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 int 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   int i;
 140
 141   if(pmenu->num_items != 0 && pmenu->item != NULL)
 142     {
 143       switch(menuaction)
 144         {
 145         case MN_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 MN_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 MN_LEFT:
 158           if(pmenu->item[pmenu->active_item].kind == MN_STRINGSELECT && pmenu->item[pmenu->active_item].list->num_items != 0)
 159             {
 160               if(pmenu->item[pmenu->active_item].list->active_item > 0)
 161                 --pmenu->item[pmenu->active_item].list->active_item;
 162               else
 163                 pmenu->item[pmenu->active_item].list->active_item = pmenu->item[pmenu->active_item].list->num_items-1;
 164             }
 165           break;
 166         case MN_RIGHT:
 167           if(pmenu->item[pmenu->active_item].kind == MN_STRINGSELECT && pmenu->item[pmenu->active_item].list->num_items != 0)
 168             {
 169               if(pmenu->item[pmenu->active_item].list->active_item < pmenu->item[pmenu->active_item].list->num_items-1)
 170                 ++pmenu->item[pmenu->active_item].list->active_item;
 171               else
 172                 pmenu->item[pmenu->active_item].list->active_item = 0;
 173             }
 174           break;
 175         case MN_HIT:
 176           if(pmenu->item[pmenu->active_item].kind == MN_GOTO && pmenu->item[pmenu->active_item].target_menu != NULL)
 177             menu_set_current((menu_type*)pmenu->item[pmenu->active_item].target_menu);
 178           else if(pmenu->item[pmenu->active_item].kind == MN_TOGGLE)
 179             {
 180               pmenu->item[pmenu->active_item].toggled = !pmenu->item[pmenu->active_item].toggled;
 181               menu_change = YES;
 182             }
 183           else if(pmenu->item[pmenu->active_item].kind == MN_ACTION || pmenu->item[pmenu->active_item].kind == MN_TEXTFIELD || pmenu->item[pmenu->active_item].kind == MN_NUMFIELD)
 184             {
 185               pmenu->item[pmenu->active_item].toggled = YES;
 186             }
 187           else if(pmenu->item[pmenu->active_item].kind == MN_BACK)
 188             {
 189               if(last_menu != NULL)
 190                 menu_set_current(last_menu);
 191             }
 192           break;
 193         case MN_REMOVE:
 194           if(pmenu->item[pmenu->active_item].kind == MN_TEXTFIELD || pmenu->item[pmenu->active_item].kind == MN_NUMFIELD)
 195             {
 196               if(pmenu->item[pmenu->active_item].input != NULL)
 197                 {
 198                   i = strlen(pmenu->item[pmenu->active_item].input);
 199
 200                   while(delete_character > 0)   /* remove charactes */
 201                     {
 202                       pmenu->item[pmenu->active_item].input[i-1] = '\0';
 203                       delete_character--;
 204                     }
 205                 }
 206             }
 207           break;
 208         case MN_INPUT:
 209           if(pmenu->item[pmenu->active_item].kind == MN_TEXTFIELD || (pmenu->item[pmenu->active_item].kind == MN_NUMFIELD && mn_input_char >= '0' && mn_input_char <= '9'))
 210             {
 211               if(pmenu->item[pmenu->active_item].input != NULL)
 212                 {
 213                   i = strlen(pmenu->item[pmenu->active_item].input);
 214                   pmenu->item[pmenu->active_item].input = (char*) realloc(pmenu->item[pmenu->active_item].input,sizeof(char)*(i + 2));
 215                   pmenu->item[pmenu->active_item].input[i] = mn_input_char;
 216                   pmenu->item[pmenu->active_item].input[i+1] = '\0';
 217                 }
 218               else
 219                 {
 220                   pmenu->item[pmenu->active_item].input = (char*) malloc(2*sizeof(char));
 221                   pmenu->item[pmenu->active_item].input[0] = mn_input_char;
 222                   pmenu->item[pmenu->active_item].input[1] = '\0';
 223                 }
 224             }
 225           break;
 226         }
 227     }
 228
 229   if(pmenu->item[pmenu->active_item].kind == MN_DEACTIVE || pmenu->item[pmenu->active_item].kind == MN_LABEL || pmenu->item[pmenu->active_item].kind == MN_HL)
 230     {
 231       if(menuaction != MN_UP && menuaction != MN_DOWN)
 232         menuaction = MN_DOWN;
 233
 234       if(pmenu->num_items > 1)
 235         menu_action(pmenu);
 236     }
 237
 238 }
 239
 240 /* Check, if the value of the active menu item has changed. */
 241 int menu_check(menu_type* pmenu)
 242 {
 243   if(pmenu->num_items != 0 && pmenu->item != NULL)
 244     {
 245       if((pmenu->item[pmenu->active_item].kind == MN_ACTION || pmenu->item[pmenu->active_item].kind == MN_TEXTFIELD || pmenu->item[pmenu->active_item].kind == MN_NUMFIELD) && pmenu->item[pmenu->active_item].toggled == YES)
 246         {
 247           pmenu->item[pmenu->active_item].toggled = NO;
 248           show_menu = 0;
 249           return pmenu->active_item;
 250         }
 251       else if(pmenu->item[pmenu->active_item].kind == MN_TOGGLE || pmenu->item[pmenu->active_item].kind == MN_GOTO)
 252         {
 253           return pmenu->active_item;
 254         }
 255       else
 256         return -1;
 257     }
 258   else
 259     return -1;
 260 }
 261
 262 void menu_draw_item(menu_type* pmenu,
 263                     int index, // Position of the current item in the menu
 264                     int menu_width,
 265                     int menu_height)
 266 {
 267   int font_width  = 16;
 268
 269   const menu_item_type& pitem =  pmenu->item[index];
 270
 271   int effect_offset = 0;
 272   {
 273     int effect_time = 0;
 274     if(timer_check(&pmenu->effect))
 275       effect_time = timer_get_left(&pmenu->effect) / 4;
 276
 277     effect_offset = (index % 2) ? effect_time : -effect_time;
 278   }
 279
 280   int x_pos       = screen->w/2;
 281   int y_pos       = screen->h/2 + 24*index - menu_height/2 + 12 + effect_offset;
 282   int shadow_size = 2;
 283   int text_width  = strlen(pitem.text) * font_width;
 284   int input_width = strlen(pitem.input) * font_width;
 285   int list_width  = strlen(string_list_active(pitem.list)) * font_width;
 286   text_type* text_font = &white_text;
 287
 288   if(pmenu->arrange_left == YES)
 289     x_pos += 24 - menu_width/2 + (text_width + input_width + list_width)/2;
 290
 291   if(index == pmenu->active_item)
 292     {
 293       shadow_size = 3;
 294       text_font = &blue_text;
 295     }
 296
 297   switch (pitem.kind)
 298     {
 299     case MN_DEACTIVE:
 300       {
 301         text_draw_align(&black_text, pitem.text,
 302                    x_pos, y_pos,
 303                    A_HMIDDLE, A_VMIDDLE, 2);
 304         break;
 305       }
 306
 307     case MN_HL:
 308       {
 309         int x = screen->w/2 - menu_width/2;
 310         int y = y_pos - 12 - effect_offset;
 311         /* Draw a horizontal line with a little 3d effect */
 312         fillrect(x, y + 6,
 313                  menu_width, 4,
 314                  210,50,50,225);
 315         fillrect(x, y + 10 + 6,
 316                  menu_width, 2,
 317                  0,0,0,255);
 318         break;
 319       }
 320     case MN_LABEL:
 321       {
 322         text_draw_align(&white_big_text, pitem.text,
 323                         x_pos, y_pos,
 324                         A_HMIDDLE, A_VMIDDLE, 2);
 325         break;
 326       }
 327     case MN_TEXTFIELD:
 328     case MN_NUMFIELD:
 329       {
 330         int input_pos = input_width/2;
 331         int text_pos  = (text_width + font_width)/2;
 332
 333         fillrect(x_pos - input_pos + text_pos - 1, y_pos - 10,
 334                  input_width + font_width + 2, 20,
 335                  255,255,255,255);
 336         fillrect(x_pos - input_pos + text_pos, y_pos - 9,
 337                  input_width + font_width, 18,
 338                  0,0,0,128);
 339
 340         text_draw_align(&gold_text, pitem.input,
 341                         x_pos + text_pos, y_pos,
 342                         A_HMIDDLE, A_VMIDDLE, 2);
 343
 344         text_draw_align(text_font, pitem.text,
 345                         x_pos - (input_width + font_width)/2, y_pos,
 346                         A_HMIDDLE, A_VMIDDLE, shadow_size);
 347         break;
 348       }
 349     case MN_STRINGSELECT:
 350       {
 351         int list_pos_2 = list_width + font_width;
 352         int list_pos   = list_width/2;
 353         int text_pos   = (text_width + font_width)/2;
 354
 355         /* Draw arrows */
 356         texture_draw(&arrow_left,  x_pos - list_pos + text_pos - 17, y_pos - 8);
 357         texture_draw(&arrow_right, x_pos - list_pos + text_pos - 1 + list_pos_2, y_pos - 8);
 358
 359         /* Draw input background */
 360         fillrect(x_pos - list_pos + text_pos - 1, y_pos - 10,
 361                  list_pos_2 + 2, 20,
 362                  255,255,255,255);
 363         fillrect(x_pos - list_pos + text_pos, y_pos - 9,
 364                  list_pos_2, 18,
 365                  0,0,0,128);
 366
 367         text_draw_align(&gold_text, string_list_active(pitem.list),
 368                    x_pos + text_pos, y_pos,
 369                    A_HMIDDLE, A_VMIDDLE,2);
 370
 371         text_draw_align(text_font, pitem.text,
 372                         x_pos - list_pos_2/2, y_pos,
 373                         A_HMIDDLE, A_VMIDDLE, shadow_size);
 374         break;
 375       }
 376     case MN_BACK:
 377       {
 378         texture_draw(&back, x_pos + text_width/2  + font_width, y_pos - 8);
 379         break;
 380       }
 381
 382     case MN_TOGGLE:
 383       {
 384         if(pitem.toggled == YES)
 385           texture_draw(&checkbox_checked,
 386                        x_pos + (text_width+font_width)/2,
 387                        y_pos - 8);
 388         else
 389           texture_draw(&checkbox,
 390                        x_pos + (text_width+font_width)/2,
 391                        y_pos - 8);
 392         break;
 393       }
 394     case MN_ACTION:
 395       break;
 396
 397     case MN_GOTO:
 398       break;
 399     }
 400
 401   switch (pitem.kind)
 402     {
 403     case MN_ACTION:
 404     case MN_GOTO:
 405     case MN_TOGGLE:
 406     case MN_BACK:
 407       text_draw_align(text_font, pitem.text, x_pos, y_pos, A_HMIDDLE, A_VMIDDLE, shadow_size);
 408       break;
 409     case MN_DEACTIVE:
 410     case MN_TEXTFIELD:
 411     case MN_NUMFIELD:
 412     case MN_STRINGSELECT:
 413     case MN_LABEL:
 414     case MN_HL:
 415       break;
 416     }
 417 }
 418
 419 /* Draw the current menu. */
 420 void menu_draw(menu_type* pmenu)
 421 {
 422   int y;
 423   int menu_height;
 424   int menu_width;
 425
 426   /* The width of the menu has to be more than the width of the text with the most characters */
 427   menu_width = 0;
 428   for(int i = 0; i < pmenu->num_items; ++i)
 429     {
 430       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));
 431       if( y > menu_width )
 432         {
 433           menu_width = y;
 434           if( pmenu->item[i].kind == MN_TOGGLE)
 435             menu_width += 2;
 436         }
 437     }
 438
 439   menu_width  = menu_width * 16 + 48;
 440   menu_height = (pmenu->num_items) * 24;
 441
 442   int center_x = screen->w/2;
 443   /* Draw a transparent background */
 444   fillrect(center_x - menu_width/2,screen->h/2-(((pmenu->num_items)*24)/2),menu_width,menu_height,150,150,150,100);
 445
 446   for(int i = 0; i < pmenu->num_items; ++i)
 447     {
 448       menu_draw_item(pmenu, i, menu_width, menu_height);
 449     }
 450 }
 451
 452 /* Reset/Set global defaults */
 453 void menu_reset(void)
 454 {
 455   menu_change = NO;
 456   show_menu = NO;
 457   menuaction = -1;
 458   current_menu = NULL;
 459   last_menu = NULL;
 460
 461   delete_character = 0;
 462   mn_input_char = '\0';
 463 }
 464
 465 /* --- MENU --- */
 466 /* Draw the current menu and execute the (menu)events */
 467 void menu_process_current(void)
 468 {
 469   menu_change = NO;
 470
 471   if(current_menu != NULL)
 472     {
 473       menu_action(current_menu);
 474       menu_draw(current_menu);
 475     }
 476
 477   menuaction = -1;
 478 }
 479
 480 /* Check for menu event */
 481 void menu_event(SDL_keysym* keysym)
 482 {
 483   SDLKey key = keysym->sym;
 484   SDLMod keymod;
 485   char ch[2];
 486   keymod = SDL_GetModState();
 487
 488   /* If the current unicode character is an ASCII character,
 489      assign it to ch. */
 490   if ( (keysym->unicode & 0xFF80) == 0 )
 491     {
 492       ch[0] = keysym->unicode & 0x7F;
 493       ch[1] = '\0';
 494     }
 495   else
 496     {
 497       /* An International Character. */
 498     }
 499
 500   switch(key)
 501     {
 502     case SDLK_UP:               /* Menu Up */
 503       menuaction = MN_UP;
 504       menu_change = YES;
 505       break;
 506     case SDLK_DOWN:             /* Menu Down */
 507       menuaction = MN_DOWN;
 508       menu_change = YES;
 509       break;
 510     case SDLK_LEFT:             /* Menu Up */
 511       menuaction = MN_LEFT;
 512       menu_change = YES;
 513       break;
 514     case SDLK_RIGHT:            /* Menu Down */
 515       menuaction = MN_RIGHT;
 516       menu_change = YES;
 517       break;
 518     case SDLK_SPACE:
 519       if(current_menu->item[current_menu->active_item].kind == MN_TEXTFIELD)
 520       {
 521       menuaction = MN_INPUT;
 522       menu_change = YES;
 523       mn_input_char = ' ';
 524       break;
 525       }
 526     case SDLK_RETURN: /* Menu Hit */
 527       menuaction = MN_HIT;
 528       menu_change = YES;
 529       break;
 530     case SDLK_DELETE:
 531     case SDLK_BACKSPACE:
 532       menuaction = MN_REMOVE;
 533       menu_change = YES;
 534       delete_character++;
 535       break;
 536     default:
 537       if( (key >= SDLK_0 && key <= SDLK_9) || (key >= SDLK_a && key <= SDLK_z) || (key >= SDLK_SPACE && key <= SDLK_SLASH))
 538         {
 539           menuaction = MN_INPUT;
 540           menu_change = YES;
 541           mn_input_char = *ch;
 542         }
 543       else
 544         {
 545           mn_input_char = '\0';
 546         }
 547       break;
 548     }
 549
 550
 551   /* FIXME: NO JOYSTICK SUPPORT */
 552   /*#ifdef JOY_YES
 553   else if (event.type == SDL_JOYBUTTONDOWN)
 554    {
 555       Joystick button: Continue:
 556
 557      done = 1;
 558    }
 559   #endif*/
 560 }
 561