Updated copyright notice to 2014
[xboard.git] / gtk / xboard.c
index a3add4a..d59adf1 100644 (file)
@@ -5,7 +5,7 @@
  * Massachusetts.
  *
  * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
- * 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
+ * 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
  *
  * The following terms apply to Digital Equipment Corporation's copyright
  * interest in XBoard:
@@ -167,6 +167,22 @@ extern char *getenv();
 #include "gettext.h"
 #include "draw.h"
 
+#ifdef __APPLE__
+#  include <gtkmacintegration/gtkosxapplication.h>
+   // prevent pathname of positional file argument provided by OS X being be mistaken for option name
+   // (price is that we won't recognize Windows option format anymore).
+#  define SLASH '-'
+   // redefine some defaults
+#  undef ICS_LOGON
+#  undef SYSCONFDIR
+#  define ICS_LOGON "Library/Preferences/XboardICS.conf"
+#  define SYSCONFDIR "../etc"
+#  define DATADIR dataDir
+   char *dataDir; // for expanding ~~
+#else
+#  define SLASH '/'
+#  define DATADIR "~~"
+#endif
 
 #ifdef __EMX__
 #ifndef HAVE_USLEEP
@@ -199,7 +215,6 @@ void MoveTypeInProc P((GdkEventKey *eventkey));
 gboolean KeyPressProc P((GtkWindow *window, GdkEventKey *eventkey, gpointer data));
 Boolean TempBackwardActive = False;
 void DisplayMove P((int moveNumber));
-void ICSInitScript P((void));
 void update_ics_width P(());
 int CopyMemoProc P(());
 static gboolean EventProc P((GtkWidget *widget, GdkEvent *event, gpointer g));
@@ -227,6 +242,9 @@ static GdkPixbuf       *mainwindowIcon=NULL;
 static GdkPixbuf       *WhiteIcon=NULL;
 static GdkPixbuf       *BlackIcon=NULL;
 
+/* key board accelerators */
+GtkAccelGroup *GtkAccelerators;
+
 typedef unsigned int BoardSize;
 BoardSize boardSize;
 Boolean chessProgram;
@@ -254,6 +272,7 @@ WindowPlacement wpEvalGraph;
 WindowPlacement wpEngineOutput;
 WindowPlacement wpGameList;
 WindowPlacement wpTags;
+WindowPlacement wpDualBoard;
 
 /* This magic number is the number of intermediate frames used
    in each half of the animation. For short moves it's reduced
@@ -283,73 +302,10 @@ XtResource clientResources[] = {
 };
 #endif
 
+/* keyboard shortcuts not yet transistioned int menuitem @ menu.c */
 char globalTranslations[] =
-  ":<Key>F9: MenuItem(Actions.Resign) \n \
-   :Ctrl<Key>n: MenuItem(File.NewGame) \n \
-   :Meta<Key>V: MenuItem(File.NewVariant) \n \
-   :Ctrl<Key>o: MenuItem(File.LoadGame) \n \
-   :Meta<Key>Next: MenuItem(LoadNextGameProc) \n \
-   :Meta<Key>Prior: MenuItem(LoadPrevGameProc) \n \
-   :Ctrl<Key>Down: LoadSelectedProc(3) \n \
+  ":Ctrl<Key>Down: LoadSelectedProc(3) \n \
    :Ctrl<Key>Up: LoadSelectedProc(-3) \n \
-   :Ctrl<Key>s: MenuItem(File.SaveGame) \n \
-   :Ctrl<Key>c: MenuItem(Edit.CopyGame) \n \
-   :Ctrl<Key>v: MenuItem(Edit.PasteGame) \n \
-   :Ctrl<Key>O: MenuItem(File.LoadPosition) \n \
-   :Shift<Key>Next: MenuItem(LoadNextPositionProc) \n \
-   :Shift<Key>Prior: MenuItem(LoadPrevPositionProc) \n \
-   :Ctrl<Key>S: MenuItem(File.SavePosition) \n \
-   :Ctrl<Key>C: MenuItem(Edit.CopyPosition) \n \
-   :Ctrl<Key>V: MenuItem(Edit.PastePosition) \n \
-   :Ctrl<Key>q: MenuItem(File.Quit) \n \
-   :Ctrl<Key>w: MenuItem(Mode.MachineWhite) \n \
-   :Ctrl<Key>b: MenuItem(Mode.MachineBlack) \n \
-   :Ctrl<Key>t: MenuItem(Mode.TwoMachines) \n \
-   :Ctrl<Key>a: MenuItem(Mode.AnalysisMode) \n \
-   :Ctrl<Key>g: MenuItem(Mode.AnalyzeFile) \n \
-   :Ctrl<Key>e: MenuItem(Mode.EditGame) \n \
-   :Ctrl<Key>E: MenuItem(Mode.EditPosition) \n \
-   :Meta<Key>O: MenuItem(View.EngineOutput) \n \
-   :Meta<Key>E: MenuItem(View.EvaluationGraph) \n \
-   :Meta<Key>G: MenuItem(View.GameList) \n \
-   :Meta<Key>H: MenuItem(View.MoveHistory) \n \
-   :<Key>Pause: MenuItem(Mode.Pause) \n \
-   :<Key>F3: MenuItem(Action.Accept) \n \
-   :<Key>F4: MenuItem(Action.Decline) \n \
-   :<Key>F12: MenuItem(Action.Rematch) \n \
-   :<Key>F5: MenuItem(Action.CallFlag) \n \
-   :<Key>F6: MenuItem(Action.Draw) \n \
-   :<Key>F7: MenuItem(Action.Adjourn) \n \
-   :<Key>F8: MenuItem(Action.Abort) \n \
-   :<Key>F10: MenuItem(Action.StopObserving) \n \
-   :<Key>F11: MenuItem(Action.StopExamining) \n \
-   :Ctrl<Key>d: MenuItem(DebugProc) \n \
-   :Meta Ctrl<Key>F12: MenuItem(DebugProc) \n \
-   :Meta<Key>End: MenuItem(Edit.ForwardtoEnd) \n \
-   :Meta<Key>Right: MenuItem(Edit.Forward) \n \
-   :Meta<Key>Home: MenuItem(Edit.BacktoStart) \n \
-   :Meta<Key>Left: MenuItem(Edit.Backward) \n \
-   :<Key>Left: MenuItem(Edit.Backward) \n \
-   :<Key>Right: MenuItem(Edit.Forward) \n \
-   :<Key>Home: MenuItem(Edit.Revert) \n \
-   :<Key>End: MenuItem(Edit.TruncateGame) \n \
-   :Ctrl<Key>m: MenuItem(Engine.MoveNow) \n \
-   :Ctrl<Key>x: MenuItem(Engine.RetractMove) \n \
-   :Meta<Key>J: MenuItem(Options.Adjudications) \n \
-   :Meta<Key>U: MenuItem(Options.CommonEngine) \n \
-   :Meta<Key>T: MenuItem(Options.TimeControl) \n \
-   :Ctrl<Key>P: MenuItem(PonderNextMove) \n "
-#ifndef OPTIONSDIALOG
-    "\
-   :Ctrl<Key>Q: MenuItem(AlwaysQueenProc) \n \
-   :Ctrl<Key>F: MenuItem(AutoflagProc) \n \
-   :Ctrl<Key>A: MenuItem(AnimateMovingProc) \n \
-   :Ctrl<Key>L: MenuItem(TestLegalityProc) \n \
-   :Ctrl<Key>H: MenuItem(HideThinkingProc) \n "
-#endif
-   "\
-   :<Key>F1: MenuItem(Help.ManXBoard) \n \
-   :<Key>F2: MenuItem(View.FlipView) \n \
    :<KeyDown>Return: TempBackwardProc() \n \
    :<KeyUp>Return: TempForwardProc() \n";
 
@@ -372,7 +328,7 @@ String xboardResources[] = {
 void
 BoardToTop ()
 {
-  gtk_window_present(GTK_WINDOW(mainwindow));
+  gtk_window_present(GTK_WINDOW(shells[BoardWindow]));
 }
 
 //---------------------------------------------------------------------------------------------------------
@@ -623,11 +579,16 @@ ConvertToLine (int argc, char **argv)
 
 //--------------------------------------------------------------------------------------------
 
+int clockKludge;
+
 void
 ResizeBoardWindow (int w, int h, int inhibit)
 {
+    GtkAllocation a;
+    if(clockKludge) return; // ignore as long as clock does not have final height
+    gtk_widget_get_allocation(optList[W_WHITE].handle, &a);
     w += marginW + 1; // [HGM] not sure why the +1 is (sometimes) needed...
-    h += marginH;
+    h += marginH + a.height + 1;
     gtk_window_resize(GTK_WINDOW(shellWidget), w, h);
 }
 
@@ -704,6 +665,7 @@ PrintArg (ArgType t)
     case ArgString:   p = " STR"; break;
     case ArgBoolean:  p = " TF"; break;
     case ArgSettingsFilename:
+    case ArgBackupSettingsFile:
     case ArgFilename: p = " FILE"; break;
     case ArgX:        p = " Nx"; break;
     case ArgY:        p = " Ny"; break;
@@ -751,6 +713,39 @@ PrintOptions ()
   if(len) buf[len] = NULLCHAR, printf("%s\n", buf);
 }
 
+void
+SlaveResize (Option *opt)
+{
+    static int slaveW, slaveH, w, h;
+    GtkAllocation a;
+    if(!slaveH) {
+       gtk_widget_get_allocation(shells[DummyDlg], &a);
+       w = a.width; h = a.height;
+       gtk_widget_get_allocation(opt->handle, &a);
+       slaveW =  w - opt->max; // [HGM] needed to set new shellWidget size when we resize board
+       slaveH =  h - a.height + 13;
+   }
+  gtk_window_resize(GTK_WINDOW(shells[DummyDlg]), slaveW + opt->max, slaveH + opt->value);
+}
+
+#ifdef __APPLE__
+static char clickedFile[MSG_SIZ];
+static int suppress;
+
+static gboolean
+StartNewXBoard(GtkosxApplication *app, gchar *path, gpointer user_data)
+{ // handler of OSX OpenFile signal, which sends us the filename of clicked file or first argument
+  if(suppress) { // we just started XBoard without arguments
+    strncpy(clickedFile, path, MSG_SIZ); // remember file name, but otherwise ignore
+  } else {       // we are running something presumably useful
+    char buf[MSG_SIZ];
+    snprintf(buf, MSG_SIZ, "open -n -a \"xboard\" --args \"%s\"", path);
+    system(buf); // start new instance on this file
+  }
+  return TRUE;
+}
+#endif
+
 int
 main (int argc, char **argv)
 {
@@ -777,6 +772,32 @@ main (int argc, char **argv)
 
     /* set up GTK */
     gtk_init (&argc, &argv);
+#ifdef __APPLE__
+    {   // prepare to catch OX OpenFile signal, which will tell us the clicked file
+       GtkosxApplication *theApp = g_object_new(GTKOSX_TYPE_APPLICATION, NULL);
+       dataDir = gtkosx_application_get_bundle_path();
+       g_signal_connect(theApp, "NSApplicationOpenFile", G_CALLBACK(StartNewXBoard), NULL);
+       // we must call application ready before we can get the signal,
+       // and supply a (dummy) menu bar before that, to avoid problems with dual apples in it
+       gtkosx_application_set_menu_bar(theApp, GTK_MENU_SHELL(gtk_menu_bar_new()));
+       gtkosx_application_ready(theApp);
+       suppress = (argc == 1 || argc > 1 && argv[1][00] != '-'); // OSX sends signal even if name was already argv[1]!
+       if(argc == 1) {                  // called without args: OSX open-file signal might follow
+           static char *fakeArgv[3] = {NULL, clickedFile, NULL};
+           usleep(10000);               // wait 10 msec (and hope this is long enough).
+           while(gtk_events_pending())
+               gtk_main_iteration();    // process all events that came in upto now
+           suppress = 0;                // future open-file signals should start new instance
+           if(clickedFile[0]) {         // we were sent an open-file signal with filename!
+             fakeArgv[0] = argv[0];
+             argc = 2; argv = fakeArgv; // fake that we were called as "xboard filename"
+           }
+       }
+    }
+#endif
+
+    /* set up keyboard accelerators group */
+    GtkAccelerators = gtk_accel_group_new();
 
     programName = strrchr(argv[0], '/');
     if (programName == NULL)
@@ -790,6 +811,7 @@ main (int argc, char **argv)
 //    }
 
     bindtextdomain(PACKAGE, LOCALEDIR);
+    bind_textdomain_codeset(PACKAGE, "UTF-8"); // needed when creating markup for the clocks
     textdomain(PACKAGE);
 #endif
 
@@ -961,6 +983,7 @@ main (int argc, char **argv)
        layoutName = "normalLayout";
     }
 
+    wpMain.width = -1; // prevent popup sizes window
     optList = BoardPopUp(squareSize, lineGap, (void*)
 #ifdef TODO_GTK
 #if ENABLE_NLS
@@ -995,6 +1018,9 @@ main (int argc, char **argv)
 
     InitMenuMarkers();
 
+    // add accelerators to main shell
+    gtk_window_add_accel_group(GTK_WINDOW(shellWidget), GtkAccelerators);
+
     /*
      * Create an icon. (Use two icons, to indicate whther it is white's or black's turn.)
      */
@@ -1025,15 +1051,21 @@ main (int argc, char **argv)
 //    XtSetValues(shellWidget, &shellArgs[2], 4);
 #endif
     {
+       // Note: We cannot do sensible sizing here, because the height of the clock widget is not yet known
+       // It wil only become known asynchronously, when we first write a string into it.
+       // This will then change the clock widget height, which triggers resizing the top-level window
+       // and a configure event. Only then can we know the total height of the top-level window,
+       // and calculate the height we need. The clockKludge flag suppresses all resizing until
+       // that moment comes, after which the configure event-handler handles it through a (delayed) DragProg.
+       int hc;
        GtkAllocation a;
        gtk_widget_get_allocation(shells[BoardWindow], &a);
        w = a.width; h = a.height;
-//printf("start size (%d,%d), %dx%d\n", a.x, a.y, w, h);
+       gtk_widget_get_allocation(optList[W_WHITE].handle, &a);
+       clockKludge = hc = a.height;
        gtk_widget_get_allocation(boardWidget, &a);
        marginW =  w - boardWidth; // [HGM] needed to set new shellWidget size when we resize board
-       marginH =  h - a.height - 25; // subtract 25, because GTK seems to insert this amount of extra empty space
-       gtk_window_resize(GTK_WINDOW(shellWidget), marginW + boardWidth, marginH + boardHeight);
-//printf("margins h=%d v=%d\n", marginW, marginH);
+       marginH =  h - a.height - hc; // subtract current clock height, so it can be added back dynamically
     }
 
     CreateAnyPieces();
@@ -1290,7 +1322,7 @@ FindFont (char *pattern, int targetPxlSize)
         safeStrCpy(p, best, strlen(best)+1 );
     }
     if (appData.debugMode) {
-        fprintf(debugFP, _("resolved %s at pixel size %d\n  to %s\n"),
+        fprintf(debugFP, "resolved %s at pixel size %d\n  to %s\n",
                pattern, targetPxlSize, p);
     }
     XFreeFontNames(fonts);
@@ -1454,15 +1486,23 @@ CoDrag (GtkWidget *sh, WindowPlacement *wp)
 void
 ReSize (WindowPlacement *wp)
 {
-       int sqx, sqy, w, h, lg = lineGap;
+       GtkAllocation a;
+       int sqx, sqy, w, h, hc, lg = lineGap;
+       gtk_widget_get_allocation(optList[W_WHITE].handle, &a);
+       hc = a.height; // clock height can depend on single / double line clock text!
+        if(clockKludge == a.height) return; // wait for clock to get final size at startup
+       if(clockKludge) { // clock height OK now; calculate desired initial board height
+           clockKludge = 0;
+           wp->height = BOARD_HEIGHT * (squareSize + lineGap) + lineGap + marginH + hc;
+       }
        if(wp->width == wpMain.width && wp->height == wpMain.height) return; // not sized
        sqx = (wp->width  - lg - marginW) / BOARD_WIDTH - lg;
-       sqy = (wp->height - lg - marginH) / BOARD_HEIGHT - lg;
+       sqy = (wp->height - lg - marginH - hc) / BOARD_HEIGHT - lg;
        if(sqy < sqx) sqx = sqy;
        if(appData.overrideLineGap < 0) { // do second iteration with adjusted lineGap
            lg = lineGap = sqx < 37 ? 1 : sqx < 59 ? 2 : sqx < 116 ? 3 : 4;
            sqx = (wp->width  - lg - marginW) / BOARD_WIDTH - lg;
-           sqy = (wp->height - lg - marginH) / BOARD_HEIGHT - lg;
+           sqy = (wp->height - lg - marginH - hc) / BOARD_HEIGHT - lg;
            if(sqy < sqx) sqx = sqy;
        }
        if(sqx != squareSize) {
@@ -1487,16 +1527,17 @@ DragProc ()
 
        busy = 1;
 //     GetActualPlacement(shellWidget, &wpNew);
-//printf("drag proc (%d,%d) %dx%d\n", wpNew.x, wpNew.y, wpNew.width, wpNew.height);
        if(wpNew.x == wpMain.x && wpNew.y == wpMain.y && // not moved
           wpNew.width == wpMain.width && wpNew.height == wpMain.height) { // not sized
            busy = 0; return; // false alarm
        }
        ReSize(&wpNew);
-       if(shellUp[EngOutDlg]) CoDrag(shells[EngOutDlg], &wpEngineOutput);
-       if(shellUp[HistoryDlg]) CoDrag(shells[HistoryDlg], &wpMoveHistory);
-       if(shellUp[EvalGraphDlg]) CoDrag(shells[EvalGraphDlg], &wpEvalGraph);
-       if(shellUp[GameListDlg]) CoDrag(shells[GameListDlg], &wpGameList);
+       if(appData.useStickyWindows) {
+           if(shellUp[EngOutDlg]) CoDrag(shells[EngOutDlg], &wpEngineOutput);
+           if(shellUp[HistoryDlg]) CoDrag(shells[HistoryDlg], &wpMoveHistory);
+           if(shellUp[EvalGraphDlg]) CoDrag(shells[EvalGraphDlg], &wpEvalGraph);
+           if(shellUp[GameListDlg]) CoDrag(shells[GameListDlg], &wpGameList);
+        }
        wpMain = wpNew;
        DrawPosition(True, NULL);
        if(delayedDragTag) g_source_remove(delayedDragTag);
@@ -1522,8 +1563,7 @@ EventProc (GtkWidget *widget, GdkEvent *event, gpointer g)
     wpNew.y = event->configure.y;
     wpNew.width  = event->configure.width;
     wpNew.height = event->configure.height;
-    if(appData.useStickyWindows)
-       DelayedDrag(); // as long as events keep coming in faster than 50 msec, they destroy each other
+    DelayedDrag(); // as long as events keep coming in faster than 50 msec, they destroy each other
     return FALSE;
 }
 
@@ -1566,7 +1606,7 @@ ModeHighlight ()
          /* Always toggle, don't set.  Previous code messes up when
             invoked while the button is pressed, as releasing it
             toggles the state again. */
-           GdkColor color;     
+           GdkColor color;
             gdk_color_parse( pausing ? "#808080" : "#F0F0F0", &color );
             gtk_widget_modify_bg ( GTK_WIDGET(optList[W_PAUSE].handle), GTK_STATE_NORMAL, &color );
        }
@@ -1619,7 +1659,7 @@ void CopyFileToClipboard(gchar *filename)
       return;
     }
     selection_tmp[len] = NULLCHAR; // file is now in selection_tmp
-    
+
     // copy selection_tmp to clipboard
     GdkDisplay *gdisp = gdk_display_get_default();
     if (!gdisp) {
@@ -1628,7 +1668,7 @@ void CopyFileToClipboard(gchar *filename)
     }
     cb = gtk_clipboard_get_for_display(gdisp, GDK_SELECTION_CLIPBOARD);
     gtk_clipboard_set_text(cb, selection_tmp, -1);
-    g_free(selection_tmp);    
+    g_free(selection_tmp);
 }
 
 void
@@ -1650,9 +1690,9 @@ PastePositionProc ()
     gchar *fenstr;
 
     if (gdisp == NULL) return;
-    cb = gtk_clipboard_get_for_display(gdisp, GDK_SELECTION_CLIPBOARD);    
+    cb = gtk_clipboard_get_for_display(gdisp, GDK_SELECTION_CLIPBOARD);
     fenstr = gtk_clipboard_wait_for_text(cb);
-    if (fenstr==NULL) return; // nothing had been selected to copy  
+    if (fenstr==NULL) return; // nothing had been selected to copy
     EditPositionPasteFEN(fenstr);
     return;
 }
@@ -1668,14 +1708,14 @@ PasteGameProc ()
     // get game from clipboard
     GdkDisplay *gdisp = gdk_display_get_default();
     if (gdisp == NULL) return;
-    cb = gtk_clipboard_get_for_display(gdisp, GDK_SELECTION_CLIPBOARD);    
+    cb = gtk_clipboard_get_for_display(gdisp, GDK_SELECTION_CLIPBOARD);
     text = gtk_clipboard_wait_for_text(cb);
-    if (text == NULL) return; // nothing to paste  
+    if (text == NULL) return; // nothing to paste
     len = strlen(text);
 
     // write to temp file
     if (text == NULL || len == 0) {
-      return; //nothing to paste 
+      return; //nothing to paste
     }
     f = fopen(gamePasteFilename, "w");
     if (f == NULL) {
@@ -1685,7 +1725,7 @@ PasteGameProc ()
     fwrite(text, 1, len, f);
     fclose(f);
 
-    // load from file 
+    // load from file
     LoadGameFromFile(gamePasteFilename, 0, gamePasteFilename, TRUE);
     return;
 }
@@ -1704,14 +1744,14 @@ void MoveTypeInProc(eventkey)
 {
     char buf[10];
 
-    // ingnore if ctrl or alt is pressed
-    if (eventkey->state & (GDK_CONTROL_MASK | GDK_MOD1_MASK)) {
+    // ingnore if ctrl, alt, or meta is pressed
+    if (eventkey->state & (GDK_CONTROL_MASK | GDK_MOD1_MASK | GDK_META_MASK)) {
         return;
     }
 
     buf[0]=eventkey->keyval;
     buf[1]='\0';
-    if (*buf >= 32)        
+    if (eventkey->keyval > 32 && eventkey->keyval < 256)
        BoxAutoPopUp (buf);
 }
 
@@ -1740,26 +1780,15 @@ TempForwardProc (Widget w, XEvent *event, String *prms, Cardinal *nprms)
     ForwardEvent();
        TempBackwardActive = False;
 }
-
-void
-ManInner (Widget w, XEvent *event, String *prms, Cardinal *nprms)
-{   // called as key binding
-    char buf[MSG_SIZ];
-    String name;
-    if (nprms && *nprms > 0)
-      name = prms[0];
-    else
-      name = "xboard";
-    snprintf(buf, sizeof(buf), "xterm -e man %s &", name);
-    system(buf);
-}
 #endif
 
 void
 ManProc ()
 {   // called from menu
-#ifdef TODO_GTK
-    ManInner(NULL, NULL, NULL, NULL);
+#ifdef __APPLE__
+    system("%s ./man.command", appData.sysOpen);
+#else
+    system("xterm -e man xboard &");
 #endif
 }
 
@@ -2061,7 +2090,7 @@ UpdateLogos (int displ)
     return;
 }
 
-void FileNamePopUpGTK(label, def, filter, proc, pathFlag, openMode, name, fp)
+void FileNamePopUpWrapper(label, def, filter, proc, pathFlag, openMode, name, fp)
      char *label;
      char *def;
      char *filter;
@@ -2080,7 +2109,7 @@ void FileNamePopUpGTK(label, def, filter, proc, pathFlag, openMode, name, fp)
   char *cp;
 
   /* make a copy of the filter string, so that strtok can work with it*/
-  cp = strndup(filter,strlen(filter));
+  cp = strdup(filter);
 
   /* add filters for file extensions */
   gtkfilter     = gtk_file_filter_new();
@@ -2161,4 +2190,3 @@ void FileNamePopUpGTK(label, def, filter, proc, pathFlag, openMode, name, fp)
   return;
 
 }
-