new version number for developer release
[xboard.git] / 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 PlaySoundFile P((char *name));
110 void PlaySoundByColor P((void));
111 void EchoOn P((void));
112 void EchoOff P((void));
113 void Raw P((void));
114 void Colorize P((ColorClass cc, int continuation));
115 char *InterpretFileName P((char *name, char *dir));
116 void DoSleep P((int n));
117
118 char *UserName P((void));
119 char *HostName P((void));
120
121 int ClockTimerRunning P((void));
122 int StopClockTimer P((void));
123 void StartClockTimer P((long millisec));
124 void DisplayWhiteClock P((long timeRemaining, int highlight));
125 void DisplayBlackClock P((long timeRemaining, int highlight));
126 void UpdateLogos P((int display));
127
128 int LoadGameTimerRunning P((void));
129 int StopLoadGameTimer P((void));
130 void StartLoadGameTimer P((long millisec));
131 void AutoSaveGame P((void));
132
133 typedef void (*DelayedEventCallback) P((void));
134 void ScheduleDelayedEvent P((DelayedEventCallback cb, long millisec));
135 DelayedEventCallback GetDelayedEvent P((void));
136 void CancelDelayedEvent P((void));
137 // [HGM] mouse: next six used by mouse handler, which was moved to backend
138 extern int fromX, fromY, toX, toY;
139 typedef enum { Press, Release } ClickType;
140 void PromotionPopUp P((void));
141 void DragPieceBegin P((int x, int y, Boolean instantly));
142 void DragPieceEnd P((int x, int y));
143 void DragPieceMove P((int x, int y));
144 void LeftClick P((ClickType c, int x, int y));
145 int  RightClick P((ClickType c, int x, int y, int *col, int *row));
146
147 int StartChildProcess P((char *cmdLine, char *dir, ProcRef *pr));
148 void DestroyChildProcess P((ProcRef pr, int/*boolean*/ signal));
149 void InterruptChildProcess P((ProcRef pr));
150 void RunCommand P((char *buf));
151
152 int OpenTelnet P((char *host, char *port, ProcRef *pr));
153 int OpenTCP P((char *host, char *port, ProcRef *pr));
154 int OpenCommPort P((char *name, ProcRef *pr));
155 int OpenLoopback P((ProcRef *pr));
156 int OpenRcmd P((char *host, char *user, char *cmd, ProcRef *pr));
157
158 typedef void (*InputCallback) P((InputSourceRef isr, VOIDSTAR closure,
159                                  char *buf, int count, int error));
160 /* pr == NoProc means the local keyboard */
161 InputSourceRef AddInputSource P((ProcRef pr, int lineByLine,
162                                  InputCallback func, VOIDSTAR closure));
163 void RemoveInputSource P((InputSourceRef isr));
164
165 /* pr == NoProc means the local display */
166 int OutputToProcess P((ProcRef pr, char *message, int count, int *outError));
167 int OutputToProcessDelayed P((ProcRef pr, char *message, int count,
168                               int *outError, long msdelay));
169
170 void CmailSigHandlerCallBack P((InputSourceRef isr, VOIDSTAR closure,
171                                 char *buf, int count, int error));
172
173 extern ProcRef cmailPR;
174 extern int shiftKey, controlKey;
175
176 /* in xgamelist.c or winboard.c */
177 void GLT_ClearList();
178 void GLT_DeSelectList();
179 void GLT_AddToList( char *name );
180 Boolean GLT_GetFromList( int index, char *name );
181
182 extern char lpUserGLT[];
183 extern char *homeDir;
184
185 /* these are in wgamelist.c */
186 void GameListPopUp P((FILE *fp, char *filename));
187 void GameListHighlight P((int index));
188 void GameListDestroy P((void));
189
190 /* these are in wedittags.c */
191 void EditTagsPopUp P((char *tags, char **dest));
192 void TagsPopUp P((char *tags, char *msg));
193 void TagsPopDown P((void));
194
195 void ParseIcsTextColors P((void));
196 void ICSInitScript P((void));
197 void StartAnalysisClock P((void));
198 void EngineOutputPopUp P((void));
199 void EgineOutputPopDown P((void));
200
201 void SetHighlights P((int fromX, int fromY, int toX, int toY));
202 void ClearHighlights P((void));
203 void SetPremoveHighlights P((int fromX, int fromY, int toX, int toY));
204 void ClearPremoveHighlights P((void));
205
206 void AnimateAtomicCapture P((Board board, int fromX, int fromY, int toX, int toY));
207 void ShutDownFrontEnd P((void));
208 void BoardToTop P((void));
209 void AnimateMove P((Board board, int fromX, int fromY, int toX, int toY));
210 void HistorySet P((char movelist[][2*MOVE_LEN], int first, int last, int current));
211 void FreezeUI P((void));
212 void ThawUI P((void));
213 void ChangeDragPiece P((ChessSquare piece));
214 void CopyFENToClipboard P((void));
215 extern char *programName;
216 extern int commentUp;
217 extern char *firstChessProgramNames;
218
219 void GreyRevert P((Boolean grey));
220 void MarkMenuItem P((char *menuRef, int state));
221 void EnableNamedMenuItem P((char *menuRef, int state));
222
223 typedef struct FrontEndProgramStats_TAG {
224     int which;
225     int depth;
226     unsigned long nodes;
227     int score;
228     int time;
229     char * pv;
230     char * hint;
231     int an_move_index;
232     int an_move_count;
233 } FrontEndProgramStats;
234
235 void SetProgramStats P(( FrontEndProgramStats * stats )); /* [AS] */
236
237 void EngineOutputPopUp P((void));
238 void EngineOutputPopDown P((void));
239 int  EngineOutputIsUp P((void));
240 int  EngineOutputDialogExists P((void));
241 void EvalGraphPopUp P((void));
242 Boolean EvalGraphIsUp P((void));
243 int  EvalGraphDialogExists P((void));
244 void SlavePopUp P((void));
245
246 /* these are in xhistory.c  */
247 Boolean MoveHistoryIsUp P((void));
248 void HistoryPopUp P((void));
249
250 #endif