drawing.c

   1 /*
   2  * drawing.c: Intermediary between the drawing interface as
   3  * presented to the back end, and that implemented by the front
   4  * end.
   5  *
   6  * Mostly just looks up calls in a vtable and passes them through
   7  * unchanged. However, on the printing side it tracks print colours
   8  * so the front end API doesn't have to.
   9  *
  10  * FIXME:
  11  *
  12  *  - I'd _like_ to do automatic draw_updates, but it's a pain for
  13  *    draw_text in particular. I'd have to invent a front end API
  14  *    which retrieved the text bounds.
  15  *     + that might allow me to do the alignment centrally as well?
  16  *        * perhaps not, because PS can't return this information,
  17  *          so there would have to be a special case for it.
  18  *     + however, that at least doesn't stand in the way of using
  19  *       the text bounds for draw_update, because PS doesn't need
  20  *       draw_update since it's printing-only. Any _interactive_
  21  *       drawing API couldn't get away with refusing to tell you
  22  *       what parts of the screen a text draw had covered, because
  23  *       you would inevitably need to erase it later on.
  24  */
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <assert.h>
  30 #include <math.h>
  31
  32 #include "puzzles.h"
  33
  34 struct print_colour {
  35     int hatch;
  36     int hatch_when;                    /* 0=never 1=only-in-b&w 2=always */
  37     float r, g, b;
  38     float grey;
  39 };
  40
  41 struct drawing {
  42     const drawing_api *api;
  43     void *handle;
  44     struct print_colour *colours;
  45     int ncolours, coloursize;
  46     float scale;
  47     /* `me' is only used in status_bar(), so print-oriented instances of
  48      * this may set it to NULL. */
  49     midend *me;
  50     char *laststatus;
  51 };
  52
  53 drawing *drawing_new(const drawing_api *api, midend *me, void *handle)
  54 {
  55     drawing *dr = snew(drawing);
  56     dr->api = api;
  57     dr->handle = handle;
  58     dr->colours = NULL;
  59     dr->ncolours = dr->coloursize = 0;
  60     dr->scale = 1.0F;
  61     dr->me = me;
  62     dr->laststatus = NULL;
  63     return dr;
  64 }
  65
  66 void drawing_free(drawing *dr)
  67 {
  68     sfree(dr->laststatus);
  69     sfree(dr->colours);
  70     sfree(dr);
  71 }
  72
  73 void draw_text(drawing *dr, int x, int y, int fonttype, int fontsize,
  74                int align, int colour, char *text)
  75 {
  76     dr->api->draw_text(dr->handle, x, y, fonttype, fontsize, align,
  77                        colour, text);
  78 }
  79
  80 void draw_rect(drawing *dr, int x, int y, int w, int h, int colour)
  81 {
  82     dr->api->draw_rect(dr->handle, x, y, w, h, colour);
  83 }
  84
  85 void draw_line(drawing *dr, int x1, int y1, int x2, int y2, int colour)
  86 {
  87     dr->api->draw_line(dr->handle, x1, y1, x2, y2, colour);
  88 }
  89
  90 void draw_polygon(drawing *dr, int *coords, int npoints,
  91                   int fillcolour, int outlinecolour)
  92 {
  93     dr->api->draw_polygon(dr->handle, coords, npoints, fillcolour,
  94                           outlinecolour);
  95 }
  96
  97 void draw_circle(drawing *dr, int cx, int cy, int radius,
  98                  int fillcolour, int outlinecolour)
  99 {
 100     dr->api->draw_circle(dr->handle, cx, cy, radius, fillcolour,
 101                          outlinecolour);
 102 }
 103
 104 void draw_update(drawing *dr, int x, int y, int w, int h)
 105 {
 106     if (dr->api->draw_update)
 107         dr->api->draw_update(dr->handle, x, y, w, h);
 108 }
 109
 110 void clip(drawing *dr, int x, int y, int w, int h)
 111 {
 112     dr->api->clip(dr->handle, x, y, w, h);
 113 }
 114
 115 void unclip(drawing *dr)
 116 {
 117     dr->api->unclip(dr->handle);
 118 }
 119
 120 void start_draw(drawing *dr)
 121 {
 122     dr->api->start_draw(dr->handle);
 123 }
 124
 125 void end_draw(drawing *dr)
 126 {
 127     dr->api->end_draw(dr->handle);
 128 }
 129
 130 char *text_fallback(drawing *dr, const char *const *strings, int nstrings)
 131 {
 132     int i;
 133
 134     /*
 135      * If the drawing implementation provides one of these, use it.
 136      */
 137     if (dr && dr->api->text_fallback)
 138         return dr->api->text_fallback(dr->handle, strings, nstrings);
 139
 140     /*
 141      * Otherwise, do the simple thing and just pick the first string
 142      * that fits in plain ASCII. It will then need no translation
 143      * out of UTF-8.
 144      */
 145     for (i = 0; i < nstrings; i++) {
 146         const char *p;
 147
 148         for (p = strings[i]; *p; p++)
 149             if (*p & 0x80)
 150                 break;
 151         if (!*p)
 152             return dupstr(strings[i]);
 153     }
 154
 155     /*
 156      * The caller was responsible for making sure _some_ string in
 157      * the list was in plain ASCII.
 158      */
 159     assert(!"Should never get here");
 160     return NULL;                       /* placate optimiser */
 161 }
 162
 163 void status_bar(drawing *dr, char *text)
 164 {
 165     char *rewritten;
 166
 167     if (!dr->api->status_bar)
 168         return;
 169
 170     assert(dr->me);
 171
 172     rewritten = midend_rewrite_statusbar(dr->me, text);
 173     if (!dr->laststatus || strcmp(rewritten, dr->laststatus)) {
 174         dr->api->status_bar(dr->handle, rewritten);
 175         sfree(dr->laststatus);
 176         dr->laststatus = rewritten;
 177     } else {
 178         sfree(rewritten);
 179     }
 180 }
 181
 182 blitter *blitter_new(drawing *dr, int w, int h)
 183 {
 184     return dr->api->blitter_new(dr->handle, w, h);
 185 }
 186
 187 void blitter_free(drawing *dr, blitter *bl)
 188 {
 189     dr->api->blitter_free(dr->handle, bl);
 190 }
 191
 192 void blitter_save(drawing *dr, blitter *bl, int x, int y)
 193 {
 194     dr->api->blitter_save(dr->handle, bl, x, y);
 195 }
 196
 197 void blitter_load(drawing *dr, blitter *bl, int x, int y)
 198 {
 199     dr->api->blitter_load(dr->handle, bl, x, y);
 200 }
 201
 202 void print_begin_doc(drawing *dr, int pages)
 203 {
 204     dr->api->begin_doc(dr->handle, pages);
 205 }
 206
 207 void print_begin_page(drawing *dr, int number)
 208 {
 209     dr->api->begin_page(dr->handle, number);
 210 }
 211
 212 void print_begin_puzzle(drawing *dr, float xm, float xc,
 213                         float ym, float yc, int pw, int ph, float wmm,
 214                         float scale)
 215 {
 216     dr->scale = scale;
 217     dr->ncolours = 0;
 218     dr->api->begin_puzzle(dr->handle, xm, xc, ym, yc, pw, ph, wmm);
 219 }
 220
 221 void print_end_puzzle(drawing *dr)
 222 {
 223     dr->api->end_puzzle(dr->handle);
 224     dr->scale = 1.0F;
 225 }
 226
 227 void print_end_page(drawing *dr, int number)
 228 {
 229     dr->api->end_page(dr->handle, number);
 230 }
 231
 232 void print_end_doc(drawing *dr)
 233 {
 234     dr->api->end_doc(dr->handle);
 235 }
 236
 237 void print_get_colour(drawing *dr, int colour, int printing_in_colour,
 238                       int *hatch, float *r, float *g, float *b)
 239 {
 240     assert(colour >= 0 && colour < dr->ncolours);
 241     if (dr->colours[colour].hatch_when == 2 ||
 242         (dr->colours[colour].hatch_when == 1 && !printing_in_colour)) {
 243         *hatch = dr->colours[colour].hatch;
 244     } else {
 245         *hatch = -1;
 246         if (printing_in_colour) {
 247             *r = dr->colours[colour].r;
 248             *g = dr->colours[colour].g;
 249             *b = dr->colours[colour].b;
 250         } else {
 251             *r = *g = *b = dr->colours[colour].grey;
 252         }
 253     }
 254 }
 255
 256 static int print_generic_colour(drawing *dr, float r, float g, float b,
 257                                 float grey, int hatch, int hatch_when)
 258 {
 259     if (dr->ncolours >= dr->coloursize) {
 260         dr->coloursize = dr->ncolours + 16;
 261         dr->colours = sresize(dr->colours, dr->coloursize,
 262                               struct print_colour);
 263     }
 264     dr->colours[dr->ncolours].hatch = hatch;
 265     dr->colours[dr->ncolours].hatch_when = hatch_when;
 266     dr->colours[dr->ncolours].r = r;
 267     dr->colours[dr->ncolours].g = g;
 268     dr->colours[dr->ncolours].b = b;
 269     dr->colours[dr->ncolours].grey = grey;
 270     return dr->ncolours++;
 271 }
 272
 273 int print_mono_colour(drawing *dr, int grey)
 274 {
 275     return print_generic_colour(dr, grey, grey, grey, grey, -1, 0);
 276 }
 277
 278 int print_grey_colour(drawing *dr, float grey)
 279 {
 280     return print_generic_colour(dr, grey, grey, grey, grey, -1, 0);
 281 }
 282
 283 int print_hatched_colour(drawing *dr, int hatch)
 284 {
 285     return print_generic_colour(dr, 0, 0, 0, 0, hatch, 2);
 286 }
 287
 288 int print_rgb_mono_colour(drawing *dr, float r, float g, float b, int grey)
 289 {
 290     return print_generic_colour(dr, r, g, b, grey, -1, 0);
 291 }
 292
 293 int print_rgb_grey_colour(drawing *dr, float r, float g, float b, float grey)
 294 {
 295     return print_generic_colour(dr, r, g, b, grey, -1, 0);
 296 }
 297
 298 int print_rgb_hatched_colour(drawing *dr, float r, float g, float b, int hatch)
 299 {
 300     return print_generic_colour(dr, r, g, b, 0, hatch, 1);
 301 }
 302
 303 void print_line_width(drawing *dr, int width)
 304 {
 305     /*
 306      * I don't think it's entirely sensible to have line widths be
 307      * entirely relative to the puzzle size; there is a point
 308      * beyond which lines are just _stupidly_ thick. On the other
 309      * hand, absolute line widths aren't particularly nice either
 310      * because they start to feel a bit feeble at really large
 311      * scales.
 312      *
 313      * My experimental answer is to scale line widths as the
 314      * _square root_ of the main puzzle scale. Double the puzzle
 315      * size, and the line width multiplies by 1.4.
 316      */
 317     dr->api->line_width(dr->handle, (float)sqrt(dr->scale) * width);
 318 }
 319
 320 void print_line_dotted(drawing *dr, int dotted)
 321 {
 322     dr->api->line_dotted(dr->handle, dotted);
 323 }