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 int getFontWidth(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].width;
 138 }
 139
 140 int getFontHeight(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].height;
 145 }
 146
 147 int getTextWidth(char *text, int font_nr)
 148 {
 149   return (text != NULL ? strlen(text) * getFontWidth(font_nr) : 0);
 150 }
 151
 152 static char getFontCharPosition(int font_nr, char c)
 153 {
 154   int font_bitmap_id = gfx.select_font_function(font_nr);
 155   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 156   boolean default_font = (font->num_chars == DEFAULT_NUM_CHARS_PER_FONT);
 157   int font_pos = c - 32;
 158
 159   /* map some special characters to their ascii values in default font */
 160   if (default_font)
 161     font_pos = MAP_FONT_ASCII(c) - 32;
 162
 163   /* this allows dynamic special characters together with special font */
 164   if (font_pos < 0 || font_pos >= font->num_chars)
 165     font_pos = 0;
 166
 167   return font_pos;
 168 }
 169
 170 void getFontCharSource(int font_nr, char c, Bitmap **bitmap, int *x, int *y)
 171 {
 172   int font_bitmap_id = gfx.select_font_function(font_nr);
 173   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 174   int font_pos = getFontCharPosition(font_nr, c);
 175
 176   *bitmap = font->bitmap;
 177   *x = font->src_x + (font_pos % font->num_chars_per_line) * font->width;
 178   *y = font->src_y + (font_pos / font->num_chars_per_line) * font->height;
 179 }
 180
 181 void DrawInitText(char *text, int ypos, int font_nr)
 182 {
 183   if (window &&
 184       gfx.num_fonts > 0 &&
 185       gfx.font_bitmap_info[font_nr].bitmap != NULL)
 186   {
 187     ClearRectangle(window, 0, ypos, video.width, getFontHeight(font_nr));
 188     DrawTextExt(window, (video.width - getTextWidth(text, font_nr)) / 2, ypos,
 189                 text, font_nr, BLIT_OPAQUE);
 190     FlushDisplay();
 191   }
 192 }
 193
 194 void DrawTextFCentered(int y, int font_nr, char *format, ...)
 195 {
 196   char buffer[MAX_OUTPUT_LINESIZE + 1];
 197   va_list ap;
 198
 199   va_start(ap, format);
 200   vsprintf(buffer, format, ap);
 201   va_end(ap);
 202
 203   if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
 204     Error(ERR_EXIT, "string too long in DrawTextFCentered() -- aborting");
 205
 206   DrawText(gfx.sx + (gfx.sxsize - getTextWidth(buffer, font_nr)) / 2,
 207            gfx.sy + y, buffer, font_nr);
 208 }
 209
 210 void DrawTextF(int x, int y, int font_nr, char *format, ...)
 211 {
 212   char buffer[MAX_OUTPUT_LINESIZE + 1];
 213   va_list ap;
 214
 215   va_start(ap, format);
 216   vsprintf(buffer, format, ap);
 217   va_end(ap);
 218
 219   if (strlen(buffer) > MAX_OUTPUT_LINESIZE)
 220     Error(ERR_EXIT, "string too long in DrawTextF() -- aborting");
 221
 222   DrawText(gfx.sx + x, gfx.sy + y, buffer, font_nr);
 223 }
 224
 225 void DrawText(int x, int y, char *text, int font_nr)
 226 {
 227   int mask_mode = BLIT_OPAQUE;
 228
 229   if (DrawingOnBackground(x, y))
 230     mask_mode = BLIT_ON_BACKGROUND;
 231
 232   DrawTextExt(drawto, x, y, text, font_nr, mask_mode);
 233
 234   if (x < gfx.dx)
 235     redraw_mask |= REDRAW_FIELD;
 236   else if (y < gfx.vy || gfx.vy == 0)
 237     redraw_mask |= REDRAW_DOOR_1;
 238 }
 239
 240 void DrawTextExt(DrawBuffer *dst_bitmap, int dst_x, int dst_y, char *text,
 241                  int font_nr, int mask_mode)
 242 {
 243   int font_bitmap_id = gfx.select_font_function(font_nr);
 244   struct FontBitmapInfo *font = &gfx.font_bitmap_info[font_bitmap_id];
 245   int font_width = getFontWidth(font_nr);
 246   int font_height = getFontHeight(font_nr);
 247   Bitmap *src_bitmap;
 248   int src_x, src_y;
 249   char *text_ptr = text;
 250
 251   if (font->bitmap == NULL)
 252     return;
 253
 254   /* add offset for drawing font characters */
 255   dst_x += font->draw_x;
 256   dst_y += font->draw_y;
 257
 258   while (*text_ptr)
 259   {
 260     char c = *text_ptr++;
 261
 262     if (c == '\n')
 263       c = ' ';          /* print space instaed of newline */
 264
 265     getFontCharSource(font_nr, c, &src_bitmap, &src_x, &src_y);
 266
 267     if (mask_mode == BLIT_INVERSE)      /* special mode for text gadgets */
 268     {
 269       /* first step: draw solid colored rectangle (use "cursor" character) */
 270       if (strlen(text) == 1)    /* only one char inverted => draw cursor */
 271       {
 272         Bitmap *cursor_bitmap;
 273         int cursor_x, cursor_y;
 274
 275         getFontCharSource(font_nr, FONT_ASCII_CURSOR, &cursor_bitmap,
 276                           &cursor_x, &cursor_y);
 277
 278         BlitBitmap(cursor_bitmap, dst_bitmap, cursor_x, cursor_y,
 279                    font_width, font_height, dst_x, dst_y);
 280       }
 281
 282 #if defined(TARGET_SDL)
 283       /* second step: draw masked inverted character */
 284       SDLCopyInverseMasked(src_bitmap, dst_bitmap, src_x, src_y,
 285                            font_width, font_height, dst_x, dst_y);
 286 #else
 287       /* second step: draw masked black rectangle (use "space" character) */
 288       SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
 289                     dst_x - src_x, dst_y - src_y);
 290       BlitBitmapMasked(src_bitmap, dst_bitmap, 0, 0,
 291                        font_width, font_height, dst_x, dst_y);
 292 #endif
 293     }
 294     else if (mask_mode == BLIT_MASKED || mask_mode == BLIT_ON_BACKGROUND)
 295     {
 296       if (mask_mode == BLIT_ON_BACKGROUND)
 297       {
 298         /* clear font character background */
 299         ClearRectangleOnBackground(dst_bitmap, dst_x, dst_y,
 300                                    font_width, font_height);
 301       }
 302
 303 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
 304       /* use special font tile clipmasks */
 305       {
 306         int font_pos = getFontCharPosition(font_nr, c);
 307
 308         SetClipMask(src_bitmap, font_clip_gc, font->clip_mask[font_pos]);
 309         SetClipOrigin(src_bitmap, font_clip_gc, dst_x, dst_y);
 310       }
 311 #else
 312       SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
 313                     dst_x - src_x, dst_y - src_y);
 314 #endif
 315
 316       BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y,
 317                        font_width, font_height, dst_x, dst_y);
 318     }
 319     else        /* normal, non-masked font blitting */
 320     {
 321       BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y,
 322                  font_width, font_height, dst_x, dst_y);
 323     }
 324
 325     dst_x += font_width;
 326   }
 327 }
 328
 329 void DrawTextToTextArea(int x, int y, char *text, int font_nr,
 330                         int area_xsize, int area_ysize)
 331 {
 332   int area_line = 0;
 333   int font_height = getFontWidth(font_nr);
 334
 335   if (text == NULL)
 336     return;
 337
 338   while (*text && area_line < area_ysize)
 339   {
 340     char buffer[MAX_OUTPUT_LINESIZE + 1];
 341     int i;
 342
 343     for (i=0; i < area_xsize && *text; i++)
 344       if ((buffer[i] = *text++) == '\n')
 345         break;
 346     buffer[i] = '\0';
 347
 348     DrawText(x, y + area_line * font_height, buffer, font_nr);
 349
 350     area_line++;
 351   }
 352 }