2 * Code for controlling the console
3 * Based on an old version of SDL_Console
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>
9 * This is free, just be sure to give us credit when using it
10 * in any of your programs.
40 int text_console_enabled = 1;
43 #define text_console_enabled (!isvga())
47 /* Console specific cvars */
48 /* How discriminating we are about which messages are displayed */
49 cvar_t con_threshold = {"con_threshold", "0",};
51 /* Private console stuff */
52 #define CON_NUM_LINES 128
54 #define FG_COLOR grd_curcanv->cv_font_fg_color
55 #define get_msecs() approx_fsec_to_msec(timer_get_approx_seconds())
57 #define CON_BG_HIRES (cfexist("scoresb.pcx")?"scoresb.pcx":"scores.pcx")
58 #define CON_BG_LORES (cfexist("scores.pcx")?"scores.pcx":"scoresb.pcx") // Mac datafiles only have scoresb.pcx
59 #define CON_BG ((SWIDTH>=640)?CON_BG_HIRES:CON_BG_LORES)
61 //! Cut the buffer line if it becomes longer than this
62 #define CON_CHARS_PER_LINE 128
63 //! Cursor blink frequency in ms
64 #define CON_BLINK_RATE 500
65 //! Border in pixels from the most left to the first letter
66 #define CON_CHAR_BORDER 4
67 //! Spacing in pixels between lines
68 #define CON_LINE_SPACE 1
69 //! Default prompt used at the commandline
70 #define CON_DEFAULT_PROMPT "]"
71 //! Scroll this many lines at a time (when pressing PGUP or PGDOWN)
72 #define CON_LINE_SCROLL 2
73 //! Indicator showing that you scrolled up the history
74 #define CON_SCROLL_INDICATOR "^"
75 //! Cursor shown if we are in insert mode
76 #define CON_INS_CURSOR "_"
77 //! Cursor shown if we are in overwrite mode
78 #define CON_OVR_CURSOR "|"
79 //! Defines the default hide key (Hide() the console if pressed)
80 #define CON_DEFAULT_HIDEKEY KEY_ESC
81 //! Defines the opening/closing speed
82 #define CON_OPENCLOSE_SPEED 50
85 /*! This is a struct for the console's data */
86 typedef struct console_information_td {
87 int Visible; //! enum that tells which visible state we are in CON_HIDE, CON_SHOW, CON_RAISE, CON_LOWER
88 int RaiseOffset; //! Offset used when scrolling in the console
89 int HideKey; //! the key that can hide the console
90 char **ConsoleLines; //! List of all the past lines
91 char **CommandLines; //! List of all the past commands
92 int TotalConsoleLines; //! Total number of lines in the console
93 int ConsoleScrollBack; //! How much the user scrolled back in the console
94 int TotalCommands; //! Number of commands in the Back Commands
95 int LineBuffer; //! The number of visible lines in the console (autocalculated)
96 int VChars; //! The number of visible characters in one console line (autocalculated)
97 char* Prompt; //! Prompt displayed in command line
98 char Command[CON_CHARS_PER_LINE]; //! current command in command line = lcommand + rcommand
99 char RCommand[CON_CHARS_PER_LINE]; //! left hand side of cursor
100 char LCommand[CON_CHARS_PER_LINE]; //! right hand side of cursor
101 char VCommand[CON_CHARS_PER_LINE]; //! current visible command line
102 int CursorPos; //! Current cursor position in CurrentCommand
103 int Offset; //! CommandOffset (first visible char of command) - if command is too long to fit into console
104 int InsMode; //! Insert or Overwrite characters?
105 grs_canvas *ConsoleSurface; //! Canvas of the console
106 grs_bitmap *BackgroundImage; //! Background image for the console
107 grs_bitmap *InputBackground; //! Dirty rectangle to draw over behind the users background
109 unsigned char ConsoleAlpha; //! The consoles alpha level
111 int CommandScrollBack; //! How much the users scrolled back in the command lines
114 static ConsoleInformation Console;
115 #define console (&Console)
117 /* console is ready to be written to */
118 static int con_initialized;
122 void CON_UpdateOffset(void);
123 /*! Frees all the memory loaded by the console */
126 /*! Sets the alpha channel of an SDL_Surface to the specified value (0 - transparend,
127 255 - opaque). Use this function also for OpenGL. */
128 void CON_Alpha(unsigned char alpha);
129 /*! Internal: Sets the alpha channel of an SDL_Surface to the specified value.
130 Preconditions: the surface in question is RGBA. 0 <= a <= 255, where 0 is transparent and 255 opaque */
131 void CON_AlphaGL(SDL_Surface *s, int alpha);
132 /*! Sets a background image for the console */
134 int CON_Background(grs_bitmap *image);
135 /*! Sets font info for the console */
136 void CON_Font(grs_font *font, int fg, int bg);
137 /*! Modify the prompt of the console */
138 void CON_SetPrompt(char* newprompt);
139 /*! Set the key, that invokes a CON_Hide() after press. default is ESCAPE and you can always hide using
140 ESCAPE and the HideKey. compared against event->key.keysym.sym !! */
141 void CON_SetHideKey(int key);
142 /*! Internal: executes the command typed in at the console (called if you press ENTER)*/
143 void CON_Execute(char* command);
144 /*! Internal: Gets called when TAB was pressed */
145 void CON_TabCompletion(void);
146 /*! Internal: makes newline (same as printf("\n") or CON_Out("\n") ) */
147 void CON_NewLineConsole(void);
148 /*! Internal: shift command history (the one you can switch with the up/down keys) */
149 void CON_NewLineCommand(void);
150 /*! Internal: updates console after resize etc. */
151 void CON_UpdateConsole(void);
154 /*! Internal: draws the commandline the user is typing in to the screen. called by update? */
155 void DrawCommandLine();
157 /*! Internal: Gets called if you press the LEFT key (move cursor left) */
158 void Cursor_Left(void);
159 /*! Internal: Gets called if you press the RIGHT key (move cursor right) */
160 void Cursor_Right(void);
161 /*! Internal: Gets called if you press the HOME key (move cursor to the beginning
163 void Cursor_Home(void);
164 /*! Internal: Gets called if you press the END key (move cursor to the end of the line*/
165 void Cursor_End(void);
166 /*! Internal: Called if you press DELETE (deletes character under the cursor) */
167 void Cursor_Del(void);
168 /*! Internal: Called if you press BACKSPACE (deletes character left of cursor) */
169 void Cursor_BSpace(void);
170 /*! Internal: Called if you type in a character (add the char to the command) */
171 void Cursor_Add(int event);
173 /*! Internal: Called if you press Ctrl-C (deletes the commandline) */
174 void Clear_Command(void);
175 /*! Internal: Called if you press Ctrl-L (deletes the History) */
176 void Clear_History(void);
178 /*! Internal: Called if you press UP key (switches through recent typed in commands */
179 void Command_Up(void);
180 /*! Internal: Called if you press DOWN key (switches through recent typed in commands */
181 void Command_Down(void);
184 /* Takes keys from the keyboard and inputs them to the console
185 If the event was not handled (i.e. WM events or unknown ctrl-shift
186 sequences) the function returns the event for further processing. */
187 int CON_Events(int event)
192 if(event & KEY_CTRLED)
195 switch(event & ~KEY_CTRLED)
214 else if(event & KEY_ALTED)
216 //the console does not handle ALT combinations!
221 //first of all, check if the console hide key was pressed
222 if(event == console->HideKey)
227 switch (event & 0xff)
233 if(event & KEY_SHIFTED)
235 console->ConsoleScrollBack = console->LineBuffer-1;
242 if(event & KEY_SHIFTED)
244 console->ConsoleScrollBack = 0;
251 console->ConsoleScrollBack += CON_LINE_SCROLL;
252 if(console->ConsoleScrollBack > console->LineBuffer-1)
253 console->ConsoleScrollBack = console->LineBuffer-1;
258 console->ConsoleScrollBack -= CON_LINE_SCROLL;
259 if(console->ConsoleScrollBack < 0)
260 console->ConsoleScrollBack = 0;
282 console->InsMode = 1-console->InsMode;
288 if(strlen(console->Command) > 0) {
289 CON_NewLineCommand();
291 // copy the input into the past commands strings
292 strcpy(console->CommandLines[0], console->Command);
294 // display the command including the prompt
295 CON_Out("%s%s\n", console->Prompt, console->Command);
298 CON_Execute(console->Command);
301 console->CommandScrollBack = -1;
309 if (key_to_ascii(event) == 255)
323 /* CON_AlphaGL() -- sets the alpha channel of an SDL_Surface to the
324 * specified value. Preconditions: the surface in question is RGBA.
325 * 0 <= a <= 255, where 0 is transparent and 255 is opaque. */
326 void CON_AlphaGL(SDL_Surface *s, int alpha) {
331 SDL_PixelFormat *format;
332 static char errorPrinted = 0;
335 /* debugging assertions -- these slow you down, but hey, crashing sucks */
337 PRINT_ERROR("NULL Surface passed to CON_AlphaGL\n");
341 /* clamp alpha value to 0...255 */
342 if(alpha < SDL_ALPHA_TRANSPARENT)
343 val = SDL_ALPHA_TRANSPARENT;
344 else if(alpha > SDL_ALPHA_OPAQUE)
345 val = SDL_ALPHA_OPAQUE;
349 /* loop over alpha channels of each pixel, setting them appropriately. */
353 switch (format->BytesPerPixel) {
355 /* 16-bit surfaces don't seem to support alpha channels. */
358 PRINT_ERROR("16-bit SDL surfaces do not support alpha-blending under OpenGL.\n");
362 /* we can do this very quickly in 32-bit mode. 24-bit is more
363 * difficult. And since 24-bit mode is reall the same as 32-bit,
364 * so it usually ends up taking this route too. Win! Unroll loop
365 * and use pointer arithmetic for extra speed. */
366 int numpixels = h * (w << 2);
367 Uint8 *pix = (Uint8 *) (s->pixels);
368 Uint8 *last = pix + numpixels;
370 if((numpixels & 0x7) == 0)
371 for(pixel = pix + 3; pixel < last; pixel += 32)
372 *pixel = *(pixel + 4) = *(pixel + 8) = *(pixel + 12) = *(pixel + 16) = *(pixel + 20) = *(pixel + 24) = *(pixel + 28) = val;
374 for(pixel = pix + 3; pixel < last; pixel += 4)
379 /* we have no choice but to do this slowly. <sigh> */
380 for(y = 0; y < h; ++y)
381 for(x = 0; x < w; ++x) {
383 /* Lock the surface for direct access to the pixels */
384 if(SDL_MUSTLOCK(s) && SDL_LockSurface(s) < 0) {
385 PRINT_ERROR("Can't lock surface: ");
386 fprintf(stderr, "%s\n", SDL_GetError());
389 pixel = DT_GetPixel(s, x, y);
392 SDL_GetRGBA(pixel, format, &r, &g, &b, &a);
393 pixel = SDL_MapRGBA(format, r, g, b, val);
394 SDL_GetRGBA(pixel, format, &r, &g, &b, &a);
395 DT_PutPixel(s, x, y, pixel);
397 /* unlock surface again */
399 SDL_UnlockSurface(s);
407 /* Updates the console buffer */
408 void CON_UpdateConsole(void) {
412 grs_canvas *canv_save;
415 /* Due to the Blits, the update is not very fast: So only update if it's worth it */
419 Screenlines = console->ConsoleSurface->cv_h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h);
421 canv_save = grd_curcanv;
422 gr_set_current_canvas(console->ConsoleSurface);
425 SDL_FillRect(console->ConsoleSurface, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, console->ConsoleAlpha));
431 if(grd_curscreen->flags & SDL_OPENGLBLIT)
432 SDL_SetAlpha(console->ConsoleSurface, 0, SDL_ALPHA_OPAQUE);
435 /* draw the background image if there is one */
436 if(console->BackgroundImage)
437 gr_bitmap(0, 0, console->BackgroundImage);
439 /* Draw the text from the back buffers, calculate in the scrollback from the user
440 * this is a normal SDL software-mode blit, so we need to temporarily set the ColorKey
441 * for the font, and then clear it when we're done.
444 if((grd_curscreen->flags & SDL_OPENGLBLIT) && (grd_curscreen->format->BytesPerPixel > 2)) {
445 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
446 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
450 //now draw text from last but second line to top
451 for(loop = 0; loop < Screenlines-1 && loop < console->LineBuffer - console->ConsoleScrollBack; loop++) {
452 if(console->ConsoleScrollBack != 0 && loop == 0)
453 for(loop2 = 0; loop2 < (console->VChars / 5) + 1; loop2++)
455 orig_color = FG_COLOR;
456 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);
457 FG_COLOR = orig_color;
461 orig_color = FG_COLOR;
462 gr_string(CON_CHAR_BORDER, (Screenlines - loop - 2) * (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h), console->ConsoleLines[console->ConsoleScrollBack + loop]);
463 FG_COLOR = orig_color;
467 gr_set_current_canvas(canv_save);
470 if(grd_curscreen->flags & SDL_OPENGLBLIT)
471 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
475 void CON_UpdateOffset(void) {
476 switch(console->Visible) {
478 console->RaiseOffset -= CON_OPENCLOSE_SPEED;
479 if(console->RaiseOffset <= 0) {
480 console->RaiseOffset = 0;
481 console->Visible = CON_CLOSED;
485 console->RaiseOffset += CON_OPENCLOSE_SPEED;
486 if(console->RaiseOffset >= console->ConsoleSurface->cv_h) {
487 console->RaiseOffset = console->ConsoleSurface->cv_h;
488 console->Visible = CON_OPEN;
497 /* Draws the console buffer to the screen if the console is "visible" */
498 void CON_DrawConsole(void) {
499 grs_canvas *canv_save;
502 /* only draw if console is visible: here this means, that the console is not CON_CLOSED */
503 if(console->Visible == CON_CLOSED)
506 /* Update the scrolling offset */
509 /* Update the command line since it has a blinking cursor */
513 /* before drawing, make sure the alpha channel of the console surface is set
514 * properly. (sigh) I wish we didn't have to do this every frame... */
515 if(grd_curscreen->flags & SDL_OPENGLBLIT)
516 CON_AlphaGL(console->ConsoleSurface, console->ConsoleAlpha);
519 canv_save = grd_curcanv;
520 gr_set_current_canvas(&grd_curscreen->sc_canvas);
522 clip = gr_create_sub_bitmap(&console->ConsoleSurface->cv_bitmap, 0, console->ConsoleSurface->cv_h - console->RaiseOffset, console->ConsoleSurface->cv_w, console->RaiseOffset);
524 gr_bitmap(0, 0, clip);
525 gr_free_sub_bitmap(clip);
528 if(grd_curscreen->flags & SDL_OPENGLBLIT)
529 SDL_UpdateRects(grd_curscreen, 1, &DestRect);
532 gr_set_current_canvas(canv_save);
536 /* Initializes the console */
541 console->Visible = CON_CLOSED;
542 console->RaiseOffset = 0;
543 console->ConsoleLines = NULL;
544 console->CommandLines = NULL;
545 console->TotalConsoleLines = 0;
546 console->ConsoleScrollBack = 0;
547 console->TotalCommands = 0;
548 console->BackgroundImage = NULL;
550 console->ConsoleAlpha = SDL_ALPHA_OPAQUE;
553 console->InsMode = 1;
554 console->CursorPos = 0;
555 console->CommandScrollBack = 0;
556 console->Prompt = d_strdup(CON_DEFAULT_PROMPT);
557 console->HideKey = CON_DEFAULT_HIDEKEY;
559 /* load the console surface */
560 console->ConsoleSurface = NULL;
562 /* Load the dirty rectangle for user input */
563 console->InputBackground = NULL;
565 console->VChars = CON_CHARS_PER_LINE - 1;
566 console->LineBuffer = CON_NUM_LINES;
568 console->ConsoleLines = (char **)d_malloc(sizeof(char *) * console->LineBuffer);
569 console->CommandLines = (char **)d_malloc(sizeof(char *) * console->LineBuffer);
570 for(loop = 0; loop <= console->LineBuffer - 1; loop++) {
571 console->ConsoleLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
572 console->CommandLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
574 memset(console->Command, 0, CON_CHARS_PER_LINE);
575 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
576 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
577 memset(console->VCommand, 0, CON_CHARS_PER_LINE);
581 /* Initialise the cvars */
582 cvar_registervariable (&con_threshold);
590 void gr_init_bitmap_alloc( grs_bitmap *bm, int mode, int x, int y, int w, int h, int bytesperline);
591 void CON_InitGFX(int w, int h)
597 if (console->ConsoleSurface) {
598 /* resize console surface */
599 gr_free_bitmap_data(&console->ConsoleSurface->cv_bitmap);
600 gr_init_bitmap_alloc(&console->ConsoleSurface->cv_bitmap, BM_LINEAR, 0, 0, w, h, w);
602 /* load the console surface */
603 console->ConsoleSurface = gr_create_canvas(w, h);
606 /* Load the consoles font */
607 CON_Font(SMALL_FONT, gr_find_closest_color(29,29,47), -1);
609 /* make sure that the size of the console is valid */
610 if(w > grd_curscreen->sc_w || w < console->ConsoleSurface->cv_font->ft_w * 32)
611 w = grd_curscreen->sc_w;
612 if(h > grd_curscreen->sc_h || h < console->ConsoleSurface->cv_font->ft_h)
613 h = grd_curscreen->sc_h;
615 /* Load the dirty rectangle for user input */
616 if (console->InputBackground)
617 gr_free_bitmap(console->InputBackground);
618 console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
620 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
623 /* calculate the number of visible characters in the command line */
624 #if 0 // doesn't work because proportional font
625 console->VChars = (w - CON_CHAR_BORDER) / console->ConsoleSurface->cv_font->ft_w;
626 if(console->VChars >= CON_CHARS_PER_LINE)
627 console->VChars = CON_CHARS_PER_LINE - 1;
630 gr_init_bitmap_data(&bmp);
631 pcx_error = pcx_read_bitmap(CON_BG, &bmp, BM_LINEAR, pal);
632 Assert(pcx_error == PCX_ERROR_NONE);
633 gr_remap_bitmap_good(&bmp, pal, -1, -1);
634 CON_Background(&bmp);
635 gr_free_bitmap_data(&bmp);
639 /* Makes the console visible */
640 void CON_Show(void) {
641 console->Visible = CON_OPENING;
645 /* Hides the console (make it invisible) */
646 void CON_Hide(void) {
647 console->Visible = CON_CLOSING;
651 /* tells wether the console is visible or not */
652 int CON_isVisible(void) {
653 return((console->Visible == CON_OPEN) || (console->Visible == CON_OPENING));
656 /* Frees all the memory loaded by the console */
657 void CON_Free(void) {
660 for(i = 0; i <= console->LineBuffer - 1; i++) {
661 d_free(console->ConsoleLines[i]);
662 d_free(console->CommandLines[i]);
664 d_free(console->ConsoleLines);
665 d_free(console->CommandLines);
667 console->ConsoleLines = NULL;
668 console->CommandLines = NULL;
670 if (console->ConsoleSurface)
671 gr_free_canvas(console->ConsoleSurface);
672 console->ConsoleSurface = NULL;
674 if (console->BackgroundImage)
675 gr_free_bitmap(console->BackgroundImage);
676 console->BackgroundImage = NULL;
678 if (console->InputBackground)
679 gr_free_bitmap(console->InputBackground);
680 console->InputBackground = NULL;
682 d_free(console->Prompt);
688 /* Increments the console lines */
689 void CON_NewLineConsole(void) {
693 temp = console->ConsoleLines[console->LineBuffer - 1];
695 for(loop = console->LineBuffer - 1; loop > 0; loop--)
696 console->ConsoleLines[loop] = console->ConsoleLines[loop - 1];
698 console->ConsoleLines[0] = temp;
700 memset(console->ConsoleLines[0], 0, CON_CHARS_PER_LINE);
701 if(console->TotalConsoleLines < console->LineBuffer - 1)
702 console->TotalConsoleLines++;
704 //Now adjust the ConsoleScrollBack
705 //dont scroll if not at bottom
706 if(console->ConsoleScrollBack != 0)
707 console->ConsoleScrollBack++;
709 if(console->ConsoleScrollBack > console->LineBuffer-1)
710 console->ConsoleScrollBack = console->LineBuffer-1;
715 /* Increments the command lines */
716 void CON_NewLineCommand(void) {
720 temp = console->CommandLines[console->LineBuffer - 1];
723 for(loop = console->LineBuffer - 1; loop > 0; loop--)
724 console->CommandLines[loop] = console->CommandLines[loop - 1];
726 console->CommandLines[0] = temp;
728 memset(console->CommandLines[0], 0, CON_CHARS_PER_LINE);
729 if(console->TotalCommands < console->LineBuffer - 1)
730 console->TotalCommands++;
733 /* Draws the command line the user is typing in to the screen */
734 /* completely rewritten by C.Wacha */
735 void DrawCommandLine() {
739 grs_font* CurrentFont;
741 static unsigned int LastBlinkTime = 0; /* Last time the consoles cursor blinked */
742 static int LastCursorPos = 0; // Last Cursor Position
743 static int Blink = 0; /* Is the cursor currently blinking */
744 grs_canvas *canv_save;
747 commandbuffer = console->VChars - (int)strlen(console->Prompt) - 1; // -1 to make cursor visible
750 CurrentFont = console->ConsoleSurface->cv_font;
753 //Concatenate the left and right side to command
754 strcpy(console->Command, console->LCommand);
755 strncat(console->Command, console->RCommand, strlen(console->RCommand));
757 //calculate display offset from current cursor position
758 if(console->Offset < console->CursorPos - commandbuffer)
759 console->Offset = console->CursorPos - commandbuffer;
760 if(console->Offset > console->CursorPos)
761 console->Offset = console->CursorPos;
763 //first add prompt to visible part
764 strcpy(console->VCommand, console->Prompt);
766 //then add the visible part of the command
767 strncat(console->VCommand, &console->Command[console->Offset], strlen(&console->Command[console->Offset]));
769 //now display the result
772 //once again we're drawing text, so in OpenGL context we need to temporarily set up
773 //software-mode transparency.
774 if(grd_curscreen->flags & SDL_OPENGLBLIT) {
775 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
776 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
780 canv_save = grd_curcanv;
781 gr_set_current_canvas(console->ConsoleSurface);
783 //first of all restore InputBackground
784 gr_bitmap(0, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->InputBackground);
787 orig_color = FG_COLOR;
788 gr_string(CON_CHAR_BORDER, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, console->VCommand);
789 FG_COLOR = orig_color;
791 //at last add the cursor
792 //check if the blink period is over
793 if(get_msecs() > LastBlinkTime) {
794 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
801 //check if cursor has moved - if yes display cursor anyway
802 if(console->CursorPos != LastCursorPos) {
803 LastCursorPos = console->CursorPos;
804 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
809 int prompt_width, cmd_width, h, w;
811 gr_get_string_size(console->Prompt, &prompt_width, &h, &w);
812 gr_get_string_size(console->LCommand + console->Offset, &cmd_width, &h, &w);
813 x = CON_CHAR_BORDER + prompt_width + cmd_width;
814 orig_color = FG_COLOR;
816 gr_string(x, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, CON_INS_CURSOR);
818 gr_string(x, console->ConsoleSurface->cv_h - console->ConsoleSurface->cv_font->ft_h, CON_OVR_CURSOR);
819 FG_COLOR = orig_color;
822 gr_set_current_canvas(canv_save);
826 if(grd_curscreen->flags & SDL_OPENGLBLIT) {
827 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
833 static inline int con_get_width(void)
835 if (!console->ConsoleSurface)
838 return console->ConsoleSurface->cv_bitmap.bm_w - CON_CHAR_BORDER;
842 static inline int con_get_string_width(char *string)
844 grs_canvas *canv_save;
847 if (!console->ConsoleSurface)
850 canv_save = grd_curcanv;
851 gr_set_current_canvas(console->ConsoleSurface);
852 gr_get_string_size(string, &w, &h, &aw);
853 gr_set_current_canvas(canv_save);
860 # define vsnprintf _vsnprintf
863 /* Outputs text to the console (in game), up to CON_CHARS_PER_LINE chars can be entered */
864 void CON_Out(const char *str, ...) {
866 //keep some space free for stuff like CON_Out("blablabla %s", console->Command);
867 char temp[CON_CHARS_PER_LINE + 128];
870 va_start(marker, str);
871 vsnprintf(temp, CON_CHARS_PER_LINE + 127, str, marker);
876 //temp now contains the complete string we want to output
877 // the only problem is that temp is maybe longer than the console
878 // width so we have to cut it into several pieces
880 if(console->ConsoleLines) {
886 CON_NewLineConsole();
887 strcat(console->ConsoleLines[0], ptemp);
889 } else if (p - ptemp > console->VChars - strlen(console->ConsoleLines[0]) ||
890 con_get_string_width(ptemp) > con_get_width()) {
891 CON_NewLineConsole();
892 strncat(console->ConsoleLines[0], ptemp, console->VChars - strlen(console->ConsoleLines[0]));
893 console->ConsoleLines[0][console->VChars] = '\0';
899 strncat(console->ConsoleLines[0], ptemp, console->VChars - strlen(console->ConsoleLines[0]));
900 console->ConsoleLines[0][console->VChars] = '\0';
908 /* Sets the alpha level of the console, 0 turns off alpha blending */
909 void CON_Alpha(unsigned char alpha) {
910 /* store alpha as state! */
911 console->ConsoleAlpha = alpha;
913 if((grd_curscreen->flags & SDL_OPENGLBLIT) == 0) {
915 SDL_SetAlpha(console->ConsoleSurface, 0, alpha);
917 SDL_SetAlpha(console->ConsoleSurface, SDL_SRCALPHA, alpha);
920 // CON_UpdateConsole();
925 /* Adds background image to the console, scaled to size of console*/
926 int CON_Background(grs_bitmap *image)
928 /* Free the background from the console */
930 if (console->BackgroundImage)
931 gr_free_bitmap(console->BackgroundImage);
932 console->BackgroundImage = NULL;
934 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
939 /* Load a new background */
940 if (console->BackgroundImage)
941 gr_free_bitmap(console->BackgroundImage);
942 console->BackgroundImage = gr_create_bitmap(console->ConsoleSurface->cv_w, console->ConsoleSurface->cv_h);
943 gr_bitmap_scale_to(image, console->BackgroundImage);
946 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
948 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);
953 /* Sets font info for the console */
954 void CON_Font(grs_font *font, int fg, int bg)
956 grs_canvas *canv_save;
958 canv_save = grd_curcanv;
959 gr_set_current_canvas(console->ConsoleSurface);
960 gr_set_curfont(font);
961 gr_set_fontcolor(fg, bg);
962 gr_set_current_canvas(canv_save);
966 /* resizes the console, has to reset alot of stuff
967 * returns 1 on error */
968 void CON_Resize(int w, int h)
970 /* make sure that the size of the console is valid */
971 if(w > grd_curscreen->sc_w || w < console->ConsoleSurface->cv_font->ft_w * 32)
972 w = grd_curscreen->sc_w;
973 if(h > grd_curscreen->sc_h || h < console->ConsoleSurface->cv_font->ft_h)
974 h = grd_curscreen->sc_h;
976 /* resize console surface */
977 gr_free_bitmap_data(&console->ConsoleSurface->cv_bitmap);
978 gr_init_bitmap_alloc(&console->ConsoleSurface->cv_bitmap, BM_LINEAR, 0, 0, w, h, w);
980 /* Load the dirty rectangle for user input */
981 gr_free_bitmap(console->InputBackground);
982 console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
984 /* Now reset some stuff dependent on the previous size */
985 console->ConsoleScrollBack = 0;
987 /* Reload the background image (for the input text area) in the console */
988 if(console->BackgroundImage) {
990 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
992 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);
996 /* restore the alpha level */
997 CON_Alpha(console->ConsoleAlpha);
1001 /* Sets the Prompt for console */
1002 void CON_SetPrompt(char* newprompt) {
1003 //check length so we can still see at least 1 char :-)
1004 if(strlen(newprompt) < console->VChars) {
1005 d_free(console->Prompt);
1006 console->Prompt = d_strdup(newprompt);
1008 CON_Out("prompt too long. (max. %i chars)\n", console->VChars - 1);
1011 /* Sets the key that deactivates (hides) the console. */
1012 void CON_SetHideKey(int key) {
1013 console->HideKey = key;
1016 /* Executes the command entered */
1017 void CON_Execute(char* command) {
1018 cmd_append(command);
1021 void CON_TabCompletion(void) {
1025 command = cmd_complete(console->LCommand);
1028 return; //no tab completion took place so return silently
1030 j = (int)strlen(command);
1031 if(j > CON_CHARS_PER_LINE - 2)
1032 j = CON_CHARS_PER_LINE-1;
1034 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1035 console->CursorPos = 0;
1037 for(i = 0; i < j; i++) {
1038 console->CursorPos++;
1039 console->LCommand[i] = command[i];
1041 //add a trailing space
1042 console->CursorPos++;
1043 console->LCommand[j] = ' ';
1044 console->LCommand[j+1] = '\0';
1047 void Cursor_Left(void) {
1048 char temp[CON_CHARS_PER_LINE];
1050 if(console->CursorPos > 0) {
1051 console->CursorPos--;
1052 strcpy(temp, console->RCommand);
1053 strcpy(console->RCommand, &console->LCommand[strlen(console->LCommand)-1]);
1054 strcat(console->RCommand, temp);
1055 console->LCommand[strlen(console->LCommand)-1] = '\0';
1056 //CON_Out("L:%s, R:%s\n", console->LCommand, console->RCommand);
1060 void Cursor_Right(void) {
1061 char temp[CON_CHARS_PER_LINE];
1063 if(console->CursorPos < strlen(console->Command)) {
1064 console->CursorPos++;
1065 strncat(console->LCommand, console->RCommand, 1);
1066 strcpy(temp, console->RCommand);
1067 strcpy(console->RCommand, &temp[1]);
1068 //CON_Out("L:%s, R:%s\n", console->LCommand, console->RCommand);
1072 void Cursor_Home(void) {
1073 char temp[CON_CHARS_PER_LINE];
1075 console->CursorPos = 0;
1076 strcpy(temp, console->RCommand);
1077 strcpy(console->RCommand, console->LCommand);
1078 strncat(console->RCommand, temp, strlen(temp));
1079 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1082 void Cursor_End(void) {
1083 console->CursorPos = (int)strlen(console->Command);
1084 strncat(console->LCommand, console->RCommand, strlen(console->RCommand));
1085 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1088 void Cursor_Del(void) {
1089 char temp[CON_CHARS_PER_LINE];
1091 if(strlen(console->RCommand) > 0) {
1092 strcpy(temp, console->RCommand);
1093 strcpy(console->RCommand, &temp[1]);
1097 void Cursor_BSpace(void) {
1098 if(console->CursorPos > 0) {
1099 console->CursorPos--;
1101 if(console->Offset < 0)
1102 console->Offset = 0;
1103 console->LCommand[strlen(console->LCommand)-1] = '\0';
1107 void Cursor_Add(int event)
1109 if(strlen(console->Command) < CON_CHARS_PER_LINE - 1)
1111 console->CursorPos++;
1112 console->LCommand[strlen(console->LCommand)] = key_to_ascii(event);
1113 console->LCommand[strlen(console->LCommand)] = '\0';
1117 void Clear_Command(void) {
1118 console->CursorPos = 0;
1119 memset(console->VCommand, 0, CON_CHARS_PER_LINE);
1120 memset(console->Command, 0, CON_CHARS_PER_LINE);
1121 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1122 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1125 void Clear_History(void) {
1128 for(loop = 0; loop <= console->LineBuffer - 1; loop++)
1129 memset(console->ConsoleLines[loop], 0, CON_CHARS_PER_LINE);
1132 void Command_Up(void) {
1133 if(console->CommandScrollBack < console->TotalCommands - 1) {
1134 /* move back a line in the command strings and copy the command to the current input string */
1135 console->CommandScrollBack++;
1136 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1137 console->Offset = 0;
1138 strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1139 console->CursorPos = (int)strlen(console->CommandLines[console->CommandScrollBack]);
1140 CON_UpdateConsole();
1144 void Command_Down(void) {
1145 if(console->CommandScrollBack > -1) {
1146 /* move forward a line in the command strings and copy the command to the current input string */
1147 console->CommandScrollBack--;
1148 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1149 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1150 console->Offset = 0;
1151 if(console->CommandScrollBack > -1)
1152 strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1153 console->CursorPos = (int)strlen(console->LCommand);
1154 CON_UpdateConsole();
1158 /* convert to ansi rgb colors 17-231 */
1159 #define PAL2ANSI(x) ((36*gr_palette[(x)*3]/11) + (6*gr_palette[(x)*3+1]/11) + (gr_palette[(x)*3+2]/11) + 16)
1161 /* Print a message to the console */
1162 void con_printf(int priority, char *fmt, ...)
1167 if (priority <= (con_threshold.intval))
1169 va_start (arglist, fmt);
1170 vsprintf (buffer, fmt, arglist);
1173 if (con_initialized)
1176 if (!text_console_enabled)
1179 if (isatty(fileno(stdout))) {
1181 unsigned char color, spacing, underline;
1191 printf("\x1B[38;5;%dm", PAL2ANSI(color));
1198 //printf("<SPACING %d>", color);
1205 //printf("<UNDERLINE>");
1216 /* Produce a sanitised version and send it to the standard output */
1235 printf("%s", buffer);