main/console.c

   1 /*
   2  * Code for controlling the console
   3  *  Based on an old version of SDL_Console
   4  *
   5  *  Written By: Garrett Banuk <mongoose@mongeese.org>
   6  *  Code Cleanup and heavily extended by: Clemens Wacha <reflex-2000@gmx.net>
   7  *  Ported to use native Descent interfaces by: Bradley Bell <btb@icculus.org>
   8  *
   9  *  This is free, just be sure to give us credit when using it
  10  *  in any of your programs.
  11  */
  12
  13 #ifdef HAVE_CONFIG_H
  14 #include <conf.h>
  15 #endif
  16
  17 #include <stdlib.h>
  18 #include <stdio.h>
  19 #include <string.h>
  20 #include <stdarg.h>
  21
  22 #include "console.h"
  23 #include "u_mem.h"
  24 #include "gr.h"
  25 #include "timer.h"
  26
  27
  28 #define FG_COLOR    grd_curcanv->cv_font_fg_color
  29 #define get_msecs() approx_fsec_to_msec(timer_get_approx_seconds())
  30
  31
  32 /* our one console */
  33 static ConsoleInformation Console;
  34 #define console (&Console)
  35
  36 /* Internals */
  37 void CON_UpdateOffset(void);
  38 /*! Frees all the memory loaded by the console */
  39 void CON_Free(void);
  40 #if 0
  41 /*! Sets the alpha channel of an SDL_Surface to the specified value (0 - transparend,
  42  255 - opaque). Use this function also for OpenGL. */
  43 void CON_Alpha(unsigned char alpha);
  44 /*! Internal: Sets the alpha channel of an SDL_Surface to the specified value.
  45  Preconditions: the surface in question is RGBA. 0 <= a <= 255, where 0 is transparent and 255 opaque */
  46 void CON_AlphaGL(SDL_Surface *s, int alpha);
  47 /*! Sets a background image for the console */
  48 #endif
  49 int CON_Background(grs_bitmap *image);
  50 /*! Sets font info for the console */
  51 void CON_Font(grs_font *font, int fg, int bg);
  52 /*! Beams a console to another screen surface. Needed if you want to make a Video restart in your program. This
  53  function first changes the OutputScreen Pointer then calls CON_Resize to adjust the new size. */
  54 int CON_Transfer(grs_screen* new_outputscreen, int x, int y, int w, int h);
  55 /*! Modify the prompt of the console */
  56 void CON_SetPrompt(char* newprompt);
  57 /*! Set the key, that invokes a CON_Hide() after press. default is ESCAPE and you can always hide using
  58  ESCAPE and the HideKey. compared against event->key.keysym.sym !! */
  59 void CON_SetHideKey(int key);
  60 /*! Internal: executes the command typed in at the console (called if you press ENTER)*/
  61 void CON_Execute(char* command);
  62 /*! Internal: Gets called when TAB was pressed */
  63 void CON_TabCompletion(void);
  64 /*! Internal: makes newline (same as printf("\n") or CON_Out("\n") ) */
  65 void CON_NewLineConsole(void);
  66 /*! Internal: shift command history (the one you can switch with the up/down keys) */
  67 void CON_NewLineCommand(void);
  68 /*! Internal: updates console after resize etc. */
  69 void CON_UpdateConsole(void);
  70
  71
  72 /*! Internal: draws the commandline the user is typing in to the screen. called by update? */
  73 void DrawCommandLine();
  74
  75 /*! Internal: Gets called if you press the LEFT key (move cursor left) */
  76 void Cursor_Left(void);
  77 /*! Internal: Gets called if you press the RIGHT key (move cursor right) */
  78 void Cursor_Right(void);
  79 /*! Internal: Gets called if you press the HOME key (move cursor to the beginning
  80         of the line */
  81 void Cursor_Home(void);
  82 /*! Internal: Gets called if you press the END key (move cursor to the end of the line*/
  83 void Cursor_End(void);
  84 /*! Internal: Called if you press DELETE (deletes character under the cursor) */
  85 void Cursor_Del(void);
  86 /*! Internal: Called if you press BACKSPACE (deletes character left of cursor) */
  87 void Cursor_BSpace(void);
  88 /*! Internal: Called if you type in a character (add the char to the command) */
  89 void Cursor_Add(int event);
  90
  91 /*! Internal: Called if you press Ctrl-C (deletes the commandline) */
  92 void Clear_Command(void);
  93 /*! Internal: Called if you press Ctrl-L (deletes the History) */
  94 void Clear_History(void);
  95
  96 /*! Internal: Called if you press UP key (switches through recent typed in commands */
  97 void Command_Up(void);
  98 /*! Internal: Called if you press DOWN key (switches through recent typed in commands */
  99 void Command_Down(void);
 100
 101
 102 /*  Takes keys from the keyboard and inputs them to the console
 103  If the event was not handled (i.e. WM events or unknown ctrl-shift
 104  sequences) the function returns the event for further processing. */
 105 int CON_Events(int event)
 106 {
 107         if(!CON_isVisible())
 108                 return event;
 109
 110         if(event & KEY_CTRLED)
 111         {
 112                 //CTRL pressed
 113                 switch(event & ~KEY_CTRLED)
 114                 {
 115                         case KEY_A:
 116                                 Cursor_Home();
 117                                 break;
 118                         case KEY_E:
 119                                 Cursor_End();
 120                                 break;
 121                         case KEY_C:
 122                                 Clear_Command();
 123                                 break;
 124                         case KEY_L:
 125                                 Clear_History();
 126                                 CON_UpdateConsole();
 127                                 break;
 128                         default:
 129                                 return event;
 130                 }
 131         }
 132         else if(event & KEY_ALTED)
 133         {
 134                 //the console does not handle ALT combinations!
 135                 return event;
 136         }
 137         else
 138         {
 139                 //first of all, check if the console hide key was pressed
 140                 if(event == console->HideKey)
 141                 {
 142                         CON_Hide();
 143                         return 0;
 144                 }
 145                 switch (event & 0xff)
 146                 {
 147                         case KEY_LSHIFT:
 148                         case KEY_RSHIFT:
 149                                 return event;
 150                         case KEY_HOME:
 151                                 if(event & KEY_SHIFTED)
 152                                 {
 153                                         console->ConsoleScrollBack = console->LineBuffer-1;
 154                                         CON_UpdateConsole();
 155                                 } else {
 156                                         Cursor_Home();
 157                                 }
 158                                 break;
 159                         case KEY_END:
 160                                 if(event & KEY_SHIFTED)
 161                                 {
 162                                         console->ConsoleScrollBack = 0;
 163                                         CON_UpdateConsole();
 164                                 } else {
 165                                         Cursor_End();
 166                                 }
 167                                 break;
 168                         case KEY_PAGEUP:
 169                                 console->ConsoleScrollBack += CON_LINE_SCROLL;
 170                                 if(console->ConsoleScrollBack > console->LineBuffer-1)
 171                                         console->ConsoleScrollBack = console->LineBuffer-1;
 172
 173                                 CON_UpdateConsole();
 174                                 break;
 175                         case KEY_PAGEDOWN:
 176                                 console->ConsoleScrollBack -= CON_LINE_SCROLL;
 177                                 if(console->ConsoleScrollBack < 0)
 178                                         console->ConsoleScrollBack = 0;
 179                                 CON_UpdateConsole();
 180                                 break;
 181                         case KEY_UP:
 182                                 Command_Up();
 183                                 break;
 184                         case KEY_DOWN:
 185                                 Command_Down();
 186                                 break;
 187                         case KEY_LEFT:
 188                                 Cursor_Left();
 189                                 break;
 190                         case KEY_RIGHT:
 191                                 Cursor_Right();
 192                                 break;
 193                         case KEY_BACKSP:
 194                                 Cursor_BSpace();
 195                                 break;
 196                         case KEY_DELETE:
 197                                 Cursor_Del();
 198                                 break;
 199                         case KEY_INSERT:
 200                                 console->InsMode = 1-console->InsMode;
 201                                 break;
 202                         case KEY_TAB:
 203                                 CON_TabCompletion();
 204                                 break;
 205                         case KEY_ENTER:
 206                                 if(strlen(console->Command) > 0) {
 207                                         CON_NewLineCommand();
 208
 209                                         // copy the input into the past commands strings
 210                                         strcpy(console->CommandLines[0], console->Command);
 211
 212                                         // display the command including the prompt
 213                                         CON_Out("%s%s", console->Prompt, console->Command);
 214                                         CON_UpdateConsole();
 215
 216                                         CON_Execute(console->Command);
 217
 218                                         Clear_Command();
 219                                         console->CommandScrollBack = -1;
 220                                 }
 221                                 break;
 222                         case KEY_LAPOSTRO:
 223                                 //deactivate Console
 224                                 CON_Hide();
 225                                 return 0;
 226                         default:
 227                                 if (key_to_ascii(event) == 255)
 228                                         break;
 229                                 if(console->InsMode)
 230                                         Cursor_Add(event);
 231                                 else {
 232                                         Cursor_Add(event);
 233                                         Cursor_Del();
 234                                 }
 235                 }
 236         }
 237         return 0;
 238 }
 239
 240 #if 0
 241 /* CON_AlphaGL() -- sets the alpha channel of an SDL_Surface to the
 242  * specified value.  Preconditions: the surface in question is RGBA.
 243  * 0 <= a <= 255, where 0 is transparent and 255 is opaque. */
 244 void CON_AlphaGL(SDL_Surface *s, int alpha) {
 245         Uint8 val;
 246         int x, y, w, h;
 247         Uint32 pixel;
 248         Uint8 r, g, b, a;
 249         SDL_PixelFormat *format;
 250         static char errorPrinted = 0;
 251
 252
 253         /* debugging assertions -- these slow you down, but hey, crashing sucks */
 254         if(!s) {
 255                 PRINT_ERROR("NULL Surface passed to CON_AlphaGL\n");
 256                 return;
 257         }
 258
 259         /* clamp alpha value to 0...255 */
 260         if(alpha < SDL_ALPHA_TRANSPARENT)
 261                 val = SDL_ALPHA_TRANSPARENT;
 262         else if(alpha > SDL_ALPHA_OPAQUE)
 263                 val = SDL_ALPHA_OPAQUE;
 264         else
 265                 val = alpha;
 266
 267         /* loop over alpha channels of each pixel, setting them appropriately. */
 268         w = s->w;
 269         h = s->h;
 270         format = s->format;
 271         switch (format->BytesPerPixel) {
 272                 case 2:
 273                         /* 16-bit surfaces don't seem to support alpha channels. */
 274                         if(!errorPrinted) {
 275                                 errorPrinted = 1;
 276                                 PRINT_ERROR("16-bit SDL surfaces do not support alpha-blending under OpenGL.\n");
 277                         }
 278                         break;
 279                 case 4: {
 280                         /* we can do this very quickly in 32-bit mode.  24-bit is more
 281                          * difficult.  And since 24-bit mode is reall the same as 32-bit,
 282                          * so it usually ends up taking this route too.  Win!  Unroll loop
 283                          * and use pointer arithmetic for extra speed. */
 284                         int numpixels = h * (w << 2);
 285                         Uint8 *pix = (Uint8 *) (s->pixels);
 286                         Uint8 *last = pix + numpixels;
 287                         Uint8 *pixel;
 288                         if((numpixels & 0x7) == 0)
 289                                 for(pixel = pix + 3; pixel < last; pixel += 32)
 290                                         *pixel = *(pixel + 4) = *(pixel + 8) = *(pixel + 12) = *(pixel + 16) = *(pixel + 20) = *(pixel + 24) = *(pixel + 28) = val;
 291                         else
 292                                 for(pixel = pix + 3; pixel < last; pixel += 4)
 293                                         *pixel = val;
 294                         break;
 295                 }
 296                 default:
 297                         /* we have no choice but to do this slowly.  <sigh> */
 298                         for(y = 0; y < h; ++y)
 299                                 for(x = 0; x < w; ++x) {
 300                                         char print = 0;
 301                                         /* Lock the surface for direct access to the pixels */
 302                                         if(SDL_MUSTLOCK(s) && SDL_LockSurface(s) < 0) {
 303                                                 PRINT_ERROR("Can't lock surface: ");
 304                                                 fprintf(stderr, "%s\n", SDL_GetError());
 305                                                 return;
 306                                         }
 307                                         pixel = DT_GetPixel(s, x, y);
 308                                         if(x == 0 && y == 0)
 309                                                 print = 1;
 310                                         SDL_GetRGBA(pixel, format, &r, &g, &b, &a);
 311                                         pixel = SDL_MapRGBA(format, r, g, b, val);
 312                                         SDL_GetRGBA(pixel, format, &r, &g, &b, &a);
 313                                         DT_PutPixel(s, x, y, pixel);
 314
 315                                         /* unlock surface again */
 316                                         if(SDL_MUSTLOCK(s))
 317                                                 SDL_UnlockSurface(s);
 318                                 }
 319                         break;
 320         }
 321 }
 322 #endif
 323
 324
 325 /* Updates the console buffer */
 326 void CON_UpdateConsole(void) {
 327         int loop;
 328         int loop2;
 329         int Screenlines;
 330         grs_canvas *canv_save;
 331         short orig_color;
 332
 333         /* Due to the Blits, the update is not very fast: So only update if it's worth it */
 334         if(!CON_isVisible())
 335                 return;
 336
 337         Screenlines = console->ConsoleSurface->cv_h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h);
 338
 339         canv_save = grd_curcanv;
 340         gr_set_current_canvas(console->ConsoleSurface);
 341
 342 #if 0
 343         SDL_FillRect(console->ConsoleSurface, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, console->ConsoleAlpha));
 344 #else
 345         //gr_rect(0,0,
 346 #endif
 347
 348 #if 0
 349         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 350                 SDL_SetAlpha(console->ConsoleSurface, 0, SDL_ALPHA_OPAQUE);
 351 #endif
 352
 353         /* draw the background image if there is one */
 354         if(console->BackgroundImage)
 355                 gr_bitmap(0, 0, console->BackgroundImage);
 356
 357         /* Draw the text from the back buffers, calculate in the scrollback from the user
 358          * this is a normal SDL software-mode blit, so we need to temporarily set the ColorKey
 359          * for the font, and then clear it when we're done.
 360          */
 361 #if 0
 362         if((console->OutputScreen->flags & SDL_OPENGLBLIT) && (console->OutputScreen->format->BytesPerPixel > 2)) {
 363                 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
 364                 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
 365         }
 366 #endif
 367
 368         //now draw text from last but second line to top
 369         for(loop = 0; loop < Screenlines-1 && loop < console->LineBuffer - console->ConsoleScrollBack; loop++) {
 370                 if(console->ConsoleScrollBack != 0 && loop == 0)
 371                         for(loop2 = 0; loop2 < (console->VChars / 5) + 1; loop2++)
 372                         {
 373                                 orig_color = FG_COLOR;
 374                                 gr_string(CON_CHAR_BORDER + (loop2*5*console->ConsoleSurface->cv_font->ft_w), (Screenlines - loop - 2) * (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h), CON_SCROLL_INDICATOR);
 375                                 FG_COLOR = orig_color;
 376                         }
 377                 else
 378                 {
 379                         orig_color = FG_COLOR;
 380                         gr_string(CON_CHAR_BORDER, (Screenlines - loop - 2) * (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h), console->ConsoleLines[console->ConsoleScrollBack + loop]);
 381                         FG_COLOR = orig_color;
 382                 }
 383         }
 384
 385         gr_set_current_canvas(canv_save);
 386
 387 #if 0
 388         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 389                 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
 390 #endif
 391 }
 392
 393 void CON_UpdateOffset(void) {
 394         switch(console->Visible) {
 395                 case CON_CLOSING:
 396                         console->RaiseOffset -= CON_OPENCLOSE_SPEED;
 397                         if(console->RaiseOffset <= 0) {
 398                                 console->RaiseOffset = 0;
 399                                 console->Visible = CON_CLOSED;
 400                         }
 401                         break;
 402                 case CON_OPENING:
 403                         console->RaiseOffset += CON_OPENCLOSE_SPEED;
 404                         if(console->RaiseOffset >= console->ConsoleSurface->cv_h) {
 405                                 console->RaiseOffset = console->ConsoleSurface->cv_h;
 406                                 console->Visible = CON_OPEN;
 407                         }
 408                         break;
 409                 case CON_OPEN:
 410                 case CON_CLOSED:
 411                         break;
 412         }
 413 }
 414
 415 /* Draws the console buffer to the screen if the console is "visible" */
 416 void CON_DrawConsole(void) {
 417         grs_canvas *canv_save;
 418         grs_bitmap *clip;
 419
 420         /* only draw if console is visible: here this means, that the console is not CON_CLOSED */
 421         if(console->Visible == CON_CLOSED)
 422                 return;
 423
 424         /* Update the scrolling offset */
 425         CON_UpdateOffset();
 426
 427         /* Update the command line since it has a blinking cursor */
 428         DrawCommandLine();
 429
 430 #if 0
 431         /* before drawing, make sure the alpha channel of the console surface is set
 432          * properly.  (sigh) I wish we didn't have to do this every frame... */
 433         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 434                 CON_AlphaGL(console->ConsoleSurface, console->ConsoleAlpha);
 435 #endif
 436
 437         canv_save = grd_curcanv;
 438         gr_set_current_canvas(&console->OutputScreen->sc_canvas);
 439
 440         clip = gr_create_sub_bitmap(&console->ConsoleSurface->cv_bitmap, 0, console->ConsoleSurface->cv_h - console->RaiseOffset, console->ConsoleSurface->cv_w, console->RaiseOffset);
 441
 442         gr_bitmap(0, 0, clip);
 443         gr_free_sub_bitmap(clip);
 444
 445 #if 0
 446         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 447                 SDL_UpdateRects(console->OutputScreen, 1, &DestRect);
 448 #endif
 449
 450         gr_set_current_canvas(canv_save);
 451 }
 452
 453
 454 /* Initializes the console */
 455 void CON_Init(grs_font *Font, grs_screen *DisplayScreen, int lines, int x, int y, int w, int h)
 456 {
 457         int loop;
 458
 459         console->Visible = CON_CLOSED;
 460         console->RaiseOffset = 0;
 461         console->ConsoleLines = NULL;
 462         console->CommandLines = NULL;
 463         console->TotalConsoleLines = 0;
 464         console->ConsoleScrollBack = 0;
 465         console->TotalCommands = 0;
 466         console->BackgroundImage = NULL;
 467 #if 0
 468         console->ConsoleAlpha = SDL_ALPHA_OPAQUE;
 469 #endif
 470         console->Offset = 0;
 471         console->InsMode = 1;
 472         console->CursorPos = 0;
 473         console->CommandScrollBack = 0;
 474         console->OutputScreen = DisplayScreen;
 475         console->Prompt = CON_DEFAULT_PROMPT;
 476         console->HideKey = CON_DEFAULT_HIDEKEY;
 477
 478         /* make sure that the size of the console is valid */
 479         if(w > console->OutputScreen->sc_w || w < Font->ft_w * 32)
 480                 w = console->OutputScreen->sc_w;
 481         if(h > console->OutputScreen->sc_h || h < Font->ft_h)
 482                 h = console->OutputScreen->sc_h;
 483
 484         /* load the console surface */
 485         console->ConsoleSurface = gr_create_canvas(w, h);
 486
 487         /* Load the consoles font */
 488         {
 489                 grs_canvas *canv_save;
 490
 491                 canv_save = grd_curcanv;
 492                 gr_set_current_canvas(console->ConsoleSurface);
 493                 gr_set_curfont(Font);
 494                 gr_set_fontcolor(gr_getcolor(63,63,63), -1);
 495                 gr_set_current_canvas(canv_save);
 496         }
 497
 498
 499         /* Load the dirty rectangle for user input */
 500         console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
 501 #if 0
 502         SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 503 #endif
 504
 505         /* calculate the number of visible characters in the command line */
 506         console->VChars = (w - CON_CHAR_BORDER) / console->ConsoleSurface->cv_font->ft_w;
 507         if(console->VChars > CON_CHARS_PER_LINE)
 508                 console->VChars = CON_CHARS_PER_LINE;
 509
 510         /* We would like to have a minumum # of lines to guarentee we don't create a memory error */
 511         if(h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h) > lines)
 512                 console->LineBuffer = h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h);
 513         else
 514                 console->LineBuffer = lines;
 515
 516
 517         console->ConsoleLines = (char **)d_malloc(sizeof(char *) * console->LineBuffer);
 518         console->CommandLines = (char **)d_malloc(sizeof(char *) * console->LineBuffer);
 519         for(loop = 0; loop <= console->LineBuffer - 1; loop++) {
 520                 console->ConsoleLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
 521                 console->CommandLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
 522         }
 523         memset(console->Command, 0, CON_CHARS_PER_LINE);
 524         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 525         memset(console->RCommand, 0, CON_CHARS_PER_LINE);
 526         memset(console->VCommand, 0, CON_CHARS_PER_LINE);
 527
 528
 529         CON_Out("Console initialised.");
 530         CON_NewLineConsole();
 531 }
 532
 533 /* Makes the console visible */
 534 void CON_Show(void) {
 535         console->Visible = CON_OPENING;
 536         CON_UpdateConsole();
 537 }
 538
 539 /* Hides the console (make it invisible) */
 540 void CON_Hide(void) {
 541         console->Visible = CON_CLOSING;
 542 }
 543
 544 /* tells wether the console is visible or not */
 545 int CON_isVisible(void) {
 546         return((console->Visible == CON_OPEN) || (console->Visible == CON_OPENING));
 547 }
 548
 549 /* Frees all the memory loaded by the console */
 550 void CON_Free(void) {
 551         int i;
 552
 553         for(i = 0; i <= console->LineBuffer - 1; i++) {
 554                 d_free(console->ConsoleLines[i]);
 555                 d_free(console->CommandLines[i]);
 556         }
 557         d_free(console->ConsoleLines);
 558         d_free(console->CommandLines);
 559
 560         console->ConsoleLines = NULL;
 561         console->CommandLines = NULL;
 562
 563         gr_free_canvas(console->ConsoleSurface);
 564         console->ConsoleSurface = NULL;
 565
 566         if (console->BackgroundImage)
 567                 gr_free_bitmap(console->BackgroundImage);
 568         console->BackgroundImage = NULL;
 569
 570         gr_free_bitmap(console->InputBackground);
 571         console->InputBackground = NULL;
 572 }
 573
 574
 575 /* Increments the console lines */
 576 void CON_NewLineConsole(void) {
 577         int loop;
 578         char* temp;
 579
 580         temp = console->ConsoleLines[console->LineBuffer - 1];
 581
 582         for(loop = console->LineBuffer - 1; loop > 0; loop--)
 583                 console->ConsoleLines[loop] = console->ConsoleLines[loop - 1];
 584
 585         console->ConsoleLines[0] = temp;
 586
 587         memset(console->ConsoleLines[0], 0, CON_CHARS_PER_LINE);
 588         if(console->TotalConsoleLines < console->LineBuffer - 1)
 589                 console->TotalConsoleLines++;
 590
 591         //Now adjust the ConsoleScrollBack
 592         //dont scroll if not at bottom
 593         if(console->ConsoleScrollBack != 0)
 594                 console->ConsoleScrollBack++;
 595         //boundaries
 596         if(console->ConsoleScrollBack > console->LineBuffer-1)
 597                 console->ConsoleScrollBack = console->LineBuffer-1;
 598
 599 }
 600
 601
 602 /* Increments the command lines */
 603 void CON_NewLineCommand(void) {
 604         int loop;
 605         char *temp;
 606
 607         temp  = console->CommandLines[console->LineBuffer - 1];
 608
 609
 610         for(loop = console->LineBuffer - 1; loop > 0; loop--)
 611                 console->CommandLines[loop] = console->CommandLines[loop - 1];
 612
 613         console->CommandLines[0] = temp;
 614
 615         memset(console->CommandLines[0], 0, CON_CHARS_PER_LINE);
 616         if(console->TotalCommands < console->LineBuffer - 1)
 617                 console->TotalCommands++;
 618 }
 619
 620 /* Draws the command line the user is typing in to the screen */
 621 /* completely rewritten by C.Wacha */
 622 void DrawCommandLine() {
 623         int x;
 624         int commandbuffer;
 625 #if 0
 626         grs_font* CurrentFont;
 627 #endif
 628         static unsigned int LastBlinkTime = 0;  /* Last time the consoles cursor blinked */
 629         static int LastCursorPos = 0;           // Last Cursor Position
 630         static int Blink = 0;                   /* Is the cursor currently blinking */
 631         grs_canvas *canv_save;
 632         short orig_color;
 633
 634         commandbuffer = console->VChars - strlen(console->Prompt)-1; // -1 to make cursor visible
 635
 636 #if 0
 637         CurrentFont = console->ConsoleSurface->cv_font;
 638 #endif
 639
 640         //Concatenate the left and right side to command
 641         strcpy(console->Command, console->LCommand);
 642         strncat(console->Command, console->RCommand, strlen(console->RCommand));
 643
 644         //calculate display offset from current cursor position
 645         if(console->Offset < console->CursorPos - commandbuffer)
 646                 console->Offset = console->CursorPos - commandbuffer;
 647         if(console->Offset > console->CursorPos)
 648                 console->Offset = console->CursorPos;
 649
 650         //first add prompt to visible part
 651         strcpy(console->VCommand, console->Prompt);
 652
 653         //then add the visible part of the command
 654         strncat(console->VCommand, &console->Command[console->Offset], strlen(&console->Command[console->Offset]));
 655
 656         //now display the result
 657
 658 #if 0
 659         //once again we're drawing text, so in OpenGL context we need to temporarily set up
 660         //software-mode transparency.
 661         if(console->OutputScreen->flags & SDL_OPENGLBLIT) {
 662                 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
 663                 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
 664         }
 665 #endif
 666
 667         canv_save = grd_curcanv;
 668         gr_set_current_canvas(console->ConsoleSurface);
 669
 670         //first of all restore InputBackground
 671         gr_bitmap(0, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->InputBackground);
 672
 673         //now add the text
 674         orig_color = FG_COLOR;
 675         gr_string(CON_CHAR_BORDER, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->VCommand);
 676         FG_COLOR = orig_color;
 677
 678         //at last add the cursor
 679         //check if the blink period is over
 680         if(get_msecs() > LastBlinkTime) {
 681                 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
 682                 if(Blink)
 683                         Blink = 0;
 684                 else
 685                         Blink = 1;
 686         }
 687
 688         //check if cursor has moved - if yes display cursor anyway
 689         if(console->CursorPos != LastCursorPos) {
 690                 LastCursorPos = console->CursorPos;
 691                 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
 692                 Blink = 1;
 693         }
 694
 695         if(Blink) {
 696                 int prompt_width, cmd_width, h, w;
 697
 698                 gr_get_string_size(console->Prompt, &prompt_width, &h, &w);
 699                 gr_get_string_size(console->LCommand + console->Offset, &cmd_width, &h, &w);
 700                 x = CON_CHAR_BORDER + prompt_width + cmd_width;
 701                 orig_color = FG_COLOR;
 702                 if(console->InsMode)
 703                         gr_string(x, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, CON_INS_CURSOR);
 704                 else
 705                         gr_string(x, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, CON_OVR_CURSOR);
 706                 FG_COLOR = orig_color;
 707         }
 708
 709         gr_set_current_canvas(canv_save);
 710
 711
 712 #if 0
 713         if(console->OutputScreen->flags & SDL_OPENGLBLIT) {
 714                 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
 715         }
 716 #endif
 717 }
 718
 719 #ifdef _MSC_VER
 720 # define vsnprintf _vsnprintf
 721 #endif
 722
 723 /* Outputs text to the console (in game), up to CON_CHARS_PER_LINE chars can be entered */
 724 void CON_Out(const char *str, ...) {
 725         va_list marker;
 726         //keep some space free for stuff like CON_Out("blablabla %s", console->Command);
 727         char temp[CON_CHARS_PER_LINE + 128];
 728         char* ptemp;
 729
 730         va_start(marker, str);
 731         vsnprintf(temp, CON_CHARS_PER_LINE + 127, str, marker);
 732         va_end(marker);
 733
 734         ptemp = temp;
 735
 736         //temp now contains the complete string we want to output
 737         // the only problem is that temp is maybe longer than the console
 738         // width so we have to cut it into several pieces
 739
 740         if(console->ConsoleLines) {
 741                 while(strlen(ptemp) > console->VChars) {
 742                         CON_NewLineConsole();
 743                         strncpy(console->ConsoleLines[0], ptemp, console->VChars);
 744                         console->ConsoleLines[0][console->VChars] = '\0';
 745                         ptemp = &ptemp[console->VChars];
 746                 }
 747                 CON_NewLineConsole();
 748                 strncpy(console->ConsoleLines[0], ptemp, console->VChars);
 749                 console->ConsoleLines[0][console->VChars] = '\0';
 750                 CON_UpdateConsole();
 751         }
 752 }
 753
 754
 755 #if 0
 756 /* Sets the alpha level of the console, 0 turns off alpha blending */
 757 void CON_Alpha(unsigned char alpha) {
 758         /* store alpha as state! */
 759         console->ConsoleAlpha = alpha;
 760
 761         if((console->OutputScreen->flags & SDL_OPENGLBLIT) == 0) {
 762                 if(alpha == 0)
 763                         SDL_SetAlpha(console->ConsoleSurface, 0, alpha);
 764                 else
 765                         SDL_SetAlpha(console->ConsoleSurface, SDL_SRCALPHA, alpha);
 766         }
 767
 768         //      CON_UpdateConsole();
 769 }
 770 #endif
 771
 772
 773 /* Adds  background image to the console, scaled to size of console*/
 774 int CON_Background(grs_bitmap *image)
 775 {
 776         /* Free the background from the console */
 777         if (image == NULL) {
 778                 if (console->BackgroundImage)
 779                         gr_free_bitmap(console->BackgroundImage);
 780                 console->BackgroundImage = NULL;
 781 #if 0
 782                 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 783 #endif
 784                 return 0;
 785         }
 786
 787         /* Load a new background */
 788         if (console->BackgroundImage)
 789                 gr_free_bitmap(console->BackgroundImage);
 790         console->BackgroundImage = gr_create_bitmap(console->ConsoleSurface->cv_w, console->ConsoleSurface->cv_h);
 791         gr_bitmap_scale_to(image, console->BackgroundImage);
 792
 793 #if 0
 794         SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 795 #endif
 796         gr_bm_bitblt(console->BackgroundImage->bm_w, console->InputBackground->bm_h, 0, 0, 0, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->BackgroundImage, console->InputBackground);
 797
 798         return 0;
 799 }
 800
 801 /* Sets font info for the console */
 802 void CON_Font(grs_font *font, int fg, int bg)
 803 {
 804         grs_canvas *canv_save;
 805
 806         canv_save = grd_curcanv;
 807         gr_set_current_canvas(console->ConsoleSurface);
 808         gr_set_curfont(font);
 809         gr_set_fontcolor(fg, bg);
 810         gr_set_current_canvas(canv_save);
 811 }
 812
 813 void gr_init_bitmap_alloc( grs_bitmap *bm, int mode, int x, int y, int w, int h, int bytesperline);
 814 /* resizes the console, has to reset alot of stuff
 815  * returns 1 on error */
 816 int CON_Resize(int x, int y, int w, int h)
 817 {
 818         /* make sure that the size of the console is valid */
 819         if(w > console->OutputScreen->sc_w || w < console->ConsoleSurface->cv_font->ft_w * 32)
 820                 w = console->OutputScreen->sc_w;
 821         if(h > console->OutputScreen->sc_h || h < console->ConsoleSurface->cv_font->ft_h)
 822                 h = console->OutputScreen->sc_h;
 823
 824         /* resize console surface */
 825         gr_free_bitmap_data(&console->ConsoleSurface->cv_bitmap);
 826         gr_init_bitmap_alloc(&console->ConsoleSurface->cv_bitmap, BM_LINEAR, 0, 0, w, h, w);
 827
 828         /* Load the dirty rectangle for user input */
 829         gr_free_bitmap(console->InputBackground);
 830         console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
 831
 832         /* Now reset some stuff dependent on the previous size */
 833         console->ConsoleScrollBack = 0;
 834
 835         /* Reload the background image (for the input text area) in the console */
 836         if(console->BackgroundImage) {
 837 #if 0
 838                 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 839 #endif
 840                 gr_bm_bitblt(console->BackgroundImage->bm_w, console->InputBackground->bm_h, 0, 0, 0, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->BackgroundImage, console->InputBackground);
 841         }
 842
 843 #if 0
 844         /* restore the alpha level */
 845         CON_Alpha(console->ConsoleAlpha);
 846 #endif
 847         return 0;
 848 }
 849
 850 /* Transfers the console to another screen surface, and adjusts size */
 851 int CON_Transfer(grs_screen *new_outputscreen, int x, int y, int w, int h)
 852 {
 853         console->OutputScreen = new_outputscreen;
 854
 855         return(CON_Resize(x, y, w, h));
 856 }
 857
 858 /* Sets the Prompt for console */
 859 void CON_SetPrompt(char* newprompt) {
 860         //check length so we can still see at least 1 char :-)
 861         if(strlen(newprompt) < console->VChars)
 862                 console->Prompt = d_strdup(newprompt);
 863         else
 864                 CON_Out("prompt too long. (max. %i chars)", console->VChars - 1);
 865 }
 866
 867 /* Sets the key that deactivates (hides) the console. */
 868 void CON_SetHideKey(int key) {
 869         console->HideKey = key;
 870 }
 871
 872 /* Executes the command entered */
 873 void CON_Execute(char* command) {
 874         cmd_parse(command);
 875 }
 876
 877 void CON_TabCompletion(void) {
 878         int i,j;
 879         char* command;
 880
 881         command = d_strdup(console->LCommand);
 882         command = cmd_complete(command);
 883
 884         if(!command)
 885                 return; //no tab completion took place so return silently
 886
 887         j = strlen(command);
 888         if(j > CON_CHARS_PER_LINE - 2)
 889                 j = CON_CHARS_PER_LINE-1;
 890
 891         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 892         console->CursorPos = 0;
 893
 894         for(i = 0; i < j; i++) {
 895                 console->CursorPos++;
 896                 console->LCommand[i] = command[i];
 897         }
 898         //add a trailing space
 899         console->CursorPos++;
 900         console->LCommand[j] = ' ';
 901         console->LCommand[j+1] = '\0';
 902 }
 903
 904 void Cursor_Left(void) {
 905         char temp[CON_CHARS_PER_LINE];
 906
 907         if(console->CursorPos > 0) {
 908                 console->CursorPos--;
 909                 strcpy(temp, console->RCommand);
 910                 strcpy(console->RCommand, &console->LCommand[strlen(console->LCommand)-1]);
 911                 strcat(console->RCommand, temp);
 912                 console->LCommand[strlen(console->LCommand)-1] = '\0';
 913                 //CON_Out("L:%s, R:%s", console->LCommand, console->RCommand);
 914         }
 915 }
 916
 917 void Cursor_Right(void) {
 918         char temp[CON_CHARS_PER_LINE];
 919
 920         if(console->CursorPos < strlen(console->Command)) {
 921                 console->CursorPos++;
 922                 strncat(console->LCommand, console->RCommand, 1);
 923                 strcpy(temp, console->RCommand);
 924                 strcpy(console->RCommand, &temp[1]);
 925                 //CON_Out("L:%s, R:%s", console->LCommand, console->RCommand);
 926         }
 927 }
 928
 929 void Cursor_Home(void) {
 930         char temp[CON_CHARS_PER_LINE];
 931
 932         console->CursorPos = 0;
 933         strcpy(temp, console->RCommand);
 934         strcpy(console->RCommand, console->LCommand);
 935         strncat(console->RCommand, temp, strlen(temp));
 936         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 937 }
 938
 939 void Cursor_End(void) {
 940         console->CursorPos = strlen(console->Command);
 941         strncat(console->LCommand, console->RCommand, strlen(console->RCommand));
 942         memset(console->RCommand, 0, CON_CHARS_PER_LINE);
 943 }
 944
 945 void Cursor_Del(void) {
 946         char temp[CON_CHARS_PER_LINE];
 947
 948         if(strlen(console->RCommand) > 0) {
 949                 strcpy(temp, console->RCommand);
 950                 strcpy(console->RCommand, &temp[1]);
 951         }
 952 }
 953
 954 void Cursor_BSpace(void) {
 955         if(console->CursorPos > 0) {
 956                 console->CursorPos--;
 957                 console->Offset--;
 958                 if(console->Offset < 0)
 959                         console->Offset = 0;
 960                 console->LCommand[strlen(console->LCommand)-1] = '\0';
 961         }
 962 }
 963
 964 void Cursor_Add(int event)
 965 {
 966         if(strlen(console->Command) < CON_CHARS_PER_LINE - 1)
 967         {
 968                 console->CursorPos++;
 969                 console->LCommand[strlen(console->LCommand)] = key_to_ascii(event);
 970                 console->LCommand[strlen(console->LCommand)] = '\0';
 971         }
 972 }
 973
 974 void Clear_Command(void) {
 975         console->CursorPos = 0;
 976         memset(console->VCommand, 0, CON_CHARS_PER_LINE);
 977         memset(console->Command, 0, CON_CHARS_PER_LINE);
 978         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 979         memset(console->RCommand, 0, CON_CHARS_PER_LINE);
 980 }
 981
 982 void Clear_History(void) {
 983         int loop;
 984
 985         for(loop = 0; loop <= console->LineBuffer - 1; loop++)
 986                 memset(console->ConsoleLines[loop], 0, CON_CHARS_PER_LINE);
 987 }
 988
 989 void Command_Up(void) {
 990         if(console->CommandScrollBack < console->TotalCommands - 1) {
 991                 /* move back a line in the command strings and copy the command to the current input string */
 992                 console->CommandScrollBack++;
 993                 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
 994                 console->Offset = 0;
 995                 strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
 996                 console->CursorPos = strlen(console->CommandLines[console->CommandScrollBack]);
 997                 CON_UpdateConsole();
 998         }
 999 }
1000
1001 void Command_Down(void) {
1002         if(console->CommandScrollBack > -1) {
1003                 /* move forward a line in the command strings and copy the command to the current input string */
1004                 console->CommandScrollBack--;
1005                 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1006                 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1007                 console->Offset = 0;
1008                 if(console->CommandScrollBack > -1)
1009                         strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1010                 console->CursorPos = strlen(console->LCommand);
1011                 CON_UpdateConsole();
1012         }
1013 }
1014
1015 #include <stdio.h>
1016 #include <stdlib.h>
1017 #include <stdarg.h>
1018 #include <string.h>
1019 #ifndef _WIN32_WCE
1020 #include <fcntl.h>
1021 #endif
1022 #include <ctype.h>
1023
1024 #include "pstypes.h"
1025 #include "u_mem.h"
1026 #include "error.h"
1027 #include "console.h"
1028 #include "cmd.h"
1029 #include "cvar.h"
1030 #include "gr.h"
1031 #include "gamefont.h"
1032 #include "pcx.h"
1033 #include "cfile.h"
1034
1035 #ifndef __MSDOS__
1036 int text_console_enabled = 1;
1037 #else
1038 int isvga();
1039 #define text_console_enabled (!isvga())
1040 #endif
1041
1042
1043 /* Console specific cvars */
1044 /* How discriminating we are about which messages are displayed */
1045 cvar_t con_threshold = {"con_threshold", "0",};
1046
1047 /* Private console stuff */
1048 #define CON_NUM_LINES 40
1049
1050 static int con_initialized;
1051
1052
1053 /* Free the console */
1054 void con_free(void)
1055 {
1056         if (con_initialized)
1057                 CON_Free();
1058         con_initialized = 0;
1059 }
1060
1061
1062 /* Initialise the console */
1063 void con_init(void)
1064 {
1065         grs_screen fake_screen;
1066         grs_font   fake_font;
1067
1068         fake_screen.sc_w = 320;
1069         fake_screen.sc_h = 200;
1070         fake_font.ft_w = 5;
1071         fake_font.ft_h = 5;
1072
1073         CON_Init(&fake_font, &fake_screen, CON_NUM_LINES, 0, 0, 320, 200);
1074
1075         cmd_init();
1076
1077         /* Initialise the cvars */
1078         cvar_registervariable (&con_threshold);
1079
1080         con_initialized = 1;
1081
1082         atexit(con_free);
1083 }
1084
1085
1086 #define CON_BG_HIRES (cfexist("scoresb.pcx")?"scoresb.pcx":"scores.pcx")
1087 #define CON_BG_LORES (cfexist("scores.pcx")?"scores.pcx":"scoresb.pcx") // Mac datafiles only have scoresb.pcx
1088 #define CON_BG ((SWIDTH>=640)?CON_BG_HIRES:CON_BG_LORES)
1089
1090 void con_background(char *filename)
1091 {
1092         int pcx_error;
1093         grs_bitmap bmp;
1094         ubyte pal[256*3];
1095
1096         gr_init_bitmap_data(&bmp);
1097         pcx_error = pcx_read_bitmap(filename, &bmp, BM_LINEAR, pal);
1098         Assert(pcx_error == PCX_ERROR_NONE);
1099         gr_remap_bitmap_good(&bmp, pal, -1, -1);
1100         CON_Background(&bmp);
1101         gr_free_bitmap_data(&bmp);
1102 }
1103
1104
1105 void con_init_gfx(void)
1106 {
1107         CON_Font(SMALL_FONT, gr_getcolor(63, 63, 63), -1);
1108         CON_Transfer(grd_curscreen, 0, 0, SWIDTH, SHEIGHT / 2);
1109
1110         con_background(CON_BG);
1111 }
1112
1113
1114 void con_resize(void)
1115 {
1116         CON_Font(SMALL_FONT, gr_getcolor(63, 63, 63), -1);
1117         CON_Resize(0, 0, SWIDTH, SHEIGHT / 2);
1118         con_background(CON_BG);
1119 }
1120
1121 /* Print a message to the console */
1122 void con_printf(int priority, char *fmt, ...)
1123 {
1124         va_list arglist;
1125         char buffer[2048];
1126
1127         if (priority <= ((int)con_threshold.value))
1128         {
1129                 va_start (arglist, fmt);
1130                 vsprintf (buffer,  fmt, arglist);
1131                 va_end (arglist);
1132
1133                 if (con_initialized)
1134                         CON_Out(buffer);
1135
1136                 if (text_console_enabled)
1137                 {
1138                         /* Produce a sanitised version and send it to the standard output */
1139                         char *p1, *p2;
1140
1141                         p1 = p2 = buffer;
1142                         do
1143                                 switch (*p1)
1144                                 {
1145                                 case CC_COLOR:
1146                                 case CC_LSPACING:
1147                                         p1++;
1148                                 case CC_UNDERLINE:
1149                                         p1++;
1150                                         break;
1151                                 default:
1152                                         *p2++ = *p1++;
1153                                 }
1154                         while (*p1);
1155                         *p2 = 0;
1156
1157                         printf("%s", buffer);
1158                 }
1159         }
1160 }