4 * Core GTK-based user interface
6 * Copyright (c) 2005 Nathan Keynes.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
22 #include <glib/gi18n.h>
23 #include <gtk/gtkversion.h>
24 #include "dreamcast.h"
26 #include "gdrom/gdrom.h"
27 #include "gtkui/gtkui.h"
29 /* Base GUI clock is 10ms */
30 #define GUI_TICK_PERIOD 10000000
32 void gtk_gui_start( void );
33 void gtk_gui_stop( void );
34 void gtk_gui_alloc_resources ( void );
35 uint32_t gtk_gui_run_slice( uint32_t nanosecs );
37 struct dreamcast_module gtk_gui_module = { "gui", NULL,
45 * Single-instance windows (at most one)
47 static main_window_t main_win = NULL;
48 static debug_window_t debug_win = NULL;
49 static mmio_window_t mmio_win = NULL;
52 * UIManager and action helpers
54 static GtkUIManager *global_ui_manager;
55 static GtkActionGroup *global_action_group;
58 * Count of running nanoseconds - used to cut back on the GUI runtime
60 static uint32_t gtk_gui_nanos = 0;
61 static uint32_t gtk_gui_ticks = 0;
62 static struct timeval gtk_gui_lasttv;
64 static gboolean gtk_gui_init_ok = FALSE;
66 #define ENABLE_ACTION(win,name) SET_ACTION_ENABLED(win,name,TRUE)
67 #define DISABLE_ACTION(win,name) SET_ACTION_ENABLED(win,name,FALSE)
70 static const GtkActionEntry ui_actions[] = {
71 { "FileMenu", NULL, N_("_File") },
72 { "SettingsMenu", NULL, N_("_Settings") },
73 { "HelpMenu", NULL, N_("_Help") },
74 { "LoadBinary", NULL, N_("Load _Binary..."), NULL, N_("Load and run a program binary"), G_CALLBACK(load_binary_action_callback) },
75 { "Reset", GTK_STOCK_REFRESH, N_("_Reset"), "<control>R", N_("Reset dreamcast"), G_CALLBACK(reset_action_callback) },
76 { "Pause", GTK_STOCK_MEDIA_PAUSE, N_("_Pause"), NULL, N_("Pause dreamcast"), G_CALLBACK(pause_action_callback) },
77 { "Run", GTK_STOCK_MEDIA_PLAY, N_("Resume"), NULL, N_("Resume"), G_CALLBACK(resume_action_callback) },
78 { "LoadState", GTK_STOCK_REVERT_TO_SAVED, N_("_Load state..."), "F4", N_("Load an lxdream save state"), G_CALLBACK(load_state_action_callback) },
79 { "SaveState", GTK_STOCK_SAVE_AS, N_("_Save state..."), "F3", N_("Create an lxdream save state"), G_CALLBACK(save_state_action_callback) },
80 { "Exit", GTK_STOCK_QUIT, N_("E_xit"), NULL, N_("Exit lxdream"), G_CALLBACK(exit_action_callback) },
81 { "GdromSettings", NULL, N_("_GD-Rom...") },
82 { "GdromUnmount", NULL, N_("_Empty") },
83 { "GdromMount", GTK_STOCK_CDROM, N_("_Open Image..."), "<control>O", N_("Mount a cdrom disc"), G_CALLBACK(mount_action_callback) },
84 { "PathSettings", NULL, N_("_Paths..."), NULL, N_("Configure files and paths"), G_CALLBACK(path_settings_callback) },
85 { "AudioSettings", NULL, N_("_Audio..."), NULL, N_("Configure audio output"), G_CALLBACK(audio_settings_callback) },
86 { "ControllerSettings", NULL, N_("_Controllers..."), NULL, N_("Configure controllers"), G_CALLBACK(maple_settings_callback) },
87 { "NetworkSettings", NULL, N_("_Network..."), NULL, N_("Configure network settings"), G_CALLBACK(network_settings_callback) },
88 { "VideoSettings", NULL, N_("_Video..."), NULL,N_( "Configure video output"), G_CALLBACK(video_settings_callback) },
89 { "About", GTK_STOCK_ABOUT, N_("_About..."), NULL, N_("About lxdream"), G_CALLBACK(about_action_callback) },
90 { "DebugMenu", NULL, N_("_Debug") },
91 { "Debugger", NULL, N_("_Debugger"), NULL, N_("Open debugger window"), G_CALLBACK(debugger_action_callback) },
92 { "DebugMem", NULL, N_("View _Memory"), NULL, N_("View memory dump"), G_CALLBACK(debug_memory_action_callback) },
93 { "DebugMmio", NULL, N_("View IO _Registers"), NULL, N_("View MMIO Registers"), G_CALLBACK(debug_mmio_action_callback) },
94 { "SaveScene", NULL, N_("_Save Scene"), NULL, N_("Save next rendered scene"), G_CALLBACK(save_scene_action_callback) },
95 { "SingleStep", GTK_STOCK_REDO, N_("_Single Step"), NULL, N_("Single step"), G_CALLBACK(debug_step_action_callback) },
96 { "RunTo", GTK_STOCK_GOTO_LAST, N_("Run _To"), NULL, N_("Run to"), G_CALLBACK( debug_runto_action_callback) },
97 { "SetBreakpoint", GTK_STOCK_CLOSE, N_("_Breakpoint"), NULL, N_("Toggle breakpoint"), G_CALLBACK( debug_breakpoint_action_callback) }
99 static const GtkToggleActionEntry ui_toggle_actions[] = {
100 { "FullScreen", NULL, "_Full Screen", "<alt>Return", "Toggle full screen video", G_CALLBACK(fullscreen_toggle_callback), 0 },
103 // Menus and toolbars
104 static const char *ui_description =
106 " <menubar name='MainMenu'>"
107 " <menu action='FileMenu'>"
108 " <menuitem action='LoadBinary'/>"
109 " <menuitem action='GdromSettings'/>"
111 " <menuitem action='Reset'/>"
112 " <menuitem action='Pause'/>"
113 " <menuitem action='Run'/>"
114 " <menuitem action='Debugger'/>"
116 " <menuitem action='LoadState'/>"
117 " <menuitem action='SaveState'/>"
119 " <menuitem action='Exit'/>"
121 " <menu action='SettingsMenu'>"
122 " <menuitem action='PathSettings'/>"
123 " <menuitem action='AudioSettings'/>"
124 " <menuitem action='ControllerSettings'/>"
125 " <menuitem action='NetworkSettings'/>"
126 " <menuitem action='VideoSettings'/>"
128 " <menuitem action='FullScreen'/>"
130 " <menu action='HelpMenu'>"
131 " <menuitem action='About'/>"
134 " <toolbar name='MainToolbar'>"
135 " <toolitem action='GdromMount'/>"
136 " <toolitem action='Reset'/>"
137 " <toolitem action='Pause'/>"
138 " <toolitem action='Run'/>"
140 " <toolitem action='LoadState'/>"
141 " <toolitem action='SaveState'/>"
143 " <menubar name='DebugMenu'>"
144 " <menu action='FileMenu'>"
145 " <menuitem action='GdromSettings'/>"
147 " <menuitem action='Reset'/>"
149 " <menuitem action='LoadState'/>"
150 " <menuitem action='SaveState'/>"
152 " <menuitem action='Exit'/>"
154 " <menu action='DebugMenu'>"
155 " <menuitem action='DebugMem'/>"
156 " <menuitem action='DebugMmio'/>"
157 " <menuitem action='SaveScene'/>"
159 " <menuitem action='SetBreakpoint'/>"
160 " <menuitem action='Pause'/>"
161 " <menuitem action='SingleStep'/>"
162 " <menuitem action='RunTo'/>"
163 " <menuitem action='Run'/>"
165 " <menu action='SettingsMenu'>"
166 " <menuitem action='PathSettings'/>"
167 " <menuitem action='AudioSettings'/>"
168 " <menuitem action='ControllerSettings'/>"
169 " <menuitem action='NetworkSettings'/>"
170 " <menuitem action='VideoSettings'/>"
172 " <menuitem action='FullScreen'/>"
174 " <menu action='HelpMenu'>"
175 " <menuitem action='About'/>"
178 " <toolbar name='DebugToolbar'>"
179 " <toolitem action='GdromMount'/>"
180 " <toolitem action='Reset'/>"
181 " <toolitem action='Pause'/>"
183 " <toolitem action='SingleStep'/>"
184 " <toolitem action='RunTo'/>"
185 " <toolitem action='Run'/>"
186 " <toolitem action='SetBreakpoint'/>"
188 " <toolitem action='LoadState'/>"
189 " <toolitem action='SaveState'/>"
193 gboolean gui_parse_cmdline( int *argc, char **argv[] )
195 gtk_gui_init_ok = gtk_init_check( argc, argv );
196 return gtk_gui_init_ok;
199 gboolean gui_init( gboolean withDebug )
201 if( gtk_gui_init_ok ) {
202 GError *error = NULL;
203 dreamcast_register_module( >k_gui_module );
204 gtk_gui_alloc_resources();
206 global_action_group = gtk_action_group_new("MenuActions");
207 gtk_action_group_set_translation_domain( global_action_group, NULL );
208 gtk_action_group_add_actions( global_action_group, ui_actions, G_N_ELEMENTS(ui_actions), NULL );
209 gtk_action_group_add_toggle_actions( global_action_group, ui_toggle_actions, G_N_ELEMENTS(ui_toggle_actions), NULL );
210 gtk_gui_enable_action("AudioSettings", FALSE);
211 gtk_gui_enable_action("NetworkSettings", FALSE);
212 gtk_gui_enable_action("VideoSettings", FALSE);
214 global_ui_manager = gtk_ui_manager_new();
215 gtk_ui_manager_set_add_tearoffs(global_ui_manager, TRUE);
216 gtk_ui_manager_insert_action_group( global_ui_manager, global_action_group, 0 );
218 if (!gtk_ui_manager_add_ui_from_string (global_ui_manager, ui_description, -1, &error)) {
219 g_message ("building menus failed: %s", error->message);
220 g_error_free (error);
223 GtkAccelGroup *accel_group = gtk_ui_manager_get_accel_group (global_ui_manager);
224 GtkWidget *menubar = gtk_ui_manager_get_widget(global_ui_manager, "/MainMenu");
225 GtkWidget *toolbar = gtk_ui_manager_get_widget(global_ui_manager, "/MainToolbar");
227 GtkWidget *gdrommenuitem = gtk_ui_manager_get_widget(global_ui_manager, "/MainMenu/FileMenu/GdromSettings");
229 GtkWidget *gdrommenu = gdrom_menu_new();
230 gtk_menu_item_set_submenu( GTK_MENU_ITEM(gdrommenuitem), gdrommenu );
231 main_win = main_window_new( APP_NAME " " APP_VERSION, menubar, toolbar, accel_group );
232 main_window_set_use_grab(main_win, TRUE);
234 gtk_gui_show_debugger();
243 void gui_main_loop(void)
249 void gui_update_state(void)
254 gboolean gui_error_dialog( const char *msg, ... )
256 if( main_win != NULL ) {
259 gtk_message_dialog_new( main_window_get_frame(main_win), GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,
260 GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, NULL );
262 gchar *markup = g_markup_vprintf_escaped( msg, args );
264 gtk_message_dialog_set_markup( GTK_MESSAGE_DIALOG(dialog), markup );
266 gtk_dialog_run(GTK_DIALOG(dialog));
267 gtk_widget_destroy(dialog);
273 void gui_update_io_activity( io_activity_type io, gboolean active )
278 void gtk_gui_show_debugger()
281 debug_window_show(debug_win, TRUE);
283 GtkAccelGroup *accel_group = gtk_ui_manager_get_accel_group (global_ui_manager);
284 GtkWidget *menubar = gtk_ui_manager_get_widget(global_ui_manager, "/DebugMenu");
285 GtkWidget *toolbar = gtk_ui_manager_get_widget(global_ui_manager, "/DebugToolbar");
286 GtkWidget *gdrommenuitem = gtk_ui_manager_get_widget(global_ui_manager, "/DebugMenu/FileMenu/GdromSettings");
287 GtkWidget *gdrommenu = gdrom_menu_new();
288 gtk_menu_item_set_submenu( GTK_MENU_ITEM(gdrommenuitem), gdrommenu );
289 gchar *title = g_strdup_printf( APP_NAME " " APP_VERSION " :: %s", _("Debugger"));
290 debug_win = debug_window_new( title, menubar, toolbar, accel_group );
295 void gtk_gui_show_mmio()
298 mmio_window_show(mmio_win, TRUE);
300 gchar *title = g_strdup_printf( APP_NAME " " APP_VERSION " :: %s", _("MMIO Registers"));
301 mmio_win = mmio_window_new( title );
307 main_window_t gtk_gui_get_main()
312 debug_window_t gtk_gui_get_debugger()
317 mmio_window_t gtk_gui_get_mmio()
322 GtkWidget *gtk_gui_get_renderarea()
324 if( main_win == NULL ) {
327 return main_window_get_renderarea(main_win);
332 * Hook called when DC starts running. Just disables the run/step buttons
333 * and enables the stop button.
335 void gtk_gui_start( void )
337 main_window_set_running( main_win, TRUE );
338 if( debug_win != NULL ) {
339 debug_window_set_running( debug_win, TRUE );
342 gettimeofday(>k_gui_lasttv,NULL);
346 * Hook called when DC stops running. Enables the run/step buttons
347 * and disables the stop button.
349 void gtk_gui_stop( void )
351 main_window_set_running( main_win, FALSE );
355 void gtk_gui_update( void )
357 if( global_action_group ) {
358 gtk_gui_enable_action("Run", dreamcast_can_run() && !dreamcast_is_running() );
359 gtk_gui_enable_action("Pause", dreamcast_is_running() );
362 debug_window_set_running( debug_win, FALSE );
363 debug_window_update(debug_win);
366 mmio_window_update(mmio_win);
368 dump_window_update_all();
372 * Module run-slice. Run the event loop 100 times/second (doesn't really need to be
373 * any more often than this), and update the speed display 10 times/second.
375 * Also detect if we're running too fast here and yield for a bit
377 uint32_t gtk_gui_run_slice( uint32_t nanosecs )
379 gtk_gui_nanos += nanosecs;
380 if( gtk_gui_nanos > GUI_TICK_PERIOD ) { /* 10 ms */
381 gtk_gui_nanos -= GUI_TICK_PERIOD;
383 uint32_t current_period = gtk_gui_ticks * GUI_TICK_PERIOD;
385 // Run the event loop
386 while( gtk_events_pending() )
387 gtk_main_iteration();
390 gettimeofday(&tv,NULL);
391 uint32_t ns = ((tv.tv_sec - gtk_gui_lasttv.tv_sec) * 1000000000) +
392 (tv.tv_usec - gtk_gui_lasttv.tv_usec)*1000;
393 if( (ns * 1.05) < current_period ) {
394 // We've gotten ahead - sleep for a little bit
397 tv.tv_nsec = current_period - ns;
401 /* Update the display every 10 ticks (ie 10 times a second) and
402 * save the current tv value */
403 if( gtk_gui_ticks > 10 ) {
406 double speed = (float)( (double)current_period * 100.0 / ns );
407 gtk_gui_lasttv.tv_sec = tv.tv_sec;
408 gtk_gui_lasttv.tv_usec = tv.tv_usec;
409 main_window_set_speed( main_win, speed );
416 PangoFontDescription *gui_fixed_font;
417 GdkColor gui_colour_normal, gui_colour_changed, gui_colour_error;
418 GdkColor gui_colour_warn, gui_colour_pc, gui_colour_debug;
419 GdkColor gui_colour_trace, gui_colour_break, gui_colour_temp_break;
420 GdkColor gui_colour_white;
422 void gtk_gui_alloc_resources() {
425 gui_colour_normal.red = gui_colour_normal.green = gui_colour_normal.blue = 0;
426 gui_colour_changed.red = gui_colour_changed.green = 64*256;
427 gui_colour_changed.blue = 154*256;
428 gui_colour_error.red = 65535;
429 gui_colour_error.green = gui_colour_error.blue = 64*256;
430 gui_colour_pc.red = 32*256;
431 gui_colour_pc.green = 170*256;
432 gui_colour_pc.blue = 52*256;
433 gui_colour_warn = gui_colour_changed;
434 gui_colour_trace.red = 156*256;
435 gui_colour_trace.green = 78*256;
436 gui_colour_trace.blue = 201*256;
437 gui_colour_debug = gui_colour_pc;
438 gui_colour_break.red = 65535;
439 gui_colour_break.green = gui_colour_break.blue = 192*256;
440 gui_colour_temp_break.red = gui_colour_temp_break.green = 128*256;
441 gui_colour_temp_break.blue = 32*256;
442 gui_colour_white.red = gui_colour_white.green = gui_colour_white.blue = 65535;
444 map = gdk_colormap_new(gdk_visual_get_best(), TRUE);
445 gdk_colormap_alloc_color(map, &gui_colour_normal, TRUE, TRUE);
446 gdk_colormap_alloc_color(map, &gui_colour_changed, TRUE, TRUE);
447 gdk_colormap_alloc_color(map, &gui_colour_error, TRUE, TRUE);
448 gdk_colormap_alloc_color(map, &gui_colour_warn, TRUE, TRUE);
449 gdk_colormap_alloc_color(map, &gui_colour_pc, TRUE, TRUE);
450 gdk_colormap_alloc_color(map, &gui_colour_debug, TRUE, TRUE);
451 gdk_colormap_alloc_color(map, &gui_colour_trace, TRUE, TRUE);
452 gdk_colormap_alloc_color(map, &gui_colour_break, TRUE, TRUE);
453 gdk_colormap_alloc_color(map, &gui_colour_temp_break, TRUE, TRUE);
454 gdk_colormap_alloc_color(map, &gui_colour_white, TRUE, TRUE);
455 gui_fixed_font = pango_font_description_from_string("Courier 10");
458 gint gtk_gui_run_property_dialog( const gchar *title, GtkWidget *panel, gtk_dialog_done_fn fn )
461 gtk_dialog_new_with_buttons(title, main_window_get_frame(main_win),
462 GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,
463 GTK_STOCK_OK, GTK_RESPONSE_ACCEPT,
464 GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
467 gtk_widget_show_all(panel);
468 gtk_container_add( GTK_CONTAINER(GTK_DIALOG(dialog)->vbox), panel );
469 result = gtk_dialog_run( GTK_DIALOG(dialog) );
471 fn(panel, result == GTK_RESPONSE_ACCEPT);
473 gtk_widget_destroy( dialog );
477 void gtk_gui_enable_action( const gchar *action, gboolean enable )
479 gtk_action_set_sensitive( gtk_action_group_get_action( global_action_group, action), enable);
482 static void delete_frame_buffer( guchar *pixels, gpointer buffer )
484 if( buffer != NULL ) {
489 GdkPixbuf *gdk_pixbuf_new_from_frame_buffer( frame_buffer_t buffer )
491 return gdk_pixbuf_new_from_data( (unsigned char *)buffer->data,
493 (buffer->colour_format == COLFMT_BGRA8888),
503 * Extract the keyval of the key event if no modifier keys were pressed -
504 * in other words get the keyval of the key by itself. The other way around
505 * would be to use the hardware keysyms directly rather than the keyvals,
506 * but the mapping looks to be messier.
508 uint16_t gtk_get_unmodified_keyval( GdkEventKey *event )
510 GdkKeymap *keymap = gdk_keymap_get_default();
513 gdk_keymap_translate_keyboard_state( keymap, event->hardware_keycode, 0, 0, &keyval,
518 /************* X11-specificness **********/
519 #include <gdk/gdkx.h>
521 guint gdk_keycode_to_modifier( GdkDisplay *display, guint keycode )
525 Display *xdisplay = GDK_DISPLAY_XDISPLAY (display);
526 XModifierKeymap *keymap = XGetModifierMapping( xdisplay );
527 for( i=0; i<8*keymap->max_keypermod; i++ ) {
528 if( keymap->modifiermap[i] == keycode ) {
529 result = 1 << (i/keymap->max_keypermod);
533 XFreeModifiermap(keymap);
537 #if !(GTK_CHECK_VERSION(2,8,0))
538 /* gdk_display_warp_pointer was added in GTK 2.8. If we're using an earlier
539 * version, include the code here. (Can't just set the dependency on 2.8 as
540 * it still hasn't been ported to OSX...) Original copyright statement belo
543 /* GDK - The GIMP Drawing Kit
544 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
546 * This library is free software; you can redistribute it and/or
547 * modify it under the terms of the GNU Lesser General Public
548 * License as published by the Free Software Foundation; either
549 * version 2 of the License, or (at your option) any later version.
551 * This library is distributed in the hope that it will be useful,
552 * but WITHOUT ANY WARRANTY; without even the implied warranty of
553 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
554 * Lesser General Public License for more details.
556 * You should have received a copy of the GNU Lesser General Public
557 * License along with this library; if not, write to the
558 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
559 * Boston, MA 02111-1307, USA.
563 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
564 * file for a list of people on the GTK+ Team. See the ChangeLog
565 * files for a list of changes. These files are distributed with
566 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
568 void gdk_display_warp_pointer (GdkDisplay *display,
576 xdisplay = GDK_DISPLAY_XDISPLAY (display);
577 dest = GDK_WINDOW_XWINDOW (gdk_screen_get_root_window (screen));
579 XWarpPointer (xdisplay, None, dest, 0, 0, 0, 0, x, y);
.