cleaned up an old #ifdef in zippy
[xboard.git] / xengineoutput.c
1 /*
2  * Engine output (PV)
3  *
4  * Author: Alessandro Scotti (Dec 2005)
5  *
6  * Copyright 2005 Alessandro Scotti
7  *
8  * Enhancements Copyright 2009 Free Software Foundation, Inc.
9  *
10  * ------------------------------------------------------------------------
11  *
12  * GNU XBoard is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or (at
15  * your option) any later version.
16  *
17  * GNU XBoard is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  * General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see http://www.gnu.org/licenses/.
24  *
25  * ------------------------------------------------------------------------
26  ** See the file ChangeLog for a revision history.  */
27
28 #include "config.h"
29
30 #include <stdio.h>
31 #include <ctype.h>
32 #include <errno.h>
33 #include <sys/types.h>
34
35 #if STDC_HEADERS
36 # include <stdlib.h>
37 # include <string.h>
38 #else /* not STDC_HEADERS */
39 extern char *getenv();
40 # if HAVE_STRING_H
41 #  include <string.h>
42 # else /* not HAVE_STRING_H */
43 #  include <strings.h>
44 # endif /* not HAVE_STRING_H */
45 #endif /* not STDC_HEADERS */
46
47 #if HAVE_UNISTD_H
48 # include <unistd.h>
49 #endif
50
51 #include <X11/Intrinsic.h>
52 #include <X11/StringDefs.h>
53 #include <X11/Shell.h>
54 #include <X11/Xaw/Dialog.h>
55 #include <X11/Xaw/Form.h>
56 #include <X11/Xaw/List.h>
57 #include <X11/Xaw/Label.h>
58 #include <X11/Xaw/SimpleMenu.h>
59 #include <X11/Xaw/SmeBSB.h>
60 #include <X11/Xaw/SmeLine.h>
61 #include <X11/Xaw/Box.h>
62 #include <X11/Xaw/Paned.h>
63 #include <X11/Xaw/MenuButton.h>
64 #include <X11/cursorfont.h>
65 #include <X11/Xaw/Text.h>
66 #include <X11/Xaw/AsciiText.h>
67 #include <X11/Xaw/Viewport.h>
68
69 #include "common.h"
70 #include "frontend.h"
71 #include "backend.h"
72 #include "xboard.h"
73 // Add xengineo.h later
74 #include "gettext.h"
75
76 #ifdef ENABLE_NLS
77 # define  _(s) gettext (s)
78 # define N_(s) gettext_noop (s)
79 #else
80 # define  _(s) (s)
81 # define N_(s)  s
82 #endif
83
84 #include <X11/xpm.h>
85
86 // [HGM] pixmaps of some ICONS used in the engine-outut window
87 #include "pixmaps/WHITE_14.xpm"
88 #include "pixmaps/BLACK_14.xpm"
89 #include "pixmaps/CLEAR_14.xpm"
90 #include "pixmaps/UNKNOWN_14.xpm"
91 #include "pixmaps/THINKING_14.xpm"
92 #include "pixmaps/PONDER_14.xpm"
93 #include "pixmaps/ANALYZING_14.xpm"
94
95 #ifdef SNAP
96 #include "wsnap.h"
97 #endif
98
99 #define _LL_ 100
100
101 // imports from xboard.c
102 extern Widget formWidget, shellWidget, boardWidget, menuBarWidget;
103 extern Display *xDisplay;
104 extern Window xBoardWindow;
105 extern int squareSize;
106 extern Pixmap xMarkPixmap, wIconPixmap, bIconPixmap;
107 extern char *layoutName;
108
109 // temporary kludge to avoid compile errors untill all Windows code has been replaced
110 #define HICON int *
111 #define HWND  int *
112
113 // [HGM] define numbers to indicate icons, for referring to them in platform-independent way
114 #define nColorBlack   1
115 #define nColorWhite   2
116 #define nColorUnknown 3
117 #define nClear        4
118 #define nPondering    5
119 #define nThinking     6
120 #define nAnalyzing    7
121
122 Pixmap icons[8]; // [HGM] this front-end array translates back-end icon indicator to handle
123
124 // [HGM] same for output fields (note that there are two of each type, one per color)
125 #define nColorIcon 1
126 #define nStateIcon 2
127 #define nLabel     3
128 #define nStateData 4
129 #define nLabelNPS  5
130 #define nMemo      6
131
132 Widget outputField[2][7]; // [HGM] front-end array to translate output field to window handle
133
134 void EngineOutputPopDown();
135 void engineOutputPopUp(char *title, char *text);
136 int  EngineOutputIsUp();
137 static void SetEngineColorIcon( int which );
138
139 #define SHOW_PONDERING
140
141 /* Imports from backend.c */
142 char * SavePart(char *str);
143 extern int opponentKibitzes;
144
145 /* Imports from winboard.c */
146 //extern HWND engineOutputDialog;
147 extern Arg layoutArgs[2], formArgs[2], messageArgs[4];
148
149 //extern WindowPlacement wpEngineOutput;
150
151 Position engineOutputX = -1, engineOutputY = -1;
152 Dimension engineOutputW, engineOutputH;
153 Widget engineOutputShell;
154 int engineOutputDialogUp;
155
156 /* Module variables */
157 #define H_MARGIN            2
158 #define V_MARGIN            2
159 #define LABEL_V_DISTANCE    1   /* Distance between label and memo */
160 #define SPLITTER_SIZE       4   /* Distance between first memo and second label */
161
162 #define ICON_SIZE           14
163
164 #define STATE_UNKNOWN   -1
165 #define STATE_THINKING   0
166 #define STATE_IDLE       1
167 #define STATE_PONDERING  2
168 #define STATE_ANALYZING  3
169
170 static int  windowMode = 1;
171
172 static int  needInit = TRUE;
173
174 static int  lastDepth[2] = { -1, -1 };
175 static int  lastForwardMostMove[2] = { -1, -1 };
176 static int  engineState[2] = { -1, -1 };
177
178 typedef struct {
179     char * name;
180     int which;
181     int depth;
182     u64 nodes;
183     int score;
184     int time;
185     char * pv;
186     char * hint;
187     int an_move_index;
188     int an_move_count;
189 } EngineOutputData;
190
191 static void VerifyDisplayMode();
192 static void UpdateControls( EngineOutputData * ed );
193 static void SetEngineState( int which, int state, char * state_data );
194
195 void ReadIcon(char *pixData[], int iconNr)
196 {
197     int r;
198
199         if ((r=XpmCreatePixmapFromData(xDisplay, XtWindow(outputField[0][nColorIcon]),
200                                        pixData,
201                                        &(icons[iconNr]),
202                                        NULL, NULL /*&attr*/)) != 0) {
203           fprintf(stderr, _("Error %d loading icon image\n"), r);
204           exit(1); 
205         }       
206 }
207
208 static void InitializeEngineOutput()
209 { int i;
210
211         ReadIcon(WHITE_14,   nColorWhite);
212         ReadIcon(BLACK_14,   nColorBlack);
213         ReadIcon(UNKNOWN_14, nColorUnknown);
214
215         ReadIcon(CLEAR_14,   nClear);
216         ReadIcon(PONDER_14,  nPondering);
217         ReadIcon(THINK_14,   nThinking);
218         ReadIcon(ANALYZE_14, nAnalyzing);
219 }
220
221 void DoSetWindowText(int which, int field, char *s_label)
222
223         Arg arg;
224
225         XtSetArg(arg, XtNlabel, (XtArgVal) s_label);
226         XtSetValues(outputField[which][field], &arg, 1);
227 }
228
229 static void InsertIntoMemo( int which, char * text )
230 {
231         Arg arg; XawTextBlock t; Widget edit;
232
233         t.ptr = text; t.firstPos = 0; t.length = strlen(text); t.format = XawFmt8Bit;
234         edit = XtNameToWidget(engineOutputShell, which ? "*form2.text" : "*form.text");
235         XawTextReplace(edit, 0, 0, &t);
236 //      XtSetArg(arg, XtNstring, (XtArgVal) text);
237 //      XtSetValues(outputField[which][nMemo], &arg, 1);
238 }
239
240 static void SetIcon( int which, int field, int nIcon )
241 {
242     Arg arg;
243
244     if( nIcon != 0 ) {
245         XtSetArg(arg, XtNleftBitmap, (XtArgVal) icons[nIcon]);
246         XtSetValues(outputField[which][field], &arg, 1);
247     }
248 }
249
250 void DoClearMemo(int which)
251
252     Arg args[16];
253     int j;
254     Widget edit;
255
256         edit = XtNameToWidget(engineOutputShell, which ? "*form2.text" : "*form.text");
257         XtCallActionProc(edit, "select-all", NULL, NULL, 0);
258         XtCallActionProc(edit, "kill-selection", NULL, NULL, 0);
259 }
260
261 // The following routines are mutated clones of the commentPopUp routines
262
263 void PositionControlSet(which, form, bw_width)
264      int which;
265      Widget form;
266      Dimension bw_width;
267 {
268     Arg args[16];
269     Widget edit, NameWidget, ColorWidget, ModeWidget, MoveWidget, NodesWidget;
270     int j, mutable=1;
271     j = 0;
272     XtSetArg(args[j], XtNborderWidth, (XtArgVal) 0); j++;
273     XtSetArg(args[j], XtNlabel,     (XtArgVal) ""); j++;
274     XtSetArg(args[j], XtNtop,       XtChainTop); j++;
275     XtSetArg(args[j], XtNbottom,    XtChainTop); j++;
276     XtSetArg(args[j], XtNleft,      XtChainLeft); j++;
277     XtSetArg(args[j], XtNright,     XtChainLeft); j++;
278     XtSetArg(args[j], XtNheight,    (XtArgVal) 16); j++;
279     XtSetArg(args[j], XtNwidth,     (XtArgVal) 17); j++;
280     outputField[which][nColorIcon] = ColorWidget =
281       XtCreateManagedWidget("Color", labelWidgetClass,
282                      form, args, j);
283
284     j = 0;
285     XtSetArg(args[j], XtNborderWidth, (XtArgVal) 0); j++;
286     XtSetArg(args[j], XtNjustify,   (XtArgVal) XtJustifyLeft); j++;
287     XtSetArg(args[j], XtNfromHoriz, (XtArgVal) ColorWidget); j++;
288     XtSetArg(args[j], XtNtop,       XtChainTop); j++;
289     XtSetArg(args[j], XtNbottom,    XtChainTop); j++;
290     XtSetArg(args[j], XtNleft,      XtChainLeft); j++;
291     XtSetArg(args[j], XtNheight,    (XtArgVal) 16); j++;
292     XtSetArg(args[j], XtNwidth,     (XtArgVal) bw_width/2 - 57); j++;
293     outputField[which][nLabel] = NameWidget =
294       XtCreateManagedWidget("Engine", labelWidgetClass,
295                      form, args, j);
296
297     j = 0;
298     XtSetArg(args[j], XtNborderWidth, (XtArgVal) 0); j++;
299     XtSetArg(args[j], XtNlabel,     (XtArgVal) ""); j++;
300     XtSetArg(args[j], XtNfromHoriz, (XtArgVal) NameWidget); j++;
301     XtSetArg(args[j], XtNtop,       XtChainTop); j++;
302     XtSetArg(args[j], XtNbottom,    XtChainTop); j++;
303     XtSetArg(args[j], XtNheight,    (XtArgVal) 16); j++;
304     XtSetArg(args[j], XtNwidth,     (XtArgVal) 20); j++;
305     outputField[which][nStateIcon] = ModeWidget =
306       XtCreateManagedWidget("Mode", labelWidgetClass,
307                      form, args, j);
308
309     j = 0;
310     XtSetArg(args[j], XtNborderWidth, (XtArgVal) 0); j++;
311     XtSetArg(args[j], XtNjustify,   (XtArgVal) XtJustifyLeft); j++;
312     XtSetArg(args[j], XtNlabel,     (XtArgVal) ""); j++;
313     XtSetArg(args[j], XtNfromHoriz, (XtArgVal) ModeWidget); j++;
314     XtSetArg(args[j], XtNtop,       XtChainTop); j++;
315     XtSetArg(args[j], XtNbottom,    XtChainTop); j++;
316     XtSetArg(args[j], XtNright,     XtChainRight); j++;
317     XtSetArg(args[j], XtNheight,    (XtArgVal) 16); j++;
318     XtSetArg(args[j], XtNwidth,     (XtArgVal) bw_width/2 - 102); j++;
319     outputField[which][nStateData] = MoveWidget =
320       XtCreateManagedWidget("Move", labelWidgetClass,
321                      form, args, j);
322
323     j = 0;
324     XtSetArg(args[j], XtNborderWidth, (XtArgVal) 0); j++;
325     XtSetArg(args[j], XtNjustify,   (XtArgVal) XtJustifyRight); j++;
326     XtSetArg(args[j], XtNlabel,     (XtArgVal) _("NPS")); j++;
327     XtSetArg(args[j], XtNfromHoriz, (XtArgVal) MoveWidget); j++;
328     XtSetArg(args[j], XtNtop,       XtChainTop); j++;
329     XtSetArg(args[j], XtNbottom,    XtChainTop); j++;
330     XtSetArg(args[j], XtNleft,      XtChainRight); j++;
331     XtSetArg(args[j], XtNright,     XtChainRight); j++;
332     XtSetArg(args[j], XtNheight,    (XtArgVal) 16); j++;
333     XtSetArg(args[j], XtNwidth,     (XtArgVal) 100); j++;
334     outputField[which][nLabelNPS] = NodesWidget =
335       XtCreateManagedWidget("Nodes", labelWidgetClass,
336                      form, args, j);
337
338     // create "text" within "form"
339     j = 0;
340     if (mutable) {
341         XtSetArg(args[j], XtNeditType, XawtextEdit);  j++;
342         XtSetArg(args[j], XtNuseStringInPlace, False);  j++;
343     }
344     XtSetArg(args[j], XtNstring, "");  j++;
345     XtSetArg(args[j], XtNdisplayCaret, False);  j++;
346     XtSetArg(args[j], XtNtop, XtChainTop);  j++;
347     XtSetArg(args[j], XtNbottom, XtChainBottom);  j++;
348     XtSetArg(args[j], XtNleft, XtChainLeft);  j++;
349     XtSetArg(args[j], XtNright, XtChainRight);  j++;
350     XtSetArg(args[j], XtNresizable, True);  j++;
351     XtSetArg(args[j], XtNwidth, bw_width);  j++; /*force wider than buttons*/
352     /* !!Work around an apparent bug in XFree86 4.0.1 (X11R6.4.3) */
353     XtSetArg(args[j], XtNscrollVertical, XawtextScrollAlways);  j++;
354     XtSetArg(args[j], XtNscrollHorizontal, XawtextScrollWhenNeeded);  j++;
355 //    XtSetArg(args[j], XtNautoFill, True);  j++;
356 //    XtSetArg(args[j], XtNwrap, XawtextWrapWord); j++;
357     outputField[which][nMemo] = edit =
358       XtCreateManagedWidget("text", asciiTextWidgetClass, form, args, j);
359
360     j = 0;
361     XtSetArg(args[j], XtNfromVert, ColorWidget); j++;
362 //    XtSetArg(args[j], XtNresizable, (XtArgVal) True); j++;
363     XtSetValues(edit, args, j);
364 }
365
366 Widget EngineOutputCreate(name, text)
367      char *name, *text;
368 {
369     Arg args[16];
370     Widget shell, layout, form, form2, edit;
371     Dimension bw_width, bw_height;
372     int j;
373
374     // get board width
375     j = 0;
376     XtSetArg(args[j], XtNwidth,  &bw_width);  j++;
377     XtSetArg(args[j], XtNheight, &bw_height);  j++;
378     XtGetValues(boardWidget, args, j);
379
380     // define form within layout within shell.
381     j = 0;
382     XtSetArg(args[j], XtNresizable, True);  j++;
383     shell =
384       XtCreatePopupShell(name, transientShellWidgetClass,
385                          shellWidget, args, j);
386     layout =
387       XtCreateManagedWidget(layoutName, formWidgetClass, shell,
388                             layoutArgs, XtNumber(layoutArgs));
389     // divide window vertically into two equal parts, by creating two forms
390     form =
391       XtCreateManagedWidget("form", formWidgetClass, layout,
392                             formArgs, XtNumber(formArgs));
393     form2 =
394       XtCreateManagedWidget("form2", formWidgetClass, layout,
395                             formArgs, XtNumber(formArgs));
396     j = 0;
397     XtSetArg(args[j], XtNfromVert,  (XtArgVal) form); j++;
398     XtSetValues(form2, args, j);
399     // make sure width is known in advance, for better placement of child widgets
400     j = 0;
401     XtSetArg(args[j], XtNwidth,     (XtArgVal) bw_width-16); j++;
402     XtSetArg(args[j], XtNheight,    (XtArgVal) bw_height/2); j++;
403     XtSetValues(shell, args, j);
404
405     // fill up both forms with control elements
406     PositionControlSet(0, form,  bw_width);
407     PositionControlSet(1, form2, bw_width);
408
409     XtRealizeWidget(shell);
410
411     if (engineOutputX == -1) {
412         int xx, yy;
413         Window junk;
414         Dimension pw_height;
415         Dimension ew_height;
416         engineOutputH = bw_height/2;
417         engineOutputW = bw_width-16;
418
419         XSync(xDisplay, False);
420 #ifdef NOTDEF
421         /* This code seems to tickle an X bug if it is executed too soon
422            after xboard starts up.  The coordinates get transformed as if
423            the main window was positioned at (0, 0).
424            */
425         XtTranslateCoords(shellWidget,
426                           (bw_width - engineOutputW) / 2, 0 - engineOutputH / 2,
427                           &engineOutputX, &engineOutputY);
428 #else  /*!NOTDEF*/
429         XTranslateCoordinates(xDisplay, XtWindow(shellWidget),
430                               RootWindowOfScreen(XtScreen(shellWidget)),
431                               (bw_width - engineOutputW) / 2, 0 - engineOutputH / 2,
432                               &xx, &yy, &junk);
433         engineOutputX = xx;
434         engineOutputY = yy;
435 #endif /*!NOTDEF*/
436         if (engineOutputY < 0) engineOutputY = 0; /*avoid positioning top offscreen*/
437     }
438     j = 0;
439     XtSetArg(args[j], XtNheight, engineOutputH);  j++;
440     XtSetArg(args[j], XtNwidth, engineOutputW);  j++;
441     XtSetArg(args[j], XtNx, engineOutputX);  j++;
442     XtSetArg(args[j], XtNy, engineOutputY);  j++;
443     XtSetValues(shell, args, j);
444 //    XtSetKeyboardFocus(shell, edit);
445
446     return shell;
447 }
448
449 void ResizeWindowControls(shell, mode)
450         Widget shell;
451         int mode;
452 {
453     Widget form1, form2;
454     Arg args[16];
455     int j;
456     Dimension ew_height, tmp;
457
458     form1 = XtNameToWidget(shell, "*form");
459     form2 = XtNameToWidget(shell, "*form2");
460
461     j = 0;
462     XtSetArg(args[j], XtNheight, (XtArgVal) &ew_height); j++;
463     XtGetValues(form1, args, j);
464     j = 0;
465     XtSetArg(args[j], XtNheight, (XtArgVal) &tmp); j++;
466     XtGetValues(form2, args, j);
467     ew_height += tmp; // total height
468
469     if(mode==0) {
470         j = 0;
471         XtSetArg(args[j], XtNheight, (XtArgVal) 5); j++;
472         XtSetValues(form2, args, j);
473         j = 0;
474         XtSetArg(args[j], XtNheight, (XtArgVal) (ew_height-5)); j++;
475         XtSetValues(form1, args, j);
476     } else {
477         j = 0;
478         XtSetArg(args[j], XtNheight, (XtArgVal) (ew_height/2)); j++;
479         XtSetValues(form1, args, j);
480         j = 0;
481         XtSetArg(args[j], XtNheight, (XtArgVal) (ew_height/2)); j++;
482         XtSetValues(form2, args, j);
483     }
484 }
485
486 void EngineOutputPopUp(title, text)
487      char *title, *text;
488 {
489     Arg args[16];
490     int j;
491     Widget edit;
492
493     if (engineOutputShell == NULL) {
494         engineOutputShell =
495           EngineOutputCreate(title, text);
496         XtRealizeWidget(engineOutputShell);
497         CatchDeleteWindow(engineOutputShell, "EngineOutputPopDown");
498         if( needInit ) {
499             InitializeEngineOutput();
500             needInit = FALSE;
501         }
502         SetEngineColorIcon( 0 );
503         SetEngineColorIcon( 1 );
504         SetEngineState( 0, STATE_IDLE, "" );
505         SetEngineState( 1, STATE_IDLE, "" );
506     } else {
507         edit = XtNameToWidget(engineOutputShell, "*form.text");
508         j = 0;
509         XtSetArg(args[j], XtNstring, text); j++;
510         XtSetValues(edit, args, j);
511         j = 0;
512         XtSetArg(args[j], XtNiconName, (XtArgVal) title);   j++;
513         XtSetArg(args[j], XtNtitle, (XtArgVal) title);      j++;
514         XtSetValues(engineOutputShell, args, j);
515     }
516
517     XtPopup(engineOutputShell, XtGrabNone);
518     XSync(xDisplay, False);
519
520     j=0;
521     XtSetArg(args[j], XtNleftBitmap, xMarkPixmap); j++;
522     XtSetValues(XtNameToWidget(menuBarWidget, "menuMode.Show Engine Output"),
523                 args, j);
524
525     engineOutputDialogUp = True;
526     ShowThinkingEvent(); // [HGM] thinking: might need to prompt engine for thinking output
527 }
528
529 void EngineOutputPopDown()
530 {
531     Arg args[16];
532     int j;
533
534     if (!engineOutputDialogUp) return;
535     DoClearMemo(1);
536     j = 0;
537     XtSetArg(args[j], XtNx, &engineOutputX); j++;
538     XtSetArg(args[j], XtNy, &engineOutputY); j++;
539     XtSetArg(args[j], XtNwidth, &engineOutputW); j++;
540     XtSetArg(args[j], XtNheight, &engineOutputH); j++;
541     XtGetValues(engineOutputShell, args, j);
542     XtPopdown(engineOutputShell);
543     XSync(xDisplay, False);
544     j=0;
545     XtSetArg(args[j], XtNleftBitmap, None); j++;
546     XtSetValues(XtNameToWidget(menuBarWidget, "menuMode.Show Engine Output"),
547                 args, j);
548
549     engineOutputDialogUp = False;
550     ShowThinkingEvent(); // [HGM] thinking: might need to shut off thinking output
551 }
552
553 //------------------------ pure back-end routines -------------------------------
554
555
556 // back end, due to front-end wrapper for SetWindowText, and new SetIcon arguments
557 static void SetEngineState( int which, int state, char * state_data )
558 {
559     int x_which = 1 - which;
560
561     if( engineState[ which ] != state ) {
562         engineState[ which ] = state;
563
564         switch( state ) {
565         case STATE_THINKING:
566             SetIcon( which, nStateIcon, nThinking );
567             if( engineState[ x_which ] == STATE_THINKING ) {
568                 SetEngineState( x_which, STATE_IDLE, "" );
569             }
570             break;
571         case STATE_PONDERING:
572             SetIcon( which, nStateIcon, nPondering );
573             break;
574         case STATE_ANALYZING:
575             SetIcon( which, nStateIcon, nAnalyzing );
576             break;
577         default:
578             SetIcon( which, nStateIcon, nClear );
579             break;
580         }
581     }
582
583     if( state_data != 0 ) {
584         DoSetWindowText( which, nStateData, state_data );
585     }
586 }
587
588 // back end, now the front-end wrapper ClearMemo is used, and ed no longer contains handles.
589 void EngineOutputUpdate( FrontEndProgramStats * stats )
590 {
591     EngineOutputData ed;
592     int clearMemo = FALSE;
593     int which;
594     int depth;
595
596     if( stats == 0 ) {
597         SetEngineState( 0, STATE_IDLE, "" );
598         SetEngineState( 1, STATE_IDLE, "" );
599         return;
600     }
601
602     if(gameMode == IcsObserving && !appData.icsEngineAnalyze)
603         return; // [HGM] kibitz: shut up engine if we are observing an ICS game
604
605     which = stats->which;
606     depth = stats->depth;
607
608     if( which < 0 || which > 1 || depth < 0 || stats->time < 0 || stats->pv == 0 ) {
609         return;
610     }
611
612     if( engineOutputShell == NULL ) {
613         return;
614     }
615
616     VerifyDisplayMode();
617
618     ed.which = which;
619     ed.depth = depth;
620     ed.nodes = stats->nodes;
621     ed.score = stats->score;
622     ed.time = stats->time;
623     ed.pv = stats->pv;
624     ed.hint = stats->hint;
625     ed.an_move_index = stats->an_move_index;
626     ed.an_move_count = stats->an_move_count;
627
628     /* Get target control. [HGM] this is moved to front end, which get them from a table */
629     if( which == 0 ) {
630         ed.name = first.tidy;
631     }
632     else {
633         ed.name = second.tidy;
634     }
635
636     /* Clear memo if needed */
637     if( lastDepth[which] > depth || (lastDepth[which] == depth && depth <= 1) ) {
638         clearMemo = TRUE;
639     }
640
641     if( lastForwardMostMove[which] != forwardMostMove ) {
642         clearMemo = TRUE;
643     }
644
645     if( clearMemo ) DoClearMemo(which);
646
647     /* Update */
648     lastDepth[which] = depth == 1 && ed.nodes == 0 ? 0 : depth; // [HGM] info-line kudge
649     lastForwardMostMove[which] = forwardMostMove;
650
651     if( ed.pv != 0 && ed.pv[0] == ' ' ) {
652         if( strncmp( ed.pv, " no PV", 6 ) == 0 ) { /* Hack on hack! :-O */
653             ed.pv = "";
654         }
655     }
656
657     UpdateControls( &ed );
658 }
659
660 #define ENGINE_COLOR_WHITE      'w'
661 #define ENGINE_COLOR_BLACK      'b'
662 #define ENGINE_COLOR_UNKNOWN    ' '
663
664 // pure back end
665 char GetEngineColor( int which )
666 {
667     char result = ENGINE_COLOR_UNKNOWN;
668
669     if( which == 0 || which == 1 ) {
670         ChessProgramState * cps;
671
672         switch (gameMode) {
673         case MachinePlaysBlack:
674         case IcsPlayingBlack:
675             result = ENGINE_COLOR_BLACK;
676             break;
677         case MachinePlaysWhite:
678         case IcsPlayingWhite:
679             result = ENGINE_COLOR_WHITE;
680             break;
681         case AnalyzeMode:
682         case AnalyzeFile:
683             result = WhiteOnMove(forwardMostMove) ? ENGINE_COLOR_WHITE : ENGINE_COLOR_BLACK;
684             break;
685         case TwoMachinesPlay:
686             cps = (which == 0) ? &first : &second;
687             result = cps->twoMachinesColor[0];
688             result = result == 'w' ? ENGINE_COLOR_WHITE : ENGINE_COLOR_BLACK;
689             break;
690         }
691     }
692
693     return result;
694 }
695
696 // pure back end
697 char GetActiveEngineColor()
698 {
699     char result = ENGINE_COLOR_UNKNOWN;
700
701     if( gameMode == TwoMachinesPlay ) {
702         result = WhiteOnMove(forwardMostMove) ? ENGINE_COLOR_WHITE : ENGINE_COLOR_BLACK;
703     }
704
705     return result;
706 }
707
708 // pure back end
709 static int IsEnginePondering( int which )
710 {
711     int result = FALSE;
712
713     switch (gameMode) {
714     case MachinePlaysBlack:
715     case IcsPlayingBlack:
716         if( WhiteOnMove(forwardMostMove) ) result = TRUE;
717         break;
718     case MachinePlaysWhite:
719     case IcsPlayingWhite:
720         if( ! WhiteOnMove(forwardMostMove) ) result = TRUE;
721         break;
722     case TwoMachinesPlay:
723         if( GetActiveEngineColor() != ENGINE_COLOR_UNKNOWN ) {
724             if( GetEngineColor( which ) != GetActiveEngineColor() ) result = TRUE;
725         }
726         break;
727     }
728
729     return result;
730 }
731
732 // back end
733 static void SetDisplayMode( int mode )
734 {
735     if( windowMode != mode ) {
736         windowMode = mode;
737
738         ResizeWindowControls( engineOutputShell, mode );
739     }
740 }
741
742 // pure back end
743 void VerifyDisplayMode()
744 {
745     int mode;
746
747     /* Get proper mode for current game */
748     switch( gameMode ) {
749     case IcsObserving:    // [HGM] ICS analyze
750         if(!appData.icsEngineAnalyze) return;
751     case AnalyzeMode:
752     case AnalyzeFile:
753     case MachinePlaysWhite:
754     case MachinePlaysBlack:
755         mode = 0;
756         break;
757     case IcsPlayingWhite:
758     case IcsPlayingBlack:
759         mode = appData.zippyPlay && opponentKibitzes; // [HGM] kibitz
760         break;
761     case TwoMachinesPlay:
762         mode = 1;
763         break;
764     default:
765         /* Do not change */
766         return;
767     }
768
769     SetDisplayMode( mode );
770 }
771
772 // back end. Determine what icon to se in the color-icon field, and print it
773 static void SetEngineColorIcon( int which )
774 {
775     char color = GetEngineColor(which);
776     int nicon = 0;
777
778     if( color == ENGINE_COLOR_BLACK )
779         nicon = nColorBlack;
780     else if( color == ENGINE_COLOR_WHITE )
781         nicon = nColorWhite;
782     else
783         nicon = nColorUnknown;
784
785     SetIcon( which, nColorIcon, nicon );
786 }
787
788 #define MAX_NAME_LENGTH 32
789
790 // pure back end, now SetWindowText is called via wrapper DoSetWindowText
791 static void UpdateControls( EngineOutputData * ed )
792 {
793     int isPondering = FALSE;
794
795     char s_label[MAX_NAME_LENGTH + 32];
796     
797     char * name = ed->name;
798
799     /* Label */
800     if( name == 0 || *name == '\0' ) {
801         name = "?";
802     }
803
804     strncpy( s_label, name, MAX_NAME_LENGTH );
805     s_label[ MAX_NAME_LENGTH-1 ] = '\0';
806
807 #ifdef SHOW_PONDERING
808     if( IsEnginePondering( ed->which ) ) {
809         char buf[8];
810
811         buf[0] = '\0';
812
813         if( ed->hint != 0 && *ed->hint != '\0' ) {
814             strncpy( buf, ed->hint, sizeof(buf) );
815             buf[sizeof(buf)-1] = '\0';
816         }
817         else if( ed->pv != 0 && *ed->pv != '\0' ) {
818             char * sep = strchr( ed->pv, ' ' );
819             int buflen = sizeof(buf);
820
821             if( sep != NULL ) {
822                 buflen = sep - ed->pv + 1;
823                 if( buflen > sizeof(buf) ) buflen = sizeof(buf);
824             }
825
826             strncpy( buf, ed->pv, buflen );
827             buf[ buflen-1 ] = '\0';
828         }
829
830         SetEngineState( ed->which, STATE_PONDERING, buf );
831     }
832     else if( gameMode == TwoMachinesPlay ) {
833         SetEngineState( ed->which, STATE_THINKING, "" );
834     }
835     else if( gameMode == AnalyzeMode || gameMode == AnalyzeFile 
836           || gameMode == IcsObserving && appData.icsEngineAnalyze) { // [HGM] ICS-analyze
837         char buf[64];
838         int time_secs = ed->time / 100;
839         int time_mins = time_secs / 60;
840
841         buf[0] = '\0';
842
843         if( ed->an_move_index != 0 && ed->an_move_count != 0 && *ed->hint != '\0' ) {
844             char mov[16];
845
846             strncpy( mov, ed->hint, sizeof(mov) );
847             mov[ sizeof(mov)-1 ] = '\0';
848
849             sprintf( buf, "%d/%d: %s [%02d:%02d:%02d]", ed->an_move_index, ed->an_move_count, mov, time_mins / 60, time_mins % 60, time_secs % 60 );
850         }
851
852         SetEngineState( ed->which, STATE_ANALYZING, buf );
853     }
854     else {
855         SetEngineState( ed->which, STATE_IDLE, "" );
856     }
857 #endif
858
859     DoSetWindowText( ed->which, nLabel, s_label );
860
861     s_label[0] = '\0';
862
863     if( ed->time > 0 && ed->nodes > 0 ) {
864         unsigned long nps_100 = ed->nodes / ed->time;
865
866         if( nps_100 < 100000 ) {
867             sprintf( s_label, _("NPS: %lu"), nps_100 * 100 );
868         }
869         else {
870             sprintf( s_label, _("NPS: %.1fk"), nps_100 / 10.0 );
871         }
872     }
873
874     DoSetWindowText( ed->which, nLabelNPS, s_label );
875
876     /* Memo */
877     if( ed->pv != 0 && *ed->pv != '\0' ) {
878         char s_nodes[24];
879         char s_score[16];
880         char s_time[24];
881         char buf[256];
882         int buflen;
883         int time_secs = ed->time / 100;
884         int time_cent = ed->time % 100;
885
886         /* Nodes */
887         if( ed->nodes < 1000000 ) {
888             sprintf( s_nodes, u64Display, ed->nodes );
889         }
890         else {
891             sprintf( s_nodes, "%.1fM", u64ToDouble(ed->nodes) / 1000000.0 );
892         }
893
894         /* Score */
895         if( ed->score > 0 ) {
896             sprintf( s_score, "+%.2f", ed->score / 100.0 );
897         } else
898             sprintf( s_score, "%.2f", ed->score / 100.0 );
899
900         /* Time */
901         sprintf( s_time, "%d:%02d.%02d", time_secs / 60, time_secs % 60, time_cent );
902
903         /* Put all together... */
904         if(ed->nodes == 0 && ed->score == 0 && ed->time == 0) sprintf( buf, "%3d\t", ed->depth ); else 
905         sprintf( buf, "%3d  %s  %s\t%s\t", ed->depth, s_score, s_nodes, s_time );
906
907         /* Add PV */
908         buflen = strlen(buf);
909
910         strncpy( buf + buflen, ed->pv, sizeof(buf) - buflen );
911
912         buf[ sizeof(buf) - 3 ] = '\0';
913
914         strcat( buf + buflen, "\n" );
915
916         /* Update memo */
917         InsertIntoMemo( ed->which, buf );
918     }
919
920     /* Colors */
921     SetEngineColorIcon( ed->which );
922 }
923
924 // back end
925 int EngineOutputIsUp()
926 {
927     return engineOutputDialogUp;
928 }
929
930 void
931 EngineOutputProc(w, event, prms, nprms)
932      Widget w;
933      XEvent *event;
934      String *prms;
935      Cardinal *nprms;
936 {
937   if (engineOutputDialogUp) {
938     EngineOutputPopDown();
939   } else {
940     EngineOutputPopUp(_("engine output"),_("This feature is experimental"));
941   }
942 //  ToNrEvent(currentMove);
943 }
944
945 // [HGM] kibitz: write kibitz line; split window for it if necessary
946 void OutputKibitz(int window, char *text)
947 {
948         if(!EngineOutputIsUp()) return;
949         if(!opponentKibitzes) { // on first kibitz of game, clear memos
950             DoClearMemo(1);
951             if(gameMode == IcsObserving) DoClearMemo(0);
952         }
953         opponentKibitzes = TRUE; // this causes split window DisplayMode in ICS modes.
954         VerifyDisplayMode();
955         if(gameMode == IcsObserving) {
956             DoSetWindowText(0, nLabel, gameInfo.white);
957             SetIcon( 0, nColorIcon,  nColorWhite);
958             SetIcon( 0, nStateIcon,  nClear);
959         }
960         DoSetWindowText(1, nLabel, gameMode == IcsPlayingBlack ? gameInfo.white : gameInfo.black); // opponent name
961         SetIcon( 1, nColorIcon,  gameMode == IcsPlayingBlack ? nColorWhite : nColorBlack);
962         SetIcon( 1, nStateIcon,  nClear);
963         InsertIntoMemo(window-1, text);
964 }