Fix narrative_pos_trail_to_offset for runs (use which_run)
[colloquium.git] / libstorycode / narrative_render_cairo.c
1 /*
2  * narrative_render_cairo.c
3  *
4  * Copyright © 2013-2019 Thomas White <taw@bitwiz.org.uk>
5  *
6  * This file is part of Colloquium.
7  *
8  * Colloquium is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20  *
21  */
22
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <cairo.h>
29 #include <cairo-pdf.h>
30 #include <pango/pangocairo.h>
31 #include <assert.h>
32 #include <string.h>
33 #include <stdlib.h>
34 #include <math.h>
35
36 #include <libintl.h>
37 #define _(x) gettext(x)
38
39 #include "slide.h"
40 #include "narrative.h"
41 #include "stylesheet.h"
42 #include "imagestore.h"
43 #include "slide_render_cairo.h"
44 #include "narrative_render_cairo.h"
45 #include "render_cairo_common.h"
46
47 #include "narrative_priv.h"
48
49 const double dummy_h_val = 1024.0;
50
51
52 static double lcalc(struct length l, double pd)
53 {
54         if ( l.unit == LENGTH_UNIT ) {
55                 return l.len;
56         } else {
57                 return l.len * pd;
58         }
59 }
60
61
62 static PangoAlignment to_pangoalignment(enum alignment align)
63 {
64         switch ( align ) {
65                 case ALIGN_LEFT : return PANGO_ALIGN_LEFT;
66                 case ALIGN_RIGHT : return PANGO_ALIGN_RIGHT;
67                 case ALIGN_CENTER : return PANGO_ALIGN_CENTER;
68                 default: return PANGO_ALIGN_LEFT;
69         }
70 }
71
72
73 static void wrap_text(struct narrative_item *item, PangoContext *pc,
74                       Stylesheet *ss, const char *stn, double w,
75                       size_t sel_start, size_t sel_end)
76 {
77         PangoAlignment palignment;
78         PangoRectangle rect;
79         const char *font;
80         PangoFontDescription *fontdesc;
81         enum alignment align;
82         double wrap_w;
83         PangoAttrList *attrs;
84         PangoAttribute *attr;
85         struct colour fgcol;
86         guint16 r, g, b;
87
88         font = stylesheet_get_font(ss, stn, &fgcol, &align);
89         if ( font == NULL ) return;
90         fontdesc = pango_font_description_from_string(font);
91
92         if ( item->align == ALIGN_INHERIT ) {
93                 /* Use value from stylesheet */
94                 palignment = to_pangoalignment(align);
95         } else {
96                 /* Use item-specific value */
97                 palignment = to_pangoalignment(item->align);
98         }
99
100         /* Calculate width of actual text */
101         wrap_w = w - item->space_l - item->space_r;
102
103         /* Set foreground colour */
104         attrs = pango_attr_list_new();
105         r = fgcol.rgba[0] * 65535;
106         g = fgcol.rgba[1] * 65535;
107         b = fgcol.rgba[2] * 65535;
108         attr = pango_attr_foreground_new(r, g, b);
109         pango_attr_list_insert(attrs, attr);
110
111         /* Add attributes for selected text */
112         if ( sel_start > 0 || sel_end > 0 ) {
113                 PangoAttribute *attr;
114                 attr = pango_attr_background_new(42919, 58853, 65535);
115                 attr->start_index = sel_start;
116                 attr->end_index = sel_end;
117                 pango_attr_list_insert(attrs, attr);
118         }
119
120         if ( item->layout == NULL ) {
121                 item->layout = pango_layout_new(pc);
122         }
123         pango_layout_set_width(item->layout, pango_units_from_double(wrap_w));
124         pango_layout_set_alignment(item->layout, palignment);
125         pango_layout_set_font_description(item->layout, fontdesc);
126         pango_layout_set_attributes(item->layout, attrs);
127
128         if ( runs_to_pangolayout(item->layout, item->runs, item->n_runs) ) return;
129
130         pango_layout_get_extents(item->layout, NULL, &rect);
131         item->obj_w = pango_units_to_double(rect.width);
132         item->obj_h = pango_units_to_double(rect.height);
133
134         pango_attr_list_unref(attrs);
135 }
136
137
138 /* Render a thumbnail of the slide */
139 static cairo_surface_t *render_thumbnail(Slide *s, Stylesheet *ss, ImageStore *is,
140                                          int w, int h)
141 {
142         cairo_surface_t *surf;
143         cairo_surface_t *full_surf;
144         cairo_t *cr;
145         double logical_w, logical_h;
146         PangoContext *pc;
147         const int rh = 1024; /* "reasonably big" height for slide */
148         int rw;
149         struct slide_pos sel;
150
151         slide_get_logical_size(s, ss, &logical_w, &logical_h);
152         rw = rh*(logical_w/logical_h);
153
154         sel.para = 0;  sel.pos = 0;  sel.trail = 0;
155
156         /* Render at a reasonably big size.  Rendering to a small surface makes
157          * rounding of text positions (due to font hinting) cause significant
158          * differences between the thumbnail and "normal" rendering. */
159         full_surf = cairo_image_surface_create(CAIRO_FORMAT_RGB24, rw, rh);
160         cr = cairo_create(full_surf);
161         cairo_scale(cr, (double)rw/logical_w, (double)rh/logical_h);
162         pc = pango_cairo_create_context(cr);
163         slide_render_cairo(s, cr, is, ss, 0, pango_language_get_default(), pc,
164                            NULL, sel, sel);
165         g_object_unref(pc);
166         cairo_destroy(cr);
167
168         /* Scale down to the actual size of the thumbnail */
169         surf = cairo_image_surface_create(CAIRO_FORMAT_RGB24, w, h);
170         cr = cairo_create(surf);
171         cairo_scale(cr, (double)w/rw, (double)h/rh);
172         cairo_set_source_surface(cr, full_surf, 0.0, 0.0);
173         cairo_paint(cr);
174         cairo_destroy(cr);
175
176         cairo_surface_destroy(full_surf);
177         return surf;
178 }
179
180
181 static void wrap_slide(struct narrative_item *item, Stylesheet *ss, ImageStore *is, int sel_block)
182 {
183         double w, h;
184
185         slide_get_logical_size(item->slide, ss, &w, &h);
186         item->obj_h = 320.0;  /* Actual height of thumbnail */
187         item->obj_w = rint(item->obj_h*w/h);
188
189         if ( item->slide_thumbnail != NULL ) {
190                 cairo_surface_destroy(item->slide_thumbnail);
191         }
192         item->slide_thumbnail = render_thumbnail(item->slide, ss, is,
193                                                  item->obj_w, item->obj_h);
194         item->selected = sel_block;
195 }
196
197
198 size_t narrative_pos_trail_to_offset(Narrative *n, int i, int offs, int trail)
199 {
200         int run;
201         glong char_offs;
202         char *ptr;
203         size_t run_offs;
204         struct narrative_item *item = &n->items[i];
205         int j;
206         size_t prev_len;
207
208         if ( !narrative_item_is_text(n, i) ) return offs;
209
210         run = which_run(item, offs, &run_offs);
211
212         char_offs = g_utf8_pointer_to_offset(item->runs[run].text,
213                                              item->runs[run].text+run_offs);
214         char_offs += trail;
215         ptr = g_utf8_offset_to_pointer(item->runs[run].text, char_offs);
216
217         prev_len = 0;
218         for ( j=0; j<run; j++ ) prev_len += strlen(item->runs[j].text);
219         return prev_len + ptr - item->runs[run].text;
220 }
221
222
223 static int positions_equal(struct edit_pos a, struct edit_pos b)
224 {
225         if ( a.para != b.para ) return 0;
226         if ( a.pos != b.pos ) return 0;
227         if ( a.trail != b.trail ) return 0;
228         return 1;
229 }
230
231
232 static void sort_positions(struct edit_pos *a, struct edit_pos *b)
233 {
234         if ( a->para > b->para ) {
235                 size_t tpos;
236                 int tpara, ttrail;
237                 tpara = b->para;   tpos = b->pos;  ttrail = b->trail;
238                 b->para = a->para;  b->pos = a->pos;  b->trail = a->trail;
239                 a->para = tpara;    a->pos = tpos;    a->trail = ttrail;
240         }
241
242         if ( (a->para == b->para) && (a->pos > b->pos) )
243         {
244                 size_t tpos = b->pos;
245                 int ttrail = b->trail;
246                 b->pos = a->pos;  b->trail = a->trail;
247                 a->pos = tpos;    a->trail = ttrail;
248         }
249 }
250
251
252 static void wrap_marker(struct narrative_item *item, PangoContext *pc, double w,
253                         int sel_block)
254 {
255         item->obj_w = w - item->space_l - item->space_r;
256         item->obj_h = 20.0;
257         item->selected = sel_block;
258 }
259
260
261 int narrative_wrap_range(Narrative *n, Stylesheet *stylesheet, PangoLanguage *lang,
262                          PangoContext *pc, double w, ImageStore *is,
263                          int min, int max,
264                          struct edit_pos sel_start, struct edit_pos sel_end)
265 {
266         int i;
267         struct length pad[4];
268         int sel_s, sel_e;
269         const char *stn;
270         struct length paraspace[4];
271
272         if ( stylesheet_get_padding(stylesheet, "NARRATIVE", pad) ) return 1;
273         n->space_l = lcalc(pad[0], w);
274         n->space_r = lcalc(pad[1], w);
275         n->space_t = lcalc(pad[2], dummy_h_val);
276         n->space_b = lcalc(pad[3], dummy_h_val);
277
278         n->w = w;
279         w -= n->space_l + n->space_r;
280
281         sort_positions(&sel_start, &sel_end);
282         if ( min < 0 ) min = 0;
283         if ( max >= n->n_items ) max = n->n_items-1;
284
285         if ( !positions_equal(sel_start, sel_end) ) {
286                 sel_s = narrative_pos_trail_to_offset(n, sel_start.para,
287                                                       sel_start.pos, sel_start.trail);
288                 sel_e = narrative_pos_trail_to_offset(n, sel_end.para,
289                                                       sel_end.pos, sel_end.trail);
290         } else {
291                 sel_s = 0;
292                 sel_e = 0;
293         }
294
295         for ( i=min; i<=max; i++ ) {
296
297                 size_t srt, end;
298                 int sel_block = 0;
299
300                 if ( i >= sel_start.para && i <= sel_end.para ) {
301                         if ( i == sel_start.para ) {
302                                 srt = sel_s;
303                         } else {
304                                 srt = 0;
305                         }
306                         if ( i == sel_end.para ) {
307                                 end = sel_e;
308                         } else {
309                                 end = G_MAXUINT;
310                         }
311                         if ( i > sel_start.para && i < sel_end.para ) {
312                                 end = G_MAXUINT;
313                         }
314                         sel_block = 1;
315                 } else {
316                         srt = 0;
317                         end = 0;
318                 }
319
320                 switch ( n->items[i].type ) {
321
322                         case NARRATIVE_ITEM_TEXT :
323                         stn = "NARRATIVE.TEXT";
324                         break;
325
326                         case NARRATIVE_ITEM_BP :
327                         stn = "NARRATIVE.BP";
328                         break;
329
330                         case NARRATIVE_ITEM_PRESTITLE :
331                         stn = "NARRATIVE.PRESTITLE";
332                         break;
333
334                         case NARRATIVE_ITEM_SLIDE :
335                         stn = "NARRATIVE.SLIDE";
336                         break;
337
338                         case NARRATIVE_ITEM_EOP :
339                         stn = "NARRATIVE.EOP";
340                         break;
341
342                         default :
343                         stn = NULL;
344                         break;
345                 }
346
347                 if ( stylesheet_get_paraspace(stylesheet, stn, paraspace) == 0 ) {
348                         n->items[i].space_l = lcalc(paraspace[0], w);
349                         n->items[i].space_r = lcalc(paraspace[1], w);
350                         n->items[i].space_t = lcalc(paraspace[2], dummy_h_val);
351                         n->items[i].space_b = lcalc(paraspace[3], dummy_h_val);
352                 }
353
354                 switch ( n->items[i].type ) {
355
356                         case NARRATIVE_ITEM_TEXT :
357                         case NARRATIVE_ITEM_BP :
358                         case NARRATIVE_ITEM_PRESTITLE :
359                         wrap_text(&n->items[i], pc, stylesheet,
360                                   stn, w, srt, end);
361                         break;
362
363                         case NARRATIVE_ITEM_SLIDE :
364                         wrap_slide(&n->items[i], stylesheet, is, sel_block);
365                         break;
366
367                         case NARRATIVE_ITEM_EOP :
368                         wrap_marker(&n->items[i], pc, w, sel_block);
369                         break;
370                 }
371         }
372
373         return 0;
374 }
375
376
377 double narrative_item_get_height(Narrative *n, int i)
378 {
379         return n->items[i].obj_h + n->items[i].space_t + n->items[i].space_b;
380 }
381
382
383 double narrative_get_height(Narrative *n)
384 {
385         int i;
386         double total = 0.0;
387         for ( i=0; i<n->n_items; i++ ) {
388                 total += narrative_item_get_height(n, i);
389         }
390         return total + n->space_t + n->space_b;
391 }
392
393
394 static void draw_slide(struct narrative_item *item, cairo_t *cr)
395 {
396         double x, y;
397
398         cairo_save(cr);
399         cairo_translate(cr, item->space_l, item->space_t);
400
401         x = 0.0;  y = 0.0;
402         cairo_user_to_device(cr, &x, &y);
403         x = rint(x);  y = rint(y);
404         cairo_device_to_user(cr, &x, &y);
405
406         if ( item->selected ) {
407                 cairo_rectangle(cr, x-5.0, y-5.0, item->obj_w+10.0, item->obj_h+10.0);
408                 cairo_set_source_rgb(cr, 0.655, 0.899, 1.0);
409                 cairo_fill(cr);
410         }
411
412         cairo_rectangle(cr, x, y, item->obj_w, item->obj_h);
413         cairo_set_source_surface(cr, item->slide_thumbnail, 0.0, 0.0);
414         cairo_fill(cr);
415
416         cairo_rectangle(cr, x+0.5, y+0.5, item->obj_w, item->obj_h);
417         cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
418         cairo_set_line_width(cr, 1.0);
419         cairo_stroke(cr);
420
421         cairo_restore(cr);
422 }
423
424
425 static void draw_marker(struct narrative_item *item, cairo_t *cr)
426 {
427         double x, y;
428         PangoLayout *layout;
429         PangoFontDescription *fontdesc;
430
431         cairo_save(cr);
432         cairo_translate(cr, item->space_l, item->space_t);
433
434         x = 0.0;  y = 0.0;
435         cairo_user_to_device(cr, &x, &y);
436         x = rint(x);  y = rint(y);
437         cairo_device_to_user(cr, &x, &y);
438
439         if ( item->selected ) {
440                 cairo_rectangle(cr, x-5.0, y-5.0, item->obj_w+10.0, item->obj_h+10.0);
441                 cairo_set_source_rgb(cr, 0.655, 0.899, 1.0);
442                 cairo_fill(cr);
443         }
444
445         cairo_rectangle(cr, x, y, item->obj_w, item->obj_h);
446         cairo_set_source_rgb(cr, 0.8, 0.0, 0.0);
447         cairo_fill(cr);
448
449         layout = pango_cairo_create_layout(cr);
450         pango_layout_set_text(layout, _("End of presentation"), -1);
451
452         fontdesc = pango_font_description_new();
453         pango_font_description_set_family_static(fontdesc, "Sans");
454         pango_font_description_set_style(fontdesc, PANGO_STYLE_ITALIC);
455         pango_font_description_set_absolute_size(fontdesc, 0.9*item->obj_h*PANGO_SCALE);
456         pango_layout_set_font_description(layout, fontdesc);
457         pango_layout_set_alignment(layout, PANGO_ALIGN_CENTER);
458         pango_layout_set_width(layout, item->obj_w*PANGO_SCALE);
459
460         cairo_move_to(cr, 0.0, 0.0);
461         cairo_set_source_rgb(cr, 1.0, 1.0, 1.0);
462         pango_cairo_update_layout(cr, layout);
463         pango_cairo_show_layout(cr, layout);
464         cairo_fill(cr);
465
466         g_object_unref(layout);
467         pango_font_description_free(fontdesc);
468
469         cairo_restore(cr);
470 }
471
472
473 static void draw_text(struct narrative_item *item, cairo_t *cr)
474 {
475         if ( item->layout == NULL ) return;
476
477         cairo_save(cr);
478         cairo_translate(cr, item->space_l, item->space_t);
479
480         //if ( (hpos + cur_h > min_y) && (hpos < max_y) ) {
481                 cairo_set_source_rgba(cr, 0.0, 0.0, 0.0, 1.0);
482                 pango_cairo_update_layout(cr, item->layout);
483                 pango_cairo_show_layout(cr, item->layout);
484                 cairo_fill(cr);
485         //} /* else paragraph is not visible */
486
487         cairo_restore(cr);
488 }
489
490
491 int narrative_render_item_cairo(Narrative*n, cairo_t *cr, int i)
492 {
493         switch ( n->items[i].type ) {
494
495                 case NARRATIVE_ITEM_TEXT :
496                 case NARRATIVE_ITEM_PRESTITLE :
497                 draw_text(&n->items[i], cr);
498                 break;
499
500                 case NARRATIVE_ITEM_BP :
501                 draw_text(&n->items[i], cr);
502                 break;
503
504                 case NARRATIVE_ITEM_SLIDE :
505                 draw_slide(&n->items[i], cr);
506                 break;
507
508                 case NARRATIVE_ITEM_EOP :
509                 draw_marker(&n->items[i], cr);
510                 break;
511
512         }
513
514         return 0;
515 }
516
517
518 /* NB You must first call narrative_wrap() */
519 int narrative_render_cairo(Narrative *n, cairo_t *cr, Stylesheet *stylesheet)
520 {
521         int i, r;
522         enum gradient bg;
523         struct colour bgcol;
524         struct colour bgcol2;
525         cairo_pattern_t *patt = NULL;
526
527         r = stylesheet_get_background(stylesheet, "NARRATIVE", &bg, &bgcol, &bgcol2);
528         if ( r ) return 1;
529
530         /* Overall background */
531         cairo_rectangle(cr, 0.0, 0.0, n->w, narrative_get_height(n));
532         switch ( bg ) {
533
534                 case GRAD_NONE:
535                 cairo_set_source_rgb(cr, bgcol.rgba[0], bgcol.rgba[1], bgcol.rgba[2]);
536                 break;
537
538                 case GRAD_VERT:
539                 patt = cairo_pattern_create_linear(0.0, 0.0, 0.0, narrative_get_height(n));
540                 cairo_pattern_add_color_stop_rgb(patt, 0.0,
541                                                  bgcol.rgba[0], bgcol.rgba[1], bgcol.rgba[2]);
542                 cairo_pattern_add_color_stop_rgb(patt, 1.0,
543                                                  bgcol2.rgba[0], bgcol2.rgba[1], bgcol2.rgba[2]);
544                 cairo_set_source(cr, patt);
545                 break;
546
547                 case GRAD_HORIZ:
548                 patt = cairo_pattern_create_linear(0.0, 0.0, n->w, 0.0);
549                 cairo_pattern_add_color_stop_rgb(patt, 0.0,
550                                                  bgcol.rgba[0], bgcol.rgba[1], bgcol.rgba[2]);
551                 cairo_pattern_add_color_stop_rgb(patt, 1.0,
552                                                  bgcol2.rgba[0], bgcol2.rgba[1], bgcol2.rgba[2]);
553                 cairo_set_source(cr, patt);
554                 break;
555
556         }
557         cairo_fill(cr);
558
559         cairo_save(cr);
560         cairo_translate(cr, n->space_l, n->space_t);
561
562         for ( i=0; i<n->n_items; i++ ) {
563                 narrative_render_item_cairo(n, cr, i);
564                 cairo_translate(cr, 0.0, narrative_item_get_height(n, i));
565         }
566
567         cairo_restore(cr);
568
569         return 0;
570 }