xhistory.c

   1 /*
   2  * New (WinBoard-style) Move history for XBoard
   3  *
   4  * Copyright 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
   5  * ------------------------------------------------------------------------
   6  *
   7  * GNU XBoard is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or (at
  10  * your option) any later version.
  11  *
  12  * GNU XBoard is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program. If not, see http://www.gnu.org/licenses/.
  19  *
  20  * ------------------------------------------------------------------------
  21  ** See the file ChangeLog for a revision history.  */
  22
  23 #include "config.h"
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27
  28 #include <X11/Intrinsic.h>
  29 #include <X11/StringDefs.h>
  30 #include <X11/Shell.h>
  31 #include <X11/Xaw/Dialog.h>
  32 #include <X11/Xaw/Form.h>
  33 #include <X11/Xaw/List.h>
  34 #include <X11/Xaw/Label.h>
  35 #include <X11/Xaw/SimpleMenu.h>
  36 #include <X11/Xaw/SmeBSB.h>
  37 #include <X11/Xaw/SmeLine.h>
  38 #include <X11/Xaw/Box.h>
  39 #include <X11/Xaw/Paned.h>
  40 #include <X11/Xaw/MenuButton.h>
  41 #include <X11/cursorfont.h>
  42 #include <X11/Xaw/Text.h>
  43 #include <X11/Xaw/AsciiText.h>
  44 #include <X11/Xaw/Viewport.h>
  45 #include <X11/Xatom.h>
  46 #include <X11/Xmu/Atoms.h>
  47
  48 #include "common.h"
  49 #include "frontend.h"
  50 #include "backend.h"
  51 #include "xhistory.h"
  52 #include "xboard.h"
  53 #include "dialogs.h"
  54 #include "gettext.h"
  55
  56 #ifdef ENABLE_NLS
  57 # define  _(s) gettext (s)
  58 # define N_(s) gettext_noop (s)
  59 #else
  60 # define  _(s) (s)
  61 # define N_(s)  s
  62 #endif
  63
  64 // templates for calls into back-end (= history.c; should be moved to history.h header shared with it!)
  65 void RefreshMemoContent P((void));
  66 void MemoContentUpdated P((void));
  67 void FindMoveByCharIndex P(( int char_index ));
  68
  69 // variables in xoptions.c
  70 extern Option historyOptions[];
  71
  72 // ------------- low-level front-end actions called by MoveHistory back-end -----------------
  73
  74 void
  75 HighlightMove (int from, int to, Boolean highlight)
  76 {
  77     if(highlight)
  78         XawTextSetSelection( historyOptions[0].handle, from, to ); // for lack of a better method, use selection for highighting
  79 }
  80
  81 void
  82 ClearHistoryMemo ()
  83 {
  84     SetWidgetText(&historyOptions[0], "", HistoryDlg);
  85 }
  86
  87 // the bold argument says 0 = normal, 1 = bold typeface
  88 // the colorNr argument says 0 = font-default, 1 = gray
  89 int
  90 AppendToHistoryMemo (char * text, int bold, int colorNr)
  91 {
  92     return AppendText(&historyOptions[0], text); // for now ignore bold & color stuff, as Xaw cannot handle that
  93 }
  94
  95 void
  96 ScrollToCurrent (int caretPos)
  97 {
  98     Arg args[10];
  99     char *s;
 100     int len;
 101     GetWidgetText(&historyOptions[0], &s);
 102     len = strlen(s);
 103     if(caretPos < 0 || caretPos > len) caretPos = len;
 104     if(caretPos > len-30) { // scroll to end, which causes no flicker
 105       static XEvent event;
 106       XtCallActionProc(historyOptions[0].handle, "end-of-file", &event, NULL, 0);
 107       return;
 108     }
 109     // the following leads to a very annoying flicker, even when no scrolling is done at all.
 110     XtSetArg(args[0], XtNinsertPosition, caretPos); // this triggers scrolling in Xaw
 111     XtSetArg(args[1], XtNdisplayCaret, False);
 112     XtSetValues(historyOptions[0].handle, args, 2);
 113 }
 114
 115
 116 // ------------------------------ callbacks --------------------------
 117
 118 char *historyText;
 119 char historyTranslations[] =
 120 "<Btn3Down>: select-start() \n \
 121 <Btn3Up>: extend-end() SelectMove() \n";
 122
 123 void
 124 SelectMove (Widget w, XEvent * event, String * params, Cardinal * nParams)
 125 {
 126         XawTextPosition index, dummy;
 127
 128         XawTextGetSelectionPos(w, &index, &dummy);
 129         FindMoveByCharIndex( index ); // [HGM] also does the actual moving to it, now
 130 }
 131
 132 Option historyOptions[] = {
 133 { 200, T_VSCRL | T_FILL | T_WRAP | T_TOP, 400, NULL, (void*) &historyText, "", NULL, TextBox, "" },
 134 {   0,           NO_OK,             0, NULL, (void*) NULL, "", NULL, EndMark , "" }
 135 };
 136
 137 // ------------ standard entry points into MoveHistory code -----------
 138
 139 Boolean
 140 MoveHistoryIsUp ()
 141 {
 142     return shellUp[HistoryDlg];
 143 }
 144
 145 Boolean
 146 MoveHistoryDialogExists ()
 147 {
 148     return DialogExists(HistoryDlg);
 149 }
 150
 151 void
 152 HistoryPopUp ()
 153 {
 154     if(GenericPopUp(historyOptions, _("Move list"), HistoryDlg, BoardWindow, NONMODAL))
 155         AddHandler(&historyOptions[0], 0);
 156     MarkMenu("Show Move History", HistoryDlg);
 157 }
 158
 159 void
 160 HistoryShowProc ()
 161 {
 162   if (!shellUp[HistoryDlg]) {
 163     ASSIGN(historyText, "");
 164     HistoryPopUp();
 165     RefreshMemoContent();
 166     MemoContentUpdated();
 167   } else PopDown(HistoryDlg);
 168   ToNrEvent(currentMove);
 169 }