src/ui/inputbox.cpp

   1 /*
   2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
   3  *
   4  * All source code herein is the property of Volition, Inc. You may not sell
   5  * or otherwise commercially exploit the source or things you created based on
   6  * the source.
   7  */
   8
   9 /*
  10  * $Logfile: /Freespace2/code/Ui/INPUTBOX.cpp $
  11  * $Revision$
  12  * $Date$
  13  * $Author$
  14  *
  15  * Code to implement input boxes
  16  *
  17  * $Log$
  18  * Revision 1.3  2004/09/20 01:31:45  theoddone33
  19  * GCC 3.4 fixes.
  20  *
  21  * Revision 1.2  2002/06/09 04:41:29  relnev
  22  * added copyright header
  23  *
  24  * Revision 1.1.1.1  2002/05/03 03:28:11  root
  25  * Initial import.
  26  *
  27  *
  28  * 8     9/07/99 4:01p Dave
  29  * Fixed up a string.tbl paroblem (self destruct message). Make sure IPX
  30  * does everything properly (setting up address when binding). Remove
  31  * black rectangle background from UI_INPUTBOX.
  32  *
  33  * 7     7/15/99 7:14p Jefff
  34  *
  35  * 6     6/25/99 11:59a Dave
  36  * Multi options screen.
  37  *
  38  * 5     2/11/99 3:08p Dave
  39  * PXO refresh button. Very preliminary squad war support.
  40  *
  41  * 4     12/02/98 5:47p Dave
  42  * Put in interface xstr code. Converted barracks screen to new format.
  43  *
  44  * 3     10/13/98 9:29a Dave
  45  * Started neatening up freespace.h. Many variables renamed and
  46  * reorganized. Added AlphaColors.[h,cpp]
  47  *
  48  * 2     10/07/98 10:54a Dave
  49  * Initial checkin.
  50  *
  51  * 1     10/07/98 10:51a Dave
  52  *
  53  * 43    5/14/98 6:29p Hoffoss
  54  * Fixed some warnings a release rebuild all turned up.
  55  *
  56  * 42    4/14/98 5:06p Dave
  57  * Don't load or send invalid pilot pics. Fixed chatbox graphic errors.
  58  * Made chatbox display team icons in a team vs. team game. Fixed up pause
  59  * and endgame sequencing issues.
  60  *
  61  * 41    4/12/98 5:31p Lawrance
  62  * use timer_get_milliseconds() instead of gettime()
  63  *
  64  * 40    4/10/98 5:36p Dave
  65  * Put in user notification of illegal values in multi host options
  66  * screen. Fixed server respawn ship class problem.
  67  *
  68  * 39    4/09/98 3:10p Mike
  69  * Fix shockingly stupid typo.
  70  *
  71  * 38    4/09/98 2:46p Mike
  72  * Fix bug preventing first letter in pilot name being capitalized.
  73  *
  74  * 37    4/09/98 12:12p Mike
  75  * Separate versioning for demo and full versions.
  76  * Fix inputbox bugs.
  77  *
  78  * 36    4/06/98 5:14p Hoffoss
  79  * Added some needed asserts.
  80  *
  81  * 35    4/06/98 4:25p Allender
  82  * Fix strncpy bug in inputbox
  83  *
  84  * 34    4/06/98 3:58p Frank
  85  * added initialization to try and fix a bug.
  86  *
  87  * 33    4/01/98 10:26a Hoffoss
  88  * Changed input box code to not draw a cursor if the input box is
  89  * disabled.
  90  *
  91  * 32    3/27/98 4:01p Hoffoss
  92  * Fixed bug where input box text wsn't being null terminated!  Bad!
  93  *
  94  * 31    3/27/98 3:04p Mitri
  95  * Fixed bug in set_text().  'length' is the number of characters allowed,
  96  * EXCLUDING the null terminator.
  97  *
  98  * 30    3/27/98 11:20a Hoffoss
  99  * Changed input to use bright white text instead of bright green.
 100  *
 101  * 29    3/10/98 11:29a Hoffoss
 102  * Make first_time ignored and text not disappear after a return is
 103  * pressed.
 104  *
 105  * 28    2/26/98 4:21p Dave
 106  * More robust multiplayer voice.
 107  *
 108  * 27    1/23/98 5:43p Dave
 109  * Finished bringing standalone up to speed. Coded in new host options
 110  * screen.
 111  *
 112  * 26    1/20/98 10:36a Hoffoss
 113  * Fixed optimized warnings.
 114  *
 115  * 25    1/17/98 5:51p Dave
 116  * Bug fixes for bugs generated by multiplayer testing.
 117  *
 118  * 24    1/16/98 7:57p Lawrance
 119  * support animating input box cursor
 120  *
 121  * 23    1/15/98 5:12p Hoffoss
 122  * Fixed inputbox so clicking on it gives it focus.
 123  *
 124  * 22    1/15/98 5:10p Allender
 125  * ton of interface changes.  chatbox in multiplayer now behaves
 126  * differently than before.  It's always active in any screen that uses
 127  * it.  Only non-printatble characters will get passed back out from
 128  * chatbox
 129  *
 130  * 21    1/14/98 6:43p Hoffoss
 131  * Massive changes to UI code.  A lot cleaner and better now.  Did all
 132  * this to get the new UI_DOT_SLIDER to work properly, which the old code
 133  * wasn't flexible enough to handle.
 134  *
 135  * 20    1/05/98 1:15p John
 136  * Made inputbox skip the initial "selected" phase when you first tab to
 137  * it.
 138  *
 139  * 19    12/22/97 5:08p Hoffoss
 140  * Changed inputbox class to be able to accept only certain keys, changed
 141  * pilot screens to utilize this feature.  Added to assert with pilot file
 142  * saving.
 143  *
 144  * 18    12/11/97 8:15p Dave
 145  * Put in network options screen. Xed out olf protocol selection screen.
 146  *
 147  * 17    12/08/97 6:22p Lawrance
 148  * blink cursor on inputbox
 149  *
 150  * 16    12/06/97 4:27p Dave
 151  * Another load of interface and multiplayer bug fixes.
 152  *
 153  * 15    11/25/97 3:51p Hoffoss
 154  * Changed edit background rect position slightly.
 155  *
 156  * 14    10/24/97 10:58p Hoffoss
 157  * Made some changes to the UI code to do some things I need it to do.
 158  *
 159  * 13    10/09/97 11:05a Allender
 160  * ignore controled and alted keys in input box
 161  *
 162  * 12    10/01/97 4:39p Lawrance
 163  * null out text when free'ed
 164  *
 165  * 11    9/09/97 3:39p Sandeep
 166  * warning level 4 bugs
 167  *
 168  * 10    8/21/97 12:13p Dave
 169  * Made it possible for input box to ignore esc to lose focus.
 170  *
 171  * 9     8/19/97 1:28p Dave
 172  * Made it possible to limit characters by pixel width.
 173  *
 174  * 8     8/15/97 8:21p Dave
 175  * Modified UI_INPUTBOX so that it is possible to draw it invisibly. That
 176  * is, only the text is displayed.
 177  *
 178  * 7     8/11/97 9:48p Lawrance
 179  * reset clip after drawing
 180  *
 181  * 6     7/01/97 2:10p Dave
 182  * Fixed bug which caused the box to stop responding after user called
 183  * set_text(...) with a 0 length string.
 184  *
 185  * 5     6/12/97 12:39p John
 186  * made ui use freespace colors
 187  *
 188  * 4     6/11/97 1:13p John
 189  * Started fixing all the text colors in the game.
 190  *
 191  * 3     12/03/96 3:46p Lawrance
 192  * added ability to set contents of input box
 193  *
 194  * 2     11/15/96 11:43a John
 195  *
 196  * 1     11/15/96 8:21a John
 197  *
 198  * $NoKeywords: $
 199  */
 200
 201 #include <ctype.h>
 202 #include "uidefs.h"
 203 #include "ui.h"
 204 #include "bmpman.h"
 205 #include "timer.h"
 206 #include "alphacolors.h"
 207 #include "font.h"
 208
 209
 210 #define INPUTBOX_PASSWD_CHAR        '*'   // the password protected char
 211
 212 //      Retuen true if c is a letter, else return false.
 213 int is_letter(char c)
 214 {
 215         return ((c >= 'a') && (c <= 'z')) || ((c >= 'A') && (c <= 'Z'));
 216 }
 217
 218 // insert character c into string s at position p.
 219 void strcins(char *s, int p, char c)
 220 {
 221         int n;
 222         for (n=strlen(s)-p; n>=0; n-- )
 223                 *(s+p+n+1) = *(s+p+n);   // Move everything over
 224         *(s+p) = c;         // then insert the character
 225 }
 226
 227 // delete n character from string s starting at position p
 228
 229 void strndel(char *s, int p, int n)
 230 {
 231         for (; (*(s+p) = *(s+p+n)) != '\0'; s++ )
 232                 *(s+p+n) = '\0';    // Delete and zero fill
 233 }
 234
 235 void UI_INPUTBOX::init_cursor()
 236 {
 237         cursor_first_frame = bm_load_animation("cursor1", &cursor_nframes, &cursor_fps);
 238         if ( cursor_first_frame < 0 ) {
 239                 Warning(LOCATION,"Cannot load input box cursor: cursor1.ani\n");
 240                 return;
 241         }
 242         cursor_elapsed_time=0;
 243         cursor_current_frame=0;
 244 }
 245
 246 void UI_INPUTBOX::create(UI_WINDOW *wnd, int _x, int _y, int _w, int _text_len, const char *_text, int _flags, int pixel_lim, color *clr)
 247 {
 248         int tw, th;
 249
 250         SDL_assert(_text_len >= 0);
 251         SDL_assert((int) strlen(_text) <= _text_len);
 252         gr_set_font(wnd->f_id);
 253         gr_get_string_size( &tw, &th, "*" );
 254
 255         // check to see if the user passed in a text color otherwise use the default green color
 256         if (clr){
 257                 text_color = clr;
 258         } else {
 259                 text_color = &CBRIGHT;
 260         }
 261
 262         base_create( wnd, UI_KIND_INPUTBOX, _x, _y, _w, th+4 );
 263         text = (char *) malloc( _text_len + 1);
 264
 265         // input boxes no longer use background
 266         _flags |= UI_INPUTBOX_FLAG_NO_BACK;
 267
 268         // if its in "password" mode, allocate a second string
 269         // and copy it
 270         if (_flags & UI_INPUTBOX_FLAG_PASSWD) {
 271                 passwd_text = (char *) malloc(_text_len + 1);
 272                 memset(passwd_text, INPUTBOX_PASSWD_CHAR, strlen(_text));
 273                 passwd_text[strlen(_text)] = 0;
 274
 275         } else {
 276                 passwd_text = NULL;
 277         }
 278
 279         init_cursor();
 280
 281         if ( _text_len > 0 ) {
 282                 SDL_strlcpy( text, _text, _text_len+1 );
 283         }
 284         text[_text_len] = 0;
 285         position = strlen(_text);
 286         oldposition = position;
 287         length = _text_len;
 288         pressed_down = 0;
 289 //      first_time = 1;
 290         changed_flag = 0;
 291         flags = _flags;
 292         pixel_limit = pixel_lim;
 293         locked = 0;
 294         valid_chars = NULL;
 295         invalid_chars = NULL;
 296 };
 297
 298 void UI_INPUTBOX::set_valid_chars(const char *vchars)
 299 {
 300         // free up any existing string
 301         if(valid_chars != NULL){
 302                 free(valid_chars);
 303                 valid_chars = NULL;
 304         }
 305
 306         valid_chars = strdup(vchars);
 307 }
 308
 309 void UI_INPUTBOX::set_invalid_chars(const char *ichars)
 310 {
 311         // free up any existing string
 312         if(invalid_chars != NULL){
 313                 free(invalid_chars);
 314                 invalid_chars = NULL;
 315         }
 316
 317         invalid_chars = strdup(ichars);
 318 }
 319
 320 void UI_INPUTBOX::destroy()
 321 {
 322         if (text) {
 323                 free(text);
 324                 text = NULL;
 325         }
 326
 327         // free any valid chars
 328         if(valid_chars != NULL){
 329                 free(valid_chars);
 330                 valid_chars = NULL;
 331         }
 332
 333         // free any invalid chars
 334         if(invalid_chars != NULL){
 335                 free(invalid_chars);
 336                 invalid_chars = NULL;
 337         }
 338
 339         if ((flags & UI_INPUTBOX_FLAG_PASSWD) && passwd_text) {
 340                 free(passwd_text);
 341                 passwd_text = NULL;
 342         }
 343
 344         UI_GADGET::destroy();
 345 }
 346
 347 void UI_INPUTBOX::draw()
 348 {
 349         int invis, w1, h1, tw, th;
 350         int text_x, text_y;
 351
 352         if (hidden){
 353                 return;
 354         }
 355
 356         w1 = w;
 357         h1 = h;
 358         invis = flags & UI_INPUTBOX_FLAG_INVIS;
 359
 360         gr_set_font(my_wnd->f_id);
 361         gr_reset_clip();
 362         if (!invis && !(flags & UI_INPUTBOX_FLAG_NO_BACK)) {
 363                 // draw the entire text box region
 364                 ui_draw_sunken_border( x-2, y-2, x+w+1, y+h+1 );
 365                 gr_set_color_fast( &CBLACK );
 366                 gr_rect( 0, 0, w, h );
 367                 w1 -= 4;
 368                 h1 -= 4;
 369                 gr_set_clip( x + 1, y + 1, w1 + 1, h1 + 1 );
 370         } else {
 371                 gr_set_clip( x - 1, y - 1, w1 + 1, h1 + 1 );
 372         }
 373
 374         if (flags & UI_INPUTBOX_FLAG_PASSWD){
 375                 gr_get_string_size(&tw, &th, passwd_text);
 376         } else {
 377                 gr_get_string_size(&tw, &th, text);
 378         }
 379
 380         // If first_time is set, that means this input box got
 381         // focus, but nothing is typed yet, so all the text is
 382         // selected, if you type a character it will replace the
 383         // text, if you type an arrow it will unselect it.
 384         // So it needs to be colored differently to show this.
 385         if (!disabled_flag && !(flags & UI_INPUTBOX_FLAG_NO_BACK)) {
 386 //              if ( (my_wnd->selected_gadget == this) && first_time ) {
 387 //                      gr_set_color_fast( text_color );
 388
 389 //              } else {
 390                         gr_set_color_fast( &CBLACK );
 391 //              }
 392
 393                 // color the background behind the text
 394                 gr_rect( 0, 0, tw + 1, th );
 395         }
 396
 397         if      ( (my_wnd->selected_gadget == this) || disabled_flag ) {
 398                 gr_set_color_fast(text_color);
 399         } else {
 400                 gr_set_color_fast(&CWHITE);
 401         }
 402
 403         // coords of where to draw the text
 404         text_x = 1;
 405         text_y = 1;
 406         if(flags & UI_INPUTBOX_FLAG_TEXT_CEN){
 407                 // if we fit within the text area, draw it centered
 408                 if(tw <= w1 - 5){
 409                         text_x += (w1 - tw)/2;
 410                 }
 411         }
 412
 413         // draw the text
 414         if (flags & UI_INPUTBOX_FLAG_PASSWD){
 415                 gr_string(text_x, text_y, passwd_text);
 416         } else {
 417                 gr_string(text_x, text_y, text);
 418         }
 419
 420         // draw the "cursor"
 421         if (!disabled_flag) {
 422                 if (my_wnd->selected_gadget == this) {
 423                         if (cursor_first_frame == -1) {
 424                                 gr_set_color_fast(text_color);
 425                                 ui_vline(1, h1, text_x + tw + 4);
 426                                 ui_vline(1, h1, text_x + tw + 5);
 427                         } else {
 428                                 // draw animating cursor
 429                                 int time_delta = timer_get_milliseconds() - cursor_elapsed_time;
 430
 431                                 if ( (time_delta / 1000.0f) > (1.0f / cursor_fps) ) {
 432                                         // advance frame
 433                                         cursor_elapsed_time += time_delta;
 434                                         cursor_current_frame++;
 435                                         if (cursor_current_frame >= cursor_nframes) {
 436                                                 cursor_current_frame = 0;
 437                                         }
 438                                 }
 439
 440                                 // draw current frame
 441                                 gr_set_bitmap(cursor_first_frame + cursor_current_frame, GR_ALPHABLEND_NONE, GR_BITBLT_MODE_NORMAL, 1.0f, -1, -1);
 442                                 gr_bitmap(text_x + tw + 4, 1);
 443                         }
 444                 }
 445         }
 446
 447         gr_reset_clip();
 448 }
 449
 450 int UI_INPUTBOX::validate_input(int chr)
 451 {
 452         if (chr < 32) {  // weed out control characters
 453                 return 0;
 454         }
 455
 456         // if we're disallowing letters altogether
 457         if((flags & UI_INPUTBOX_FLAG_NO_LETTERS) && isalpha(chr)){
 458                 return 0;
 459         }
 460
 461         // if we're disallowing numbers altogether
 462         if((flags & UI_INPUTBOX_FLAG_NO_NUMERALS) && isdigit(chr)){
 463                 return 0;
 464         }
 465
 466         // otherwise allow numbers and alpha chars by
 467         if (isdigit(chr) || isalpha(chr)){
 468                 return chr;
 469         }
 470
 471         // if we have specified no valid or invalid chars, accept everything
 472         if(!valid_chars && !invalid_chars){
 473                 return chr;
 474         }
 475
 476         // otherwise compare against the valid chars list
 477         if((valid_chars) && SDL_strchr(valid_chars, chr)){
 478                 return chr;
 479         }
 480
 481         // otherwise compare against the invalid chars list0
 482         if((invalid_chars) && !SDL_strchr(invalid_chars,chr)){
 483                 return chr;
 484         }
 485
 486         return 0;
 487 }
 488
 489 void UI_INPUTBOX::process(int focus)
 490 {
 491         int ascii, clear_lastkey, key, key_used, key_check;
 492
 493         // check if mouse is pressed
 494         if (B1_PRESSED && is_mouse_on()) {
 495                 set_focus();
 496 //              first_time = 1;
 497         }
 498
 499         if (disabled_flag)
 500                 return;
 501
 502         if (my_wnd->selected_gadget == this)
 503                 focus = 1;
 504 //      else
 505 //              first_time = 0;
 506
 507         key_used = 0;
 508         changed_flag = 0;
 509         oldposition = position;
 510         pressed_down = 0;
 511         clear_lastkey = (flags & UI_INPUTBOX_FLAG_KEYTHRU) ? 0 : 1;
 512
 513         if (focus) {
 514                 key = my_wnd->keypress;
 515                 switch (key) {
 516                         case 0:
 517                                 break;
 518
 519                         //case SDLK_LEFT:
 520                         case SDLK_BACKSPACE:
 521                                 if (position > 0)
 522                                         position--;
 523
 524                                 text[position] = 0;
 525                                 if (flags & UI_INPUTBOX_FLAG_PASSWD) {
 526                                         passwd_text[position] = 0;
 527                                 }
 528
 529                                 changed_flag = 1;
 530                                 key_used = 1;
 531 //                              if (first_time)
 532 //                                      first_time = 0;
 533
 534                                 break;
 535
 536                         case SDLK_RETURN:
 537                                 pressed_down = 1;
 538                                 locked = 0;
 539                                 changed_flag = 1;
 540                                 key_used = 1;
 541 //                              if (first_time)
 542 //                                      first_time = 0;
 543
 544 //                              should_reset = 1;
 545                                 break;
 546
 547                         case SDLK_ESCAPE:
 548                                 if (flags & UI_INPUTBOX_FLAG_ESC_CLR){
 549                                         if (position > 0) {
 550                                                 set_text("");
 551                                                 key_used = 1;
 552
 553                                         } else {
 554                                                 key_used = 0;
 555                                                 clear_lastkey = 0;
 556                                         }
 557                                 }
 558
 559                                 if (flags & UI_INPUTBOX_FLAG_ESC_FOC) {
 560                                         clear_focus();
 561                                 }
 562
 563                                 break;
 564
 565                         default:
 566                                 if (!locked) {
 567                                         // MWA -- determine if alt or ctrl held down on this key and don't process if it is.  We
 568                                         // need to be able to pass these keys back to the top level.  (And anyway -- ctrl-a shouldn't
 569                                         // print out an A in the input window
 570                                         if ( key & (KEY_ALTED | KEY_CTRLED) ) {
 571                                                 clear_lastkey = 0;
 572                                                 break;
 573                                         }
 574
 575                                         // get an ascii char from the input if possible
 576                                         key_check = my_wnd->keypress_text;
 577
 578                                         ascii = validate_input(key_check);
 579                                         if ((ascii > 0) && (ascii < 255)) {
 580                                                 if (flags & UI_INPUTBOX_FLAG_LETTER_FIRST) {
 581                                                         if ((position == 0) && !is_letter((char) ascii))
 582                                                                 break;
 583                                                 }
 584
 585                                                 key_used = 1;
 586 //                                              if (should_reset) {
 587 //                                                      should_reset = 0;
 588 //                                                      position = 0;
 589 //                                              }
 590
 591 //                                              if (first_time) {
 592 //                                                      first_time = 0;
 593 //                                                      position = 0;
 594 //                                              }
 595
 596                                                 if ( position < length ) {
 597                                                         text[position] = (char) ascii;
 598                                                         text[position + 1] = 0;
 599
 600                                                         if (flags & UI_INPUTBOX_FLAG_PASSWD) {
 601                                                                 passwd_text[position] = (char) INPUTBOX_PASSWD_CHAR;
 602                                                                 passwd_text[position + 1] = 0;
 603                                                         }
 604
 605                                                         position++;
 606
 607                                                         // check to see if we should limit by pixel width
 608                                                         if (pixel_limit > -1) {
 609                                                                 int width;
 610
 611                                                                 if (flags & UI_INPUTBOX_FLAG_PASSWD) {
 612                                                                         gr_get_string_size(&width, NULL, passwd_text);
 613
 614                                                                 } else {
 615                                                                         gr_get_string_size(&width, NULL, text);
 616                                                                 }
 617
 618                                                                 if (width > pixel_limit) {
 619                                                                         position--;
 620                                                                         locked = 1;
 621                                                                         text[position] = 0;
 622
 623                                                                         if (flags & UI_INPUTBOX_FLAG_PASSWD) {
 624                                                                                 passwd_text[position] = 0;
 625                                                                         }
 626                                                                 }
 627                                                         }
 628                                                 }
 629
 630                                                 changed_flag = 1;
 631                                         }
 632                                 }
 633
 634                                 break;
 635                 }
 636
 637                 if (clear_lastkey || (key_used && (flags & UI_INPUTBOX_FLAG_EAT_USED)) )
 638                         my_wnd->last_keypress=0;
 639
 640 //      } else {
 641 //              first_time = 1;
 642         }
 643 }
 644
 645 int UI_INPUTBOX::changed()
 646 {
 647         return changed_flag;
 648 }
 649
 650 int UI_INPUTBOX::pressed()
 651 {
 652         return pressed_down;
 653 }
 654
 655 void UI_INPUTBOX::get_text(char *out)
 656 {
 657         SDL_strlcpy(out, text, length+1);
 658 }
 659
 660 void UI_INPUTBOX::set_text(const char *in)
 661 {
 662         int in_length;
 663
 664         if (in == NULL) {
 665                 SDL_strlcpy(text, "", length+1);
 666                 position = 0;
 667
 668                 return;
 669         }
 670
 671         in_length = strlen(in);
 672         if (in_length > length)
 673                 SDL_assert(0);  // tried to force text into an input box that won't fit into allocated memory
 674
 675         SDL_strlcpy(text, in, length+1);
 676
 677         if (flags & UI_INPUTBOX_FLAG_PASSWD) {
 678                 memset(passwd_text, INPUTBOX_PASSWD_CHAR, strlen(text));
 679                 passwd_text[strlen(text)] = 0;
 680         }
 681
 682         position = in_length;  // fixes the zero-length-I-don't-think-so bug
 683 }
 684
 685