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 x_pos = 0;
 272   if(pmenu->arrange_left == YES)
 273     x_pos = 24 - menu_width/2
 274       + (font_width * (strlen(pitem.text)
 275                + strlen(pitem.input)
 276                + strlen(string_list_active(pitem.list))))/2;
 277
 278   int effect_offset = 0;
 279   {
 280     int effect_time = 0;
 281     if(timer_check(&pmenu->effect))
 282       effect_time = timer_get_left(&pmenu->effect) / 4;
 283
 284     effect_offset = (index % 2) ? effect_time : -effect_time;
 285   }
 286
 287   int raw_y_pos  = 24*index - menu_height/2;
 288   int top        = raw_y_pos + effect_offset;
 289   int bottom     = top + 10; // bottom of the menu item
 290
 291   int start_x    = screen->w/2 + x_pos;
 292   int cen_y_10_f = screen->h/2 + bottom;
 293
 294   int shadow_size = 2;
 295   text_type* text_font = &white_text;
 296   if(index == pmenu->active_item)
 297     {
 298       shadow_size = 3;
 299       text_font = &blue_text;
 300     }
 301
 302   switch (pitem.kind)
 303     {
 304     case MN_DEACTIVE:
 305       {
 306         text_drawf(&black_text, pitem.text,
 307                    x_pos, bottom,
 308                    A_HMIDDLE, A_VMIDDLE, 2);
 309         break;
 310       }
 311
 312     case MN_HL:
 313       {
 314         int x = screen->w/2 - menu_width/2;
 315         int y = screen->h/2 + raw_y_pos;
 316         /* Draw a horizontal line with a little 3d effect */
 317         fillrect(x, y + 6,
 318                  menu_width, 4,
 319                  210,50,50,225);
 320         fillrect(x, y + 10 + 6,
 321                  menu_width, 2,
 322                  0,0,0,255);
 323         break;
 324       }
 325     case MN_LABEL:
 326       {
 327         text_drawf(&white_big_text, pitem.text,
 328                    x_pos, bottom,
 329                    A_HMIDDLE, A_VMIDDLE, 2);
 330         break;
 331       }
 332     case MN_TEXTFIELD:
 333     case MN_NUMFIELD:
 334       {
 335         int input_pos = (strlen(pitem.input)*font_width)/2;
 336         int text_pos  = (strlen(pitem.text)+1)*font_width/2;
 337
 338         fillrect(start_x - input_pos + text_pos - 1, cen_y_10_f - 10,
 339                  (strlen(pitem.input)+1)*font_width + 2, 20,
 340                  255,255,255,255);
 341         fillrect(start_x - input_pos + text_pos, cen_y_10_f - 9,
 342                  (strlen(pitem.input)+1)*font_width, 18,
 343                  0,0,0,128);
 344
 345         text_drawf(&gold_text, pitem.input,
 346                    x_pos + text_pos, bottom,
 347                    A_HMIDDLE, A_VMIDDLE, 2);
 348
 349         text_drawf(text_font, pitem.text,
 350                    x_pos - (((strlen(pitem.input)+1) * font_width)/2), bottom,
 351                    A_HMIDDLE, A_VMIDDLE, shadow_size);
 352         break;
 353       }
 354     case MN_STRINGSELECT:
 355       {
 356         int list_pos_2 = (strlen(string_list_active(pitem.list))+1)*font_width;
 357         int list_pos   = (strlen(string_list_active(pitem.list))*font_width)/2;
 358         int text_pos   = ((strlen(pitem.text) + 1)*font_width)/2;
 359
 360         /* Draw arrows */
 361         texture_draw(&arrow_left,  start_x - list_pos + text_pos - 17, cen_y_10_f - 8);
 362         texture_draw(&arrow_right, start_x - list_pos + text_pos - 1 + list_pos_2, cen_y_10_f - 8);
 363
 364         /* Draw input background */
 365         fillrect(start_x - list_pos + text_pos - 1, cen_y_10_f - 10,
 366                  list_pos_2 + 2, 20,
 367                  255,255,255,255);
 368         fillrect(start_x - list_pos + text_pos, cen_y_10_f - 9,
 369                  list_pos_2, 18,
 370                  0,0,0,128);
 371
 372         text_drawf(&gold_text, string_list_active(pitem.list),
 373                    x_pos + text_pos, bottom,
 374                    A_HMIDDLE, A_VMIDDLE,2);
 375
 376         text_drawf(text_font, pitem.text,
 377                    x_pos - list_pos_2/2, bottom,
 378                    A_HMIDDLE, A_VMIDDLE, shadow_size);
 379         break;
 380       }
 381     case MN_BACK:
 382       {
 383         texture_draw(&back, start_x + (strlen(pitem.text) * font_width)/2  + font_width, cen_y_10_f - 8);
 384         break;
 385       }
 386
 387     case MN_TOGGLE:
 388       {
 389         if(pitem.toggled == YES)
 390           texture_draw(&checkbox_checked, start_x + (strlen(pitem.text) * font_width)/2 + font_width, cen_y_10_f - 8);
 391         else
 392           texture_draw(&checkbox, start_x + (strlen(pitem.text) * font_width)/2 + font_width, cen_y_10_f - 8);
 393         break;
 394       }
 395     case MN_ACTION:
 396       break;
 397
 398     case MN_GOTO:
 399       break;
 400     }
 401
 402   switch (pitem.kind)
 403     {
 404     case MN_ACTION:
 405     case MN_GOTO:
 406     case MN_TOGGLE:
 407     case MN_BACK:
 408       text_drawf(text_font, pitem.text, x_pos, bottom, A_HMIDDLE, A_VMIDDLE, shadow_size);
 409       break;
 410     case MN_DEACTIVE:
 411     case MN_TEXTFIELD:
 412     case MN_NUMFIELD:
 413     case MN_STRINGSELECT:
 414     case MN_LABEL:
 415     case MN_HL:
 416       break;
 417     }
 418 }
 419
 420 /* Draw the current menu. */
 421 void menu_draw(menu_type* pmenu)
 422 {
 423   int y;
 424   int menu_height;
 425   int menu_width;
 426
 427   /* The width of the menu has to be more than the width of the text with the most characters */
 428   menu_width = 0;
 429   for(int i = 0; i < pmenu->num_items; ++i)
 430     {
 431       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));
 432       if( y > menu_width )
 433         {
 434           menu_width = y;
 435           if( pmenu->item[i].kind == MN_TOGGLE)
 436             menu_width += 2;
 437         }
 438     }
 439
 440   menu_width  = menu_width * 16 + 48;
 441   menu_height = (pmenu->num_items) * 24;
 442
 443   int center_x = screen->w/2;
 444   /* Draw a transparent background */
 445   fillrect(center_x - menu_width/2,screen->h/2-(((pmenu->num_items)*24)/2),menu_width,menu_height,150,150,150,100);
 446
 447   for(int i = 0; i < pmenu->num_items; ++i)
 448     {
 449       menu_draw_item(pmenu, i, menu_width, menu_height);
 450     }
 451 }
 452
 453 /* Reset/Set global defaults */
 454 void menu_reset(void)
 455 {
 456   menu_change = NO;
 457   show_menu = NO;
 458   menuaction = -1;
 459   current_menu = NULL;
 460   last_menu = NULL;
 461
 462   delete_character = 0;
 463   mn_input_char = '\0';
 464 }
 465
 466 /* --- MENU --- */
 467 /* Draw the current menu and execute the (menu)events */
 468 void menu_process_current(void)
 469 {
 470   menu_change = NO;
 471
 472   if(current_menu != NULL)
 473     {
 474       menu_action(current_menu);
 475       menu_draw(current_menu);
 476     }
 477
 478   menuaction = -1;
 479 }
 480
 481 /* Check for menu event */
 482 void menu_event(SDL_keysym* keysym)
 483 {
 484   SDLKey key = keysym->sym;
 485   SDLMod keymod;
 486   char ch[2];
 487   keymod = SDL_GetModState();
 488
 489   /* If the current unicode character is an ASCII character,
 490      assign it to ch. */
 491   if ( (keysym->unicode & 0xFF80) == 0 )
 492     {
 493       ch[0] = keysym->unicode & 0x7F;
 494       ch[1] = '\0';
 495     }
 496   else
 497     {
 498       /* An International Character. */
 499     }
 500
 501   switch(key)
 502     {
 503     case SDLK_UP:               /* Menu Up */
 504       menuaction = MN_UP;
 505       menu_change = YES;
 506       break;
 507     case SDLK_DOWN:             /* Menu Down */
 508       menuaction = MN_DOWN;
 509       menu_change = YES;
 510       break;
 511     case SDLK_LEFT:             /* Menu Up */
 512       menuaction = MN_LEFT;
 513       menu_change = YES;
 514       break;
 515     case SDLK_RIGHT:            /* Menu Down */
 516       menuaction = MN_RIGHT;
 517       menu_change = YES;
 518       break;
 519     case SDLK_SPACE:
 520       if(current_menu->item[current_menu->active_item].kind == MN_TEXTFIELD)
 521       {
 522       menuaction = MN_INPUT;
 523       menu_change = YES;
 524       mn_input_char = ' ';
 525       break;
 526       }
 527     case SDLK_RETURN: /* Menu Hit */
 528       menuaction = MN_HIT;
 529       menu_change = YES;
 530       break;
 531     case SDLK_DELETE:
 532     case SDLK_BACKSPACE:
 533       menuaction = MN_REMOVE;
 534       menu_change = YES;
 535       delete_character++;
 536       break;
 537     default:
 538       if( (key >= SDLK_0 && key <= SDLK_9) || (key >= SDLK_a && key <= SDLK_z) || (key >= SDLK_SPACE && key <= SDLK_SLASH))
 539         {
 540           menuaction = MN_INPUT;
 541           menu_change = YES;
 542           mn_input_char = *ch;
 543         }
 544       else
 545         {
 546           mn_input_char = '\0';
 547         }
 548       break;
 549     }
 550
 551
 552   /* FIXME: NO JOYSTICK SUPPORT */
 553   /*#ifdef JOY_YES
 554   else if (event.type == SDL_JOYBUTTONDOWN)
 555    {
 556       Joystick button: Continue:
 557
 558      done = 1;
 559    }
 560   #endif*/
 561 }
 562