src/libgame/text.c

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2006 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 DrawTextSAligned(int x, int y, char *text, int font_nr, int align)
 244 {
 245   DrawText(gfx.sx + ALIGNED_XPOS(x, getTextWidth(text, font_nr), align),
 246            gfx.sx + y, text, font_nr);
 247 }
 248
 249 void DrawTextAligned(int x, int y, char *text, int font_nr, int align)
 250 {
 251   DrawText(ALIGNED_XPOS(x, getTextWidth(text, font_nr), align),
 252            y, text, font_nr);
 253 }
 254
 255 void DrawText(int x, int y, char *text, int font_nr)
 256 {
 257   int mask_mode = BLIT_OPAQUE;
 258
 259   if (DrawingOnBackground(x, y))
 260     mask_mode = BLIT_ON_BACKGROUND;
 261
 262   DrawTextExt(drawto, x, y, text, font_nr, mask_mode);
 263
 264   if (x < gfx.dx)
 265     redraw_mask |= REDRAW_FIELD;
 266   else if (y < gfx.vy || gfx.vy == 0)
 267     redraw_mask |= REDRAW_DOOR_1;
 268 }
 269
 270 void DrawTextExt(DrawBuffer *dst_bitmap, int dst_x, int dst_y, char *text,
 271                  int font_nr, int mask_mode)
 272 {
 273 #if 1
 274   struct FontBitmapInfo *font = getFontBitmapInfo(font_nr);
 275 #else
 276   int font_bitmap_id = gfx.select_font_function(font_nr);
 277   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 278 #endif
 279   int font_width = getFontWidth(font_nr);
 280   int font_height = getFontHeight(font_nr);
 281 #if 0
 282   int border_1 = gfx.sx + gfx.sxsize;
 283   int border_2 = gfx.dx + gfx.dxsize;
 284   int dst_x_start = dst_x;
 285 #endif
 286   Bitmap *src_bitmap;
 287   int src_x, src_y;
 288   char *text_ptr = text;
 289
 290   if (font->bitmap == NULL)
 291     return;
 292
 293   /* skip text to be printed outside the window (left/right will be clipped) */
 294   if (dst_y < 0 || dst_y + font_height > video.height)
 295     return;
 296
 297   /* add offset for drawing font characters */
 298   dst_x += font->draw_xoffset;
 299   dst_y += font->draw_yoffset;
 300
 301   while (*text_ptr)
 302   {
 303     char c = *text_ptr++;
 304
 305     if (c == '\n')
 306       c = ' ';          /* print space instaed of newline */
 307
 308     getFontCharSource(font_nr, c, &src_bitmap, &src_x, &src_y);
 309
 310     /* clip text at the left side of the window */
 311     if (dst_x < 0)
 312     {
 313       dst_x += font_width;
 314
 315       continue;
 316     }
 317
 318     /* clip text at the right side of the window */
 319 #if 1
 320     if (dst_x + font_width > video.width)
 321       break;
 322 #else
 323     /* (this does not work well when trying to print text to whole screen) */
 324     if ((dst_x_start < border_1 && dst_x + font_width > border_1) ||
 325         (dst_x_start < border_2 && dst_x + font_width > border_2))
 326       break;
 327 #endif
 328
 329     if (mask_mode == BLIT_INVERSE)      /* special mode for text gadgets */
 330     {
 331       /* first step: draw solid colored rectangle (use "cursor" character) */
 332       if (strlen(text) == 1)    /* only one char inverted => draw cursor */
 333       {
 334         Bitmap *cursor_bitmap;
 335         int cursor_x, cursor_y;
 336
 337         getFontCharSource(font_nr, FONT_ASCII_CURSOR, &cursor_bitmap,
 338                           &cursor_x, &cursor_y);
 339
 340         BlitBitmap(cursor_bitmap, dst_bitmap, cursor_x, cursor_y,
 341                    font_width, font_height, dst_x, dst_y);
 342       }
 343
 344 #if defined(TARGET_SDL)
 345       /* second step: draw masked inverted character */
 346       SDLCopyInverseMasked(src_bitmap, dst_bitmap, src_x, src_y,
 347                            font_width, font_height, dst_x, dst_y);
 348 #else
 349       /* second step: draw masked black rectangle (use "space" character) */
 350       SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
 351                     dst_x - src_x, dst_y - src_y);
 352       BlitBitmapMasked(src_bitmap, dst_bitmap, 0, 0,
 353                        font_width, font_height, dst_x, dst_y);
 354 #endif
 355     }
 356     else if (mask_mode == BLIT_MASKED || mask_mode == BLIT_ON_BACKGROUND)
 357     {
 358       if (mask_mode == BLIT_ON_BACKGROUND)
 359       {
 360         /* clear font character background */
 361         ClearRectangleOnBackground(dst_bitmap, dst_x, dst_y,
 362                                    font_width, font_height);
 363       }
 364
 365 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 366       /* use special font tile clipmasks */
 367       {
 368         int font_pos = getFontCharPosition(font_nr, c);
 369
 370         SetClipMask(src_bitmap, font_clip_gc, font->clip_mask[font_pos]);
 371         SetClipOrigin(src_bitmap, font_clip_gc, dst_x, dst_y);
 372       }
 373 #else
 374       SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
 375                     dst_x - src_x, dst_y - src_y);
 376 #endif
 377
 378       BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y,
 379                        font_width, font_height, dst_x, dst_y);
 380     }
 381     else        /* normal, non-masked font blitting */
 382     {
 383       BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y,
 384                  font_width, font_height, dst_x, dst_y);
 385     }
 386
 387     dst_x += font_width;
 388   }
 389 }
 390
 391 void DrawTextToTextArea(int x, int y, char *text, int font_nr, int line_length,
 392                         int area_xsize, int area_ysize, int mask_mode)
 393 {
 394   int area_line = 0;
 395   int font_height = getFontHeight(font_nr);
 396
 397   if (text == NULL)
 398     return;
 399
 400   while (*text && area_line < area_ysize)
 401   {
 402     char buffer[MAX_OUTPUT_LINESIZE + 1];
 403     int i;
 404
 405     for (i = 0; i < line_length && *text; i++)
 406       if ((buffer[i] = *text++) == '\n')
 407         break;
 408     buffer[MIN(i, area_xsize)] = '\0';
 409
 410     DrawTextExt(drawto, x, y + area_line * font_height, buffer, font_nr,
 411                 mask_mode);
 412
 413     area_line++;
 414   }
 415
 416   redraw_mask |= REDRAW_FIELD;
 417 }
 418
 419 boolean RenderLineToBuffer(char **src_buffer_ptr, char *dst_buffer,
 420                            int *dst_buffer_len, boolean last_line_was_empty,
 421                            int line_length)
 422 {
 423   char *text_ptr = *src_buffer_ptr;
 424   char *buffer = dst_buffer;
 425   int buffer_len = *dst_buffer_len;
 426   boolean buffer_filled = FALSE;
 427
 428   while (*text_ptr)
 429   {
 430     char *word_ptr;
 431     int word_len;
 432
 433     /* skip leading whitespaces */
 434     while (*text_ptr == ' ' || *text_ptr == '\t')
 435       text_ptr++;
 436
 437     word_ptr = text_ptr;
 438     word_len = 0;
 439
 440     /* look for end of next word */
 441     while (*word_ptr != ' ' && *word_ptr != '\t' && *word_ptr != '\0')
 442     {
 443       word_ptr++;
 444       word_len++;
 445     }
 446
 447     if (word_len == 0)
 448     {
 449       continue;
 450     }
 451     else if (*text_ptr == '\n')         /* special case: force empty line */
 452     {
 453       if (buffer_len == 0)
 454         text_ptr++;
 455
 456       /* prevent printing of multiple empty lines */
 457       if (buffer_len > 0 || !last_line_was_empty)
 458         buffer_filled = TRUE;
 459     }
 460     else if (word_len < line_length - buffer_len)
 461     {
 462       /* word fits into text buffer -- add word */
 463
 464       if (buffer_len > 0)
 465         buffer[buffer_len++] = ' ';
 466
 467       strncpy(&buffer[buffer_len], text_ptr, word_len);
 468       buffer_len += word_len;
 469       buffer[buffer_len] = '\0';
 470       text_ptr += word_len;
 471     }
 472     else if (buffer_len > 0)
 473     {
 474       /* not enough space left for word in text buffer -- print buffer */
 475
 476       buffer_filled = TRUE;
 477     }
 478     else
 479     {
 480       /* word does not fit at all into empty text buffer -- cut word */
 481
 482       strncpy(buffer, text_ptr, line_length);
 483       buffer[line_length] = '\0';
 484       text_ptr += line_length;
 485       buffer_filled = TRUE;
 486     }
 487
 488     if (buffer_filled)
 489       break;
 490   }
 491
 492   *src_buffer_ptr = text_ptr;
 493   *dst_buffer_len = buffer_len;
 494
 495   return buffer_filled;
 496 }
 497
 498 void DrawTextWrapped(int x, int y, char *text, int font_nr, int line_length,
 499                      int max_lines)
 500 {
 501   char *text_ptr = text;
 502   char buffer[line_length + 1];
 503   int buffer_len;
 504   int current_line = 0;
 505   int font_height = getFontHeight(font_nr);
 506
 507   while (*text_ptr && current_line < max_lines)
 508   {
 509     buffer[0] = '\0';
 510     buffer_len = 0;
 511
 512     RenderLineToBuffer(&text_ptr, buffer, &buffer_len, TRUE, line_length);
 513
 514     DrawText(x, y + current_line * font_height, buffer, font_nr);
 515     current_line++;
 516   }
 517 }
 518
 519 int DrawTextFromFile(int x, int y, char *filename, int font_nr,
 520                      int line_length, int max_lines)
 521 {
 522   int font_height = getFontHeight(font_nr);
 523   char line[MAX_LINE_LEN];
 524   char buffer[line_length + 1];
 525   int buffer_len;
 526   int current_line = 0;
 527   FILE *file;
 528
 529   if (current_line >= max_lines)
 530     return 0;
 531
 532   if (filename == NULL)
 533     return 0;
 534
 535   if (!(file = fopen(filename, MODE_READ)))
 536     return 0;
 537
 538   buffer[0] = '\0';
 539   buffer_len = 0;
 540
 541   while (!feof(file) && current_line < max_lines)
 542   {
 543     char *line_ptr;
 544     boolean last_line_was_empty = TRUE;
 545
 546     /* read next line of input file */
 547     if (!fgets(line, MAX_LINE_LEN, file))
 548       break;
 549
 550     /* skip comments (lines directly beginning with '#') */
 551     if (line[0] == '#')
 552       continue;
 553
 554     /* cut trailing newline from input line */
 555     for (line_ptr = line; *line_ptr; line_ptr++)
 556     {
 557       if (*line_ptr == '\n' || *line_ptr == '\r')
 558       {
 559         *line_ptr = '\0';
 560         break;
 561       }
 562     }
 563
 564     if (strlen(line) == 0)              /* special case: force empty line */
 565       strcpy(line, "\n");
 566
 567     line_ptr = line;
 568
 569     while (*line_ptr && current_line < max_lines)
 570     {
 571       boolean buffer_filled = RenderLineToBuffer(&line_ptr,
 572                                                  buffer, &buffer_len,
 573                                                  last_line_was_empty,
 574                                                  line_length);
 575       if (buffer_filled)
 576       {
 577         DrawText(x, y + current_line * font_height, buffer, font_nr);
 578         current_line++;
 579
 580         last_line_was_empty = (buffer_len == 0);
 581
 582         buffer[0] = '\0';
 583         buffer_len = 0;
 584       }
 585     }
 586   }
 587
 588   fclose(file);
 589
 590   if (buffer_len > 0 && current_line < max_lines)
 591   {
 592     DrawText(x, y + current_line * font_height, buffer, font_nr);
 593     current_line++;
 594   }
 595
 596   return current_line;
 597 }