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>
6 * This is free, just be sure to give us credit when using it
7 * in any of your programs.
19 #include "CON_console.h"
26 #define FG_COLOR grd_curcanv->cv_font_fg_color
27 #define get_msecs() approx_fsec_to_msec(timer_get_approx_seconds())
30 /* This contains a pointer to the "topmost" console. The console that
31 * is currently taking keyboard input. */
32 static ConsoleInformation *Topmost;
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)
41 if(!CON_isVisible(Topmost))
44 if(event & KEY_CTRLED)
47 switch(event & ~KEY_CTRLED)
56 Clear_Command(Topmost);
59 Clear_History(Topmost);
60 CON_UpdateConsole(Topmost);
66 else if(event & KEY_ALTED)
68 //the console does not handle ALT combinations!
73 //first of all, check if the console hide key was pressed
74 if(event == Topmost->HideKey)
85 if(event & KEY_SHIFTED)
87 Topmost->ConsoleScrollBack = Topmost->LineBuffer-1;
88 CON_UpdateConsole(Topmost);
94 if(event & KEY_SHIFTED)
96 Topmost->ConsoleScrollBack = 0;
97 CON_UpdateConsole(Topmost);
103 Topmost->ConsoleScrollBack += CON_LINE_SCROLL;
104 if(Topmost->ConsoleScrollBack > Topmost->LineBuffer-1)
105 Topmost->ConsoleScrollBack = Topmost->LineBuffer-1;
107 CON_UpdateConsole(Topmost);
110 Topmost->ConsoleScrollBack -= CON_LINE_SCROLL;
111 if(Topmost->ConsoleScrollBack < 0)
112 Topmost->ConsoleScrollBack = 0;
113 CON_UpdateConsole(Topmost);
119 Command_Down(Topmost);
122 Cursor_Left(Topmost);
125 Cursor_Right(Topmost);
128 Cursor_BSpace(Topmost);
134 Topmost->InsMode = 1-Topmost->InsMode;
137 CON_TabCompletion(Topmost);
140 if(strlen(Topmost->Command) > 0) {
141 CON_NewLineCommand(Topmost);
143 // copy the input into the past commands strings
144 strcpy(Topmost->CommandLines[0], Topmost->Command);
146 // display the command including the prompt
147 CON_Out(Topmost, "%s%s", Topmost->Prompt, Topmost->Command);
148 CON_UpdateConsole(Topmost);
150 CON_Execute(Topmost, Topmost->Command);
151 //printf("Command: %s\n", Topmost->Command);
153 Clear_Command(Topmost);
154 Topmost->CommandScrollBack = -1;
163 Cursor_Add(Topmost, event);
165 Cursor_Add(Topmost, event);
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) {
182 SDL_PixelFormat *format;
183 static char errorPrinted = 0;
186 /* debugging assertions -- these slow you down, but hey, crashing sucks */
188 PRINT_ERROR("NULL Surface passed to CON_AlphaGL\n");
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;
200 /* loop over alpha channels of each pixel, setting them appropriately. */
204 switch (format->BytesPerPixel) {
206 /* 16-bit surfaces don't seem to support alpha channels. */
209 PRINT_ERROR("16-bit SDL surfaces do not support alpha-blending under OpenGL.\n");
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;
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;
225 for(pixel = pix + 3; pixel < last; pixel += 4)
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) {
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());
240 pixel = DT_GetPixel(s, x, y);
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);
248 /* unlock surface again */
250 SDL_UnlockSurface(s);
258 /* Updates the console buffer */
259 void CON_UpdateConsole(ConsoleInformation *console) {
263 grs_canvas *canv_save;
269 /* Due to the Blits, the update is not very fast: So only update if it's worth it */
270 if(!CON_isVisible(console))
273 Screenlines = console->ConsoleSurface->cv_h / (CON_LINE_SPACE + console->ConsoleSurface->cv_font->ft_h);
275 canv_save = grd_curcanv;
276 gr_set_current_canvas(console->ConsoleSurface);
279 SDL_FillRect(console->ConsoleSurface, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, console->ConsoleAlpha));
285 if(console->OutputScreen->flags & SDL_OPENGLBLIT)
286 SDL_SetAlpha(console->ConsoleSurface, 0, SDL_ALPHA_OPAQUE);
289 /* draw the background image if there is one */
290 if(console->BackgroundImage)
291 gr_bitmap(0, 0, console->BackgroundImage);
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.
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);
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++)
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;
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;
321 gr_set_current_canvas(canv_save);
324 if(console->OutputScreen->flags & SDL_OPENGLBLIT)
325 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
329 void CON_UpdateOffset(ConsoleInformation* console) {
333 switch(console->Visible) {
335 console->RaiseOffset -= CON_OPENCLOSE_SPEED;
336 if(console->RaiseOffset <= 0) {
337 console->RaiseOffset = 0;
338 console->Visible = CON_CLOSED;
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;
354 /* Draws the console buffer to the screen if the console is "visible" */
355 void CON_DrawConsole(ConsoleInformation *console) {
356 grs_canvas *canv_save;
362 /* only draw if console is visible: here this means, that the console is not CON_CLOSED */
363 if(console->Visible == CON_CLOSED)
366 /* Update the scrolling offset */
367 CON_UpdateOffset(console);
369 /* Update the command line since it has a blinking cursor */
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);
379 canv_save = grd_curcanv;
380 gr_set_current_canvas(&console->OutputScreen->sc_canvas);
382 clip = gr_create_sub_bitmap(&console->ConsoleSurface->cv_bitmap, 0, console->ConsoleSurface->cv_h - console->RaiseOffset, console->ConsoleSurface->cv_w, console->RaiseOffset);
384 gr_bitmap(console->DispX, console->DispY, clip);
385 gr_free_sub_bitmap(clip);
388 if(console->OutputScreen->flags & SDL_OPENGLBLIT)
389 SDL_UpdateRects(console->OutputScreen, 1, &DestRect);
392 gr_set_current_canvas(canv_save);
396 /* Initializes the console */
397 ConsoleInformation *CON_Init(grs_font *Font, grs_screen *DisplayScreen, int lines, int x, int y, int w, int h)
400 ConsoleInformation *newinfo;
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");
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;
417 newinfo->ConsoleAlpha = SDL_ALPHA_OPAQUE;
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;
427 CON_SetExecuteFunction(newinfo, Default_CmdFunction);
428 CON_SetTabCompletion(newinfo, Default_TabFunction);
429 CON_SetHideFunction(newinfo, Default_HideFunction);
431 /* make sure that the size of the console is valid */
432 if(w > newinfo->OutputScreen->sc_w || w < Font->ft_w * 32)
433 w = newinfo->OutputScreen->sc_w;
434 if(h > newinfo->OutputScreen->sc_h || h < Font->ft_h)
435 h = newinfo->OutputScreen->sc_h;
436 if(x < 0 || x > newinfo->OutputScreen->sc_w - w)
440 if(y < 0 || y > newinfo->OutputScreen->sc_h - h)
445 /* load the console surface */
446 newinfo->ConsoleSurface = gr_create_canvas(w, h);
448 /* Load the consoles font */
450 grs_canvas *canv_save;
452 canv_save = grd_curcanv;
453 gr_set_current_canvas(newinfo->ConsoleSurface);
454 gr_set_curfont(Font);
455 gr_set_fontcolor(gr_getcolor(63,63,63), -1);
456 gr_set_current_canvas(canv_save);
460 /* Load the dirty rectangle for user input */
461 newinfo->InputBackground = gr_create_bitmap(w, newinfo->ConsoleSurface->cv_font->ft_h);
463 SDL_FillRect(newinfo->InputBackground, NULL, SDL_MapRGBA(newinfo->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
466 /* calculate the number of visible characters in the command line */
467 newinfo->VChars = (w - CON_CHAR_BORDER) / newinfo->ConsoleSurface->cv_font->ft_w;
468 if(newinfo->VChars > CON_CHARS_PER_LINE)
469 newinfo->VChars = CON_CHARS_PER_LINE;
471 /* We would like to have a minumum # of lines to guarentee we don't create a memory error */
472 if(h / (CON_LINE_SPACE + newinfo->ConsoleSurface->cv_font->ft_h) > lines)
473 newinfo->LineBuffer = h / (CON_LINE_SPACE + newinfo->ConsoleSurface->cv_font->ft_h);
475 newinfo->LineBuffer = lines;
478 newinfo->ConsoleLines = (char **)d_malloc(sizeof(char *) * newinfo->LineBuffer);
479 newinfo->CommandLines = (char **)d_malloc(sizeof(char *) * newinfo->LineBuffer);
480 for(loop = 0; loop <= newinfo->LineBuffer - 1; loop++) {
481 newinfo->ConsoleLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
482 newinfo->CommandLines[loop] = (char *)d_calloc(CON_CHARS_PER_LINE, sizeof(char));
484 memset(newinfo->Command, 0, CON_CHARS_PER_LINE);
485 memset(newinfo->LCommand, 0, CON_CHARS_PER_LINE);
486 memset(newinfo->RCommand, 0, CON_CHARS_PER_LINE);
487 memset(newinfo->VCommand, 0, CON_CHARS_PER_LINE);
490 CON_Out(newinfo, "Console initialised.");
491 CON_NewLineConsole(newinfo);
492 //CON_ListCommands(newinfo);
497 /* Makes the console visible */
498 void CON_Show(ConsoleInformation *console) {
500 console->Visible = CON_OPENING;
501 CON_UpdateConsole(console);
505 /* Hides the console (make it invisible) */
506 void CON_Hide(ConsoleInformation *console) {
508 console->Visible = CON_CLOSING;
509 console->HideFunction();
512 /* tells wether the console is visible or not */
513 int CON_isVisible(ConsoleInformation *console) {
516 return((console->Visible == CON_OPEN) || (console->Visible == CON_OPENING));
519 /* Frees all the memory loaded by the console */
520 void CON_Destroy(ConsoleInformation *console) {
524 /* Frees all the memory loaded by the console */
525 void CON_Free(ConsoleInformation *console) {
531 //CON_DestroyCommands();
532 for(i = 0; i <= console->LineBuffer - 1; i++) {
533 d_free(console->ConsoleLines[i]);
534 d_free(console->CommandLines[i]);
536 d_free(console->ConsoleLines);
537 d_free(console->CommandLines);
539 console->ConsoleLines = NULL;
540 console->CommandLines = NULL;
542 gr_free_canvas(console->ConsoleSurface);
543 console->ConsoleSurface = NULL;
545 if (console->BackgroundImage)
546 gr_free_bitmap(console->BackgroundImage);
547 console->BackgroundImage = NULL;
549 gr_free_bitmap(console->InputBackground);
550 console->InputBackground = NULL;
556 /* Increments the console lines */
557 void CON_NewLineConsole(ConsoleInformation *console) {
564 temp = console->ConsoleLines[console->LineBuffer - 1];
566 for(loop = console->LineBuffer - 1; loop > 0; loop--)
567 console->ConsoleLines[loop] = console->ConsoleLines[loop - 1];
569 console->ConsoleLines[0] = temp;
571 memset(console->ConsoleLines[0], 0, CON_CHARS_PER_LINE);
572 if(console->TotalConsoleLines < console->LineBuffer - 1)
573 console->TotalConsoleLines++;
575 //Now adjust the ConsoleScrollBack
576 //dont scroll if not at bottom
577 if(console->ConsoleScrollBack != 0)
578 console->ConsoleScrollBack++;
580 if(console->ConsoleScrollBack > console->LineBuffer-1)
581 console->ConsoleScrollBack = console->LineBuffer-1;
586 /* Increments the command lines */
587 void CON_NewLineCommand(ConsoleInformation *console) {
594 temp = console->CommandLines[console->LineBuffer - 1];
597 for(loop = console->LineBuffer - 1; loop > 0; loop--)
598 console->CommandLines[loop] = console->CommandLines[loop - 1];
600 console->CommandLines[0] = temp;
602 memset(console->CommandLines[0], 0, CON_CHARS_PER_LINE);
603 if(console->TotalCommands < console->LineBuffer - 1)
604 console->TotalCommands++;
607 /* Draws the command line the user is typing in to the screen */
608 /* completely rewritten by C.Wacha */
609 void DrawCommandLine() {
613 grs_font* CurrentFont;
615 static unsigned int LastBlinkTime = 0; /* Last time the consoles cursor blinked */
616 static int LastCursorPos = 0; // Last Cursor Position
617 static int Blink = 0; /* Is the cursor currently blinking */
618 grs_canvas *canv_save;
624 commandbuffer = Topmost->VChars - strlen(Topmost->Prompt)-1; // -1 to make cursor visible
627 CurrentFont = Topmost->ConsoleSurface->cv_font;
630 //Concatenate the left and right side to command
631 strcpy(Topmost->Command, Topmost->LCommand);
632 strncat(Topmost->Command, Topmost->RCommand, strlen(Topmost->RCommand));
634 //calculate display offset from current cursor position
635 if(Topmost->Offset < Topmost->CursorPos - commandbuffer)
636 Topmost->Offset = Topmost->CursorPos - commandbuffer;
637 if(Topmost->Offset > Topmost->CursorPos)
638 Topmost->Offset = Topmost->CursorPos;
640 //first add prompt to visible part
641 strcpy(Topmost->VCommand, Topmost->Prompt);
643 //then add the visible part of the command
644 strncat(Topmost->VCommand, &Topmost->Command[Topmost->Offset], strlen(&Topmost->Command[Topmost->Offset]));
646 //now display the result
649 //once again we're drawing text, so in OpenGL context we need to temporarily set up
650 //software-mode transparency.
651 if(Topmost->OutputScreen->flags & SDL_OPENGLBLIT) {
652 Uint32 *pix = (Uint32 *) (CurrentFont->FontSurface->pixels);
653 SDL_SetColorKey(CurrentFont->FontSurface, SDL_SRCCOLORKEY, *pix);
657 canv_save = grd_curcanv;
658 gr_set_current_canvas(Topmost->ConsoleSurface);
660 //first of all restore InputBackground
661 gr_bitmap(0, Topmost->ConsoleSurface->cv_h - Topmost->ConsoleSurface->cv_font->ft_h, Topmost->InputBackground);
664 orig_color = FG_COLOR;
665 gr_string(CON_CHAR_BORDER, Topmost->ConsoleSurface->cv_h - Topmost->ConsoleSurface->cv_font->ft_h, Topmost->VCommand);
666 FG_COLOR = orig_color;
668 //at last add the cursor
669 //check if the blink period is over
670 if(get_msecs() > LastBlinkTime) {
671 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
678 //check if cursor has moved - if yes display cursor anyway
679 if(Topmost->CursorPos != LastCursorPos) {
680 LastCursorPos = Topmost->CursorPos;
681 LastBlinkTime = get_msecs() + CON_BLINK_RATE;
686 int prompt_width, cmd_width, h, w;
688 gr_get_string_size(Topmost->Prompt, &prompt_width, &h, &w);
689 gr_get_string_size(Topmost->LCommand + Topmost->Offset, &cmd_width, &h, &w);
690 x = CON_CHAR_BORDER + prompt_width + cmd_width;
691 orig_color = FG_COLOR;
693 gr_string(x, Topmost->ConsoleSurface->cv_h - Topmost->ConsoleSurface->cv_font->ft_h, CON_INS_CURSOR);
695 gr_string(x, Topmost->ConsoleSurface->cv_h - Topmost->ConsoleSurface->cv_font->ft_h, CON_OVR_CURSOR);
696 FG_COLOR = orig_color;
699 gr_set_current_canvas(canv_save);
703 if(Topmost->OutputScreen->flags & SDL_OPENGLBLIT) {
704 SDL_SetColorKey(CurrentFont->FontSurface, 0, 0);
710 # define vsnprintf _vsnprintf
713 /* Outputs text to the console (in game), up to CON_CHARS_PER_LINE chars can be entered */
714 void CON_Out(ConsoleInformation *console, const char *str, ...) {
716 //keep some space free for stuff like CON_Out(console, "blablabla %s", console->Command);
717 char temp[CON_CHARS_PER_LINE + 128];
723 va_start(marker, str);
724 vsnprintf(temp, CON_CHARS_PER_LINE + 127, str, marker);
729 //temp now contains the complete string we want to output
730 // the only problem is that temp is maybe longer than the console
731 // width so we have to cut it into several pieces
733 if(console->ConsoleLines) {
734 while(strlen(ptemp) > console->VChars) {
735 CON_NewLineConsole(console);
736 strncpy(console->ConsoleLines[0], ptemp, console->VChars);
737 console->ConsoleLines[0][console->VChars] = '\0';
738 ptemp = &ptemp[console->VChars];
740 CON_NewLineConsole(console);
741 strncpy(console->ConsoleLines[0], ptemp, console->VChars);
742 console->ConsoleLines[0][console->VChars] = '\0';
743 CON_UpdateConsole(console);
746 /* And print to stdout */
747 //printf("%s\n", temp);
752 /* Sets the alpha level of the console, 0 turns off alpha blending */
753 void CON_Alpha(ConsoleInformation *console, unsigned char alpha) {
757 /* store alpha as state! */
758 console->ConsoleAlpha = alpha;
760 if((console->OutputScreen->flags & SDL_OPENGLBLIT) == 0) {
762 SDL_SetAlpha(console->ConsoleSurface, 0, alpha);
764 SDL_SetAlpha(console->ConsoleSurface, SDL_SRCALPHA, alpha);
767 // CON_UpdateConsole(console);
772 /* Adds background image to the console, scaled to size of console*/
773 int CON_Background(ConsoleInformation *console, grs_bitmap *image)
778 /* Free the background from the console */
780 if (console->BackgroundImage)
781 gr_free_bitmap(console->BackgroundImage);
782 console->BackgroundImage = NULL;
784 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
789 /* Load a new background */
790 if (console->BackgroundImage)
791 gr_free_bitmap(console->BackgroundImage);
792 console->BackgroundImage = gr_create_bitmap(console->ConsoleSurface->cv_w, console->ConsoleSurface->cv_h);
793 gr_bitmap_scale_to(image, console->BackgroundImage);
796 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
798 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);
803 /* Sets font info for the console */
804 void CON_Font(ConsoleInformation *console, grs_font *font, int fg, int bg)
806 grs_canvas *canv_save;
808 canv_save = grd_curcanv;
809 gr_set_current_canvas(console->ConsoleSurface);
810 gr_set_curfont(font);
811 gr_set_fontcolor(fg, bg);
812 gr_set_current_canvas(canv_save);
815 /* takes a new x and y of the top left of the console window */
816 void CON_Position(ConsoleInformation *console, int x, int y) {
820 if(x < 0 || x > console->OutputScreen->sc_w - console->ConsoleSurface->cv_w)
825 if(y < 0 || y > console->OutputScreen->sc_h - console->ConsoleSurface->cv_h)
831 void gr_init_bitmap_alloc( grs_bitmap *bm, int mode, int x, int y, int w, int h, int bytesperline);
832 /* resizes the console, has to reset alot of stuff
833 * returns 1 on error */
834 int CON_Resize(ConsoleInformation *console, int x, int y, int w, int h)
839 /* make sure that the size of the console is valid */
840 if(w > console->OutputScreen->sc_w || w < console->ConsoleSurface->cv_font->ft_w * 32)
841 w = console->OutputScreen->sc_w;
842 if(h > console->OutputScreen->sc_h || h < console->ConsoleSurface->cv_font->ft_h)
843 h = console->OutputScreen->sc_h;
844 if(x < 0 || x > console->OutputScreen->sc_w - w)
848 if(y < 0 || y > console->OutputScreen->sc_h - h)
853 /* resize console surface */
854 gr_free_bitmap_data(&console->ConsoleSurface->cv_bitmap);
855 gr_init_bitmap_alloc(&console->ConsoleSurface->cv_bitmap, BM_LINEAR, 0, 0, w, h, w);
857 /* Load the dirty rectangle for user input */
858 gr_free_bitmap(console->InputBackground);
859 console->InputBackground = gr_create_bitmap(w, console->ConsoleSurface->cv_font->ft_h);
861 /* Now reset some stuff dependent on the previous size */
862 console->ConsoleScrollBack = 0;
864 /* Reload the background image (for the input text area) in the console */
865 if(console->BackgroundImage) {
867 SDL_FillRect(console->InputBackground, NULL, SDL_MapRGBA(console->ConsoleSurface->format, 0, 0, 0, SDL_ALPHA_OPAQUE));
869 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);
873 /* restore the alpha level */
874 CON_Alpha(console, console->ConsoleAlpha);
879 /* Transfers the console to another screen surface, and adjusts size */
880 int CON_Transfer(ConsoleInformation *console, grs_screen *new_outputscreen, int x, int y, int w, int h)
885 console->OutputScreen = new_outputscreen;
887 return(CON_Resize(console, x, y, w, h));
890 /* Sets the topmost console for input */
891 void CON_Topmost(ConsoleInformation *console) {
892 grs_canvas *canv_save;
898 // Make sure the blinking cursor is gone
900 canv_save = grd_curcanv;
901 gr_set_current_canvas(Topmost->ConsoleSurface);
903 gr_bitmap(0, Topmost->ConsoleSurface->cv_h - Topmost->ConsoleSurface->cv_font->ft_h, Topmost->InputBackground);
904 orig_color = FG_COLOR;
905 gr_string(CON_CHAR_BORDER, Topmost->ConsoleSurface->cv_h - Topmost->ConsoleSurface->cv_font->ft_h, Topmost->VCommand);
906 FG_COLOR = orig_color;
908 gr_set_current_canvas(canv_save);
913 /* Sets the Prompt for console */
914 void CON_SetPrompt(ConsoleInformation *console, char* newprompt) {
918 //check length so we can still see at least 1 char :-)
919 if(strlen(newprompt) < console->VChars)
920 console->Prompt = d_strdup(newprompt);
922 CON_Out(console, "prompt too long. (max. %i chars)", console->VChars - 1);
925 /* Sets the key that deactivates (hides) the console. */
926 void CON_SetHideKey(ConsoleInformation *console, int key) {
928 console->HideKey = key;
931 void CON_SetHideFunction(ConsoleInformation *console, void(*HideFunction)(void)) {
933 console->HideFunction = HideFunction;
936 void Default_HideFunction(void) {
939 /* Executes the command entered */
940 void CON_Execute(ConsoleInformation *console, char* command) {
942 console->CmdFunction(console, command);
945 void CON_SetExecuteFunction(ConsoleInformation *console, void(*CmdFunction)(ConsoleInformation *console2, char* command)) {
947 console->CmdFunction = CmdFunction;
950 void Default_CmdFunction(ConsoleInformation *console, char* command) {
951 CON_Out(console, " No CommandFunction registered");
952 CON_Out(console, " use 'CON_SetExecuteFunction' to register one");
953 CON_Out(console, " ");
954 CON_Out(console, "Unknown Command \"%s\"", command);
957 void CON_SetTabCompletion(ConsoleInformation *console, char*(*TabFunction)(char* command)) {
959 console->TabFunction = TabFunction;
962 void CON_TabCompletion(ConsoleInformation *console) {
969 command = d_strdup(console->LCommand);
970 command = console->TabFunction(command);
973 return; //no tab completion took place so return silently
976 if(j > CON_CHARS_PER_LINE - 2)
977 j = CON_CHARS_PER_LINE-1;
979 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
980 console->CursorPos = 0;
982 for(i = 0; i < j; i++) {
983 console->CursorPos++;
984 console->LCommand[i] = command[i];
986 //add a trailing space
987 console->CursorPos++;
988 console->LCommand[j] = ' ';
989 console->LCommand[j+1] = '\0';
992 char* Default_TabFunction(char* command) {
993 CON_Out(Topmost, " No TabFunction registered");
994 CON_Out(Topmost, " use 'CON_SetTabCompletion' to register one");
995 CON_Out(Topmost, " ");
999 void Cursor_Left(ConsoleInformation *console) {
1000 char temp[CON_CHARS_PER_LINE];
1002 if(Topmost->CursorPos > 0) {
1003 Topmost->CursorPos--;
1004 strcpy(temp, Topmost->RCommand);
1005 strcpy(Topmost->RCommand, &Topmost->LCommand[strlen(Topmost->LCommand)-1]);
1006 strcat(Topmost->RCommand, temp);
1007 Topmost->LCommand[strlen(Topmost->LCommand)-1] = '\0';
1008 //CON_Out(Topmost, "L:%s, R:%s", Topmost->LCommand, Topmost->RCommand);
1012 void Cursor_Right(ConsoleInformation *console) {
1013 char temp[CON_CHARS_PER_LINE];
1015 if(Topmost->CursorPos < strlen(Topmost->Command)) {
1016 Topmost->CursorPos++;
1017 strncat(Topmost->LCommand, Topmost->RCommand, 1);
1018 strcpy(temp, Topmost->RCommand);
1019 strcpy(Topmost->RCommand, &temp[1]);
1020 //CON_Out(Topmost, "L:%s, R:%s", Topmost->LCommand, Topmost->RCommand);
1024 void Cursor_Home(ConsoleInformation *console) {
1025 char temp[CON_CHARS_PER_LINE];
1027 Topmost->CursorPos = 0;
1028 strcpy(temp, Topmost->RCommand);
1029 strcpy(Topmost->RCommand, Topmost->LCommand);
1030 strncat(Topmost->RCommand, temp, strlen(temp));
1031 memset(Topmost->LCommand, 0, CON_CHARS_PER_LINE);
1034 void Cursor_End(ConsoleInformation *console) {
1035 Topmost->CursorPos = strlen(Topmost->Command);
1036 strncat(Topmost->LCommand, Topmost->RCommand, strlen(Topmost->RCommand));
1037 memset(Topmost->RCommand, 0, CON_CHARS_PER_LINE);
1040 void Cursor_Del(ConsoleInformation *console) {
1041 char temp[CON_CHARS_PER_LINE];
1043 if(strlen(Topmost->RCommand) > 0) {
1044 strcpy(temp, Topmost->RCommand);
1045 strcpy(Topmost->RCommand, &temp[1]);
1049 void Cursor_BSpace(ConsoleInformation *console) {
1050 if(Topmost->CursorPos > 0) {
1051 Topmost->CursorPos--;
1053 if(Topmost->Offset < 0)
1054 Topmost->Offset = 0;
1055 Topmost->LCommand[strlen(Topmost->LCommand)-1] = '\0';
1059 void Cursor_Add(ConsoleInformation *console, int event)
1061 if(strlen(Topmost->Command) < CON_CHARS_PER_LINE - 1)
1063 Topmost->CursorPos++;
1064 Topmost->LCommand[strlen(Topmost->LCommand)] = key_to_ascii(event);
1065 Topmost->LCommand[strlen(Topmost->LCommand)] = '\0';
1069 void Clear_Command(ConsoleInformation *console) {
1070 Topmost->CursorPos = 0;
1071 memset(Topmost->VCommand, 0, CON_CHARS_PER_LINE);
1072 memset(Topmost->Command, 0, CON_CHARS_PER_LINE);
1073 memset(Topmost->LCommand, 0, CON_CHARS_PER_LINE);
1074 memset(Topmost->RCommand, 0, CON_CHARS_PER_LINE);
1077 void Clear_History(ConsoleInformation *console) {
1080 for(loop = 0; loop <= console->LineBuffer - 1; loop++)
1081 memset(console->ConsoleLines[loop], 0, CON_CHARS_PER_LINE);
1084 void Command_Up(ConsoleInformation *console) {
1085 if(console->CommandScrollBack < console->TotalCommands - 1) {
1086 /* move back a line in the command strings and copy the command to the current input string */
1087 console->CommandScrollBack++;
1088 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1089 console->Offset = 0;
1090 strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1091 console->CursorPos = strlen(console->CommandLines[console->CommandScrollBack]);
1092 CON_UpdateConsole(console);
1096 void Command_Down(ConsoleInformation *console) {
1097 if(console->CommandScrollBack > -1) {
1098 /* move forward a line in the command strings and copy the command to the current input string */
1099 console->CommandScrollBack--;
1100 memset(console->RCommand, 0, CON_CHARS_PER_LINE);
1101 memset(console->LCommand, 0, CON_CHARS_PER_LINE);
1102 console->Offset = 0;
1103 if(console->CommandScrollBack > -1)
1104 strcpy(console->LCommand, console->CommandLines[console->CommandScrollBack]);
1105 console->CursorPos = strlen(console->LCommand);
1106 CON_UpdateConsole(console);