Changes needed to compile master branch.
[xboard.git] / winboard / wengineoutput.c
diff --git a/winboard/wengineoutput.c b/winboard/wengineoutput.c
new file mode 100644 (file)
index 0000000..bb51525
--- /dev/null
@@ -0,0 +1,384 @@
+/*\r
+ * wengineoutput.c - split-off front-end of Engine output (PV) by HGM\r
+ *\r
+ * Author: Alessandro Scotti (Dec 2005)\r
+ *\r
+ * Copyright 2005 Alessandro Scotti\r
+ *\r
+ * ------------------------------------------------------------------------\r
+ *\r
+ * GNU XBoard is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or (at\r
+ * your option) any later version.\r
+ *\r
+ * GNU XBoard is distributed in the hope that it will be useful, but\r
+ * WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
+ * General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program. If not, see http://www.gnu.org/licenses/.  *\r
+ *\r
+ *------------------------------------------------------------------------\r
+ ** See the file ChangeLog for a revision history.  */\r
+\r
+#include "config.h"\r
+\r
+#include <windows.h> /* required for all Windows applications */\r
+#include <richedit.h>\r
+#include <stdio.h>\r
+#include <stdlib.h>\r
+#include <malloc.h>\r
+#include <commdlg.h>\r
+#include <dlgs.h>\r
+\r
+#include "common.h"\r
+#include "frontend.h"\r
+#include "backend.h"\r
+#include "winboard.h"\r
+\r
+#include "wsnap.h"\r
+#include "engineoutput.h"\r
+\r
+/* Module variables */\r
+int  windowMode = 1;\r
+static BOOLEAN engineOutputDialogUp = FALSE;\r
+HICON icons[8]; // [HGM] this front-end array translates back-end icon indicator to handle\r
+HWND outputField[2][7]; // [HGM] front-end array to translate output field to window handle\r
+\r
+// front end\r
+static HICON LoadIconEx( int id )\r
+{\r
+    return LoadImage( hInst, MAKEINTRESOURCE(id), IMAGE_ICON, ICON_SIZE, ICON_SIZE, 0 );\r
+}\r
+\r
+// [HGM] the platform-dependent way of indicating where output should go is now all\r
+// concentrated here, where a table of platform-dependent handles are initialized.\r
+// This cleanses most other routines of front-end stuff, so they can go into the back end.\r
+static void InitializeEngineOutput()\r
+{\r
+       // [HGM] made this into a table, rather than separate global variables\r
+        icons[nColorBlack]   = LoadIconEx( IDI_BLACK_14 );\r
+        icons[nColorWhite]   = LoadIconEx( IDI_WHITE_14 );\r
+        icons[nColorUnknown] = LoadIconEx( IDI_UNKNOWN_14 );\r
+        icons[nClear]        = LoadIconEx( IDI_TRANS_14 );\r
+        icons[nPondering]    = LoadIconEx( IDI_PONDER_14 );\r
+        icons[nThinking]     = LoadIconEx( IDI_CLOCK_14 );\r
+        icons[nAnalyzing]    = LoadIconEx( IDI_ANALYZE2_14 );\r
+\r
+       // [HGM] also make a table of handles to output controls\r
+       // Note that engineOutputDialog must be defined first!\r
+        outputField[0][nColorIcon] = GetDlgItem( engineOutputDialog, IDC_Color1 );\r
+        outputField[0][nLabel]     = GetDlgItem( engineOutputDialog, IDC_EngineLabel1 );\r
+        outputField[0][nStateIcon] = GetDlgItem( engineOutputDialog, IDC_StateIcon1 );\r
+        outputField[0][nStateData] = GetDlgItem( engineOutputDialog, IDC_StateData1 );\r
+        outputField[0][nLabelNPS]  = GetDlgItem( engineOutputDialog, IDC_Engine1_NPS );\r
+        outputField[0][nMemo]      = GetDlgItem( engineOutputDialog, IDC_EngineMemo1 );\r
+\r
+        outputField[1][nColorIcon] = GetDlgItem( engineOutputDialog, IDC_Color2 );\r
+        outputField[1][nLabel]     = GetDlgItem( engineOutputDialog, IDC_EngineLabel2 );\r
+        outputField[1][nStateIcon] = GetDlgItem( engineOutputDialog, IDC_StateIcon2 );\r
+        outputField[1][nStateData] = GetDlgItem( engineOutputDialog, IDC_StateData2 );\r
+        outputField[1][nLabelNPS]  = GetDlgItem( engineOutputDialog, IDC_Engine2_NPS );\r
+        outputField[1][nMemo]      = GetDlgItem( engineOutputDialog, IDC_EngineMemo2 );\r
+}\r
+\r
+// front end\r
+static void SetControlPos( HWND hDlg, int id, int x, int y, int width, int height )\r
+{\r
+    HWND hControl = GetDlgItem( hDlg, id );\r
+\r
+    SetWindowPos( hControl, HWND_TOP, x, y, width, height, SWP_NOZORDER );\r
+}\r
+\r
+#define HIDDEN_X    20000\r
+#define HIDDEN_Y    20000\r
+\r
+// front end\r
+static void HideControl( HWND hDlg, int id )\r
+{\r
+    HWND hControl = GetDlgItem( hDlg, id );\r
+    RECT rc;\r
+\r
+    GetWindowRect( hControl, &rc );\r
+\r
+    /* \r
+        Avoid hiding an already hidden control, because that causes many\r
+        unnecessary WM_ERASEBKGND messages!\r
+    */\r
+    if( rc.left != HIDDEN_X || rc.top != HIDDEN_Y ) {\r
+        SetControlPos( hDlg, id, 20000, 20000, 100, 100 );\r
+    }\r
+}\r
+\r
+// front end, although we might make GetWindowRect front end instead\r
+static int GetControlWidth( HWND hDlg, int id )\r
+{\r
+    RECT rc;\r
+\r
+    GetWindowRect( GetDlgItem( hDlg, id ), &rc );\r
+\r
+    return rc.right - rc.left;\r
+}\r
+\r
+// front end?\r
+static int GetControlHeight( HWND hDlg, int id )\r
+{\r
+    RECT rc;\r
+\r
+    GetWindowRect( GetDlgItem( hDlg, id ), &rc );\r
+\r
+    return rc.bottom - rc.top;\r
+}\r
+\r
+static int GetHeaderHeight()\r
+{\r
+    int result = GetControlHeight( engineOutputDialog, IDC_EngineLabel1 );\r
+\r
+    if( result < ICON_SIZE ) result = ICON_SIZE;\r
+\r
+    return result;\r
+}\r
+\r
+// The size calculations should be backend? If setControlPos is a platform-dependent way of doing things,\r
+// a platform-independent wrapper for it should be supplied.\r
+static void PositionControlSet( HWND hDlg, int x, int y, int clientWidth, int memoHeight, int idColor, int idEngineLabel, int idNPS, int idMemo, int idStateIcon, int idStateData )\r
+{\r
+    int label_x = x + ICON_SIZE + H_MARGIN;\r
+    int label_h = GetControlHeight( hDlg, IDC_EngineLabel1 );\r
+    int label_y = y + ICON_SIZE - label_h;\r
+    int nps_w = GetControlWidth( hDlg, IDC_Engine1_NPS );\r
+    int nps_x = clientWidth - H_MARGIN - nps_w;\r
+    int state_data_w = GetControlWidth( hDlg, IDC_StateData1 );\r
+    int state_data_x = nps_x - H_MARGIN - state_data_w;\r
+    int state_icon_x = state_data_x - ICON_SIZE - 2;\r
+    int max_w = clientWidth - 2*H_MARGIN;\r
+    int memo_y = y + ICON_SIZE + LABEL_V_DISTANCE;\r
+\r
+    SetControlPos( hDlg, idColor, x, y, ICON_SIZE, ICON_SIZE );\r
+    SetControlPos( hDlg, idEngineLabel, label_x, label_y, state_icon_x - label_x, label_h );\r
+    SetControlPos( hDlg, idStateIcon, state_icon_x, y, ICON_SIZE, ICON_SIZE );\r
+    SetControlPos( hDlg, idStateData, state_data_x, label_y, state_data_w, label_h );\r
+    SetControlPos( hDlg, idNPS, nps_x, label_y, nps_w, label_h );\r
+    SetControlPos( hDlg, idMemo, x, memo_y, max_w, memoHeight );\r
+}\r
+\r
+// Also here some of the size calculations should go to the back end, and their actual application to a front-end routine\r
+void ResizeWindowControls( int mode )\r
+{\r
+    HWND hDlg = engineOutputDialog; // [HGM] used to be parameter, but routine is called from back-end\r
+    RECT rc;\r
+    int headerHeight = GetHeaderHeight();\r
+//    int labelHeight = GetControlHeight( hDlg, IDC_EngineLabel1 );\r
+//    int labelOffset = H_MARGIN + ICON_SIZE + H_MARGIN;\r
+//    int labelDeltaY = ICON_SIZE - labelHeight;\r
+    int clientWidth;\r
+    int clientHeight;\r
+    int maxControlWidth;\r
+    int npsWidth;\r
+\r
+    /* Initialize variables */\r
+    GetClientRect( hDlg, &rc );\r
+\r
+    clientWidth = rc.right - rc.left;\r
+    clientHeight = rc.bottom - rc.top;\r
+\r
+    maxControlWidth = clientWidth - 2*H_MARGIN;\r
+\r
+    npsWidth = GetControlWidth( hDlg, IDC_Engine1_NPS );\r
+\r
+    /* Resize controls */\r
+    if( mode == 0 ) {\r
+        /* One engine */\r
+        PositionControlSet( hDlg, H_MARGIN, V_MARGIN, \r
+            clientWidth, \r
+            clientHeight - V_MARGIN - LABEL_V_DISTANCE - headerHeight- V_MARGIN,\r
+            IDC_Color1, IDC_EngineLabel1, IDC_Engine1_NPS, IDC_EngineMemo1, IDC_StateIcon1, IDC_StateData1 );\r
+\r
+        /* Hide controls for the second engine */\r
+        HideControl( hDlg, IDC_Color2 );\r
+        HideControl( hDlg, IDC_EngineLabel2 );\r
+        HideControl( hDlg, IDC_StateIcon2 );\r
+        HideControl( hDlg, IDC_StateData2 );\r
+        HideControl( hDlg, IDC_Engine2_NPS );\r
+        HideControl( hDlg, IDC_EngineMemo2 );\r
+        SendDlgItemMessage( hDlg, IDC_EngineMemo2, WM_SETTEXT, 0, (LPARAM) "" );\r
+        /* TODO: we should also hide/disable them!!! what about tab stops?!?! */\r
+    }\r
+    else {\r
+        /* Two engines */\r
+        int memo_h = (clientHeight - headerHeight*2 - V_MARGIN*2 - LABEL_V_DISTANCE*2 - SPLITTER_SIZE) / 2;\r
+        int header1_y = V_MARGIN;\r
+        int header2_y = V_MARGIN + headerHeight + LABEL_V_DISTANCE + memo_h + SPLITTER_SIZE;\r
+\r
+        PositionControlSet( hDlg, H_MARGIN, header1_y, clientWidth, memo_h,\r
+            IDC_Color1, IDC_EngineLabel1, IDC_Engine1_NPS, IDC_EngineMemo1, IDC_StateIcon1, IDC_StateData1 );\r
+\r
+        PositionControlSet( hDlg, H_MARGIN, header2_y, clientWidth, memo_h,\r
+            IDC_Color2, IDC_EngineLabel2, IDC_Engine2_NPS, IDC_EngineMemo2, IDC_StateIcon2, IDC_StateData2 );\r
+    }\r
+\r
+    InvalidateRect( GetDlgItem(hDlg,IDC_EngineMemo1), NULL, FALSE );\r
+    InvalidateRect( GetDlgItem(hDlg,IDC_EngineMemo2), NULL, FALSE );\r
+}\r
+\r
+// front end. Actual printing of PV lines into the output field\r
+void InsertIntoMemo( int which, char * text, int where )\r
+{\r
+    SendMessage( outputField[which][nMemo], EM_SETSEL, where, where ); // [HGM] multivar: choose insertion point\r
+\r
+    SendMessage( outputField[which][nMemo], EM_REPLACESEL, (WPARAM) FALSE, (LPARAM) text );\r
+}\r
+\r
+// front end. Associates an icon with an output field ("control" in Windows jargon).\r
+// [HGM] let it find out the output field from the 'which' number by itself\r
+void SetIcon( int which, int field, int nIcon )\r
+{\r
+\r
+    if( nIcon != 0 ) {\r
+        SendMessage( outputField[which][field], STM_SETICON, (WPARAM) icons[nIcon], 0 );\r
+    }\r
+}\r
+\r
+// front end wrapper for SetWindowText, taking control number in stead of handle\r
+void DoSetWindowText(int which, int field, char *s_label)\r
+{\r
+    SetWindowText( outputField[which][field], s_label );\r
+}\r
+\r
+// This seems pure front end\r
+LRESULT CALLBACK EngineOutputProc( HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam )\r
+{\r
+    static SnapData sd;\r
+\r
+    switch (message) {\r
+    case WM_INITDIALOG:\r
+        if( engineOutputDialog == NULL ) {\r
+            engineOutputDialog = hDlg;\r
+\r
+            RestoreWindowPlacement( hDlg, &wpEngineOutput ); /* Restore window placement */\r
+\r
+            ResizeWindowControls( windowMode );\r
+\r
+           /* Set font */\r
+           SendDlgItemMessage( engineOutputDialog, IDC_EngineMemo1, WM_SETFONT, (WPARAM)font[boardSize][MOVEHISTORY_FONT]->hf, MAKELPARAM(TRUE, 0 ));\r
+           SendDlgItemMessage( engineOutputDialog, IDC_EngineMemo2, WM_SETFONT, (WPARAM)font[boardSize][MOVEHISTORY_FONT]->hf, MAKELPARAM(TRUE, 0 ));\r
+\r
+            SetEngineState( 0, STATE_IDLE, "" );\r
+            SetEngineState( 1, STATE_IDLE, "" );\r
+        }\r
+\r
+        return FALSE;\r
+\r
+    case WM_COMMAND:\r
+        switch (LOWORD(wParam)) {\r
+        case IDOK:\r
+          EndDialog(hDlg, TRUE);\r
+          return TRUE;\r
+\r
+        case IDCANCEL:\r
+          EndDialog(hDlg, FALSE);\r
+          return TRUE;\r
+\r
+        default:\r
+          break;\r
+        }\r
+\r
+        break;\r
+\r
+    case WM_GETMINMAXINFO:\r
+        {\r
+            MINMAXINFO * mmi = (MINMAXINFO *) lParam;\r
+        \r
+            mmi->ptMinTrackSize.x = 100;\r
+            mmi->ptMinTrackSize.y = 160;\r
+        }\r
+        break;\r
+\r
+    case WM_CLOSE:\r
+        EngineOutputPopDown();\r
+        break;\r
+\r
+    case WM_SIZE:\r
+        ResizeWindowControls( windowMode );\r
+        break;\r
+\r
+    case WM_ENTERSIZEMOVE:\r
+        return OnEnterSizeMove( &sd, hDlg, wParam, lParam );\r
+\r
+    case WM_SIZING:\r
+        return OnSizing( &sd, hDlg, wParam, lParam );\r
+\r
+    case WM_MOVING:\r
+        return OnMoving( &sd, hDlg, wParam, lParam );\r
+\r
+    case WM_EXITSIZEMOVE:\r
+        return OnExitSizeMove( &sd, hDlg, wParam, lParam );\r
+    }\r
+\r
+    return FALSE;\r
+}\r
+\r
+// front end\r
+void EngineOutputPopUp()\r
+{\r
+  FARPROC lpProc;\r
+  static int  needInit = TRUE;\r
+  \r
+  CheckMenuItem(GetMenu(hwndMain), IDM_ShowEngineOutput, MF_CHECKED);\r
+\r
+  if( engineOutputDialog ) {\r
+    SendMessage( engineOutputDialog, WM_INITDIALOG, 0, 0 );\r
+\r
+    if( ! engineOutputDialogUp ) {\r
+        ShowWindow(engineOutputDialog, SW_SHOW);\r
+    }\r
+  }\r
+  else {\r
+    lpProc = MakeProcInstance( (FARPROC) EngineOutputProc, hInst );\r
+\r
+    /* Note to self: dialog must have the WS_VISIBLE style set, otherwise it's not shown! */\r
+    CreateDialog( hInst, MAKEINTRESOURCE(DLG_EngineOutput), hwndMain, (DLGPROC)lpProc );\r
+\r
+    FreeProcInstance(lpProc);\r
+  }\r
+\r
+  // [HGM] displaced to after creation of dialog, to allow initialization of output fields\r
+  if( needInit ) {\r
+      InitializeEngineOutput();\r
+      needInit = FALSE;\r
+  }\r
+\r
+  engineOutputDialogUp = TRUE;\r
+}\r
+\r
+// front end\r
+void EngineOutputPopDown()\r
+{\r
+  CheckMenuItem(GetMenu(hwndMain), IDM_ShowEngineOutput, MF_UNCHECKED);\r
+\r
+  if( engineOutputDialog ) {\r
+      ShowWindow(engineOutputDialog, SW_HIDE);\r
+  }\r
+\r
+  engineOutputDialogUp = FALSE;\r
+}\r
+\r
+// front end. [HGM] Takes handle of output control from table, so only number is passed\r
+void DoClearMemo(int which)\r
+{\r
+        SendMessage( outputField[which][nMemo], WM_SETTEXT, 0, (LPARAM) "" );\r
+}\r
+\r
+// front end (because only other front-end wants to know)\r
+int EngineOutputIsUp()\r
+{\r
+    return engineOutputDialogUp;\r
+}\r
+\r
+// front end, to give back-end access to engineOutputDialog\r
+int EngineOutputDialogExists()\r
+{\r
+    return engineOutputDialog != NULL;\r
+}\r