Aquarium Scripter - Chess shop from the developers of Rybka 4 ...

http://chessok.com/aqtiki/tiki-print_multi_pages.php1 of 144 26.05.2011 19:56Aquarium ScripterAquarium 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 Apeculiar 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 ContentsIntroductionBrief IDE overviewMain panelsToolbarsUpper toolbarMiddle and lower toolbarsSome IDE featuresAqScripter TutorialDatabase UsageOpening databaseProcessing a gameComparing tree with databaseAnnotationsVariationsTree UsageOpening a treeSearching positions in treeCopying a treeDedupeEPDFinding endnodesGenerating subtreesJoining treesMarking a nodeMinimaxRecolorRoot NodesGenerating Back MovesCheck TreeImport tree comparisonCompress TreeExport EPDImport EPDExport Subtree to EPD‐fileMultiple MinimaxExport SubtreeImport tree difference

http://chessok.com/aqtiki/tiki-print_multi_pages.php2 of 144 26.05.2011 19:56How to work with Tree ConfigurationsTreeConfigurations of AquariumHow to work with enginesRunning an engineAnalyze of timeAnalyze of depthAnalyze all the linesTest SuiteHow to work with other useful thingsRegExpXMLTagsAqScripter ManualAqScripter syntaxFormattingAquarium classesCommon classesClass TSNodeInfoClass TSMoveInfoClass TSAnnotationClass TSSearchInfoCommon functionsClasses for processing Aquarium data objectsTree classesClass TSTreeScannerClass TSTreeJoinerClass TSTreeConfigurationDatabase classesClass TSDatabaseClass TSGameClass TSGameHeaderClasses for working with the enginesClass TSEngineIDeA classesTIDeATaskTIDeAQualityTIdeaProjectInfoTIdeaTreeExpandOptionsTIdeaProlongationOptionsTIdeaRootNodeTIdeaProjectNoteFunctions that work only in IDeAFunctions that work only in IDeA Project viewDelphi classes

http://chessok.com/aqtiki/tiki-print_multi_pages.php3 of 144 26.05.2011 19:56Class TObjectListClass TStringListOther ClassesClass TVariantListClass TPropertyListTCustomPropertyClass XMLParserClass TXMLTagClass TRegExprClass TBackgroundEventReleasing objectsProcedures used in Aquarium onlyFunctions that work everywhereFunctions that work only in IDeAFunctions that work only in IDeA Project viewFunctions working with GameViewFunctions working in databasePossible problems1 Introduction_2The Scripter is designed to provide access to low level Aquarium structures using high level implementation. This implementation highlights the most imsignificantly worse than usual Aquarium performance. Never the less the speed of processing is quite acceptable and higher than that of external scriptperformance 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 asdramatic changes after the first week of its usage. After research stage, we're going to incorporate Scripter into various Aquarium modes (first of all, IDAccess 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 synlanguages). We don't aim to teach you the Delphi/Paslanguage syntax, we rather aim to acquaint you with data structures and functions available for uDelphi tutorialAll 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 debugging1. Putting breakpoints. Click the blue point of the left side of the page to put a breakpoint2. Running a script line‐by‐line without going into procedures. Press F8 to go to the next line3. 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 th

http://chessok.com/aqtiki/tiki-print_multi_pages.php4 of 144 26.05.2011 19:565. To clear console, type clear; in script or press View‐Clear ConsoleColoring used to highlight Scripter language constructs in this manual:ReadGame(Index: integer): TSDataBaseGame – procedures/functions and types/return typesDelete ‐ methodsMove – read‐only propertiesColor – read/write propertiesmcNone – constantsOnInit – event identifiersfunction(): boolean – event profiles2 Brief IDE overviewAqScripter IDE is a full environment for writing scripts. It has all the features needed to debug and write scripts ‐ debug, breakpoints and watches, consTable of contentsMain panelsToolbarsUpper toolbarMiddle and lower toolbarsSome IDE features2.1 Main panelsThis is an IDE of 3.11 beta‐version, but it won't change much by the release

http://chessok.com/aqtiki/tiki-print_multi_pages.php5 of 144 26.05.2011 19:56AqScripter IDEThe 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. ASome words about breakpointsCode with numbers and breakpointsA 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

http://chessok.com/aqtiki/tiki-print_multi_pages.php6 of 144 26.05.2011 19:56Variables in object inspectorAnd 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, priUsing print commandStatus bar and progress bar are situated in the very bottom of the IDEStatus bar and progress barStatus 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 b2.2 ToolbarsLet's look more carefully on the toolbarsToolbarsTable of contentsUpper toolbarMiddle and lower toolbars

http://chessok.com/aqtiki/tiki-print_multi_pages.php7 of 144 26.05.2011 19:562.2.1 Upper toolbarThis upper toolbar consists of 5 menusFile menu is the one working with current script.File menuIt has the following functions: New (Creating a new script, shortcut CTRL+N), Open (opening some script, shortcut CTRL+O), Save and Save Asrecently 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), CopyEdit menuTogether 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 CCTRL+Y), and tabulation functions – Move Left (Moves a whole selection left, shortcut CTRL+U) and Move Right (Moves a whole selection right, short(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 SourceView menuDebug menu is, maybe, the most important here.

http://chessok.com/aqtiki/tiki-print_multi_pages.php8 of 144 26.05.2011 19:56Debug menuRun function (shortcut F9) executes a script. Before executing it verifies it and checks syntax. If there're syntax errors, it pops up the error messageError message. ExampleThere'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 Intoscript 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 thShow 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 faHere variable i equals 1Toggle breakpoint (F5) sets a breakpoint to a current line.

http://chessok.com/aqtiki/tiki-print_multi_pages.php9 of 144 26.05.2011 19:56Evaluation featureWhile 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 moThe last menu is Help. It has only two important featuresHelpYou 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,Going to the manualFind 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 toolbarsMiddle 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 circle2.3 Some IDE featuresFor 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 willAutocompletion list

http://chessok.com/aqtiki/tiki-print_multi_pages.php10 of 144 26.05.2011 19:563 AqScripter ExamplesYou can find all these sample scripts also in AScripts directory in Aquarium data folderTable of contents:Database UsageOpening databaseProcessing a gameComparing tree with databaseAnnotationsVariationsTree UsageOpening a treeSearching positions in treeCopying a treeDedupeEPDFinding endnodesGenerating subtreesJoining treesMarking a nodeMinimaxRecolorRoot NodesGenerating Back MovesCheck TreeImport tree comparisonCompress TreeExport EPDImport EPDExport Subtree to EPD‐fileMultiple MinimaxExport SubtreeImport tree differenceHow to work with Tree ConfigurationsTreeConfigurations of AquariumHow to work with enginesRunning an engineAnalyze of timeAnalyze of depthAnalyze all the linesTest SuiteHow to work with other useful things

http://chessok.com/aqtiki/tiki-print_multi_pages.php11 of 144 26.05.2011 19:56RegExpXMLTags3.1 How to work with databaseThere’re two classes designed for database usage:TSDatabaseTSGameEvery TSDatabase object represents a chess database (.cdp, .pgn and others) and contains a numbers of games which can be referenced viaHave a look at basic scripts of how to:Open databaseProcess a game:Open databasePrint the number of gamesRead a gamePrint its header (class TSHeader)Scan it forward and backwardExport information about every node (class TSNodeInfo) in the file.Compare tree with database: open a database and process the first three games. To begin with, find the first node that exists in the databasehad chosen the best move. If the player didn't choose the best move, write in a file, otherwise, if the difference between evaluations is too signAnnotations This is a very simple script. It reads annotations (class TSAnnotation) to the move and writes them.Variations This script shows how to work with annotations: read, add, and delete them3.1.1 Opening database

http://chessok.com/aqtiki/tiki-print_multi_pages.php12 of 144 26.05.2011 19:56//For Aquarium 4.0.6vardb: TSDatabase; // Database objectgam: TSGame;// Game objectname: string;// a stringbegin// Create database object// DataPath returns the path to the directory where Aquarium data is storedname := DataPath + 'AScripts\Data\Abases\comment.cdp';db := TSDatabase.Create(name);// if database existsif db.Opened thenbegin//print command prints the argument in the consoleprint( 'Database '+name + ' opened. Games:' + IntToStr(db.Count) );// Read game number 19gam := db.ReadGame(19, true);// if Game was readif gam nil thenbeginprint ('game opened: ' + gam.Header.White + '-' + gam.Header.Black + ', ' + gam.Header.Result);gam.Free;endelseShowMessage('Error opening game');endelseShowMessage('Error opening database');// Release database object. Compulsory!!db.Free;end.3.1.2 Processing a game

http://chessok.com/aqtiki/tiki-print_multi_pages.php13 of 144 26.05.2011 19:56//For Aquarium 4.0.6//Opening a game and processing it://scanning a game and writing down some info about movesvardb: TSDatabase; // Database objectgam: TSGame;// Game objectf: text; // Text file objecth: TPGNHeader; // Header object// This procedure is assigned for processing moves in //ScanGameForward procedureprocedure OnScan1(gam: TSGame);varsi: TSNodeInfo;begin// si.Number - ply number// si.VarLevel - 0 - main line; 1 - variant for main line;// si.Move - notation of the movesi := gam.CurrentNode;WriteLn(f, Format('fwd: %.3d [%d]: %s (%s)', [si.Number, si.VarLevel, si.Pos, si.Move]));//writing into a fileend;// This procedure is assigned for processing moves in ScanGameBackward procedureprocedure OnScan2(gam: TSGame);varsi: TSNodeInfo;beginsi := gam.CurrentNode;WriteLn(f, Format('bwd: %.3d [%d]: %s (%s)', [si.Number, si.VarLevel, si.Pos, si.Move]));end;begin// Create database objectname := DataPath + 'Ascripts\Data\Abases\comment.cdp';db := TSDatabase.Create(name);// if database existsif db.Opened thenbeginprint('opened');// Create db_script.log fileAssignFile(f, DataPath+'AScripts\data\db.epd');//Make the file writableRewrite(f);// Inform about number of games in the databaseShowMessage(format('%d',[db.Count])+' games');// Read game number 19gam := db.ReadGame(19);if gamnil then//if openedbegin//Creating header objecth:= gam.Header;//prints who played whiteprint (h.White);//Setting OnScan procedure//for evey new processed position

http://chessok.com/aqtiki/tiki-print_multi_pages.php14 of 144 26.05.2011 19:563.1.3 Comparing tree with database

http://chessok.com/aqtiki/tiki-print_multi_pages.php15 of 144 26.05.2011 19:56//Compares the evaluation of the position in the game with the one in the treeconstDBname = 'AScripts\data\ABases\4_e3_is_better.cdp';TreeName = 'AScripts\DATA\Atrees\cap.hsh';EPDFile = 'AScripts\data\db_tree_combined.epd';vardb: TSDatabase; // Database objectgam: TSGame;//Game objectf: text; // Text file objectt: TSTreeScanner; // Input tree objectni: TSNodeInfo; // List of movesposline: string; // Cuurent positionj :integer;//an auxiliry varlines: integer; // number of lines saves to file// This procedure is assigned for processing moves in ScanGameForward procedureprocedure OnScan(gm: TSGame); //scanning the databasevargmove: string;p:string;mi: TSMoveInfo;si: TSNodeInfo;tmove_score: integer;beginsi := gm.CurrentNode;beginposline := si.Pos;//takes the current positionni := t.SearchFEN(posline);//looks for it in the treeif (ni nil) thenif (ni.Count>0) and (si.Count>0) then //checking that it exists and has movesbegingmove := si.Move;//the move from mainlinemi := ni.Moves[ni.Sorted[0]];//the best move in the treetmove_score := mi.cpScore;if gmove mi.Move then// if a player didn't choose the best moveif not t.DoMove(mi.Move) then //if there's nowhere to gobeginWriteLn(f, t.CurrentNode.Pos);//writes it to a epd-file fileinc(lines);end;//stop scan if eval itself is too bigif abs(tmove_score)>100 thenbegingam.StopScan;end;end;end;end;begin// Create database objectdb := TSDatabase.Create(DBname);//And a tree object//There're folloeing parameters^ path to the tree, if it should be read only (here TRUE)//if it could be created by the script (here FALSE)//and the memory to use (here 128)t := TSTreeScanner.Create(TreeName, True, False, 128);

http://chessok.com/aqtiki/tiki-print_multi_pages.php16 of 144 26.05.2011 19:563.1.4 Annotations

http://chessok.com/aqtiki/tiki-print_multi_pages.php17 of 144 26.05.2011 19:56//For Aquarium version 4.0.6// Examples how to read and edit annotations in the game// The first game of Comment.cdp is annotated.constdbName = 'AScripts\Data\ABases\Comment.cdp';vardb: TSDataBase; //database objectgam: TSGame; //game objectsl: TStringList; //list of annotationssl1: TStringList;//list of annotationsni: TSNodeInfo; //the position we work withi: Inetger;ant: TSAnnotation;//annotationbegin//clearing consoleclear;//opening a base. It should be closed in Database mode in Aquarium!db := TSDataBase.Create( dbName);//GetAquariumBase - current databaseif not db.Opened thenShowMessage('No database found ('+dbName+')')elsebegin //if it is opened//opening the first game.gam := db.ReadGame(1);if gam = nil then // if not openedShowMessage('ReadGame failed')elsebegin//getting annotations for the current position (first position)ant := gam.Annot;//going to the 4 move, stayng after itni := gam.LnGoTo(4, true);//printing FENprint (ni.Pos);//getting the move from the main line and printing itmi := ni.Moves[0];print (mi.Move);// setting Progress Bar with 7 stagesShowProgressBar(7);//setting evaluation 4 centipawns. Returns the number of a comment (i)i := ant.SetComment(antEval, '4');print(i);//getting all evaluation annotationssl := ant.GetAllCommentsByType(antEval);if sl nil then//printing all lines separation them by commasprint(sl.CommaText);//we should free a stringlistsl.Free;

http://chessok.com/aqtiki/tiki-print_multi_pages.php18 of 144 26.05.2011 19:563.1.5 VariationsVariations

http://chessok.com/aqtiki/tiki-print_multi_pages.php19 of 144 26.05.2011 19:56//For Aquarium 4.0.6vardb: TSDataBase; //Databasegam: TSGame; //gameni: TSNodeInfo; //node=positionbegin//clearing consoleclear;//creating databasedb := TSDataBase.Create(DataPath + 'Ascripts\Data\abases\comment.cdp');if db.Opened then //if database existsbegin//reading game number 3, games are counted from 0//(so in fact it's the fourth game)gam := db.ReadGame(3);if gam nil then//if openedbegin//going to the first move in the mainline//in this case it's the same as LnGoToMove(1);//true stands for AfterMove=true//so we have positioned between the first and the second moves//to make it clear - it's black to moveni := gam.MainLineGoTo(1, true);if ni nil thenbegin//printing that move and i's number//Moves are counted from 1!print(Format('Move to start: %s, its number %d ', [ni.Move, ni.Number]));//first level variations, adding new line with movesgam.NewLine('b7b5 h2h4');//adding moves to the currnt position with numbers before themgam.AddMoves('1.h6h5 2.g2g4', tsNumbers);//second level variationsgam.NewLine('a2a3');//returning to upper lineni:=gam.returnToUpperLine;if ni nil then//if we've returned rightbegin//printing current info:print(Format('Move on which the second-line variation hangs: %s, its number %d ', [ni.Move, ni.Number]));//number of moves in current lineprint(Format('Moves in the current line: %d', [gam.LineCount]));//new line of variations of second levelgam.NewLine('b2b3');//returning to mainlineni := gam.ReturnToMainLine;if ni nil then //if we've returned rightbegin//total number of variations from this moveprint(Format('Variations from here: %d', [gam.VariationsCount]));//choosing a variationni := gam.SelectLine(0);if ni nil then //if there's such a variationprint(Format('First move in the second variation: %s, its number %d ', [ni.Move, ni.Number]));//total number of moves in a gameprint(Format('Moves in a game: %d ', [gam.TotalCount]));end;end;end;end;

http://chessok.com/aqtiki/tiki-print_multi_pages.php20 of 144 26.05.2011 19:563.2 How to work with treesTree is the most common way to store chess information. The tree file has .hsh‐extension. In AqScripter there're many functions developed especiallypowerful and interesting scripts.So, to open a tree, write the following:vart: TSTreeScanner; // Tree objectbegin't' is the name of the tree object, as a parameter to Create function we give a path to the tree.Trees consist of nodes. Node is a special object of class TSNodeInfo, where we store FEN position and an array of moves (class TSMoveInfothem in the manual.Here is some examples of scripts:Script one: opening a tree.Script two: Searching positions in tree.Script three: Copying a tree. This script opens a tree, processes first 6000 nodes, and adds it with all moves to another.Script four: DedupeEPD. This is a very simple script that eliminates duplicates from epd‐file.Script five: Finding endnodes. This script checks, if a given node is endnode in the tree (has no moves after it.)Script six: Joinig trees. We take two trees, join them and write the result in a third. Joining parameters are described in the script comments.Script seven: Marking a node. It's used if you want to mark some nodes with a Boolean flag – i.e., while scanning to mark that the node was pScript eight: Minimax. This script shows the usage of minimax function. First it unminimax the move, that is, writes a wrong evaluation. Than iour trees are minimaxed.Script nine: Recolor. This script works with colors. It opens a tree, sets parameters for scanning and scans it. It does two things – writes the numcolor, it's colored red.Script ten: Root Nodes. It is an illustration of the GetRootNodes function that finds positions in tree that have no parents. The result is writtenScript eleven: Generating Back Moves. It takes a node and generates (adds into a tree) all its possible parents.Script twelve: Check Tree. This is very important if you need to know whether a tree is normal or corrupted.Script thirteen: Compare Trees Compares two trees and adds nodes and positions from the first one to the result (third)treeScript fourteen: Compress TreeCompresses a tree, eliminating extra nodes and adding linking moves. Note, that a compressed tree might beScript fifteen: Export EPD This scripts takes a tree and exports it to a epd‐fileScript sixteen: Import EPD Makes a tree from a given EPD‐file.Script seventeen: Export subtree to EPD This script creates a subtree from a given node and exports it to epd‐file. You can use Generate SubtScript eighteen: Multiple minimax Minimaxing a tree from a number of FEN positionsScript nineteen: Save from position Saves a tree from a given position as another treeScript twenty: Subtract trees Compares 2 trees and adds nodes from a first one only to the result tree3.2.1 Opening a tree

http://chessok.com/aqtiki/tiki-print_multi_pages.php21 of 144 26.05.2011 19:56//For Aquarium 4.0.6vart: TSTreeScanner; // Tree objectbegin// Create tree objectt := TSTreeScanner.Create(DataPath + 'AScripts\Data\ATrees\cap.hsh');// if opened successfullyif t.Opened thenbeginShowMessage('opened');endelseShowMessage('not opened');// Release the object (close tree file). Don't forget about such thingsend.t.Free;3.2.2 Searching positions in tree

http://chessok.com/aqtiki/tiki-print_multi_pages.php22 of 144 26.05.2011 19:56//For Aquarium 4.0.6// Search the position in the tree and show information about movesvart: TSTreeScanner; // Tree objectni: TSNodeInfo; // List of movess1: string; // string, line of charactersi: integer; // integer = real numberbegin//clearing consoleclear;// Create tree objectt := TSTreeScanner.Create(DataPath + 'AScripts\Data\ATrees\cap.hsh');// if opened successfullyif t.Opened thenbegin// Search some position and fill moves structure if successni := t.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - ');// if foundif ni nil thenbegin//writing the first moves1 := ni.Move;// show number of moves from position, first move in the list and its evaluation//ni.Moves - array of moves//ni.Moves[0] -f irst move, ni.Moves[1] -s econd move, etc//cpScore - attribute of a move//its evaluation in centipawnsShowMessage( format('%d moves from the position after 1.e4 e5 2.Nf3: 2...%s %d',[ni.Count, s1, ni.Moves[0].cpScore]));//making a first move. It changes current position in a tree!if t.DoMove(ni.Moves[0].Move) thenbegin//filling structure for current positionni := t.CurrentNode;//now informationShowMessage( format('%d moves from the position after 1.e4 e5 2.Nf3: 2...%s 3.%s %d',[ni.Count,s1,ni.Moves[0].Move,ni.Moves[0].cpScore]));end;endelseShowMessage('not found');//Looking for new positionni := t.SearchFEN('rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq -');if ni nil then//if foundbegin// using 'with' operator for simplifying access to the fieldswith ni.Moves[0] doShowMessage( format('%d moves from the position after 1.e4 e5: 2.%s %d',[ni.Count,Move,cpScore]));endelseShowMessage('not found');endelse

http://chessok.com/aqtiki/tiki-print_multi_pages.php23 of 144 26.05.2011 19:563.2.3 Copying a tree

http://chessok.com/aqtiki/tiki-print_multi_pages.php24 of 144 26.05.2011 19:56//Copies 6000 positions from one tree into an another.varsrc: TSTreeScanner; //source treedst: TSTreeScanner; //destination treecnt: integer; //counter//this function works for every node found while scanning a treeprocedure ProcessNodeSrc(AScanner: TSTreeScanner);vari: integer; //integer, used for a cyclemi: TSMoveInfo; //moveni: TSNodeInfo; //nodebegininc(cnt);//+1 to counter//mod is getting a remainder.if (cnt mod 1000) = 0 then//we print every thousandprint(IntToStr(cnt));if cnt > 6000 thenAScanner.StopScan;//limit copying only for first 6000 moveselsebegin//taking a current nodeni := AScanner.CurrentNode;//Adding node to a destination treedst.Add(ni);//Copying all moves and marking them GREENfor i := 0 to ni.Count - 1 dobeginmi := ni.Moves[i];mi.Color := mcGreen;dst.AddMove(mi);end;//Very important - to save destination treedst.Reset;end;end;begin//setting countercnt := 0;print('started');//change directory - for smart inputChDir(InputPath(DataPath+'Scripter\Atrees\'));// Create tree objectsrc := TSTreeScanner.Create('cap.hsh');if not src.Opened thenShowMessage('Tree not found')elsebeginprint('src opened');//Setting procedure, executed when a node is processedsrc.OnProcessNode := 'ProcessNodeSrc';//destination treedst := TSTreeScanner.Create('out', False, True);

http://chessok.com/aqtiki/tiki-print_multi_pages.php25 of 144 26.05.2011 19:563.2.4 DedupeEPD// For Aquarium versoin 4.0.6// DedupeEPD is one of the TreeUtils procedures.// It removes identical lines from EPD file.//input EPD file, where duplicates are searched//output EPD file without duplicatesconstinput_epd = 'AScrips\data\EPD\inepd.epd';output_epd = 'AScripts\data\EPD\outepd.epd';vart: TSTreeScanner;ni: TSNodeInfo;begin// Tree is usually used in TreeUitls operations// Any tree you like. It is not used in this operationt:= TSTreeScanner.Create(DataPath+'AScripts\Data\Atrees\idea.hsh');if t.Opened thenbegint.DedupeEpd(DataPath+input_epd, DataPath+output_epd) //Dedupe procedureShowMessage('ok')end;//Dot't forgetend;t.Free;3.2.5 Finding endnodes

http://chessok.com/aqtiki/tiki-print_multi_pages.php26 of 144 26.05.2011 19:56//This script shows how to use EndNode function for trees//Endnode is a node that has no more positions after it//For Aquarium version 4.0.6vart: TStreeScanner; //treeni: TSNodeInfo; //node in treeni1:TSNodeInfo; //node in treebegin//opening a treet := TSTreeScanner.Create(DataPath+'Scripter\ATrees\idea.hsh', False);if t.Opened then //if openedbeginprint('opened');//Serachs for FENni := t.SearchFEN('r1bqkbnr/1ppp1ppp/p1n5/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq -');if ninil then //if foundbeginif t.IsEndNode(ni) then//Checks if it's an endnodeprint('Endnode!')elseprint ('Not endnode')endelse //if not foundprint('Position is not found in tree');ni1 := t.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1');if ni1nil then //if foundbeginif t.IsEndNode(ni1) then//Checks if it's an endnodeprint('Endnode!')elseprint ('Not endnode')endelse //if not foundprint('Position is not found in tree');end;t.Free;end.3.2.6 Generating subtrees

http://chessok.com/aqtiki/tiki-print_multi_pages.php27 of 144 26.05.2011 19:56vart: TSTreeScanner;//input treeo: TStReeScanner;//output treeout: string; //path to the output treeAFen: String; //position from where to generateni: TSNodeInfo; //NodeInfo with AFEN poaitioni: integer; //Counter//Scan and count nodesprocedure OnScan(Ascanner: TStreeScanner)varnn: TSNodeInfo;beginnn := Ascanner.CurrentNode;inc(i);end;begint:=TSTreeScanner.Create('Data/Atrees/cap.hsh')if t.Opened thenbegini := 0;t.OnProcessNode := 'OnScan';Afen := 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -';t.StartRecursive;print (inttostr(i) + ' positions')//Nodes in the whole treeni := t.SearchFEN(AFen);if ni nil thenbeginout := 'Data/Atrees/gensub.hsh'print(t.ImportSubtree(out, Afen));//Generate subtree from the given node, returns integer - number of nodesprint('ok');i := 0;//Creating result tree and counting nodes thereo := TStreeScanner.Create(out);if o.Opened thenbegino.OnProcessNode := 'OnScan';o.StartRecursive;print (inttostr(i) + ' positions');//Number of positions in the subtree;ShowMessage('ok');end;o.Free;end;end;t.Free;end.3.2.7 Joining trees

http://chessok.com/aqtiki/tiki-print_multi_pages.php28 of 144 26.05.2011 19:56//For Aquarium version 4.0.6//Joins 2 trees, similar to TreeUtilsvar// treessrc: TSTreeScanner;att: string;dst: string;beginprint('started');ChDir(InputPath('AScripts\data\ATrees'));//Change directory// Create tree object and open treesrc := TSTreeScanner.Create('cap.hsh');if src.Opened thenbeginShowMessage('src opened ok');att := DataPath+'AScripts\data\Atrees'+'idea.hsh';//An attached treedst := DataPath+'AScripts\data\Atrees'+'out.hsh';//A destination=output treesrc.JoinTrees(att, dst, jrJoin, jrJoin, jrJoin, jrJoin, jrJoin, apInter, 128);//Params://att - attached tree//dst - destination tree//Next 6 constants where to take the data from//Statistics, Evaluations, Moves, Annotation, Variants//Constants for them: jrNo (from nowhere) jrJoin(Join), jrSrc(source tree),//jrAtt(Attached tree), jrSrcPrior(priority to source), jrAttPrioprio(prority to attached)//!!!!You cannot join Moves and Stat with jrSrcPrior, jrAttPrior!!!!//Position//Constants for it: apJoin (joined), apSource(source), apInter(Intersection)//Memory to use: integerend;src.Free;//Other trees should not be freed!print('ok');end.3.2.8 Marking a node

http://chessok.com/aqtiki/tiki-print_multi_pages.php29 of 144 26.05.2011 19:56//For Aquarium version 4.0.6//Joins 2 trees, similar to TreeUtilsvar// treessrc: TSTreeScanner;att: string;dst: string;beginprint('started');ChDir(InputPath('AScripts\data\ATrees'));//Change directory// Create tree object and open treesrc := TSTreeScanner.Create('cap.hsh');if src.Opened thenbeginShowMessage('src opened ok');att := DataPath+'AScripts\data\Atrees'+'idea.hsh';//An attached treedst := DataPath+'AScripts\data\Atrees'+'out.hsh';//A destination=output treesrc.JoinTrees(att, dst, jrJoin, jrJoin, jrJoin, jrJoin, jrJoin, apInter, 128);//Params://att - attached tree//dst - destination tree//Next 6 constants where to take the data from//Statistics, Evaluations, Moves, Annotation, Variants//Constants for them: jrNo (from nowhere) jrJoin(Join), jrSrc(source tree),//jrAtt(Attached tree), jrSrcPrior(priority to source), jrAttPrioprio(prority to attached)//!!!!You cannot join Moves and Stat with jrSrcPrior, jrAttPrior!!!!//Position//Constants for it: apJoin (joined), apSource(source), apInter(Intersection)//Memory to use: integerend;src.Free;//Other trees should not be freed!print('ok');end.3.2.9 Minimax

http://chessok.com/aqtiki/tiki-print_multi_pages.php30 of 144 26.05.2011 19:56//For Aquarium version 4.0.6//Joins 2 trees, similar to TreeUtilsvar// treessrc: TSTreeScanner;att: string;dst: string;beginprint('started');ChDir(InputPath('AScripts\data\ATrees'));//Change directory// Create tree object and open treesrc := TSTreeScanner.Create('cap.hsh');if src.Opened thenbeginShowMessage('src opened ok');att := DataPath+'AScripts\data\Atrees'+'idea.hsh';//An attached treedst := DataPath+'AScripts\data\Atrees'+'out.hsh';//A destination=output treesrc.JoinTrees(att, dst, jrJoin, jrJoin, jrJoin, jrJoin, jrJoin, apInter, 128);//Params://att - attached tree//dst - destination tree//Next 6 constants where to take the data from//Statistics, Evaluations, Moves, Annotation, Variants//Constants for them: jrNo (from nowhere) jrJoin(Join), jrSrc(source tree),//jrAtt(Attached tree), jrSrcPrior(priority to source), jrAttPrioprio(prority to attached)//!!!!You cannot join Moves and Stat with jrSrcPrior, jrAttPrior!!!!//Position//Constants for it: apJoin (joined), apSource(source), apInter(Intersection)//Memory to use: integerend;src.Free;//Other trees should not be freed!print('ok');end.3.2.10 Recolor

http://chessok.com/aqtiki/tiki-print_multi_pages.php31 of 144 26.05.2011 19:56//For Aqurium version 4.0.6//Example of changing move colors in the tree{the folloiwng color constants may be used:mcNone, mcRed, mcGreen, mcBlue, mcOrange}//Results are not saved in the treevarcount,// nubmer of scanned positionschanged_count: integer; // nubmer of changed positionst: TSTreeScanner; // tree objectf: text; // file handle// This procedure is called for every scanned positionprocedure ProcessNode(Ascanner:TStreeScanner);varm: TSMoveInfo; // Move objecti: integer;ni: TSNodeInfo; //Node i\objectbegin//Getting current nodeni := AScanner.CurrentNode;//Writing in a file//a position and a number of moves in itwriteln( f, format('%s %d moves ',[ni.Pos,ni.Count]));//clearing a lines := '';//cycle^ processing move by movefor i := 0 to ni.Count - 1 dobeginm := ni.Moves[i]; // Get the movecase m.Color of //it's like if, but for many cases//printing move with its colormcNone: print(format('None: [%s]; ',[m.Move]));mcRed: print(format('Red (%s); ',[m.Move]));mcGreen: print(format('%s Green; ',[m.Move]));mcBlue: print(format('%s Blue; ',[m.Move]));mcOrange: print(format('%s Orange; ',[m.Move]));end;if m.Color=mcRed then // if it is Redbeginm.Color := mcNone; // make it BlackInc(changed_count); // count it as changedend;end;//writing an empty line into a log-filewriteln( f,'');end;Inc(count);begin// Create tree objectname := DataPath+'AScripts\data\ATrees\colored2.hsh';//Example of smart input, to change paths easilyInputQuery('Change Tree', 'Path: ', name);//creating a treet := TSTreeScanner.Create(name);

http://chessok.com/aqtiki/tiki-print_multi_pages.php32 of 144 26.05.2011 19:563.2.11 Root Nodes//For Aquarium version 4.0.6//This simple script looks for the root node of the tree//Root node=node, that has no parents,//it means, there's no ways to reach such a position in the treevart: TStreeScanner; //tree scanneri: integer;sl: TStringlist; //stringlist to write rootnodesbeginclear;//opening a tree, false stands for ReadOnly = false and//ACanCreate=false//the tree should exist, we cannot create itt := TSTreeScanner.Create(DataPath + 'AScripts\data\ATrees\cap.hsh', False, False);if t.Opened then //if openedbegin//printingprint('opened');//Generates a StringList of root nodessl := t.GetRootNodes;ShowMessage(Format('%d root nodes found', [sl.Count]));//Printing all rootsfor i:=0 to sl.Count-1 doprint (sl.Strings[i]);//releasingsl.Free;end;//one more releasingt.Free;end.3.2.12 Generating Back Moves

http://chessok.com/aqtiki/tiki-print_multi_pages.php33 of 144 26.05.2011 19:56//For Aquarium 4.0.6vart:TSTreeScanner;//our treeni: TSNodeInfo;begint := TSTreeScanner.Create(DataPath+'Ascripts\Data\ATrees\idea.hsh', False);if t.Opened thenbeginprint ('opened');ni := t.SearchFEN('rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq -');//Node to generate parentsPif ninil thenbeginif t.GenerateBackMoves(ni) then//Generates back movesprint ('Moves Generated')elseprint ('nothing generated');//all back moves already in treeend;end;t.Free;end.3.2.13 Check Tree

http://chessok.com/aqtiki/tiki-print_multi_pages.php34 of 144 26.05.2011 19:56// Checking a tree for corruption (like TreeUtils operation)// For Aquarium version 4.0.6vart: TSTreeScanner;t_Cor: TSTreeScanner;begin//Open the treet := TSTreeScanner.Create('AScripts\Data\Atrees\cap.hsh');t_Cor := TSTreeScanner.Create('AScripts\Data\Atrees\idea_corrupted.hsh');if not t.Opened thenprint ('cap tree not found')else //if openedbegin//Checking that tree is not corrupt//returns True when the tree is all rightif t.Check thenprint ('cap tree is Good!')else {(= if false)}print('cap tree is Bad!');end;if not t_Cor.Opened thenprint ('idea_cor tree not found')else //if openedbegin//This tree is deliberately corrupted by the developersif t_Cor.Check thenprint ('idea_cor tree is Good!')else {(= if false)}print('idea_cor tree is Bad!');end;//release them!t.Free;t_cor.Free;end.3.2.14 Import tree comparisonThis script compares two trees and adds to the third one the positions and moves that exist only in the first one.//For Aquarium 4.0.6vart: TStreeScanner;begin//creating result TreeScanner, readonly=false, CanCreate = truet := TSTreeScanner.Create(DataPath + 'AScripts\Data\Atrees\out.hsh', false, true);if t.Opened thenbegin//comparing, result is the number of gpositions processedprint(t.ImportTreeComparison(DataPath + 'AScripts\Data\Atrees\nnt.hsh', DataPath + 'AScripts\Data\Atrees\idea.hsh'end;t.Free;end.3.2.15 Compress Tree

http://chessok.com/aqtiki/tiki-print_multi_pages.php35 of 144 26.05.2011 19:56//For Aquarium version 4.0.6vart: TStreeScanner;begin//creating result treet := TSTreeScanner.Create(DataPath+'AScripts\Data\Atrees\idea_compressed.hsh', false, true);//if createdif t.Opened thenbegin//returns integer - number of positions processedprint(t.CompressTree(DataPath + 'AScripts\Data\Atrees\idea.hsh'));end;t.Free;end.3.2.16 Export EPD//For AqScripter beta version 3.11vart: TStreeScanner;i: integer;epd: String;begin//creating a result treet := TSTreeScanner.Create(DataPath + 'AScripts\Data\Atrees\cap.hsh');if t.Opened thenbegin//source tree//file to exportepd := DataPath + 'AScripts\Data\epd\exported.epd'i := t.ExportEPD(epd);print(i);ShowMessage(Format('Export done, see %s, %d positions processed', [epd, i]))end;//releasingt.Free;end.3.2.17 Import EPD

http://chessok.com/aqtiki/tiki-print_multi_pages.php36 of 144 26.05.2011 19:56//For Aquarium 4.0.6vart: TStreeScanner;i: integer;epd: String;s: string;beginclear;s := DataPath + 'AScripts\Data\Atrees\cap_out.hsh';t := TSTreeScanner.Create(s, false, true);if t.Opened thenbegin//file to importepd :=DataPath + 'AScripts\Data\epd\toimport.epd';i := t.ImportEPD(epd);print(i);ShowMessage(Format('Import done, see %s, %d positions processed', [epd, i]))end;t.Free;end.3.2.18 Export Subtree to EPD‐file// For Aquarium version 4.0.6// This tree exports recursivly the tree from given position// into a epd-fileconstTreeName = 'AScripts\Data\Atrees\cap.hsh';epdFile = 'AScripts\data\EPD\subepd.epd'vart: TStreeScanner;//tree we exprtAFen: string; //fen from which to startbegin//opening a treet := TSTreeScanner.Create(TreeName);if t.Opened then//if openedbegin//setting a fenAfen := 'rnbqkbnr/pppp1ppp/8/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R b KQkq -';//setting the name of the epd-file. For better use, it should be empty//parameters are: FEN line, epd-file name,//whether to export all the lines (here TRUE) or onlyt main//what to export - all levaes (here ExAll), or only//internal (exInternal) or only endnodes (exConcluding)//the last integers are min and max valuesif t.ExportSubtreeTOEPD(AFen, epdFile, true, 'exAll', -30000, 30000) thenShowMessage(Format('Export done, see %s', [epdFile]))elseShowMessage('Export was not done');end;t.Free;end.

http://chessok.com/aqtiki/tiki-print_multi_pages.php37 of 144 26.05.2011 19:563.2.19 Multiple Minimax//For AqScripter beta version 3.11vart: TStreeScanner;sl: TStringList;begint := TSTreeScanner.Create(DataPath+'AScripts\data\Atrees\cap.hsh', false);if t.Opened thenbegin//stringlist with FENs from that to start minimaxsl := TStringList.Create;//importing them from filesl.LoadFromFile(DataPath+'AScripts\Data\EPD\minimax.epd');t.MultipleMinimax(sl);//releasing a stringlistsl.Free;ShowMessage('Minimaxed');end;t.Free;end.3.2.20 Export Subtree//For AqScripter version beta 3.11vart: TSTReeSCanner;beginclear;//result treet := TSTreeScanner.Create(DataPath +'AScripts\Data\Atrees\out.hsh', false, true);if t.Opened then//params: path to a tree, fenprint(t.ExportSubtree(DataPath+'AScripts\Data\Atrees\cap.hsh', 'r1bqkb1r/pppp1ppp/2n5/1B2p3/4n3/5N2/PPPP1PPP/RNBQ1RK1 wt.free;end.3.2.21 Import tree difference

http://chessok.com/aqtiki/tiki-print_multi_pages.php38 of 144 26.05.2011 19:56//For AqScripter beta version 3.11vart: TSTreeScanner;beginclear;t := TSTreeScanner.Create(DataPath+'AScripts\Data\Atrees\out.hsh', false, true);if t.OPened thenbeginif t.ImportTreeDifference(DataPath+'Ascripts\DATA\ATrees\cap.hsh', DataPath+'AScripter\Data\Atrees\idea.hsh') thenprint('Import Done')elseprint('Import not done');end;t.Free;end.3.3 How to work with Tree ConfigurationsWe've implemented some features of TreeConfiguarions, in class TSTreeConfiguration. They can work with PlayProbability and colors of the moves. T3.3.1 TreeConfigurations of Aquarium

http://chessok.com/aqtiki/tiki-print_multi_pages.php39 of 144 26.05.2011 19:56//For AqScripter beta version 3.11//To get it work, copy config and atrees folders of Aquarium into the directory of AqScripter.exevarTSConfig: TSTreeConfiguration;t: TStreeScanner;//we need it only to have a node.ni: TSNodeInfo;begint := TSTreeScanner.Create('data\ATrees\cap.hsh');if t.Opened thenbeginni := t.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');if ni nil thenbeginTSConfig := TSTreeConfiguration.Create('NarrowBook');//OpenConfigTSConfig.SetManualPercent(12, ni, 1);//Set Play Propability percents: percents, nodeinfo, number of moveTSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[0]], tmcRed); //Set ColorsTSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[1]], tmcBlue);//nodeinfo, moveinfo, colorTSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[2]], tmcOrange);TSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[3]], tmcGreen);TSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[4]], tmcPurple);t.Reset;ni := t.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');if ni nil thenbeginprint(inttostr(TSConfig.GetPlayProbabilityPercents(ni, 1)));// get play probability percentprint(inttostr(TSConfig.GetPlayProbabilityPercents(ni, ni.Sorted[0]))); //nodeinfo, move numbverprint(ni.Moves[ni.Sorted[0]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[0]]));//get colorprint(ni.Moves[ni.Sorted[1]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[1]]));//nodeinfo, moveinfoprint(ni.Moves[ni.Sorted[2]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[2]]));print(ni.Moves[ni.Sorted[3]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[3]]));print(ni.Moves[ni.Sorted[4]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[4]]));end;endelseShowMessage('No position!');end;t.Free;TSConfig.Free;end.3.4 How to work with enginesOf course, we couldn't leave AqScripter without engines. It has a set of functions, permitting working with engines. To create an engine object, write thvare: TSEngine; // Engine objectThere are some most common examples:Script one: Running an engine.Script two: Analyze to time. This script shows how to make an engine analyze the position for the given time.Script three: Analyze to depth. If you want an engine to analyze a position to a certain depth, see the following script.

http://chessok.com/aqtiki/tiki-print_multi_pages.php40 of 144 26.05.2011 19:56Script four: Analyze all the lines. These functions are used when you want to process every line returned by an engine. It has an event structurScript five: test Suite It creates a test for an engine, that it works well enough.3.4.1 Running an enginevare: TSEngine; // Engine objectf: text; // Text file objects: string;begin// Search engine and load itname := DataPath + 'Engines\Rybka\1-cpu\w32\Rybka 4 w32.exe'e := TSEngine.Create(name);if e.Started thenShowMessage('Engine was started.')elsebeginShowMessage('Engine was not started. Please check the path '+name);end;e.Free;end.3.4.2 Analyze of time

http://chessok.com/aqtiki/tiki-print_multi_pages.php41 of 144 26.05.2011 19:56vare: TSEngine; // Engine objectf: text; // Text file objects: string;begin// Search engine and load itname := DataPath + 'Engines\Rybka\1-cpu\w32\Rybka 4 w32.exe'e := TSEngine.Create(name);if e.Started thenbegin// Create 'engine.log' fileAssignFile(f, 'engine.log'); Rewrite(f);// You may use low level UCI commandse.SetPosition('startpos moves c2c4 e7e5');e.SendUciCommand('setoption name hash value 32');// Or higher level commandse.SetIgnoreMoves('g1f3,e2e4,d2d4');// Run analysis for 1 seconds := e.AnalyseToTime(1000);// Write resulting string to fileWriteLn(f, 'Analyse: '+s);CloseFile(f);endelsebeginShowMessage('Engine was not started. Please check the path '+name);end;e.Free;end.ShowMessage('Success. See engine.log for the results');3.4.3 Analyze of depth

http://chessok.com/aqtiki/tiki-print_multi_pages.php42 of 144 26.05.2011 19:56vare: TSEngine; // Engine objectbegin// Search engine and load itname := DataPath + 'Engines\Rybka\1-cpu\w32\Rybka 4 w32.exe'e := TSEngine.Create(name);if e.Started thenbegine.SetFen('rnbqkbnr/8/8/8/8/8/8/RNBQKBNR w KQkq -');e.SetIgnoreMoves('');e.AnalyseToDepth(10);WriteLn(f, 'Last response: '+ e.LastResponse);WriteLn(f, 'Last PVLine: '+ e.LastPV);WriteLn(f, 'Last Eval: ' + IntToStr(e.Eval));WriteLn(f, 'Last Depth: ' + IntToStr(e.Depth));WriteLn(f, 'Last Time: ' + IntToStr(e.Time));WriteLn(f, 'Last Nodes ' + IntToStr(e.Nodes));WriteLn(f, 'Last NPS: ' + IntToStr(e.NPS));WriteLn(f, 'Last PV: ' + e.PV);//string!endelsebeginShowMessage('Engine was not started. Please check the path '+name);end;e.Free;end.ShowMessage('Success. See engine.log for the results');3.4.4 Analyze all the lines

http://chessok.com/aqtiki/tiki-print_multi_pages.php43 of 144 26.05.2011 19:56vare: TSEngine; // Engine objects: string;procedure OnEngMsg(Sender: TSEngine; AResponse: integer; AValues: TStringList; ACommand: string);beginif Pos('depth 6', ACommand) > 0 thenSender.Stop;print(ACommand);end;if AValues.Values['depth'] '' thenprint('DP: ' + AValues.Values['depth']);beginclear;// Search engine and load itname := DataPath + 'Engines\Rybka\1-cpu\w32\Rybka 4 w32.exe';e := TSEngine.Create(name);e.OnEngMsg := 'OnEngMsg';if e.Started thenbegin// You may use low level UCI commandse.SetPosition('startpos moves c2c4 e7e5');e.SendUciCommand('setoption name hash value 32');e.AnalyseToDepth(8);endelsebeginShowMessage('Engine was not started. Please check the path '+name);end;e.Free;end.3.4.5 Test Suite//For AqScripter beta version 3.11varRegExp: TRegExpr;s: string;TTag: TXMLTag;e: TSengine;beginclear;s := 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -';e := TSEngine.Create('data\Engines\Rybka 3 1-cpu w32.exe', false);if e.Started then//params: type of test, EPD, bestmove, mintime of analysis, maxtime, mindepth, delay(how long to hold result and evaluatie.TestSuite(tstBestMoveAndEval, s, 'e2e4', 5, 20, 7, 4, 9);print(e.TestRes);e.Free;end.

http://chessok.com/aqtiki/tiki-print_multi_pages.php44 of 144 26.05.2011 19:563.5 How to work with other useful thingsRegular expressionsRegular expressions allow you to process strings. See a description of class TRegExpr in our manual.Script one: RegExp.XMLTags.Using this class you can store your data as XML tree. For example, parse Aquarium Config files.Script two: XMLTags.For more information, refer to the manual, classes TXMLParser and TXMLTag3.5.1 RegExpFor more info on regular expressions look herehttp://en.wikipedia.org/wiki/Regular_expressions

http://chessok.com/aqtiki/tiki-print_multi_pages.php45 of 144 26.05.2011 19:56//For Aquarium 4.0.6//regular expressions, usage example//Regular expression help to process lines or text//usually used to find out the needed information from the whole text//for example, files with certain extension//Here we process floating-point numbersvarRegExp: TRegExpr; //object that processes expressionss: string; //string to processbegin//Smart entering a numberInputQuery('Enter floating-point number', 'Number (e.g. 3,5 or 5.66)', s);// creating objectRegExp := TRegExpr.Create;// guarantee to free memorytry//-------------Example 1---------------------------//it means: we must find 3 parts in our line => 3 pairs of brackets//the first and the third are integers//the second is either full stop or commaRegExp.Expression := '(\d+)([.,])(\d+)';// do search; s - source string//Use Exec if you want your expression to be appended to a line once//and ExecNext is used to append it as much times as possible//ExecNext is used only AFTER Execif RegExp.Exec (s) thenrepeatprint('Whole number: '+ RegExp.Match[0]); //first match = whole expressionprint('Integer part: '+ RegExp.Match[1]); //second match = first bracketsprint('Divider : '+ RegExp.Match[2]); //third match = second bracketsprint('Fractional part: '+ RegExp.Match[3]);//forth match = third brackets//Substitute is used to put one match instead of another = exchange matchesprint(RegExp.Substitute('$3$2$1'));until not RegExp.ExecNextelseprint('Entered string doesn''t contain number in required format!');//------------ Example 2-------------------------------//This expression lloks for construction like//anything - am - anything - ; - anythingRegExp.Expression := '.* am (.*);.*';if RegExp.Exec('blablabla; am Ra1; bm e4') thenbeginprint('am:' + RegExp.Match[1]); //returns what stayes sfter amend;//------------ Example 3-------------------------------//This expression lloks for construction like//anything - am - anythingRegExp.Expression := '.* am (.*)';if RegExp.Exec('blablabla; am Ra1') thenbeginprint('am:' + RegExp.Match[1]); //returns what stayes sfter amend;

http://chessok.com/aqtiki/tiki-print_multi_pages.php46 of 144 26.05.2011 19:563.5.2 XMLTags

http://chessok.com/aqtiki/tiki-print_multi_pages.php47 of 144 26.05.2011 19:56//Please, before starting a script, specify an AqPath variable://Debug-User VAriables, Add AqPath, the VAlue is a path to your Aquarium folder//(where Auarium.exe lies). Add a slash after it! For example: C:/Program Files/Aquarium/varroot: TXMLtag; //root tagengines: TXMLTag;//engine tagt: TXMLTag;e: TSEngine; //engine objectpath: string; //path to the engineAqPath1: string;function GetPath (ATag: TXMLTag): string;beginengines := TXMLTag.Create; //Creating a child tagengines := ATag.FindChild('Engines'); //filling tags with datafor i:=0 to engines.ChildCount-1 dobegint := engines.Children[i];//search throgh all the childrenif t.Values['name'] = 'Rybka 3 w32' then // looking for the needed enginebegins := Copy(t.Values['path'], 3, Length(t.Values['path']));//creating a half of pathlineresult := AqPath1 + s;//making a path from the one found in XML and a special user variableend;end;Engines.Free;end;beginpath := '';AqPath1 := 'D:\Petr\Exe\'root := TXMLTag.Create;//creating a tagroot := LoadXML('data/engines.xml'); //loading an XML tree from fileif Assigned (root) then //check that succeedpath := GetPath(root);if path '' thenbegine := TSEngine.Create(path); //creating an engine objectif e.Started thenbeginprint ('engine started');//Starting analyzes := e.AnalyseToDepth(12);//Inserting into an XML tagroot.ClearChildren; //clear the root tagroot.TagName := 'Analyse'; //setting a tagname//Creating a first childEngines := TXMLTAg.Create(root);Engines.TagName := 'Engine';Engines.Values['Path'] := path;//Setting values//Creating a "grandchild"t := TXMLTag.Create(Engines);t.Values['an_res'] := s;t.TagName := 'Data';//Setting valuest.Values['Eval']:=e.Eval;t.Values['Depth'] := e.Depth;

http://chessok.com/aqtiki/tiki-print_multi_pages.php48 of 144 26.05.2011 19:564 AqScripter ManualTable of contents:AqScripter syntaxFormattingAquarium classesCommon classesClass TSNodeInfoClass TSMoveInfoClass TSAnnotationClass TSSearchInfoCommon functionsClasses for processing Aquarium data objectsTree classesClass TSTreeScannerClass TSTreeJoinerClass TSTreeConfigurationDatabase classesClass TSDatabaseClass TSGameClass TSGameHeaderClasses for working with the enginesClass TSEngineIDeA classesTIDeATaskTIDeAQualityTIdeaProjectInfoTIdeaTreeExpandOptionsTIdeaProlongationOptionsTIdeaRootNodeTIdeaProjectNoteFunctions that work only in IDeAFunctions that work only in IDeA Project viewDelphi classesClass TObjectListClass TStringListOther ClassesClass TVariantListClass TPropertyListTCustomProperty

http://chessok.com/aqtiki/tiki-print_multi_pages.php49 of 144 26.05.2011 19:56Class XMLParserClass TXMLTagClass TRegExprClass TBackgroundEventReleasing objectsProcedures used in Aquarium onlyFunctions that work everywhereFunctions that work only in IDeAFunctions that work only in IDeA Project viewFunctions working with GameViewFunctions working in database4.1 AqScripter syntaxAqScripter is an instrument to write small programs for Aquarium. Look in the Tutorial? for the examples and most popular scripts, and in the list of claHere we give a description of a syntax used in AqScripter. It will be familiar to everyone, who has ever worked in Delphi or Pascal.Script structureMain keywordsThe main body of script is written between begin and end. keywords:beginSomething happens;end.Procedures and functionsAqScripter supports functions and procedures. They must have a header and be written between begin and end; keywordsprocedure ProcedureOne;beginSomething happens;end;beginend.ProcedureOne;Procedures and functions can have parameters. They must have a specified type (delimited by ':') and are written in brackets after a header, like this:procedure ProcedureOne (AParam: SomeType);beginSomething happens;end;beginend.ProcedureOne(FParam);

http://chessok.com/aqtiki/tiki-print_multi_pages.php50 of 144 26.05.2011 19:56Functions, unlike procedures, must have result of a specified type. It is written after the parameters delimited by ':'. Like this:function FunctionOne(AParam: SomeType): AnotherType;beginSomething happens;Result := Something;end;beginend.AResult := FunctionOne(FParam);VariablesTo work with all this parameters and types, we use variables. They're written after a keyword var. Variables must be of specified type, which is writtenfunction FunctionOne(AParam: SomeType): AnotherType;varAvar: SomeType;beginSomething happens;Result := Something;end;If we need a variable for the whole script or for main body, it is written in the very top of the page, like this:VarAresult: AnotherType;function FunctionOne(AParam: SomeType): AnotherType;varAvar: SomeType;beginSomething happens;Result := Something;end;beginend.AResult := FunctionOne(FParam);Supported variables are:integer – integerdouble – floating‐point numeralsstring – stringschar – characterstext: text filesBoolean: true and falseFor example:

http://chessok.com/aqtiki/tiki-print_multi_pages.php51 of 144 26.05.2011 19:56VarAResult: string;Function FunctionOne(AParam: integer): string;varAvar: string;beginSomething happens;Result := Avar;end;beginend.AResult := FunctionOne(FParam);ClassesCreating objectsAqScripter has a set of its own classes, together with some auxiliary ones and common Delphi classes. The whole list of them is in the list of classesVarScanner: TSTreeScanner;beginScanner := TSTreeScanner.Create(path);end.Look up in the manual the full description of Create function for every class.Releasing objectsWhen you create an object (and any instance of any class, that starts with the letter 'T' is an object)m you need to release it, to free memory. For this, FVarScanner: TSTreeScanner;beginScanner := TSTreeScanner.Create(path);Scanner.Free;end.Also note that you need to free an object only after you have stopped working with it. For example, if you have created an object, and then have writtThis is very important for a TSMoveInfo class, because every instance of TSNodeInfo class has an array of MoveInfos. More info on releasing is inCommon operatorsConditionsThere're two condition operators: if and caseIF is used if you have no more than two possible cases. It has the following syntax:For one case, a is a conditionif a thenbeginSomething;Something;end;

http://chessok.com/aqtiki/tiki-print_multi_pages.php52 of 144 26.05.2011 19:56Begin and end; are compulsory if there're two or more lines between them. If you have only one line, begin and end; can be omitted.For two cases, a is a conditionif a thenbeginSomething;Something;endelsebeginSomething;Something;end;Note, that before else you shouldn't put ';' symbol, neither after end, neither after a unique line of the case. Like that:if a thenSomethingelseSomething;Case is used if you have more than two cases. It has the following syntax:Case a of1:something;2:beginsomething;something;end;3: somethingelseSomething;end;Note, that here a should be a variable and 1, 2, 3 are its possible values (so a is a numeral). We have cases for a=1, a=2, a=3 and for all others we haveCyclesHere we have three types of cycle operators: for, while, and repeat.For operator is used when we know for sure, from which value to start and after which to finish. Also, it has a predefined step (1). Example:For i:=0 to 14 doBeginSomething happens 15 times;End;While operator is more flexible. It can be used when you don't know where to stop the cycle or if it should be stopped when a certain condition is satis

http://chessok.com/aqtiki/tiki-print_multi_pages.php53 of 144 26.05.2011 19:56While not a dobeginSomething happens;end;You can also exchange places of cycle and it condition. For this you need repeat operator:repeatSomething;Something;until a>0;No begin and end; is needed here.Other notes1. Every line should be finished with ';' symbol (except the one before else)2. To assign a value to a variable, we use ':=' (a:=3;). To create a condition (equals), simply '=' (if a=3 then). For "doesn't equals" condition '' symbol is u3. Boolean values are true and false.4. Negation operator is not. Conjunction operator is and, disjunction operator is or. Operands are written in () brackets5. If an object isn't assigned, it's nil.6. Comments are written a '//' symbol for one‐line comments and between {} brackets for multiline comments8. To print a string on a command line, type 'something'?;.9. To run a script, press F9. To run it line‐by‐line, press F7 and F8.10. You can have another script used in the current one, e.g. it has some useful procedures you don't want to copy. You can do it by printing on the ve{CODE}usesmy_script;{/CODE}And after that you can use the procedures of that script as if they were in the currently opened scriptFor more information on syntax, look in the Delphi tutorial4.2 FormatingYou can write you scripts as you like, but to make them readable easily, it's worth following a standard of writing, common to the users of Pascal. The1.2.3.The var, begin and end. operators that are used in the whole program, should be printed at the beginning of the line, without spaces or tabulaThe part of the code between begin and end operators and after var should have one tabulation before.After if, for, etc only code should have tabulations – begin and end should be on the same level.Recommendations:1.2.3.Don't put begin and end; for code in cycles and conditions of 1 linePut ';' in all ends of code, except the line before else, conditions and cycles.If you want to print an integer, you should convert it into a string(inttostr command). But if you want to print only an integer, don't convert it.4.3 Aquarium classesThis is classes AqScripter was designed for ‐ Aquarium data classes. They have complicated hierarchy, described here:

http://chessok.com/aqtiki/tiki-print_multi_pages.php54 of 144 26.05.2011 19:56The links don't mean parent‐child relationship, but availabilityMutual availability exists between:TSDataBase(one instance) and TSDataBaseGame?(many instances)TSNodeInfo(one instance) and TSMoveInfo(many instances)TSMoveInfo(one instance) and TSAnnotation(one instance)One‐direction availability exist betweenTSDataBaseGame?(one instance) and TSHeader(one instance)TSDataBaseGame?(one instance) and TSNodeInfo(many instances)TSTreeScanner(one instance) and TSNodeInfo(many instances)Classes TSEngine, TSTreeJoiner and TSTreeConfiguration are unavailable from any other classes.Table of contents:

http://chessok.com/aqtiki/tiki-print_multi_pages.php55 of 144 26.05.2011 19:56Common classesClass TSNodeInfoClass TSMoveInfoClass TSAnnotationClass TSSearchInfoCommon functionsClasses for processing Aquarium data objectsTree classesClass TSTreeScannerClass TSTreeJoinerClass TSTreeConfigurationDatabase classesClass TSDatabaseClass TSGameClass TSGameHeaderClasses for working with the enginesClass TSEngineIDeA classesTIDeATaskTIDeAQualityTIdeaProjectInfoTIdeaTreeExpandOptionsTIdeaProlongationOptionsTIdeaRootNodeTIdeaProjectNoteFunctions that work only in IDeAFunctions that work only in IDeA Project viewDelphi classesClass TObjectListClass TStringListOther ClassesClass TVariantListClass TPropertyListTCustomPropertyClass XMLParserClass TXMLTagClass TRegExprClass TBackgroundEvent4.3.1 Common classes

http://chessok.com/aqtiki/tiki-print_multi_pages.php56 of 144 26.05.2011 19:56This classes are labeled as 'Common', because they are used both in Trees and DataBases. Without bounds to these parent classes they loose a big pieTable of contents:Class TSNodeInfoClass TSMoveInfoClass TSAnnotationClass TSSearchInfo4.3.1.1 Class TSNodeInfo↑ Is used in: TSDataBaseGame, TSTreeScanner↓ Uses: TSMoveInfoDeclaration:varni: TSNodeInfo;This is the class used to store the information about a position and to work with it. This information isPropertiesPos: string ‐ the FEN position.Exampleni.Pos;Moves[Index: integer]: TSMoveInfo – array of moves (from 0 to Count‐1). Moves[0]=MoveExampleni.Moves[4].Move;Move: string – main move for notation,that is first move for a tree.Exampleni.Move;Sorted: [Index: integer]:integer – the array of the move indexes sorted by evaluation. Sorted[4] ‐ number of the forth best move.Exampleni.Sorted[4];//number of the forth best moveni.Moves[ni.Sorted[0]];//best move

http://chessok.com/aqtiki/tiki-print_multi_pages.php57 of 144 26.05.2011 19:56AllMoves[Index: integer]: TSMoveInfo – the list of all the moves available from this position.Exampleni.AllMoves[7];//seventh move from all that can be done from this positionBestMove: TSMoveInfo – returns a move with the biggest evaluation. Same as ni.Moves[ni.Sorted0]Examplemi := ni.BestMove;Count: integer – the number of the moves assigned to this node.Exampleni.Count;TotalCount: integer – the total number of moves theoretically available from this position.Exampleni.TotalCount;Number: integer – the number of a move.Exampleni.Number;IsWhite: boolean – side to move.Exampleni.IsWhite//returns true if white to move and false if blackVarLevel: integer – nesting level of variation, returns 0 for main level.Exampleni.VarLevel;AllBackPos: TStringList – All backward (parent) positions, that is positions from which a given one is available, and linking moves.Examplesl := ni.AllBackPos;//sl is stringlistprint (sl.Strings[0]);//first parentprint (TSMoveInfo(sl.Objects[0]).Move);//a move from a parent node to a child node

http://chessok.com/aqtiki/tiki-print_multi_pages.php58 of 144 26.05.2011 19:56Score: integer – the score of a node. Basically it the evaluation of the best move from a position, but in some cases these evaluations mExampleni.ScorePositions: integer – the number of times this position was played (Wins+Loses+Draws).Exampleni.PositionsIsCheckmate: boolean – returns TRUE if a position is a checkmate and FALSE otherwiseExampleif ni.IsCheckmate thenIsCheck: boolean – returns TRUE if a position is a check and FALSE otherwiseExampleif ni.IsCheck thenIsStalemate: boolean – returns TRUE if a position is a stalemate and FALSE otherwiseExampleif ni.IsStalemate thenPlayer: PlayerCol – side to move. Writable. Constants are WhiteCol and BlackColExampleni.PlayerCol := WhiteCol;MethodsCreate[Pos: string = '' ]: TSNodeInfo – Creating a node from a given FEN line, by default it's empty. Moves are not added.Exampleni:=TSNodeInfo.Create('r1b2k1r/5pbp/p1pqp3/3P1p2/5P2/2N3R1/P1PQB1PP/1R5K w - - ');Free ‐ Releasing an object. It is needed when you don't need to use this node any more. Note, that if you add it into a List (TObjectListExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php59 of 144 26.05.2011 19:56ni.Free;Copy:TSNodeInfo ‐ used to copy one NodeInfo into an another, as long as it's prohibited to work, for instance, with two NodeInfos ofExampleni1.Copy(ni2);//ni2 is a NodeInfo being copiedAddMove(string): TSMoveInfo – adding a move (TSMoveInfo object) into a TSNodeInfo object. Note, that it doesn't add it into a treeExampleni.AddMove(mi);//mi is TSMoveInfo objectDelete[Index: integer] – Deleting a move (TSMoveInfo object) from a TSnodeInfo objectExampleni.Delete[2];//deleting a second moveIndexOf(TSMoveInfo): integer – getting an index of a move.Examplei:=ni.IndexOf(mi);//i is integer, mi is TSMoveInfoLocateMove(string): integer – locating a move returns 1 if there's such move in a given node and 0 otherwise.Exampleb:=ni.LocateMove('e2e4');//b is BooleanSearchMove(string): TSMoveInfo – Searching for a move returns TSMoveInfo if a move exists the node and nil otherwiseExamplemi := ni.SearchMove('e2e3');//mi is TSMoveInfoNewPosition(TSMoveInfo): string – Getting a EPD string of the position that will occur after a certain move.Examples := ni.NewPosition(mi);//s is string, mi is TSMoveInfoInvertPlayer: string – Inverting the position so that the white pieces become black and vv, that means, updise down. Moves are also inExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php60 of 144 26.05.2011 19:56fen := ni.InvertPlayer;Usage examplevarni:TSNodeInfo;//creating new variable of type TSNodeInfomi:TSMoveInfo;//creating new variable of type TSMoveInfomi1:TSMoveInfo;i:integer;b:boolean;s:string;beginni := TSNodeInfo.Create('r1b2k1r/5pbp/p1pqp3/3P1p2/5P2/2N3R1/P1PQB1PP/1R5K w - - ');ni.AddMove('Qd3');ni.AddMove('Qe3');mi := ni.AddMove('Qe1');//here added three moves. white queen from d2 to d3, to e3, to e1print(ni.Moves[1].Move);//print move with number 1. Note, the numeration started by 0, then first move isni.Delete(1) //delete move with number 1.print(ni.Moves[1].Move);//print move with number 1. First move is white queen from d2 to e1, now.i := ni.IndexOf(mi); //save in i index of last move (white queen from d2 to e1)print(i);print( ni.IndexOf( ni.Moves[0].Move )); //print index of zero turn (white queen from d2 to d3)mi1 := TSMoveInfo.Create;i := ni.LocateMove('a7a5');//does it exist in treeprint(i);//print -1 if exists, 0 if it doesn'tmi := ni.SearchMove('a3a4');s :=ni.NewPosition(mi);print (ni.Pos);print (ni.Moves[4].Move);print (inttostr(ni.Sorted[4]));print (ni.Moves[ni.Sorted[0]]);//bestmove!print (ni.Move);//main move!print (ni.AllMoves[7]);//seventh move from all that can be done from this posprint (inttostr(ni.Count));//number of played movesprint (inttostr(ni.TotalCount));//number of theoretically available movesprint (booltostr(ni.IsWhite));print (inttostr(ni.VarLevel));//Level of variationprint (inttostr(ni.Positions));//how many games with this positionprint (inttosr(ni.Score));//evaluation of nodesl := ni.AllBackPos;print (sl.Strings[0]);//first parentni.Free;end.4.3.1.2 Class TSMoveInfo↑ Is used in: TSNodeInfo↓ Uses: nothingDeclaration:

http://chessok.com/aqtiki/tiki-print_multi_pages.php61 of 144 26.05.2011 19:56varmi: TSMoveInfo;This class is used to store the information about a move.PropertiesMove: string – Move is a property that returns a string like 'e2e4'. This property is rewritable.Examples := mi.Move;//s is stringScore: integer – Score returns an absolute score of a move. Writable.Examplei := mi.Score;//i is IntegerRelScore: integer – RelScore returns a relative score of a move. WritableExamplemi1.RelScore := -(mi2.Score);CPScore: integer – CpScore returns an evaluation in centipawns. WritableExamplemi.CpScore := 50;Color: mcBlue – Color returns a move color and is also writable. Constants are: mcNone, mcRed, mcGreen, mcBlue, mcOrangeExamplemi.Color := mcOrange;print(mi.Color);//mcOrange is printedWins: integer – Wins is some statistics: how many wins were made from this position. Read‐only.ExamplePrint(mi.Wins);Loses: integer ‐ Losses is a number of losses from this position. Read‐only.Example

http://chessok.com/aqtiki/tiki-print_multi_pages.php62 of 144 26.05.2011 19:56if mi1.Losses > mi2.Lossesprint(mi1.Losses)elseprint(mi2.Losses);Draws: integer – Draws is a number of draws from a position.Examplemi.Draws;Stat: integer – Total number of times this move was played (according to a tree).Examplemi.Stat;Year: integer – tghe year this move was last played in.Examplemi.Year;ELO: integer – The ELO of a move.Examplemi.ELO;Level: integer – The evaluation level of a move. E.g. 0 means level is ‐+ and eval is from 0 to 9.Examplemi.ELO;Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php63 of 144 26.05.2011 19:56varni:TSNodeInfo;mi:TSMoveInfo;beginclearni := TSNodeInfo.Create('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');mi := ni.AddMove('e2e4');mi.Score := 35;print('Move: ' + mi.Move);print('Score: '+ inttostr(mi.Score));print('RelScore:' + inttostr(mi.RelScore));print('CpScore: ' +inttostr(mi.CPScore));print('Color: '+inttostr(mi.Color));print('Wins: '+inttostr(mi.Wins));print('Loses: '+inttostr(mi.Loses));print('Draws: '+inttostr(mi.Draws));end.4.3.1.3 Class TSAnnotation^ Is used in: TSGamev Uses: NothingDeclaration:varAnnot:TSAnnotation;The objects of this class stores the annotations. Annotations are still in development, by now they store information about the engine games, but anyMethodsGetAllComments: TStringList ‐ returns all comments in a stringlist. Types of comments are in objects.Examplesl := gam.Annot.GetAllComments;//sl is Stringlistif sl nil thenprint(sl.CommaText)elseprint ('No more comments');sl.Free;GetAllCommentsByType(AType: Type): TStringList ‐ returns all comments of a given type in stringlist.Examplesl := gam.Annot.GetAllCommentsByType(antEval); //sl is Stringlistif sl nil thenprint(sl.CommaText);sl.Free

http://chessok.com/aqtiki/tiki-print_multi_pages.php64 of 144 26.05.2011 19:56SetComment(AType: Type, AComment: String): integer ‐ sets a comment, returns it number (among comments of this type).Examplei := gam.Annot.SetComment(antEval, ScoreToString(20));print(i);SetAllComments(AComments: TStringList) ‐ sets all comments to a move. Types should be in objects.Examplesl := TStringList.Create;sl.AddObject('jeans', antShortBefore);sl.AddObject('fly', antShortAfter);sl.AddObject('tomato', antLongBefore);sl.AddObject('blue', antLongAfter);sl.AddObject(ScoreToString(4), antEval);gam.Annot.SetAllComments(sl);SetAllCommentsByType(AType: Type, AComments: TStringList) ‐ sets all comments of a given type.Examplesl := TStringList.Create;sl.Add('mama');sl.Add('papa');gam.Annot.SetAllCommentsByType(antShortBefore, sl);sl.Free;DeleteComment(AType: Type, Anumber: integer) ‐ deletes given comment.Examplegam.Annot.DeleteComment(antShortBefore, i);DeleteAllCommentsByType(AType:Type) ‐ deletes all comments of a given type.Examplegam.Annot.DeleteAllCommentsByType(antEval);DeleteAllComments ‐ simply deletes everything.Examplegam.Annot.DeleteAllComments;SearchComment(AType: Type, AComment: String): integer ‐ returns a number of a given comment among the comments of a givenExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php65 of 144 26.05.2011 19:56i := gam.Annot.SearchComment(antShortBefore, 'mama');ReplaceComment(Atype: Type, ANumber: Number, Acomment: string) ‐ replacing a comment with a given number with ACommenExamplegam.Annot.ReplaceComment(antShortAfter, i, 'swim');InsertComment(Atype: Type, ANumber: Number, Acomment: string) ‐ – inserting a given comment into a given place.Examplegam.Annot.InsertComment(antLongBefore, 0, 'swim');Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php66 of 144 26.05.2011 19:56//For AqScripter version 3.11vardb: TSDataBase;gam: TSGame;sl: TStringList;sl1: TStringList;ni: TSNodeInfo;i: Integer;ant: TSAnnotation;begincleardb := TSDataBase.Create('Data\ABases\Comment.cdp');if db.Opened thenbegingam := db.ReadGame(1, true);if gam nil thenbeginant := gam.Annot;//setting evaluation for first move (b1c3), printing itni := gam.LnGoTo(4, true);print (ni.Pos);mi := ni.Moves[0];print (mi.Move);ShowProgressBar(7);i := ant.SetComment(antEval, ScoreToString(4));print(i);sl := ant.GetAllCommentsByType(antEval);if sl nil thenbeginfor i := 0 to sl.Count - 1 doprint(IntToStr(StringToScore(sl.Strings[i])));sl.Free;end;SetProgress(1);//Deleting eval comment, printing all commentsAnt.DeleteAllCommentsByType(antEval);sl := Ant.GetAllComments;if sl nil thenbeginprint(sl.CommaText);sl.Free;endelseprint ('No more comments');SetProgress(2);//Setting all comments of 1 type, finding one of them, deleting it//and printing what is leftsl := TStringList.Create;sl.Add('mama');sl.Add('papa');gam.Annot.SetAllCommentsByType(antShortBefore, sl);SetProgress(3);sl.Free;i := Ant.SearchComment(antShortBefore, 'mama');Ant.DeleteComment(antShortBefore, i);sl := Ant.GetAllComments;

http://chessok.com/aqtiki/tiki-print_multi_pages.php67 of 144 26.05.2011 19:564.3.1.4 Class TSSearchInfo↑ Is used in: Nothing↓ Uses: NothingDeclaration:varsi: TSSearchInfo;It is a very special class used to work with file system(FindFirst, FindNext). It can store the name of the file, the time it was last modified, the size of thePropertiesName: string – getting a filename.Examplesi.Name;Time: integer – getting the time when the file was last modifiedExamplesi.Time;Size: integer – getting a size of the fileExamplesi.Size;Attr: integer – returns file attributes: faReadOnly, faHidden, faSysFile, faVolumeID, faDirectory, faArchive.Examplesi.AttrMethodsCreate: TSSearchInfo – creates an objectExamplesi := TSSearchInfo.Create;

http://chessok.com/aqtiki/tiki-print_multi_pages.php68 of 144 26.05.2011 19:56Free() ‐ releasing an object.ExampleSi.Free;Usage examplevarsi: TSSearchInfo;beginsi := TSSearchInfo.Create;ChDir(InputPath(ExePath));if FindFirst('*.cdp', faAnyFile, si) = 0 thenbeginrepeatprint(si.Name);until FindNext(si) 0FindClose(si);end;si.Free;print('ok');end.4.3.2 Common functionsPrint (string) – printing a string on a command lineExampleprint('mama');Clear – clears consoleExampleclear;Assignfile(f: text, filename: string) ‐ opens a file with a given filenameExampleassignfile(f, 'Data\Text\Text1.txt');Reset(f: text) ‐ file opens for readingExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php69 of 144 26.05.2011 19:56Reset(f);Rewrite(f: text) ‐ file opens for writingExampleRewrite(f);ExePath: string – getting a path from where AqScripter is executedExamplename := ExePath + 'data\ABases\comment.cdp';InputQuery(StartPath: string): string – path dialogExampleInputQuery('Enter floating-point number', 'Number (e.g. 3,5 or 5.66)', s);FindFirst (Path: string; Attr: integer; Info: SearchInfo): integer – searching for the first instance of a file name with a given set of attributes incode.Exampleif FindFirst('*.cdp', faAnyFile, si) = 0 then//si is TSSearchInfoFindNext(Info: TSSearchInfo): integer ‐ getting the next entry matching the name and attributes specified in a previous call to FindFirst. ReturExampleFindNext(si) 0FindClose(Info: TSSearchInfo) ‐ terminating a FindFirst/FindNext sequenceExampleFindClose(si);FindFirstInDbNotInTree(Game: TSDataBaseGame, Tree: TSTreeScanner):String Finds first node that exists only in the databaseExampleprint(FindFirstInDBNotInTree(dbg, tree));ToFullEPD(EPD: String):String converts EPD to FullEPD

http://chessok.com/aqtiki/tiki-print_multi_pages.php70 of 144 26.05.2011 19:56Exampleprint(ToFullEPD(EPD));IsIsolated(EPD: String, Square: String):boolean check if a figure is isolatedExampleif IsIsolated(epd, p) thenIsCentralBlocked(EPD: String):boolean check if a figure is blockedExampleif IsCentralBlocked(epd) thenMaterialDiff(EPD: String, DiffOptions: boolean):String returns difference between white and black. When DiffOptions is true, returns onlyExampleprint(MateriaDiff(EPD, true));RenameFile(OldFile, NewFile: String):renames the file.ExampleRenameFile('myoldfile.txt', 'mynewfile.txt');DeleteFile(Filename: String): deletes given fileExampleDeleteFile('myfile.txt');ForceDirectories(Path: String):boolean creates a new directory as specified in Path, which must be a fully‐qualified path name. If the directoriereturns True if it successfully creates all necessary directories, False if it could not create a needed directory.ExampleForceDirectories('c:/scripter/path');ParseEPD(EPD: String):TXMLTag returns an XMLTag, where 'FEN' value contains FEN, 'bm' ‐ bestmove, c0‐ evaluation and so on.Example

http://chessok.com/aqtiki/tiki-print_multi_pages.php71 of 144 26.05.2011 19:56epd := 'r2rqbk1/p1n3p1/1p1pPpPp/P1p2P2/6Q1/2N1B1P1/1P4K1/R6R w - - 0 1 bm Be3h6; c0 97;';TTAg := PArseEPD(epd);print(TTAg.Values['FEN']);print(TTag.Values['bm']);print(TTag.VAlues['c0']);TTag.Free;4.3.3 Classes for processing Aquarium data objects

http://chessok.com/aqtiki/tiki-print_multi_pages.php72 of 144 26.05.2011 19:56This is classes AqScripter was designed for ‐ Aquarium data classes. They have complicated hierarchy, described here:The links don't mean parent‐child relationship, but availabilityMutual availability exists between:TSDataBase(one instance) and TSDataBaseGame?(many instances)TSNodeInfo(one instance) and TSMoveInfo(many instances)TSMoveInfo(one instance) and TSAnnotation(one instance)One‐direction availability exist betweenTSDataBaseGame?(one instance) and TSHeader(one instance)TSDataBaseGame?(one instance) and TSNodeInfo(many instances)TSTreeScanner(one instance) and TSNodeInfo(many instances)Classes TSEngine, TSTreeJoiner and TSTreeConfiguration are unavailable from any other classes.

http://chessok.com/aqtiki/tiki-print_multi_pages.php73 of 144 26.05.2011 19:56Table of contents:Tree classesClass TSTreeScannerClass TSTreeJoinerClass TSTreeConfigurationDatabase classesClass TSDatabaseClass TSGameClass TSGameHeader4.3.3.1 Tree classesTrees is the most popular way for storing chess data. AqScripter has three classes working with trees.Table of contents:Class TSTreeScannerClass TSTreeJoinerClass TSTreeConfiguration4.3.3.1.1 Class TSTreeScanner↑ Is used in: Nothing↓ Uses: TSNodeInfoDeclaration:vart: TSTreeScanner;The most common class, that work provides most of the Aquarium tree functionality. The instances of this class can scan the tree consecutive or recursor whatever he or she wants. It also has a number of implemented methods and properties. Scanning is done on a event‐driven system.You can find here how tp work with currently opened treesPropertiesOpened: boolean – checking if the tree is opened.Exampleif t.Opened thenCurrentNode: TSNodeInfo – current node the scanner is positioned onExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php74 of 144 26.05.2011 19:56n := AScanner.CurrentNode;//n is TSNodeInfoName: string ‐ storing a path to a tree.Examples := t.Name; //s is stringScanOpt: integer – gets and sets Scan Options, that are tssMoves, tssStat, tssColor or its combination (that means which of them wiExamplet.ScanOpt := tssMoves;MinValue: integer – minimal value (in percents) for move selection in scanning, 0 by default.Examplet.MinValue := 45;PosLoc: position selection for precessing (only internal nodes, leaves, all). Correspondent values are: plInternal, plConcluding, plInterExamplet.PosLoc := plInternal;MaxValue: integer – maximal value (in percents) for move selection in scanning, 100 by default. (MinValue:= 0; MaxValue:=100 meansExamplet.MaxValue := 55;GameExists: boolean – returns true if there's a game attached to the Current positionExampleif t.GameExists thenMethodsCreate(Path: string; ReadOnly:boolean = true; CanCreate:boolean = false; AMemory:integer=64) – create the object (PathExample// Opening tree to create:t := TSTreeScanner.Create('cap.hsh', false, true);// Opening tree as read-onlyt := TSTreeScanner.Create('cap.hsh');

http://chessok.com/aqtiki/tiki-print_multi_pages.php75 of 144 26.05.2011 19:56Free() ‐ releasing an objectExamplet.Free;Reset() – resetting a tree.Examplet.Reset;StartRecursive (StartPos: string = '') – making a recursive scan from a given position (start position by default)Examplet.ScanRecursive('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');StartConsecutive() – making successive scan (faster than recursive)Examplet.ScanConsecutive;StopScan() ‐ stopping scan.Examplet.StopScan;AbortNode() ‐ stops scanning the current node and goes to the next one.Examplet.AbortNode;Search(TSNodeInfo): TSNodeInfo ‐ searching for a node (returns TSNodeInfo)Exampleni1 := t.Search(ni2)// ni1, ni2 is TSNodeInfoSearchFEN(string): TSNodeInfo – searching for a node by EPD string (returns TSNodeInfo)Exampleni := t.SearchFEN('rnbqkbnr/pppppppp/8/8/8/5N2/PPPPPPPP/RNBQKB1R b KQkq -');// ni is TSNodeInfo

http://chessok.com/aqtiki/tiki-print_multi_pages.php76 of 144 26.05.2011 19:56Locate(TSNodeInfo) boolean – Locating a node (returns boolean, true found)Exampleif t.Locate(ni) then// ni is TSNodeInfoLocateFEN(string):boolean – Locating a node by EPD (returns Boolean, true if found)Exampleif t.LocateFEN('rnbqkbnr/pppppppp/8/8/8/5N2/PPPPPPPP/RNBQKB1R b KQkq -') then// ni is TSNodeInfoDoMove(string):boolean – makes a move from the current position. Works like NewPosition, but for a tree.Exampleif t.DoMove(mi) then//mi is TSMoveInfoAdd(TSNodeInfo):boolean ‐ adds a position into the tree.Exampleb := t.Add(ni);//b is boolean, ni is TSNodeInfoAddFen(string): boolean – adding a node by EPD (returns TSNodeInfo)Exampleb := t.AddFen('rnbqkbnr/pppppppp/8/8/8/5N2/PPPPPPPP/RNBQKB1R b KQkq -');//b is boolean, ni is TSNodeInfoAddMove(string): boolean – adding a move (returns a true if added)Exampleif t.AddMove(mi) then//mi is TSMoveInfoDeleteMove (string): Boolean – deleting a move (return true if deleted)Exampleif t.DeleteMove(mi) then//mi is MoveInfoUpdateMove(TSMoveInfo): Boolean ‐ updating move, need to be called if a move was edited (e.g. its Score)Examplet.UpdateMove(mi);//mi is TSMoveInfo

http://chessok.com/aqtiki/tiki-print_multi_pages.php77 of 144 26.05.2011 19:56GenerateMoves(TSNodeInfo): boolean ‐ generating all possible moves from a given position. Node: adds all possible moves that are nExamplet.GenerateMoves(ni);//ni is TSNodeInfoGenerateBackMoves(TSNodeInfo): boolean – generating all backward moves from current position.Examplet.GenerateBackMoves(ni);// ni is TSNodeInfoGetRootNodes: TStringList – finding root nodes.Examplesl := t.GetRootNodes;//sl is StringListIsEndNode(TSNodeInfo): boolean – checking if a given node is an endnodeExampleif t.IsEndNode(ni) then//ni is TSNodeInfoMarkNode(TSNodeInfo): boolean – marking a given moveExamplet.MarkNode(ni);//ni is TSNodeInfoIsMarked(TSNodeInfo): boolean – checking if a move is markedExampleif t.IsMarked(ni) then//ni is TSNodeInfoSetNodeScore(integer) ‐ setting a score of a node (of a node that is located)Examplet.SetNodeScore(25);//ni is TSNodeInfoGetGame:TSGame ‐ returns the game attached to the Current position and nil otherwiseExamplegam := t.GetGame;

http://chessok.com/aqtiki/tiki-print_multi_pages.php78 of 144 26.05.2011 19:56Check checks if the tree is not corruptedExampleif t.Check thenAquarium Tree Utils functionalityExportEPD(AEPD: string)integer ‐ Exporting tree into a epd file (only posotions)Exampleepd := 'Data\epd\export.epd';//filei := t.ExportEPD(epd);print(i);//number of positions//t is any tree you likeImportEPD(AEPD: string)integer ‐ Importing tree from a epd file (positions, moves and evaluations)Exampleepd := 'Data\epd\exported2.epd'//epd filei := t.ImportEPD(epd);print(i);//number of positions//t is any tree you likeFilterEPD(ASourceEPD, ADestinationEPD, AposControl: string): integer‐ Filtering a epd file. Compares a epd file and a tree and writnot in treeExamples := 'data\Atrees\d2m.hsh';\\tree to compareepd := 'Data\epd\exported2.epd';\\source filefiltered := 'Data\epd\filtered2.epd';\\output file\\APosControl are 'pExclude' or 'pPreserve't := TSTreeScanner.Create(s);t.FilterEPD(epd, filtered, 'pExclude');ShowMessage(Format('Filter done see %s', [filtered]))DedupeEPD(inputfile, outputfile: string) ‐ eliminating duplicate nodes. Output parameter can be omitted, so it will be generExamplet.DedupeEpd(inputepd, outputepd);//inputepd, outputepd – path to files// ort.DedupeEpd(inputepd);ImportTreeDifference(InputTree, SubtractedTree: string)boolean ‐ subtracting trees, returns a tree that has nodes from Input tree anExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php79 of 144 26.05.2011 19:56t := TSTreeScanner.Create('Data\Atrees\out4.hsh', false, true);if t.Opened thenbeginif t.ImportTreeDifference('DATA\ATrees\cap.hsh', 'Data\Atrees\idea.hsh') thenprint('Subtract Done')elseprint('Subtract not done');end;ImportTreeComparison(InputTree, ComparedTree: string)boolean ‐ subtracting trees, returns a tree that has nodes from Input tree aExamplet := TSTreeScanner.Create('Data\Atrees\out1.hsh', false, true);if t.Opened thenbeginif t.ImportTreeComparison('Data\Atrees\nnt.hsh', 'Data\Atrees\idea.hsh') thenprint ('Compare done')elseprint ('Compare not done');end;CompressTrees(InputTree:string)integer ‐ rebuilds tree if its neededExamplet := TSTreeScanner.Create('Data\Atrees\cap_compressed2.hsh', false, true);if t.Opened thenbeginif t.CompressTree('Data\Atrees\cap.hsh') = 0 thenprint ('Compress done')elseprint ('Compress not done');end;ExportSubtree(AInputTree, AFEN:string)integer ‐ Saves a subtree from a given position into another tree, returns number of positiExamplet := TSTreeScanner.Create('Data\Atrees\out2.hsh', false, true);if t.Opened thenprint(t.ExportSubtree('Data\Atrees\cap.hsh', 'r1bqkb1r/pppp1ppp/2n5/1B2p3/4n3/5N2/PPPP1PPP/RNBQ1RK1 w kq -' ));ExportSubTreeToEPD(AFEN, AEPD:string; AAllLines:boolean; ExpSet:string; MinValue, MaxValue:integer)boolean ‐ Exports a submainline, ExpSet sets whether all leaves ('EsAll'), internal ('exInternal') or endnodes (exConcluding) are processed and MinValue and MExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php80 of 144 26.05.2011 19:56t := TSTreeScanner.Create('Data\Atrees\out1.hsh', false, true);if t.Opened thenbegins := 'data\Atrees\cap.hsh';Afen := 'rnbqkbnr/pppp1ppp/8/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R b KQkq -';epd := 'Data\epd\subepd2.epd'i := t.ExportSubtreeTOEPD(AFEn, epd, true, 'exAll', -30000, 30000);if i thenShowMessage(Format('Export done, see %s', [epd]))elseShowMessage('Export not done');end;JoinTrees(AJoinTreePath: string; AOutputTreePath: string; Stat, Eval, Move, Ant, Avar:TJoinType; Pos: TAddPositionsModeto take this info. Constants are: jrNo (from nowhere), jrJoin(Join), jrSrc(source tree), jrAtt(Attached tree), jrSrcPrior(priority to source),apInter(Intersection). You cannot join Moves and Stat with jrSrcPrior and jrAttPrior.Examplesrc.JoinTrees(att, dst, jrJoin, jrJoin, jrJoin, jrJoin, jrJoin, apInter);Minimax(AFen: string) ‐ minimaxing a tree.Examplet.Minimax(''); // minimaxes all the treet.Minimax('8/8/8/8/5K2/8/2k5'); // minimaxes from FENMultipleMinimax(sl:TStringList) ‐ minimaxing a tree from all positions in StringList.Examplet := TSTreeScanner.Create('Data\Atrees\cap.hsh', false);if t.Opened thenbeginsl := TStringList.Create;sl.LoadFromFile('Data\EPD\minimax.epd');t.MultipleMinimax(sl);sl.Free;ShowMessage('Minimaxed');end;ImportSubtree(outputtree, FEN: string):integer ‐ generating Subtree from a given node (as a EPD line) and writes it to a .hsh‐fileExampleprint(t.ImportSubtree('out.hsh', 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -'));EventsOnInit – The procedure that should be called before scanning start. Profile: function(): boolean; if result is False – scanning will not be

http://chessok.com/aqtiki/tiki-print_multi_pages.php81 of 144 26.05.2011 19:56Examplet.OnInit := 'DoBeforeScanning';OnTerminate – The procedure that should be called after scanning finish. Profile: procedure().Examplet.OnTerminate := 'DoAfterScanning';OnProcessNode – The procedure that should be called for every scanning position. Profile: procedure(Info: TSTreeScanner). Fills the fall moves from the current position, presented in the tree. Fields Move, Score, RelScore, Color are automatically filled with proper infoExamplet.OnProcessNode := 'OnScan';OnProcessTransposition – the procedure is called in case of reentering to a position, i.e. in case of reaching position by another path.Examplet.OnProcessTransportation := 'DoIfReenter';OnProcessStartBranch ‐ The procedure is called at the start of processing some move and line after it. Profile: procedure(Move:Examplet.OnProcessStartBranch := 'DoWhenBranchStart';OnProcessEndBranch ‐ The procedure is called at the end of line scanning starting with some move. Profile: procedure(Move:Examplet.OnProcessEndBranch := 'DoWhenBranchEnd';OnProcessBacksolve ‐ The procedure is called in case of processing all lines for the position. Profile: procedure().Examplet.ProcessBacksolve := 'DoWhenAllLines';OnProcessEndLine ‐ The procedure is called in case if the current position is not found. Profile: procedure().Examplet.OnProcessEndLine := 'DoWhenNotFound';Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php82 of 144 26.05.2011 19:56vart: TSTreeScanner;AFen: String;i: integer;procedure OnScan(Ascanner: TStreeScanner)varnn: TSNodeInfo;beginnn := Ascanner.CurrentNode;inc(i);end;begint:=TSTreeScanner.Create('Data/Atrees/cap.hsh')if t.Opened thenbegini := 0;t.OnProcessNode := 'OnScan';Afen := 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -';t.StartRecursive;print (inttostr(i) + ' positions')//Nodes in the whole treet.Free;end.4.3.3.1.2 Class TSTreeJoiner↑ Is used in: Nothing↓ Uses: NothingDeclaration:varTJoiner: TSTreeJoinerA very special class, that does only one, but important procedure – it joins and minimaxes a very big and a very small tree, and does it much faster thanMethodsSmartJoin(bigtree, smalltree: string) ‐ smart join.ExamplevarTJoiner: TSTreeJoiner;beginTJoiner := TStreeJoiner.Create('Data\Atrees\output.hsh');//Creating an objectTJoiner.SmartJoin('Data\Atrees\Cap.hsh', 'Data\ATrees\Idea.hsh');//bigtree, smalltreeShowMessage('ok');end.4.3.3.1.3 Class TSTreeConfiguration

http://chessok.com/aqtiki/tiki-print_multi_pages.php83 of 144 26.05.2011 19:56↑ Is used in: Nothing↓ Uses: NothingDeclaration:varConfig: TSTreeConfigurationA special class used to work with tree configurations of Aquarium. By now only several functions are available, they are getting and setting play probabTo get it work, copy files tree_configurations.xml and RBaseTrees.xml from Config folder of Aquarium to the Config folder of AqScripter, andMethodsCreate(string): TSTreeConfiguration ‐ creating a configuration: takes the Aquarium name of a configuration (here 'NarrowBook')ExampleTSConfig := TSTreeConfiguration.Create('NarrowBook');//OpenConfigGetPlayProbabilityPercents(TSNodeInfo, MoveNumber: integer): integer ‐ getting play probability (in percents). Gets TSNodeInfo, fExampleTSConfig.GetPlayProbabilityPercents(ni, 1);//ni is ModeInfo, 1 is numberSetManualPercent(Percents: Integer, TSNodeInfo, MoveNumber: integer): boolean ‐ setting play probability (in percents). Gets PeExampleTSConfig.SetManualPercent(12, ni, 1);//12 is percents, ni is NodeInfo, 1 is Move numberGetMoveColor(TSNodeInfo, TSMoveInfo): string ‐ getting colors of the move (as strings). Gets TSNodeInfo, from where to take a moExampleTSConfig.GetMoveColor(ni, mi);//ni is NodeInfo, mi is MoveInfoSetMoveColor(TSNodeInfo, TSMoveInfo, movecolor: TSMoveColor): boolean ‐ setting colors of the move (also as strings. Constantsmove number and color constant.ExampleTSConfig.SetMoveColor(ni, mi, tmcRed);//ni is NodeInfo, mi is MoveInfo, tmcRed is constantSearchFEN(string): TSNodeInfo ‐ returns the node with all moves for the given string and nil if it doesn't exist. Should be freed after u

http://chessok.com/aqtiki/tiki-print_multi_pages.php84 of 144 26.05.2011 19:56Exampleni := TSConfig.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');Usage example//For AqScripter version beta 4.0.2//Works with TreeConfigurations of Aquarium//To get it work, copy config and atrees folders of Aquarium into the directory of AqScripter.exevarTSConfig: TSTreeConfiguration;t: TStreeScanner;ni: TSNodeInfo;beginTSConfig := TSTreeConfiguration.Create('NarrowBook');//OpenConfigni := TSConfig.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');if ninil thenbeginTSConfig.SetManualPercent(12, ni, 1);//Set Play Propability percents: percents, nodeinfo, number of moveTSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[0]], tmcRed); //Set ColorsTSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[1]], tmcBlue);//nodeinfo, moveinfo, colorTSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[2]], tmcOrange);TSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[3]], tmcGreen);TSConfig.SetMoveColor(ni, ni.Moves[ni.Sorted[4]], tmcPurple);ni := TSConfig.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');if ni nil thenbeginprint(inttostr(TSConfig.GetPlayProbabilityPercents(ni, 1)));// get play probability percentprint(inttostr(TSConfig.GetPlayProbabilityPercents(ni, ni.Sorted[0]))); //nodeinfo, move numbverprint(ni.Moves[ni.Sorted[0]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[0]]));//get colorprint(ni.Moves[ni.Sorted[1]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[1]]));//nodeinfo, moveinfoprint(ni.Moves[ni.Sorted[2]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[2]]));print(ni.Moves[ni.Sorted[3]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[3]]));print(ni.Moves[ni.Sorted[4]].Move +': ' +TSConfig.GetMoveColor(ni, ni.Moves[ni.Sorted[4]]));end;ni.Free;endelseShowMessage('No position!');TSConfig.Free;end;4.3.3.2 Database classesAquarium provides many instruments to work with chess databases, the most important and useful of them are also available from AqScripter.Table of contents:Class TSDatabaseClass TSGameClass TSGameHeader

http://chessok.com/aqtiki/tiki-print_multi_pages.php85 of 144 26.05.2011 19:564.3.3.2.1 Class TSDatabase↑ Is used in: Nothing↓ Uses: TSGameDeclaration:vardb: TSDataBase;This class operated with the database itself. The main functionality is to read and write or re‐write games.Also, look here for how to work with currently opened base in Aquarium.MethodsCreate(Path: string): TSDatabase – creating a database object from a given path (and creates an empty database if it doesn't exist)Exampledb := TSDataBase.Create('Data/ABases/comment.cdp');ReadGame(Index: integer, AWithFlags: boolean): TSGame – reading a game with a given number, returns a TSGame objectTSGame works.Examplegam := db.ReadGame(2, true);//Reading a game Number 2 with flags, gam is TSGameNewGame: TSGame – creating a new game that will be the last in the list of the games, returns a TSGame objectExamplegam := db.NewGame;//Creating a new gamedbg.AddMove('e2e4'); //adding a new moveWriteGame(Game: TSGame):boolean – writing a gameExampledb.WriteGame(gam);Free() – release database object. Note, that since there's no garbage collector in Scripter, the object must always be released to free thExampledb.Free;

http://chessok.com/aqtiki/tiki-print_multi_pages.php86 of 144 26.05.2011 19:56CommentGame(Game: TSGame): – Adds to a game a comment "Novelty" sicut Hugebase and inserts a game(s) with a move(s) that wExampledb.CommentGame(gam);PropertiesCount: integer ‐ number of games in the database.Exampledb.Count;Opened: boolean ‐ the database was opened.Exampleif db.Opened thenUsage example #1vardb: TSDatabase; // Declare database objectbegin// Create database object// ExePath contains the Scripter folder pathpath := ExePath + 'data\ABases\comment.cdp';db := TSDatabase.Create(path);// if database existsif db.Opened thenbegin// Print text message in Scripter consoleprint('opened');// Show message box with number of games in the databaseShowMessage(format('%d',[db.Count])+' games');// Free memory for database objectdb.Free;end;end.4.3.3.2.2 Class TSGameIs used in: TSDataBaseUses: TSGameHeader, TSNodeInfo, TSAnnotationDeclarationvargam: TSGame;

http://chessok.com/aqtiki/tiki-print_multi_pages.php87 of 144 26.05.2011 19:56This is the main class working with a database game. The games in the database can be scanned forward and backward, same as tree, with opportunievaluation and text comment – to a chosen move. The game header is also stored in this class. The game has no Create method, it is read by ReadGamLook here to find how to work with currently opened game in AquariumPropertiesCurrentNode: TSNodeInfo – current node the game is positioned onExampleni := gam.CurrentNode;Header: TSGameHeader – contains header of the game in TSGameHeader object.Exampleprint(gam.Header.Result);Annot: TSAnnotation – provides access to the annotation. Works with current move.Exampleprint(gam.Annot.GetAllComments);Flags: integer – provides access to the flags.Exampleprint(gam.Flags);TotalCount: integer – number of moves in the whole gameExamplefor i:=0 to gam.TotalCount-1 doLineCount: integer ‐ getting the number of moves in the current lineExamplei := gam.LineCount;TotalCount: integer ‐ getting the number of moves in the whole gameExamplei := dbg.TotalCount;

http://chessok.com/aqtiki/tiki-print_multi_pages.php88 of 144 26.05.2011 19:56VariationsCount: integer ‐ getting the number of variations from current moveExamplei := dbg.VariaitonsCount;IsInVariant:Boolean ‐ checking whether current line is a variationExampleif dbg.IsInVariant thenIsAfterMove:Boolean ‐ returns true, when we stay after the current move, and false otherwiseExampleif dbg.IsAfterMove thenTotalIndex:integer ‐ returns the number of the current move.Examplek := gam.TotalIndex;MethodsCreate:TSNodeInfo– Creates a new empty game.Examplegam := TSGame.Create;LoadFromPGN(PGN: String):– creates a game of a pgn‐string, e.g. copied from Aquarium using right‐clicl on Notation>Copy>Copy gaExamplegam.LoadFromPGN(PasteFromClipboard)SetStartPos(AFEN:String)– Sets a given position as a start position of a game.Examplegam.SetStartPos('r2rqbk1/p1n3p1/1p1pPpPp/P1p2P2/6Q1/2N1B1P1/1P4K1/R6R w - -');LoadUCIString(UCIString:String)– loads into a game a string in uci‐format, like this'position startpos moves e2e4 e7e5'or this

http://chessok.com/aqtiki/tiki-print_multi_pages.php89 of 144 26.05.2011 19:56'position fen r2rqbk1/p1n3p1/1p1pPpPp/P1p2P2/6Q1/2N1B1P1/1P4K1/R6R w ‐ ‐ moves d5d6'Examplegam.LoadUCIString('position startpos moves e2e4 e7e5');ScanGameForward(AMainOnly: boolean = True) – scan game starting from the first move. If AMainOnly is not specified or is set toevent on every position.Exampledbg.ScanGameForward(False);ScanGameBackward() – scan game in backward direction starting from the end (scans only main variation). Invokes OnScanExampledbg.ScanGameBackward;StopScan() – stop the ongoing scan of the game.Exampledbg.StopScan;It's a number of GoTo procedures. Note, that moves are now always counted from 1!!So, if you type LnGoTo(2, true) you'll get FEN after the second move and player will be white. if you type LnGoTo(2, false), you'll get FEN after the firstsecond move (including it).LnGoTo(Index: integer, AAfter: boolean): TSNodeInfo – going to a move number Index within current line. When AAfter is false, we sExampleni := gam.LnGoTo(1, true);//after move number 1, moves are counted from 1ni := gam.LnGoTo(1, false);//to start positionTotalGoTo(Index: integer, AAfter: boolean): TSNodeInfo – going to a move number Index in the whole game. When AAfter is false, wExampleni := gam.TotalGoTo(1, true);//after move number 1, moves are counted from 1ni := gam.TotalGoTo(1, false);//to start positionLnGoToFEN(AFEN: String): TSNodeInfo ‐ going to a certain FEN position within current line.Exampleni := gam.LnGoToFEN(12);//ni is TSnodeInfo

http://chessok.com/aqtiki/tiki-print_multi_pages.php90 of 144 26.05.2011 19:56MainLineGoTo(AMoveNumer: integer, AAfter: boolean): TSNodeInfo ‐ going to a move number Index within the mainline. When AAExampleni := gam.MainLineGoTo(12, false);// ni is TSNodeInfo;MainLineGoToFEN(AFEN: String): TSNodeInfo ‐ going to a certain FEN position within mainline.Exampleni := dbg.MainLineGoToFEN(' rnbqkbnr/p1pppppp/8/1p6/4P3/8/PPPP1PPP/RNBQKBNR w KQkq -', false);//ni is TSNodeInfo;NewLine(AMoves: String): integer ‐ adding a new variation to a current move. Adding moves is compulsory! If there's more than oneExamplei := gam.NewLine('b7b5 h2h4');AddMove(AMove: String) ‐ adding move to a current line.Examplegam.AddMove('a7a5');AddMoves(Amoves: String; AMoveTypes: TSMoveType) ‐ adding number of move to a current line. It might be of three MoveTypes:tsNumbers means, that there're numbers of moves.Examplegam.AddMoves('1.h6h5 2.g2g4', tsNumbers);DeleteMoves ‐ deletes current move and all that's after it.Examplegam.DeleteMove;ReturnToUpperLine: TSNodeInfo ‐ going back from variation to upper level, where a variation startsExampleni:=gam.returnToUpperLine;//ni is TSNodeInfoReturnToMainLine: TSNodeInfo ‐ going back to mainline, where the current variation or its parent(s) startExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php91 of 144 26.05.2011 19:56ni := gam.ReturnToMainLine;//ni is TSNodeInfoGoToStartPos: TSNodeInfo ‐ going to start position. Same as dbg.MainLineGoToMove(0);Exampleni := gam.GoToStartPos;//ni is NodeInfo;SelectLine(AlineNumber: integer):TSNodeInfo ‐ selecting a variation. To do it, you should be positioned on a move from which vaExampleni := gam.SelectLine(0);PushLocation ‐ "remembers" current locationExamplegam.PushLocationPopLocation ‐ positions on the location, remembered in PushLocation.Examplegam.PopLocationInvertPlayer: TSNodeInfo ‐ inverts the position upside down, so that black pieces become white and vice versa. The whole line, includExampleni := gam.InvertPlayer;Free() – Release the created game object.Exampledbg.Free;EventsOnScan procedure(Info: TSNodeInfo) – Procedure that is done while scanning. Profile: procedure (AInfo: TSnodeInfo). The following fiLevel, VarLevel, IsWhite. Currently Moves contains only one move, and only Move field is filled with the value.OnScan event is invoked from ScanGameForward / ScanGameBackward and should be reloaded with a custom procedure to process the node:Reloading OnScan

http://chessok.com/aqtiki/tiki-print_multi_pages.php92 of 144 26.05.2011 19:56procedure OnScan1(node: TSNodeInfo);beginPrint( Node.Move);// ... do something with nodeend;// ...gam.OnScan := 'OnScan1';gam.ScanGameForward(true);// ...Scanning the game is also possible with step‐by‐step GoTo procedure:Alternative scanningfor i := 0 to dbg.LineCount - 1 dobeginnode := dbg.GoTo(i, true);print(node.Move);// ... do something else with nodeend;An example of a scriptUsage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php93 of 144 26.05.2011 19:56vardb: TSDatabase; // Database objectgam: TSGame; // Game objectf: text; // Text file objects: TStringList;h: TSGameHeader;// Printing information about a move// This procedure is assigned for processing moves in ScanGameForward procedureprocedure OnScan1(si: TSNodeInfo);begin// si.Level - ply number// si.VarLevel - 0 - main line; 1 - variant for main line; ...// si.Move - notation of the moveWriteLn(f, Format('fwd: %.3d [%d]: %s (%s)', [si.Level, si.VarLevel, si.Pos, si.Move]));end;// Printing information about a move// This procedure is assigned for processing moves in ScanGameBackward procedureprocedure OnScan2(si: TSNodeInfo);beginWriteLn(f, Format('bwd: %.3d [%d]: %s (%s)', [si.Level, si.VarLevel, si.Pos, si.Move]));end;begin// Create database object and open databasepath := ExePath + 'data\ABases\comment.cdp';if FileExists(path) thenprint ('Database found')elseprint ('Database not found');db := TSDatabase.Create(path);// If database is foundif db.Opened thenbegin// Create db_script.log fileAssignFile(f, 'db_script.log'); Rewrite(f);s := TStringList.Create;// Inform about number of games in the databaseShowMessage(format('%d',[db.Count])+' games');// Read game #19gam:= db.ReadGame(19, true);if gam.Opened thenbeginh:= gam.Header;print (h.Result);// Scan forwardgam.OnScan := 'OnScan1';gam.ScanGameForward(False);// Scan backwardsgam.OnScan := 'OnScan2';gam.ScanGameBackward;gam.Free;gam:= db.ReadGame(20, true);

http://chessok.com/aqtiki/tiki-print_multi_pages.php94 of 144 26.05.2011 19:564.3.3.2.3 Class TSGameHeaderIs used in: TSGameDeclarationvarh:TSGameHeader;This is a small class that contains a header of a game – such as who played black and white, where and when did this game take place, and its result.All properties are writable.PropertiesEvent: String ‐ A tournament/match where the game was playedExamplegam.Header.Event := 'Memorial Rosenwald';Site: String ‐ place where a game took placeExamplegam.Header.Site := 'New York (USA)';Date: String ‐ Date of the gameExamplegam.Header.Date := '1956.03.25';Black: String ‐ Who played blackExamplegam.Header.Black := 'Fischer Robert J (USA)';White: String ‐ Who played whiteExamplegam.Header.White := 'Bisguier Arthur B (USA)';Result: String ‐ The result of the gameExamplegam.Header.Result := '1-0';

http://chessok.com/aqtiki/tiki-print_multi_pages.php95 of 144 26.05.2011 19:56GameNo: integer ‐ the number of a gameExamplegam.Header.GameNo := 19;Round: String ‐ the round in a tournamentExamplegam.Header.Round := '?';WhiteELO: integer ‐ ELO rating of white playerExamplegam.Header.WhiteELO := 2256;BlackELO: integer ‐ ELO rating of black playerExamplegam.Header.BlackELO := 2780;** ECO: string ‐ returns ECO of a game.Examplegam.Header.ECO := 'E78';Some codeUsage exampleif gam nil thenbeginh:= gam.Header;print (h.White);end;4.3.4 Classes for working with the enginesTable of contents:Class TSEngine4.3.4.1 Class TSEngineIs used in: NothingUses: Nothing

http://chessok.com/aqtiki/tiki-print_multi_pages.php96 of 144 26.05.2011 19:56Declarationvar:e: TSengine;This is the class that works with engines. The analysis can be started by uci command and stopped either directly (used when you want every line to becan set an analysis position and process the response, as it is returned both as a whole line or parsed.MethodsCreate(Path: string, Log:boolean) – create engine object (Path – the path to engine, Log ‐ whether to hold an engine log).Examplee:=TSEngine.Create('data\Engines\Rybka v2.3.2a.exe', true);Free() – Release the created engine object.Examplee.Free;AnalyseToTime(Time: integer) – Start position analysis; Time – time in milliseconds for analysisExamplee.AnalyseToTime(1000);AnalyseToTime(Depth: integer) – Start position analysis; Depth – up to which depth to analyzeExamplee.AnalyseToDepth(9);SendUCICommand(Cmd: string) – send UCI‐command for the engine. It is not supposed that sending UCI commands is the commonscripts.Examplee.SendUciCommand('setoption name hash value 32');SetPosition(Position: string) – set the position specified in the full UCI – format (for example, 'startpos moves e2e4' or 'fen rnbqkbnr/Examplee.SetPosition('startpos moves c2c4 e7e5');SetFEN(FEN: string) – set the position specified as EPD string.Example

http://chessok.com/aqtiki/tiki-print_multi_pages.php97 of 144 26.05.2011 19:56e.SetFen('rnbqkbnr/8/8/8/8/8/8/RNBQKBNR w KQkq -');SetIgnoreMoves(Moves: string) – specify the ignored moves, comma is the separator between moves (for example 'e2e4,d7d8q'Examplee.SetIgnoreMoves('e2e4');Stop – stops the analysisExamplee.Stop;TestSuite(TestType:TSTestType; epd, Move: string; mintime, maxtime, mindepth, delay, evaluation: integer) – Creating a Test SuiTestType(tsBestMove, tsBadMove, tsbestEval, tsBestMoveAndEval), which sets what to check: whether it finds the best move, or bmove is move to analyze, mintime, maxtime (in seconds) and mindepth are parameters of engine. Delay is for how long should the ancan be set as ‐1 – if so, they won't be taken in accountExamplee.TestSuite(tstBestMoveAndEval, s, 'e2e4', 5, 20, 7, 4, 9);print(e.TestRes);PropertiesStarted: boolean – it is TRUE if the engine started successfully.Exampleif e.Started thenEval: integer – The evaluation of last analyzed position (absolute).Examplee.Eval;Depth: integer – The depth of the last analyzed positionExamplee.Depth;Time: integer – The time of the last analyzed positionExamplee.Time;

http://chessok.com/aqtiki/tiki-print_multi_pages.php98 of 144 26.05.2011 19:56Nodes: integer – The number of nodes of the last analyzed positionExamplee.Nodes;NPS: integer – Nodes per second of the last analyzed positionExamplee.NPS;PV: string – Principal variationExamplee.PV;LastResponse: string – Last response from the engine.Examplee.LastResponse;LastPV: string – the last pv received from the engine.Examplee.LastPV;Bestmove: string – Best move calculated by engine after Stop command or after end of analysisExamplee.BestMove;Ponder: string – Ponder calculated by engine after Stop command or after end of analysisExamplee.Ponder;TestRes: string –Result of test suiteExamplee.TestRes;

http://chessok.com/aqtiki/tiki-print_multi_pages.php99 of 144 26.05.2011 19:56EevntsOnEngMsg procedure(Info: TSNodeInfo) – For determining procedures done with every engine response. Profile: procedure OnExamplee.OnEngMsg := 'OnEngMsg';Some useful codeUsage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php100 of 144 26.05.2011 19:56vare: TSEngine; // Engine objects: string;procedure OnEngMsg(Sender: TSEngine; AResponse: integer; AValues: TStringList; ACommand: string);beginif Pos('depth 6', ACommand) > 0 thenSender.Stop;print(ACommand);{ case AResponse ofrcId, rcUciOk, rcReadyOk, rcCar3Ok, rcCbr3Ok: print('ok command');rcOption: print('opt command');//rcBestMove, rcCopyProtection, rcRegistration, rcInfo, rcResponse,elseprint('other command');end; }end;if AValues.Values['depth'] '' thenprint('DP: ' + AValues.Values['depth']);beginclear;// Search engine and load itname := 'data\Engines\Rybka 3 1-cpu w32.exe'e := TSEngine.Create(name, true);e.OnEngMsg := 'OnEngMsg';if e.Started thenbegin// You may use low level UCI commandse.SetPosition('startpos moves c2c4 e7e5');e.SendUciCommand('setoption name hash value 32');e.SetFen('rnbqkbnr/8/8/8/8/8/8/RNBQKBNR w KQkq -');e.SetIgnoreMoves('');e.AnalyseToDepth(8);print('Last response: '+ e.LastResponse);print('Last PV: '+ e.LastPV);print('Last TimeLine: '+ e.LastTime);//last line with time updateprint('Last DepthLine: '+ e.LastDepth);//last line with depth updateprint('Last Eval: ' + IntToStr(e.Eval));print('Last Depth: ' + IntToStr(e.Depth));print('Last Time: ' + IntToStr(e.Time));print('Last Nodes ' + IntToStr(e.Nodes));print('Last NPS: ' + IntToStr(e.NPS));print('Last PV: ' + e.PV);//string!endelsebeginShowMessage('Engine was not started. Please check the path '+name);end;e.Free;end.4.3.5 IDeA classes

http://chessok.com/aqtiki/tiki-print_multi_pages.php101 of 144 26.05.2011 19:56There're three IDeA classes: TIDeATask, TIDeAQuality, and TIdeaProjectInfoTIDeATaskTIDeAQualityTIdeaProjectInfoTIdeaTreeExpandOptionsTIdeaProlongationOptionsTIdeaRootNodeTIdeaProjectNoteFunctions that work only in IDeAFunctions that work only in IDeA Project view4.3.5.1 TIDeATask↑ Is used in: Nothing↓ Uses: TIDeAQuality, __TBackgroundEvent?__This is a special task class, that is provides an easy way to make tasks and add them to IDeA.Declaration:vartask: TIDeATask;ProperiesFEN:String ‐ getting and setting a FEN of a taskExampletask.FEN;ProlongDepth: integer ‐ for how many moves the branch is played furtherExampletask.prolongDepth := 10;AltCount: integer ‐ how many alternatives to findExampletask.AltCount := 2;AltMinScore: integer ‐ the lower bound of the score of an alternative (or in autoplay)Example

http://chessok.com/aqtiki/tiki-print_multi_pages.php102 of 144 26.05.2011 19:56task.AltMinScore := 300;AltMaxScore: integer ‐the upper boundExampletask.AltMaxScore := 450;UserTask: booleanif true, task gets higher proirityExampletask.UserPriority := true;IgnoreMoves: stringline of moves to ignore, such as 'e2e4,d2d4,c1d3'Exampletask.IgnoreMoves := 'e2e4 d7d5';Quality: TIdeaQuality ‐ an TIDeAQuality objectExampletask.Quality := AQuality;Event: TBackGroundEvent ‐ a TBackgroundEvent object?Exampletask.Event := ev;//see example for background eventMethodsCreate ‐ creates a task object.Exampletask := TIDeATask.Create;SetUciPosition(APosition: string) loads UCI string into a task.

http://chessok.com/aqtiki/tiki-print_multi_pages.php103 of 144 26.05.2011 19:56Exampletask.SetUCIPosition('startpos e2e4');SetQuality(ATime: integer; ADepth: integer; AOp: integer; AWaitNextDepth: boolean; AMaxTime: integer) ‐ sets Task qualityExampleSetQuality(1000, 14, 1, false, 1300)4.3.5.2 TIDeAQuality↑ Is used in: TIDeATask, TIDeAProjectInfo↓ Uses: nothingThis is a quality of IDeA task. It has only propertiesDeclaration:varq: TIDeAQuality;PropertiesTime: integer ‐ getting and setting time for a task;Exampleq.Time := 1000;Depth: integer ‐ getting and setting Depth for a task;Exampleq.Depth := 14;Op: integer ‐ getting and setting options of a task: 0 ‐ Time OR Depth; 1 ‐ Time AND DepthExampleq.Op := 1;WaitNextDepth: boolean ‐ sets whether to wait for next depth in analysis or notExampleq.WaithNextDepth := true;MaxTime: integer ‐ getting and setting max time for a task;

http://chessok.com/aqtiki/tiki-print_multi_pages.php104 of 144 26.05.2011 19:56Exampleq.MaxTime := 2000;4.3.5.3 TIdeaProjectInfo↑ Is used in: Nothing↓ Uses: TIDeAQuality, TIdeaTreeExpandOptions, TIdeaProjectNoteDeclaration:varIdPr: TIDeAProjectInfo;This is a class that contains all information about the IDeA project.PropertiesID: integer ‐ the unique ID of the project. It's read‐onlyExampleprint(IdPr.ID);Active: boolean ‐ returns true, if project is activeExampleif IdPr.Active thenDescription: String ‐ the description of a project. It's also read‐onlyExampleprint(IdPr.Description);ProjectState: TProjectState ‐ returns the state of the project. Can be: ipsIdle, ipsWaitingTaskGeneration, ipsWaitingAnalysis, ipsWaitiExampleif IdPr.ProjectState = ipsIdle thenProjectType: TprojectType ‐ returns the type of the project. Can be iptLocal, iptRemoteExampleif Idpr.projectType = iptRemote then

http://chessok.com/aqtiki/tiki-print_multi_pages.php105 of 144 26.05.2011 19:56CpuUsage: integer ‐ the per cent of CPU used.ExampleIdPr.CpuUsage := 50;AutoProlongation: Boolean ‐ Should the analysis queue be expanded (using IDEA methods) or notExampleIdPr.AutoProlongation:= true;AnalysisTreeName: Boolean ‐ the name of the current IDeA tree.ExampleIdPr.AnalysisTreeName:= 'Mytree';MasterTreeName: Boolean ‐ the name of the current Maser tree(if exists).ExampleIdPr.MasterTreeName:= 'Mytree';StorageFileName: String ‐ the name of the XML‐file, read‐onlyExampleIdPr.StorageFileName:= 'file.xml';TreeConfigName: String ‐ the name of the tree configuration used for the projectExampleIdPr.TreeConfigName:= 'IDEA';QualitySettings: TIdeaQuality ‐ the setting of the project (default)ExampleIdPr.QualitySettings.Time:= 1000;RootNodes: TStringList ‐ the list of the project root nodes. Objects in RootNodes stringlist are integers of node state: 0 is disabled, 1 isExampleprint(IdPr.RootNodes.Strings[0]);//first root

http://chessok.com/aqtiki/tiki-print_multi_pages.php106 of 144 26.05.2011 19:56TreeExpandOptions:TIdeaTreeExpandOptions ‐ options of tree expand.Exampleprint(IdPr.TreeExpandOptions.TreeWidth);//first rootProjectNotes: TObjectList ‐ the list of notes. Notes are TIdeaProjectNoteExamplevarol: TObjectList;beginend;ol := IdPr.ProjectNotes['Good'];4.3.5.4 TIdeaTreeExpandOptionsIs used in: TIDeAProjectInfoUses: TIdeaProlongationOptions,DeclarationvarTrEx: TIDeATreeExpandOptionsPropertiesTreeWidth: integer ‐ Tree width percentage, 0‐100. 0 meas the narrowest tree, 100 ‐ the widest.ExampleTrEx.TreeWidth := 56;WhiteAlternativesLimit: integer ‐ Alternatives limit for White. When set, disables alternative search when the appropriate limit is reachExampleTrEx.WhiteAlternativesLimit:= 4;BlackAlternativesLimit: integer ‐ Alternatives limit for Black. When set, disables alternative search when the appropriate limit is reachExampleTrEx.BlackAlternativesLimit:= 4;VariationLengthLimit: integer ‐ No variation is prolongated if its length is above (or equal to) this number. Zero setting disables the lim

http://chessok.com/aqtiki/tiki-print_multi_pages.php107 of 144 26.05.2011 19:56ExampleTrEx.VariationLengthLimit:= 14;ProjectMinScore: integer ‐ Score bounds for the project. Any leaves with score outside of the bounds are not considered.ExampleTrEx.ProjectMinScore:= 7;ProjectMaxScore: integer ‐ Score bounds for the project. Any leaves with score outside of the bounds are not considered.ExampleTrEx.ProjectMaxScore:= 15;FalseAlarmCheckEnabled: Boolean ‐ Shows whether the 'false alarm check' is enabled or notExampleTrEx.FalseAlarmCheckEnabled := true;FalseAlarmCheckDepth: Integer ‐ Number of plies the 'better' alternative is prolongated when false alarm check is on.ExampleTrEx.FalseAlarmCheckDepth := 6;FalseAlarmCheckMaxDelta: Integer ‐ If cumulative score difference > FalseAlarmCheckMaxDelta, then FA check is not performedExampleTrEx.FalseAlarmCheckMaxDelta:= 3;ThematicMovesString: Integer ‐ Additional string setting for thematic moves. Both moves and additional parameters are set in it.ExampleTrEx.ThematicMovesString:= 'e2e4';MainlineVerificationEnabled: Integer ‐ Shows whether the mainline verification is enabled.ExampleTrEx.MainlineVerificationEnabled:= true;OnEndOfStageScript: string ‐ Path to outer script which is used to generate tasks

http://chessok.com/aqtiki/tiki-print_multi_pages.php108 of 144 26.05.2011 19:56ExampleTrEx.OnEndOfStageScript:= true;OnEndOfStageScriptEnabled: boolean ‐ returns true if a script for the end‐of‐state is enabledExampleTrEx.OnEndOfStageScriptEnabled:= true;ProlongationOptions: TIdeaProlongationOptions ‐ Prolongation optionsExampleTrEx.ProlongationOptions.ProlongationNodesFraction:= 4,5;4.3.5.5 TIdeaProlongationOptions↑ Is used in: TIdeaTreeExpandOptions↓ Uses: nothingThis is a quality of IDeA task. It has only propertiesDeclaration:varPrOp: TIdeaProlongationOptions;PropertiesProlongationNodesFraction: Double ‐ fraction of all leaf nodes that are prolongatedExamplePrOp.ProlongationNodesFraction := 6,7;ProlongationCount0: Integer Maximum number of nodes to prolongate, with width=0.ExamplePrOp.ProlongationCount0 := 3;ProlongationCount100: Integer Maximum number of nodes to prolongate, with width=100. Other values are linearly interpolated betwExamplePrOp.ProlongationCount100 := 14;ScoreCategoryLevel0: Integer Score category level: the leaves with lower category are picked first.

http://chessok.com/aqtiki/tiki-print_multi_pages.php109 of 144 26.05.2011 19:56ExamplePrOp.ScoreCategoryLevel0:= 4;ScoreCategoryLevel100: Integer Score category level: the leaves with lower category are picked first. Other values are linearly interpoExamplePrOp.ScoreCategoryLevel100:= 16;PreferredSideMask: Integer 1*White + 2*Black. Don't prolongate suboptimal answers to preferred side's suboptimal moves.ExamplePrOp.PreferredSideMask:= 1;4.3.5.6 TIdeaRootNode↑ Is used in: TIDeAProjectInfo↓ Uses: TSGameDeclaration:varr1: TIDeARootNode;PropertiesEnabled: boolean – checking if the root is enabledExampleif r1.Enabled thenEval: integer – sets eval between ‐1 and 100.Exampler1.Eval := 100;Comment: string – checking if the root is enabledExampleprint (r1.Comment);FEN: string – checking if the root is enabledExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php110 of 144 26.05.2011 19:56print (r1.FEN);MethodsCreate – create the rootExampler1 := TIDeARootNode.Create;Assign(Another: TIdeaRootNode) – assign a rootExampler1.Assign(r2);CopyToGame(Game: TSGame) – copies to a GameExampler1.CopyToGame(gam);FillFromGame(Game: TSGame) – takes roots from a gameExampler1.FillFromGame(gam)Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php111 of 144 26.05.2011 19:56varproj: TIdeaProjectInfo;r1, r2: TIdeaRootNode;roots: TObjectList;i: integer;gm: TSGame;beginclear;r1 := TIdeaRootNode.Create;r1.FEN := 'r1bqkb1r/ppp2ppp/2n5/3np1N1/2B5/8/PPPP1PPP/RNBQK2R w KQkq - 0 6';r1.Comment := 'Test 1';r1.Enabled := False;AddIdeaRootNode(r1); // deprecated methodproj := GetCurrentProject;if Assigned(proj) thenbeginr2 := TIdeaRootNode.Create;r2.Assign(r1);r2.Comment := 'Test 2';proj.RootNodes.Add(r2); // new methodgm := TSGame.Create;gm.AddMove('e2e4');gm.LnGoTo(gm.LineCount, True);gm.AddMove('e7e5');r2 := TIdeaRootNode.Create;r2.Comment := 'Test 3';r2.FillFromGame(gm);gm.Free;proj.RootNodes.Add(r2); // new methodend;UpdateCurrentProject(proj);gm := TSGame.Create;roots := proj.RootNodes; // just for conviniencefor i := 0 to roots.Count - 1 dobeginr1 := TIdeaRootNode(roots.Items[i]);r1.CopyToGame(gm);print(Format('%d: %s [%d] %s (%d)',[i, Copy(r1.FEN, 1, 20), r1.Eval,r1.Comment, gm.LineCount]));end;gm.Free;end.4.3.5.7 TIdeaProjectNoteIs used in: TIDeAProjectInfoUses: TSGameDeclaration

http://chessok.com/aqtiki/tiki-print_multi_pages.php112 of 144 26.05.2011 19:56varPrN: TIDeAProjectNote;PropertiesComment : string ‐ A comment itselfExamplePrN.Comment:= 'some comment';Date: string ‐ A date of a commentExamplePrN.Date:= '01.01.2001 12:34:24';MethodsCreate() – creating a noteExamplePrN := TIdeaProjectNote.Create;Assign(Another: TIdeaProjectNote) – creating a noteExamplePrN.Assign(PrN2);//Prn2 is TIdeaProjectNote;FillFromGame(gam: TSGame) – loading notes from a gameExamplePrN.FillFromGame(gam);Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php113 of 144 26.05.2011 19:56varproj: TIdeaProjectInfo;notelist: TObjectList;i: integer;n1, n2: TIdeaProjectNote;beginclear;proj := GetCurrentProject;if Assigned(proj) thenbeginnotelist := proj.ProjectNotes['Good'];for i := 0 to notelist.Count - 1 dobeginn1 := TIdeaProjectNote(notelist.Items[i]);print(Format('%d: %s [%d - %d] %s (%s)',[i, Copy(n1.FEN, 1, 20), n1.InitEval, n1.CurrentEval,n1.Comment, n1.Date]));end;n1 := TIdeaProjectNote.Create;n1.Comment := 'test';n1.Date := '02.09.2010 14:29:07';notelist.Add(n1);n2 := TIdeaProjectNote.Create;n2.Assign(n1);n2.Comment := 'Test 2';proj.ProjectNotes['Critical'].Add(n2);gm := TSGame.Create;gm.AddMove('e2e4');gm.LnGoTo(gm.LineCount, True);gm.AddMove('e7e5');gm.LnGoTo(gm.LineCount, True);n2 := TIdeaProjectNote.Create;n2.Comment := 'Test 3';n2.FillFromGame(gm);gm.Free;notelist.Add(n2);end;end.UpdateCurrentProject(proj);4.3.5.8 Functions that work only in IDeAThese are so beloved functions that can add tasks to IDeA, or Root node, etcAddIdeaTask(ATask:TIdeaTask):boolean: adds IDeA TIDeATask.ExampleAddIdeaTask(MyTask)AddIdeaRootNode(root:TIdeARootNode): adds IDeA task.

http://chessok.com/aqtiki/tiki-print_multi_pages.php114 of 144 26.05.2011 19:56ExampleAddIdeaRootNode('1Q1q3r/1p1k1pp1/p7/n2p3p/r2P3P/2P5/5PP1/1R2R1K1 w', 'myIdeaRoot');GetIdeaTree:TSTreeScanner creates a tree from an IDeA projectExamplet := GetIDeATree;GetIdeaStage:integer: returns a stage Constants are tesProlong, tesAlternative, tesDeepProlong, tesMainlineVerificationExamplei := GetIDeAStage;AddIdeaTask(ATask:TIdeaTask): adds IDeA task.Exampleni1 := t.Search(ni2)// ni1, ni2 is TSNodeInfoGetIdeaActiveRootNodes:TStringList: returns a list of active IDeA root nodes in FEN strings;Examplesl := GetIDeAActiveRootNodes;GetIdeaTotalRootNodes:TStringList: returns a list of all IDeA root nodes in FEN strings;Examplesl := GetIDeATotalRootNodes;StopTaskGeneration stops IDeAExampleIdeaForceStop;ContinueTaskGeneration makes IDeA continue analysis.ExampleIdeaForceContinue;UpdateCurrentProj(AProject:#c30:TIdeaProjectInfo~~)~~ updates the project so the changes start working (allowed one time at theExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php115 of 144 26.05.2011 19:56UpdateCurrentProj(IdPr);4.3.5.9 Functions that work only in IDeA Project viewIDEA_Running:Boolean– returns true is a project is runningExampleif IDEA_Running thenIDEA_Start– starts IDeAExampleIDEA_Start;IDEA_Stop(WaitTasksToFinish:Boolean, Minimax AfterFinish:Boolean, MakeAccuratePositionCount: Boolean)– Stops IDeA with givExampleIDeAStop(flase, true, false);//stops IDeA and minimaxes after finish4.3.6 Delphi classesTable of contents:Class TObjectListClass TStringList4.3.6.1 Class TObjectList↑ Is used in: Nothing↓ Uses: NothingDeclaration:varol: TObjectListIt is a list of objects. A Delphi object is any descendant of the class TObject. In this class any data not bigger than 4 bytes can be stored (note, that floatadd or remove items, clear the whole list, insert items into a certain place and get their indexes. For more information see any Delphi or Pascal manualMethods

http://chessok.com/aqtiki/tiki-print_multi_pages.php116 of 144 26.05.2011 19:56Create(OwnsObject: boolean): TObjectList – creating an objectObjectList should accept only boolean as parameter. String is treated as False.If the OwnsObjects property is set to True (the default), TObjectList controls the memory of its objects, freeing an object when its index is reassigned; wTObjectList instance is itself destroyed.If you store Integers in the list instead of objects, Scripter tries to free memory on deletion and causes access violation on this.Exampleol := TobjectList.Create(true);Add(TObject): integer – adding an item into a listExampleol.Add(AObject);Clear() – delete all the items from a list.Exampleol.Clear;Delete(integer) – deleting one item by its number.Exampleol.Delete(45);Remove(TObject) – removing an object from a list, returns its number.Examplei:= ol.Remove(Aobject);//I is integerIndexOf(TObject): integer – getting an index of an object.Examplei:=ol.IndexOf(AObject);Insert (Index: integer, Object: TObject) – inserting an object to a given place.Exampleol.Insert(12,AObject);PropertiesItems[Index: integer]: TObject – items of a list. Writable.

http://chessok.com/aqtiki/tiki-print_multi_pages.php117 of 144 26.05.2011 19:56ExampleAObject := ol.Items[2];ol.Items[4] := AObject;Count: integer – number of the objects.Examplefor i:=0 to ol.Count-1 doUsage examplevarol: TObjectList;i: integer;ni: TSNodeInfo;begin…ol := TObjectList.Create;for i:=0 to ni.Count-1 dool.Add(ni.Moves[i].Anot);for i:=0 to ol.Count-1 doprint (inttostr(TSAnnotation(ol.Items[i]).Eval));ol.Free;end.4.3.6.2 Class TStringList↑ Is used in: NONE↓ Uses: NONEDeclaration:varsl: TStringList;This very list contains, in the first place strings that are text lines. Also to every string an object can be added. You can carry the same operations as witValues, etc. For more information see any Delphi or Pascal manual.MethodsCreate: TStringList – creates an object.Examplesl := TobjectList.Create(true);Add(string): integer – adding a string into a list

http://chessok.com/aqtiki/tiki-print_multi_pages.php118 of 144 26.05.2011 19:56Examplesl.Add('aaa');AddObject(string, Tobject):integer – adding a string AND an object into a list.Examplesl.AddObject('aaa', Aobject);//Aobject is of class TObjectAssign(AnotherList:TStringList) – Assigns one list to another.Examplesl1.Assign(sl2);//sl1, sl2 - stringlistsDelete(integer) ‐ deleting an item by number.Examplesl.Delete(2);Clear – deleting all strings.Examplesl.Clear;GetText: boolean – getting stringlist as a text, delimited by CRLF.Examplesl.GetText//returns item1, item2, item3 each on its own lineExchange(AFirst: integer, ASecond: integer) ‐ exchange places of the strings.Examplesl.Exchange(7, 12);IndexOf(string): integer – getting Index of a string.Exampleif sl.IndexOf('mama') > 12 thenIndexOfName(string): integer ‐ getting index o a name.

http://chessok.com/aqtiki/tiki-print_multi_pages.php119 of 144 26.05.2011 19:56Exampleif sl.IndexOfName('brother') < 0//that means that there's no item 'brother'Insert(Place: integer, Line: string) ‐Inserting a string into a given place.Examplesl.Insert(3, 'mama');//'mama' is put on the third placeInsertObject(Place: integer, Line: string, Object: TObject) – inserting a string AND an object into a given place.Examplesl.InserObject(3, 'mama', AObject);//AObject is TObjectLoadFromFile(FileName: string) – loading a stringlist from a file . The strings in the file should be separated with ‘;’Examplesl.LoadFromFile('strings.txt');SaveToFile(FileName:`string) – saving a stringlist, separated by ‘;’ to a file.Examplesl.SaveToFile('strings.txt');SetText(string) ‐ setting text.Examplesl.SetText('mama');//all stringlist consists of 'mama'Sort – sortes the strings alphabeticallyExamplesl.Sort;PropertiesDuplicates: dupIgnore, dupAccept, dupError – setting and getting what to do with duplicates. Constants are dupAccept (delete dupliExamplesl.Duplicates := dupIgnore;Sorted: boolean – gets and sets whether the list is sorted. It's false (unsorted) by default

http://chessok.com/aqtiki/tiki-print_multi_pages.php120 of 144 26.05.2011 19:56Examplesl.Sorted := true;CaseSensitive: boolean – making list case‐(in)sensitiveExamplesl.CaseSensitive := true;CommaText: string – returns all the elements in one string, separated by ‘;’.Exampleprint(sl.CommaText);Count: integer – returns the number of strings in a list.Examplefor i:=0 to sl.Count-1//cycle through all itemsDelimiter: char – setting a way to delimit stringsExamplesl.Delimiter := '%';//now when calling DelimitedText procedure you get strings delimited by '%'DelimitedText: string – creating a string with special delimitersExampleprint(sl.DelimitedText);Names[Index: integer]: string – getting and setting namesExampleprint (sl.Names[2]);//Name number 2Values[AName: string]: string – getting and setting valuesExampleprint(sl.Values[sl.Names[2]]);//Value of name number 2Strings[Index: integer]: string – getting and setting strings of a list

http://chessok.com/aqtiki/tiki-print_multi_pages.php121 of 144 26.05.2011 19:56Exampleprint(sl.Strings[3]); //string number 3Objects[Index: integer]: TObject – getting and setting objectsExamplesl.Objects[3];//returns TObjectText: string – getting all as a textExampleprint(sl.Text);Usage examplevart:TSTreeScanner;ni: TSNodeInfo;i: integer;str : TstringList;begint := TSTreeScanner.Create('data\ATrees\idea.hsh', False);//str := TStringList.Create;if t.Opened thenbeginprint ('opened');ni := t.SearchFEN('rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -');if ninil thenbeginstr := ni.AllBackPos;for i:=0 to Str.Count-1 doprint (str.Strings[i] +': '+TSMoveInfo(str.Objects[i]).Move);str.Free;end;ni.Free;end;t.Free;end.4.3.7 Other ClassesTable of contents:Class TVariantListClass TPropertyListTCustomPropertyClass XMLParserClass TXMLTag

http://chessok.com/aqtiki/tiki-print_multi_pages.php122 of 144 26.05.2011 19:56Class TRegExprClass TBackgroundEvent4.3.7.1 Class TVariantList↑ Is used in: Nothing↓ Uses: NothingDeclaration:varvl: TVariantListIt is a special class used to store items that cannot be stored into ObjectList – I mean, that are bigger than 4 bytes. For instance, floating point numeralMethodsCreate: TVariantList – creating an instanceExamplevl := TVariantList.Create(true);Add(TVariant): integer – adding an item into a listExamplevl.Add(AVariant);Clear() – delete all the items from a list.Examplevl.Clear;Delete(integer) – deleting one item by its number.Examplevl.Delete(45);Remove(TVariant) – removing an item from a list, returns its number.Examplei:= vl.Remove(AVariant);//I is integer

http://chessok.com/aqtiki/tiki-print_multi_pages.php123 of 144 26.05.2011 19:56IndexOf(TVariant): integer – getting an index of an item.Examplei:=vl.IndexOf(AVariant);Insert (Index: integer, Avariant: TVariant) – inserting an item to a given place.Examplevl.Insert(12,AVariant);PropertiesItems[Index: integer]: TVariant – items of a list. Writable.ExampleAVariant := vl.Items[2];vl.Items[4] := AVariant;Count: integer – number of the items.Examplefor i:=0 to vl.Count-1 doExamplevarvl: TVariantList;i:integer;a: integer;c: variant;beginvl := TVariantList.Create;i:=9;c := i/2;vl.Add(12.5);for i:=1 to 10 dobeginvl.Add(i/2);end;print(FloatToStr(vl.Items[4]));for i:=0 to 10 doprint(FloatToStr(vl.Items[i]));vl.Free;end.4.3.7.2 Class TPropertyList↑ Is used in: Nothing

http://chessok.com/aqtiki/tiki-print_multi_pages.php124 of 144 26.05.2011 19:56↓ Uses: TCustomProperty, TStringList, TXMLTagDeclaration:varpr: TPropertyListThis is the list of engine propertiesMethodsCreate(OwnsObject: boolean): TPropertyList – creating an objectPropertyList should accept only boolean as parameter. String is treated as False.If the OwnsObjects property is set to True (the default), TPropertyList controls the memory of its objects, freeing an object when its index is reassignedTPropertyList instance is itself destroyed.If you store Integers in the list instead of objects, Scripter tries to free memory on deletion and causes access violation on this.Examplepr := TPropertyList.Create(true);Add(TCustomProperty): integer – adding an item into a listExamplepr.Add(AProperty);Clear() – delete all the items from a list.Examplepr.Clear;Delete(integer) – deleting one item by its number.Examplepr.Delete(45);Remove(TCustomProperty) – removing an object from a list, returns its number.Examplei:= pr.Remove(Property);//I is integerIndexOf(TCustomProperty): integer – getting an index of an object.Examplei:=pr.IndexOf(Property);

http://chessok.com/aqtiki/tiki-print_multi_pages.php125 of 144 26.05.2011 19:56Insert (Index: integer, Property: TCustomProperty) – inserting an object to a given place.Examplepr.Insert(12,Property);WriteToStringList (sl: TStringList) – writing a property list into a string listExamplepr.WriteToStringList(sl);WriteToXMLTag (t: TXMLTag) – writing a property list into a XMLTagExamplepr.WriteToXMLTag(t);ReadFromXMLTag (t: TXMLTag) – reading info from an XML tagExamplepr.ReadFromXMLTag(t);PropertiesItems[Index: integer]: TCustomProperty – items of a list. Writable.ExampleProperty:=pr.Items[2];pr.Items[4] := Property;Count: integer – number of the objects.Examplefor i:=0 to pr.Count-1 doName: string – a name of a listExamplepr.Name := 'test';Usage Example

http://chessok.com/aqtiki/tiki-print_multi_pages.php126 of 144 26.05.2011 19:56varroot, t: TXMLTag;i: integer;pl: TPropertyList;sl: TStringList;beginclear;root := LoadXML('e:\Temp\engines.xml');if Assigned(root) thentryt := root.FindChild('Personalities');if Assigned(t) thenbeginpl := TPropertyList.Create;sl := TStringList.Create;for i := 0 to t.ChildCount - 1 dobeginpl.ReadFromXMLTag(t.Children[i]);if pl.Count > 0 thenif SetupPropertiesDlg(pl, pl.Name +' Setup') thenbeginpl.WriteToStringList(sl);print(sl.CommaText);Break;end;end;sl.Free;pl.Free;end;finallyroot.Free;end;end.4.3.7.3 TCustomProperty↑ Is used in: TPropertyList↓ Uses: TStringListAll the properties that can be set for the dialogues. It has a number of descendants with their own propertiesDeclaration:varprop: TCustomProperty;Of TCustomPropertyPropertiesName: string – Property nameExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php127 of 144 26.05.2011 19:56prop.Name := 'Custom';StringValue:Value: string – Getting and setting a string valueExampleprop.StringValue := 'true';ObjType: TPropTypes – reading a type of an object (read‐only!)Exampleprint (prop.ObjType);OwnerID: string – ID of an object (writable)Exampleprop.OwnerID := 'first prop';MethodsCreate(AOwnerID: string):TCustomProperty ‐ creating a propertyExampleprop := TCustomProperty.Create('property');ReadFromXMLTag(Tag: TXMLTag)Exampleprop.ReadFromXMLTag(ATag);WriteFromXMLTag(Tag: TXMLTag)Exampleprop.WriteToXMLTag(ATag);First descendantsTCustomProperty has a number of descendants. The first set of children are:TIntegerPropertyHas all the methods and properties of TCustomProperty, andValue: integer – any value. Can be read and writtenExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php128 of 144 26.05.2011 19:56prop.Value := 5;DefValue: integer – any value. Can be read and writtenExampleprop.DefValue := 8;TStringPropertyValue: string – any value. Can be read and writtenExampleprop.Value := 'aaa';DefValue: string – any value. Can be read and writtenExampleprop.DefValue := 'bbb';TBooleanPropertyValue: boolean – any value. Can be read and writtenExampleprop.Value := true;DefValue: boolean – any value. Can be read and writtenExampleprop.DefValue := false;Of TSliderPropertyDescendant of TIntegerProperty, has all its functions andMinValue:integer – Getting and setting the minimum valueExampleprop.MinValue := 4;MaxValue:integer – Getting and setting max valueExampleprop.MaxValue := 13;

http://chessok.com/aqtiki/tiki-print_multi_pages.php129 of 144 26.05.2011 19:56Of TCheckPropertyDescendant of TBooleanProperty, has all its properties. The most important isValue: boolean – Property valueExampleprop.Value:= true;Of TCombotextPropertyDescendant of TStringproperty, has all its properties andOptions: string – Property optionsExampleprop.Options := 'rare,seldom,"all the time"';Of TEditPropertyDescandant od TString property, has all its properties. Thne most important isStringValue:Value: string – Getting and setting a string valueExampleprop.StringValue := 'test';Note that only last four classes describe a dialogue, all others are invisible!Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php130 of 144 26.05.2011 19:56varpl: TPropertyList;cp: TCustomProperty;t: TXmlTag;beginpl := TPropertyList.Create;pl.Name := 'test';cp := TSliderProperty.Create(pl.Name);cp.Name := 'Sample Slider';TSliderProperty(cp).Value := 7;TSliderProperty(cp).MinValue := 0;TSliderProperty(cp).MaxValue := 15;pl.Add(cp);cp := TCheckProperty.Create(pl.Name);cp.Name := 'Sample Checkbox';TCheckProperty(cp).Value := True;pl.Add(cp);cp := TComboTextProperty.Create(pl.Name);cp.Name := 'Sample Select';TComboTextProperty(cp).Options := 'rare,seldom,"all the time"';cp.StringValue := 'rare';pl.Add(cp);cp := TEditProperty.Create(pl.Name);cp.Name := 'Sample Edit';cp.StringValue := 'test';pl.Add(cp);if SetupPropertiesDlg(pl, pl.Name +' Setup') thenbegint := TXMlTag.Create;t.TagName := 'opt';pl.WriteToXmlTag(t);WriteXML(t, 'e:\temp\cp.xml');t.Free;end;pl.Free;end.4.3.7.4 Class XMLParser↑ Is used in: NONE↓ Uses: NONEDeclaration: no.This class works with XML tree. The most important functions are provided by the instances of TXMLTag class, while the Parser provides conversions oand reads XML tree from a file.Methods

http://chessok.com/aqtiki/tiki-print_multi_pages.php131 of 144 26.05.2011 19:56StringToBool(Line: string): boolean – converts string to booleanExampleStringToBool('0');//returns falseStringToInt(Line: string): integer – converts string to integerExampleStringToInt('4');//returns integer;Koi8ToWin(string) – converts KOI8 encoding to Win1251ExampleKoi8ToWin('mama');//returns 'mama' in Win1251CP866ToWin(string) – converts CP866 encoding to Win1251ExampleCp866ToWin('papa');//returns 'papa' in Win1251LoadXML(AFileName: string): TXMLTag – loading XML file into a tag (root tag)Exampleroot :=LoadXML('data\engines.xml');WriteXML(ARootTag: TXMLTag, AFileName: string, AEncoding: string, APreserveWhiteSpace: boolean) – writes a tag with all the c(default without).ExampleWriteXML(root,'engines-res.xml');//root is TXMLTagUsage example: look here4.3.7.5 Class TXMLTag↑ Is use in: XMLParser↓ Uses: NONEDeclaration:varTTag: TXMLTag

http://chessok.com/aqtiki/tiki-print_multi_pages.php132 of 144 26.05.2011 19:56The main class working with XML. It can run through the tree forward and backward, Find children tags and given values, and stores all XML data: tagMethodsCreate() – creating a tag.Exampleroot := TXMLTag.Create;TTag := TXMLTag.Create(root);//TTag is a chil od a root tagCreateCopy(ATag: TXMLTag) – creating a copy of a tag (result is another object)Exampleroot.CreateCopy(ATag);//root is a copy of ATag; 2 objects were createdMakeCopy (ATag: TXMLTag) – making a copy of a tag (new index that indicates the same object)Exampleroot.MakeCopy(ATag);//root is a copy of ATag; 1 object was createdValuePresents(Value: string): boolean – checking if a value exists in the list of valuesExampleif TTag.ValuePresents('mama') thenGetNext: TXMLTag – getting the next tag ‐ a child or a brother with the bigger indexExampleATag := TTag.GetNext;//ATag is TXMLTagGetPrev: TXMLTag – getting the previous tag – a parent or brother with bigger indexExampleATag := TTag.GetNext;//ATag is TXMLTagFindChild(TagName: string, Index: integer): TXMLTag – finding a childExampleATag := root.FindChild('mama', 3);ClearChildren – clearing a list of the children

http://chessok.com/aqtiki/tiki-print_multi_pages.php133 of 144 26.05.2011 19:56Exampleroot.ClearChildren;DeleteValue(AName: string) – deleting a valueExampleTTag.DeleteValue('papa');PropertiesChildCount: integer – the number of childrenExamplefor i:=0 to root.ChildCount doTagName: string – a name of a tag (writable)ExampleATag.TagName := 'mama';Values[AName: string]: string – getting and setting a name of the field and its valueExampleATag.Values['parents'] := 'mama';IntValues[AName: string]: integer – getting and setting an integer valueExampleATag.IntValues['parents'] := 2;Children[Index: integer]: TXMLTag – a list of childrenExampleATag := ATag.Children[3];Parent: TXMLTag – a parent of the current tagExampleroot := ATag.Parent;Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php134 of 144 26.05.2011 19:56varroot: TXMLtag; //root tagengines: TXMLTag;//engine tagt: TXMLTag;e: TSEngine; //engine objectpath: string; //path to the engineAqPath: string;function GetPath (ATag: TXMLTag): string;beginengines := TXMLTag.Create; //Creating a child tagengines := ATag.FindChild('Engines'); //filling tags with datafor i:=0 to engines.ChildCount-1 dobegint := engines.Children[i];//search throgh all the childrenif t.Values['name'] = 'Rybka 3 w32' then // looking for the needed enginebegins := Copy(t.Values['path'], 3, Length(t.Values['path']));//creating a half of pathlineresult := AqPath + s;//making a path from the one found in XML and a special user variableend;end;Engines.Free;end;beginpath := '';AqPath := 'C:\ProgramFiles\Aquarium\';root := TXMLTag.Create;//creating a tagroot := LoadXML('data/engines.xml'); //loading an XML tree from fileif Assigned (root) then //check that succeedpath := GetPath(root);if path '' thenbegine := TSEngine.Create(path); //creating an engine objectif e.Started thenbeginprint ('engine started');//Starting analyzes := e.AnalyseToDepth(12);//Inserting into an XML tagroot.ClearChildren; //clear the root tagroot.TagName := 'Analyse'; //setting a tagname//Creating a first childEngines := TXMLTAg.Create(root);Engines.TagName := 'Engine';Engines.Values['Path'] := path;//Setting values//Creating a "grandchild"t := TXMLTag.Create(Engines);t.Values['an_res'] := s;t.TagName := 'Data';//Setting valuest.Values['Eval']:=e.Eval;t.Values['Depth'] := e.Depth;t.Values['Nodes'] := e.Nodes;t.Values['NPS'] := e.NPS;t.Values['PV'] := e.PV;

http://chessok.com/aqtiki/tiki-print_multi_pages.php135 of 144 26.05.2011 19:564.3.7.6 Class TRegExpr↑ Is used in: NONE↓ Uses: NONEDeclaration:varRegExp: TRegExprUsing this class, you can append regular expressions to any string. You can execute your expression once or find all suitable occurrences, substitute maMethodsCreate() – creating an expressionExampleRegExp := TRegExpr.Create;Exec(string): boolean – execute a regular expressionExampleRegExp.Exec (s);//s is source stringExecNext(string): boolean – executing regular expression while it is possible (only after Exec procedure)Exampleuntil not RegExp.ExecNextSubstitute(string): string – substituting matchesExampleRegExp.Substitute('$3$2$1');Split(Input: string, Result: TStringList) – splitting matches and writing them down into a StringListExampleRegExp.Split(s, sl);//s is input string, sl is a StringListPropertiesMatch[Index: integer]: string – returns the match itself.

http://chessok.com/aqtiki/tiki-print_multi_pages.php136 of 144 26.05.2011 19:56ExampleRegExp.Match[0]Expression: string – getting and setting expressionExampleRegExp.Expression := '(\d+)([.,])(\d+)';CaseInsensitive: boolean – switching case‐sensitive/insensitiveExampleRegExp.CaseSensitive := false;Token_S: string – making regular expression sensitive only to strings and numbersExampleRegExp.Token_S := true;InputString: string – getting and setting input string (which to process)ExampleRegExpr.InputString := s;Greedy: boolean – making Regulars greedy or non‐greedy (greedy by default)ExampleRegExpt.Greedy := false;Count: integer – the number of matchesExamplefor i:=0 to RegExpr.Count-1 doMatchPos: integer – the position where a match startsExamplei := RegExpr.MatchPos;//i is integerMatchLen: integer – a length of a match

http://chessok.com/aqtiki/tiki-print_multi_pages.php137 of 144 26.05.2011 19:56ExampleCopy(ReExpr.Match[0], 5, RegExpr.MatchLen);//copying a matched string from fifth character to the last oneUsage examplevarRegExp: TRegExpr;s: string;beginInputQuery('Enter floating-point number', 'Number (e.g. 3,5 or 5.66)', s);// creating objectRegExp := TRegExpr.Create;// guarantee to free memorytry// expressionRegExp.Expression := '(\d+)([.,])(\d+)';// do search; s - source stringif RegExp.Exec (s) thenrepeatprint('Whole number: '+ RegExp.Match[0]);print('Integer part: '+ RegExp.Match[1]);print('Divider : '+ RegExp.Match[2]);print('Fractional part: '+ RegExp.Match[3]);print(4);print(RegExp.Substitute('$3$2$1'));until not RegExp.ExecNextelseprint('Entered string doesn''t contain number in required format!');// just a test 1RegExp.Expression := '.* am (.*);.*';if RegExp.Exec('blablabla; am Ra1; bm e4') thenbeginprint('am:' + RegExp.Match[1]);end;// just a test 2RegExp.Expression := '.* am (.*)';if RegExp.Exec('blablabla; am Ra1') thenbeginprint('am:' + RegExp.Match[1]);end;finallyRegExp.Free;end;end.4.3.7.7 Class TBackgroundEvent

http://chessok.com/aqtiki/tiki-print_multi_pages.php138 of 144 26.05.2011 19:56↑ Is used in: nothing↓ Uses: nothingThis is a user‐defined eventDeclaration:varev: TBackgroundEventMethodsCreate: ‐ Creating an event;Exampleev := TBackgroundEvent.Create;ResetEvent: boolean ‐ prepares event to waiting.Exampleev.ResetEvent;SetEvent: boolean ‐ finishes event.Exampleev.SetEvent;WaitFor(integer): TEventState ‐ waits given time and then checks if event has happenedExampleev.WaitFor(1000)States of the events (TEventState)wrSignaled The signal of the event was set.wrTimeout The specified time elapsed without the signal being set.wrAbandoned The event object was destroyed before the timeout period elapsed.wrError An error occurred while waiting.Usage example

http://chessok.com/aqtiki/tiki-print_multi_pages.php139 of 144 26.05.2011 19:56vart: TIdeaTask;ev: TBackgroundEvent;b: boolean;begint := TIdeaTask.Create;t.FEN := 'r1bqkb1r/ppp2ppp/2n2n2/3Pp1N1/2B5/8/PPPP1PPP/RNBQK2R b KQkq - 0 5';t.UserTask := True;t.Quality.Depth := 10;t.Quality.Time := 10;t.Quality.Op := 1;ev := TBackgroundEvent.Create;t.Event := ev;AddIdeaTask(t);IDEA_Start;repeatb := ev.WaitFor(1000)until not b;end.ev.Free;IDEA_Stop(False, False, False);4.4 Releasing objectsFor nearly any language, releasing objects is very important. It's your guarantee that you don't use more memory than necessary and that your script iAqScripter.I'm making down a list of classes and write, which of them should be released and when.1. TSNodeInfo should be released in three cases:you have created it and didn't add neither in tree, nor in database.you have copied it from another NodeInfo using Copy function and didn' write anywhere.you have added it as an object to StringList and nowhere else. If so, you should write following code:Releasing objects of StringListsfor i:=sl.Count-1 downto 0 do//otherwise it won't worksl.Objects[i].Free;sl.Free;2. TSSearchInfo should be released any time you use it (after usage, of course)3. TSDataBaseGame should be freed any time you've finished using it, but before TSDataBase.4. Should always be freed after using them:TSDatabase;

http://chessok.com/aqtiki/tiki-print_multi_pages.php140 of 144 26.05.2011 19:56TSTreeScanner;TSTreeConfigurationTSTreeJoinerTSEngineTStringListTObjectListTSVariantListTRegExprTXMLTag5. Never freedTSMoveInfoTSAnnotationTSHeaderTXMLParser4.5 Procedures used in Aquarium onlyWe have 2 versions of AqScripter ‐ standalone and implemented in Aquarium. This second one works with trees and databases, and is very good in IDeneeded to provide links between Aquarium and AScripter.Table of contentsFunctions that work everywhereFunctions that work only in IDeAFunctions that work only in IDeA Project viewFunctions working with GameViewFunctions working in database4.5.1 Functions that work everywhereThese functions work in any mode where you can use AqScipterUseAquariumTree(AName string; AReadOnly boolean = True): TSTreeScanner function returns given Aquarium tree or nil if not succet := UsqAquariumTree('statistics\d2m');ReleaseAquariumTree(AName string) releases this tree.ReleaseAquariumTree('cap')DataPath: string returns path to the Aquarium data folder (when used in standalone version, returns path to AqScripter.exe)

http://chessok.com/aqtiki/tiki-print_multi_pages.php141 of 144 26.05.2011 19:56print (Datapath());Usage examplevari: integer;procedure ProcessNode(Sender: TSTreeScanner);begininc(i);end;vartsc: TSTreeScanner;name: string;beginclear;name := 'statistics\d2m';tsc := UseAquariumTree(name, True);if Assigned(tsc) thenbegini := 0;tsc.OnProcessNode := 'ProcessNode';tsc.StartConsecutive;print(intToStr(i));tsc.Free;ReleaseAquariumTree(name);endelseprint('tree not opened');print('ok');end.AquariumTree(statistics\d2m);{CODE}4.5.2 Functions that work only in IDeAThese are so beloved functions that can add tasks to IDeA, or Root node, etcAddIdeaTask(ATask:TIdeaTask):boolean: adds IDeA TIDeATask.ExampleAddIdeaTask(MyTask)AddIdeaRootNode(root:TIdeARootNode): adds IDeA task.ExampleAddIdeaRootNode('1Q1q3r/1p1k1pp1/p7/n2p3p/r2P3P/2P5/5PP1/1R2R1K1 w', 'myIdeaRoot');

http://chessok.com/aqtiki/tiki-print_multi_pages.php142 of 144 26.05.2011 19:56GetIdeaTree:TSTreeScanner creates a tree from an IDeA projectExamplet := GetIDeATree;GetIdeaStage:integer: returns a stage Constants are tesProlong, tesAlternative, tesDeepProlong, tesMainlineVerificationExamplei := GetIDeAStage;AddIdeaTask(ATask:TIdeaTask): adds IDeA task.Exampleni1 := t.Search(ni2)// ni1, ni2 is TSNodeInfoGetIdeaActiveRootNodes:TStringList: returns a list of active IDeA root nodes in FEN strings;Examplesl := GetIDeAActiveRootNodes;GetIdeaTotalRootNodes:TStringList: returns a list of all IDeA root nodes in FEN strings;Examplesl := GetIDeATotalRootNodes;StopTaskGeneration stops IDeAExampleIdeaForceStop;ContinueTaskGeneration makes IDeA continue analysis.ExampleIdeaForceContinue;UpdateCurrentProj(AProject:#c30:TIdeaProjectInfo~~)~~ updates the project so the changes start working (allowed one time at theExampleUpdateCurrentProj(IdPr);

http://chessok.com/aqtiki/tiki-print_multi_pages.php143 of 144 26.05.2011 19:564.5.2.1 Functions that work only in IDeA Project viewIDEA_Running:Boolean– returns true is a project is runningExampleif IDEA_Running thenIDEA_Start– starts IDeAExampleIDEA_Start;IDEA_Stop(WaitTasksToFinish:Boolean, Minimax AfterFinish:Boolean, MakeAccuratePositionCount: Boolean)– Stops IDeA with givExampleIDeAStop(flase, true, false);//stops IDeA and minimaxes after finish4.5.3 Functions working with GameViewThese functions are working only in GameView. Their target is currently opened gameGetAquariumGame: TSGame ‐ returns the game opened currently in AquariumExamplegam := GetAquariumGame;RefreshGame(AGame:TSGame) ‐ writes current game into a baseExampleRefreshGame(gam);4.5.4 Functions working in databaseThese functions work in a list of games. Yes, you can access Scripter from there too!GetAquariumBase: TSDataBase ‐ returns database currently opened in Aquarium.Don't forget to free the game(! not base!) after you've finished working with it, even if it's Aquarium baseExample

http://chessok.com/aqtiki/tiki-print_multi_pages.php144 of 144 26.05.2011 19:56db := GetAquariumBase;RefreshBase ‐ refreshes current database. used, e.g. when you want to add a new game to a databaseExampleRefreshBase;5 Possible problemsWhen you create large scripts using uses option to attach other scripts to yours, note, that some problems may occur. It is very hard to debug them, th