Allow engine to define its own variant names
[xboard.git] / backend.h
index aac6ab1..c82c989 100644 (file)
--- a/backend.h
+++ b/backend.h
@@ -5,7 +5,7 @@
  * Massachusetts.
  *
  * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
  * Massachusetts.
  *
  * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
- * 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+ * 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
  *
  * Enhancements Copyright 2005 Alessandro Scotti
  *
  *
  * Enhancements Copyright 2005 Alessandro Scotti
  *
@@ -51,8 +51,8 @@
  *------------------------------------------------------------------------
  ** See the file ChangeLog for a revision history.  */
 
  *------------------------------------------------------------------------
  ** See the file ChangeLog for a revision history.  */
 
-#ifndef _BACKEND
-#define _BACKEND
+#ifndef XB_BACKEND
+#define XB_BACKEND
 
 /* unsigned int 64 for engine nodes work and display */
 #ifdef WIN32
 
 /* unsigned int 64 for engine nodes work and display */
 #ifdef WIN32
 #endif
 
 #include "lists.h"
 #endif
 
 #include "lists.h"
-#include "frontend.h"
 
 
+typedef int (*FileProc) P((FILE *f, int n, char *title));
+
+extern char *wbOptions;
 extern int gotPremove;
 extern GameMode gameMode;
 extern int gotPremove;
 extern GameMode gameMode;
+extern int matchMode;
+extern int matchGame;
 extern int pausing, cmailMsgLoaded, flipView, mute;
 extern char white_holding[], black_holding[];
 extern int currentMove, backwardMostMove, forwardMostMove;
 extern int blackPlaysFirst;
 extern FILE *debugFP;
 extern char* programVersion;
 extern int pausing, cmailMsgLoaded, flipView, mute;
 extern char white_holding[], black_holding[];
 extern int currentMove, backwardMostMove, forwardMostMove;
 extern int blackPlaysFirst;
 extern FILE *debugFP;
 extern char* programVersion;
-extern ProcRef firstProgramPR, secondProgramPR;
 extern Board boards[];
 extern char marker[BOARD_RANKS][BOARD_FILES];
 extern Board boards[];
 extern char marker[BOARD_RANKS][BOARD_FILES];
+extern char lastMsg[MSG_SIZ];
+extern Boolean bookUp;
+extern int tinyLayout, smallLayout;
+extern Boolean mcMode;
 
 
+void MarkMenuItem P((char *menuRef, int state));
 char *CmailMsg P((void));
 /* Tord: Added the useFEN960 parameter in PositionToFEN() below */
 char *CmailMsg P((void));
 /* Tord: Added the useFEN960 parameter in PositionToFEN() below */
-char *PositionToFEN P((int move, char* useFEN960));
+char *PositionToFEN P((int move, char* useFEN960, int moveCounts));
 void AlphaRank P((char *s, int n)); /* [HGM] Shogi move preprocessor */
 void EditPositionPasteFEN P((char *fen));
 void TimeDelay P((long ms));
 void AlphaRank P((char *s, int n)); /* [HGM] Shogi move preprocessor */
 void EditPositionPasteFEN P((char *fen));
 void TimeDelay P((long ms));
@@ -122,14 +130,14 @@ void SetBlackToPlayEvent P((void));
 void UploadGameEvent P((void));
 void InitBackEnd1 P((void));
 void InitBackEnd2 P((void));
 void UploadGameEvent P((void));
 void InitBackEnd1 P((void));
 void InitBackEnd2 P((void));
-int HasPromotionChoice P((int fromX, int fromY, int toX, int toY, char *choice));
+int HasPromotionChoice P((int fromX, int fromY, int toX, int toY, char *choice, int sweep));
 int InPalace P((int row, int column));
 int PieceForSquare P((int x, int y));
 int OKToStartUserMove P((int x, int y));
 void Reset P((int redraw, int init));
 void ResetGameEvent P((void));
 int InPalace P((int row, int column));
 int PieceForSquare P((int x, int y));
 int OKToStartUserMove P((int x, int y));
 void Reset P((int redraw, int init));
 void ResetGameEvent P((void));
-Boolean HasPattern P(( const char * text, const char * pattern ));\r
-Boolean SearchPattern P(( const char * text, const char * pattern ));\r
+Boolean HasPattern P(( const char * text, const char * pattern ));
+Boolean SearchPattern P(( const char * text, const char * pattern ));
 int LoadGame P((FILE *f, int n, char *title, int useList));
 int LoadGameFromFile P((char *filename, int n, char *title, int useList));
 int CmailLoadGame P((FILE *f, int n, char *title, int useList));
 int LoadGame P((FILE *f, int n, char *title, int useList));
 int LoadGameFromFile P((char *filename, int n, char *title, int useList));
 int CmailLoadGame P((FILE *f, int n, char *title, int useList));
@@ -160,6 +168,7 @@ void MoveNowEvent P((void));
 void TruncateGameEvent P((void));
 void PauseEvent P((void));
 void CallFlagEvent P((void));
 void TruncateGameEvent P((void));
 void PauseEvent P((void));
 void CallFlagEvent P((void));
+void ClockClick P((int which));
 void AcceptEvent P((void));
 void DeclineEvent P((void));
 void RematchEvent P((void));
 void AcceptEvent P((void));
 void DeclineEvent P((void));
 void RematchEvent P((void));
@@ -171,7 +180,6 @@ void UserAdjudicationEvent P((int result));
 void StopObservingEvent P((void));
 void StopExaminingEvent P((void));
 void PonderNextMoveEvent P((int newState));
 void StopObservingEvent P((void));
 void StopExaminingEvent P((void));
 void PonderNextMoveEvent P((int newState));
-void NewSettingeEvent P((int option, char *command, int value));
 void ShowThinkingEvent P(());
 void PeriodicUpdatesEvent P((int newState));
 void HintEvent P((void));
 void ShowThinkingEvent P(());
 void PeriodicUpdatesEvent P((int newState));
 void HintEvent P((void));
@@ -188,24 +196,32 @@ void AdjustClock P((Boolean which, int dir));
 void DisplayBothClocks P((void));
 void EditPositionMenuEvent P((ChessSquare selection, int x, int y));
 void DropMenuEvent P((ChessSquare selection, int x, int y));
 void DisplayBothClocks P((void));
 void EditPositionMenuEvent P((ChessSquare selection, int x, int y));
 void DropMenuEvent P((ChessSquare selection, int x, int y));
-int ParseTimeControl P((char *tc, int ti, int mps));
+int ParseTimeControl P((char *tc, float ti, int mps));
+void EscapeExpand(char *p, char *q);
 void ProcessICSInitScript P((FILE * f));
 void EditCommentEvent P((void));
 void ReplaceComment P((int index, char *text));
 int ReplaceTags P((char *tags, GameInfo *gi));/* returns nonzero on error */
 void AppendComment P((int index, char *text, Boolean addBraces));
 void ProcessICSInitScript P((FILE * f));
 void EditCommentEvent P((void));
 void ReplaceComment P((int index, char *text));
 int ReplaceTags P((char *tags, GameInfo *gi));/* returns nonzero on error */
 void AppendComment P((int index, char *text, Boolean addBraces));
+void LoadVariation P((int index, char *text));
 void ReloadCmailMsgEvent P((int unregister));
 void MailMoveEvent P((void));
 void EditTagsEvent P((void));
 void GetMoveListEvent P((void));
 void ExitAnalyzeMode P((void));
 void ReloadCmailMsgEvent P((int unregister));
 void MailMoveEvent P((void));
 void EditTagsEvent P((void));
 void GetMoveListEvent P((void));
 void ExitAnalyzeMode P((void));
-void AnalyzeModeEvent P((void));
+int  AnalyzeModeEvent P((void));
 void AnalyzeFileEvent P((void));
 void AnalyzeFileEvent P((void));
+void MatchEvent P((int mode));
+void RecentEngineEvent P((int nr));
+void TypeInEvent P((char first));
+void TypeInDoneEvent P((char *move));
 void InitPosition P((int redraw));
 void InitPosition P((int redraw));
-void NewSettingEvent P((int option, char *command, int value));
+void NewSettingEvent P((int option, int *feature, char *command, int value));
+void SettingsMenuIfReady P((void));
 void DoEcho P((void));
 void DontEcho P((void));
 void TidyProgramName P((char *prog, char *host, char *buf));
 void DoEcho P((void));
 void DontEcho P((void));
 void TidyProgramName P((char *prog, char *host, char *buf));
+void SetGameInfo P((void));
 void AskQuestionEvent P((char *title, char *question,
                         char *replyPrefix, char *which));
 Boolean ParseOneMove P((char *move, int moveNum,
 void AskQuestionEvent P((char *title, char *question,
                         char *replyPrefix, char *which));
 Boolean ParseOneMove P((char *move, int moveNum,
@@ -218,15 +234,29 @@ void OutputChatMessage P((int partner, char *mess));
 void EditPositionDone P((Boolean fakeRights));
 Boolean GetArgValue P((char *name));
 Boolean LoadPV P((int x, int y));
 void EditPositionDone P((Boolean fakeRights));
 Boolean GetArgValue P((char *name));
 Boolean LoadPV P((int x, int y));
-Boolean LoadMultiPV P((int x, int y, char *buf, int index, int *start, int *end));
+Boolean LoadMultiPV P((int x, int y, char *buf, int index, int *start, int *end, int pane));
 void UnLoadPV P(());
 void MovePV P((int x, int y, int h));
 void UnLoadPV P(());
 void MovePV P((int x, int y, int h));
+int PromoScroll P((int x, int y));
+void EditBookEvent P((void));
+Boolean DisplayBook P((int moveNr));
+void SaveToBook P((char *text));
+void HoverEvent P((int hiX, int hiY, int x, int y));
+int PackGame P((Board board));
+Boolean ParseFEN P((Board board, int *blackPlaysFirst, char *fen));
+void ApplyMove P((int fromX, int fromY, int toX, int toY, int promoChar, Board board));
+void PackMove P((int fromX, int fromY, int toX, int toY, ChessSquare promoPiece));
+void ics_printf P((char *format, ...));
+int GetEngineLine P((char *nick, int engine));
+void AddGameToBook P((int always));
+void FlushBook P((void));
 
 char *StrStr P((char *string, char *match));
 char *StrCaseStr P((char *string, char *match));
 char *StrSave P((char *s));
 char *StrSavePtr P((char *s, char **savePtr));
 char *SavePart P((char *));
 
 char *StrStr P((char *string, char *match));
 char *StrCaseStr P((char *string, char *match));
 char *StrSave P((char *s));
 char *StrSavePtr P((char *s, char **savePtr));
 char *SavePart P((char *));
+char* safeStrCpy P(( char *dst, const char *src, size_t count ));
 
 #ifndef _amigados
 int StrCaseCmp P((char *s1, char *s2));
 
 #ifndef _amigados
 int StrCaseCmp P((char *s1, char *s2));
@@ -240,13 +270,8 @@ int ToUpper P((int c));
 extern GameInfo gameInfo;
 
 /* ICS vars used with backend.c and zippy.c */
 extern GameInfo gameInfo;
 
 /* ICS vars used with backend.c and zippy.c */
-#define ICS_GENERIC 0
-#define ICS_ICC 1
-#define ICS_FICS 2
-#define ICS_CHESSNET 3 /* not really supported */
-int ics_type;
-
+enum ICS_TYPE { ICS_GENERIC, ICS_ICC, ICS_FICS, ICS_CHESSNET /* not really supported */ };
+enum ICS_TYPE ics_type;
 
 /* pgntags.c prototypes
  */
 
 /* pgntags.c prototypes
  */
@@ -260,43 +285,60 @@ char *PGNResult P((ChessMove result));
  */
 /* A game node in the double linked list of games.
  */
  */
 /* A game node in the double linked list of games.
  */
-typedef struct _ListGame {
+typedef struct XB_ListGame {
     ListNode node;
     int number;
     ListNode node;
     int number;
+    int position;
+    int moves;
     unsigned long offset;   /*  Byte offset of game within file.     */
     GameInfo gameInfo;      /*  Note that some entries may be NULL. */
 } ListGame;
     unsigned long offset;   /*  Byte offset of game within file.     */
     GameInfo gameInfo;      /*  Note that some entries may be NULL. */
 } ListGame;
+
+extern int doubleClick;
+extern int storedGames;
+extern int opponentKibitzes;
+extern ChessSquare gatingPiece;
 extern List gameList;
 extern List gameList;
+extern int lastLoadGameNumber;
 void ClearGameInfo P((GameInfo *));
 int GameListBuild P((FILE *));
 void GameListInitGameInfo P((GameInfo *));
 char *GameListLine P((int, GameInfo *));
 char * GameListLineFull P(( int, GameInfo *));
 void ClearGameInfo P((GameInfo *));
 int GameListBuild P((FILE *));
 void GameListInitGameInfo P((GameInfo *));
 char *GameListLine P((int, GameInfo *));
 char * GameListLineFull P(( int, GameInfo *));
+void InitSearch P((void));
+int GameContainsPosition P((FILE *f, ListGame *lg));
 void GLT_TagsToList P(( char * tags ));
 void GLT_ParseList P((void));
 void GLT_TagsToList P(( char * tags ));
 void GLT_ParseList P((void));
+int NamesToList P((char *name, char **engines, char **mnemonics, char *group));
+int CreateTourney P((char *name));
+char *MakeName P((char *templ));
+void SwapEngines P((int n));
+void Substitute P((char *participants, int expunge));
 
 extern char* StripHighlight P((char *));  /* returns static data */
 extern char* StripHighlightAndTitle P((char *));  /* returns static data */
 extern void ics_update_width P((int new_width));
 extern Boolean set_cont_sequence P((char *new_seq));
 extern int wrap P((char *dest, char *src, int count, int width, int *lp));
 
 extern char* StripHighlight P((char *));  /* returns static data */
 extern char* StripHighlightAndTitle P((char *));  /* returns static data */
 extern void ics_update_width P((int new_width));
 extern Boolean set_cont_sequence P((char *new_seq));
 extern int wrap P((char *dest, char *src, int count, int width, int *lp));
+int Explode P((Board board, int fromX, int fromY, int toX, int toY));
 
 
-typedef enum { CheckBox, ComboBox, TextBox, Button, Spin, ResetButton,
-                  SaveButton, FileName, PathName, Slider, Message } Control;
+typedef enum { CheckBox, ComboBox, TextBox, Button, Spin, ResetButton, SaveButton, ListBox, Graph, PopUp,
+                FileName, PathName, Slider, Message, Fractional, Label, Icon,
+                BoxBegin, BoxEnd, BarBegin, BarEnd, DropDown, Break, EndMark } Control;
 
 
-typedef struct _OPT {   // [HGM] options: descriptor of UCI-style option
+typedef struct XB_OPT {   // [HGM] options: descriptor of UCI-style option
     int value;          // current setting, starts as default
     int value;          // current setting, starts as default
-    int min;
+    int min;           // Also used for flags
     int max;
     void *handle;       // for use by front end
     int max;
     void *handle;       // for use by front end
+    void *target;       // for use by front end
     char *textValue;    // points to beginning of text value in name field
     char **choice;      // points to array of combo choices in cps->combo
     Control type;
     char *textValue;    // points to beginning of text value in name field
     char **choice;      // points to array of combo choices in cps->combo
     Control type;
-    char name[MSG_SIZ]; // holds both option name and text value
+    char *name;         // holds both option name and text value (in allocated memory)
 } Option;
 
 } Option;
 
-typedef struct _CPS {
+typedef struct XB_CPS {
     char *which;
     int maybeThinking;
     ProcRef pr;
     char *which;
     int maybeThinking;
     ProcRef pr;
@@ -305,7 +347,7 @@ typedef struct _CPS {
     char *program;
     char *host;
     char *dir;
     char *program;
     char *host;
     char *dir;
-    struct _CPS *other;
+    struct XB_CPS *other;
     char *initString;
     char *computerString;
     int sendTime; /* 0=don't, 1=do, 2=test */
     char *initString;
     char *computerString;
     int sendTime; /* 0=don't, 1=do, 2=test */
@@ -315,6 +357,7 @@ typedef struct _CPS {
     int offeredDraw; /* countdown */
     int reuse;
     int useSetboard; /* 0=use "edit"; 1=use "setboard" */
     int offeredDraw; /* countdown */
     int reuse;
     int useSetboard; /* 0=use "edit"; 1=use "setboard" */
+    int extendedEdit;/* 1=also set holdings with "edit" */
     int useSAN;      /* 0=use coordinate notation; 1=use SAN */
     int usePing;     /* 0=not OK to use ping; 1=OK */
     int lastPing;
     int useSAN;      /* 0=use coordinate notation; 1=use SAN */
     int usePing;     /* 0=not OK to use ping; 1=OK */
     int lastPing;
@@ -326,9 +369,10 @@ typedef struct _CPS {
     int sendName;    /* 0=don't use "name" command; 1=do */
     int sdKludge;    /* 0=use "sd DEPTH" command; 1=use "depth\nDEPTH" */
     int stKludge;    /* 0=use "st TIME" command; 1=use "level 1 TIME" */
     int sendName;    /* 0=don't use "name" command; 1=do */
     int sdKludge;    /* 0=use "sd DEPTH" command; 1=use "depth\nDEPTH" */
     int stKludge;    /* 0=use "st TIME" command; 1=use "level 1 TIME" */
-    char tidy[MSG_SIZ];
+    int excludeMoves;/* 0=don't use "exclude" command; 1=do */
+    char *tidy;
     int matchWins;
     int matchWins;
-    char variants[MSG_SIZ];
+    char *variants;
     int analysisSupport;
     int analyzing;
     int protocolVersion;
     int analysisSupport;
     int analyzing;
     int protocolVersion;
@@ -353,8 +397,10 @@ typedef struct _CPS {
     int alphaRank;    /* [HGM] shogi: engine uses shogi-type coordinates    */
     int maxCores;     /* [HGM] SMP: engine understands cores command        */
     int memSize;      /* [HGM] memsize: engine understands memory command   */
     int alphaRank;    /* [HGM] shogi: engine uses shogi-type coordinates    */
     int maxCores;     /* [HGM] SMP: engine understands cores command        */
     int memSize;      /* [HGM] memsize: engine understands memory command   */
-    char egtFormats[MSG_SIZ];     /* [HGM] EGT: supported tablebase formats */
+    char *egtFormats; /* [HGM] EGT: supported tablebase formats             */
     int bookSuspend;  /* [HGM] book: go was deferred because of book hit    */
     int bookSuspend;  /* [HGM] book: go was deferred because of book hit    */
+    int pause;        /* [HGM] pause: 1=supports it, 2=actually paused      */
+    int highlight;    /* [HGM] engine wants to get lift and put commands    */
     int nrOptions;    /* [HGM] options: remembered option="..." features    */
 #define MAX_OPTIONS 200
     Option option[MAX_OPTIONS];
     int nrOptions;    /* [HGM] options: remembered option="..." features    */
 #define MAX_OPTIONS 200
     Option option[MAX_OPTIONS];
@@ -363,7 +409,8 @@ typedef struct _CPS {
     char *optionSettings;
     void *programLogo; /* [HGM] logo: bitmap of the logo                    */
     char *fenOverride; /* [HGM} FRC: force FEN casling & ep fields by hand  */
     char *optionSettings;
     void *programLogo; /* [HGM] logo: bitmap of the logo                    */
     char *fenOverride; /* [HGM} FRC: force FEN casling & ep fields by hand  */
-    char userError;    /* [HGM] crash: flag to suppress fatal-error messages*/\r
+    char userError;    /* [HGM] crash: flag to suppress fatal-error messages*/
+    char reload;       /* [HGM] options: flag to resend options with xreuse */
 } ChessProgramState;
 
 extern ChessProgramState first, second;
 } ChessProgramState;
 
 extern ChessProgramState first, second;
@@ -386,9 +433,31 @@ typedef struct {
 } ChessProgramStats;
 
 extern ChessProgramStats_Move pvInfoList[MAX_MOVES];
 } ChessProgramStats;
 
 extern ChessProgramStats_Move pvInfoList[MAX_MOVES];
-extern int shuffleOpenings;
+extern Boolean shuffleOpenings;
 extern ChessProgramStats programStats;
 extern int opponentKibitzes; // used by wengineo.c
 extern ChessProgramStats programStats;
 extern int opponentKibitzes; // used by wengineo.c
-extern int errorExitStatus;\r
+extern int errorExitStatus;
+extern char *recentEngines;
+extern char *comboLine;
+extern Boolean partnerUp, twoBoards;
+extern char engineVariant[];
+char *EngineDefinedVariant P((ChessProgramState *cps, int n));
+void SettingsPopUp P((ChessProgramState *cps)); // [HGM] really in front-end, but CPS not known in frontend.h
+int WaitForEngine P((ChessProgramState *cps, DelayedEventCallback x));
+void Load P((ChessProgramState *cps, int n));
+int MultiPV P((ChessProgramState *cps));
+void MoveHistorySet P(( char movelist[][2*MOVE_LEN], int first, int last, int current, ChessProgramStats_Move * pvInfo ));
+void MakeEngineOutputTitle P((void));
+void LoadTheme P((void));
+void CreateBookEvent P((void));
+
+/* A point in time */
+typedef struct {
+    long sec;  /* Assuming this is >= 32 bits */
+    int ms;    /* Assuming this is >= 16 bits */
+} TimeMark;
+
+void GetTimeMark P((TimeMark *));
+long SubtractTimeMarks P((TimeMark *, TimeMark *));
 
 
-#endif /* _BACKEND */
+#endif /* XB_BACKEND */