src/libgame/text.c

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  https://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // text.c
  10 // ============================================================================
  11
  12 #include <stdio.h>
  13 #include <stdarg.h>
  14
  15 #include "text.h"
  16 #include "misc.h"
  17
  18
  19 // ============================================================================
  20 // font functions
  21 // ============================================================================
  22
  23 void InitFontInfo(struct FontBitmapInfo *font_bitmap_info, int num_fonts,
  24                   int (*select_font_function)(int),
  25                   int (*get_font_from_token_function)(char *))
  26 {
  27   gfx.num_fonts = num_fonts;
  28   gfx.font_bitmap_info = font_bitmap_info;
  29   gfx.select_font_function = select_font_function;
  30   gfx.get_font_from_token_function = get_font_from_token_function;
  31 }
  32
  33 void FreeFontInfo(struct FontBitmapInfo *font_bitmap_info)
  34 {
  35   if (font_bitmap_info == NULL)
  36     return;
  37
  38   free(font_bitmap_info);
  39 }
  40
  41 struct FontBitmapInfo *getFontBitmapInfo(int font_nr)
  42 {
  43   int font_bitmap_id = gfx.select_font_function(font_nr);
  44
  45   return &gfx.font_bitmap_info[font_bitmap_id];
  46 }
  47
  48 int getFontWidth(int font_nr)
  49 {
  50   int font_bitmap_id = gfx.select_font_function(font_nr);
  51
  52   return gfx.font_bitmap_info[font_bitmap_id].width;
  53 }
  54
  55 int getFontHeight(int font_nr)
  56 {
  57   int font_bitmap_id = gfx.select_font_function(font_nr);
  58
  59   return gfx.font_bitmap_info[font_bitmap_id].height;
  60 }
  61
  62 int getFontDrawOffsetX(int font_nr)
  63 {
  64   int font_bitmap_id = gfx.select_font_function(font_nr);
  65
  66   return gfx.font_bitmap_info[font_bitmap_id].draw_xoffset;
  67 }
  68
  69 int getFontDrawOffsetY(int font_nr)
  70 {
  71   int font_bitmap_id = gfx.select_font_function(font_nr);
  72
  73   return gfx.font_bitmap_info[font_bitmap_id].draw_yoffset;
  74 }
  75
  76 int getTextWidth(char *text, int font_nr)
  77 {
  78   return (text != NULL ? strlen(text) * getFontWidth(font_nr) : 0);
  79 }
  80
  81 static int getFontCharPosition(int font_nr, char c)
  82 {
  83   int font_bitmap_id = gfx.select_font_function(font_nr);
  84   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
  85   boolean default_font = (font->num_chars == DEFAULT_NUM_CHARS_PER_FONT);
  86   int font_pos = (unsigned char)c - 32;
  87
  88   // map some special characters to their ascii values in default font
  89   if (default_font)
  90     font_pos = MAP_FONT_ASCII(c) - 32;
  91
  92   // this allows dynamic special characters together with special font
  93   if (font_pos < 0 || font_pos >= font->num_chars)
  94     font_pos = 0;
  95
  96   return font_pos;
  97 }
  98
  99 void getFontCharSource(int font_nr, char c, Bitmap **bitmap, int *x, int *y)
 100 {
 101   int font_bitmap_id = gfx.select_font_function(font_nr);
 102   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 103   int font_pos = getFontCharPosition(font_nr, c);
 104   int offset_x = (font->offset_x != 0 ? font->offset_x : font->width);
 105   int offset_y = (font->offset_y != 0 ? font->offset_y : font->height);
 106
 107   *bitmap = font->bitmap;
 108   *x = font->src_x + (font_pos % font->num_chars_per_line) * offset_x;
 109   *y = font->src_y + (font_pos / font->num_chars_per_line) * offset_y;
 110 }
 111
 112
 113 // ============================================================================
 114 // text string helper functions
 115 // ============================================================================
 116
 117 int maxWordLengthInRequestString(char *text)
 118 {
 119   char *text_ptr;
 120   int word_len = 0, max_word_len = 0;
 121
 122   for (text_ptr = text; *text_ptr; text_ptr++)
 123   {
 124     word_len = (*text_ptr != ' ' &&
 125                 *text_ptr != '?' &&
 126                 *text_ptr != '!' ? word_len + 1 : 0);
 127
 128     max_word_len = MAX(word_len, max_word_len);
 129   }
 130
 131   return max_word_len;
 132 }
 133
 134
 135 // ============================================================================
 136 // simple text drawing functions
 137 // ============================================================================
 138
 139 void DrawInitText(char *text, int ypos, int font_nr)
 140 {
 141   LimitScreenUpdates(TRUE);
 142
 143   UPDATE_BUSY_STATE();
 144
 145   if (window != NULL &&
 146       gfx.draw_init_text &&
 147       gfx.num_fonts > 0 &&
 148       gfx.font_bitmap_info[font_nr].bitmap != NULL)
 149   {
 150     int x = (video.width - getTextWidth(text, font_nr)) / 2;
 151     int y = ypos;
 152     int width = video.width;
 153     int height = getFontHeight(font_nr);
 154
 155     ClearRectangle(drawto, 0, y, width, height);
 156     DrawTextExt(drawto, x, y, text, font_nr, BLIT_OPAQUE);
 157
 158     BlitBitmap(drawto, window, 0, 0, video.width, video.height, 0, 0);
 159   }
 160 }
 161
 162 void DrawInitTextHead(char *text)
 163 {
 164   DrawInitText(text, 120, FC_GREEN);
 165 }
 166
 167 void DrawInitTextItem(char *text)
 168 {
 169   DrawInitText(text, 150, FC_YELLOW);
 170 }
 171
 172 void DrawTextF(int x, int y, int font_nr, char *format, ...)
 173 {
 174   char buffer[MAX_OUTPUT_LINESIZE + 1];
 175   va_list ap;
 176
 177   va_start(ap, format);
 178   vsprintf(buffer, format, ap);
 179   va_end(ap);
 180
 181   if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
 182     Fail("string too long in DrawTextF() -- aborting");
 183
 184   DrawText(gfx.sx + x, gfx.sy + y, buffer, font_nr);
 185 }
 186
 187 void DrawTextFCentered(int y, int font_nr, char *format, ...)
 188 {
 189   char buffer[MAX_OUTPUT_LINESIZE + 1];
 190   va_list ap;
 191
 192   va_start(ap, format);
 193   vsprintf(buffer, format, ap);
 194   va_end(ap);
 195
 196   if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
 197     Fail("string too long in DrawTextFCentered() -- aborting");
 198
 199   DrawText(gfx.sx + (gfx.sxsize - getTextWidth(buffer, font_nr)) / 2,
 200            gfx.sy + y, buffer, font_nr);
 201 }
 202
 203 void DrawTextS(int x, int y, int font_nr, char *text)
 204 {
 205   DrawText(gfx.sx + x, gfx.sy + y, text, font_nr);
 206 }
 207
 208 void DrawTextSCentered(int y, int font_nr, char *text)
 209 {
 210   DrawText(gfx.sx + (gfx.sxsize - getTextWidth(text, font_nr)) / 2,
 211            gfx.sy + y, text, font_nr);
 212 }
 213
 214 void DrawTextSAligned(int x, int y, char *text, int font_nr, int align)
 215 {
 216   DrawText(gfx.sx + ALIGNED_XPOS(x, getTextWidth(text, font_nr), align),
 217            gfx.sy + y, text, font_nr);
 218 }
 219
 220 void DrawTextAligned(int x, int y, char *text, int font_nr, int align)
 221 {
 222   DrawText(ALIGNED_XPOS(x, getTextWidth(text, font_nr), align),
 223            y, text, font_nr);
 224 }
 225
 226 void DrawText(int x, int y, char *text, int font_nr)
 227 {
 228   int mask_mode = BLIT_OPAQUE;
 229
 230   if (DrawingOnBackground(x, y))
 231     mask_mode = BLIT_ON_BACKGROUND;
 232
 233   DrawTextExt(drawto, x, y, text, font_nr, mask_mode);
 234
 235   if (IN_GFX_FIELD_FULL(x, y))
 236     redraw_mask |= REDRAW_FIELD;
 237   else if (IN_GFX_DOOR_1(x, y))
 238     redraw_mask |= REDRAW_DOOR_1;
 239   else if (IN_GFX_DOOR_2(x, y))
 240     redraw_mask |= REDRAW_DOOR_2;
 241   else if (IN_GFX_DOOR_3(x, y))
 242     redraw_mask |= REDRAW_DOOR_3;
 243   else
 244     redraw_mask |= REDRAW_ALL;
 245 }
 246
 247 void DrawTextExt(DrawBuffer *dst_bitmap, int dst_x, int dst_y, char *text,
 248                  int font_nr, int mask_mode)
 249 {
 250   struct FontBitmapInfo *font = getFontBitmapInfo(font_nr);
 251   int font_width = getFontWidth(font_nr);
 252   int font_height = getFontHeight(font_nr);
 253   Bitmap *src_bitmap;
 254   int src_x, src_y;
 255   char *text_ptr = text;
 256
 257   if (font->bitmap == NULL)
 258     return;
 259
 260   // skip text to be printed outside the window (left/right will be clipped)
 261   if (dst_y < 0 || dst_y + font_height > video.height)
 262     return;
 263
 264   // add offset for drawing font characters
 265   dst_x += font->draw_xoffset;
 266   dst_y += font->draw_yoffset;
 267
 268   while (*text_ptr)
 269   {
 270     char c = *text_ptr++;
 271
 272     if (c == '\n')
 273       c = ' ';          // print space instead of newline
 274
 275     getFontCharSource(font_nr, c, &src_bitmap, &src_x, &src_y);
 276
 277     // clip text at the left side of the window
 278     if (dst_x < 0)
 279     {
 280       dst_x += font_width;
 281
 282       continue;
 283     }
 284
 285     // clip text at the right side of the window
 286     if (dst_x + font_width > video.width)
 287       break;
 288
 289     if (mask_mode == BLIT_INVERSE)      // special mode for text gadgets
 290     {
 291       // first step: draw solid colored rectangle (use "cursor" character)
 292       if (strlen(text) == 1)    // only one char inverted => draw cursor
 293       {
 294         Bitmap *cursor_bitmap;
 295         int cursor_x, cursor_y;
 296
 297         getFontCharSource(font_nr, FONT_ASCII_CURSOR, &cursor_bitmap,
 298                           &cursor_x, &cursor_y);
 299
 300         BlitBitmap(cursor_bitmap, dst_bitmap, cursor_x, cursor_y,
 301                    font_width, font_height, dst_x, dst_y);
 302       }
 303
 304       // second step: draw masked inverted character
 305       SDLCopyInverseMasked(src_bitmap, dst_bitmap, src_x, src_y,
 306                            font_width, font_height, dst_x, dst_y);
 307     }
 308     else if (mask_mode == BLIT_MASKED || mask_mode == BLIT_ON_BACKGROUND)
 309     {
 310       if (mask_mode == BLIT_ON_BACKGROUND)
 311       {
 312         // clear font character background
 313         ClearRectangleOnBackground(dst_bitmap, dst_x, dst_y,
 314                                    font_width, font_height);
 315       }
 316
 317       BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y,
 318                        font_width, font_height, dst_x, dst_y);
 319     }
 320     else        // normal, non-masked font blitting
 321     {
 322       BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y,
 323                  font_width, font_height, dst_x, dst_y);
 324     }
 325
 326     dst_x += font_width;
 327   }
 328 }
 329
 330
 331 // ============================================================================
 332 // text buffer drawing functions
 333 // ============================================================================
 334
 335 #define MAX_LINES_FROM_FILE             1024
 336
 337 char *GetTextBufferFromFile(char *filename, int max_lines)
 338 {
 339   File *file;
 340   char *buffer;
 341   int num_lines = 0;
 342
 343   if (filename == NULL)
 344     return NULL;
 345
 346   if (!(file = openFile(filename, MODE_READ)))
 347     return NULL;
 348
 349   buffer = checked_calloc(1);   // start with valid, but empty text buffer
 350
 351   while (!checkEndOfFile(file) && num_lines < max_lines)
 352   {
 353     char line[MAX_LINE_LEN];
 354
 355     // read next line of input file
 356     if (!getStringFromFile(file, line, MAX_LINE_LEN))
 357       break;
 358
 359     buffer = checked_realloc(buffer, strlen(buffer) + strlen(line) + 1);
 360
 361     strcat(buffer, line);
 362
 363     num_lines++;
 364   }
 365
 366   closeFile(file);
 367
 368   return buffer;
 369 }
 370
 371 static boolean RenderLineToBuffer(char **src_buffer_ptr, char *dst_buffer,
 372                                   int *dst_buffer_len, int line_length,
 373                                   boolean last_line_was_empty)
 374 {
 375   char *text_ptr = *src_buffer_ptr;
 376   char *buffer = dst_buffer;
 377   int buffer_len = *dst_buffer_len;
 378   boolean buffer_filled = FALSE;
 379
 380   while (*text_ptr)
 381   {
 382     char *word_ptr;
 383     int word_len;
 384
 385     // skip leading whitespaces
 386     while (*text_ptr == ' ' || *text_ptr == '\t')
 387       text_ptr++;
 388
 389     word_ptr = text_ptr;
 390     word_len = 0;
 391
 392     // look for end of next word
 393     while (*word_ptr != ' ' && *word_ptr != '\t' && *word_ptr != '\0')
 394     {
 395       word_ptr++;
 396       word_len++;
 397     }
 398
 399     if (word_len == 0)
 400     {
 401       continue;
 402     }
 403     else if (*text_ptr == '\n')         // special case: force empty line
 404     {
 405       if (buffer_len == 0)
 406         text_ptr++;
 407
 408       // prevent printing of multiple empty lines
 409       if (buffer_len > 0 || !last_line_was_empty)
 410         buffer_filled = TRUE;
 411     }
 412     else if (word_len < line_length - buffer_len)
 413     {
 414       // word fits into text buffer -- add word
 415
 416       if (buffer_len > 0)
 417         buffer[buffer_len++] = ' ';
 418
 419       strncpy(&buffer[buffer_len], text_ptr, word_len);
 420       buffer_len += word_len;
 421       buffer[buffer_len] = '\0';
 422       text_ptr += word_len;
 423     }
 424     else if (buffer_len > 0)
 425     {
 426       // not enough space left for word in text buffer -- print buffer
 427
 428       buffer_filled = TRUE;
 429     }
 430     else
 431     {
 432       // word does not fit at all into empty text buffer -- cut word
 433
 434       strncpy(buffer, text_ptr, line_length);
 435       buffer[line_length] = '\0';
 436       text_ptr += line_length;
 437       buffer_filled = TRUE;
 438     }
 439
 440     if (buffer_filled)
 441       break;
 442   }
 443
 444   *src_buffer_ptr = text_ptr;
 445   *dst_buffer_len = buffer_len;
 446
 447   return buffer_filled;
 448 }
 449
 450 static boolean getCheckedTokenValueFromString(char *string, char **token,
 451                                               char **value)
 452 {
 453   char *ptr;
 454
 455   if (!getTokenValueFromString(string, token, value))
 456     return FALSE;
 457
 458   if (**token != '.')                   // token should begin with dot
 459     return FALSE;
 460
 461   for (ptr = *token; *ptr; ptr++)       // token should contain no whitespace
 462     if (*ptr == ' ' || *ptr == '\t')
 463       return FALSE;
 464
 465   for (ptr = *value; *ptr; ptr++)       // value should contain no whitespace
 466     if (*ptr == ' ' || *ptr == '\t')
 467       return FALSE;
 468
 469   return TRUE;
 470 }
 471
 472 static void DrawTextBuffer_Flush(int x, int y, char *buffer, int font_nr,
 473                                  int line_length, int cut_length,
 474                                  int mask_mode, boolean centered,
 475                                  int current_ypos)
 476 {
 477   int buffer_len = strlen(buffer);
 478   int font_width = getFontWidth(font_nr);
 479   int offset_chars = (centered ? (line_length - buffer_len) / 2 : 0);
 480   int offset_xsize =
 481     (centered ? font_width * (line_length - buffer_len) / 2 : 0);
 482   int final_cut_length = MAX(0, cut_length - offset_chars);
 483   int xx = x + offset_xsize;
 484   int yy = y + current_ypos;
 485
 486   buffer[final_cut_length] = '\0';
 487
 488   if (mask_mode != -1)
 489     DrawTextExt(drawto, xx, yy, buffer, font_nr, mask_mode);
 490   else
 491     DrawText(xx, yy, buffer, font_nr);
 492 }
 493
 494 int DrawTextBuffer(int x, int y, char *text_buffer, int font_nr,
 495                    int line_length, int cut_length, int max_lines,
 496                    int line_spacing, int mask_mode, boolean autowrap,
 497                    boolean centered, boolean parse_comments)
 498 {
 499   char buffer[line_length + 1];
 500   int buffer_len;
 501   int font_height = getFontHeight(font_nr);
 502   int line_height = font_height + line_spacing;
 503   int current_line = 0;
 504   int current_ypos = 0;
 505   int max_ysize = max_lines * line_height;
 506
 507   if (text_buffer == NULL || *text_buffer == '\0')
 508     return 0;
 509
 510   if (current_line >= max_lines)
 511     return 0;
 512
 513   if (cut_length == -1)
 514     cut_length = line_length;
 515
 516   buffer[0] = '\0';
 517   buffer_len = 0;
 518
 519   while (*text_buffer && current_ypos < max_ysize)
 520   {
 521     char line[MAX_LINE_LEN + 1];
 522     char *line_ptr;
 523     boolean last_line_was_empty = TRUE;
 524     int num_line_chars = MAX_LINE_LEN;
 525     int i;
 526
 527     // copy next line from text buffer to line buffer (nearly fgets() style)
 528     for (i = 0; i < num_line_chars && *text_buffer; i++)
 529       if ((line[i] = *text_buffer++) == '\n')
 530         break;
 531     line[i] = '\0';
 532
 533     // prevent 'num_line_chars' sized lines to cause additional empty line
 534     if (i == num_line_chars && *text_buffer == '\n')
 535       text_buffer++;
 536
 537     // skip comments (lines directly beginning with '#')
 538     if (line[0] == '#' && parse_comments)
 539     {
 540       char *token, *value;
 541
 542       // try to read generic token/value pair definition after comment sign
 543       if (getCheckedTokenValueFromString(line + 1, &token, &value))
 544       {
 545         // if found, flush the current buffer, if non-empty
 546         if (buffer_len > 0 && current_ypos < max_ysize)
 547         {
 548           DrawTextBuffer_Flush(x, y, buffer, font_nr, line_length, cut_length,
 549                                mask_mode, centered, current_ypos);
 550           current_ypos += line_height;
 551           current_line++;
 552
 553           buffer[0] = '\0';
 554           buffer_len = 0;
 555         }
 556
 557         if (strEqual(token, ".font"))
 558           font_nr = gfx.get_font_from_token_function(value);
 559         else if (strEqual(token, ".autowrap"))
 560           autowrap = get_boolean_from_string(value);
 561         else if (strEqual(token, ".centered"))
 562           centered = get_boolean_from_string(value);
 563         else if (strEqual(token, ".parse_comments"))
 564           parse_comments = get_boolean_from_string(value);
 565
 566         // if font has changed, depending values need to be updated as well
 567         font_height = getFontHeight(font_nr);
 568         line_height = font_height + line_spacing;
 569       }
 570
 571       continue;
 572     }
 573
 574     // cut trailing newline and carriage return from input line
 575     for (line_ptr = line; *line_ptr; line_ptr++)
 576     {
 577       if (*line_ptr == '\n' || *line_ptr == '\r')
 578       {
 579         *line_ptr = '\0';
 580         break;
 581       }
 582     }
 583
 584     if (strlen(line) == 0)              // special case: force empty line
 585       strcpy(line, "\n");
 586
 587     line_ptr = line;
 588
 589     while (*line_ptr && current_ypos < max_ysize)
 590     {
 591       boolean buffer_filled;
 592
 593       if (autowrap)
 594       {
 595         buffer_filled = RenderLineToBuffer(&line_ptr, buffer, &buffer_len,
 596                                            line_length, last_line_was_empty);
 597       }
 598       else
 599       {
 600         if (strlen(line_ptr) <= line_length)
 601         {
 602           buffer_len = strlen(line_ptr);
 603           strcpy(buffer, line_ptr);
 604         }
 605         else
 606         {
 607           buffer_len = line_length;
 608           strncpy(buffer, line_ptr, line_length);
 609         }
 610
 611         buffer[buffer_len] = '\0';
 612         line_ptr += buffer_len;
 613
 614         buffer_filled = TRUE;
 615       }
 616
 617       if (buffer_filled)
 618       {
 619         DrawTextBuffer_Flush(x, y, buffer, font_nr, line_length, cut_length,
 620                              mask_mode, centered, current_ypos);
 621         current_ypos += line_height;
 622         current_line++;
 623
 624         last_line_was_empty = (buffer_len == 0);
 625
 626         buffer[0] = '\0';
 627         buffer_len = 0;
 628       }
 629     }
 630   }
 631
 632   if (buffer_len > 0 && current_ypos < max_ysize)
 633   {
 634     DrawTextBuffer_Flush(x, y, buffer, font_nr, line_length, cut_length,
 635                          mask_mode, centered, current_ypos);
 636     current_ypos += line_height;
 637     current_line++;
 638   }
 639
 640   return current_line;
 641 }
 642
 643 int DrawTextBufferVA(int x, int y, char *format, va_list ap, int font_nr,
 644                      int line_length, int cut_length, int max_lines,
 645                      int line_spacing, int mask_mode, boolean autowrap,
 646                      boolean centered, boolean parse_comments)
 647 {
 648   char text_buffer[MAX_OUTPUT_LINESIZE];
 649   int text_length = vsnprintf(text_buffer, MAX_OUTPUT_LINESIZE, format, ap);
 650
 651   if (text_length >= MAX_OUTPUT_LINESIZE)
 652     Warn("string too long in DrawTextBufferVA() -- truncated");
 653
 654   int num_lines_printed = DrawTextBuffer(x, y, text_buffer, font_nr,
 655                                          line_length, cut_length, max_lines,
 656                                          line_spacing, mask_mode, autowrap,
 657                                          centered, parse_comments);
 658   return num_lines_printed;
 659 }
 660
 661 int DrawTextFile(int x, int y, char *filename, int font_nr,
 662                  int line_length, int cut_length, int max_lines,
 663                  int line_spacing, int mask_mode, boolean autowrap,
 664                  boolean centered, boolean parse_comments)
 665 {
 666   char *text_buffer = GetTextBufferFromFile(filename, MAX_LINES_FROM_FILE);
 667   int num_lines_printed = DrawTextBuffer(x, y, text_buffer, font_nr,
 668                                          line_length, cut_length, max_lines,
 669                                          line_spacing, mask_mode, autowrap,
 670                                          centered, parse_comments);
 671   checked_free(text_buffer);
 672
 673   return num_lines_printed;
 674 }