zipped rom support in GUI
[drnoksnes] / gui / plugin.c
1 /*
2 * This file is part of DrNokSnes
3 *
4 * Copyright (C) 2005 INdT - Instituto Nokia de Tecnologia
5 * http://www.indt.org/maemo
6 * Copyright (C) 2009 Javier S. Pedro <maemo@javispedro.com>
7 *
8 * This software is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 2.1 of
11 * the License, or (at your option) any later version.
12 *
13 * This software is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this software; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 *
23 */
24
25 #include <stdio.h>
26 #include <string.h>
27 #include <gtk/gtk.h>
28 #include <startup_plugin.h>
29 #include <gconf/gconf.h>
30 #include <gconf/gconf-client.h>
31 #include <hildon/hildon-file-chooser-dialog.h>
32 #include <hildon/hildon-note.h>
33 #include <hildon/hildon-defines.h>
34
35 #if MAEMO_VERSION >= 5
36 #include <hildon/hildon-button.h>
37 #include <hildon/hildon-check-button.h>
38 #include <hildon/hildon-picker-button.h>
39 #include <hildon/hildon-touch-selector.h>
40 #include <hildon/hildon-gtk.h>
41 #else
42 #include <hildon/hildon-caption.h>
43 #endif
44
45 #include "../platform/hgw.h"
46 #include "plugin.h"
47
48 static GtkWidget * load_plugin(void);
49 static void unload_plugin(void);
50 static void write_config(void);
51 static GtkWidget ** load_menu(guint *);
52 static void update_menu(void);
53 static void plugin_callback(GtkWidget * menu_item, gpointer data);
54
55 GConfClient * gcc = NULL;
56 static GameStartupInfo gs;
57 static GtkWidget * menu_items[4];
58
59 static StartupPluginInfo plugin_info = {
60         load_plugin,
61         unload_plugin,
62         write_config,
63         load_menu,
64         update_menu,
65         plugin_callback
66 };
67
68 STARTUP_INIT_PLUGIN(plugin_info, gs, FALSE, TRUE)
69
70 gchar* current_rom_file = 0;
71 gboolean current_rom_file_exists = FALSE;
72
73 #if MAEMO_VERSION >= 5
74 static HildonButton* select_rom_btn;
75 static HildonCheckButton* sound_check;
76 static HildonPickerButton* framerate_picker;
77 static HildonCheckButton* display_fps_check;
78 static HildonCheckButton* turbo_check;
79 // speedhacks=no and accuracy=yes in fremantle
80 #else
81 static GtkButton* select_rom_btn;
82 static GtkLabel* rom_label;
83 static GtkCheckButton* sound_check;
84 static GtkCheckButton* turbo_check;
85 static GtkComboBox* framerate_combo;
86 static GtkCheckButton* accu_check;
87 static GtkCheckButton* display_fps_check;
88 static GtkComboBox* speedhacks_combo;
89 #endif
90
91 static inline void set_rom_label(gchar * text)
92 {
93 #if MAEMO_VERSION >= 5
94         hildon_button_set_value(select_rom_btn, text);
95 #else
96         gtk_label_set_text(GTK_LABEL(rom_label), text);
97 #endif
98 }
99
100 static void set_rom(const char * rom_file)
101 {
102         if (current_rom_file) g_free(current_rom_file);
103         if (!rom_file || strlen(rom_file) == 0) {
104                 current_rom_file = NULL;
105                 set_rom_label("<no rom selected>");
106                 return;
107         }
108
109         current_rom_file = g_strdup(rom_file);
110
111         gchar * utf8_filename = g_filename_display_basename(rom_file);
112         set_rom_label(utf8_filename);
113         g_free(utf8_filename);
114
115         current_rom_file_exists = g_file_test(current_rom_file,
116                 G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR);
117
118         game_state_update();
119         save_clear();
120 }
121
122 static inline GtkWindow* get_parent_window() {
123         return GTK_WINDOW(gs.ui->hildon_appview);
124 }
125
126 static void select_rom_callback(GtkWidget * button, gpointer data)
127 {
128         GtkWidget * dialog;
129         GtkFileFilter * filter;
130         gchar * filename = NULL;
131
132         filter = gtk_file_filter_new();
133         gtk_file_filter_add_pattern(filter, "*.smc");
134         gtk_file_filter_add_pattern(filter, "*.sfc");
135         gtk_file_filter_add_pattern(filter, "*.fig");
136         gtk_file_filter_add_pattern(filter, "*.smc.gz");
137         gtk_file_filter_add_pattern(filter, "*.sfc.gz");
138         gtk_file_filter_add_pattern(filter, "*.fig.gz");
139         gtk_file_filter_add_pattern(filter, "*.zip");
140
141         dialog = hildon_file_chooser_dialog_new_with_properties(
142                 get_parent_window(),
143                 "action", GTK_FILE_CHOOSER_ACTION_OPEN,
144                 "local-only", TRUE,
145                 "filter", filter,
146                 NULL);
147         hildon_file_chooser_dialog_set_show_upnp(HILDON_FILE_CHOOSER_DIALOG(dialog),
148                 FALSE);
149
150         if (current_rom_file_exists) {
151                 // By default open showing the last selected file
152                 gtk_file_chooser_set_filename(GTK_FILE_CHOOSER(dialog), 
153                         current_rom_file);
154         }
155
156         gtk_widget_show_all(GTK_WIDGET(dialog));
157         if (gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_OK) {
158                 filename = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(dialog));
159         }
160
161         gtk_widget_destroy(dialog);
162
163         if (filename) {
164                 set_rom(filename);
165                 g_free(filename);
166         }
167 }
168
169 static void controls_item_callback(GtkWidget * button, gpointer data)
170 {
171         controls_setup();
172         controls_dialog(get_parent_window());
173 }
174
175 static void advanced_item_callback(GtkWidget * button, gpointer data)
176 {
177         advanced_dialog(get_parent_window());
178 }
179
180 static void about_item_callback(GtkWidget * button, gpointer data)
181 {
182         about_dialog(get_parent_window());
183 }
184
185 #if MAEMO_VERSION >= 5
186 /* Called for each of the play/restart/continue buttons */
187 static void found_ogs_button_callback(GtkWidget *widget, gpointer data)
188 {
189         hildon_gtk_widget_set_theme_size(widget,
190                 HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_THUMB_HEIGHT);
191         gtk_widget_set_size_request(widget, 200, -1);
192         gtk_box_set_child_packing(GTK_BOX(data), widget,
193                 FALSE, FALSE, 0, GTK_PACK_START);
194 }
195 #endif
196
197 static GtkWidget * load_plugin(void)
198 {
199         g_type_init();
200         gcc = gconf_client_get_default();
201
202         GtkWidget* parent = gtk_vbox_new(FALSE, HILDON_MARGIN_DEFAULT);
203
204 /* Select ROM button */
205 #if MAEMO_VERSION >= 5
206 {
207         select_rom_btn = HILDON_BUTTON(hildon_button_new_with_text(
208                 HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_THUMB_HEIGHT,
209                 HILDON_BUTTON_ARRANGEMENT_VERTICAL,
210                 "ROM",
211                 NULL));
212         hildon_button_set_alignment(select_rom_btn, 0.0f, 0.5f, 0.9f, 0.2f);
213
214         // Ugly hacks: resize the Osso-Games-Startup buttons
215         GtkBox* button_box =
216                 GTK_BOX(gtk_widget_get_parent(gs.ui->play_button));
217         gtk_box_set_spacing(button_box, HILDON_MARGIN_DEFAULT);
218         gtk_container_foreach(GTK_CONTAINER(button_box),
219                 found_ogs_button_callback, button_box);
220
221         // Ugly hacks: move the select rom button to the left.
222         gtk_box_pack_start_defaults(button_box, GTK_WIDGET(select_rom_btn));
223         gtk_box_reorder_child(button_box, GTK_WIDGET(select_rom_btn), 0);
224 }
225 #else
226 {
227         GtkWidget* rom_hbox = gtk_hbox_new(FALSE, HILDON_MARGIN_DEFAULT);
228         select_rom_btn = GTK_BUTTON(gtk_button_new_with_label("Select ROM..."));
229         gtk_widget_set_size_request(GTK_WIDGET(select_rom_btn), 180, 46);
230         rom_label = GTK_LABEL(gtk_label_new(NULL));
231
232         gtk_box_pack_start(GTK_BOX(rom_hbox), GTK_WIDGET(select_rom_btn), FALSE, FALSE, 0);
233         gtk_box_pack_start(GTK_BOX(rom_hbox), GTK_WIDGET(rom_label), TRUE, TRUE, 0);
234         gtk_box_pack_start(GTK_BOX(parent), rom_hbox, FALSE, FALSE, 0);
235 }
236 #endif
237
238 /* First row of widgets */
239 #if MAEMO_VERSION >= 5
240 {
241         GtkBox* opt_hbox1 = GTK_BOX(gtk_hbox_new(FALSE, HILDON_MARGIN_DEFAULT));
242         sound_check =
243                 HILDON_CHECK_BUTTON(hildon_check_button_new(
244                         HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_FINGER_HEIGHT));
245         gtk_button_set_label(GTK_BUTTON(sound_check), "Sound");
246
247         framerate_picker = HILDON_PICKER_BUTTON(hildon_picker_button_new(
248                 HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_FINGER_HEIGHT,
249                 HILDON_BUTTON_ARRANGEMENT_HORIZONTAL));
250         hildon_button_set_title(HILDON_BUTTON(framerate_picker), "Target framerate");
251
252         HildonTouchSelector* framerate_sel =
253                 HILDON_TOUCH_SELECTOR(hildon_touch_selector_new_text());
254         hildon_touch_selector_append_text(framerate_sel, "Auto");
255         for (int i = 1; i < 10; i++) {
256                 gchar buffer[20];
257                 sprintf(buffer, "%d-%d", 50/i, 60/i);
258                 hildon_touch_selector_append_text(framerate_sel, buffer);
259         }
260         hildon_picker_button_set_selector(framerate_picker, framerate_sel);
261
262         GtkBox* framerate_sel_box = GTK_BOX(gtk_hbox_new(FALSE, HILDON_MARGIN_DEFAULT));
263
264         display_fps_check =
265                 HILDON_CHECK_BUTTON(hildon_check_button_new(HILDON_SIZE_FINGER_HEIGHT));
266         gtk_button_set_label(GTK_BUTTON(display_fps_check),
267                 "Show while in game");
268         turbo_check =
269                 HILDON_CHECK_BUTTON(hildon_check_button_new(HILDON_SIZE_FINGER_HEIGHT));
270         gtk_button_set_label(GTK_BUTTON(turbo_check),
271                 "Turbo mode");
272
273         gtk_box_pack_start_defaults(framerate_sel_box, GTK_WIDGET(display_fps_check));
274         gtk_box_pack_start_defaults(framerate_sel_box, GTK_WIDGET(turbo_check));
275         gtk_box_pack_start(GTK_BOX(framerate_sel), GTK_WIDGET(framerate_sel_box), FALSE, FALSE, 0);
276         gtk_widget_show_all(GTK_WIDGET(framerate_sel_box));
277
278         gtk_box_pack_start_defaults(opt_hbox1, GTK_WIDGET(sound_check));
279         gtk_box_pack_start_defaults(opt_hbox1, GTK_WIDGET(framerate_picker));
280         gtk_box_pack_start(GTK_BOX(parent), GTK_WIDGET(opt_hbox1), FALSE, FALSE, 0);
281 }
282 #else
283 {
284         GtkBox* opt_hbox1 = GTK_BOX(gtk_hbox_new(FALSE, HILDON_MARGIN_DEFAULT));
285         sound_check =
286                 GTK_CHECK_BUTTON(gtk_check_button_new_with_label("Enable sound"));
287
288         turbo_check =
289                 GTK_CHECK_BUTTON(gtk_check_button_new_with_label("Turbo mode"));
290         display_fps_check =
291                 GTK_CHECK_BUTTON(gtk_check_button_new_with_label("Display framerate"));
292         speedhacks_combo =
293                 GTK_COMBO_BOX(gtk_combo_box_new_text());
294
295         gtk_box_pack_start(opt_hbox1, GTK_WIDGET(sound_check), FALSE, FALSE, 0);
296         gtk_box_pack_start(opt_hbox1, GTK_WIDGET(display_fps_check), TRUE, FALSE, 0);
297         gtk_box_pack_start(opt_hbox1, GTK_WIDGET(turbo_check), FALSE, FALSE, 0);
298         gtk_box_pack_start(GTK_BOX(parent), GTK_WIDGET(opt_hbox1), FALSE, FALSE, 0);
299 }
300 #endif
301
302 /* Second row of widgets */
303 #if MAEMO_VERSION >= 5
304         // Empty
305 #else
306 {
307         GtkBox* opt_hbox2 = GTK_BOX(gtk_hbox_new(FALSE, HILDON_MARGIN_DEFAULT));
308
309         accu_check =
310                 GTK_CHECK_BUTTON(gtk_check_button_new_with_label("Accurate graphics"));
311
312         framerate_combo =
313                 GTK_COMBO_BOX(gtk_combo_box_new_text());
314         GtkWidget* framerate_box = hildon_caption_new(NULL, "Framerate:",
315                 GTK_WIDGET(framerate_combo), NULL, HILDON_CAPTION_OPTIONAL);
316
317         gtk_combo_box_append_text(framerate_combo, "Auto");
318         for (int i = 1; i < 10; i++) {
319                 gchar buffer[20];
320                 sprintf(buffer, "%d-%d", 50/i, 60/i);
321                 gtk_combo_box_append_text(framerate_combo, buffer);
322         }
323         gtk_combo_box_append_text(speedhacks_combo, "No speedhacks");
324         gtk_combo_box_append_text(speedhacks_combo, "Safe hacks only");
325         gtk_combo_box_append_text(speedhacks_combo, "All speedhacks");
326
327         gtk_box_pack_start(opt_hbox2, GTK_WIDGET(accu_check), FALSE, FALSE, 0);
328         gtk_box_pack_start(opt_hbox2, GTK_WIDGET(framerate_box), TRUE, FALSE, 0);
329         gtk_box_pack_start(opt_hbox2, GTK_WIDGET(speedhacks_combo), FALSE, FALSE, 0);
330         gtk_box_pack_start(GTK_BOX(parent), GTK_WIDGET(opt_hbox2), FALSE, FALSE, 0);
331 }
332 #endif
333
334 /* Load current configuration from GConf */
335 #if MAEMO_VERSION >= 5
336         hildon_check_button_set_active(sound_check,
337                 gconf_client_get_bool(gcc, kGConfSound, NULL));
338         hildon_picker_button_set_active(framerate_picker,
339                 gconf_client_get_int(gcc, kGConfFrameskip, NULL));
340         hildon_check_button_set_active(turbo_check,
341                 gconf_client_get_bool(gcc, kGConfTurboMode, NULL));
342         hildon_check_button_set_active(display_fps_check,
343                 gconf_client_get_bool(gcc, kGConfDisplayFramerate, NULL));
344 #else
345         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(sound_check),
346                 gconf_client_get_bool(gcc, kGConfSound, NULL));
347         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(turbo_check),
348                 gconf_client_get_bool(gcc, kGConfTurboMode, NULL));
349         gtk_combo_box_set_active(framerate_combo,
350                 gconf_client_get_int(gcc, kGConfFrameskip, NULL));
351         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(accu_check),
352                 gconf_client_get_bool(gcc, kGConfTransparency, NULL));
353         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(display_fps_check),
354                 gconf_client_get_bool(gcc, kGConfDisplayFramerate, NULL));
355         gtk_combo_box_set_active(speedhacks_combo,
356                 gconf_client_get_int(gcc, kGConfSpeedhacks, NULL));
357 #endif
358
359         set_rom(gconf_client_get_string(gcc, kGConfRomFile, NULL));
360
361         // Connect signals
362         g_signal_connect(G_OBJECT(select_rom_btn), "clicked",
363                                         G_CALLBACK(select_rom_callback), NULL);
364
365         return parent;
366 }
367
368 static void unload_plugin(void)
369 {
370         if (current_rom_file) {
371                 g_free(current_rom_file);
372                 current_rom_file = 0;
373         }
374         game_state_clear();
375         save_clear();
376         g_object_unref(gcc);
377 }
378
379 static void write_config(void)
380 {
381 /* Write current settings to gconf */
382 #if MAEMO_VERSION >= 5
383         gconf_client_set_bool(gcc, kGConfSound,
384                 hildon_check_button_get_active(sound_check), NULL);
385         gconf_client_set_int(gcc, kGConfFrameskip,
386                 hildon_picker_button_get_active(framerate_picker), NULL);
387         gconf_client_set_bool(gcc, kGConfDisplayFramerate,
388                 hildon_check_button_get_active(display_fps_check), NULL);
389         gconf_client_set_bool(gcc, kGConfTurboMode,
390                 hildon_check_button_get_active(turbo_check), NULL);
391 #else
392         gconf_client_set_bool(gcc, kGConfSound,
393                 gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(sound_check)), NULL);
394         gconf_client_set_bool(gcc, kGConfTurboMode,
395                 gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(turbo_check)), NULL);
396         gconf_client_set_int(gcc, kGConfFrameskip,
397                 gtk_combo_box_get_active(framerate_combo), NULL);
398         gconf_client_set_bool(gcc, kGConfTransparency,
399                 gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(accu_check)), NULL);
400         gconf_client_set_bool(gcc, kGConfDisplayFramerate,
401                 gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(display_fps_check)), NULL);
402         gconf_client_set_int(gcc, kGConfSpeedhacks,
403                 gtk_combo_box_get_active(speedhacks_combo), NULL);
404 #endif
405
406         if (current_rom_file) {
407                 gconf_client_set_string(gcc, kGConfRomFile, current_rom_file, NULL);
408         }
409
410         controls_setup();
411 }
412
413 static GtkWidget **load_menu(guint *nitems)
414 {
415 #if MAEMO_VERSION >= 5
416         const HildonSizeType button_size =
417                 HILDON_SIZE_FINGER_HEIGHT | HILDON_SIZE_AUTO_WIDTH;
418         menu_items[0] = hildon_gtk_button_new(button_size);
419         gtk_button_set_label(GTK_BUTTON(menu_items[0]), "Settings…");
420         menu_items[1] = hildon_gtk_button_new(button_size);
421         gtk_button_set_label(GTK_BUTTON(menu_items[1]), "Controls…");
422         menu_items[2] = hildon_gtk_button_new(button_size);
423         gtk_button_set_label(GTK_BUTTON(menu_items[2]), "About…");
424         *nitems = 3;
425
426         g_signal_connect(G_OBJECT(menu_items[0]), "clicked",
427                                         G_CALLBACK(advanced_item_callback), NULL);
428         g_signal_connect(G_OBJECT(menu_items[1]), "clicked",
429                                         G_CALLBACK(controls_item_callback), NULL);
430         g_signal_connect(G_OBJECT(menu_items[2]), "clicked",
431                                         G_CALLBACK(about_item_callback), NULL);
432 #else
433         menu_items[0] = gtk_menu_item_new_with_label("Settings");
434         menu_items[1] = gtk_menu_item_new_with_label("About…");
435         *nitems = 2;
436
437         GtkMenu* settings_menu = GTK_MENU(gtk_menu_new());
438         gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu_items[0]),
439                 GTK_WIDGET(settings_menu));
440
441         GtkMenuItem* controls_item =
442                 GTK_MENU_ITEM(gtk_menu_item_new_with_label("Controls…"));
443         gtk_menu_append(GTK_MENU(settings_menu), GTK_WIDGET(controls_item));
444
445         GtkMenuItem* advanced_item =
446                 GTK_MENU_ITEM(gtk_menu_item_new_with_label("Advanced…"));
447         gtk_menu_append(GTK_MENU(settings_menu), GTK_WIDGET(advanced_item));
448
449         g_signal_connect(G_OBJECT(controls_item), "activate",
450                                         G_CALLBACK(controls_item_callback), NULL);
451         g_signal_connect(G_OBJECT(advanced_item), "activate",
452                                         G_CALLBACK(advanced_item_callback), NULL);
453         g_signal_connect(G_OBJECT(menu_items[1]), "activate",
454                                         G_CALLBACK(about_item_callback), NULL);
455 #endif
456
457         return menu_items;
458 }
459
460 static void update_menu(void)
461 {
462         // Nothing to update in the current menu
463 }
464
465 // From osso-games-startup
466 #define MA_GAME_PLAY 1
467 #define MA_GAME_RESTART 2
468 #define MA_GAME_OPEN 3
469 #define MA_GAME_SAVE 4
470 #define MA_GAME_SAVE_AS 5
471 #define MA_GAME_HELP 6
472 #define MA_GAME_RECENT_1 7
473 #define MA_GAME_RECENT_2 8
474 #define MA_GAME_RECENT_3 9
475 #define MA_GAME_RECENT_4 10
476 #define MA_GAME_RECENT_5 11
477 #define MA_GAME_RECENT_6 12
478 #define MA_GAME_CLOSE 13
479 #define MA_GAME_HIGH_SCORES 14
480 #define MA_GAME_RESET 15
481 #define MA_GAME_CHECKSTATE 16
482 #define MA_GAME_SAVEMENU_REFERENCE 17
483 #define ME_GAME_OPEN     20
484 #define ME_GAME_SAVE     21
485 #define ME_GAME_SAVE_AS  22
486 #define MA_GAME_PLAYING_START 30
487 #define MA_GAME_PLAYING 31
488
489 static void plugin_callback(GtkWidget * menu_item, gpointer data)
490 {
491         switch ((gint) data) {
492                 case ME_GAME_OPEN:
493                         save_load(get_parent_window());
494                         break;
495                 case ME_GAME_SAVE:
496                         save_save(get_parent_window());
497                         break;
498                 case ME_GAME_SAVE_AS:
499                         save_save_as(get_parent_window());
500                         break;
501                 case MA_GAME_PLAYING_START:
502                         if (!menu_item) {
503                                 // Avoid duplicate message
504                                 break;
505                         }
506                         if (!current_rom_file) {
507                                 GtkWidget* note = hildon_note_new_information(get_parent_window(),
508                                         "No ROM selected");
509                                 gtk_dialog_run(GTK_DIALOG(note));
510                                 gtk_widget_destroy(note);
511                         } else if (!current_rom_file_exists) {
512                                 GtkWidget* note = hildon_note_new_information(get_parent_window(),
513                                         "ROM file does not exist");
514                                 gtk_dialog_run(GTK_DIALOG(note));
515                                 gtk_widget_destroy(note);
516                         }
517                         break;
518         }
519 }
520