1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 // ============================================================================
20 // static font variables
21 // ============================================================================
23 boolean text_drawing_enabled = TRUE;
26 // ============================================================================
28 // ============================================================================
30 void EnableDrawingText(void)
32 text_drawing_enabled = TRUE;
35 void DisableDrawingText(void)
37 text_drawing_enabled = FALSE;
40 void InitFontInfo(struct FontBitmapInfo *font_bitmap_info, int num_fonts,
41 int (*select_font_function)(int),
42 int (*get_font_from_token_function)(char *),
43 char * (*get_token_from_font_function)(int))
45 gfx.num_fonts = num_fonts;
46 gfx.font_bitmap_info = font_bitmap_info;
47 gfx.select_font_function = select_font_function;
48 gfx.get_font_from_token_function = get_font_from_token_function;
49 gfx.get_token_from_font_function = get_token_from_font_function;
52 void FreeFontInfo(struct FontBitmapInfo *font_bitmap_info)
54 if (font_bitmap_info == NULL)
57 free(font_bitmap_info);
60 struct FontBitmapInfo *getFontBitmapInfo(int font_nr)
62 int font_bitmap_id = gfx.select_font_function(font_nr);
64 return &gfx.font_bitmap_info[font_bitmap_id];
67 int getFontWidth(int font_nr)
69 int font_bitmap_id = gfx.select_font_function(font_nr);
71 return gfx.font_bitmap_info[font_bitmap_id].width;
74 int getFontHeight(int font_nr)
76 int font_bitmap_id = gfx.select_font_function(font_nr);
78 return gfx.font_bitmap_info[font_bitmap_id].height;
81 int getFontDrawOffsetX(int font_nr)
83 int font_bitmap_id = gfx.select_font_function(font_nr);
85 return gfx.font_bitmap_info[font_bitmap_id].draw_xoffset;
88 int getFontDrawOffsetY(int font_nr)
90 int font_bitmap_id = gfx.select_font_function(font_nr);
92 return gfx.font_bitmap_info[font_bitmap_id].draw_yoffset;
95 int getTextWidth(char *text, int font_nr)
97 return (text != NULL ? strlen(text) * getFontWidth(font_nr) : 0);
100 static int getFontCharPosition(int font_nr, char c)
102 int font_bitmap_id = gfx.select_font_function(font_nr);
103 struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
104 int font_pos = (unsigned char)c - 32;
106 // map some special characters to their ascii values in default font
107 if (font->num_chars == DEFAULT_NUM_CHARS_PER_FONT)
108 font_pos = MAP_FONT_ASCII(c) - 32;
109 else if (font->num_chars == NUM_CHARS_PER_FONT_EXT)
110 font_pos = MAP_FONT_ASCII_EXT(c) - 32;
112 // this allows dynamic special characters together with special font
113 if (font_pos < 0 || font_pos >= font->num_chars)
119 void getFontCharSource(int font_nr, char c, Bitmap **bitmap, int *x, int *y)
121 int font_bitmap_id = gfx.select_font_function(font_nr);
122 struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
123 int font_pos = getFontCharPosition(font_nr, c);
124 int offset_x = (font->offset_x != 0 ? font->offset_x : font->width);
125 int offset_y = (font->offset_y != 0 ? font->offset_y : font->height);
127 *bitmap = font->bitmap;
128 *x = font->src_x + (font_pos % font->num_chars_per_line) * offset_x;
129 *y = font->src_y + (font_pos / font->num_chars_per_line) * offset_y;
133 // ============================================================================
134 // text string helper functions
135 // ============================================================================
137 int maxWordLengthInRequestString(char *text)
140 int word_len = 0, max_word_len = 0;
142 for (text_ptr = text; *text_ptr; text_ptr++)
144 word_len = (*text_ptr != ' ' &&
146 *text_ptr != '!' ? word_len + 1 : 0);
148 max_word_len = MAX(word_len, max_word_len);
155 // ============================================================================
156 // simple text drawing functions
157 // ============================================================================
159 static void DrawInitTextExt(char *text, int ypos, int font_nr, boolean update)
161 LimitScreenUpdates(TRUE);
165 if (!text_drawing_enabled)
168 if (window != NULL &&
169 gfx.draw_init_text &&
171 gfx.font_bitmap_info[font_nr].bitmap != NULL)
173 int x = (video.width - getTextWidth(text, font_nr)) / 2;
175 int width = video.width;
176 int height = getFontHeight(font_nr);
178 ClearRectangleOnBackground(drawto, 0, y, width, height);
179 DrawTextExt(drawto, x, y, text, font_nr, BLIT_MASKED);
182 BlitBitmap(drawto, window, 0, 0, video.width, video.height, 0, 0);
186 void DrawInitText(char *text, int ypos, int font_nr)
188 DrawInitTextExt(text, ypos, font_nr, FALSE);
191 void DrawInitTextHead(char *text)
193 DrawInitTextExt(text, 120, FC_GREEN, FALSE);
196 void DrawInitTextItem(char *text)
198 DrawInitTextExt(text, 150, FC_YELLOW, TRUE);
201 void DrawTextF(int x, int y, int font_nr, char *format, ...)
203 char buffer[MAX_OUTPUT_LINESIZE + 1];
206 va_start(ap, format);
207 vsprintf(buffer, format, ap);
210 if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
211 Fail("string too long in DrawTextF() -- aborting");
213 DrawText(gfx.sx + x, gfx.sy + y, buffer, font_nr);
216 void DrawTextFCentered(int y, int font_nr, char *format, ...)
218 char buffer[MAX_OUTPUT_LINESIZE + 1];
221 va_start(ap, format);
222 vsprintf(buffer, format, ap);
225 if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
226 Fail("string too long in DrawTextFCentered() -- aborting");
228 DrawText(gfx.sx + (gfx.sxsize - getTextWidth(buffer, font_nr)) / 2,
229 gfx.sy + y, buffer, font_nr);
232 void DrawTextS(int x, int y, int font_nr, char *text)
234 DrawText(gfx.sx + x, gfx.sy + y, text, font_nr);
237 void DrawTextSCentered(int y, int font_nr, char *text)
239 DrawText(gfx.sx + (gfx.sxsize - getTextWidth(text, font_nr)) / 2,
240 gfx.sy + y, text, font_nr);
243 void DrawTextSAligned(int x, int y, char *text, int font_nr, int align)
245 DrawText(gfx.sx + ALIGNED_XPOS(x, getTextWidth(text, font_nr), align),
246 gfx.sy + y, text, font_nr);
249 void DrawText(int x, int y, char *text, int font_nr)
251 int mask_mode = BLIT_OPAQUE;
253 if (DrawingOnBackground(x, y))
254 mask_mode = BLIT_ON_BACKGROUND;
256 DrawTextExt(drawto, x, y, text, font_nr, mask_mode);
258 if (IN_GFX_FIELD_FULL(x, y))
259 redraw_mask |= REDRAW_FIELD;
260 else if (IN_GFX_DOOR_1(x, y))
261 redraw_mask |= REDRAW_DOOR_1;
262 else if (IN_GFX_DOOR_2(x, y))
263 redraw_mask |= REDRAW_DOOR_2;
264 else if (IN_GFX_DOOR_3(x, y))
265 redraw_mask |= REDRAW_DOOR_3;
267 redraw_mask |= REDRAW_ALL;
270 void DrawTextExt(DrawBuffer *dst_bitmap, int dst_x, int dst_y, char *text,
271 int font_nr, int mask_mode)
273 struct FontBitmapInfo *font = getFontBitmapInfo(font_nr);
274 int font_width = getFontWidth(font_nr);
275 int font_height = getFontHeight(font_nr);
278 char *text_ptr = text;
280 if (!text_drawing_enabled)
284 Debug("font:token", "'%s' / '%s'",
285 gfx.get_token_from_font_function(font_nr), text);
288 if (font->bitmap == NULL)
291 // skip text to be printed outside the window (left/right will be clipped)
292 if (dst_y < 0 || dst_y + font_height > video.height)
295 // add offset for drawing font characters
296 dst_x += font->draw_xoffset;
297 dst_y += font->draw_yoffset;
301 char c = *text_ptr++;
304 c = ' '; // print space instead of newline
306 getFontCharSource(font_nr, c, &src_bitmap, &src_x, &src_y);
308 // clip text at the left side of the window
316 // clip text at the right side of the window
317 if (dst_x + font_width > video.width)
320 if (mask_mode == BLIT_INVERSE) // special mode for text gadgets
322 // first step: draw solid colored rectangle (use "cursor" character)
323 if (strlen(text) == 1) // only one char inverted => draw cursor
325 Bitmap *cursor_bitmap;
326 int cursor_x, cursor_y;
328 getFontCharSource(font_nr, FONT_ASCII_CURSOR, &cursor_bitmap,
329 &cursor_x, &cursor_y);
331 BlitBitmap(cursor_bitmap, dst_bitmap, cursor_x, cursor_y,
332 font_width, font_height, dst_x, dst_y);
335 // second step: draw masked inverted character
336 SDLCopyInverseMasked(src_bitmap, dst_bitmap, src_x, src_y,
337 font_width, font_height, dst_x, dst_y);
339 else if (mask_mode == BLIT_MASKED || mask_mode == BLIT_ON_BACKGROUND)
341 if (mask_mode == BLIT_ON_BACKGROUND)
343 // clear font character background
344 ClearRectangleOnBackground(dst_bitmap, dst_x, dst_y,
345 font_width, font_height);
348 BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y,
349 font_width, font_height, dst_x, dst_y);
351 else // normal, non-masked font blitting
353 BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y,
354 font_width, font_height, dst_x, dst_y);
362 // ============================================================================
363 // text buffer drawing functions
364 // ============================================================================
366 #define MAX_LINES_FROM_FILE 1024
368 char *GetTextBufferFromFile(char *filename, int max_lines)
374 if (filename == NULL)
377 if (!(file = openFile(filename, MODE_READ)))
380 buffer = checked_calloc(1); // start with valid, but empty text buffer
382 while (!checkEndOfFile(file) && num_lines < max_lines)
384 char line[MAX_LINE_LEN];
388 // read next line of input file
389 if (!getStringFromFile(file, line, MAX_LINE_LEN))
392 line_len = strlen(line);
394 // cut trailing line break (this can be newline and/or carriage return)
395 for (line_ptr = &line[line_len]; line_ptr >= line; line_ptr--)
396 if ((*line_ptr == '\n' || *line_ptr == '\r') && *(line_ptr + 1) == '\0')
399 // re-add newline (so the result is terminated by newline, but not CR/LF)
400 if (strlen(line) != line_len)
403 buffer = checked_realloc(buffer, strlen(buffer) + strlen(line) + 1);
405 strcat(buffer, line);
412 if (getTextEncoding(buffer) == TEXT_ENCODING_UTF_8)
414 char *body_latin1 = getLatin1FromUTF8(buffer);
416 checked_free(buffer);
418 buffer = body_latin1;
424 static boolean RenderLineToBuffer(char **src_buffer_ptr, char *dst_buffer,
425 int *dst_buffer_len, int line_length,
426 boolean last_line_was_empty)
428 char *text_ptr = *src_buffer_ptr;
429 char *buffer = dst_buffer;
430 int buffer_len = *dst_buffer_len;
431 boolean buffer_filled = FALSE;
438 if (strEqual(text_ptr, " ")) // special case: force line break
439 buffer_filled = TRUE;
441 // skip leading whitespaces
442 while (*text_ptr == ' ' || *text_ptr == '\t')
448 // look for end of next word
449 while (*word_ptr != ' ' && *word_ptr != '\t' && *word_ptr != '\0')
459 else if (*text_ptr == '\n') // special case: force empty line
464 // prevent printing of multiple empty lines
465 if (buffer_len > 0 || !last_line_was_empty)
466 buffer_filled = TRUE;
468 else if (word_len < line_length - buffer_len)
470 // word fits into text buffer -- add word
473 buffer[buffer_len++] = ' ';
475 strncpy(&buffer[buffer_len], text_ptr, word_len);
476 buffer_len += word_len;
477 buffer[buffer_len] = '\0';
478 text_ptr += word_len;
480 else if (buffer_len > 0)
482 // not enough space left for word in text buffer -- print buffer
484 buffer_filled = TRUE;
488 // word does not fit at all into empty text buffer -- cut word
490 strncpy(buffer, text_ptr, line_length);
491 buffer[line_length] = '\0';
492 text_ptr += line_length;
493 buffer_filled = TRUE;
500 *src_buffer_ptr = text_ptr;
501 *dst_buffer_len = buffer_len;
503 return buffer_filled;
506 static boolean getCheckedTokenValueFromString(char *string, char **token,
511 if (!getTokenValueFromString(string, token, value))
514 if (**token != '.') // token should begin with dot
517 for (ptr = *token; *ptr; ptr++) // token should contain no whitespace
518 if (*ptr == ' ' || *ptr == '\t')
521 for (ptr = *value; *ptr; ptr++) // value should contain no whitespace
522 if (*ptr == ' ' || *ptr == '\t')
528 static void DrawTextBuffer_Flush(int x, int y, char *buffer, int base_font_nr,
529 int font_nr, int line_length, int cut_length,
530 int mask_mode, boolean centered,
533 int buffer_len = strlen(buffer);
534 int base_font_width = getFontWidth(base_font_nr);
535 int font_width = getFontWidth(font_nr);
536 int offset_chars = (centered ? (line_length - buffer_len) / 2 : 0);
537 int line_width = base_font_width * line_length;
538 int buffer_width = font_width * buffer_len;
539 int offset_xsize = (centered ? (line_width - buffer_width) / 2 : 0);
540 int final_cut_length = MAX(0, cut_length - offset_chars);
541 int xx = x + offset_xsize;
542 int yy = y + current_ypos;
544 buffer[final_cut_length] = '\0';
547 DrawTextExt(drawto, xx, yy, buffer, font_nr, mask_mode);
549 DrawText(xx, yy, buffer, font_nr);
552 static int DrawTextBufferExt(int x, int y, char *text_buffer, int base_font_nr,
553 int line_length, int cut_length, int max_lines,
554 int line_spacing, int mask_mode, boolean autowrap,
555 boolean centered, boolean parse_comments,
556 boolean is_text_area)
558 char buffer[line_length + 1];
560 int font_nr = base_font_nr;
561 int font_height = getFontHeight(font_nr);
562 int line_height = font_height + line_spacing;
563 int current_line = 0;
564 int current_ypos = 0;
565 int max_ysize = max_lines * line_height;
567 if (text_buffer == NULL || *text_buffer == '\0')
570 if (current_line >= max_lines)
573 if (cut_length == -1)
574 cut_length = line_length;
579 while (*text_buffer && current_ypos < max_ysize)
581 char line[MAX_LINE_LEN + 1];
583 boolean last_line_was_empty = TRUE;
584 int num_line_chars = MAX_LINE_LEN;
587 // copy next line from text buffer to line buffer (nearly fgets() style)
588 for (i = 0; i < num_line_chars && *text_buffer; i++)
590 if ((line[i] = *text_buffer++) == '\n')
592 // in text areas, 'line_length' sized lines cause additional empty line
593 if (i == line_length && is_text_area)
601 // prevent 'num_line_chars' sized lines to cause additional empty line
602 if (i == num_line_chars && *text_buffer == '\n')
605 // skip comments (lines directly beginning with '#')
606 if (line[0] == '#' && parse_comments)
610 // try to read generic token/value pair definition after comment sign
611 if (getCheckedTokenValueFromString(line + 1, &token, &value))
613 // if found, flush the current buffer, if non-empty
614 if (buffer_len > 0 && current_ypos < max_ysize)
616 DrawTextBuffer_Flush(x, y, buffer, base_font_nr, font_nr, line_length,
617 cut_length, mask_mode, centered, current_ypos);
618 current_ypos += line_height;
625 if (strEqual(token, ".font"))
626 font_nr = gfx.get_font_from_token_function(value);
627 else if (strEqual(token, ".autowrap"))
628 autowrap = get_boolean_from_string(value);
629 else if (strEqual(token, ".centered"))
630 centered = get_boolean_from_string(value);
631 else if (strEqual(token, ".parse_comments"))
632 parse_comments = get_boolean_from_string(value);
634 // if font has changed, depending values need to be updated as well
635 font_height = getFontHeight(font_nr);
636 line_height = font_height + line_spacing;
642 // cut trailing newline and carriage return from input line
643 for (line_ptr = line; *line_ptr; line_ptr++)
645 if (*line_ptr == '\n' || *line_ptr == '\r')
652 if (strlen(line) == 0) // special case: force empty line
657 while (*line_ptr && current_ypos < max_ysize)
659 boolean buffer_filled;
663 buffer_filled = RenderLineToBuffer(&line_ptr, buffer, &buffer_len,
664 line_length, last_line_was_empty);
668 if (strlen(line_ptr) <= line_length)
670 buffer_len = strlen(line_ptr);
671 strcpy(buffer, line_ptr);
675 buffer_len = line_length;
676 strncpy(buffer, line_ptr, line_length);
679 buffer[buffer_len] = '\0';
680 line_ptr += buffer_len;
682 buffer_filled = TRUE;
687 DrawTextBuffer_Flush(x, y, buffer, base_font_nr, font_nr, line_length,
688 cut_length, mask_mode, centered, current_ypos);
689 current_ypos += line_height;
692 last_line_was_empty = (buffer_len == 0);
700 if (buffer_len > 0 && current_ypos < max_ysize)
702 DrawTextBuffer_Flush(x, y, buffer, base_font_nr, font_nr, line_length,
703 cut_length, mask_mode, centered, current_ypos);
704 current_ypos += line_height;
711 int DrawTextArea(int x, int y, char *text_buffer, int font_nr,
712 int line_length, int cut_length, int max_lines,
713 int line_spacing, int mask_mode, boolean autowrap,
714 boolean centered, boolean parse_comments)
716 return DrawTextBufferExt(x, y, text_buffer, font_nr,
717 line_length, cut_length, max_lines,
718 line_spacing, mask_mode, autowrap,
719 centered, parse_comments, TRUE);
722 int DrawTextBuffer(int x, int y, char *text_buffer, int font_nr,
723 int line_length, int cut_length, int max_lines,
724 int line_spacing, int mask_mode, boolean autowrap,
725 boolean centered, boolean parse_comments)
727 return DrawTextBufferExt(x, y, text_buffer, font_nr,
728 line_length, cut_length, max_lines,
729 line_spacing, mask_mode, autowrap,
730 centered, parse_comments, FALSE);
733 int DrawTextBufferS(int x, int y, char *text_buffer, int font_nr,
734 int line_length, int cut_length, int max_lines,
735 int line_spacing, int mask_mode, boolean autowrap,
736 boolean centered, boolean parse_comments)
738 return DrawTextBuffer(gfx.sx + x, gfx.sy + y, text_buffer, font_nr,
739 line_length, cut_length, max_lines,
740 line_spacing, mask_mode, autowrap,
741 centered, parse_comments);
744 int DrawTextBufferVA(int x, int y, char *format, va_list ap, int font_nr,
745 int line_length, int cut_length, int max_lines,
746 int line_spacing, int mask_mode, boolean autowrap,
747 boolean centered, boolean parse_comments)
749 char text_buffer[MAX_OUTPUT_LINESIZE];
750 int text_length = vsnprintf(text_buffer, MAX_OUTPUT_LINESIZE, format, ap);
752 if (text_length >= MAX_OUTPUT_LINESIZE)
753 Warn("string too long in DrawTextBufferVA() -- truncated");
755 int num_lines_printed = DrawTextBuffer(x, y, text_buffer, font_nr,
756 line_length, cut_length, max_lines,
757 line_spacing, mask_mode, autowrap,
758 centered, parse_comments);
759 return num_lines_printed;
762 int DrawTextFile(int x, int y, char *filename, int font_nr,
763 int line_length, int cut_length, int max_lines,
764 int line_spacing, int mask_mode, boolean autowrap,
765 boolean centered, boolean parse_comments)
767 char *text_buffer = GetTextBufferFromFile(filename, MAX_LINES_FROM_FILE);
768 int num_lines_printed = DrawTextBuffer(x, y, text_buffer, font_nr,
769 line_length, cut_length, max_lines,
770 line_spacing, mask_mode, autowrap,
771 centered, parse_comments);
772 checked_free(text_buffer);
774 return num_lines_printed;