Bochs/bochs/gui/gui.cc
Bryce Denney 26385f2866 - I've added lots of comments in siminterface.h, and tried to clean up
the terminology a bit.  In particular, the term "gui" has started
  to mean different things in different contexts, so I've defined
  some more specific names for the parts of the user interface, and
  updated comments and some variable names to reflect it.  See
  siminterface.h for a more complete description of all of these.

    VGAW: VGA display window and toolbar buttons, the traditional Bochs
      display which is ported to X, win32, MacOS X, etc.  Implemented
      in gui/gui.* and platform dependent gui/*.cc files.
    CI: configuration interface that lets the user change settings such
      as floppy disk image, ne2k settings, log options.  The CI consists
      of two parts: configuration user interface (CUI) which does the
      actual rendering to the screen and handles key/mouse/menu events,
      and the siminterface object.
    CUI: configuration user interface.  This handles the user interactions
      that allow the user to configure Bochs.  To actually change any
      values it talks to the siminterface object.  One implementation of
      the CUI is the text-mode menus in gui/control.cc.  Another
      implementation is (will be) the wxWindows menus and dialogs in
      gui/wxmain.cc.
    siminterface: the glue between the CUI and the simulation code,
      accessible throughout the code by the global variable
        bx_simulator_interface_c *SIM;
      Among other things, siminterface methods allow the simulator to ask the
      CUI to display things or ask for user input, and allows the CUI
      to query and modify variables in the simulation code.


    GUI: Literally, "graphical user interface".  Until the configuration menus
      and wxWindows came along, everyone understood that "gui" referred to the
      VGA display window and the toolbar buttons because that's all there
      was.  Now that we have the wxWindows code, which implements both the VGAW
      and the CUI, while all other platforms implement only the VGAW, it's not
      so clear.  So, I'm trying to use VGAW, CI, and CUI consistently since
      they are more specific.
    control panel: This has been used as another name for the configuration
      interface.  "control panel" is also somewhat unspecific and it sounds
      like it would be graphical with buttons and sliders, but our text-mode
      thing is not graphical at all.  I've replaced "control panel" with
      "configuration interface" wherever I could find it.  In configure script,
      the --disable-control-panel option is still supported, but it politely
      suggests that you use --disable-config-interface instead.
- clean up comments in siminterface,wx* code
- add comments and examples for bx_param_* and BxEvents
- remove some obsolete stuff: notify_*_args,
  bx_simulator_interface_c::[sg]et_enabled() methods
- in siminterface.cc, move a few bx_real_sim_c methods to where they belong,
  with the rest of the methods.  No changes to the actual methods.
- remove some DOS ^M's which crept in and confused my editor.
2002-08-26 15:31:23 +00:00

484 lines
16 KiB
C++

/////////////////////////////////////////////////////////////////////////
// $Id: gui.cc,v 1.45 2002-08-26 15:31:20 bdenney Exp $
/////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2002 MandrakeSoft S.A.
//
// MandrakeSoft S.A.
// 43, rue d'Aboukir
// 75002 Paris - France
// http://www.linux-mandrake.com/
// http://www.mandrakesoft.com/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#include <signal.h>
#include "bochs.h"
#include "gui/bitmaps/floppya.h"
#include "gui/bitmaps/floppyb.h"
#include "gui/bitmaps/mouse.h"
#include "gui/bitmaps/reset.h"
#include "gui/bitmaps/power.h"
#include "gui/bitmaps/snapshot.h"
#include "gui/bitmaps/copy.h"
#include "gui/bitmaps/paste.h"
#include "gui/bitmaps/configbutton.h"
#include "gui/bitmaps/cdromd.h"
#include "gui/bitmaps/userbutton.h"
#if BX_WITH_MACOS
# include <Disks.h>
#endif
bx_gui_c bx_gui;
#define BX_GUI_THIS bx_gui.
#define LOG_THIS BX_GUI_THIS
bx_gui_c::bx_gui_c(void)
{
put("GUI"); // Init in specific_init
settype(GUILOG);
}
void
bx_gui_c::init(int argc, char **argv, unsigned tilewidth, unsigned tileheight)
{
specific_init(&bx_gui, argc, argv, tilewidth, tileheight, BX_HEADER_BAR_Y);
// Define some bitmaps to use in the headerbar
BX_GUI_THIS floppyA_bmap_id = create_bitmap(bx_floppya_bmap,
BX_FLOPPYA_BMAP_X, BX_FLOPPYA_BMAP_Y);
BX_GUI_THIS floppyA_eject_bmap_id = create_bitmap(bx_floppya_eject_bmap,
BX_FLOPPYA_BMAP_X, BX_FLOPPYA_BMAP_Y);
BX_GUI_THIS floppyB_bmap_id = create_bitmap(bx_floppyb_bmap,
BX_FLOPPYB_BMAP_X, BX_FLOPPYB_BMAP_Y);
BX_GUI_THIS floppyB_eject_bmap_id = create_bitmap(bx_floppyb_eject_bmap,
BX_FLOPPYB_BMAP_X, BX_FLOPPYB_BMAP_Y);
BX_GUI_THIS cdromD_bmap_id = create_bitmap(bx_cdromd_bmap,
BX_CDROMD_BMAP_X, BX_CDROMD_BMAP_Y);
BX_GUI_THIS cdromD_eject_bmap_id = create_bitmap(bx_cdromd_eject_bmap,
BX_CDROMD_BMAP_X, BX_CDROMD_BMAP_Y);
BX_GUI_THIS mouse_bmap_id = create_bitmap(bx_mouse_bmap,
BX_MOUSE_BMAP_X, BX_MOUSE_BMAP_Y);
BX_GUI_THIS nomouse_bmap_id = create_bitmap(bx_nomouse_bmap,
BX_MOUSE_BMAP_X, BX_MOUSE_BMAP_Y);
BX_GUI_THIS power_bmap_id = create_bitmap(bx_power_bmap, BX_POWER_BMAP_X, BX_POWER_BMAP_Y);
BX_GUI_THIS reset_bmap_id = create_bitmap(bx_reset_bmap, BX_RESET_BMAP_X, BX_RESET_BMAP_Y);
BX_GUI_THIS snapshot_bmap_id = create_bitmap(bx_snapshot_bmap, BX_SNAPSHOT_BMAP_X, BX_SNAPSHOT_BMAP_Y);
BX_GUI_THIS copy_bmap_id = create_bitmap(bx_copy_bmap, BX_COPY_BMAP_X, BX_COPY_BMAP_Y);
BX_GUI_THIS paste_bmap_id = create_bitmap(bx_paste_bmap, BX_PASTE_BMAP_X, BX_PASTE_BMAP_Y);
BX_GUI_THIS config_bmap_id = create_bitmap(bx_config_bmap, BX_CONFIG_BMAP_X, BX_CONFIG_BMAP_Y);
BX_GUI_THIS user_bmap_id = create_bitmap(bx_user_bmap, BX_USER_BMAP_X, BX_USER_BMAP_Y);
// Add the initial bitmaps to the headerbar, and enable callback routine, for use
// when that bitmap is clicked on
// Floppy A:
BX_GUI_THIS floppyA_status = bx_devices.floppy->get_media_status(0);
if (BX_GUI_THIS floppyA_status)
BX_GUI_THIS floppyA_hbar_id = headerbar_bitmap(BX_GUI_THIS floppyA_bmap_id,
BX_GRAVITY_LEFT, floppyA_handler);
else
BX_GUI_THIS floppyA_hbar_id = headerbar_bitmap(BX_GUI_THIS floppyA_eject_bmap_id,
BX_GRAVITY_LEFT, floppyA_handler);
// Floppy B:
BX_GUI_THIS floppyB_status = bx_devices.floppy->get_media_status(1);
if (BX_GUI_THIS floppyB_status)
BX_GUI_THIS floppyB_hbar_id = headerbar_bitmap(BX_GUI_THIS floppyB_bmap_id,
BX_GRAVITY_LEFT, floppyB_handler);
else
BX_GUI_THIS floppyB_hbar_id = headerbar_bitmap(BX_GUI_THIS floppyB_eject_bmap_id,
BX_GRAVITY_LEFT, floppyB_handler);
// CDROM
BX_GUI_THIS cdromD_status =
bx_devices.hard_drive->get_cd_media_status()
&& bx_options.cdromd.Opresent->get ();
if (BX_GUI_THIS cdromD_status)
BX_GUI_THIS cdromD_hbar_id = headerbar_bitmap(BX_GUI_THIS cdromD_bmap_id,
BX_GRAVITY_LEFT, cdromD_handler);
else
BX_GUI_THIS cdromD_hbar_id = headerbar_bitmap(BX_GUI_THIS cdromD_eject_bmap_id,
BX_GRAVITY_LEFT, cdromD_handler);
// Mouse button
if (bx_options.Omouse_enabled->get ())
BX_GUI_THIS mouse_hbar_id = headerbar_bitmap(BX_GUI_THIS mouse_bmap_id,
BX_GRAVITY_LEFT, toggle_mouse_enable);
else
BX_GUI_THIS mouse_hbar_id = headerbar_bitmap(BX_GUI_THIS nomouse_bmap_id,
BX_GRAVITY_LEFT, toggle_mouse_enable);
// These are the buttons on the right side. They are created in order
// of right to left.
// Power button
BX_GUI_THIS power_hbar_id = headerbar_bitmap(BX_GUI_THIS power_bmap_id,
BX_GRAVITY_RIGHT, power_handler);
// Reset button
BX_GUI_THIS reset_hbar_id = headerbar_bitmap(BX_GUI_THIS reset_bmap_id,
BX_GRAVITY_RIGHT, reset_handler);
// Configure button
BX_GUI_THIS config_hbar_id = headerbar_bitmap(BX_GUI_THIS config_bmap_id,
BX_GRAVITY_RIGHT, config_handler);
// Snapshot button
BX_GUI_THIS snapshot_hbar_id = headerbar_bitmap(BX_GUI_THIS snapshot_bmap_id,
BX_GRAVITY_RIGHT, snapshot_handler);
// Paste button
BX_GUI_THIS paste_hbar_id = headerbar_bitmap(BX_GUI_THIS paste_bmap_id,
BX_GRAVITY_RIGHT, paste_handler);
// Copy button
BX_GUI_THIS copy_hbar_id = headerbar_bitmap(BX_GUI_THIS copy_bmap_id,
BX_GRAVITY_RIGHT, copy_handler);
// User button
BX_GUI_THIS user_hbar_id = headerbar_bitmap(BX_GUI_THIS user_bmap_id,
BX_GRAVITY_RIGHT, userbutton_handler);
show_headerbar();
}
void
bx_gui_c::update_drive_status_buttons (void) {
BX_GUI_THIS floppyA_status =
bx_devices.floppy->get_media_status (0)
&& bx_options.floppya.Ostatus->get ();
BX_GUI_THIS floppyB_status =
bx_devices.floppy->get_media_status (1)
&& bx_options.floppyb.Ostatus->get ();
BX_GUI_THIS cdromD_status =
bx_devices.hard_drive->get_cd_media_status()
&& bx_options.cdromd.Opresent->get ();
if (BX_GUI_THIS floppyA_status)
replace_bitmap(BX_GUI_THIS floppyA_hbar_id, BX_GUI_THIS floppyA_bmap_id);
else {
#if BX_WITH_MACOS
// If we are using the Mac floppy driver, eject the disk
// from the floppy drive. This doesn't work in MacOS X.
if (!strcmp(bx_options.floppya.Opath->get (), SuperDrive))
DiskEject(1);
#endif
replace_bitmap(BX_GUI_THIS floppyA_hbar_id, BX_GUI_THIS floppyA_eject_bmap_id);
}
if (BX_GUI_THIS floppyB_status)
replace_bitmap(BX_GUI_THIS floppyB_hbar_id, BX_GUI_THIS floppyB_bmap_id);
else {
#if BX_WITH_MACOS
// If we are using the Mac floppy driver, eject the disk
// from the floppy drive. This doesn't work in MacOS X.
if (!strcmp(bx_options.floppyb.Opath->get (), SuperDrive))
DiskEject(1);
#endif
replace_bitmap(BX_GUI_THIS floppyB_hbar_id, BX_GUI_THIS floppyB_eject_bmap_id);
}
if (BX_GUI_THIS cdromD_status)
replace_bitmap(BX_GUI_THIS cdromD_hbar_id, BX_GUI_THIS cdromD_bmap_id);
else {
replace_bitmap(BX_GUI_THIS cdromD_hbar_id, BX_GUI_THIS cdromD_eject_bmap_id);
}
}
void
bx_gui_c::floppyA_handler(void)
{
#if BX_WITH_WX
// instead of just toggling the status, call wxWindows to bring up
// a dialog asking what disk image you want to switch to.
int ret = SIM->ask_param (BXP_FLOPPYA_PATH);
if (ret < 0) return; // cancelled
// eject and then insert the disk. If the new path is invalid,
// the status will return 0.
unsigned new_status = bx_devices.floppy->set_media_status(0, 0);
printf ("eject disk, new_status is %d\n", new_status);
new_status = bx_devices.floppy->set_media_status(0, 1);
printf ("insert disk, new_status is %d\n", new_status);
fflush (stdout);
BX_GUI_THIS floppyA_status = new_status;
#else
BX_GUI_THIS floppyA_status = !BX_GUI_THIS floppyA_status;
bx_devices.floppy->set_media_status(0, BX_GUI_THIS floppyA_status);
#endif
BX_GUI_THIS update_drive_status_buttons ();
}
void
bx_gui_c::floppyB_handler(void)
{
#if BX_WITH_WX
// instead of just toggling the status, call wxWindows to bring up
// a dialog asking what disk image you want to switch to.
int ret = SIM->ask_param (BXP_FLOPPYB_PATH);
if (ret < 0) return; // cancelled
// eject and then insert the disk. If the new path is invalid,
// the status will return 0.
unsigned new_status = bx_devices.floppy->set_media_status(1, 0);
printf ("eject disk, new_status is %d\n", new_status);
new_status = bx_devices.floppy->set_media_status(1, 1);
printf ("insert disk, new_status is %d\n", new_status);
fflush (stdout);
BX_GUI_THIS floppyB_status = new_status;
#else
BX_GUI_THIS floppyB_status = !BX_GUI_THIS floppyB_status;
bx_devices.floppy->set_media_status(1, BX_GUI_THIS floppyB_status);
#endif
BX_GUI_THIS update_drive_status_buttons ();
}
void
bx_gui_c::cdromD_handler(void)
{
#if BX_WITH_WX
// instead of just toggling the status, call wxWindows to bring up
// a dialog asking what disk image you want to switch to.
int ret = SIM->ask_param (BXP_CDROM_PATH);
if (ret < 0) return; // cancelled
// eject and then insert the disk. If the new path is invalid,
// the status will return 0.
unsigned status = bx_devices.hard_drive->set_cd_media_status(0);
printf ("eject disk, new_status is %d\n", status);
status = bx_devices.hard_drive->set_cd_media_status(1);
printf ("insert disk, new_status is %d\n", status);
fflush (stdout);
BX_GUI_THIS cdromD_status = status;
#else
BX_GUI_THIS cdromD_status =
bx_devices.hard_drive->set_cd_media_status(!BX_GUI_THIS cdromD_status);
#endif
BX_GUI_THIS update_drive_status_buttons ();
}
void
bx_gui_c::reset_handler(void)
{
BX_INFO(( "system RESET callback." ));
bx_pc_system.ResetSignal( PCS_SET ); /* XXX is this right? */
for (int i=0; i<BX_SMP_PROCESSORS; i++)
BX_CPU(i)->reset(BX_RESET_HARDWARE);
}
void
bx_gui_c::power_handler(void)
{
// the user pressed power button, so there's no doubt they want bochs
// to quit. Change panics to fatal for the GUI and then do a panic.
LOG_THIS setonoff(LOGLEV_PANIC, ACT_FATAL);
BX_PANIC (("POWER button turned off."));
// shouldn't reach this point, but if you do, QUIT!!!
fprintf (stderr, "Bochs is exiting because you pressed the power button.\n");
BX_EXIT (1);
}
Bit32s
bx_gui_c::make_text_snapshot (char **snapshot, Bit32u *length)
{
Bit8u* raw_snap = NULL;
char *clean_snap;
unsigned line_addr, txt_addr, txHeight, txWidth;
bx_vga.get_text_snapshot(&raw_snap, &txHeight, &txWidth);
if (txHeight <= 0) return -1;
clean_snap = (char*) malloc(txHeight*(txWidth+2)+1);
txt_addr = 0;
for (unsigned i=0; i<txHeight; i++) {
line_addr = i * txWidth * 2;
for (unsigned j=0; j<(txWidth*2); j+=2) {
clean_snap[txt_addr] = raw_snap[line_addr+j];
txt_addr++;
}
#ifdef WIN32
clean_snap[txt_addr] = 13;
txt_addr++;
#endif
clean_snap[txt_addr] = 10;
txt_addr++;
}
clean_snap[txt_addr] = 0;
*snapshot = clean_snap;
*length = txt_addr;
return 0;
}
// create a text snapshot and copy to the system clipboard. On guis that
// we haven't figured out how to support yet, dump to a file instead.
void
bx_gui_c::copy_handler(void)
{
Bit32u len;
char *text_snapshot;
if (make_text_snapshot (&text_snapshot, &len) < 0) {
BX_INFO(( "copy button failed, mode not implemented"));
return;
}
if (!set_clipboard_text(text_snapshot, len)) {
// platform specific code failed, use portable code instead
FILE *fp = fopen("copy.txt", "w");
fwrite(text_snapshot, 1, strlen(text_snapshot), fp);
fclose(fp);
}
free(text_snapshot);
}
// create a text snapshot and dump it to a file
void
bx_gui_c::snapshot_handler(void)
{
char *text_snapshot;
Bit32u len;
int flag;
if (make_text_snapshot (&text_snapshot, &len) < 0) {
BX_ERROR(( "snapshot button failed, mode not implemented"));
return;
}
//FIXME
char filename[BX_PATHNAME_LEN];
#if BX_WITH_WX
int ret = SIM->ask_filename (filename, sizeof(filename),
"Save snapshot as...", "snapshot.txt",
bx_param_string_c::BX_SAVE_FILE_DIALOG);
if (ret < 0) return; // cancelled
#else
strcpy (filename, "snapshot.txt");
#endif
FILE *fp = fopen(filename, "w");
fwrite(text_snapshot, 1, strlen(text_snapshot), fp);
fclose(fp);
free(text_snapshot);
}
// Read ASCII chars from the system clipboard and paste them into bochs.
// Note that paste cannot work with the key mapping tables loaded.
void
bx_gui_c::paste_handler(void)
{
Bit32s nbytes;
Bit8u *bytes;
if (!bx_keymap.isKeymapLoaded ()) {
BX_ERROR (("keyboard_mapping disabled, so paste cannot work"));
return;
}
if (!get_clipboard_text(&bytes, &nbytes)) {
BX_ERROR (("paste not implemented on this platform"));
return;
}
BX_INFO (("pasting %d bytes", nbytes));
bx_devices.keyboard->paste_bytes (bytes, nbytes);
}
void
bx_gui_c::config_handler(void)
{
#if BX_USE_CONFIG_INTERFACE && !BX_WITH_WX
bx_config_interface (BX_CI_RUNTIME);
#else
BX_ERROR(( "# CONFIG callback (unimplemented)." ));
#endif
}
void
bx_gui_c::toggle_mouse_enable(void)
{
int old = bx_options.Omouse_enabled->get ();
BX_DEBUG (("toggle mouse_enabled, now %d", !old));
bx_options.Omouse_enabled->set (!old);
}
void
bx_gui_c::userbutton_handler(void)
{
unsigned shortcut[4];
char *user_shortcut;
int i, len;
len = 0;
#if BX_WITH_WX
int ret = SIM->ask_param (BXP_USER_SHORTCUT);
user_shortcut = bx_options.Ouser_shortcut->getptr();
if ((ret > 0) && user_shortcut[0] && (strcmp(user_shortcut, "none"))) {
#else
user_shortcut = bx_options.Ouser_shortcut->getptr();
if (user_shortcut[0] && (strcmp(user_shortcut, "none"))) {
#endif
if (!strcmp(user_shortcut, "ctrlaltdel")) {
shortcut[0] = BX_KEY_CTRL_L;
shortcut[1] = BX_KEY_ALT_L;
shortcut[2] = BX_KEY_DELETE;
len = 3;
}
else if (!strcmp(user_shortcut, "ctrlaltesc")) {
shortcut[0] = BX_KEY_CTRL_L;
shortcut[1] = BX_KEY_ALT_L;
shortcut[2] = BX_KEY_ESC;
len = 3;
}
else if (!strcmp(user_shortcut, "ctrlaltf1")) {
shortcut[0] = BX_KEY_CTRL_L;
shortcut[1] = BX_KEY_ALT_L;
shortcut[2] = BX_KEY_F1;
len = 3;
}
else if (!strcmp(user_shortcut, "alttab")) {
shortcut[0] = BX_KEY_ALT_L;
shortcut[1] = BX_KEY_TAB;
len = 2;
}
else {
BX_ERROR(("Unknown shortcut %s ignored", user_shortcut));
}
i = 0;
while (i < len) {
bx_devices.keyboard->gen_scancode(shortcut[i++]);
}
i--;
while (i >= 0) {
bx_devices.keyboard->gen_scancode(shortcut[i--] | BX_KEY_RELEASED);
}
}
}
void
bx_gui_c::mouse_enabled_changed (Boolean val)
{
// This is only called when SIM->get_init_done is 1. Note that VAL
// is the new value of mouse_enabled, which may not match the old
// value which is still in bx_options.Omouse_enabled->get ().
BX_DEBUG (("replacing the mouse bitmaps"));
if (val)
replace_bitmap(BX_GUI_THIS mouse_hbar_id, BX_GUI_THIS mouse_bmap_id);
else
replace_bitmap(BX_GUI_THIS mouse_hbar_id, BX_GUI_THIS nomouse_bmap_id);
// give the GUI a chance to respond to the event. Most guis will hide
// the native mouse cursor and do something to trap the mouse inside the
// bochs VGA display window.
mouse_enabled_changed_specific (val);
}
void
bx_gui_c::init_signal_handlers ()
{
#if BX_GUI_SIGHANDLER
Bit32u mask = get_sighandler_mask ();
for (Bit32u sig=0; sig<32; sig++)
{
if (mask & (1<<sig))
signal (sig, bx_signal_handler);
}
#endif
}