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         if(!console)
 334                 return;
 335
 336         /* Due to the Blits, the update is not very fast: So only update if it's worth it */
 337         if(!CON_isVisible())
 338                 return;
 339
 340         Screenlines = console->ConsoleSurface->cv_h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h);
 341
 342         canv_save = grd_curcanv;
 343         gr_set_current_canvas(console->ConsoleSurface);
 344
 345 #if 0
 346         SDL_FillRect(console->ConsoleSurface, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, console->ConsoleAlpha));
 347 #else
 348         //gr_rect(0,0,
 349 #endif
 350
 351 #if 0
 352         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 353                 SDL_SetAlpha(console->ConsoleSurface, 0, SDL_ALPHA_OPAQUE);
 354 #endif
 355
 356         /* draw the background image if there is one */
 357         if(console->BackgroundImage)
 358                 gr_bitmap(0, 0, console->BackgroundImage);
 359
 360         /* Draw the text from the back buffers, calculate in the scrollback from the user
 361          * this is a normal SDL software-mode blit, so we need to temporarily set the ColorKey
 362          * for the font, and then clear it when we're done.
 363          */
 364 #if 0
 365         if((console->OutputScreen->flags & SDL_OPENGLBLIT) && (console->OutputScreen->format->BytesPerPixel > 2)) {
 366                 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
 367                 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
 368         }
 369 #endif
 370
 371         //now draw text from last but second line to top
 372         for(loop = 0; loop < Screenlines-1 && loop < console->LineBuffer - console->ConsoleScrollBack; loop++) {
 373                 if(console->ConsoleScrollBack != 0 && loop == 0)
 374                         for(loop2 = 0; loop2 < (console->VChars / 5) + 1; loop2++)
 375                         {
 376                                 orig_color = FG_COLOR;
 377                                 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);
 378                                 FG_COLOR = orig_color;
 379                         }
 380                 else
 381                 {
 382                         orig_color = FG_COLOR;
 383                         gr_string(CON_CHAR_BORDER, (Screenlines - loop - 2) * (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h), console->ConsoleLines[console->ConsoleScrollBack + loop]);
 384                         FG_COLOR = orig_color;
 385                 }
 386         }
 387
 388         gr_set_current_canvas(canv_save);
 389
 390 #if 0
 391         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 392                 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
 393 #endif
 394 }
 395
 396 void CON_UpdateOffset(void) {
 397         if(!console)
 398                 return;
 399
 400         switch(console->Visible) {
 401                 case CON_CLOSING:
 402                         console->RaiseOffset -= CON_OPENCLOSE_SPEED;
 403                         if(console->RaiseOffset <= 0) {
 404                                 console->RaiseOffset = 0;
 405                                 console->Visible = CON_CLOSED;
 406                         }
 407                         break;
 408                 case CON_OPENING:
 409                         console->RaiseOffset += CON_OPENCLOSE_SPEED;
 410                         if(console->RaiseOffset >= console->ConsoleSurface->cv_h) {
 411                                 console->RaiseOffset = console->ConsoleSurface->cv_h;
 412                                 console->Visible = CON_OPEN;
 413                         }
 414                         break;
 415                 case CON_OPEN:
 416                 case CON_CLOSED:
 417                         break;
 418         }
 419 }
 420
 421 /* Draws the console buffer to the screen if the console is "visible" */
 422 void CON_DrawConsole(void) {
 423         grs_canvas *canv_save;
 424         grs_bitmap *clip;
 425
 426         if(!console)
 427                 return;
 428
 429         /* only draw if console is visible: here this means, that the console is not CON_CLOSED */
 430         if(console->Visible == CON_CLOSED)
 431                 return;
 432
 433         /* Update the scrolling offset */
 434         CON_UpdateOffset();
 435
 436         /* Update the command line since it has a blinking cursor */
 437         DrawCommandLine();
 438
 439 #if 0
 440         /* before drawing, make sure the alpha channel of the console surface is set
 441          * properly.  (sigh) I wish we didn't have to do this every frame... */
 442         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 443                 CON_AlphaGL(console->ConsoleSurface, console->ConsoleAlpha);
 444 #endif
 445
 446         canv_save = grd_curcanv;
 447         gr_set_current_canvas(&console->OutputScreen->sc_canvas);
 448
 449         clip = gr_create_sub_bitmap(&console->ConsoleSurface->cv_bitmap, 0, console->ConsoleSurface->cv_h - console->RaiseOffset, console->ConsoleSurface->cv_w, console->RaiseOffset);
 450
 451         gr_bitmap(0, 0, clip);
 452         gr_free_sub_bitmap(clip);
 453
 454 #if 0
 455         if(console->OutputScreen->flags & SDL_OPENGLBLIT)
 456                 SDL_UpdateRects(console->OutputScreen, 1, &DestRect);
 457 #endif
 458
 459         gr_set_current_canvas(canv_save);
 460 }
 461
 462
 463 /* Initializes the console */
 464 void CON_Init(grs_font *Font, grs_screen *DisplayScreen, int lines, int x, int y, int w, int h)
 465 {
 466         int loop;
 467
 468         console->Visible = CON_CLOSED;
 469         console->RaiseOffset = 0;
 470         console->ConsoleLines = NULL;
 471         console->CommandLines = NULL;
 472         console->TotalConsoleLines = 0;
 473         console->ConsoleScrollBack = 0;
 474         console->TotalCommands = 0;
 475         console->BackgroundImage = NULL;
 476 #if 0
 477         console->ConsoleAlpha = SDL_ALPHA_OPAQUE;
 478 #endif
 479         console->Offset = 0;
 480         console->InsMode = 1;
 481         console->CursorPos = 0;
 482         console->CommandScrollBack = 0;
 483         console->OutputScreen = DisplayScreen;
 484         console->Prompt = CON_DEFAULT_PROMPT;
 485         console->HideKey = CON_DEFAULT_HIDEKEY;
 486
 487         /* make sure that the size of the console is valid */
 488         if(w > console->OutputScreen->sc_w || w < Font->ft_w * 32)
 489                 w = console->OutputScreen->sc_w;
 490         if(h > console->OutputScreen->sc_h || h < Font->ft_h)
 491                 h = console->OutputScreen->sc_h;
 492
 493         /* load the console surface */
 494         console->ConsoleSurface = gr_create_canvas(w, h);
 495
 496         /* Load the consoles font */
 497         {
 498                 grs_canvas *canv_save;
 499
 500                 canv_save = grd_curcanv;
 501                 gr_set_current_canvas(console->ConsoleSurface);
 502                 gr_set_curfont(Font);
 503                 gr_set_fontcolor(gr_getcolor(63,63,63), -1);
 504                 gr_set_current_canvas(canv_save);
 505         }
 506
 507
 508         /* Load the dirty rectangle for user input */
 509         console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
 510 #if 0
 511         SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 512 #endif
 513
 514         /* calculate the number of visible characters in the command line */
 515         console->VChars = (w - CON_CHAR_BORDER) / console->ConsoleSurface->cv_font->ft_w;
 516         if(console->VChars > CON_CHARS_PER_LINE)
 517                 console->VChars = CON_CHARS_PER_LINE;
 518
 519         /* We would like to have a minumum # of lines to guarentee we don't create a memory error */
 520         if(h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h) > lines)
 521                 console->LineBuffer = h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h);
 522         else
 523                 console->LineBuffer = lines;
 524
 525
 526         console->ConsoleLines = (char **)d_malloc(sizeof(char *) * console->LineBuffer);
 527         console->CommandLines = (char **)d_malloc(sizeof(char *) * console->LineBuffer);
 528         for(loop = 0; loop <= console->LineBuffer - 1; loop++) {
 529                 console->ConsoleLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
 530                 console->CommandLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
 531         }
 532         memset(console->Command, 0, CON_CHARS_PER_LINE);
 533         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 534         memset(console->RCommand, 0, CON_CHARS_PER_LINE);
 535         memset(console->VCommand, 0, CON_CHARS_PER_LINE);
 536
 537
 538         CON_Out("Console initialised.");
 539         CON_NewLineConsole();
 540 }
 541
 542 /* Makes the console visible */
 543 void CON_Show(void) {
 544         if(console) {
 545                 console->Visible = CON_OPENING;
 546                 CON_UpdateConsole();
 547         }
 548 }
 549
 550 /* Hides the console (make it invisible) */
 551 void CON_Hide(void) {
 552         if(console)
 553                 console->Visible = CON_CLOSING;
 554 }
 555
 556 /* tells wether the console is visible or not */
 557 int CON_isVisible(void) {
 558         if(!console)
 559                 return CON_CLOSED;
 560         return((console->Visible == CON_OPEN) || (console->Visible == CON_OPENING));
 561 }
 562
 563 /* Frees all the memory loaded by the console */
 564 void CON_Free(void) {
 565         int i;
 566
 567         if(!console)
 568                 return;
 569
 570         for(i = 0; i <= console->LineBuffer - 1; i++) {
 571                 d_free(console->ConsoleLines[i]);
 572                 d_free(console->CommandLines[i]);
 573         }
 574         d_free(console->ConsoleLines);
 575         d_free(console->CommandLines);
 576
 577         console->ConsoleLines = NULL;
 578         console->CommandLines = NULL;
 579
 580         gr_free_canvas(console->ConsoleSurface);
 581         console->ConsoleSurface = NULL;
 582
 583         if (console->BackgroundImage)
 584                 gr_free_bitmap(console->BackgroundImage);
 585         console->BackgroundImage = NULL;
 586
 587         gr_free_bitmap(console->InputBackground);
 588         console->InputBackground = NULL;
 589 }
 590
 591
 592 /* Increments the console lines */
 593 void CON_NewLineConsole(void) {
 594         int loop;
 595         char* temp;
 596
 597         if(!console)
 598                 return;
 599
 600         temp = console->ConsoleLines[console->LineBuffer - 1];
 601
 602         for(loop = console->LineBuffer - 1; loop > 0; loop--)
 603                 console->ConsoleLines[loop] = console->ConsoleLines[loop - 1];
 604
 605         console->ConsoleLines[0] = temp;
 606
 607         memset(console->ConsoleLines[0], 0, CON_CHARS_PER_LINE);
 608         if(console->TotalConsoleLines < console->LineBuffer - 1)
 609                 console->TotalConsoleLines++;
 610
 611         //Now adjust the ConsoleScrollBack
 612         //dont scroll if not at bottom
 613         if(console->ConsoleScrollBack != 0)
 614                 console->ConsoleScrollBack++;
 615         //boundaries
 616         if(console->ConsoleScrollBack > console->LineBuffer-1)
 617                 console->ConsoleScrollBack = console->LineBuffer-1;
 618
 619 }
 620
 621
 622 /* Increments the command lines */
 623 void CON_NewLineCommand(void) {
 624         int loop;
 625         char *temp;
 626
 627         if(!console)
 628                 return;
 629
 630         temp  = console->CommandLines[console->LineBuffer - 1];
 631
 632
 633         for(loop = console->LineBuffer - 1; loop > 0; loop--)
 634                 console->CommandLines[loop] = console->CommandLines[loop - 1];
 635
 636         console->CommandLines[0] = temp;
 637
 638         memset(console->CommandLines[0], 0, CON_CHARS_PER_LINE);
 639         if(console->TotalCommands < console->LineBuffer - 1)
 640                 console->TotalCommands++;
 641 }
 642
 643 /* Draws the command line the user is typing in to the screen */
 644 /* completely rewritten by C.Wacha */
 645 void DrawCommandLine() {
 646         int x;
 647         int commandbuffer;
 648 #if 0
 649         grs_font* CurrentFont;
 650 #endif
 651         static unsigned int LastBlinkTime = 0;  /* Last time the consoles cursor blinked */
 652         static int LastCursorPos = 0;           // Last Cursor Position
 653         static int Blink = 0;                   /* Is the cursor currently blinking */
 654         grs_canvas *canv_save;
 655         short orig_color;
 656
 657         commandbuffer = console->VChars - strlen(console->Prompt)-1; // -1 to make cursor visible
 658
 659 #if 0
 660         CurrentFont = console->ConsoleSurface->cv_font;
 661 #endif
 662
 663         //Concatenate the left and right side to command
 664         strcpy(console->Command, console->LCommand);
 665         strncat(console->Command, console->RCommand, strlen(console->RCommand));
 666
 667         //calculate display offset from current cursor position
 668         if(console->Offset < console->CursorPos - commandbuffer)
 669                 console->Offset = console->CursorPos - commandbuffer;
 670         if(console->Offset > console->CursorPos)
 671                 console->Offset = console->CursorPos;
 672
 673         //first add prompt to visible part
 674         strcpy(console->VCommand, console->Prompt);
 675
 676         //then add the visible part of the command
 677         strncat(console->VCommand, &console->Command[console->Offset], strlen(&console->Command[console->Offset]));
 678
 679         //now display the result
 680
 681 #if 0
 682         //once again we're drawing text, so in OpenGL context we need to temporarily set up
 683         //software-mode transparency.
 684         if(console->OutputScreen->flags & SDL_OPENGLBLIT) {
 685                 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
 686                 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
 687         }
 688 #endif
 689
 690         canv_save = grd_curcanv;
 691         gr_set_current_canvas(console->ConsoleSurface);
 692
 693         //first of all restore InputBackground
 694         gr_bitmap(0, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->InputBackground);
 695
 696         //now add the text
 697         orig_color = FG_COLOR;
 698         gr_string(CON_CHAR_BORDER, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->VCommand);
 699         FG_COLOR = orig_color;
 700
 701         //at last add the cursor
 702         //check if the blink period is over
 703         if(get_msecs() > LastBlinkTime) {
 704                 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
 705                 if(Blink)
 706                         Blink = 0;
 707                 else
 708                         Blink = 1;
 709         }
 710
 711         //check if cursor has moved - if yes display cursor anyway
 712         if(console->CursorPos != LastCursorPos) {
 713                 LastCursorPos = console->CursorPos;
 714                 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
 715                 Blink = 1;
 716         }
 717
 718         if(Blink) {
 719                 int prompt_width, cmd_width, h, w;
 720
 721                 gr_get_string_size(console->Prompt, &prompt_width, &h, &w);
 722                 gr_get_string_size(console->LCommand + console->Offset, &cmd_width, &h, &w);
 723                 x = CON_CHAR_BORDER + prompt_width + cmd_width;
 724                 orig_color = FG_COLOR;
 725                 if(console->InsMode)
 726                         gr_string(x, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, CON_INS_CURSOR);
 727                 else
 728                         gr_string(x, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, CON_OVR_CURSOR);
 729                 FG_COLOR = orig_color;
 730         }
 731
 732         gr_set_current_canvas(canv_save);
 733
 734
 735 #if 0
 736         if(console->OutputScreen->flags & SDL_OPENGLBLIT) {
 737                 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
 738         }
 739 #endif
 740 }
 741
 742 #ifdef _MSC_VER
 743 # define vsnprintf _vsnprintf
 744 #endif
 745
 746 /* Outputs text to the console (in game), up to CON_CHARS_PER_LINE chars can be entered */
 747 void CON_Out(const char *str, ...) {
 748         va_list marker;
 749         //keep some space free for stuff like CON_Out("blablabla %s", console->Command);
 750         char temp[CON_CHARS_PER_LINE + 128];
 751         char* ptemp;
 752
 753         if(!console)
 754                 return;
 755
 756         va_start(marker, str);
 757         vsnprintf(temp, CON_CHARS_PER_LINE + 127, str, marker);
 758         va_end(marker);
 759
 760         ptemp = temp;
 761
 762         //temp now contains the complete string we want to output
 763         // the only problem is that temp is maybe longer than the console
 764         // width so we have to cut it into several pieces
 765
 766         if(console->ConsoleLines) {
 767                 while(strlen(ptemp) > console->VChars) {
 768                         CON_NewLineConsole();
 769                         strncpy(console->ConsoleLines[0], ptemp, console->VChars);
 770                         console->ConsoleLines[0][console->VChars] = '\0';
 771                         ptemp = &ptemp[console->VChars];
 772                 }
 773                 CON_NewLineConsole();
 774                 strncpy(console->ConsoleLines[0], ptemp, console->VChars);
 775                 console->ConsoleLines[0][console->VChars] = '\0';
 776                 CON_UpdateConsole();
 777         }
 778 }
 779
 780
 781 #if 0
 782 /* Sets the alpha level of the console, 0 turns off alpha blending */
 783 void CON_Alpha(unsigned char alpha) {
 784         if(!console)
 785                 return;
 786
 787         /* store alpha as state! */
 788         console->ConsoleAlpha = alpha;
 789
 790         if((console->OutputScreen->flags & SDL_OPENGLBLIT) == 0) {
 791                 if(alpha == 0)
 792                         SDL_SetAlpha(console->ConsoleSurface, 0, alpha);
 793                 else
 794                         SDL_SetAlpha(console->ConsoleSurface, SDL_SRCALPHA, alpha);
 795         }
 796
 797         //      CON_UpdateConsole();
 798 }
 799 #endif
 800
 801
 802 /* Adds  background image to the console, scaled to size of console*/
 803 int CON_Background(grs_bitmap *image)
 804 {
 805         if(!console)
 806                 return 1;
 807
 808         /* Free the background from the console */
 809         if (image == NULL) {
 810                 if (console->BackgroundImage)
 811                         gr_free_bitmap(console->BackgroundImage);
 812                 console->BackgroundImage = NULL;
 813 #if 0
 814                 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 815 #endif
 816                 return 0;
 817         }
 818
 819         /* Load a new background */
 820         if (console->BackgroundImage)
 821                 gr_free_bitmap(console->BackgroundImage);
 822         console->BackgroundImage = gr_create_bitmap(console->ConsoleSurface->cv_w, console->ConsoleSurface->cv_h);
 823         gr_bitmap_scale_to(image, console->BackgroundImage);
 824
 825 #if 0
 826         SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 827 #endif
 828         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);
 829
 830         return 0;
 831 }
 832
 833 /* Sets font info for the console */
 834 void CON_Font(grs_font *font, int fg, int bg)
 835 {
 836         grs_canvas *canv_save;
 837
 838         canv_save = grd_curcanv;
 839         gr_set_current_canvas(console->ConsoleSurface);
 840         gr_set_curfont(font);
 841         gr_set_fontcolor(fg, bg);
 842         gr_set_current_canvas(canv_save);
 843 }
 844
 845 void gr_init_bitmap_alloc( grs_bitmap *bm, int mode, int x, int y, int w, int h, int bytesperline);
 846 /* resizes the console, has to reset alot of stuff
 847  * returns 1 on error */
 848 int CON_Resize(int x, int y, int w, int h)
 849 {
 850         if(!console)
 851                 return 1;
 852
 853         /* make sure that the size of the console is valid */
 854         if(w > console->OutputScreen->sc_w || w < console->ConsoleSurface->cv_font->ft_w * 32)
 855                 w = console->OutputScreen->sc_w;
 856         if(h > console->OutputScreen->sc_h || h < console->ConsoleSurface->cv_font->ft_h)
 857                 h = console->OutputScreen->sc_h;
 858
 859         /* resize console surface */
 860         gr_free_bitmap_data(&console->ConsoleSurface->cv_bitmap);
 861         gr_init_bitmap_alloc(&console->ConsoleSurface->cv_bitmap, BM_LINEAR, 0, 0, w, h, w);
 862
 863         /* Load the dirty rectangle for user input */
 864         gr_free_bitmap(console->InputBackground);
 865         console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
 866
 867         /* Now reset some stuff dependent on the previous size */
 868         console->ConsoleScrollBack = 0;
 869
 870         /* Reload the background image (for the input text area) in the console */
 871         if(console->BackgroundImage) {
 872 #if 0
 873                 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
 874 #endif
 875                 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);
 876         }
 877
 878 #if 0
 879         /* restore the alpha level */
 880         CON_Alpha(console->ConsoleAlpha);
 881 #endif
 882         return 0;
 883 }
 884
 885 /* Transfers the console to another screen surface, and adjusts size */
 886 int CON_Transfer(grs_screen *new_outputscreen, int x, int y, int w, int h)
 887 {
 888         if(!console)
 889                 return 1;
 890
 891         console->OutputScreen = new_outputscreen;
 892
 893         return(CON_Resize(x, y, w, h));
 894 }
 895
 896 /* Sets the Prompt for console */
 897 void CON_SetPrompt(char* newprompt) {
 898         if(!console)
 899                 return;
 900
 901         //check length so we can still see at least 1 char :-)
 902         if(strlen(newprompt) < console->VChars)
 903                 console->Prompt = d_strdup(newprompt);
 904         else
 905                 CON_Out("prompt too long. (max. %i chars)", console->VChars - 1);
 906 }
 907
 908 /* Sets the key that deactivates (hides) the console. */
 909 void CON_SetHideKey(int key) {
 910         if(console)
 911                 console->HideKey = key;
 912 }
 913
 914 /* Executes the command entered */
 915 void CON_Execute(char* command) {
 916         if(console)
 917                 cmd_parse(command);
 918 }
 919
 920 void CON_TabCompletion(void) {
 921         int i,j;
 922         char* command;
 923
 924         if(!console)
 925                 return;
 926
 927         command = d_strdup(console->LCommand);
 928         command = cmd_complete(command);
 929
 930         if(!command)
 931                 return; //no tab completion took place so return silently
 932
 933         j = strlen(command);
 934         if(j > CON_CHARS_PER_LINE - 2)
 935                 j = CON_CHARS_PER_LINE-1;
 936
 937         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 938         console->CursorPos = 0;
 939
 940         for(i = 0; i < j; i++) {
 941                 console->CursorPos++;
 942                 console->LCommand[i] = command[i];
 943         }
 944         //add a trailing space
 945         console->CursorPos++;
 946         console->LCommand[j] = ' ';
 947         console->LCommand[j+1] = '\0';
 948 }
 949
 950 void Cursor_Left(void) {
 951         char temp[CON_CHARS_PER_LINE];
 952
 953         if(console->CursorPos > 0) {
 954                 console->CursorPos--;
 955                 strcpy(temp, console->RCommand);
 956                 strcpy(console->RCommand, &console->LCommand[strlen(console->LCommand)-1]);
 957                 strcat(console->RCommand, temp);
 958                 console->LCommand[strlen(console->LCommand)-1] = '\0';
 959                 //CON_Out("L:%s, R:%s", console->LCommand, console->RCommand);
 960         }
 961 }
 962
 963 void Cursor_Right(void) {
 964         char temp[CON_CHARS_PER_LINE];
 965
 966         if(console->CursorPos < strlen(console->Command)) {
 967                 console->CursorPos++;
 968                 strncat(console->LCommand, console->RCommand, 1);
 969                 strcpy(temp, console->RCommand);
 970                 strcpy(console->RCommand, &temp[1]);
 971                 //CON_Out("L:%s, R:%s", console->LCommand, console->RCommand);
 972         }
 973 }
 974
 975 void Cursor_Home(void) {
 976         char temp[CON_CHARS_PER_LINE];
 977
 978         console->CursorPos = 0;
 979         strcpy(temp, console->RCommand);
 980         strcpy(console->RCommand, console->LCommand);
 981         strncat(console->RCommand, temp, strlen(temp));
 982         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
 983 }
 984
 985 void Cursor_End(void) {
 986         console->CursorPos = strlen(console->Command);
 987         strncat(console->LCommand, console->RCommand, strlen(console->RCommand));
 988         memset(console->RCommand, 0, CON_CHARS_PER_LINE);
 989 }
 990
 991 void Cursor_Del(void) {
 992         char temp[CON_CHARS_PER_LINE];
 993
 994         if(strlen(console->RCommand) > 0) {
 995                 strcpy(temp, console->RCommand);
 996                 strcpy(console->RCommand, &temp[1]);
 997         }
 998 }
 999
1000 void Cursor_BSpace(void) {
1001         if(console->CursorPos > 0) {
1002                 console->CursorPos--;
1003                 console->Offset--;
1004                 if(console->Offset < 0)
1005                         console->Offset = 0;
1006                 console->LCommand[strlen(console->LCommand)-1] = '\0';
1007         }
1008 }
1009
1010 void Cursor_Add(int event)
1011 {
1012         if(strlen(console->Command) < CON_CHARS_PER_LINE - 1)
1013         {
1014                 console->CursorPos++;
1015                 console->LCommand[strlen(console->LCommand)] = key_to_ascii(event);
1016                 console->LCommand[strlen(console->LCommand)] = '\0';
1017         }
1018 }
1019
1020 void Clear_Command(void) {
1021         console->CursorPos = 0;
1022         memset(console->VCommand, 0, CON_CHARS_PER_LINE);
1023         memset(console->Command, 0, CON_CHARS_PER_LINE);
1024         memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1025         memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1026 }
1027
1028 void Clear_History(void) {
1029         int loop;
1030
1031         for(loop = 0; loop <= console->LineBuffer - 1; loop++)
1032                 memset(console->ConsoleLines[loop], 0, CON_CHARS_PER_LINE);
1033 }
1034
1035 void Command_Up(void) {
1036         if(console->CommandScrollBack < console->TotalCommands - 1) {
1037                 /* move back a line in the command strings and copy the command to the current input string */
1038                 console->CommandScrollBack++;
1039                 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1040                 console->Offset = 0;
1041                 strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1042                 console->CursorPos = strlen(console->CommandLines[console->CommandScrollBack]);
1043                 CON_UpdateConsole();
1044         }
1045 }
1046
1047 void Command_Down(void) {
1048         if(console->CommandScrollBack > -1) {
1049                 /* move forward a line in the command strings and copy the command to the current input string */
1050                 console->CommandScrollBack--;
1051                 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1052                 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1053                 console->Offset = 0;
1054                 if(console->CommandScrollBack > -1)
1055                         strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1056                 console->CursorPos = strlen(console->LCommand);
1057                 CON_UpdateConsole();
1058         }
1059 }
1060
1061 #include <stdio.h>
1062 #include <stdlib.h>
1063 #include <stdarg.h>
1064 #include <string.h>
1065 #ifndef _WIN32_WCE
1066 #include <fcntl.h>
1067 #endif
1068 #include <ctype.h>
1069
1070 #include "pstypes.h"
1071 #include "u_mem.h"
1072 #include "error.h"
1073 #include "console.h"
1074 #include "cmd.h"
1075 #include "cvar.h"
1076 #include "gr.h"
1077 #include "gamefont.h"
1078 #include "pcx.h"
1079 #include "cfile.h"
1080
1081 #ifndef __MSDOS__
1082 int text_console_enabled = 1;
1083 #else
1084 int isvga();
1085 #define text_console_enabled (!isvga())
1086 #endif
1087
1088
1089 /* Console specific cvars */
1090 /* How discriminating we are about which messages are displayed */
1091 cvar_t con_threshold = {"con_threshold", "0",};
1092
1093 /* Private console stuff */
1094 #define CON_NUM_LINES 40
1095
1096 static int con_initialized;
1097
1098
1099 /* Free the console */
1100 void con_free(void)
1101 {
1102         if (con_initialized)
1103                 CON_Free();
1104         con_initialized = 0;
1105 }
1106
1107
1108 /* Initialise the console */
1109 void con_init(void)
1110 {
1111         grs_screen fake_screen;
1112         grs_font   fake_font;
1113
1114         fake_screen.sc_w = 320;
1115         fake_screen.sc_h = 200;
1116         fake_font.ft_w = 5;
1117         fake_font.ft_h = 5;
1118
1119         CON_Init(&fake_font, &fake_screen, CON_NUM_LINES, 0, 0, 320, 200);
1120
1121         cmd_init();
1122
1123         /* Initialise the cvars */
1124         cvar_registervariable (&con_threshold);
1125
1126         con_initialized = 1;
1127
1128         atexit(con_free);
1129 }
1130
1131
1132 #define CON_BG_HIRES (cfexist("scoresb.pcx")?"scoresb.pcx":"scores.pcx")
1133 #define CON_BG_LORES (cfexist("scores.pcx")?"scores.pcx":"scoresb.pcx") // Mac datafiles only have scoresb.pcx
1134 #define CON_BG ((SWIDTH>=640)?CON_BG_HIRES:CON_BG_LORES)
1135
1136 void con_background(char *filename)
1137 {
1138         int pcx_error;
1139         grs_bitmap bmp;
1140         ubyte pal[256*3];
1141
1142         gr_init_bitmap_data(&bmp);
1143         pcx_error = pcx_read_bitmap(filename, &bmp, BM_LINEAR, pal);
1144         Assert(pcx_error == PCX_ERROR_NONE);
1145         gr_remap_bitmap_good(&bmp, pal, -1, -1);
1146         CON_Background(&bmp);
1147         gr_free_bitmap_data(&bmp);
1148 }
1149
1150
1151 void con_init_gfx(void)
1152 {
1153         CON_Font(SMALL_FONT, gr_getcolor(63, 63, 63), -1);
1154         CON_Transfer(grd_curscreen, 0, 0, SWIDTH, SHEIGHT / 2);
1155
1156         con_background(CON_BG);
1157 }
1158
1159
1160 void con_resize(void)
1161 {
1162         CON_Font(SMALL_FONT, gr_getcolor(63, 63, 63), -1);
1163         CON_Resize(0, 0, SWIDTH, SHEIGHT / 2);
1164         con_background(CON_BG);
1165 }
1166
1167 /* Print a message to the console */
1168 void con_printf(int priority, char *fmt, ...)
1169 {
1170         va_list arglist;
1171         char buffer[2048];
1172
1173         if (priority <= ((int)con_threshold.value))
1174         {
1175                 va_start (arglist, fmt);
1176                 vsprintf (buffer,  fmt, arglist);
1177                 va_end (arglist);
1178
1179                 if (con_initialized)
1180                         CON_Out(buffer);
1181
1182                 if (text_console_enabled)
1183                 {
1184                         /* Produce a sanitised version and send it to the standard output */
1185                         char *p1, *p2;
1186
1187                         p1 = p2 = buffer;
1188                         do
1189                                 switch (*p1)
1190                                 {
1191                                 case CC_COLOR:
1192                                 case CC_LSPACING:
1193                                         p1++;
1194                                 case CC_UNDERLINE:
1195                                         p1++;
1196                                         break;
1197                                 default:
1198                                         *p2++ = *p1++;
1199                                 }
1200                         while (*p1);
1201                         *p2 = 0;
1202
1203                         printf("%s", buffer);
1204                 }
1205         }
1206 }