Add task-bar icon
[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 XB_FRONTEND
55 #define XB_FRONTEND
56
57 #include <stdio.h>
58
59 char *T_ P((char *s));
60 void ModeHighlight P((void));
61 void SetICSMode P((void));
62 void SetGNUMode P((void));
63 void SetNCPMode P((void));
64 void SetCmailMode P((void));
65 void SetTrainingModeOn P((void));
66 void SetTrainingModeOff P((void));
67 void SetUserThinkingEnables P((void));
68 void SetMachineThinkingEnables P((void));
69 void DisplayTitle P((String title));
70 void DisplayMessage P((String message, String extMessage));
71 void DisplayMoveError P((String message));
72
73 void DisplayNote P((String message));
74
75 void DisplayInformation P((String message));
76 void AskQuestion P((String title, String question, String replyPrefix,
77                     ProcRef pr));
78 void DisplayIcsInteractionTitle P((String title));
79 void ParseArgsFromString P((char *p));
80 void ParseArgsFromFile P((FILE *f));
81 void DrawPosition P((int fullRedraw, Board board));
82 void ResetFrontEnd P((void));
83 void NotifyFrontendLogin P((void));
84 void CommentPopUp P((String title, String comment));
85 void CommentPopDown P((void));
86 void EditCommentPopUp P((int index, String title, String text));
87 void ErrorPopDown P((void));
88 int  EventToSquare P((int x, int limit));
89 void DrawSeekAxis P(( int x, int y, int xTo, int yTo ));
90 void DrawSeekBackground P(( int left, int top, int right, int bottom ));
91 void DrawSeekText P((char *buf, int x, int y));
92 void DrawSeekDot P((int x, int y, int color));
93 void PopUpMoveDialog P((char first));
94
95 void RingBell P((void));
96 void PlayIcsWinSound P((void));
97 void PlayIcsLossSound P((void));
98 void PlayIcsDrawSound P((void));
99 void PlayIcsUnfinishedSound P((void));
100 void PlayAlarmSound P((void));
101 void PlayTellSound P((void));
102 void PlaySoundFile P((char *name));
103 void PlaySoundByColor P((void));
104 void EchoOn P((void));
105 void EchoOff P((void));
106 void Raw P((void));
107 void Colorize P((ColorClass cc, int continuation));
108 char *InterpretFileName P((char *name, char *dir));
109 void DoSleep P((int n));
110
111 char *UserName P((void));
112 char *HostName P((void));
113
114 int ClockTimerRunning P((void));
115 int StopClockTimer P((void));
116 void StartClockTimer P((long millisec));
117 void DisplayWhiteClock P((long timeRemaining, int highlight));
118 void DisplayBlackClock P((long timeRemaining, int highlight));
119 void UpdateLogos P((int display));
120
121 int LoadGameTimerRunning P((void));
122 int StopLoadGameTimer P((void));
123 void StartLoadGameTimer P((long millisec));
124 void AutoSaveGame P((void));
125
126 void ScheduleDelayedEvent P((DelayedEventCallback cb, long millisec));
127 DelayedEventCallback GetDelayedEvent P((void));
128 void CancelDelayedEvent P((void));
129 // [HGM] mouse: next six used by mouse handler, which was moved to backend
130 extern int fromX, fromY, toX, toY;
131 void PromotionPopUp P((void));
132 void DragPieceBegin P((int x, int y, Boolean instantly));
133 void DragPieceEnd P((int x, int y));
134 void DragPieceMove P((int x, int y));
135 void LeftClick P((ClickType c, int x, int y));
136 int  RightClick P((ClickType c, int x, int y, int *col, int *row));
137
138 int StartChildProcess P((char *cmdLine, char *dir, ProcRef *pr));
139 void DestroyChildProcess P((ProcRef pr, int/*boolean*/ signal));
140 void InterruptChildProcess P((ProcRef pr));
141 void RunCommand P((char *buf));
142
143 int OpenTelnet P((char *host, char *port, ProcRef *pr));
144 int OpenTCP P((char *host, char *port, ProcRef *pr));
145 int OpenCommPort P((char *name, ProcRef *pr));
146 int OpenLoopback P((ProcRef *pr));
147 int OpenRcmd P((char *host, char *user, char *cmd, ProcRef *pr));
148
149 typedef void (*InputCallback) P((InputSourceRef isr, VOIDSTAR closure,
150                                  char *buf, int count, int error));
151 /* pr == NoProc means the local keyboard */
152 InputSourceRef AddInputSource P((ProcRef pr, int lineByLine,
153                                  InputCallback func, VOIDSTAR closure));
154 void RemoveInputSource P((InputSourceRef isr));
155
156 /* pr == NoProc means the local display */
157 int OutputToProcess P((ProcRef pr, char *message, int count, int *outError));
158 int OutputToProcessDelayed P((ProcRef pr, char *message, int count,
159                               int *outError, long msdelay));
160
161 void CmailSigHandlerCallBack P((InputSourceRef isr, VOIDSTAR closure,
162                                 char *buf, int count, int error));
163
164 extern ProcRef cmailPR;
165 extern int shiftKey, controlKey;
166
167 /* in xgamelist.c or winboard.c */
168 void GLT_ClearList();
169 void GLT_DeSelectList();
170 void GLT_AddToList( char *name );
171 Boolean GLT_GetFromList( int index, char *name );
172
173 extern char lpUserGLT[];
174 extern char *homeDir;
175
176 /* these are in wgamelist.c */
177 void GameListPopUp P((FILE *fp, char *filename));
178 void GameListPopDown P((void));
179 void GameListHighlight P((int index));
180 void GameListDestroy P((void));
181
182 /* these are in wedittags.c */
183 void EditTagsPopUp P((char *tags, char **dest));
184 void TagsPopUp P((char *tags, char *msg));
185 void TagsPopDown P((void));
186
187 void ParseIcsTextColors P((void));
188 void ICSInitScript P((void));
189 void StartAnalysisClock P((void));
190 void EngineOutputPopUp P((void));
191 void EgineOutputPopDown P((void));
192
193 void SetHighlights P((int fromX, int fromY, int toX, int toY));
194 void ClearHighlights P((void));
195 void SetPremoveHighlights P((int fromX, int fromY, int toX, int toY));
196 void ClearPremoveHighlights P((void));
197
198 void AnimateAtomicCapture P((Board board, int fromX, int fromY, int toX, int toY));
199 void ShutDownFrontEnd P((void));
200 void BoardToTop P((void));
201 void AnimateMove P((Board board, int fromX, int fromY, int toX, int toY));
202 void HistorySet P((char movelist[][2*MOVE_LEN], int first, int last, int current));
203 void FreezeUI P((void));
204 void ThawUI P((void));
205 void ChangeDragPiece P((ChessSquare piece));
206 void CopyFENToClipboard P((void));
207 extern char *programName;
208 extern int commentUp;
209 extern char *firstChessProgramNames;
210
211 void GreyRevert P((Boolean grey));
212 void EnableNamedMenuItem P((char *menuRef, int state));
213
214 typedef struct FrontEndProgramStats_TAG {
215     int which;
216     int depth;
217     unsigned long nodes;
218     int score;
219     int time;
220     char * pv;
221     char * hint;
222     int an_move_index;
223     int an_move_count;
224 } FrontEndProgramStats;
225
226 void SetProgramStats P(( FrontEndProgramStats * stats )); /* [AS] */
227
228 void EngineOutputPopUp P((void));
229 void EngineOutputPopDown P((void));
230 int  EngineOutputIsUp P((void));
231 int  EngineOutputDialogExists P((void));
232 void EvalGraphPopUp P((void));
233 Boolean EvalGraphIsUp P((void));
234 int  EvalGraphDialogExists P((void));
235 void SlavePopUp P((void));
236
237 /* these are in xhistory.c  */
238 Boolean MoveHistoryIsUp P((void));
239 void HistoryPopUp P((void));
240
241 #endif /* XB_FRONTEND */