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