Reserve piece command in protocol specs
[xboard.git] / dialogs.h
1 /*
2  * dialogs.h -- shared variables for generic dialog popup of XBoard
3  *
4  * Copyright 2000, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
5  * ------------------------------------------------------------------------
6  *
7  * GNU XBoard is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or (at
10  * your option) any later version.
11  *
12  * GNU XBoard is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see http://www.gnu.org/licenses/.  *
19  *
20  *------------------------------------------------------------------------
21  ** See the file ChangeLog for a revision history.  */
22
23 // [HGM] Some remarks about the generic dialog creator of XBoard:
24 // GenericPopUp is needed to create a dialog from the lists of options supplied by the engines.
25 // But once it is there, it provides a very easy way for creating other settings dialogs as well,
26 // by letting XBoard provide its own, compiled-in lists of XBoard options (located in dialogs.c).
27 // The Option struct uses the following fields (E = for engine options, X = for XBoard options):
28 //                    Option types                  | XBoard-only ->
29 // TYPE    NAME       spin check string combo button box label list graph menu break end
30 // int     value       E     E    (h)    X/E         [w]       (h)   (h)
31 // int     min        X/E         (2)    (3)         (1)  (1)  (1)   (1)  (3)   (1)  (4)
32 // int     max        X/E   (w)   (w)    (w)   (w)   (w)  (w)  (w)   (w)
33 // void*   handle     X/E   X/E   X/E    X/E   X/E    X    X    X     X    X
34 // void*   target      X     X     X     X/C    C          X    X     C    C
35 // char*   textValue              X/E    X/E    *
36 // char ** choice                  C     X/E    *                          X
37 // enum    type       X/E   X/E   X/E    X/E    X     X    X    X     X    X     X    X
38 // char[]  name       X/E   X/E   X/E    X/E    X          X    X     X    X
39 // File and Path options are like String (but get a browse button added in the dialog), and Slider
40 // is like Spin. Menu can be PopUp or PopDown; both need the COMBO_CALLBACK bit (3) set!
41 // (h) or (w) means the field optionally (when non-null) specifies the height or width of the main
42 // control element (excluding accompanying description texts). [w] means the width is written there.
43 // C specifies the 'target' is a user-supplied callback function, which will be executed when the
44 // option is exercised.
45
46
47 /* Flags Option.min used (2) for TextBox (-string): */
48 #define T_VSCRL         (1 << 0)
49 #define T_HSCRL         (1 << 1)
50 #define T_FILL          (1 << 2)
51 #define T_WRAP          (1 << 3)
52 #define T_TOP           (1 << 4)
53
54 /* Flags Option.min used (3) for ComboBox (-combo) and menus (PopUp, PopDown): */
55 #define COMBO_CALLBACK  (1 << 0)
56 #define NO_GETTEXT      (1 << 2)
57
58 /* Flags for Option.min used (1) for Button, SaveButton, ListBox, Label: */
59 #define SAME_ROW        (1 << 0) /* also in Break & EndMark */
60 #define BORDER          (1 << 1) /* Label */
61 #define FIX_H           (1 << 1) /* in other, this bit specifies top and botom of the control chain to same window edge */
62 #define B2B             (1 << 2) /* chain bottom to bottom (by default, no chaining is done) */
63 #define T2T             (1 << 3)
64 #define R2R             (1 << 4)
65 #define L2R             (1 << 5)
66 #define R2L             (1 << 6)
67 #define L2L             (1 << 7)
68 #define TT              (T2T|FIX_H) /* useful combinations: 0xA = entirely to top */
69 #define BB              (B2B|FIX_H) /*   6 = entirely to bottom */
70 #define TB              (B2B|T2T)   /*   0xC = absorb all vertical size change */
71 #define LL              (L2L|R2L)   /*   0xC0 = entirely to left */
72 #define RR              (L2R|R2R)   /*   0x30 = entirely to right */
73 #define LR              (L2L|R2R)   /*   0x90 = absorb all horizontal size change */
74
75 /* Flags for Option.min used (4) for EndMark: */
76 #define NO_OK           (1 << 1)
77 #define NO_CANCEL       (1 << 2)
78
79 #define MODAL 1
80 #define NONMODAL 0
81
82 /* Board widget numbers, MUST correspond to mainOptions array */
83
84 #define W_MENU   0  // main menu bar
85 #define W_ENGIN  6  // engine menu
86 #define W_TITLE 10
87 #define W_WHITE 12
88 #define W_BLACK 13
89 #define W_SMALL 15  // title in small layout
90 #define W_MESSG 16
91 #define W_BUTTON 17 // button bar
92 #define W_PAUSE 20
93 #define W_BOARD 24
94 #define W_MENUW 25
95 #define W_MENUB 26
96 #define W_DROP  27  // drop (popup) menu
97
98 typedef enum {  // identifier of dialogs done by GenericPopup
99 TransientDlg=0, // transient: grabs mouse events and is destroyed at pop-down (so other dialog can use this ID next time)
100 CommentDlg, TagsDlg, TextMenuDlg, InputBoxDlg, ChatDlg, DummyDlg, HistoryDlg, // persistent: no grab and reused
101 GameListDlg,
102 EngOutDlg,
103 EvalGraphDlg,
104 PromoDlg,       // this and beyond are destroyed at pop-down
105 ErrorDlg,
106 AskDlg,         // this and beyond do grab mouse events (and are destroyed)
107 FatalDlg,
108 BoardWindow,
109 BrowserDlg,
110 MasterDlg,
111 NrOfDialogs     // dummy for total
112 } DialogClass;
113
114 typedef int MemoCallback (Option *opt, int n, int x, int y, char *text, int index);
115 typedef Option *PointerCallback(int n, int x, int y);
116 typedef void ListBoxCallback(int n, int selected);
117 typedef void ButtonCallback(int n);
118 typedef int OKCallback(int n);
119
120 extern char commentTranslations[];
121 extern char historyTranslations[];
122 //extern Pixel timerBackgroundPixel;
123 extern int values[];
124 extern ChessProgramState *currentCps;
125 extern int dialogError;
126 extern ButtonCallback *comboCallback;
127 extern void *userLogo;
128
129 extern WindowPlacement wpComment, wpTags, wpMoveHistory, wpMain, wpDualBoard, wpConsole;
130 extern char *marked[];
131 extern Boolean shellUp[];
132 extern Option textOptions[], typeOptions[], dualOptions[], mainOptions[];
133
134
135 void GetPlacement P((DialogClass dlg, WindowPlacement *wp));
136 int DialogExists P((DialogClass n));
137 int GenericPopUp P((Option *option, char *title, DialogClass dlgNr, DialogClass parent, int modal, int topLevel));
138 int GenericReadout P((Option *currentOption, int selected));
139 int PopDown P((DialogClass n));
140 void MarkMenu P((char *item, int dlgNr));
141 int AppendText P((Option *opt, char *s));
142 void AppendColorized P((Option *opt, char *s, int count));
143 void Show P((Option *opt, int hide));
144 int  IcsHist P((int dir, Option *opt, DialogClass dlg));
145 void HighlightText P((Option *opt, int from, int to, Boolean highlight));
146 void SetColor P((char *colorName, Option *box));
147 //void ColorChanged P((Widget w, XtPointer data, XEvent *event, Boolean *b));
148 void SetInsertPos P((Option *opt, int pos));
149 void HardSetFocus P((Option *opt, DialogClass dlg));
150 void CursorAtEnd P((Option *opt));
151 void GetWidgetText  P((Option *opt, char **buf));
152 void SetWidgetText  P((Option *opt, char *buf, int n));
153 void GetWidgetState  P((Option *opt, int *state));
154 void SetWidgetState  P((Option *opt, int state));
155 void SetWidgetLabel P((Option *opt, char *buf));
156 void SetDialogTitle  P((DialogClass dlg, char *title));
157 void LoadListBox P((Option *opt, char *emptyText, int n1, int n2));
158 void HighlightListBoxItem P((Option *opt, int nr));
159 void HighlightWithScroll P((Option *opt, int sel, int max));
160 void ScrollToCursor P((Option *opt, int pos));
161 int  SelectedListBoxItem P((Option *opt));
162 void BoardFocus P((void));
163 void FocusOnWidget P((Option *opt, DialogClass dlg));
164 void UnCaret P((void));
165 void SetIconName P((DialogClass dlg, char *name));
166 int  ReadScroll P((Option *opt, float *top, float *bottom));
167 void SetScroll P((Option *opt, float f));
168 void AddHandler  P((Option *opt, DialogClass dlg, int nr));
169 void SendText P((int n));
170 void DisplayLogos P((Option *left, Option *right));
171 void Browse P((DialogClass dlg, char *label, char *proposed, char *ext,
172                        Boolean pathFlag, char *mode, char **name, FILE **fp));
173 void FileNamePopUpWrapper P((char *label, char *def, char *filter, FileProc proc,
174                   Boolean pathFlag, char *openMode, char **openName, FILE **openFP));
175
176 void InitDrawingParams P((int reload)); // in draw.c
177 void InitDrawingHandle P((Option *opt));
178 void ExposeRedraw P((Option *opt, int x, int y, int w, int h));
179 void DrawLogo P((Option *opt, void *logo));
180 void ErrorPopUp P((char *title, char *text, int modal));
181 int  ShiftKeys P((void));
182 void SetClockIcon P((int color));
183 void DelayedLoad P((void));
184 void DisplayTimerLabel P((Option *opt, char *color, long timer, int highlight));
185 void SetWindowTitle P((char *text, char *title, char *icon));
186 void SetupDropMenu P((void));
187 Option *BoardPopUp P((int squareSize, int lineGap, void *clockFontThingy));
188 void SlaveResize P((Option *opt));
189
190 int  SetCurrentComboSelection P((Option *opt));
191 void BoxAutoPopUp P((char *buf));
192 void ConsoleAutoPopUp P((char *buf));
193 void IcsKey P((int n));
194 void ICSInputBoxPopUp P((void));
195 void LoadOptionsPopUp P((DialogClass parent));
196 void GameListOptionsPopUp P((DialogClass parent));
197 void RefreshColor P((int source, int n));
198 void SendString P((char *p));
199
200 // in ngamelist.c
201 int GameListClicks P((int direction));
202 void SetFilter P((void));