frontend.h

   1 /*
   2  * frontend.h -- Interface exported by all XBoard front ends
   3  *
   4  * Copyright 1991 by Digital Equipment Corporation, Maynard,
   5  * Massachusetts.
   6  *
   7  * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
   8  * 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
   9  *
  10  * Enhancements Copyright 2005 Alessandro Scotti
  11  *
  12  * The following terms apply to Digital Equipment Corporation's copyright
  13  * interest in XBoard:
  14  * ------------------------------------------------------------------------
  15  * All Rights Reserved
  16  *
  17  * Permission to use, copy, modify, and distribute this software and its
  18  * documentation for any purpose and without fee is hereby granted,
  19  * provided that the above copyright notice appear in all copies and that
  20  * both that copyright notice and this permission notice appear in
  21  * supporting documentation, and that the name of Digital not be
  22  * used in advertising or publicity pertaining to distribution of the
  23  * software without specific, written prior permission.
  24  *
  25  * DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  26  * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  27  * DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  28  * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  29  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  30  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  31  * SOFTWARE.
  32  * ------------------------------------------------------------------------
  33  *
  34  * The following terms apply to the enhanced version of XBoard
  35  * distributed by the Free Software Foundation:
  36  * ------------------------------------------------------------------------
  37  *
  38  * GNU XBoard is free software: you can redistribute it and/or modify
  39  * it under the terms of the GNU General Public License as published by
  40  * the Free Software Foundation, either version 3 of the License, or (at
  41  * your option) any later version.
  42  *
  43  * GNU XBoard is distributed in the hope that it will be useful, but
  44  * WITHOUT ANY WARRANTY; without even the implied warranty of
  45  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  46  * General Public License for more details.
  47  *
  48  * You should have received a copy of the GNU General Public License
  49  * along with this program. If not, see http://www.gnu.org/licenses/.  *
  50  *
  51  *------------------------------------------------------------------------
  52  ** See the file ChangeLog for a revision history.  */
  53
  54 #ifndef _FRONTEND
  55 #define _FRONTEND
  56
  57 #include <stdio.h>
  58
  59 typedef VOIDSTAR ProcRef;
  60 #define NoProc ((ProcRef) 0)
  61 typedef VOIDSTAR InputSourceRef;
  62
  63 char *T_ P((char *s));
  64 void ModeHighlight P((void));
  65 void SetICSMode P((void));
  66 void SetGNUMode P((void));
  67 void SetNCPMode P((void));
  68 void SetCmailMode P((void));
  69 void SetTrainingModeOn P((void));
  70 void SetTrainingModeOff P((void));
  71 void SetUserThinkingEnables P((void));
  72 void SetMachineThinkingEnables P((void));
  73 void DisplayTitle P((String title));
  74 void DisplayMessage P((String message, String extMessage));
  75 void DisplayError P((String message, int error));
  76 void DisplayMoveError P((String message));
  77
  78 /* If status == 0, we are exiting with a benign message, not an error */
  79 void DisplayFatalError P((String message, int error, int status));
  80
  81 void DisplayInformation P((String message));
  82 void DisplayNote P((String message));
  83 void AskQuestion P((String title, String question, String replyPrefix,
  84                     ProcRef pr));
  85 void DisplayIcsInteractionTitle P((String title));
  86 void ParseArgsFromString P((char *p));
  87 void ParseArgsFromFile P((FILE *f));
  88 void DrawPosition P((int fullRedraw, Board board));
  89 void ResetFrontEnd P((void));
  90 void NotifyFrontendLogin P((void));
  91 void CommentPopUp P((String title, String comment));
  92 void CommentPopDown P((void));
  93 void EditCommentPopUp P((int index, String title, String text));
  94 void ErrorPopDown P((void));
  95 int  EventToSquare P((int x, int limit));
  96 void DrawSeekAxis P(( int x, int y, int xTo, int yTo ));
  97 void DrawSeekBackground P(( int left, int top, int right, int bottom ));
  98 void DrawSeekText P((char *buf, int x, int y));
  99 void DrawSeekDot P((int x, int y, int color));
 100 void PopUpMoveDialog P((char first));
 101
 102 void RingBell P((void));
 103 void PlayIcsWinSound P((void));
 104 void PlayIcsLossSound P((void));
 105 void PlayIcsDrawSound P((void));
 106 void PlayIcsUnfinishedSound P((void));
 107 void PlayAlarmSound P((void));
 108 void PlayTellSound P((void));
 109 void EchoOn P((void));
 110 void EchoOff P((void));
 111 void Raw P((void));
 112 void Colorize P((ColorClass cc, int continuation));
 113 char *InterpretFileName P((char *name, char *dir));
 114 void DoSleep P((int n));
 115
 116 char *UserName P((void));
 117 char *HostName P((void));
 118
 119 int ClockTimerRunning P((void));
 120 int StopClockTimer P((void));
 121 void StartClockTimer P((long millisec));
 122 void DisplayWhiteClock P((long timeRemaining, int highlight));
 123 void DisplayBlackClock P((long timeRemaining, int highlight));
 124 void UpdateLogos P((int display));
 125
 126 int LoadGameTimerRunning P((void));
 127 int StopLoadGameTimer P((void));
 128 void StartLoadGameTimer P((long millisec));
 129 void AutoSaveGame P((void));
 130
 131 typedef void (*DelayedEventCallback) P((void));
 132 void ScheduleDelayedEvent P((DelayedEventCallback cb, long millisec));
 133 DelayedEventCallback GetDelayedEvent P((void));
 134 void CancelDelayedEvent P((void));
 135 // [HGM] mouse: next six used by mouse handler, which was moved to backend
 136 extern int fromX, fromY, toX, toY;
 137 typedef enum { Press, Release } ClickType;
 138 void PromotionPopUp P((void));
 139 void DragPieceBegin P((int x, int y, Boolean instantly));
 140 void DragPieceEnd P((int x, int y));
 141 void LeftClick P((ClickType c, int x, int y));
 142 int  RightClick P((ClickType c, int x, int y, int *col, int *row));
 143
 144 int StartChildProcess P((char *cmdLine, char *dir, ProcRef *pr));
 145 void DestroyChildProcess P((ProcRef pr, int/*boolean*/ signal));
 146 void InterruptChildProcess P((ProcRef pr));
 147 void RunCommand P((char *buf));
 148
 149 int OpenTelnet P((char *host, char *port, ProcRef *pr));
 150 int OpenTCP P((char *host, char *port, ProcRef *pr));
 151 int OpenCommPort P((char *name, ProcRef *pr));
 152 int OpenLoopback P((ProcRef *pr));
 153 int OpenRcmd P((char *host, char *user, char *cmd, ProcRef *pr));
 154
 155 typedef void (*InputCallback) P((InputSourceRef isr, VOIDSTAR closure,
 156                                  char *buf, int count, int error));
 157 /* pr == NoProc means the local keyboard */
 158 InputSourceRef AddInputSource P((ProcRef pr, int lineByLine,
 159                                  InputCallback func, VOIDSTAR closure));
 160 void RemoveInputSource P((InputSourceRef isr));
 161
 162 /* pr == NoProc means the local display */
 163 int OutputToProcess P((ProcRef pr, char *message, int count, int *outError));
 164 int OutputToProcessDelayed P((ProcRef pr, char *message, int count,
 165                               int *outError, long msdelay));
 166
 167 void CmailSigHandlerCallBack P((InputSourceRef isr, VOIDSTAR closure,
 168                                 char *buf, int count, int error));
 169
 170 extern ProcRef cmailPR;
 171 extern int shiftKey;
 172
 173 /* in xgamelist.c or winboard.c */
 174 void GLT_ClearList();
 175 void GLT_DeSelectList();
 176 void GLT_AddToList( char *name );
 177 Boolean GLT_GetFromList( int index, char *name );
 178
 179 extern char lpUserGLT[];
 180 extern char *homeDir;
 181
 182 /* these are in wgamelist.c */
 183 void GameListPopUp P((FILE *fp, char *filename));
 184 void GameListPopDown P((void));
 185 void GameListHighlight P((int index));
 186 void GameListDestroy P((void));
 187
 188 /* these are in wedittags.c */
 189 void EditTagsPopUp P((char *tags, char **dest));
 190 void TagsPopUp P((char *tags, char *msg));
 191 void TagsPopDown P((void));
 192
 193 void ICSInitScript P((void));
 194 void StartAnalysisClock P((void));
 195 void EngineOutputPopUp P((void));
 196 void EgineOutputPopDown P((void));
 197
 198 void SetHighlights P((int fromX, int fromY, int toX, int toY));
 199 void ClearHighlights P((void));
 200 void SetPremoveHighlights P((int fromX, int fromY, int toX, int toY));
 201 void ClearPremoveHighlights P((void));
 202
 203 void AnimateAtomicCapture P((Board board, int fromX, int fromY, int toX, int toY));
 204 void ShutDownFrontEnd P((void));
 205 void BoardToTop P((void));
 206 void AnimateMove P((Board board, int fromX, int fromY, int toX, int toY));
 207 void HistorySet P((char movelist[][2*MOVE_LEN], int first, int last, int current));
 208 void FreezeUI P((void));
 209 void ThawUI P((void));
 210 void ChangeDragPiece P((ChessSquare piece));
 211 void CopyFENToClipboard P((void));
 212 extern char *programName;
 213 extern int commentUp;
 214 extern char *firstChessProgramNames;
 215
 216 void GreyRevert P((Boolean grey));
 217
 218 typedef struct FrontEndProgramStats_TAG {
 219     int which;
 220     int depth;
 221     unsigned long nodes;
 222     int score;
 223     int time;
 224     char * pv;
 225     char * hint;
 226     int an_move_index;
 227     int an_move_count;
 228 } FrontEndProgramStats;
 229
 230 void SetProgramStats P(( FrontEndProgramStats * stats )); /* [AS] */
 231
 232 void EngineOutputPopUp P((void));
 233 void EngineOutputPopDown P((void));
 234 int  EngineOutputIsUp P((void));
 235 int  EngineOutputDialogExists P((void));
 236 void EvalGraphPopUp P((void));
 237 void EvalGraphPopDown P((void));
 238 Boolean EvalGraphIsUp P((void));
 239 int  EvalGraphDialogExists P((void));
 240
 241 /* these are in xhistory.c  */
 242 Boolean MoveHistoryIsUp P((void));
 243 void HistoryPopUp P((void));
 244
 245 #endif