src/libgame/text.c

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2002 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * text.c                                                   *
  12 ***********************************************************/
  13
  14 #include <stdio.h>
  15 #include <stdarg.h>
  16
  17 #include "text.h"
  18 #include "misc.h"
  19
  20
  21 /* ========================================================================= */
  22 /* font functions                                                            */
  23 /* ========================================================================= */
  24
  25 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
  26 static GC       font_clip_gc = None;
  27
  28 static void InitFontClipmasks()
  29 {
  30   XGCValues clip_gc_values;
  31   unsigned long clip_gc_valuemask;
  32   GC copy_clipmask_gc;
  33   int i, j;
  34
  35   /* This stuff is needed because X11 (XSetClipOrigin(), to be precise) is
  36      often very slow when preparing a masked XCopyArea() for big Pixmaps.
  37      To prevent this, create small (tile-sized) mask Pixmaps which will then
  38      be set much faster with XSetClipOrigin() and speed things up a lot. */
  39
  40   clip_gc_values.graphics_exposures = False;
  41   clip_gc_valuemask = GCGraphicsExposures;
  42   font_clip_gc = XCreateGC(display, window->drawable,
  43                            clip_gc_valuemask, &clip_gc_values);
  44
  45   /* create graphic context structures needed for clipping */
  46   clip_gc_values.graphics_exposures = False;
  47   clip_gc_valuemask = GCGraphicsExposures;
  48   copy_clipmask_gc = XCreateGC(display,
  49                                gfx.font_bitmap_info[0].bitmap->clip_mask,
  50                                clip_gc_valuemask, &clip_gc_values);
  51
  52   /* create only those clipping Pixmaps we really need */
  53   for (i = 0; i < gfx.num_fonts; i++)
  54   {
  55     if (gfx.font_bitmap_info[i].bitmap == NULL)
  56       continue;
  57
  58     gfx.font_bitmap_info[i].clip_mask =
  59       checked_calloc(gfx.font_bitmap_info[i].num_chars * sizeof(Pixmap));
  60
  61     for (j = 0; j < gfx.font_bitmap_info[i].num_chars; j++)
  62     {
  63       Bitmap *src_bitmap = gfx.font_bitmap_info[i].bitmap;
  64       Pixmap src_pixmap = src_bitmap->clip_mask;
  65       int xpos = j % gfx.font_bitmap_info[i].num_chars_per_line;
  66       int ypos = j / gfx.font_bitmap_info[i].num_chars_per_line;
  67       int width  = gfx.font_bitmap_info[i].width;
  68       int height = gfx.font_bitmap_info[i].height;
  69       int src_x = gfx.font_bitmap_info[i].src_x + xpos * width;
  70       int src_y = gfx.font_bitmap_info[i].src_y + ypos * height;
  71
  72       gfx.font_bitmap_info[i].clip_mask[j] =
  73         XCreatePixmap(display, window->drawable, width, height, 1);
  74
  75       XCopyArea(display, src_pixmap, gfx.font_bitmap_info[i].clip_mask[j],
  76                 copy_clipmask_gc, src_x, src_y, width, height, 0, 0);
  77     }
  78   }
  79
  80   XFreeGC(display, copy_clipmask_gc);
  81 }
  82
  83 static void FreeFontClipmasks()
  84 {
  85   int i, j;
  86
  87   if (gfx.num_fonts == 0 || gfx.font_bitmap_info[0].bitmap == NULL)
  88     return;
  89
  90   for (i = 0; i < gfx.num_fonts; i++)
  91   {
  92     if (gfx.font_bitmap_info[i].clip_mask)
  93     {
  94       for (j = 0; j < gfx.font_bitmap_info[i].num_chars; j++)
  95         XFreePixmap(display, gfx.font_bitmap_info[i].clip_mask[j]);
  96       free(gfx.font_bitmap_info[i].clip_mask);
  97     }
  98
  99     gfx.font_bitmap_info[i].clip_mask = NULL;
 100     gfx.font_bitmap_info[i].num_chars = 0;
 101   }
 102
 103   if (font_clip_gc)
 104     XFreeGC(display, font_clip_gc);
 105   font_clip_gc = None;
 106 }
 107 #endif /* TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND */
 108
 109 void InitFontInfo(struct FontBitmapInfo *font_bitmap_info, int num_fonts,
 110                   int (*select_font_function)(int))
 111 {
 112   gfx.num_fonts = num_fonts;
 113   gfx.font_bitmap_info = font_bitmap_info;
 114   gfx.select_font_function = select_font_function;
 115
 116 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 117   InitFontClipmasks();
 118 #endif
 119 }
 120
 121 void FreeFontInfo(struct FontBitmapInfo *font_bitmap_info)
 122 {
 123   if (font_bitmap_info == NULL)
 124     return;
 125
 126 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 127   FreeFontClipmasks();
 128 #endif
 129
 130   free(font_bitmap_info);
 131 }
 132
 133 struct FontBitmapInfo *getFontBitmapInfo(int font_nr)
 134 {
 135   int font_bitmap_id = gfx.select_font_function(font_nr);
 136
 137   return &gfx.font_bitmap_info[font_bitmap_id];
 138 }
 139
 140 int getFontWidth(int font_nr)
 141 {
 142   int font_bitmap_id = gfx.select_font_function(font_nr);
 143
 144   return gfx.font_bitmap_info[font_bitmap_id].width;
 145 }
 146
 147 int getFontHeight(int font_nr)
 148 {
 149   int font_bitmap_id = gfx.select_font_function(font_nr);
 150
 151   return gfx.font_bitmap_info[font_bitmap_id].height;
 152 }
 153
 154 int getTextWidth(char *text, int font_nr)
 155 {
 156   return (text != NULL ? strlen(text) * getFontWidth(font_nr) : 0);
 157 }
 158
 159 static char getFontCharPosition(int font_nr, char c)
 160 {
 161   int font_bitmap_id = gfx.select_font_function(font_nr);
 162   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 163   boolean default_font = (font->num_chars == DEFAULT_NUM_CHARS_PER_FONT);
 164   int font_pos = c - 32;
 165
 166   /* map some special characters to their ascii values in default font */
 167   if (default_font)
 168     font_pos = MAP_FONT_ASCII(c) - 32;
 169
 170   /* this allows dynamic special characters together with special font */
 171   if (font_pos < 0 || font_pos >= font->num_chars)
 172     font_pos = 0;
 173
 174   return font_pos;
 175 }
 176
 177 void getFontCharSource(int font_nr, char c, Bitmap **bitmap, int *x, int *y)
 178 {
 179   int font_bitmap_id = gfx.select_font_function(font_nr);
 180   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 181   int font_pos = getFontCharPosition(font_nr, c);
 182
 183   *bitmap = font->bitmap;
 184   *x = font->src_x + (font_pos % font->num_chars_per_line) * font->width;
 185   *y = font->src_y + (font_pos / font->num_chars_per_line) * font->height;
 186 }
 187
 188 void DrawInitText(char *text, int ypos, int font_nr)
 189 {
 190   if (window &&
 191       gfx.num_fonts > 0 &&
 192       gfx.font_bitmap_info[font_nr].bitmap != NULL)
 193   {
 194     ClearRectangle(window, 0, ypos, video.width, getFontHeight(font_nr));
 195     DrawTextExt(window, (video.width - getTextWidth(text, font_nr)) / 2, ypos,
 196                 text, font_nr, BLIT_OPAQUE);
 197     FlushDisplay();
 198   }
 199 }
 200
 201 void DrawTextF(int x, int y, int font_nr, char *format, ...)
 202 {
 203   char buffer[MAX_OUTPUT_LINESIZE + 1];
 204   va_list ap;
 205
 206   va_start(ap, format);
 207   vsprintf(buffer, format, ap);
 208   va_end(ap);
 209
 210   if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
 211     Error(ERR_EXIT, "string too long in DrawTextF() -- aborting");
 212
 213   DrawText(gfx.sx + x, gfx.sy + y, buffer, font_nr);
 214 }
 215
 216 void DrawTextFCentered(int y, int font_nr, char *format, ...)
 217 {
 218   char buffer[MAX_OUTPUT_LINESIZE + 1];
 219   va_list ap;
 220
 221   va_start(ap, format);
 222   vsprintf(buffer, format, ap);
 223   va_end(ap);
 224
 225   if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
 226     Error(ERR_EXIT, "string too long in DrawTextFCentered() -- aborting");
 227
 228   DrawText(gfx.sx + (gfx.sxsize - getTextWidth(buffer, font_nr)) / 2,
 229            gfx.sy + y, buffer, font_nr);
 230 }
 231
 232 void DrawTextS(int x, int y, int font_nr, char *text)
 233 {
 234   DrawText(gfx.sx + x, gfx.sy + y, text, font_nr);
 235 }
 236
 237 void DrawTextSCentered(int y, int font_nr, char *text)
 238 {
 239   DrawText(gfx.sx + (gfx.sxsize - getTextWidth(text, font_nr)) / 2,
 240            gfx.sy + y, text, font_nr);
 241 }
 242
 243 void DrawText(int x, int y, char *text, int font_nr)
 244 {
 245   int mask_mode = BLIT_OPAQUE;
 246
 247   if (DrawingOnBackground(x, y))
 248     mask_mode = BLIT_ON_BACKGROUND;
 249
 250   DrawTextExt(drawto, x, y, text, font_nr, mask_mode);
 251
 252   if (x < gfx.dx)
 253     redraw_mask |= REDRAW_FIELD;
 254   else if (y < gfx.vy || gfx.vy == 0)
 255     redraw_mask |= REDRAW_DOOR_1;
 256 }
 257
 258 void DrawTextExt(DrawBuffer *dst_bitmap, int dst_x, int dst_y, char *text,
 259                  int font_nr, int mask_mode)
 260 {
 261   int font_bitmap_id = gfx.select_font_function(font_nr);
 262   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 263   int font_width = getFontWidth(font_nr);
 264   int font_height = getFontHeight(font_nr);
 265 #if 0
 266   int border_1 = gfx.sx + gfx.sxsize;
 267   int border_2 = gfx.dx + gfx.dxsize;
 268   int dst_x_start = dst_x;
 269 #endif
 270   Bitmap *src_bitmap;
 271   int src_x, src_y;
 272   char *text_ptr = text;
 273
 274   if (font->bitmap == NULL)
 275     return;
 276
 277   /* skip text to be printed outside the window (left/right will be clipped) */
 278   if (dst_y < 0 || dst_y + font_height > video.height)
 279     return;
 280
 281   /* add offset for drawing font characters */
 282   dst_x += font->draw_xoffset;
 283   dst_y += font->draw_yoffset;
 284
 285   while (*text_ptr)
 286   {
 287     char c = *text_ptr++;
 288
 289     if (c == '\n')
 290       c = ' ';          /* print space instaed of newline */
 291
 292     getFontCharSource(font_nr, c, &src_bitmap, &src_x, &src_y);
 293
 294     /* clip text at the left side of the window */
 295     if (dst_x < 0)
 296     {
 297       dst_x += font_width;
 298
 299       continue;
 300     }
 301
 302     /* clip text at the right side of the window */
 303 #if 1
 304     if (dst_x + font_width > video.width)
 305       break;
 306 #else
 307     /* (this does not work well when trying to print text to whole screen) */
 308     if ((dst_x_start < border_1 && dst_x + font_width > border_1) ||
 309         (dst_x_start < border_2 && dst_x + font_width > border_2))
 310       break;
 311 #endif
 312
 313     if (mask_mode == BLIT_INVERSE)      /* special mode for text gadgets */
 314     {
 315       /* first step: draw solid colored rectangle (use "cursor" character) */
 316       if (strlen(text) == 1)    /* only one char inverted => draw cursor */
 317       {
 318         Bitmap *cursor_bitmap;
 319         int cursor_x, cursor_y;
 320
 321         getFontCharSource(font_nr, FONT_ASCII_CURSOR, &cursor_bitmap,
 322                           &cursor_x, &cursor_y);
 323
 324         BlitBitmap(cursor_bitmap, dst_bitmap, cursor_x, cursor_y,
 325                    font_width, font_height, dst_x, dst_y);
 326       }
 327
 328 #if defined(TARGET_SDL)
 329       /* second step: draw masked inverted character */
 330       SDLCopyInverseMasked(src_bitmap, dst_bitmap, src_x, src_y,
 331                            font_width, font_height, dst_x, dst_y);
 332 #else
 333       /* second step: draw masked black rectangle (use "space" character) */
 334       SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
 335                     dst_x - src_x, dst_y - src_y);
 336       BlitBitmapMasked(src_bitmap, dst_bitmap, 0, 0,
 337                        font_width, font_height, dst_x, dst_y);
 338 #endif
 339     }
 340     else if (mask_mode == BLIT_MASKED || mask_mode == BLIT_ON_BACKGROUND)
 341     {
 342       if (mask_mode == BLIT_ON_BACKGROUND)
 343       {
 344         /* clear font character background */
 345         ClearRectangleOnBackground(dst_bitmap, dst_x, dst_y,
 346                                    font_width, font_height);
 347       }
 348
 349 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 350       /* use special font tile clipmasks */
 351       {
 352         int font_pos = getFontCharPosition(font_nr, c);
 353
 354         SetClipMask(src_bitmap, font_clip_gc, font->clip_mask[font_pos]);
 355         SetClipOrigin(src_bitmap, font_clip_gc, dst_x, dst_y);
 356       }
 357 #else
 358       SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
 359                     dst_x - src_x, dst_y - src_y);
 360 #endif
 361
 362       BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y,
 363                        font_width, font_height, dst_x, dst_y);
 364     }
 365     else        /* normal, non-masked font blitting */
 366     {
 367       BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y,
 368                  font_width, font_height, dst_x, dst_y);
 369     }
 370
 371     dst_x += font_width;
 372   }
 373 }
 374
 375 void DrawTextToTextArea(int x, int y, char *text, int font_nr, int line_length,
 376                         int area_xsize, int area_ysize, int mask_mode)
 377 {
 378   int area_line = 0;
 379   int font_height = getFontHeight(font_nr);
 380
 381   if (text == NULL)
 382     return;
 383
 384   while (*text && area_line < area_ysize)
 385   {
 386     char buffer[MAX_OUTPUT_LINESIZE + 1];
 387     int i;
 388
 389     for (i = 0; i < line_length && *text; i++)
 390       if ((buffer[i] = *text++) == '\n')
 391         break;
 392     buffer[MIN(i, area_xsize)] = '\0';
 393
 394     DrawTextExt(drawto, x, y + area_line * font_height, buffer, font_nr,
 395                 mask_mode);
 396
 397     area_line++;
 398   }
 399
 400   redraw_mask |= REDRAW_FIELD;
 401 }
 402
 403 boolean RenderLineToBuffer(char **src_buffer_ptr, char *dst_buffer,
 404                            int *dst_buffer_len, boolean last_line_was_empty,
 405                            int line_length)
 406 {
 407   char *text_ptr = *src_buffer_ptr;
 408   char *buffer = dst_buffer;
 409   int buffer_len = *dst_buffer_len;
 410   boolean buffer_filled = FALSE;
 411
 412   while (*text_ptr)
 413   {
 414     char *word_ptr;
 415     int word_len;
 416
 417     /* skip leading whitespaces */
 418     while (*text_ptr == ' ' || *text_ptr == '\t')
 419       text_ptr++;
 420
 421     word_ptr = text_ptr;
 422     word_len = 0;
 423
 424     /* look for end of next word */
 425     while (*word_ptr != ' ' && *word_ptr != '\t' && *word_ptr != '\0')
 426     {
 427       word_ptr++;
 428       word_len++;
 429     }
 430
 431     if (word_len == 0)
 432     {
 433       continue;
 434     }
 435     else if (*text_ptr == '\n')         /* special case: force empty line */
 436     {
 437       if (buffer_len == 0)
 438         text_ptr++;
 439
 440       /* prevent printing of multiple empty lines */
 441       if (buffer_len > 0 || !last_line_was_empty)
 442         buffer_filled = TRUE;
 443     }
 444     else if (word_len < line_length - buffer_len)
 445     {
 446       /* word fits into text buffer -- add word */
 447
 448       if (buffer_len > 0)
 449         buffer[buffer_len++] = ' ';
 450
 451       strncpy(&buffer[buffer_len], text_ptr, word_len);
 452       buffer_len += word_len;
 453       buffer[buffer_len] = '\0';
 454       text_ptr += word_len;
 455     }
 456     else if (buffer_len > 0)
 457     {
 458       /* not enough space left for word in text buffer -- print buffer */
 459
 460       buffer_filled = TRUE;
 461     }
 462     else
 463     {
 464       /* word does not fit at all into empty text buffer -- cut word */
 465
 466       strncpy(buffer, text_ptr, line_length);
 467       buffer[line_length] = '\0';
 468       text_ptr += line_length;
 469       buffer_filled = TRUE;
 470     }
 471
 472     if (buffer_filled)
 473       break;
 474   }
 475
 476   *src_buffer_ptr = text_ptr;
 477   *dst_buffer_len = buffer_len;
 478
 479   return buffer_filled;
 480 }
 481
 482 void DrawTextWrapped(int x, int y, char *text, int font_nr, int line_length,
 483                      int max_lines)
 484 {
 485   char *text_ptr = text;
 486   char buffer[line_length + 1];
 487   int buffer_len;
 488   int current_line = 0;
 489   int font_height = getFontHeight(font_nr);
 490
 491   while (*text_ptr && current_line < max_lines)
 492   {
 493     buffer[0] = '\0';
 494     buffer_len = 0;
 495
 496     RenderLineToBuffer(&text_ptr, buffer, &buffer_len, TRUE, line_length);
 497
 498     DrawText(x, y + current_line * font_height, buffer, font_nr);
 499     current_line++;
 500   }
 501 }
 502
 503 int DrawTextFromFile(int x, int y, char *filename, int font_nr,
 504                      int line_length, int max_lines)
 505 {
 506   int font_height = getFontHeight(font_nr);
 507   char line[MAX_LINE_LEN];
 508   char buffer[line_length + 1];
 509   int buffer_len;
 510   int current_line = 0;
 511   FILE *file;
 512
 513   if (current_line >= max_lines)
 514     return 0;
 515
 516   if (filename == NULL)
 517     return 0;
 518
 519   if (!(file = fopen(filename, MODE_READ)))
 520     return 0;
 521
 522   buffer[0] = '\0';
 523   buffer_len = 0;
 524
 525   while (!feof(file) && current_line < max_lines)
 526   {
 527     char *line_ptr;
 528     boolean last_line_was_empty = TRUE;
 529
 530     /* read next line of input file */
 531     if (!fgets(line, MAX_LINE_LEN, file))
 532       break;
 533
 534     /* skip comments (lines directly beginning with '#') */
 535     if (line[0] == '#')
 536       continue;
 537
 538     /* cut trailing newline from input line */
 539     for (line_ptr = line; *line_ptr; line_ptr++)
 540     {
 541       if (*line_ptr == '\n' || *line_ptr == '\r')
 542       {
 543         *line_ptr = '\0';
 544         break;
 545       }
 546     }
 547
 548     if (strlen(line) == 0)              /* special case: force empty line */
 549       strcpy(line, "\n");
 550
 551     line_ptr = line;
 552
 553     while (*line_ptr && current_line < max_lines)
 554     {
 555       boolean buffer_filled = RenderLineToBuffer(&line_ptr,
 556                                                  buffer, &buffer_len,
 557                                                  last_line_was_empty,
 558                                                  line_length);
 559       if (buffer_filled)
 560       {
 561         DrawText(x, y + current_line * font_height, buffer, font_nr);
 562         current_line++;
 563
 564         last_line_was_empty = (buffer_len == 0);
 565
 566         buffer[0] = '\0';
 567         buffer_len = 0;
 568       }
 569     }
 570   }
 571
 572   fclose(file);
 573
 574   if (buffer_len > 0 && current_line < max_lines)
 575   {
 576     DrawText(x, y + current_line * font_height, buffer, font_nr);
 577     current_line++;
 578   }
 579
 580   return current_line;
 581 }