security fix: replaced strcpy with safeStrCpy from backend.c
[xboard.git] / backend.h
index 9e1fbb0..79478aa 100644 (file)
--- a/backend.h
+++ b/backend.h
@@ -1,9 +1,13 @@
 /*
  * backend.h -- Interface exported by XBoard back end
- * $Id$
  *
- * Copyright 1991 by Digital Equipment Corporation, Maynard, Massachusetts.
- * Enhancements Copyright 1992-95 Free Software Foundation, Inc.
+ * Copyright 1991 by Digital Equipment Corporation, Maynard,
+ * Massachusetts.
+ *
+ * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
+ * 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+ *
+ * Enhancements Copyright 2005 Alessandro Scotti
  *
  * The following terms apply to Digital Equipment Corporation's copyright
  * interest in XBoard:
  * SOFTWARE.
  * ------------------------------------------------------------------------
  *
- * The following terms apply to the enhanced version of XBoard distributed
- * by the Free Software Foundation:
+ * The following terms apply to the enhanced version of XBoard
+ * distributed by the Free Software Foundation:
  * ------------------------------------------------------------------------
- * This program is free software; you can redistribute it and/or modify
+ *
+ * GNU XBoard is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * GNU XBoard is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- * ------------------------------------------------------------------------
- */
+ * along with this program. If not, see http://www.gnu.org/licenses/.  *
+ *
+ *------------------------------------------------------------------------
+ ** See the file ChangeLog for a revision history.  */
+
 #ifndef _BACKEND
 #define _BACKEND
 
+/* unsigned int 64 for engine nodes work and display */
+#ifdef WIN32
+       /* I don't know the name for this type of other compiler
+        * If it not work, just modify here
+        * This is for MS Visual Studio
+        */
+       #ifdef _MSC_VER
+               #define u64 unsigned __int64
+               #define s64 signed __int64
+               #define u64Display "%I64u"
+               #define s64Display "%I64d"
+               #define u64Const(c) (c ## UI64)
+               #define s64Const(c) (c ## I64)
+       #else
+               /* place holder
+                * or dummy types for other compiler
+                * [HGM] seems that -mno-cygwin comple needs %I64?
+                */
+               #define u64 unsigned long long
+               #define s64 signed long long
+               #ifdef USE_I64
+                  #define u64Display "%I64u"
+                  #define s64Display "%I64d"
+               #else
+                  #define u64Display "%llu"
+                  #define s64Display "%lld"
+               #endif
+               #define u64Const(c) (c ## ULL)
+               #define s64Const(c) (c ## LL)
+       #endif
+#else
+       /* GNU gcc */
+       #define u64 unsigned long long
+       #define s64 signed long long
+       #define u64Display "%llu"
+       #define s64Display "%lld"
+       #define u64Const(c) (c ## ull)
+       #define s64Const(c) (c ## ll)
+#endif
+
 #include "lists.h"
 #include "frontend.h"
 
 extern int gotPremove;
 extern GameMode gameMode;
-extern int pausing, cmailMsgLoaded, flipView;
+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;
@@ -61,22 +109,29 @@ extern FILE *debugFP;
 extern char* programVersion;
 extern ProcRef firstProgramPR, secondProgramPR;
 extern Board boards[];
+extern char marker[BOARD_RANKS][BOARD_FILES];
 
 char *CmailMsg P((void));
-char *PositionToFEN P((int move));
+/* Tord: Added the useFEN960 parameter in PositionToFEN() below */
+char *PositionToFEN P((int move, char* useFEN960));
+void AlphaRank P((char *s, int n)); /* [HGM] Shogi move preprocessor */
 void EditPositionPasteFEN P((char *fen));
 void TimeDelay P((long ms));
 void SendMultiLineToICS P(( char *text ));
 void AnalysisPeriodicEvent P((int force));
 void SetWhiteToPlayEvent P((void));
 void SetBlackToPlayEvent P((void));
+void UploadGameEvent P((void));
 void InitBackEnd1 P((void));
 void InitBackEnd2 P((void));
-int IsPromotion P((int fromX, int fromY, int toX, int toY));
+int HasPromotionChoice P((int fromX, int fromY, int toX, int toY, char *choice));
+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
 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));
@@ -86,6 +141,8 @@ int SaveGameToFile P((char *filename, int append));
 int LoadPosition P((FILE *f, int n, char *title));
 int ReloadPosition P((int offset));
 int SavePosition P((FILE *f, int dummy, char *dummy2));
+int DrawSeekGraph P(());
+int SeekGraphClick P((ClickType click, int x, int y, int moving));
 void EditPositionEvent P((void));
 void FlipViewEvent P((void));
 void MachineWhiteEvent P((void));
@@ -99,7 +156,7 @@ void BackwardEvent P((void));
 void ToEndEvent P((void));
 void ToStartEvent P((void));
 void ToNrEvent P((int to));
-void RevertEvent P((void));
+void RevertEvent P((Boolean annotate));
 void RetractMoveEvent P((void));
 void MoveNowEvent P((void));
 void TruncateGameEvent P((void));
@@ -112,29 +169,34 @@ void DrawEvent P((void));
 void AbortEvent P((void));
 void AdjournEvent P((void));
 void ResignEvent P((void));
+void UserAdjudicationEvent P((int result));
 void StopObservingEvent P((void));
 void StopExaminingEvent P((void));
 void PonderNextMoveEvent P((int newState));
-void ShowThinkingEvent P((int newState));
+void ShowThinkingEvent P(());
 void PeriodicUpdatesEvent P((int newState));
 void HintEvent P((void));
 void BookEvent P((void));
 void AboutGameEvent P((void));
 void ExitEvent P((int status));
 char *DefaultFileName P((char *));
+ChessMove UserMoveTest P((int fromX, int fromY, int toX, int toY, int promoChar, Boolean captureOwn));
 void UserMoveEvent P((int fromX, int fromY, int toX, int toY, int promoChar));
 void DecrementClocks P((void));
 char *TimeString P((long millisec));
 void AutoPlayGameLoop P((void));
+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));
 int ParseTimeControl P((char *tc, int 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));
+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));
@@ -142,9 +204,12 @@ void GetMoveListEvent P((void));
 void ExitAnalyzeMode P((void));
 void AnalyzeModeEvent P((void));
 void AnalyzeFileEvent P((void));
+void InitPosition P((int redraw));
+void NewSettingEvent P((int option, int *feature, char *command, int value));
 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,
@@ -152,11 +217,21 @@ Boolean ParseOneMove P((char *move, int moveNum,
                        int *toX, int *toY, char *promoChar));
 char *VariantName P((VariantClass v));
 VariantClass StringToVariant P((char *e));
+double u64ToDouble P((u64 value));
+void OutputChatMessage P((int partner, char *mess));
+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));
+void UnLoadPV P(());
+void MovePV P((int x, int y, int h));
 
 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));
@@ -169,6 +244,14 @@ int ToUpper P((int 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;
+
 
 /* pgntags.c prototypes
  */
@@ -194,10 +277,29 @@ void ClearGameInfo P((GameInfo *));
 int GameListBuild P((FILE *));
 void GameListInitGameInfo P((GameInfo *));
 char *GameListLine P((int, GameInfo *));
+char * GameListLineFull P(( int, GameInfo *));
+void GLT_TagsToList P(( char * tags ));
+void GLT_ParseList P((void));
 
 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));
 
+typedef enum { CheckBox, ComboBox, TextBox, Button, Spin, ResetButton,
+                  SaveButton, FileName, PathName, Slider, Message } Control;
+
+typedef struct _OPT {   // [HGM] options: descriptor of UCI-style option
+    int value;          // current setting, starts as default
+    int min;
+    int max;
+    void *handle;       // 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 name[MSG_SIZ]; // holds both option name and text value
+} Option;
 
 typedef struct _CPS {
     char *which;
@@ -236,8 +338,62 @@ typedef struct _CPS {
     int analyzing;
     int protocolVersion;
     int initDone;
+
+    /* Added by Tord: */
+    int useFEN960;   /* 0=use "KQkq" style FENs, 1=use "HAha" style FENs */
+    int useOOCastle; /* 0="O-O" notation for castling, 1="king capture rook" notation */
+    /* End of additions by Tord */
+
+    int scoreIsAbsolute; /* [AS] 0=don't know (standard), 1=score is always from white side */
+    int isUCI;           /* [AS] 0=no (Winboard), 1=UCI (requires Polyglot) */
+    int hasOwnBookUCI;   /* [AS] 0=use GUI or Polyglot book, 1=has own book */
+
+    /* [HGM] time odds */
+    float timeOdds; /* factor through which we divide time for this engine  */
+    int debug;      /* [HGM] ignore engine debug lines starting with '#'    */
+    int maxNrOfSessions; /* [HGM] secondary TC: max args in 'level' command */
+    int accumulateTC; /* [HGM] secondary TC: how to handle extra sessions   */
+    int nps;          /* [HGM] nps: factor for node count to replace time   */
+    int supportsNPS;
+    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 */
+    int bookSuspend;  /* [HGM] book: go was deferred because of book hit    */
+    int nrOptions;    /* [HGM] options: remembered option="..." features    */
+#define MAX_OPTIONS 200
+    Option option[MAX_OPTIONS];
+    int comboCnt;
+    char *comboList[20*MAX_OPTIONS];
+    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
 } ChessProgramState;
 
 extern ChessProgramState first, second;
 
+/* Search stats from chessprogram */
+typedef struct {
+  char movelist[2*MSG_SIZ]; /* Last PV we were sent */
+  int depth;              /* Current search depth */
+  int nr_moves;           /* Total nr of root moves */
+  int moves_left;         /* Moves remaining to be searched */
+  char move_name[MOVE_LEN];  /* Current move being searched, if provided */
+  u64 nodes;    /* # of nodes searched */
+  int time;               /* Search time (centiseconds) */
+  int score;              /* Score (centipawns) */
+  int got_only_move;      /* If last msg was "(only move)" */
+  int got_fail;           /* 0 - nothing, 1 - got "--", 2 - got "++" */
+  int ok_to_send;         /* handshaking between send & recv */
+  int line_is_book;       /* 1 if movelist is book moves */
+  int seen_stat;          /* 1 if we've seen the stat01: line */
+} ChessProgramStats;
+
+extern ChessProgramStats_Move pvInfoList[MAX_MOVES];
+extern int shuffleOpenings;
+extern ChessProgramStats programStats;
+extern int opponentKibitzes; // used by wengineo.c
+extern int errorExitStatus;\r
+
 #endif /* _BACKEND */