loop back after winning, don't quit; don't clobber the GC on winning in case we want...
[rfk] / rfk.c
1 /*  robotfindskitten for maemo
2  *  original by Leonard Richardson, 1997
3  *  ported to maemo by Thomas Thurman, 2009
4  *  suggestions welcome
5  *  Compile with:
6  *  gcc -Wall -g rfk.c -o rfk `pkg-config --cflags --libs gtk+-2.0 hildon-1 dbus-glib-1 dbus-1`
7  */
8
9 #include <dbus/dbus-glib.h>
10 #include <gtk/gtk.h>
11 #include <stdlib.h>
12 #include <glib.h>
13 #include <hildon/hildon.h>
14 #include <math.h>
15 #include <stdio.h>
16 #include <string.h>
17
18 #define ARENA_WIDTH 25
19 #define ARENA_HEIGHT 12
20
21 const int amount_of_random_stuff = 1;
22
23 typedef enum {
24   STATE_PROLOGUE,
25   STATE_PLAYING,
26   STATE_EPILOGUE,
27   STATE_LAST
28 } StateOfPlay;
29
30 StateOfPlay current_state = STATE_LAST;
31 GtkWidget* state_widget[STATE_LAST];
32
33 GSList *nki = NULL;
34 guint nki_count = 0;
35
36 GtkWidget *arena[ARENA_WIDTH][ARENA_HEIGHT];
37 GtkWidget *window, *robot, *kitten;
38 int robot_x, robot_y;
39 gboolean *used = NULL;
40
41 GdkPixbuf *robot_pic, *love_pic, *kitten_pic;
42
43 const GdkColor black = { 0, };
44
45 /****************************************************************/
46 /* Random object descriptions.                                  */
47 /****************************************************************/
48
49 char *
50 description (void)
51 {
52   int r;
53    
54   do
55     {
56       r = random() % nki_count;
57     }
58   while (used[r]);
59
60   used[r] = TRUE;
61   return g_slist_nth_data (nki, r);
62 }
63
64 /****************************************************************/
65 /* Placing objects.                                             */
66 /****************************************************************/
67
68 void
69 place_in_arena_at_xy (GtkWidget *item, int x, int y)
70 {
71   arena[x][y] = item;
72
73   gtk_table_attach_defaults (GTK_TABLE (state_widget[STATE_PLAYING]),
74                              item,
75                              x, x+1,
76                              y, y+1);
77
78   if (item==robot)
79     {
80       robot_x = x;
81       robot_y = y;
82     }
83 }
84
85 void
86 place_in_arena_randomly (GtkWidget *item)
87 {
88   int x, y;
89    
90   do
91     {
92       x = random() % ARENA_WIDTH;
93       y = random() % ARENA_HEIGHT;
94     }
95   while (arena[x][y]);
96
97   place_in_arena_at_xy (item, x, y);
98 }
99
100 /****************************************************************/
101 /* Labels representing things the robot might find.             */
102 /****************************************************************/
103
104 GtkWidget *
105 random_character (gchar *description)
106 {
107   gchar character[2] = { random() % ('~'-'!') + '!', 0 };
108   gchar *escaped_character = g_markup_escape_text (character, -1);
109   gchar *markup = g_strdup_printf ("<span color=\"#%02x%02x%02x\">%s</span>",
110                                    (int) (random() % 0x7F)+0x80,
111                                    (int) (random() % 0x7F)+0x80,
112                                    (int) (random() % 0x7F)+0x80,
113                                    escaped_character);
114   GtkWidget *result = gtk_label_new (NULL);
115   gtk_label_set_markup (GTK_LABEL (result), markup);
116   g_free (markup);
117   g_free (escaped_character);
118
119   g_object_set_data (G_OBJECT (result), "examine", description);
120
121   return result;
122 }
123
124 /****************************************************************/
125 /* Talking back to the user.                                    */
126 /****************************************************************/
127
128 void
129 show_message (const char *message)
130 {
131   HildonNote* note = HILDON_NOTE
132     (hildon_note_new_information (GTK_WINDOW (window),
133                                   message?message:
134                                   "Some message was supposed to be here."));
135   gtk_dialog_run (GTK_DIALOG (note));
136   gtk_widget_destroy (GTK_WIDGET (note));
137 }
138
139 /****************************************************************/
140 /* Loading the non-kitten objects.                              */
141 /****************************************************************/
142 void
143 ensure_messages_loaded (void)
144 {
145   FILE *nki_file = NULL;
146   gchar *line = NULL;
147   gboolean headers = TRUE;
148
149   if (nki_count)
150     return;
151
152   nki_file = fopen ("/usr/share/rfk/non-kitten-items.rfk", "r");
153
154   if (!nki_file)
155     {
156       show_message ("Could not open list of non-kitten items!  Must quit.");
157       exit (EXIT_FAILURE);
158     }
159
160   while (!feof (nki_file))
161     {
162       char newline;
163       if (fscanf (nki_file, "%a[^\n]%c", &line, &newline) == EOF)
164         {
165           break;
166         }
167
168       if (strcmp(line, "")==0)
169         {
170           headers = FALSE;
171           fscanf (nki_file, "%c", &newline); 
172           free (line);
173         }
174       else if (headers)
175         {
176           /* we ignore all the headers for now */
177           free (line);
178         }
179       else
180         {
181           nki = g_slist_prepend (nki, line);
182           nki_count++;
183         }
184     }
185
186   fclose (nki_file);
187
188   used = g_malloc0 (nki_count);
189 }
190
191 void
192 load_images (void)
193 {
194   robot_pic = gdk_pixbuf_new_from_file ("/usr/share/rfk/rfk-robot.png", NULL);
195   love_pic = gdk_pixbuf_new_from_file ("/usr/share/rfk/rfk-love.png", NULL);
196   kitten_pic = gdk_pixbuf_new_from_file ("/usr/share/rfk/rfk-kitten.png", NULL);
197 }
198
199 /****************************************************************/
200 /* Stop doing that, and do something else.                      */
201 /****************************************************************/
202 static void
203 switch_state (StateOfPlay new_state)
204 {
205   if (current_state != STATE_LAST)
206     {
207       gtk_container_remove (GTK_CONTAINER (window), state_widget[current_state]);
208     }
209   gtk_container_add (GTK_CONTAINER (window), state_widget[new_state]);
210
211   gtk_widget_show_all (window);
212   gdk_window_set_events (GTK_WIDGET (window)->window,
213                          gdk_window_get_events(GTK_WIDGET (window)->window) | GDK_BUTTON_PRESS_MASK);
214
215   current_state = new_state;
216 }
217
218 /****************************************************************/
219 /* The ending animation.                                        */
220 /****************************************************************/
221
222 gboolean animation_running = FALSE;
223
224 static gboolean
225 ending_animation_quit (gpointer data)
226 {
227   switch_state (STATE_PROLOGUE);
228   return FALSE;
229 }
230
231 static gboolean
232 ending_animation_draw (GtkWidget *widget, GdkEventExpose *event, gpointer data)
233 {
234   static int cycle_count = 0;
235
236   static int robot_x = 0;
237   static int robot_stop = 0;
238   static int kitten_x = 0;
239   static int all_y = 0;
240   static GdkGC *gc = NULL;
241
242   const int stepsize = 3;
243
244   if (!kitten_x)
245     {
246       gc = gdk_gc_new (GDK_DRAWABLE (widget->window));
247
248       all_y = (event->area.height - gdk_pixbuf_get_height (love_pic)) / 2;
249
250       robot_stop = gdk_pixbuf_get_width (robot_pic) + gdk_pixbuf_get_width (love_pic);
251       kitten_x = event->area.width - (cycle_count*stepsize + gdk_pixbuf_get_width (kitten_pic));
252     }
253
254   gdk_gc_set_foreground (gc, &black);
255
256   gdk_draw_rectangle (GDK_DRAWABLE (widget->window),
257                       gc,
258                       TRUE,
259                       0, 0, event->area.width, event->area.height);
260
261   gdk_draw_pixbuf (GDK_DRAWABLE (widget->window),
262                    gc,
263                    robot_pic, 0, 0,
264                    robot_x, all_y,
265                    -1, -1,
266                    GDK_RGB_DITHER_NONE, 0, 0);
267
268   gdk_draw_pixbuf (GDK_DRAWABLE (widget->window),
269                    gc,
270                    kitten_pic, 0, 0,
271                    kitten_x, all_y,
272                    -1, -1,
273                    GDK_RGB_DITHER_NONE, 0, 0);
274
275   cycle_count++;
276   robot_x += stepsize;
277   kitten_x -= stepsize;
278
279   if (robot_x+robot_stop >= kitten_x)
280     {
281       gdk_draw_pixbuf (GDK_DRAWABLE(widget->window),
282                        gc,
283                        love_pic, 0, 0,
284                        robot_x + gdk_pixbuf_get_width (robot_pic), all_y,
285                        -1, -1,
286                        GDK_RGB_DITHER_NONE, 0, 0);
287
288       animation_running = FALSE;
289
290       g_timeout_add (2000, ending_animation_quit, NULL);
291
292       gdk_gc_unref (gc);
293       cycle_count = 0;
294       robot_x = 0;
295       robot_stop = 0;
296       kitten_x = 0;
297       all_y = 0;
298       gc = NULL;
299     }
300
301   return TRUE;
302 }
303
304 static gboolean
305 ending_animation_step (gpointer data)
306 {
307   if (animation_running)
308     {
309       gdk_window_invalidate_rect (state_widget[STATE_EPILOGUE]->window,
310                                   NULL, TRUE);
311
312       return TRUE;
313     }
314   else
315     return FALSE;
316 }
317
318 static void
319 ending_animation ()
320 {
321   if (current_state!=STATE_EPILOGUE)
322     {
323       animation_running = TRUE;
324       g_timeout_add (10, ending_animation_step, NULL);
325     }
326 }
327
328 /****************************************************************/
329 /* Moving the robot.  Way to go, robot!                         */
330 /****************************************************************/
331
332 typedef struct {
333   guint gdk_key;
334   gchar vi_key; /* or nethack equivalent */
335   guint8 move_x;
336   guint8 move_y;
337 } direction;
338
339 direction directions[] = {
340   { GDK_Home,      'y', -1, -1 },
341   { GDK_Left,      'h', -1,  0 },
342   { GDK_End,       'b', -1,  1 },
343   { GDK_Down,      'j',  0,  1 },
344   { GDK_Page_Down, 'n',  1,  1 },
345   { GDK_Right,     'l',  1,  0 },
346   { GDK_Page_Up,   'u',  1, -1 },
347   { GDK_Up,        'k',  0, -1 }
348 };
349
350 gboolean
351 move_robot (guint8 whichway)
352 {
353   GtkWidget *new_space;
354   gint8 dx = directions[whichway].move_x;
355   gint8 dy = directions[whichway].move_y;
356
357   const char *found;
358
359   if (robot_x+dx<0 ||
360       robot_y+dy<0 ||
361       robot_x+dx>=ARENA_WIDTH ||
362       robot_y+dy>=ARENA_HEIGHT)
363     return TRUE;
364
365   new_space = arena[robot_x+dx][robot_y+dy];
366   found = g_object_get_data (G_OBJECT (new_space), "examine");
367
368   if (found && *found)
369     {
370       show_message (found);
371
372       if (new_space == kitten)
373         {
374           switch_state (STATE_EPILOGUE);
375         }
376
377       return TRUE;
378     }
379   else
380     {
381       /* just an ordinary move into an empty space */
382
383       g_object_ref (new_space);
384
385       gtk_container_remove (GTK_CONTAINER (state_widget[STATE_PLAYING]), robot);
386       gtk_container_remove (GTK_CONTAINER (state_widget[STATE_PLAYING]), new_space);
387
388       place_in_arena_at_xy (new_space, robot_x, robot_y);
389       place_in_arena_at_xy (robot, robot_x+dx, robot_y+dy);
390
391       g_object_unref (new_space);
392
393       return FALSE;
394     }
395 }
396
397 /****************************************************************/
398 /* Event handlers.                                              */
399 /****************************************************************/
400
401 gboolean
402 on_window_clicked (GtkWidget      *widget,
403                    GdkEventButton *event,
404                    gpointer        user_data)
405 {
406   /** Centre point of robot's representation on screen */
407   int rx, ry;
408   double angle;
409
410   if (current_state!=STATE_PLAYING)
411     {
412       return TRUE;
413     }
414
415   rx = (robot->allocation.x+robot->allocation.width/2);
416   ry = (robot->allocation.y+robot->allocation.height/2);
417
418   angle = atan2(event->x - rx,
419                 event->y - ry) +
420     M_PI * (9/8);
421
422   move_robot (((int) (angle / (M_PI/4))) % 8);
423
424   return TRUE;
425 }
426
427 gboolean
428 on_key_pressed (GtkWidget      *widget,
429                 GdkEventKey    *event,
430                 gpointer        user_data)
431 {
432   gint i;
433   guint keyval = event->keyval;
434
435   if (current_state!=STATE_PLAYING)
436     {
437       return FALSE;
438     }
439
440   if (keyval>='A' && keyval<='Z')
441     {
442       keyval += ('a'-'A');
443     }
444
445   for (i=0; i<G_N_ELEMENTS(directions); i++)
446     {
447       if (keyval==directions[i].gdk_key ||
448           keyval==directions[i].vi_key)
449         {
450           if (event->state & GDK_SHIFT_MASK)
451             {
452               while (!move_robot (i))
453                 {
454                   /* keep going, robot! */
455                 }
456             }
457           else
458             {
459               move_robot (i);
460             }
461           return FALSE;
462         }
463     }
464
465   return FALSE;
466 }
467
468 /****************************************************************/
469 /* Online help.                                                 */
470 /****************************************************************/
471 gboolean
472 get_help (gpointer button, gpointer data)
473 {
474   DBusGConnection *connection;
475   GError *error = NULL;
476
477   DBusGProxy *proxy;
478
479   connection = dbus_g_bus_get (DBUS_BUS_SESSION,
480                                &error);
481   if (connection == NULL)
482     {
483       show_message (error->message);
484       g_error_free (error);
485       return FALSE;
486     }
487
488   proxy = dbus_g_proxy_new_for_name (connection,
489                                      "com.nokia.osso_browser",
490                                      "/com/nokia/osso_browser/request",
491                                      "com.nokia.osso_browser");
492
493   error = NULL;
494   if (!dbus_g_proxy_call (proxy, "load_url", &error,
495                           G_TYPE_STRING, "/usr/share/rfk/help.html",
496                           G_TYPE_INVALID,
497                           G_TYPE_INVALID))
498     {
499       show_message (error->message);
500       g_error_free (error);
501       return FALSE;
502     }
503   return FALSE;
504 }
505
506 void
507 play_game (gpointer button, gpointer data)
508 {
509   switch_state (STATE_PLAYING);
510 }
511
512 static void
513 set_up_board (void)
514 {
515   guint x, y;
516
517   if (current_state==STATE_PLAYING)
518     {
519       /* end of the game; clean up */
520
521       for (x=0; x < ARENA_WIDTH; x++)
522         for (y=0; y < ARENA_HEIGHT; y++)
523           if (arena[x][y])
524             {
525               gtk_container_remove (GTK_CONTAINER (state_widget[STATE_PLAYING]),
526                                     arena[x][y]);
527               arena[x][y] = NULL;
528             }
529
530       g_object_unref (robot);
531       g_object_unref (kitten);
532     }
533   else
534     {
535       /* make everything new */
536   
537       robot = gtk_label_new ("#");
538       g_object_ref (robot);
539       kitten = random_character ("You found kitten!  Way to go, robot!");
540       g_object_ref (kitten);
541
542       place_in_arena_randomly (robot);
543       place_in_arena_randomly (kitten);
544
545       if (nki_count < amount_of_random_stuff)
546         {
547           /* sanity check failed */
548           show_message ("There are too few non-kitten items to play a meaningful game.");
549           exit (EXIT_FAILURE);
550         }
551
552       for (x=0; x < amount_of_random_stuff; x++)
553         place_in_arena_randomly (random_character (description ()));
554
555       for (x=0; x < ARENA_WIDTH; x++)
556         for (y=0; y < ARENA_HEIGHT; y++)
557           if (!arena[x][y])
558             place_in_arena_at_xy (gtk_label_new (NULL), x, y);
559     }
560 }
561
562 static void
563 set_up_widgets (void)
564 {
565   GtkWidget *middle = gtk_hbox_new (FALSE, 0);
566   GtkWidget *buttons = gtk_hbox_new (TRUE, 0);
567   GtkWidget *explain = NULL, *help_button, *play_button, *intro;
568   const char *explanation =
569     "In this game, you are robot (#). "
570     "Your job is to find kitten. This task is complicated "
571     "by the existence of various things which are not kitten. "
572     "Robot must touch items to determine if they are kitten or "
573     "not. The game ends when robotfindskitten. You may move "
574     "robot about by tapping on any side of robot, or with the "
575     "arrow keys.";
576   GKeyFile *desktop = g_key_file_new ();
577   gchar *version;
578   guint x, y;
579   
580   /* The window */
581
582   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
583   gtk_window_set_title (GTK_WINDOW (window), "robotfindskitten");
584   gtk_widget_modify_bg (window, GTK_STATE_NORMAL, &black);
585   g_signal_connect (G_OBJECT (window), "button-press-event", G_CALLBACK (on_window_clicked), NULL);
586   g_signal_connect (G_OBJECT (window), "key-press-event", G_CALLBACK (on_key_pressed), NULL);
587   g_signal_connect (G_OBJECT (window), "delete_event", G_CALLBACK (gtk_main_quit), NULL);
588
589   /* The prologue */
590
591   if (g_key_file_load_from_file (desktop,
592                                  "/usr/share/applications/hildon/rfk.desktop",
593                                  G_KEY_FILE_NONE,
594                                  NULL))
595     {
596       version = g_strdup_printf("v%s.%d",
597                                 g_key_file_get_value (desktop, "Desktop Entry", "Version", NULL),
598                                 nki_count);
599       g_key_file_free (desktop);
600     }
601   else
602     {
603       version = g_strdup("");
604     }
605
606   help_button = hildon_button_new_with_text (HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_THUMB_HEIGHT,
607                                              HILDON_BUTTON_ARRANGEMENT_HORIZONTAL,
608                                              "Help", NULL);
609   g_signal_connect (help_button, "clicked", G_CALLBACK (get_help), NULL);
610
611   play_button = hildon_button_new_with_text (HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_THUMB_HEIGHT,
612                                              HILDON_BUTTON_ARRANGEMENT_HORIZONTAL,
613                                              "Play", NULL);
614   g_signal_connect (play_button, "clicked", G_CALLBACK (play_game), NULL);
615
616   gtk_box_pack_end (GTK_BOX (buttons), play_button, TRUE, TRUE, 0);
617   gtk_box_pack_end (GTK_BOX (buttons), help_button, TRUE, TRUE, 0);
618
619   explain = gtk_label_new (explanation);
620   gtk_label_set_line_wrap (GTK_LABEL (explain), TRUE);
621
622   gtk_box_pack_end (GTK_BOX (middle), explain, TRUE, TRUE, 0);
623   gtk_box_pack_end (GTK_BOX (middle), gtk_image_new_from_pixbuf (robot_pic), FALSE, FALSE, 0);
624
625   intro = gtk_vbox_new (FALSE, 0);
626   gtk_box_pack_end (GTK_BOX (intro), buttons, FALSE, FALSE, 0);
627   gtk_box_pack_end (GTK_BOX (intro), middle, TRUE, TRUE, 0);
628   gtk_box_pack_end (GTK_BOX (intro), gtk_label_new (version), FALSE, FALSE, 0);
629   g_free (version);
630
631   state_widget[STATE_PROLOGUE] = intro;
632
633   /* The game itself */
634
635   state_widget[STATE_PLAYING] = gtk_table_new (ARENA_HEIGHT, ARENA_WIDTH, TRUE);
636   g_signal_connect (state_widget[STATE_PLAYING], "parent-set", G_CALLBACK (set_up_board), NULL);
637
638   for (x=0; x < ARENA_WIDTH; x++)
639     for (y=0; y < ARENA_HEIGHT; y++)
640       arena[x][y] = NULL;
641
642   /* The epilogue */
643   state_widget[STATE_EPILOGUE] =  gtk_drawing_area_new ();
644   g_signal_connect (state_widget[STATE_EPILOGUE], "parent-set", G_CALLBACK (ending_animation), NULL);
645   g_signal_connect (G_OBJECT (state_widget[STATE_EPILOGUE]),
646                     "expose_event", G_CALLBACK (ending_animation_draw), NULL);
647
648   for (x=0; x<STATE_LAST; x++)
649     {
650       /* so we don't lose them when we take them offscreen */
651       g_object_ref (state_widget[x]);
652     }
653 }
654
655 /****************************************************************/
656 /* Let's kick the whole thing off...                            */
657 /****************************************************************/
658
659 int
660 main (gint argc,
661       gchar **argv)
662 {
663   gtk_init (&argc, &argv);
664   g_set_application_name ("robotfindskitten");
665   srandom (time(0));
666
667   ensure_messages_loaded ();
668   load_images ();
669
670   set_up_widgets ();
671   switch_state (STATE_PROLOGUE);
672   
673   gtk_main ();
674
675   return EXIT_SUCCESS;
676 }