console/CON_console.c

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