True graphical promotion popup for XBoard

A new file xpromo.c is added, cloned from the EvalGraph, to manage the
popup. It replaces the dummy PromoDialog function in backend.c that
presented the choice in the main window. Title and coordiate arguments
were added to this function, to allow intelligent positioning.

diff --git a/backend.c b/backend.c
index 122c8fd..c364fe2 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -6096,6 +6096,7 @@ UserMoveEvent(fromX, fromY, toX, toY, promoChar)
     FinishMove(moveType, fromX, fromY, toX, toY, promoChar);
 }
 
+#if 0
 void
 PromoDialog(int h, int w, Board board, Boolean clearBoard, char *title, int x, int y)
 {      // dummy routine to mimic with pseudo-popup what front-end should do:
@@ -6106,6 +6107,7 @@ PromoDialog(int h, int w, Board board, Boolean clearBoard, char *title, int x, i
        DisplayMessage("Click on your piece of choice", "");
        DrawPosition(TRUE, board);
 }
+#endif
 
 int hTab[(int)EmptySquare/2+1] = { 1,1,1,1,1,1,2,1,2,3,2,3,3,3,2,3,4,3,3,4,4,3,4 };
 int wTab[(int)EmptySquare/2+1] = { 1,1,2,3,4,5,3,7,4,3,5,4,4,5,7,5,4,6,6,5,5,7,6 };

diff --git a/xboard.c b/xboard.c
index 352b892..c83d83b 100644 (file)
--- a/xboard.c
+++ b/xboard.c
@@ -324,6 +324,7 @@ void FirstSettingsProc P((Widget w, XEvent *event, String *prms, Cardinal *nprms
 void SecondSettingsProc P((Widget w, XEvent *event, String *prms, Cardinal *nprms));
 void GameListOptionsPopUp P((Widget w, XEvent *event, String *prms, Cardinal *nprms));
 void GameListOptionsPopDown P(());
+void PromoPopDown P(());
 void ShufflePopDown P(());
 void EnginePopDown P(());
 void UciPopDown P(());

diff --git a/xpromo.c b/xpromo.c
new file mode 100644 (file)
index 0000000..0f259cb
--- /dev/null
+++ b/xpromo.c
@@ -0,0 +1,359 @@
+/*
+ * Evaluation graph
+ *
+ * Author: Alessandro Scotti (Dec 2005)
+ * Translated to X by H.G.Muller (Nov 2009)
+ *
+ * Copyright 2005 Alessandro Scotti
+ *
+ * Enhancements Copyright 2009 Free Software Foundation, Inc.
+ *
+ * ------------------------------------------------------------------------
+ *
+ * GNU XBoard is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * GNU XBoard is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ * ------------------------------------------------------------------------
+ ** See the file ChangeLog for a revision history.  */
+
+#include "config.h"
+
+#include <stdio.h>
+#include <ctype.h>
+#include <errno.h>
+#include <sys/types.h>
+
+#if STDC_HEADERS
+# include <stdlib.h>
+# include <string.h>
+#else /* not STDC_HEADERS */
+extern char *getenv();
+# if HAVE_STRING_H
+#  include <string.h>
+# else /* not HAVE_STRING_H */
+#  include <strings.h>
+# endif /* not HAVE_STRING_H */
+#endif /* not STDC_HEADERS */
+
+#if HAVE_UNISTD_H
+# include <unistd.h>
+#endif
+
+#include <X11/Intrinsic.h>
+#include <X11/StringDefs.h>
+#include <X11/Shell.h>
+#include <X11/Xaw/Dialog.h>
+#include <X11/Xaw/Form.h>
+#include <X11/Xaw/List.h>
+#include <X11/Xaw/Label.h>
+#include <X11/Xaw/SimpleMenu.h>
+#include <X11/Xaw/SmeBSB.h>
+#include <X11/Xaw/SmeLine.h>
+#include <X11/Xaw/Box.h>
+#include <X11/Xaw/Paned.h>
+#include <X11/Xaw/MenuButton.h>
+#include <X11/cursorfont.h>
+#include <X11/Xaw/Text.h>
+#include <X11/Xaw/AsciiText.h>
+#include <X11/Xaw/Viewport.h>
+
+#include "common.h"
+#include "frontend.h"
+#include "backend.h"
+#include "xboard.h"
+#include "evalgraph.h"
+#include "gettext.h"
+
+#ifdef ENABLE_NLS
+# define  _(s) gettext (s)
+# define N_(s) gettext_noop (s)
+#else
+# define  _(s) (s)
+# define N_(s)  s
+#endif
+
+#include <X11/xpm.h>
+
+// [HGM] pixmaps of some ICONS used in the engine-outut window
+#include "pixmaps/WHITE_14.xpm"
+#include "pixmaps/BLACK_14.xpm"
+#include "pixmaps/CLEAR_14.xpm"
+#include "pixmaps/UNKNOWN_14.xpm"
+#include "pixmaps/THINKING_14.xpm"
+#include "pixmaps/PONDER_14.xpm"
+#include "pixmaps/ANALYZING_14.xpm"
+
+#ifdef SNAP
+#include "wsnap.h"
+#endif
+
+#define _LL_ 100
+
+#define MARGIN 3
+
+typedef void (*DrawFunc)();
+DrawFunc ChooseDrawFunc();
+
+// imports from xboard.c
+extern Widget formWidget, shellWidget, boardWidget, menuBarWidget;
+extern Display *xDisplay;
+extern Window xBoardWindow;
+extern int squareSize;
+extern Pixmap xMarkPixmap, wIconPixmap, bIconPixmap;
+extern char *layoutName;
+extern int lineGap;
+
+Pixmap icons[8]; // [HGM] this front-end array translates back-end icon indicator to handle
+Widget outputField[2][7]; // [HGM] front-end array to translate output field to window handle
+
+/* Imports from backend.c */
+
+/* Imports from xboard.c */
+extern Arg layoutArgs[2], formArgs[2], messageArgs[4];
+extern GC coordGC;
+
+//extern WindowPlacement wpEvalGraph;
+
+/* Module variables */
+
+static Display *zDisplay;
+static Window promoWindow;
+static int nrow, ncol;
+extern Board promoBoard;
+
+static GC blackBrush;
+
+Widget promoShell;
+
+void PromoPopDown()
+{
+    if (!promoShell) return;
+    XtPopdown(promoShell);
+    XtDestroyWidget(promoShell);
+    promoShell = NULL;
+}
+
+// front-end
+static Pixel MakeColor(char *color )
+{
+    XrmValue vFrom, vTo;
+
+    vFrom.addr = (caddr_t) color;
+    vFrom.size = strlen(color);
+    XtConvert(promoShell, XtRString, &vFrom, XtRPixel, &vTo);
+    // test for NULL?
+
+    return *(Pixel *) vTo.addr;
+}
+
+static GC CreateGC(int width, char *fg, char *bg, int style)
+{
+    XtGCMask value_mask = GCLineWidth | GCLineStyle | GCForeground
+      | GCBackground | GCFunction | GCPlaneMask;
+    XGCValues gc_values;
+
+    gc_values.plane_mask = AllPlanes;
+    gc_values.line_width = width;
+    gc_values.line_style = style;
+    gc_values.function = GXcopy;
+
+    gc_values.foreground = MakeColor(fg);
+    gc_values.background = MakeColor(bg);
+
+    return XtGetGC(promoShell, value_mask, &gc_values);
+}
+
+void DrawPromoSquare(row, column, piece)
+     int row, column;
+     ChessSquare piece;
+{
+    int square_color, x, y;
+    DrawFunc drawfunc;
+
+    x = lineGap + column * (squareSize + lineGap);
+    y = lineGap + row * (squareSize + lineGap) + MARGIN;
+
+    square_color = 1;
+
+    if (piece == EmptySquare) {
+       BlankSquare(x, y, square_color, piece, promoWindow);
+    } else {
+       drawfunc = ChooseDrawFunc();
+       drawfunc(piece, square_color, x, y, promoWindow);
+    }
+
+}
+
+// front-end. Create pens, device context and buffer bitmap for global use, copy result to display
+// The back-end part n the middle has been taken out and moed to PainEvalGraph()
+static void DisplayPromoDialog()
+{
+    int j, r, f;
+    int width;
+    int height;
+    Dimension w, h;
+    Arg args[6];
+
+    /* Get client area */
+    j = 0;
+    XtSetArg(args[j], XtNwidth, &w); j++;
+    XtSetArg(args[j], XtNheight, &h); j++;
+    XtGetValues(promoShell, args, j);
+    width = w;
+    height = h;
+
+    /* Create or recreate paint box if needed */
+    if( width != nWidthPB || height != nHeightPB ) {
+
+        nWidthPB = width;
+        nHeightPB = height;
+    }
+
+    XFillRectangle(zDisplay, promoWindow, blackBrush, 0, MARGIN, w, h);
+    for(r = 0; r<nrow; r++) for(f=0; f<ncol; f++) 
+       DrawPromoSquare(r, f, promoBoard[r][f+BOARD_LEFT]);
+
+    XSync(zDisplay, False);
+}
+
+static void InitializePromoDialog()
+{ int i;    XtGCMask value_mask = GCLineWidth | GCLineStyle | GCForeground
+      | GCBackground | GCFunction | GCPlaneMask;
+    XGCValues gc_values;
+
+    blackBrush = CreateGC(3, "#000000", "#000000", LineSolid);
+}
+
+void PromoClick(widget, unused, event)
+     Widget widget;
+     caddr_t unused;
+     XEvent *event;
+{
+    int boardHeight = lineGap + BOARD_HEIGHT * (squareSize + lineGap);
+    int boardWidth  = lineGap + BOARD_WIDTH  * (squareSize + lineGap);
+    int boardLeft   = BOARD_LEFT  * (squareSize + lineGap);
+    int x = event->xbutton.x;
+    int y = event->xbutton.y - MARGIN;
+
+    if(y <= lineGap) y = lineGap + 1;
+
+    // translate click to as if it was on main board near a1
+    if(flipView) x = boardWidth - x; else y = boardHeight - y;
+
+    if( widget) {
+       if(event->type == ButtonPress)   LeftClick(Press,   x + boardLeft, y);
+       if(event->type == ButtonRelease) RightClick(Release, x + boardLeft, y, &y, &y);
+    }
+    PromoPopDown();
+}
+
+// This (cloned from EventProc in xboard.c) is needed as event handler, to prevent
+// the graph being wiped out after covering / uncovering by other windows.
+void PromoEventProc(widget, unused, event)
+     Widget widget;
+     caddr_t unused;
+     XEvent *event;
+{
+    if (!XtIsRealized(widget))
+      return;
+
+    switch (event->type) {
+      case Expose:
+       if (event->xexpose.count > 0) return;  /* no clipping is done */
+       DisplayPromoDialog();
+       break;
+      default:
+       return;
+    }
+}
+// The following routines are mutated clones of the commentPopUp routines
+
+Widget PromoCreate(name, x, y)
+     char *name;
+     int x, y;
+{
+    Arg args[16];
+    Widget shell, layout, form;
+    int j, h, w;
+
+    // define form within layout within shell.
+    j = 0;
+    XtSetArg(args[j], XtNresizable, True);  j++;
+    shell =
+      XtCreatePopupShell(name, transientShellWidgetClass,
+                        shellWidget, args, j);
+    layout =
+      XtCreateManagedWidget(layoutName, formWidgetClass, shell,
+                           layoutArgs, XtNumber(layoutArgs));
+    // divide window vertically into two equal parts, by creating two forms
+    form =
+      XtCreateManagedWidget("form", formWidgetClass, layout,
+                           formArgs, XtNumber(formArgs));
+    // make sure width is known in advance, for better placement of child widgets
+    j = 0;
+    XtSetArg(args[j], XtNwidth,  (XtArgVal) (w = ncol*squareSize + (ncol+1)*lineGap)); j++;
+    XtSetArg(args[j], XtNheight, (XtArgVal) (h = nrow*squareSize + (nrow+1)*lineGap + MARGIN)); j++;
+    XtSetValues(form, args, j);
+
+    if(y >= 0) {
+       Dimension bx, by;
+       if(y > h) y -= h - 5; else y += 60;
+       x -= w/2; if(x<10) x = 10;
+       j = 0;
+       XtSetArg(args[j], XtNx, &bx); j++;
+       XtSetArg(args[j], XtNy, &by); j++;
+       XtGetValues(boardWidget, args, j);
+       j = 0;
+       XtSetArg(args[j], XtNx, (XtArgVal) x+bx); j++;
+       XtSetArg(args[j], XtNy, (XtArgVal) y+by); j++;
+       XtSetValues(shell, args, j);
+    }
+
+    XtRealizeWidget(shell);
+
+    zDisplay = XtDisplay(shell);
+    promoWindow = XtWindow(form);
+    XtAddEventHandler(form, ExposureMask, False,
+                     (XtEventHandler) PromoEventProc, NULL);
+    XtAddEventHandler(form, ButtonPressMask, False,
+                     (XtEventHandler) PromoClick, NULL);
+    XtAddEventHandler(form, ButtonReleaseMask, False,
+                     (XtEventHandler) PromoClick, NULL);
+
+    return shell;
+}
+
+void 
+PromoDialog(int h, int w, Board b, Boolean clear, char *title, int x, int y)
+{
+    Arg args[16];
+    int j;
+    Widget edit;
+    static int  needInit = TRUE;
+
+    nrow = h; ncol = w;
+
+    if (promoShell == NULL) {
+
+       promoShell =
+         PromoCreate(title, x, y);
+       XtRealizeWidget(promoShell);
+       CatchDeleteWindow(promoShell, "PromoPopDown");
+       InitializePromoDialog();
+    }
+
+    XtPopup(promoShell, XtGrabExclusive);
+    XSync(zDisplay, False);
+//    DisplayPromoDialog();
+}
+