tidy comments
[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 = 15;
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   used[r] = TRUE;
60
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
189 void
190 load_images (void)
191 {
192   robot_pic = gdk_pixbuf_new_from_file ("/usr/share/rfk/rfk-robot.png", NULL);
193   love_pic = gdk_pixbuf_new_from_file ("/usr/share/rfk/rfk-love.png", NULL);
194   kitten_pic = gdk_pixbuf_new_from_file ("/usr/share/rfk/rfk-kitten.png", NULL);
195 }
196
197 /****************************************************************/
198 /* Stop doing that, and do something else.                      */
199 /****************************************************************/
200 static void
201 switch_state (StateOfPlay new_state)
202 {
203   if (current_state != STATE_LAST)
204     {
205       gtk_container_remove (GTK_CONTAINER (window), state_widget[current_state]);
206     }
207   gtk_container_add (GTK_CONTAINER (window), state_widget[new_state]);
208
209   gtk_widget_show_all (window);
210   gdk_window_set_events (GTK_WIDGET (window)->window,
211                          gdk_window_get_events(GTK_WIDGET (window)->window) | GDK_BUTTON_PRESS_MASK);
212
213   current_state = new_state;
214 }
215
216 /****************************************************************/
217 /* Things we need DBus for: online help, and vibration.         */
218 /****************************************************************/
219 static void
220 call_dbus (DBusBusType type,
221            char *name,
222            char *path,
223            char *interface,
224            char *method,
225            char *parameter)
226 {
227   DBusGConnection *connection;
228   GError *error = NULL;
229
230   DBusGProxy *proxy;
231
232   connection = dbus_g_bus_get (type,
233                                &error);
234   if (connection == NULL)
235     {
236       show_message (error->message);
237       g_error_free (error);
238       return;
239     }
240
241   proxy = dbus_g_proxy_new_for_name (connection, name, path, interface);
242
243   error = NULL;
244   if (!dbus_g_proxy_call (proxy, method, &error,
245                           G_TYPE_STRING, parameter,
246                           G_TYPE_INVALID,
247                           G_TYPE_INVALID))
248     {
249       show_message (error->message);
250       g_error_free (error);
251     }
252 }
253
254 static gboolean
255 get_help (gpointer button, gpointer data)
256 {
257   call_dbus (DBUS_BUS_SESSION,
258              "com.nokia.osso_browser",
259              "/com/nokia/osso_browser/request",
260              "com.nokia.osso_browser",
261              "load_url",
262              "/usr/share/rfk/help.html");
263   return FALSE;
264 }
265
266 static void
267 vibrate (void)
268 {
269   call_dbus (DBUS_BUS_SYSTEM,
270              "com.nokia.mce",
271              "/com/nokia/mce/request",
272              "com.nokia.mce.request",
273              "req_vibrator_pattern_activate",
274              "PatternIncomingMessage");
275 }
276
277 /****************************************************************/
278 /* The ending animation.                                        */
279 /****************************************************************/
280
281 gboolean animation_running = FALSE;
282
283 static gboolean
284 ending_animation_quit (gpointer data)
285 {
286   switch_state (STATE_PROLOGUE);
287   return FALSE;
288 }
289
290 static gboolean
291 ending_animation_draw (GtkWidget *widget, GdkEventExpose *event, gpointer data)
292 {
293   static int cycle_count = 0;
294
295   static int robot_x = 0;
296   static int robot_stop = 0;
297   static int kitten_x = 0;
298   static int all_y = 0;
299   static GdkGC *gc = NULL;
300
301   const int stepsize = 3;
302   static int love_size = 40;
303
304   if (!kitten_x)
305     {
306       gc = gdk_gc_new (GDK_DRAWABLE (widget->window));
307
308       all_y = (event->area.height - gdk_pixbuf_get_height (love_pic)) / 2;
309
310       robot_stop = gdk_pixbuf_get_width (robot_pic) + gdk_pixbuf_get_width (love_pic);
311       kitten_x = event->area.width - (cycle_count*stepsize + gdk_pixbuf_get_width (kitten_pic));
312     }
313
314   gdk_gc_set_foreground (gc, &black);
315
316   gdk_draw_rectangle (GDK_DRAWABLE (widget->window),
317                       gc,
318                       TRUE,
319                       0, 0, event->area.width, event->area.height);
320
321   gdk_draw_pixbuf (GDK_DRAWABLE (widget->window),
322                    gc,
323                    robot_pic, 0, 0,
324                    robot_x, all_y,
325                    -1, -1,
326                    GDK_RGB_DITHER_NONE, 0, 0);
327
328   gdk_draw_pixbuf (GDK_DRAWABLE (widget->window),
329                    gc,
330                    kitten_pic, 0, 0,
331                    kitten_x, all_y,
332                    -1, -1,
333                    GDK_RGB_DITHER_NONE, 0, 0);
334
335   if (robot_x+robot_stop < kitten_x)
336     {
337       cycle_count++;
338       robot_x += stepsize;
339       kitten_x -= stepsize;
340     }
341   else
342     {
343       GdkPixbuf *scaled_love_pic =
344         gdk_pixbuf_scale_simple (love_pic,
345                                  love_size,
346                                  love_size,
347                                  GDK_INTERP_BILINEAR);
348
349       gdk_draw_pixbuf (GDK_DRAWABLE(widget->window),
350                        gc,
351                        scaled_love_pic, 0, 0,
352                        robot_x + gdk_pixbuf_get_width (robot_pic), all_y,
353                        -1, -1,
354                        GDK_RGB_DITHER_NONE, 0, 0);
355
356       love_size ++;
357
358       if (love_size >= gdk_pixbuf_get_width (love_pic))
359         {
360           /* all done! */
361           
362           vibrate ();
363           
364           animation_running = FALSE;
365
366           g_timeout_add (2000, ending_animation_quit, NULL);
367
368           gdk_gc_unref (gc);
369           love_size = 40;
370           cycle_count = 0;
371           robot_x = 0;
372           robot_stop = 0;
373           kitten_x = 0;
374           all_y = 0;
375           gc = NULL;
376         }
377     }
378
379   return TRUE;
380 }
381
382 static gboolean
383 ending_animation_step (gpointer data)
384 {
385   if (animation_running)
386     {
387       gdk_window_invalidate_rect (state_widget[STATE_EPILOGUE]->window,
388                                   NULL, TRUE);
389
390       return TRUE;
391     }
392   else
393     return FALSE;
394 }
395
396 static void
397 ending_animation ()
398 {
399   if (current_state!=STATE_EPILOGUE)
400     {
401       animation_running = TRUE;
402       g_timeout_add (10, ending_animation_step, NULL);
403     }
404 }
405
406 /****************************************************************/
407 /* Moving the robot.  Way to go, robot!                         */
408 /****************************************************************/
409
410 typedef struct {
411   guint gdk_key;
412   gchar vi_key; /* or nethack equivalent */
413   guint8 move_x;
414   guint8 move_y;
415 } direction;
416
417 direction directions[] = {
418   { GDK_Home,      'y', -1, -1 },
419   { GDK_Left,      'h', -1,  0 },
420   { GDK_End,       'b', -1,  1 },
421   { GDK_Down,      'j',  0,  1 },
422   { GDK_Page_Down, 'n',  1,  1 },
423   { GDK_Right,     'l',  1,  0 },
424   { GDK_Page_Up,   'u',  1, -1 },
425   { GDK_Up,        'k',  0, -1 }
426 };
427
428 gboolean
429 move_robot (guint8 whichway)
430 {
431   GtkWidget *new_space;
432   gint8 dx = directions[whichway].move_x;
433   gint8 dy = directions[whichway].move_y;
434
435   const char *found;
436
437   if (robot_x+dx<0 ||
438       robot_y+dy<0 ||
439       robot_x+dx>=ARENA_WIDTH ||
440       robot_y+dy>=ARENA_HEIGHT)
441     return TRUE;
442
443   new_space = arena[robot_x+dx][robot_y+dy];
444   found = g_object_get_data (G_OBJECT (new_space), "examine");
445
446   if (found && *found)
447     {
448       show_message (found);
449
450       if (new_space == kitten)
451         {
452           switch_state (STATE_EPILOGUE);
453         }
454
455       return TRUE;
456     }
457   else
458     {
459       /* just an ordinary move into an empty space */
460
461       g_object_ref (new_space);
462
463       gtk_container_remove (GTK_CONTAINER (state_widget[STATE_PLAYING]), robot);
464       gtk_container_remove (GTK_CONTAINER (state_widget[STATE_PLAYING]), new_space);
465
466       place_in_arena_at_xy (new_space, robot_x, robot_y);
467       place_in_arena_at_xy (robot, robot_x+dx, robot_y+dy);
468
469       g_object_unref (new_space);
470
471       return FALSE;
472     }
473 }
474
475 /****************************************************************/
476 /* Event handlers.                                              */
477 /****************************************************************/
478
479 gboolean
480 on_window_clicked (GtkWidget      *widget,
481                    GdkEventButton *event,
482                    gpointer        user_data)
483 {
484   /** Centre point of robot's representation on screen */
485   int rx, ry;
486   double angle;
487
488   if (current_state!=STATE_PLAYING)
489     {
490       return TRUE;
491     }
492
493   rx = (robot->allocation.x+robot->allocation.width/2);
494   ry = (robot->allocation.y+robot->allocation.height/2);
495
496   angle = atan2(event->x - rx,
497                 event->y - ry) +
498     M_PI * (9/8);
499
500   move_robot (((int) (angle / (M_PI/4))) % 8);
501
502   return TRUE;
503 }
504
505 gboolean
506 on_key_pressed (GtkWidget      *widget,
507                 GdkEventKey    *event,
508                 gpointer        user_data)
509 {
510   gint i;
511   guint keyval = event->keyval;
512
513   if (current_state!=STATE_PLAYING)
514     {
515       return FALSE;
516     }
517
518   if (keyval>='A' && keyval<='Z')
519     {
520       keyval += ('a'-'A');
521     }
522
523   for (i=0; i<G_N_ELEMENTS(directions); i++)
524     {
525       if (keyval==directions[i].gdk_key ||
526           keyval==directions[i].vi_key)
527         {
528           if (event->state & GDK_SHIFT_MASK)
529             {
530               while (!move_robot (i))
531                 {
532                   /* keep going, robot! */
533                 }
534             }
535           else
536             {
537               move_robot (i);
538             }
539           return FALSE;
540         }
541     }
542
543   if (keyval=='d' && event->state & GDK_CONTROL_MASK)
544     {
545       /* secret debugging key */
546       show_message (gtk_label_get_text (GTK_LABEL (kitten)));
547     }
548
549   return FALSE;
550 }
551
552 void
553 play_game (gpointer button, gpointer data)
554 {
555   switch_state (STATE_PLAYING);
556 }
557
558 static void
559 set_up_board (void)
560 {
561   guint x, y;
562
563   if (current_state==STATE_PLAYING)
564     {
565       /* end of the game; clean up */
566
567       for (x=0; x < ARENA_WIDTH; x++)
568         for (y=0; y < ARENA_HEIGHT; y++)
569           if (arena[x][y])
570             {
571               gtk_container_remove (GTK_CONTAINER (state_widget[STATE_PLAYING]),
572                                     arena[x][y]);
573               arena[x][y] = NULL;
574             }
575
576       g_object_unref (robot);
577       g_object_unref (kitten);
578     }
579   else
580     {
581       /* make everything new */
582   
583       g_free (used);
584       used = g_malloc0 (nki_count * sizeof(gboolean));
585
586       robot = gtk_label_new ("#");
587       g_object_ref (robot);
588       kitten = random_character ("You found kitten!  Way to go, robot!");
589       g_object_ref (kitten);
590
591       place_in_arena_randomly (robot);
592       place_in_arena_randomly (kitten);
593
594       if (nki_count < amount_of_random_stuff)
595         {
596           /* sanity check failed */
597           show_message ("There are too few non-kitten items to play a meaningful game.");
598           exit (EXIT_FAILURE);
599         }
600
601       for (x=0; x < amount_of_random_stuff; x++)
602         place_in_arena_randomly (random_character (description ()));
603
604       for (x=0; x < ARENA_WIDTH; x++)
605         for (y=0; y < ARENA_HEIGHT; y++)
606           if (!arena[x][y])
607             place_in_arena_at_xy (gtk_label_new (NULL), x, y);
608     }
609 }
610
611 static void
612 set_up_widgets (void)
613 {
614   GtkWidget *middle = gtk_hbox_new (FALSE, 0);
615   GtkWidget *buttons = gtk_hbox_new (TRUE, 0);
616   GtkWidget *explain = NULL, *help_button, *play_button, *intro;
617   const char *explanation =
618     "In this game, you are robot (#). "
619     "Your job is to find kitten. This task is complicated "
620     "by the existence of various things which are not kitten. "
621     "Robot must touch items to determine if they are kitten or "
622     "not. The game ends when robotfindskitten. You may move "
623     "robot about by tapping on any side of robot, or with the "
624     "arrow keys.";
625   GKeyFile *desktop = g_key_file_new ();
626   gchar *version;
627   guint x, y;
628   
629   /* The window */
630
631   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
632   gtk_window_set_title (GTK_WINDOW (window), "robotfindskitten");
633   gtk_widget_modify_bg (window, GTK_STATE_NORMAL, &black);
634   g_signal_connect (G_OBJECT (window), "button-press-event", G_CALLBACK (on_window_clicked), NULL);
635   g_signal_connect (G_OBJECT (window), "key-press-event", G_CALLBACK (on_key_pressed), NULL);
636   g_signal_connect (G_OBJECT (window), "delete_event", G_CALLBACK (gtk_main_quit), NULL);
637
638   /* The prologue */
639
640   /* Get the rather odd version string.  The RFK spec says that
641    * it should read v<major>.<minor>.<number-of-NKIs>.
642    */
643   if (g_key_file_load_from_file (desktop,
644                                  "/usr/share/applications/hildon/rfk.desktop",
645                                  G_KEY_FILE_NONE,
646                                  NULL))
647     {
648       version = g_strdup_printf("v%s.%d",
649                                 g_key_file_get_value (desktop, "Desktop Entry", "Version", NULL),
650                                 nki_count);
651       g_key_file_free (desktop);
652     }
653   else
654     {
655       version = g_strdup("");
656     }
657
658   help_button = hildon_button_new_with_text (HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_THUMB_HEIGHT,
659                                              HILDON_BUTTON_ARRANGEMENT_HORIZONTAL,
660                                              "Help", NULL);
661   g_signal_connect (help_button, "clicked", G_CALLBACK (get_help), NULL);
662
663   play_button = hildon_button_new_with_text (HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_THUMB_HEIGHT,
664                                              HILDON_BUTTON_ARRANGEMENT_HORIZONTAL,
665                                              "Play", NULL);
666   g_signal_connect (play_button, "clicked", G_CALLBACK (play_game), NULL);
667
668   gtk_box_pack_end (GTK_BOX (buttons), play_button, TRUE, TRUE, 0);
669   gtk_box_pack_end (GTK_BOX (buttons), help_button, TRUE, TRUE, 0);
670
671   explain = gtk_label_new (explanation);
672   gtk_label_set_line_wrap (GTK_LABEL (explain), TRUE);
673
674   gtk_box_pack_end (GTK_BOX (middle), explain, TRUE, TRUE, 0);
675   gtk_box_pack_end (GTK_BOX (middle), gtk_image_new_from_pixbuf (robot_pic), FALSE, FALSE, 0);
676
677   intro = gtk_vbox_new (FALSE, 0);
678   gtk_box_pack_end (GTK_BOX (intro), buttons, FALSE, FALSE, 0);
679   gtk_box_pack_end (GTK_BOX (intro), middle, TRUE, TRUE, 0);
680   gtk_box_pack_end (GTK_BOX (intro), gtk_label_new (version), FALSE, FALSE, 0);
681   g_free (version);
682
683   state_widget[STATE_PROLOGUE] = intro;
684
685   /* The game itself */
686
687   state_widget[STATE_PLAYING] = gtk_table_new (ARENA_HEIGHT, ARENA_WIDTH, TRUE);
688   g_signal_connect (state_widget[STATE_PLAYING], "parent-set", G_CALLBACK (set_up_board), NULL);
689
690   for (x=0; x < ARENA_WIDTH; x++)
691     for (y=0; y < ARENA_HEIGHT; y++)
692       arena[x][y] = NULL;
693
694   /* The epilogue */
695   state_widget[STATE_EPILOGUE] =  gtk_drawing_area_new ();
696   g_signal_connect (state_widget[STATE_EPILOGUE], "parent-set", G_CALLBACK (ending_animation), NULL);
697   g_signal_connect (G_OBJECT (state_widget[STATE_EPILOGUE]),
698                     "expose_event", G_CALLBACK (ending_animation_draw), NULL);
699
700   for (x=0; x<STATE_LAST; x++)
701     {
702       /* so we don't lose them when we take them offscreen */
703       g_object_ref (state_widget[x]);
704     }
705 }
706
707 /****************************************************************/
708 /* Let's kick the whole thing off...                            */
709 /****************************************************************/
710
711 int
712 main (gint argc,
713       gchar **argv)
714 {
715   gtk_init (&argc, &argv);
716   g_set_application_name ("robotfindskitten");
717   srandom (time(0));
718
719   ensure_messages_loaded ();
720   load_images ();
721
722   set_up_widgets ();
723   switch_state (STATE_PROLOGUE);
724   
725   gtk_main ();
726
727   return EXIT_SUCCESS;
728 }