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