- added shurtcut function to create menu items
[supertux.git] / src / menu.cpp
1 /*
2   menu.c
3   
4   Super Tux - Menu
5   
6   by Tobias Glaesser
7   tobi.web@gmx.de
8   http://www.newbreedsoftware.com/supertux/
9   
10   December 20, 2003 - March 15, 2004
11 */
12
13 #ifndef WIN32
14 #include <sys/types.h>
15 #include <ctype.h>
16 #endif
17
18 #include <stdlib.h>
19 #include <stdio.h>
20 #include <string.h>
21
22 #include "defines.h"
23 #include "globals.h"
24 #include "menu.h"
25 #include "screen.h"
26 #include "setup.h"
27 #include "sound.h"
28 #include "scene.h"
29 #include "leveleditor.h"
30 #include "timer.h"
31 #include "high_scores.h"
32
33 /* (global) menu variables */
34 MenuAction menuaction;
35 int show_menu;
36 int menu_change;
37 texture_type checkbox, checkbox_checked, back, arrow_left, arrow_right;
38
39 menu_type main_menu, game_menu, options_menu, highscore_menu, load_game_menu, save_game_menu;
40 menu_type* current_menu, * last_menu;
41
42 /* input implementation variables */
43 int delete_character;
44 char mn_input_char;
45
46 /* Set the current menu */
47 void menu_set_current(menu_type* pmenu)
48 {
49   if(pmenu != current_menu)
50     {
51       menu_change = YES;
52       last_menu = current_menu;
53       current_menu = pmenu;
54       timer_start(&pmenu->effect, 500);
55     }
56 }
57
58 /* Return a pointer to a new menu item */
59 menu_item_type* menu_item_create(MenuItemKind kind, char *text, int init_toggle, void* target_menu)
60 {
61   menu_item_type *pnew_item = (menu_item_type*) malloc(sizeof(menu_item_type));
62   pnew_item->kind = kind;
63   pnew_item->text = (char*) malloc(sizeof(char) * (strlen(text) + 1));
64   strcpy(pnew_item->text,text);
65   if(kind == MN_TOGGLE)
66     pnew_item->toggled = init_toggle;
67   else
68     pnew_item->toggled = NO;
69   pnew_item->target_menu = target_menu;
70   pnew_item->input = (char*) malloc(sizeof(char));
71   pnew_item->input[0] = '\0';
72   if(kind == MN_STRINGSELECT)
73     {
74       pnew_item->list = (string_list_type*) malloc(sizeof(string_list_type));
75       string_list_init(pnew_item->list);
76     }
77   else
78     pnew_item->list = NULL;
79   return pnew_item;
80 }
81
82 void menu_item_change_text(menu_item_type* pmenu_item,const  char *text)
83 {
84   if(text)
85     {
86       free(pmenu_item->text);
87       pmenu_item->text = (char*) malloc(sizeof(char )*(strlen(text)+1));
88       strcpy(pmenu_item->text,text);
89     }
90 }
91 void menu_item_change_input(menu_item_type* pmenu_item,const  char *text)
92 {
93   if(text)
94     {
95       free(pmenu_item->input);
96       pmenu_item->input = (char*) malloc(sizeof(char )*(strlen(text)+1));
97       strcpy(pmenu_item->input,text);
98     }
99 }
100
101 /* Free a menu and all its items */
102 void menu_free(menu_type* pmenu)
103 {
104   int i;
105   if(pmenu->num_items != 0 && pmenu->item != NULL)
106     {
107       for(i = 0; i < pmenu->num_items; ++i)
108         {
109           free(pmenu->item[i].text);
110           free(pmenu->item[i].input);
111           string_list_free(pmenu->item[i].list);
112         }
113       free(pmenu->item);
114     }
115 }
116
117 /* Initialize a menu */
118 void menu_init(menu_type* pmenu)
119 {
120   pmenu->arrange_left = 0;
121   pmenu->num_items = 0;
122   pmenu->active_item = 0;
123   pmenu->item = NULL;
124   timer_init(&pmenu->effect,NO);
125 }
126
127 /* Add an item to a menu */
128 void menu_additem(menu_type* pmenu, menu_item_type* pmenu_item)
129 {
130   ++pmenu->num_items;
131   pmenu->item = (menu_item_type*) realloc(pmenu->item, sizeof(menu_item_type) * pmenu->num_items);
132   memcpy(&pmenu->item[pmenu->num_items-1],pmenu_item,sizeof(menu_item_type));
133   free(pmenu_item);
134 }
135
136 /* Process actions done on the menu */
137 void menu_action(menu_type* pmenu)
138 {
139   menu_item_type& item = pmenu->item[pmenu->active_item];
140
141   if(pmenu->num_items != 0 && pmenu->item != NULL)
142     {
143       switch(menuaction)
144         {
145         case MENU_ACTION_UP:
146           if(pmenu->active_item > 0)
147             --pmenu->active_item;
148           else
149             pmenu->active_item = pmenu->num_items-1;
150           break;
151         case MENU_ACTION_DOWN:
152           if(pmenu->active_item < pmenu->num_items-1)
153             ++pmenu->active_item;
154           else
155             pmenu->active_item = 0;
156           break;
157         case MENU_ACTION_LEFT:
158           if(item.kind == MN_STRINGSELECT
159              && item.list->num_items != 0)
160             {
161               if(item.list->active_item > 0)
162                 --item.list->active_item;
163               else
164                 item.list->active_item = item.list->num_items-1;
165             }
166           break;
167         case MENU_ACTION_RIGHT:
168           if(item.kind == MN_STRINGSELECT 
169              && item.list->num_items != 0)
170             {
171               if(item.list->active_item < item.list->num_items-1)
172                 ++item.list->active_item;
173               else
174                 item.list->active_item = 0;
175             }
176           break;
177         case MENU_ACTION_HIT:
178           if(item.kind == MN_GOTO
179              && item.target_menu != NULL)
180             menu_set_current((menu_type*)item.target_menu);
181
182           else if(item.kind == MN_TOGGLE)
183             {
184               item.toggled = !item.toggled;
185               menu_change = YES;
186             }
187           else if(item.kind == MN_ACTION || item.kind == MN_TEXTFIELD || item.kind == MN_NUMFIELD)
188             {
189               item.toggled = YES;
190             }
191           else if(item.kind == MN_BACK)
192             {
193               if(last_menu != NULL)
194                 menu_set_current(last_menu);
195             }
196           break;
197         case MENU_ACTION_REMOVE:
198           if(item.kind == MN_TEXTFIELD
199              || item.kind == MN_NUMFIELD)
200             {
201               if(item.input != NULL)
202                 {
203                   int i = strlen(item.input);
204
205                   while(delete_character > 0)   /* remove charactes */
206                     {
207                       item.input[i-1] = '\0';
208                       delete_character--;
209                     }
210                 }
211             }
212           break;
213         case MENU_ACTION_INPUT:
214           if(item.kind == MN_TEXTFIELD
215              || (item.kind == MN_NUMFIELD && mn_input_char >= '0' && mn_input_char <= '9'))
216             {
217               if(item.input != NULL)
218                 {
219                   int i = strlen(item.input);
220                   item.input = (char*) realloc(item.input,sizeof(char)*(i + 2));
221                   item.input[i] = mn_input_char;
222                   item.input[i+1] = '\0';
223                 }
224               else
225                 {
226                   item.input = (char*) malloc(2*sizeof(char));
227                   item.input[0] = mn_input_char;
228                   item.input[1] = '\0';
229                 }
230             }
231           break;
232         case MENU_ACTION_NONE:
233           break;
234         }
235     }
236
237   if(item.kind == MN_DEACTIVE || item.kind == MN_LABEL || item.kind == MN_HL)
238     {
239       if(menuaction != MENU_ACTION_UP && menuaction != MENU_ACTION_DOWN)
240         menuaction = MENU_ACTION_DOWN;
241
242       if(pmenu->num_items > 1)
243         menu_action(pmenu);
244     }
245
246 }
247
248 /* Check, if the value of the active menu item has changed. */
249 int menu_check(menu_type* pmenu)
250 {
251   menu_item_type& item = pmenu->item[pmenu->active_item];
252
253   if(pmenu->num_items != 0 && pmenu->item != NULL)
254     {
255       if((item.kind == MN_ACTION || item.kind == MN_TEXTFIELD || item.kind == MN_NUMFIELD) && item.toggled == YES)
256         {
257           item.toggled = NO;
258           show_menu = 0;
259           return pmenu->active_item;
260         }
261       else if(item.kind == MN_TOGGLE || item.kind == MN_GOTO)
262         {
263           return pmenu->active_item;
264         }
265       else
266         return -1;
267     }
268   else
269     return -1;
270 }
271
272 void menu_draw_item(menu_type* pmenu, 
273                     int index, // Position of the current item in the menu
274                     int menu_width, 
275                     int menu_height)
276 {
277   int font_width  = 16;
278
279   const menu_item_type& pitem =  pmenu->item[index];
280
281   int effect_offset = 0;
282   {
283     int effect_time = 0;
284     if(timer_check(&pmenu->effect))
285       effect_time = timer_get_left(&pmenu->effect) / 4;
286
287     effect_offset = (index % 2) ? effect_time : -effect_time;
288   }
289
290   int x_pos       = screen->w/2;
291   int y_pos       = screen->h/2 + 24*index - menu_height/2 + 12 + effect_offset;
292   int shadow_size = 2;
293   int text_width  = strlen(pitem.text) * font_width;
294   int input_width = strlen(pitem.input) * font_width;
295   int list_width  = strlen(string_list_active(pitem.list)) * font_width;
296   text_type* text_font = &white_text;
297
298   if(pmenu->arrange_left == YES)
299     x_pos += 24 - menu_width/2 + (text_width + input_width + list_width)/2;
300   
301   if(index == pmenu->active_item)
302     {
303       shadow_size = 3;
304       text_font = &blue_text;
305     }
306
307   switch (pitem.kind)
308     {
309     case MN_DEACTIVE:
310       {
311         text_draw_align(&black_text, pitem.text, 
312                         x_pos, y_pos,
313                         A_HMIDDLE, A_VMIDDLE, 2);
314         break;
315       }
316
317     case MN_HL:
318       {
319         int x = screen->w/2 - menu_width/2; 
320         int y = y_pos - 12 - effect_offset;
321         /* Draw a horizontal line with a little 3d effect */
322         fillrect(x, y + 6,
323                  menu_width, 4,
324                  210,50,50,225);
325         fillrect(x, y + 10 + 6, 
326                  menu_width, 2,
327                  0,0,0,255);
328         break;
329       }
330     case MN_LABEL:
331       {
332         text_draw_align(&white_big_text, pitem.text, 
333                         x_pos, y_pos,
334                         A_HMIDDLE, A_VMIDDLE, 2);
335         break;
336       }
337     case MN_TEXTFIELD:
338     case MN_NUMFIELD:
339       {
340         int input_pos = input_width/2;
341         int text_pos  = (text_width + font_width)/2;
342
343         fillrect(x_pos - input_pos + text_pos - 1, y_pos - 10,
344                  input_width + font_width + 2, 20,
345                  255,255,255,255);
346         fillrect(x_pos - input_pos + text_pos, y_pos - 9,
347                  input_width + font_width, 18,
348                  0,0,0,128);
349
350         text_draw_align(&gold_text, pitem.input,
351                         x_pos + text_pos, y_pos, 
352                         A_HMIDDLE, A_VMIDDLE, 2);
353
354         text_draw_align(text_font, pitem.text, 
355                         x_pos - (input_width + font_width)/2, y_pos,
356                         A_HMIDDLE, A_VMIDDLE, shadow_size);
357         break;
358       }
359     case MN_STRINGSELECT:
360       {
361         int list_pos_2 = list_width + font_width;
362         int list_pos   = list_width/2;
363         int text_pos   = (text_width + font_width)/2;
364
365         /* Draw arrows */
366         texture_draw(&arrow_left,  x_pos - list_pos + text_pos - 17, y_pos - 8);
367         texture_draw(&arrow_right, x_pos - list_pos + text_pos - 1 + list_pos_2, y_pos - 8);
368
369         /* Draw input background */
370         fillrect(x_pos - list_pos + text_pos - 1, y_pos - 10,
371                  list_pos_2 + 2, 20,
372                  255,255,255,255);
373         fillrect(x_pos - list_pos + text_pos, y_pos - 9,
374                  list_pos_2, 18,
375                  0,0,0,128);
376
377         text_draw_align(&gold_text, string_list_active(pitem.list), 
378                         x_pos + text_pos, y_pos,
379                         A_HMIDDLE, A_VMIDDLE,2);
380
381         text_draw_align(text_font, pitem.text,
382                         x_pos - list_pos_2/2, y_pos,
383                         A_HMIDDLE, A_VMIDDLE, shadow_size);
384         break;
385       }
386     case MN_BACK:
387       {
388         text_draw_align(text_font, pitem.text, x_pos, y_pos, A_HMIDDLE, A_VMIDDLE, shadow_size);
389         texture_draw(&back, x_pos + text_width/2  + font_width, y_pos - 8);
390         break;
391       }
392
393     case MN_TOGGLE:
394       {
395         text_draw_align(text_font, pitem.text, x_pos, y_pos, A_HMIDDLE, A_VMIDDLE, shadow_size);
396         
397         if(pitem.toggled == YES)
398           texture_draw(&checkbox_checked, 
399                        x_pos + (text_width+font_width)/2,
400                        y_pos - 8);
401         else
402           texture_draw(&checkbox, 
403                        x_pos + (text_width+font_width)/2,
404                        y_pos - 8);
405         break;
406       }
407     case MN_ACTION:
408       text_draw_align(text_font, pitem.text, x_pos, y_pos, A_HMIDDLE, A_VMIDDLE, shadow_size);
409       break;
410
411     case MN_GOTO:
412       text_draw_align(text_font, pitem.text, x_pos, y_pos, A_HMIDDLE, A_VMIDDLE, shadow_size);
413       break;
414     }
415 }
416
417 /* Draw the current menu. */
418 void menu_draw(menu_type* pmenu)
419 {
420   int y;
421   int menu_height;
422   int menu_width;
423   
424   /* The width of the menu has to be more than the width of the text with the most characters */
425   menu_width = 0;
426   for(int i = 0; i < pmenu->num_items; ++i)
427     {
428       y = strlen(pmenu->item[i].text) + (pmenu->item[i].input ? strlen(pmenu->item[i].input) + 1 : 0) + strlen(string_list_active(pmenu->item[i].list));
429       if( y > menu_width )
430         {
431           menu_width = y;
432           if( pmenu->item[i].kind == MN_TOGGLE)
433             menu_width += 2;
434         }
435     }
436
437   menu_width  = menu_width * 16 + 48;
438   menu_height = (pmenu->num_items) * 24;
439
440   int center_x = screen->w/2;
441   /* Draw a transparent background */
442   fillrect(center_x - menu_width/2,screen->h/2-(((pmenu->num_items)*24)/2),menu_width,menu_height,150,150,150,100);
443
444   for(int i = 0; i < pmenu->num_items; ++i)
445     {
446       menu_draw_item(pmenu, i, menu_width, menu_height);
447     }
448 }
449
450 /* Reset/Set global defaults */
451 void menu_reset(void)
452 {
453   menu_change  = NO;
454   show_menu    = NO;
455   menuaction   = MENU_ACTION_NONE;
456   current_menu = NULL;
457   last_menu    = NULL;
458
459   delete_character = 0;
460   mn_input_char    = '\0';
461 }
462
463 /* --- MENU --- */
464 /* Draw the current menu and execute the (menu)events */
465 void menu_process_current(void)
466 {
467   menu_change = NO;
468
469   if(current_menu != NULL)
470     {
471       menu_action(current_menu);
472       menu_draw(current_menu);
473     }
474
475   menuaction = MENU_ACTION_NONE;
476 }
477
478 /* Check for menu event */
479 void menu_event(SDL_keysym* keysym)
480 {
481   SDLKey key = keysym->sym;
482   SDLMod keymod;
483   char ch[2];
484   keymod = SDL_GetModState();
485
486   /* If the current unicode character is an ASCII character,
487      assign it to ch. */
488   if ( (keysym->unicode & 0xFF80) == 0 )
489     {
490       ch[0] = keysym->unicode & 0x7F;
491       ch[1] = '\0';
492     }
493   else
494     {
495       /* An International Character. */
496     }
497
498   switch(key)
499     {
500     case SDLK_UP:               /* Menu Up */
501       menuaction = MENU_ACTION_UP;
502       menu_change = YES;
503       break;
504     case SDLK_DOWN:             /* Menu Down */
505       menuaction = MENU_ACTION_DOWN;
506       menu_change = YES;
507       break;
508     case SDLK_LEFT:             /* Menu Up */
509       menuaction = MENU_ACTION_LEFT;
510       menu_change = YES;
511       break;
512     case SDLK_RIGHT:            /* Menu Down */
513       menuaction = MENU_ACTION_RIGHT;
514       menu_change = YES;
515       break;
516     case SDLK_SPACE:
517       if(current_menu->item[current_menu->active_item].kind == MN_TEXTFIELD)
518       {
519       menuaction = MENU_ACTION_INPUT;
520       menu_change = YES;
521       mn_input_char = ' ';
522       break;
523       }
524     case SDLK_RETURN: /* Menu Hit */
525       menuaction = MENU_ACTION_HIT;
526       menu_change = YES;
527       break;
528     case SDLK_DELETE:
529     case SDLK_BACKSPACE:
530       menuaction = MENU_ACTION_REMOVE;
531       menu_change = YES;
532       delete_character++;
533       break;
534     default:
535       if( (key >= SDLK_0 && key <= SDLK_9) || (key >= SDLK_a && key <= SDLK_z) || (key >= SDLK_SPACE && key <= SDLK_SLASH))
536         {
537           menuaction = MENU_ACTION_INPUT;
538           menu_change = YES;
539           mn_input_char = *ch;
540         }
541       else
542         {
543           mn_input_char = '\0';
544         }
545       break;
546     }
547
548
549   /* FIXME: NO JOYSTICK SUPPORT */
550   /*#ifdef JOY_YES
551   else if (event.type == SDL_JOYBUTTONDOWN)
552    {
553       Joystick button: Continue:
554
555      done = 1;
556    }
557   #endif*/
558 }
559
560 menu_item_type*
561 menu_additem(menu_type* pmenu, MenuItemKind kind, char *text, int init_toggle, void* target_menu)
562 {
563   menu_item_type* item = menu_item_create(kind, text, init_toggle, target_menu);
564   menu_additem(pmenu, item);
565   return item;
566 }
567
568 // EOF //