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