Debug position search cache
[xboard.git] / common.h
index 62086db..c018016 100644 (file)
--- a/common.h
+++ b/common.h
@@ -1,11 +1,13 @@
 /*
  * common.h -- Common definitions for X and Windows NT versions of XBoard
- * $Id: common.h,v 2.1 2003/10/27 19:21:00 mann Exp $
  *
  * Copyright 1991 by Digital Equipment Corporation, Maynard,
- * Massachusetts.  Enhancements Copyright
- * 1992-2001,2002,2003,2004,2005,2006,2007,2008,2009 Free Software
- * Foundation, Inc.
+ * Massachusetts. 
+ *
+ * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
+ * 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
+ *
+ * Enhancements Copyright 2005 Alessandro Scotti
  *
  * The following terms apply to Digital Equipment Corporation's copyright
  * interest in XBoard:
@@ -107,7 +109,7 @@ int pclose(FILE *);
 
 // [HGM] license: Messages that engines must print to satisfy their license requirements for patented variants
 #define GOTHIC "Gothic Chess (see www.GothicChess.com) is licensed under U.S. Patent #6,481,716 by Ed Trice"
-#define NOFALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
+#define FALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
 
 /* [HGM] Some notes about board sizes:
    In games that allow piece drops, the holdings are considered part of the
@@ -123,13 +125,17 @@ int pclose(FILE *);
    outside world in ASCII. In a similar way, the different rank numbering
    systems (starting at rank 0 or 1) are implemented by redefining '1'.
 */
-#define BOARD_SIZE              16            /* [HGM] for in declarations */
-#define BOARD_HEIGHT (gameInfo.boardHeight)   // [HGM] made user adjustable 
+#define BOARD_RANKS             11             /* [HGM] for in declarations  */
+#define BOARD_FILES             16             /* [HGM] for in declarations  */
+#define BOARD_HEIGHT (gameInfo.boardHeight)    /* [HGM] made user adjustable */
 #define BOARD_WIDTH  (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)   
-#define BOARD_LEFT   (gameInfo.holdingsWidth) // [HGM] play-board edges     
+#define BOARD_LEFT   (gameInfo.holdingsWidth)  /* [HGM] play-board edges     */
 #define BOARD_RGHT   (gameInfo.boardWidth + gameInfo.holdingsWidth)
-#define ONE          ('1'-(BOARD_HEIGHT>9))   // [HGM] foremost board rank  
-#define AAA          ('a'-BOARD_LEFT)         // [HGM] leftmost board file  
+#define CASTLING     (BOARD_RANKS-1)           /* [HGM] hide in upper rank   */
+#define EP_STATUS    CASTLING][(BOARD_FILES-2) /* [HGM] in upper rank        */
+#define HOLDINGS_SET CASTLING][(BOARD_FILES-1) /* [HGM] in upper-right corner*/
+#define ONE          ('1'-(BOARD_HEIGHT>9))    /* [HGM] foremost board rank  */
+#define AAA          ('a'-BOARD_LEFT)          /* [HGM] leftmost board file  */
 #define DROP_RANK               -3
 #define MAX_MOVES              1000
 #define MSG_SIZ                        512
@@ -148,6 +154,7 @@ int pclose(FILE *);
 #define FIRST_HOST             "localhost"
 #define SECOND_HOST            "localhost"
 #define TELNET_PROGRAM          "telnet"
+#define DEF_BITMAP_DIR          BITMAPDIR
 #define MATCH_MODE             "False"
 #define INIT_STRING            "new\nrandom\n"
 #define WHITE_STRING           "white\ngo\n"
@@ -161,10 +168,33 @@ int pclose(FILE *);
 #define JAIL_SQUARE_COLOR       "#808080"
 #define HIGHLIGHT_SQUARE_COLOR "#FFFF00"
 #define PREMOVE_HIGHLIGHT_COLOR        "#FF0000"
+#define LOWTIMEWARNING_COLOR    "#FF0000"
 #define BELLCHAR                '\007'
 #define NULLCHAR                '\000'
 #define FEATURE_TIMEOUT         10000 /*ms*/
 
+#define CLOCK_FONT 0
+#define MESSAGE_FONT 1
+#define COORD_FONT 2
+#define CONSOLE_FONT 3
+#define COMMENT_FONT 4
+#define EDITTAGS_FONT 5
+#define MOVEHISTORY_FONT 6
+#define GAMELIST_FONT 7
+#define NUM_FONTS 8
+
+/* Default to no flashing (the "usual" XBoard behavior) */
+#define FLASH_COUNT    0               /* Number of times to flash */
+#define FLASH_RATE     5               /* Flashes per second */
+
+/* Default delay per character (in msec) while sending login script */
+#define MS_LOGIN_DELAY  0
+
+/* [AS] Support for background textures */
+#define BACK_TEXTURE_MODE_DISABLED      0
+#define BACK_TEXTURE_MODE_PLAIN         1
+#define BACK_TEXTURE_MODE_FULL_RANDOM   2
+
 /* Zippy defaults */
 #define ZIPPY_TALK FALSE
 #define ZIPPY_PLAY FALSE
@@ -206,6 +236,7 @@ typedef enum {
     BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
     BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackKing,
     EmptySquare, 
+    NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
     ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
   } ChessSquare;
 
@@ -217,26 +248,23 @@ typedef enum {
 #define SHOGI          (int)EmptySquare + (int)
 
 
-typedef ChessSquare Board[BOARD_SIZE][BOARD_SIZE];
+typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
 
 typedef enum {
-    WhiteKingSideCastle = 1, WhiteQueenSideCastle,
+    EndOfFile = 0,
+    WhiteKingSideCastle, WhiteQueenSideCastle,
     WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
     WhiteHSideCastleFR, WhiteASideCastleFR, 
     BlackKingSideCastle, BlackQueenSideCastle,
     BlackKingSideCastleWild, BlackQueenSideCastleWild,
     BlackHSideCastleFR, BlackASideCastleFR, 
-    WhitePromotionKnight, WhitePromotionBishop,
-    WhitePromotionRook, WhitePromotionQueen, WhitePromotionKing,
-    WhitePromotionChancellor, WhitePromotionArchbishop, WhitePromotionCentaur,
-    BlackPromotionKnight, BlackPromotionBishop,
-    BlackPromotionRook, BlackPromotionQueen, BlackPromotionKing,
-    BlackPromotionChancellor, BlackPromotionArchbishop, BlackPromotionCentaur,
+    WhitePromotion, WhiteNonPromotion,
+    BlackPromotion, BlackNonPromotion,
     WhiteCapturesEnPassant, BlackCapturesEnPassant,
     WhiteDrop, BlackDrop, 
     NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
     WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
-    GNUChessGame, XBoardGame, MoveNumberOne, 
+    GNUChessGame, XBoardGame, MoveNumberOne, Open, Close, Nothing,
     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
   } ChessMove;
 
@@ -291,6 +319,10 @@ typedef enum {
     VariantSuper,
     VariantGreat,
     VariantTwilight,
+    VariantMakruk,
+    VariantSChess,
+    VariantGrand,
+    VariantSpartan,
     VariantUnknown       /* Catchall for other unknown variants */
 } VariantClass;
 
@@ -333,10 +365,17 @@ typedef enum {
   "super",\
   "great",\
   "twilight",\
+  "makruk",\
+  "seirawan",\
+  "grand",\
+  "spartan",\
   "unknown" \
 }
 
+#define ENGINES 2
+
 typedef struct {
+    char *language;
 #if !defined(_amigados)
     char *whitePieceColor;
     char *blackPieceColor;
@@ -355,20 +394,17 @@ typedef struct {
     int premoveHighlightColor;
 #endif
     int movesPerSession;
-    int timeIncrement;
-    char *initString;
-    char *secondInitString;
-    char *firstComputerString;
-    char *secondComputerString;
-    char *firstChessProgram;
-    char *secondChessProgram;
-    char *firstDirectory;
-    char *secondDirectory;
+    float timeIncrement;
+    char *engInitString[ENGINES];
+    char *computerString[ENGINES];
+    char *chessProgram[ENGINES];
+    char *directory[ENGINES];
+    char *pgnName[ENGINES];
     Boolean firstPlaysBlack;
     Boolean noChessProgram;
-    char *firstHost;
-    char *secondHost;
+    char *host[ENGINES];
     char *bitmapDirectory;
+    char *soundDirectory;
     char *remoteShell;
     char *remoteUser;
     float timeDelay;
@@ -381,6 +417,8 @@ typedef struct {
     char *icsHelper;
     Boolean icsInputBox;
     Boolean useTelnet;
+    Boolean seekGraph;
+    Boolean autoRefresh;
     char *telnetProgram;
     char *gateway;
     char *loadGameFile;
@@ -414,6 +452,7 @@ typedef struct {
     char *cmailGameName; /* xboard only */
     Boolean alwaysPromoteToQueen;
     Boolean oldSaveStyle;
+    Boolean oneClick;
     Boolean quietPlay;
     Boolean showThinking;
     Boolean ponderNextMove;
@@ -435,7 +474,7 @@ typedef struct {
                          ICS logon script (xboard only) */
     Boolean colorize;  /* If True, use the following colors to color text */
     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
-    char *colorShout;
+    char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
     char *colorSShout;
     char *colorChannel1;
     char *colorChannel;
@@ -446,7 +485,7 @@ typedef struct {
     char *colorSeek;
     char *colorNormal;
     char *soundProgram; /* sound-playing program */
-    char *soundShout;
+    char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
     char *soundSShout;
     char *soundChannel1;
     char *soundChannel;
@@ -455,14 +494,15 @@ typedef struct {
     char *soundChallenge;
     char *soundRequest;
     char *soundSeek;
-    char *soundMove;
+    char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
+    char *soundBell;
+    char *soundIcsAlarm;
     char *soundIcsWin;
     char *soundIcsLoss;
     char *soundIcsDraw;
     char *soundIcsUnfinished;
-    char *soundIcsAlarm;
-    Boolean reuseFirst;
-    Boolean reuseSecond;
+    Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
+    Boolean reuse[ENGINES];
     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
     Boolean animate;   /* If True, animate non-mouse moves */
     int animSpeed;     /* Delay in milliseconds between animation frames */
@@ -483,16 +523,18 @@ typedef struct {
     int fontSizeTolerance; /* xboard only */
     char *initialMode;
     char *variant;
-    int firstProtocolVersion;
-    int secondProtocolVersion;
+    char *chatBoxes;
+    int protocolVersion[ENGINES];
     Boolean showButtonBar;
     Boolean icsEngineAnalyze; 
+    Boolean variations;         /* [HGM] enable variation-tree walking */
 
     /* [AS] New properties (down to the "ZIPPY" part) */
-    Boolean firstScoreIsAbsolute;  /* If true, engine score is always from white side */
-    Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
+    Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
+    Boolean useBitmaps;
+    Boolean useFont;
     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
     int liteBackTextureMode;
@@ -519,19 +561,25 @@ typedef struct {
     Boolean highlightMoveWithArrow;
     int highlightArrowColor;
     Boolean useStickyWindows;
+    Boolean bgObserve;   /* [HGM] bughouse */
+    Boolean dualBoard;   /* [HGM] dual     */
     int adjudicateDrawMoves;
     Boolean autoDisplayComment;
     Boolean autoDisplayTags;
-    Boolean firstIsUCI;
-    Boolean secondIsUCI;
-    Boolean firstHasOwnBookUCI;
-    Boolean secondHasOwnBookUCI;
+    Boolean isUCI[ENGINES];
+    Boolean hasOwnBookUCI[ENGINES];
+    char * adapterCommand;
+    char * ucciAdapter;
     char * polyglotDir;
     Boolean usePolyglotBook;
+    Boolean defNoBook;
     char * polyglotBook;
+    int bookDepth;
+    int bookStrength;
     int defaultHashSize;
     int defaultCacheSizeEGTB;
     char * defaultPathEGTB;
+    int defaultMatchGames;
 
     /* [HGM] Board size */
     int NrFiles;
@@ -539,6 +587,8 @@ typedef struct {
     int holdingsSize;
     int matchPause;
     char * pieceToCharTable;
+    char * pieceNickNames;
+    char * colorNickNames;
     Boolean allWhite;
     Boolean upsideDown;
     Boolean alphaRank;
@@ -568,36 +618,69 @@ typedef struct {
     int zippyReplayTimeout; /*seconds*/
     int zippyShortGame; /* [HGM] aborter   */
 #endif
+    Boolean lowTimeWarning; /* [HGM] low time */
+    char *lowTimeWarningColor;
 
     char *serverMovesName;
     Boolean suppressLoadMoves;
     int serverPause;
-    int firstTimeOdds;
-    int secondTimeOdds;
+    int timeOdds[ENGINES];
     int timeOddsMode;
-    int firstAccumulateTC;
-    int secondAccumulateTC;
-    int firstNPS;
-    int secondNPS;
+    int accumulateTC[ENGINES];
+    int NPS[ENGINES];
     Boolean autoKibitz;
     int engineComments;
+    int eloThreshold1;  /* [HGM] select   */
+    int eloThreshold2;
+    int dateThreshold;
+    int searchMode;
+    int stretch;
+    Boolean ignoreColors;
     char *userName;
     int rewindIndex;    /* [HGM] autoinc   */
     int sameColorGames; /* [HGM] alternate */
     int smpCores;       /* [HGM] SMP       */
     char *egtFormats;
     int niceEngines;    /* [HGM] nice      */
-    char *firstLogo;    /* [HGM] logo      */
-    char *secondLogo;
+    char *logo[ENGINES];/* [HGM] logo      */
+    char *pairingEngine;/* [HGM] pairing   */
     Boolean autoLogo;
     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
-    char *firstOptions; /* [HGM] options   */
-    char *secondOptions;
-    char *fenOverride1;
-    char *fenOverride2;
+    char *engOptions[ENGINES]; /* [HGM] options   */
+    char *fenOverride[ENGINES];
+    Boolean keepAlive;  /* [HGM] alive     */
+    Boolean forceIllegal;/*[HGM] illegal   */
+    Boolean noJoin;     /* [HGM] join      */
+    char *wrapContSeq; /* continuation sequence when xboard wraps text */
+    Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
+    Boolean pasteSelection; /* paste X selection instead of clipboard */
+    int nrVariations;   /* [HGM] multivar  */
+    int zoom;           /* [HGM] evalGraph */
+    int evalThreshold;  /* [HGM] evalGraph */
+    Boolean dropMenu;   /* [HGM] pv        */
+    Boolean markers;    /* [HGM] markers   */
+    Boolean pieceMenu;
+    Boolean sweepSelect;
+    Boolean whitePOV;
+    Boolean scoreWhite;
+    Boolean pvSAN[ENGINES];
+
+    char *tourneyFile;
+    char *defName;
+    char *processes;
+    char *results;
+    char *participants;
+    char *afterGame;
+    int tourneyType;
+    int tourneyCycles;
+    int seedBase;
+    Boolean roundSync;
+    Boolean cycleSync;
 } AppData, *AppDataPtr;
 
-/* [AS] PGN tags (for showing in the game list) */
+/*  PGN tags (for showing in the game list) */
+#define LPUSERGLT_SIZE      64
+
 #define GLT_EVENT           'e'
 #define GLT_SITE            's'
 #define GLT_DATE            'd'
@@ -609,10 +692,11 @@ typedef struct {
 #define GLT_TIME_CONTROL    't'
 #define GLT_VARIANT         'v'
 #define GLT_OUT_OF_BOOK     'a'
+#define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 
 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 
-#define GLT_ALL_TAGS        "esdoprwbtva"
+#define GLT_ALL_TAGS        "esdoprwbtvac"
 
 #define PGN_OUT_OF_BOOK     "Annotator"
 
@@ -643,6 +727,73 @@ typedef struct {
     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 } GameInfo;
 
+/* [AS] Search stats from chessprogram, for the played move */
+// [HGM] moved here from backend.h because it occurs in declarations of front-end functions
+typedef struct {
+    int score;  /* Centipawns */
+    int depth;  /* Plies */
+    int time;   /* Milliseconds */
+} ChessProgramStats_Move;
+
+/* [AS] Layout management */
+typedef struct {
+    Boolean visible;
+    int x;
+    int y;
+    int width;
+    int height;
+} WindowPlacement;
+
+extern WindowPlacement wpEngineOutput;
+extern WindowPlacement wpEvalGraph;
+extern WindowPlacement wpMoveHistory;
+extern WindowPlacement wpGameList;
+extern WindowPlacement wpTags;
+
+// [HGM] chat  
+#define MAX_CHAT 5
+extern int chatCount;
+extern char chatPartner[MAX_CHAT][MSG_SIZ];
+
+// [HGM] generally useful macros; there are way too many memory leaks...
+#define FREE(x) if(x) free(x)
+#define ASSIGN(x, y) if(x) free(x); x = strdup(y)
+
+// [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
+//       in due time we would have to make the actual substitutions all through the source
+
+#define firstInitString       engInitString[0]
+#define secondInitString      engInitString[1]
+#define firstComputerString   computerString[0]
+#define secondComputerString  computerString[1]
+#define firstChessProgram     chessProgram[0]
+#define secondChessProgram    chessProgram[1]
+#define firstDirectory        directory[0]
+#define secondDirectory       directory[1]
+#define firstProtocolVersion  protocolVersion[0]
+#define secondProtocolVersion protocolVersion[1]
+#define firstScoreIsAbsolute  scoreIsAbsolute[0]
+#define secondScoreIsAbsolute scoreIsAbsolute[1]
+#define firstHasOwnBookUCI    hasOwnBookUCI[0]
+#define secondHasOwnBookUCI   hasOwnBookUCI[1]
+#define firstTimeOdds         timeOdds[0]
+#define secondTimeOdds        timeOdds[1]
+#define firstAccumulateTC     accumulateTC[0]
+#define secondAccumulateTC    accumulateTC[1]
+#define firstHost    host[0]
+#define secondHost   host[1]
+#define reuseFirst   reuse[0]
+#define reuseSecond  reuse[1]
+#define firstIsUCI   isUCI[0]
+#define secondIsUCI  isUCI[1]
+#define firstNPS     NPS[0]
+#define secondNPS    NPS[1]
+#define firstLogo    logo[0]
+#define secondLogo   logo[1]
+#define fenOverride1 fenOverride[0]
+#define fenOverride2 fenOverride[1]
+#define firstOptions      engOptions[0]
+#define secondOptions     engOptions[1]
 
 #endif