partly fix for bug #27715: scaling of menu bar
[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();
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 
487 EngineOutputPopUp()
488 {
489     Arg args[16];
490     int j;
491     Widget edit;
492     static char *title = _("Engine output"), *text = _("This feature is experimental");
493
494     if (engineOutputShell == NULL) {
495         engineOutputShell =
496           EngineOutputCreate(title, text);
497         XtRealizeWidget(engineOutputShell);
498         CatchDeleteWindow(engineOutputShell, "EngineOutputPopDown");
499         if( needInit ) {
500             InitializeEngineOutput();
501             needInit = FALSE;
502         }
503         SetEngineColorIcon( 0 );
504         SetEngineColorIcon( 1 );
505         SetEngineState( 0, STATE_IDLE, "" );
506         SetEngineState( 1, STATE_IDLE, "" );
507     } else {
508         edit = XtNameToWidget(engineOutputShell, "*form.text");
509         j = 0;
510         XtSetArg(args[j], XtNstring, text); j++;
511         XtSetValues(edit, args, j);
512         j = 0;
513         XtSetArg(args[j], XtNiconName, (XtArgVal) title);   j++;
514         XtSetArg(args[j], XtNtitle, (XtArgVal) title);      j++;
515         XtSetValues(engineOutputShell, args, j);
516     }
517
518     XtPopup(engineOutputShell, XtGrabNone);
519     XSync(xDisplay, False);
520
521     j=0;
522     XtSetArg(args[j], XtNleftBitmap, xMarkPixmap); j++;
523     XtSetValues(XtNameToWidget(menuBarWidget, "menuMode.Show Engine Output"),
524                 args, j);
525
526     engineOutputDialogUp = True;
527     ShowThinkingEvent(); // [HGM] thinking: might need to prompt engine for thinking output
528 }
529
530 void EngineOutputPopDown()
531 {
532     Arg args[16];
533     int j;
534
535     if (!engineOutputDialogUp) return;
536     DoClearMemo(1);
537     j = 0;
538     XtSetArg(args[j], XtNx, &engineOutputX); j++;
539     XtSetArg(args[j], XtNy, &engineOutputY); j++;
540     XtSetArg(args[j], XtNwidth, &engineOutputW); j++;
541     XtSetArg(args[j], XtNheight, &engineOutputH); j++;
542     XtGetValues(engineOutputShell, args, j);
543     XtPopdown(engineOutputShell);
544     XSync(xDisplay, False);
545     j=0;
546     XtSetArg(args[j], XtNleftBitmap, None); j++;
547     XtSetValues(XtNameToWidget(menuBarWidget, "menuMode.Show Engine Output"),
548                 args, j);
549
550     engineOutputDialogUp = False;
551     ShowThinkingEvent(); // [HGM] thinking: might need to shut off thinking output
552 }
553
554 //------------------------ pure back-end routines -------------------------------
555
556
557 // back end, due to front-end wrapper for SetWindowText, and new SetIcon arguments
558 static void SetEngineState( int which, int state, char * state_data )
559 {
560     int x_which = 1 - which;
561
562     if( engineState[ which ] != state ) {
563         engineState[ which ] = state;
564
565         switch( state ) {
566         case STATE_THINKING:
567             SetIcon( which, nStateIcon, nThinking );
568             if( engineState[ x_which ] == STATE_THINKING ) {
569                 SetEngineState( x_which, STATE_IDLE, "" );
570             }
571             break;
572         case STATE_PONDERING:
573             SetIcon( which, nStateIcon, nPondering );
574             break;
575         case STATE_ANALYZING:
576             SetIcon( which, nStateIcon, nAnalyzing );
577             break;
578         default:
579             SetIcon( which, nStateIcon, nClear );
580             break;
581         }
582     }
583
584     if( state_data != 0 ) {
585         DoSetWindowText( which, nStateData, state_data );
586     }
587 }
588
589 // back end, now the front-end wrapper ClearMemo is used, and ed no longer contains handles.
590 void EngineOutputUpdate( FrontEndProgramStats * stats )
591 {
592     EngineOutputData ed;
593     int clearMemo = FALSE;
594     int which;
595     int depth;
596
597     if( stats == 0 ) {
598         SetEngineState( 0, STATE_IDLE, "" );
599         SetEngineState( 1, STATE_IDLE, "" );
600         return;
601     }
602
603     if(gameMode == IcsObserving && !appData.icsEngineAnalyze)
604         return; // [HGM] kibitz: shut up engine if we are observing an ICS game
605
606     which = stats->which;
607     depth = stats->depth;
608
609     if( which < 0 || which > 1 || depth < 0 || stats->time < 0 || stats->pv == 0 ) {
610         return;
611     }
612
613     if( engineOutputShell == NULL ) {
614         return;
615     }
616
617     VerifyDisplayMode();
618
619     ed.which = which;
620     ed.depth = depth;
621     ed.nodes = stats->nodes;
622     ed.score = stats->score;
623     ed.time = stats->time;
624     ed.pv = stats->pv;
625     ed.hint = stats->hint;
626     ed.an_move_index = stats->an_move_index;
627     ed.an_move_count = stats->an_move_count;
628
629     /* Get target control. [HGM] this is moved to front end, which get them from a table */
630     if( which == 0 ) {
631         ed.name = first.tidy;
632     }
633     else {
634         ed.name = second.tidy;
635     }
636
637     /* Clear memo if needed */
638     if( lastDepth[which] > depth || (lastDepth[which] == depth && depth <= 1) ) {
639         clearMemo = TRUE;
640     }
641
642     if( lastForwardMostMove[which] != forwardMostMove ) {
643         clearMemo = TRUE;
644     }
645
646     if( clearMemo ) DoClearMemo(which);
647
648     /* Update */
649     lastDepth[which] = depth == 1 && ed.nodes == 0 ? 0 : depth; // [HGM] info-line kudge
650     lastForwardMostMove[which] = forwardMostMove;
651
652     if( ed.pv != 0 && ed.pv[0] == ' ' ) {
653         if( strncmp( ed.pv, " no PV", 6 ) == 0 ) { /* Hack on hack! :-O */
654             ed.pv = "";
655         }
656     }
657
658     UpdateControls( &ed );
659 }
660
661 #define ENGINE_COLOR_WHITE      'w'
662 #define ENGINE_COLOR_BLACK      'b'
663 #define ENGINE_COLOR_UNKNOWN    ' '
664
665 // pure back end
666 char GetEngineColor( int which )
667 {
668     char result = ENGINE_COLOR_UNKNOWN;
669
670     if( which == 0 || which == 1 ) {
671         ChessProgramState * cps;
672
673         switch (gameMode) {
674         case MachinePlaysBlack:
675         case IcsPlayingBlack:
676             result = ENGINE_COLOR_BLACK;
677             break;
678         case MachinePlaysWhite:
679         case IcsPlayingWhite:
680             result = ENGINE_COLOR_WHITE;
681             break;
682         case AnalyzeMode:
683         case AnalyzeFile:
684             result = WhiteOnMove(forwardMostMove) ? ENGINE_COLOR_WHITE : ENGINE_COLOR_BLACK;
685             break;
686         case TwoMachinesPlay:
687             cps = (which == 0) ? &first : &second;
688             result = cps->twoMachinesColor[0];
689             result = result == 'w' ? ENGINE_COLOR_WHITE : ENGINE_COLOR_BLACK;
690             break;
691         }
692     }
693
694     return result;
695 }
696
697 // pure back end
698 char GetActiveEngineColor()
699 {
700     char result = ENGINE_COLOR_UNKNOWN;
701
702     if( gameMode == TwoMachinesPlay ) {
703         result = WhiteOnMove(forwardMostMove) ? ENGINE_COLOR_WHITE : ENGINE_COLOR_BLACK;
704     }
705
706     return result;
707 }
708
709 // pure back end
710 static int IsEnginePondering( int which )
711 {
712     int result = FALSE;
713
714     switch (gameMode) {
715     case MachinePlaysBlack:
716     case IcsPlayingBlack:
717         if( WhiteOnMove(forwardMostMove) ) result = TRUE;
718         break;
719     case MachinePlaysWhite:
720     case IcsPlayingWhite:
721         if( ! WhiteOnMove(forwardMostMove) ) result = TRUE;
722         break;
723     case TwoMachinesPlay:
724         if( GetActiveEngineColor() != ENGINE_COLOR_UNKNOWN ) {
725             if( GetEngineColor( which ) != GetActiveEngineColor() ) result = TRUE;
726         }
727         break;
728     }
729
730     return result;
731 }
732
733 // back end
734 static void SetDisplayMode( int mode )
735 {
736     if( windowMode != mode ) {
737         windowMode = mode;
738
739         ResizeWindowControls( engineOutputShell, mode );
740     }
741 }
742
743 // pure back end
744 void VerifyDisplayMode()
745 {
746     int mode;
747
748     /* Get proper mode for current game */
749     switch( gameMode ) {
750     case IcsObserving:    // [HGM] ICS analyze
751         if(!appData.icsEngineAnalyze) return;
752     case AnalyzeMode:
753     case AnalyzeFile:
754     case MachinePlaysWhite:
755     case MachinePlaysBlack:
756         mode = 0;
757         break;
758     case IcsPlayingWhite:
759     case IcsPlayingBlack:
760         mode = appData.zippyPlay && opponentKibitzes; // [HGM] kibitz
761         break;
762     case TwoMachinesPlay:
763         mode = 1;
764         break;
765     default:
766         /* Do not change */
767         return;
768     }
769
770     SetDisplayMode( mode );
771 }
772
773 // back end. Determine what icon to se in the color-icon field, and print it
774 static void SetEngineColorIcon( int which )
775 {
776     char color = GetEngineColor(which);
777     int nicon = 0;
778
779     if( color == ENGINE_COLOR_BLACK )
780         nicon = nColorBlack;
781     else if( color == ENGINE_COLOR_WHITE )
782         nicon = nColorWhite;
783     else
784         nicon = nColorUnknown;
785
786     SetIcon( which, nColorIcon, nicon );
787 }
788
789 #define MAX_NAME_LENGTH 32
790
791 // pure back end, now SetWindowText is called via wrapper DoSetWindowText
792 static void UpdateControls( EngineOutputData * ed )
793 {
794     int isPondering = FALSE;
795
796     char s_label[MAX_NAME_LENGTH + 32];
797     
798     char * name = ed->name;
799
800     /* Label */
801     if( name == 0 || *name == '\0' ) {
802         name = "?";
803     }
804
805     strncpy( s_label, name, MAX_NAME_LENGTH );
806     s_label[ MAX_NAME_LENGTH-1 ] = '\0';
807
808 #ifdef SHOW_PONDERING
809     if( IsEnginePondering( ed->which ) ) {
810         char buf[8];
811
812         buf[0] = '\0';
813
814         if( ed->hint != 0 && *ed->hint != '\0' ) {
815             strncpy( buf, ed->hint, sizeof(buf) );
816             buf[sizeof(buf)-1] = '\0';
817         }
818         else if( ed->pv != 0 && *ed->pv != '\0' ) {
819             char * sep = strchr( ed->pv, ' ' );
820             int buflen = sizeof(buf);
821
822             if( sep != NULL ) {
823                 buflen = sep - ed->pv + 1;
824                 if( buflen > sizeof(buf) ) buflen = sizeof(buf);
825             }
826
827             strncpy( buf, ed->pv, buflen );
828             buf[ buflen-1 ] = '\0';
829         }
830
831         SetEngineState( ed->which, STATE_PONDERING, buf );
832     }
833     else if( gameMode == TwoMachinesPlay ) {
834         SetEngineState( ed->which, STATE_THINKING, "" );
835     }
836     else if( gameMode == AnalyzeMode || gameMode == AnalyzeFile 
837           || gameMode == IcsObserving && appData.icsEngineAnalyze) { // [HGM] ICS-analyze
838         char buf[64];
839         int time_secs = ed->time / 100;
840         int time_mins = time_secs / 60;
841
842         buf[0] = '\0';
843
844         if( ed->an_move_index != 0 && ed->an_move_count != 0 && *ed->hint != '\0' ) {
845             char mov[16];
846
847             strncpy( mov, ed->hint, sizeof(mov) );
848             mov[ sizeof(mov)-1 ] = '\0';
849
850             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 );
851         }
852
853         SetEngineState( ed->which, STATE_ANALYZING, buf );
854     }
855     else {
856         SetEngineState( ed->which, STATE_IDLE, "" );
857     }
858 #endif
859
860     DoSetWindowText( ed->which, nLabel, s_label );
861
862     s_label[0] = '\0';
863
864     if( ed->time > 0 && ed->nodes > 0 ) {
865         unsigned long nps_100 = ed->nodes / ed->time;
866
867         if( nps_100 < 100000 ) {
868             sprintf( s_label, _("NPS: %lu"), nps_100 * 100 );
869         }
870         else {
871             sprintf( s_label, _("NPS: %.1fk"), nps_100 / 10.0 );
872         }
873     }
874
875     DoSetWindowText( ed->which, nLabelNPS, s_label );
876
877     /* Memo */
878     if( ed->pv != 0 && *ed->pv != '\0' ) {
879         char s_nodes[24];
880         char s_score[16];
881         char s_time[24];
882         char buf[256];
883         int buflen;
884         int time_secs = ed->time / 100;
885         int time_cent = ed->time % 100;
886
887         /* Nodes */
888         if( ed->nodes < 1000000 ) {
889             sprintf( s_nodes, u64Display, ed->nodes );
890         }
891         else {
892             sprintf( s_nodes, "%.1fM", u64ToDouble(ed->nodes) / 1000000.0 );
893         }
894
895         /* Score */
896         if( ed->score > 0 ) {
897             sprintf( s_score, "+%.2f", ed->score / 100.0 );
898         } else
899             sprintf( s_score, "%.2f", ed->score / 100.0 );
900
901         /* Time */
902         sprintf( s_time, "%d:%02d.%02d", time_secs / 60, time_secs % 60, time_cent );
903
904         /* Put all together... */
905         if(ed->nodes == 0 && ed->score == 0 && ed->time == 0) sprintf( buf, "%3d\t", ed->depth ); else 
906         sprintf( buf, "%3d  %s  %s\t%s\t", ed->depth, s_score, s_nodes, s_time );
907
908         /* Add PV */
909         buflen = strlen(buf);
910
911         strncpy( buf + buflen, ed->pv, sizeof(buf) - buflen );
912
913         buf[ sizeof(buf) - 3 ] = '\0';
914
915         strcat( buf + buflen, "\n" );
916
917         /* Update memo */
918         InsertIntoMemo( ed->which, buf );
919     }
920
921     /* Colors */
922     SetEngineColorIcon( ed->which );
923 }
924
925 // back end
926 int EngineOutputIsUp()
927 {
928     return engineOutputDialogUp;
929 }
930
931 void
932 EngineOutputProc(w, event, prms, nprms)
933      Widget w;
934      XEvent *event;
935      String *prms;
936      Cardinal *nprms;
937 {
938   if (engineOutputDialogUp) {
939     EngineOutputPopDown();
940   } else {
941     EngineOutputPopUp();
942   }
943 //  ToNrEvent(currentMove);
944 }
945
946 // [HGM] kibitz: write kibitz line; split window for it if necessary
947 void OutputKibitz(int window, char *text)
948 {
949         if(!EngineOutputIsUp()) return;
950         if(!opponentKibitzes) { // on first kibitz of game, clear memos
951             DoClearMemo(1);
952             if(gameMode == IcsObserving) DoClearMemo(0);
953         }
954         opponentKibitzes = TRUE; // this causes split window DisplayMode in ICS modes.
955         VerifyDisplayMode();
956         if(gameMode == IcsObserving) {
957             DoSetWindowText(0, nLabel, gameInfo.white);
958             SetIcon( 0, nColorIcon,  nColorWhite);
959             SetIcon( 0, nStateIcon,  nClear);
960         }
961         DoSetWindowText(1, nLabel, gameMode == IcsPlayingBlack ? gameInfo.white : gameInfo.black); // opponent name
962         SetIcon( 1, nColorIcon,  gameMode == IcsPlayingBlack ? nColorWhite : nColorBlack);
963         SetIcon( 1, nStateIcon,  nClear);
964         InsertIntoMemo(window-1, text);
965 }