From 6f506fcf96fb49387a4ae7cd1e2e8be01e5a6bc4 Mon Sep 17 00:00:00 2001
From: Volker Ruppert <Volker.Ruppert@t-online.de>
Date: Sat, 8 Oct 2005 11:41:18 +0000
Subject: [PATCH] - modified syntax of the user shortcut string. The key names
 are now separated   with a '-' character. Added support for some more keys.
 The old-style syntax   is still supported for a few key combinations. -
 updated/added documentation for the 'cmosimage' option

---
 bochs/.bochsrc                  |  26 ++++--
 bochs/doc/docbook/user/user.dbk |  17 ++--
 bochs/doc/man/bochsrc.5         |  18 ++--
 bochs/gui/gui.cc                | 143 +++++++++++++++++++++++---------
 4 files changed, 145 insertions(+), 59 deletions(-)

diff --git a/bochs/.bochsrc b/bochs/.bochsrc
index b8a401827..b1137d3d7 100644
--- a/bochs/.bochsrc
+++ b/bochs/.bochsrc
@@ -638,14 +638,17 @@ keyboard_mapping: enabled=0, map=
 #=======================================================================
 # USER_SHORTCUT:
 # This defines the keyboard shortcut to be sent when you press the "user"
-# button in the headerbar. The shortcut string can be a combination of
-# these key names: "alt", "bksp", "ctrl", "del", "esc", "f1", "f4", "tab"
-# and "win". Up to 3 keys can be pressed at a time.
+# button in the headerbar. The shortcut string is a combination of maximum
+# 3 key names (listed below) separated with a '-' character. The old-style
+# syntax (without the '-') is still supported for a few key combinations.
+# Valid key names: "f1", ... "f12", "alt", "bksp", "ctrl", "del", "down",
+# "enter", "esc", "left", "menu", "minus", "plus", "right", "space", "tab",
+# "up", and "win".
 #
 # Example:
-#   user_shortcut: keys=ctrlaltdel
+#   user_shortcut: keys=ctrl-alt-del
 #=======================================================================
-#user_shortcut: keys=ctrlaltdel
+#user_shortcut: keys=ctrl-alt-del
 
 #=======================================================================
 # I440FXSUPPORT:
@@ -673,11 +676,22 @@ keyboard_mapping: enabled=0, map=
 #=======================================================================
 #usb1: enabled=1
 
+#=======================================================================
+# CMOSIMAGE:
+# This defines image file that can be loaded into the CMOS RAM at startup.
+# The rtc_init parameter controls whether initialize the RTC with values stored
+# in the image. By default the time0 argument given to the clock option is used.
+# With 'rtc_init=image' the image is the source for the initial time.
+#
+# Example:
+#   cmosimage: file=cmos.img, rtc_init=image
+#=======================================================================
+#cmosimage: file=cmos.img, rtc_init=time0
+
 #=======================================================================
 # other stuff
 #=======================================================================
 #magic_break: enabled=1
-#cmosimage: file=cmos.img, rtc_init=time0
 #load32bitOSImage: os=nullkernel, path=../kernel.img, iolog=../vga_io.log
 #load32bitOSImage: os=linux, path=../linux.img, iolog=../vga_io.log, initrd=../initrd.img
 #text_snapshot_check: enable
diff --git a/bochs/doc/docbook/user/user.dbk b/bochs/doc/docbook/user/user.dbk
index 347092f7a..71d920c91 100644
--- a/bochs/doc/docbook/user/user.dbk
+++ b/bochs/doc/docbook/user/user.dbk
@@ -1,7 +1,7 @@
 <!--
 ================================================================
 doc/docbook/user/user.dbk
-$Id: user.dbk,v 1.182 2005-09-25 09:01:05 vruppert Exp $
+$Id: user.dbk,v 1.183 2005-10-08 11:41:18 vruppert Exp $
 
 This is the top level file for the Bochs Users Manual.
 ================================================================
@@ -4095,13 +4095,16 @@ exception is French macs, that do have a "at"-like keyboard.
 <para>
 Examples:
 <screen>
-  user_shortcut: keys=ctrlaltdel
-  user_shortcut: keys=ctrlaltesc
+  user_shortcut: keys=ctrl-alt-del
+  user_shortcut: keys=ctrl-alt-esc
 </screen>
-This defines the keyboard shortcut to be sent when you press the "user"
-button in the <link linkend="headerbar">headerbar</link>. The shortcut string can be a combination of
-these key names: "alt", "bksp", "ctrl", "del", "esc", "f1", "f4", "tab", "win".
-Up to 3 keys can be pressed at a time.
+This defines the keyboard shortcut to be sent when you press the "user" button
+in the <link linkend="headerbar">headerbar</link>. The shortcut string is a
+combination of maximum 3 key names (listed below) separated with a '-' character.
+The old-style syntax (without the '-') is still supported for a few key combinations.
+Valid key names: "f1", ... "f12", "alt", "bksp", "ctrl", "del", "down",
+"enter", "esc", "left", "menu", "minus", "plus", "right", "space", "tab",
+"up", and "win".
 </para>
 </section>
 
diff --git a/bochs/doc/man/bochsrc.5 b/bochs/doc/man/bochsrc.5
index 5bd810ce2..81c48b190 100644
--- a/bochs/doc/man/bochsrc.5
+++ b/bochs/doc/man/bochsrc.5
@@ -1,5 +1,5 @@
 .\Document Author:  Timothy R. Butler   -   tbutler@uninetsolutions.com
-.TH bochsrc 5 "22 Sep 2005" "bochsrc" "The Bochs Project"
+.TH bochsrc 5 "8 Oct 2005" "bochsrc" "The Bochs Project"
 .\"SKIP_SECTION"
 .SH NAME
 bochsrc \- Configuration file for Bochs.
@@ -728,19 +728,25 @@ Example:
 .TP
 .I "user_shortcut:"
 This defines the keyboard shortcut to be sent when you press the "user"
-button in the headerbar. The shortcut string can be a combination of
-these key names: "alt", "bksp", "ctrl", "del", "esc", "f1", "f4", "tab",
-"win". Up to 3 keys can be pressed at a time.
+button in the headerbar. The shortcut string is a combination of maximum
+3 key names (listed below) separated with a '-' character. The old-style
+syntax (without the '-') is still supported for a few key combinations.
+Valid key names: "f1", ... "f12", "alt", "bksp", "ctrl", "del", "down",
+"enter", "esc", "left", "menu", "minus", "plus", "right", "space", "tab",
+"up", and "win".
 
 Example:
-  user_shortcut: keys=ctrlaltdel
+  user_shortcut: keys=ctrl-alt-del
 
 .TP
 .I "cmosimage:"
 This defines image file that can be loaded into the CMOS RAM at startup.
+The rtc_init parameter controls whether initialize the RTC with values stored
+in the image. By default the time0 argument given to the clock option is used.
+With 'rtc_init=image' the image is the source for the initial time.
 
 Example:
-  cmosimage: cmos.img
+  cmosimage: file=cmos.img, rtc_init=time0
 
 .TP
 .I "usb1:"
diff --git a/bochs/gui/gui.cc b/bochs/gui/gui.cc
index c1f55356a..80e4abaf1 100644
--- a/bochs/gui/gui.cc
+++ b/bochs/gui/gui.cc
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////
-// $Id: gui.cc,v 1.80 2004-08-15 19:27:14 vruppert Exp $
+// $Id: gui.cc,v 1.81 2005-10-08 11:41:18 vruppert Exp $
 /////////////////////////////////////////////////////////////////////////
 //
 //  Copyright (C) 2002  MandrakeSoft S.A.
@@ -48,6 +48,46 @@ bx_gui_c *bx_gui = NULL;
 #define BX_GUI_THIS bx_gui->
 #define LOG_THIS BX_GUI_THIS
 
+#define BX_KEY_UNKNOWN 0x7fffffff
+#define N_USER_KEYS 28
+
+typedef struct {
+  char *key;
+  Bit32u symbol;
+} user_key_t;
+
+static user_key_t user_keys[N_USER_KEYS] =
+{
+  "f1",    BX_KEY_F1,
+  "f2",    BX_KEY_F2,
+  "f3",    BX_KEY_F3,
+  "f4",    BX_KEY_F4,
+  "f5",    BX_KEY_F5,
+  "f6",    BX_KEY_F6,
+  "f7",    BX_KEY_F7,
+  "f8",    BX_KEY_F8,
+  "f9",    BX_KEY_F9,
+  "f10",   BX_KEY_F10,
+  "f11",   BX_KEY_F11,
+  "f12",   BX_KEY_F12,
+  "alt",   BX_KEY_ALT_L,
+  "bksp",  BX_KEY_BACKSPACE,
+  "ctrl",  BX_KEY_CTRL_L,
+  "del",   BX_KEY_DELETE,
+  "down",  BX_KEY_DOWN,
+  "enter", BX_KEY_ENTER,
+  "esc",   BX_KEY_ESC,
+  "left",  BX_KEY_LEFT,
+  "menu",  BX_KEY_MENU,
+  "minus", BX_KEY_MINUS,
+  "plus",  BX_KEY_KP_ADD,
+  "right", BX_KEY_RIGHT,
+  "space", BX_KEY_SPACE,
+  "tab",   BX_KEY_TAB,
+  "up",    BX_KEY_UP,
+  "win",   BX_KEY_WIN_L
+};
+
 bx_gui_c::bx_gui_c(void)
 {
   put("GUI"); // Init in specific_init
@@ -483,15 +523,27 @@ bx_gui_c::toggle_mouse_enable(void)
   bx_options.Omouse_enabled->set (!old);
 }
 
+Bit32u get_user_key(char *key)
+{
+  int i = 0;
+
+  while (i < N_USER_KEYS) {
+    if (!strcmp(key, user_keys[i].key))
+      return user_keys[i].symbol;
+    i++;
+  }
+  return BX_KEY_UNKNOWN;
+}
+
   void
 bx_gui_c::userbutton_handler(void)
 {
-  unsigned shortcut[4];
-  unsigned p;
-  char *user_shortcut;
-  int i, len, ret = 1;
+  Bit32u shortcut[4];
+  Bit32u symbol;
+  char user_shortcut[512];
+  char *ptr;
+  int i, len = 0, ret = 1;
 
-  len = 0;
 #ifdef WIN32
   if (strcmp(bx_options.Osel_displaylib->get_choice(bx_options.Osel_displaylib->get()),
               "rfb")) {
@@ -501,41 +553,52 @@ bx_gui_c::userbutton_handler(void)
 #endif
     ret = SIM->ask_param (BXP_USER_SHORTCUT);
   }
-  user_shortcut = bx_options.Ouser_shortcut->getptr();
+  strcpy(user_shortcut, bx_options.Ouser_shortcut->getptr());
   if ((ret > 0) && user_shortcut[0] && (strcmp(user_shortcut, "none"))) {
-    len = 0;
-    p = 0;
-    while ((p < strlen(user_shortcut)) && (len < 3)) {
-      if (!strncmp(user_shortcut+p, "alt", 3)) {
-        shortcut[len++] = BX_KEY_ALT_L;
-        p += 3;
-      } else if (!strncmp(user_shortcut+p, "ctrl", 4)) {
-        shortcut[len++] = BX_KEY_CTRL_L;
-        p += 4;
-      } else if (!strncmp(user_shortcut+p, "del", 3)) {
-        shortcut[len++] = BX_KEY_DELETE;
-        p += 3;
-      } else if (!strncmp(user_shortcut+p, "esc", 3)) {
-        shortcut[len++] = BX_KEY_ESC;
-        p += 3;
-      } else if (!strncmp(user_shortcut+p, "f1", 2)) {
-        shortcut[len++] = BX_KEY_F1;
-        p += 2;
-      } else if (!strncmp(user_shortcut+p, "f4", 2)) {
-        shortcut[len++] = BX_KEY_F4;
-        p += 2;
-      } else if (!strncmp(user_shortcut+p, "tab", 3)) {
-        shortcut[len++] = BX_KEY_TAB;
-        p += 3;
-      } else if (!strncmp(user_shortcut+p, "win", 3)) {
-        shortcut[len++] = BX_KEY_WIN_L;
-        p += 3;
-      } else if (!strncmp(user_shortcut+p, "bksp", 4)) {
-        shortcut[len++] = BX_KEY_BACKSPACE;
-        p += 4;
-      } else {
-        BX_ERROR(("Unknown shortcut %s ignored", user_shortcut));
-        return;
+    ptr = strtok(user_shortcut, "-");
+    if (strcmp(ptr, bx_options.Ouser_shortcut->getptr())) {
+      while (ptr) {
+        symbol = get_user_key(ptr);
+        if (symbol == BX_KEY_UNKNOWN) {
+          BX_ERROR(("Unknown shortcut %s ignored", ptr));
+          return;
+        }
+        shortcut[len++] = symbol;
+        ptr = strtok(NULL, "-");
+      }
+    } else {
+      while ((ptr[0]) && (len < 3)) {
+        if (!strncmp(ptr, "alt", 3)) {
+          shortcut[len++] = BX_KEY_ALT_L;
+          ptr += 3;
+        } else if (!strncmp(ptr, "ctrl", 4)) {
+          shortcut[len++] = BX_KEY_CTRL_L;
+          ptr += 4;
+        } else if (!strncmp(ptr, "del", 3)) {
+          shortcut[len++] = BX_KEY_DELETE;
+          ptr += 3;
+        } else if (!strncmp(ptr, "esc", 3)) {
+          shortcut[len++] = BX_KEY_ESC;
+          ptr += 3;
+        } else if (!strncmp(ptr, "f1", 2)) {
+          shortcut[len++] = BX_KEY_F1;
+          ptr += 2;
+        } else if (!strncmp(ptr, "f4", 2)) {
+          shortcut[len++] = BX_KEY_F4;
+          ptr += 2;
+        } else if (!strncmp(ptr, "tab", 3)) {
+          shortcut[len++] = BX_KEY_TAB;
+          ptr += 3;
+        } else if (!strncmp(ptr, "win", 3)) {
+          shortcut[len++] = BX_KEY_WIN_L;
+          ptr += 3;
+        } else if (!strncmp(ptr, "bksp", 4)) {
+          shortcut[len++] = BX_KEY_BACKSPACE;
+          ptr += 4;
+        } else {
+          BX_ERROR(("Unknown shortcut %s ignored", user_shortcut));
+          return;
+        }
       }
     }
     i = 0;