Aquarium Scripter

144 Pages·2011·0.86 MB·English

http://chessok.com/aqtiki/tiki-print_multi_pages.php
Aquarium Scripter
Aquarium Scripter is a software that avails anyone to process Aquarium data objects ‐ trees and databases in a way you like. It's alike the environment Aquarium is de
peculiar things, developed especially for chess data and Aquarium.
The following manual and tutorial? give a whole overview of AqScripter possibilities, but it's still being developed and new functions are being added.
Table of Contents
Introduction
Brief IDE overview
Main panels
Toolbars
Upper toolbar
Middle and lower toolbars
Some IDE features
AqScripter Tutorial
Database Usage
Opening database
Processing a game
Comparing tree with database
Annotations
Variations
Tree Usage
Opening a tree
Searching positions in tree
Copying a tree
DedupeEPD
Finding endnodes
Generating subtrees
Joining trees
Marking a node
Minimax
Recolor
Root Nodes
Generating Back Moves
Check Tree
Import tree comparison
Compress Tree
Export EPD
Import EPD
Export Subtree to EPD‐file
Multiple Minimax
Export Subtree
Import tree difference
1 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
How to work with Tree Configurations
TreeConfigurations of Aquarium
How to work with engines
Running an engine
Analyze of time
Analyze of depth
Analyze all the lines
Test Suite
How to work with other useful things
RegExp
XMLTags
AqScripter Manual
AqScripter syntax
Formatting
Aquarium classes
Common classes
Class TSNodeInfo
Class TSMoveInfo
Class TSAnnotation
Class TSSearchInfo
Common functions
Classes for processing Aquarium data objects
Tree classes
Class TSTreeScanner
Class TSTreeJoiner
Class TSTreeConfiguration
Database classes
Class TSDatabase
Class TSGame
Class TSGameHeader
Classes for working with the engines
Class TSEngine
IDeA classes
TIDeATask
TIDeAQuality
TIdeaProjectInfo
TIdeaTreeExpandOptions
TIdeaProlongationOptions
TIdeaRootNode
TIdeaProjectNote
Functions that work only in IDeA
Functions that work only in IDeA Project view
Delphi classes
2 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
Class TObjectList
Class TStringList
Other Classes
Class TVariantList
Class TPropertyList
TCustomProperty
Class XMLParser
Class TXMLTag
Class TRegExpr
Class TBackgroundEvent
Releasing objects
Procedures used in Aquarium only
Functions that work everywhere
Functions that work only in IDeA
Functions that work only in IDeA Project view
Functions working with GameView
Functions working in database
Possible problems
1 Introduction_2
The Scripter is designed to provide access to low level Aquarium structures using high level implementation. This implementation highlights the most important data
significantly worse than usual Aquarium performance. Never the less the speed of processing is quite acceptable and higher than that of external script languages. Th
performance and ease of use.
What you'll find now in Scripter is the first set of functions designed for independent processing of Aquarium data objects. It should be used mainly as introduction in
dramatic changes after the first week of its usage. After research stage, we're going to incorporate Scripter into various Aquarium modes (first of all, IDEA).
Access to any Aquarium function can be provided in Scripter, depending on necessity.
Scripter language is based on simplified Delphi/Pascal language. Note that Pascal is case‐insensitive. We assume you're familiar with Delphi/Pascal syntax, or at least
languages). We don't aim to teach you the Delphi/Paslanguage syntax, we rather aim to acquaint you with data structures and functions available for usage in Scripte
Delphi tutorial
All Scripter classes are incomplete as of now. Every class will be populated with at least twice as many methods and events later on.
An IDE provides you the following possibilities of coding and debugging
1. Putting breakpoints. Click the blue point of the left side of the page to put a breakpoint
2. Running a script line‐by‐line without going into procedures. Press F8 to go to the next line
3. Running a script line‐by‐line and going into procedures. Press F7 for it.
4. Making user variables. Press Debug‐User variables to add a new string variable, that will be used in any script you like. It's worth creating variables that store a
3 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
5. To clear console, type clear; in script or press View‐Clear Console
Coloring used to highlight Scripter language constructs in this manual:
ReadGame(Index: integer): TSDataBaseGame – procedures/functions and types/return types
Delete ‐ methods
Move – read‐only properties
Color – read/write properties
mcNone – constants
OnInit – event identifiers
function(): boolean – event profiles
2 Brief IDE overview
AqScripter IDE is a full environment for writing scripts. It has all the features needed to debug and write scripts ‐ debug, breakpoints and watches, console and many
Table of contents
Main panels
Toolbars
Upper toolbar
Middle and lower toolbars
Some IDE features
2.1 Main panels
This is an IDE of 3.11 beta‐version, but it won't change much by the release
4 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
AqScripter IDE
The main panel is Source. Here you write the code of your script. To the left of it there's a column. In this column the number of every line is printed. Also, you can pu
Some words about breakpoints
Code with numbers and breakpoints
A red circle of a breakpoint (on lines 16 and 20 here) stops the script on the line, so you can see inspect your code. It helps debugging much.
Object inspector is a very helpful thing, it allows you manage variables and objects of the code. For example, it stores a list of variables
5 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
Variables in object inspector
And double‐click on any variable locates it in the source panel.
Console is a panel used for printing debug information or information that won't be saved after leaving AqScripter. To print something in Console, print() command
Using print command
Status bar and progress bar are situated in the very bottom of the IDE
Status bar and progress bar
Status bar consists of 7 panels. In the first there're current row and column. In the second the type of source‐writing is displayed: Insert or overwrite.
display, whether NumLock (NUM), CapsLock(CAP) or ScrollLock(SCRL) are pressed. The seventh panel contains progress bar. You can set a progress by yo
2.2 Toolbars
Let's look more carefully on the toolbars
Toolbars
Table of contents
Upper toolbar
Middle and lower toolbars
6 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
2.2.1 Upper toolbar
This upper toolbar consists of 5 menus
File menu is the one working with current script.
File menu
It has the following functions: New (Creating a new script, shortcut CTRL+N), Open (opening some script, shortcut CTRL+O), Save and Save As
recently opened scripts (Recent).
Edit menu is used to edit the scripts. Together with the common functions, as Undo (cancelling the last actions, shortcut CTRL+Z), Copy
Edit menu
Together with Undo, Redo (Shortcut CTRL+ALT+Z), Cut(CTRL+X) and others there're such functions as Find (finds a given line in the source, shortcut CTRL+F) and
CTRL+Y), and tabulation functions – Move Left (Moves a whole selection left, shortcut CTRL+U) and Move Right (Moves a whole selection right, shortcut CTRL+U). T
(CTRL+F11) is described below.
View menu sets the view of the display. You can hide Console or Object explorer or clear the console. Console can also be cleared from Source, using the
View menu
Debug menu is, maybe, the most important here.
7 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
Debug menu
Run function (shortcut F9) executes a script. Before executing it verifies it and checks syntax. If there're syntax errors, it pops up the error message
Error message. Example
There're two other methods of executing the scripts – Step over (F8) that goes through all the lines, but doesn't look into functions, and Trace Into
script up to the line where the cursor stands. It works as a breakpoint.
Run until return (shortcut Shift+F11) executes the current script until the end of a long cycle or procedure. It's useful, for instance, if you are sure that the cycle works
Show execution point stops the script and shows where is it now.
Pauseis a pause, of course, and Script reset recompiles and rechecks a script.
Also, you can add and view watches, special conditions on variables. When this condition is true, it's written in a watch list. Note, that true is ‐1, and false is 0.
Here variable i equals 1
Toggle breakpoint (F5) sets a breakpoint to a current line.
8 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
Evaluation feature
While executing a script, you may like to know, which value has variable now. For this, stop the script via breakpoint (or run it by F7 or F8) and drag mouse on it. The
The last menu is Help. It has only two important features
Help
You can associate files with .tsc extension with Scripter and delete this association. By default, it exists.
You may notice, that there's no help or manual. It's true, actually, but instead we have provided direct access from AqScripter to the tiki‐pages, that is, out online m
Going to the manual
Find the name of the class (they start with T, e.g. TSTreeScanner) and press CTRL+F1 or Edit – Find URL to fetch help.
2.2.2 Middle and lower toolbars
Middle and lower toolbars is QAT for the upper one. Each button has its pair in the upper toolbar. Their action are described in hints.
Run button is in a circle
2.3 Some IDE features
For example, you make like to know, what methods can be called for this or that variable. Press CTRL+Space, and a list of methods and properties will appear
Autocompletion list
9 of 144 26.05.2011 19:56
http://chessok.com/aqtiki/tiki-print_multi_pages.php
3 AqScripter Examples
You can find all these sample scripts also in AScripts directory in Aquarium data folder
Table of contents:
Database Usage
Opening database
Processing a game
Comparing tree with database
Annotations
Variations
Tree Usage
Opening a tree
Searching positions in tree
Copying a tree
DedupeEPD
Finding endnodes
Generating subtrees
Joining trees
Marking a node
Minimax
Recolor
Root Nodes
Generating Back Moves
Check Tree
Import tree comparison
Compress Tree
Export EPD
Import EPD
Export Subtree to EPD‐file
Multiple Minimax
Export Subtree
Import tree difference
How to work with Tree Configurations
TreeConfigurations of Aquarium
How to work with engines
Running an engine
Analyze of time
Analyze of depth
Analyze all the lines
Test Suite
How to work with other useful things
10 of 144 26.05.2011 19:56