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