890741a3f904725f1a7adb99482a5d5f31a1ae85
[pspp] / src / output / render.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2009, 2010, 2011, 2013, 2014, 2016 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include <math.h>
20 #include <stdio.h>
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include "libpspp/assertion.h"
26 #include "libpspp/hash-functions.h"
27 #include "libpspp/hmap.h"
28 #include "libpspp/pool.h"
29 #include "output/render.h"
30 #include "output/table-item.h"
31 #include "output/table.h"
32
33 #include "gl/minmax.h"
34 #include "gl/xalloc.h"
35
36 #include "gettext.h"
37 #define _(msgid) gettext (msgid)
38
39 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
40 #define H TABLE_HORZ
41 #define V TABLE_VERT
42 \f
43 /* A layout for rendering a specific table on a specific device.
44
45    May represent the layout of an entire table presented to
46    render_page_create(), or a rectangular subregion of a table broken out using
47    render_break_next() to allow a table to be broken across multiple pages.
48
49    A page's size is not limited to the size passed in as part of render_params.
50    render_pager breaks a render_page into smaller render_pages that will fit in
51    the available space. */
52 struct render_page
53   {
54     const struct render_params *params; /* Parameters of the target device. */
55     struct table *table;                /* Table rendered. */
56     int ref_cnt;
57
58     /* Region of 'table' to render.
59
60        The horizontal cells rendered are the leftmost h[H][0], then
61        r[H][0] through r[H][1], exclusive, then the rightmost h[H][1].
62
63        The vertical cells rendered are the topmost h[V][0], then r[V][0]
64        through r[V][1], exclusive, then the bottommost h[V][1].
65
66        n[H] = h[H][0] + (r[H][1] - r[H][0]) + h[H][1]
67        n[V] = h[V][0] + (r[V][1] - r[V][0]) + h[V][1]
68     */
69     int h[TABLE_N_AXES][2];
70     int r[TABLE_N_AXES][2];
71     int n[TABLE_N_AXES];
72
73     /* "Cell positions".
74
75        cp[H] represents x positions within the table.
76        cp[H][0] = 0.
77        cp[H][1] = the width of the leftmost vertical rule.
78        cp[H][2] = cp[H][1] + the width of the leftmost column.
79        cp[H][3] = cp[H][2] + the width of the second-from-left vertical rule.
80        and so on:
81        cp[H][2 * nc] = x position of the rightmost vertical rule.
82        cp[H][2 * nc + 1] = total table width including all rules.
83
84        Similarly, cp[V] represents y positions within the table.
85        cp[V][0] = 0.
86        cp[V][1] = the height of the topmost horizontal rule.
87        cp[V][2] = cp[V][1] + the height of the topmost row.
88        cp[V][3] = cp[V][2] + the height of the second-from-top horizontal rule.
89        and so on:
90        cp[V][2 * nr] = y position of the bottommost horizontal rule.
91        cp[V][2 * nr + 1] = total table height including all rules.
92
93        Rules and columns can have width or height 0, in which case consecutive
94        values in this array are equal. */
95     int *cp[TABLE_N_AXES];
96
97     /* render_break_next() can break a table such that some cells are not fully
98        contained within a render_page.  This will happen if a cell is too wide
99        or two tall to fit on a single page, or if a cell spans multiple rows or
100        columns and the page only includes some of those rows or columns.
101
102        This hash table contains "struct render_overflow"s that represents each
103        such cell that doesn't completely fit on this page.
104
105        Each overflow cell borders at least one header edge of the table and may
106        border more.  (A single table cell that is so large that it fills the
107        entire page can overflow on all four sides!) */
108     struct hmap overflows;
109
110     /* If a single column (or row) is too wide (or tall) to fit on a page
111        reasonably, then render_break_next() will split a single row or column
112        across multiple render_pages.  This member indicates when this has
113        happened:
114
115        is_edge_cutoff[H][0] is true if pixels have been cut off the left side
116        of the leftmost column in this page, and false otherwise.
117
118        is_edge_cutoff[H][1] is true if pixels have been cut off the right side
119        of the rightmost column in this page, and false otherwise.
120
121        is_edge_cutoff[V][0] and is_edge_cutoff[V][1] are similar for the top
122        and bottom of the table.
123
124        The effect of is_edge_cutoff is to prevent rules along the edge in
125        question from being rendered.
126
127        When is_edge_cutoff is true for a given edge, the 'overflows' hmap will
128        contain a node for each cell along that edge. */
129     bool is_edge_cutoff[TABLE_N_AXES][2];
130
131     /* If part of a joined cell would be cut off by breaking a table along
132        'axis' at the rule with offset 'z' (where 0 <= z <= n[axis]), then
133        join_crossing[axis][z] is the thickness of the rule that would be cut
134        off.
135
136        This is used to know to allocate extra space for breaking at such a
137        position, so that part of the cell's content is not lost.
138
139        This affects breaking a table only when headers are present.  When
140        headers are not present, the rule's thickness is used for cell content,
141        so no part of the cell's content is lost (and in fact it is duplicated
142        across both pages). */
143     int *join_crossing[TABLE_N_AXES];
144   };
145
146 static struct render_page *render_page_create (const struct render_params *,
147                                                struct table *, int min_width);
148
149 struct render_page *render_page_ref (const struct render_page *page_);
150 static void render_page_unref (struct render_page *);
151
152 /* Returns the offset in struct render_page's cp[axis] array of the rule with
153    index RULE_IDX.  That is, if RULE_IDX is 0, then the offset is that of the
154    leftmost or topmost rule; if RULE_IDX is 1, then the offset is that of the
155    next rule to the right (or below); and so on. */
156 static int
157 rule_ofs (int rule_idx)
158 {
159   return rule_idx * 2;
160 }
161
162 /* Returns the offset in struct render_page's cp[axis] array of the rule with
163    index RULE_IDX_R, which counts from the right side (or bottom) of the page
164    left (or up), according to whether AXIS is H or V, respectively.  That is,
165    if RULE_IDX_R is 0, then the offset is that of the rightmost or bottommost
166    rule; if RULE_IDX is 1, then the offset is that of the next rule to the left
167    (or above); and so on. */
168 static int
169 rule_ofs_r (const struct render_page *page, int axis, int rule_idx_r)
170 {
171   return (page->n[axis] - rule_idx_r) * 2;
172 }
173
174 /* Returns the offset in struct render_page's cp[axis] array of the cell with
175    index CELL_IDX.  That is, if CELL_IDX is 0, then the offset is that of the
176    leftmost or topmost cell; if CELL_IDX is 1, then the offset is that of the
177    next cell to the right (or below); and so on. */
178 static int
179 cell_ofs (int cell_idx)
180 {
181   return cell_idx * 2 + 1;
182 }
183
184 /* Returns the width of PAGE along AXIS from OFS0 to OFS1, exclusive. */
185 static int
186 axis_width (const struct render_page *page, int axis, int ofs0, int ofs1)
187 {
188   return page->cp[axis][ofs1] - page->cp[axis][ofs0];
189 }
190
191 /* Returns the width of the headers in PAGE along AXIS. */
192 static int
193 headers_width (const struct render_page *page, int axis)
194 {
195   int h0 = page->h[axis][0];
196   int w0 = axis_width (page, axis, rule_ofs (0), cell_ofs (h0));
197   int n = page->n[axis];
198   int h1 = page->h[axis][1];
199   int w1 = axis_width (page, axis, rule_ofs_r (page, axis, h1), cell_ofs (n));
200   return w0 + w1;
201 }
202
203 /* Returns the width of cell X along AXIS in PAGE. */
204 static int
205 cell_width (const struct render_page *page, int axis, int x)
206 {
207   return axis_width (page, axis, cell_ofs (x), cell_ofs (x) + 1);
208 }
209
210 /* Returns the width of rule X along AXIS in PAGE. */
211 static int
212 rule_width (const struct render_page *page, int axis, int x)
213 {
214   return axis_width (page, axis, rule_ofs (x), rule_ofs (x) + 1);
215 }
216
217 /* Returns the width of rule X along AXIS in PAGE. */
218 static int
219 rule_width_r (const struct render_page *page, int axis, int x)
220 {
221   int ofs = rule_ofs_r (page, axis, x);
222   return axis_width (page, axis, ofs, ofs + 1);
223 }
224
225 /* Returns the width of cells X0 through X1, exclusive, along AXIS in PAGE. */
226 static int
227 joined_width (const struct render_page *page, int axis, int x0, int x1)
228 {
229   return axis_width (page, axis, cell_ofs (x0), cell_ofs (x1) - 1);
230 }
231
232 /* Returns the width of the widest cell, excluding headers, along AXIS in
233    PAGE. */
234 static int
235 max_cell_width (const struct render_page *page, int axis)
236 {
237   int n = page->n[axis];
238   int x0 = page->h[axis][0];
239   int x1 = n - page->h[axis][1];
240
241   int max = 0;
242   for (int x = x0; x < x1; x++)
243     {
244       int w = cell_width (page, axis, x);
245       if (w > max)
246         max = w;
247     }
248   return max;
249 }
250 \f
251 /* A cell that doesn't completely fit on the render_page. */
252 struct render_overflow
253   {
254     struct hmap_node node;      /* In render_page's 'overflows' hmap. */
255
256     /* Occupied region of page.
257
258        d[H][0] is the leftmost column.
259        d[H][1] is the rightmost column, plus 1.
260        d[V][0] is the top row.
261        d[V][1] is the bottom row, plus 1.
262
263        The cell in its original table might occupy a larger region.  This
264        member reflects the size of the cell in the current render_page, after
265        trimming off any rows or columns due to page-breaking. */
266     int d[TABLE_N_AXES];
267
268     /* The space that has been trimmed off the cell:
269
270        overflow[H][0]: space trimmed off its left side.
271        overflow[H][1]: space trimmed off its right side.
272        overflow[V][0]: space trimmed off its top.
273        overflow[V][1]: space trimmed off its bottom.
274
275        During rendering, this information is used to position the rendered
276        portion of the cell within the available space.
277
278        When a cell is rendered, sometimes it is permitted to spill over into
279        space that is ordinarily reserved for rules.  Either way, this space is
280        still included in overflow values.
281
282        Suppose, for example, that a cell that joins 2 columns has a width of 60
283        pixels and content "abcdef", that the 2 columns that it joins have
284        widths of 20 and 30 pixels, respectively, and that therefore the rule
285        between the two joined columns has a width of 10 (20 + 10 + 30 = 60).
286        It might render like this, if each character is 10x10, and showing a few
287        extra table cells for context:
288
289                                      +------+
290                                      |abcdef|
291                                      +--+---+
292                                      |gh|ijk|
293                                      +--+---+
294
295        If this render_page is broken at the rule that separates "gh" from
296        "ijk", then the page that contains the left side of the "abcdef" cell
297        will have overflow[H][1] of 10 + 30 = 40 for its portion of the cell,
298        and the page that contains the right side of the cell will have
299        overflow[H][0] of 20 + 10 = 30.  The two resulting pages would look like
300        this:
301
302
303                                        +---
304                                        |abc
305                                        +--+
306                                        |gh|
307                                        +--+
308
309        and:
310
311                                        ----+
312                                        cdef|
313                                        +---+
314                                        |ijk|
315                                        +---+
316     */
317     int overflow[TABLE_N_AXES][2];
318   };
319
320 /* Returns a hash value for (,Y). */
321 static unsigned int
322 hash_cell (int x, int y)
323 {
324   return hash_int (x + (y << 16), 0);
325 }
326
327 /* Searches PAGE's set of render_overflow for one whose top-left cell is
328    (X,Y).  Returns it, if there is one, otherwise a null pointer. */
329 static const struct render_overflow *
330 find_overflow (const struct render_page *page, int x, int y)
331 {
332   if (!hmap_is_empty (&page->overflows))
333     {
334       const struct render_overflow *of;
335
336       HMAP_FOR_EACH_WITH_HASH (of, struct render_overflow, node,
337                                hash_cell (x, y), &page->overflows)
338         if (x == of->d[H] && y == of->d[V])
339           return of;
340     }
341
342   return NULL;
343 }
344 \f
345 /* Row or column dimensions.  Used to figure the size of a table in
346    render_page_create() and discarded after that. */
347 struct render_row
348   {
349     /* Width without considering rows (or columns) that span more than one (or
350        column). */
351     int unspanned;
352
353     /* Width taking spanned rows (or columns) into consideration. */
354     int width;
355   };
356
357 /* Modifies the 'width' members of the N elements of ROWS so that their sum,
358    when added to rule widths RULES[1] through RULES[N - 1] inclusive, is at
359    least WIDTH. */
360 static void
361 distribute_spanned_width (int width,
362                           struct render_row *rows, const int *rules, int n)
363 {
364   /* Sum up the unspanned widths of the N rows for use as weights. */
365   int total_unspanned = 0;
366   for (int x = 0; x < n; x++)
367     total_unspanned += rows[x].unspanned;
368   for (int x = 0; x < n - 1; x++)
369     total_unspanned += rules[x + 1];
370   if (total_unspanned >= width)
371     return;
372
373   /* The algorithm used here is based on the following description from HTML 4:
374
375          For cells that span multiple columns, a simple approach consists of
376          apportioning the min/max widths evenly to each of the constituent
377          columns.  A slightly more complex approach is to use the min/max
378          widths of unspanned cells to weight how spanned widths are
379          apportioned.  Experiments suggest that a blend of the two approaches
380          gives good results for a wide range of tables.
381
382      We blend the two approaches half-and-half, except that we cannot use the
383      unspanned weights when 'total_unspanned' is 0 (because that would cause a
384      division by zero).
385
386      The calculation we want to do is this:
387
388         w0 = width / n
389         w1 = width * (column's unspanned width) / (total unspanned width)
390         (column's width) = (w0 + w1) / 2
391
392      We implement it as a precise calculation in integers by multiplying w0 and
393      w1 by the common denominator of all three calculations (d), dividing that
394      out in the column width calculation, and then keeping the remainder for
395      the next iteration.
396
397      (We actually compute the unspanned width of a column as twice the
398      unspanned width, plus the width of the rule on the left, plus the width of
399      the rule on the right.  That way each rule contributes to both the cell on
400      its left and on its right.)
401   */
402   long long int d0 = n;
403   long long int d1 = 2LL * MAX (total_unspanned, 1);
404   long long int d = d0 * d1;
405   if (total_unspanned > 0)
406     d *= 2;
407   long long int w = d / 2;
408   for (int x = 0; x < n; x++)
409     {
410       w += width * d1;
411       if (total_unspanned > 0)
412         {
413           long long int unspanned = rows[x].unspanned * 2LL;
414           if (x < n - 1)
415             unspanned += rules[x + 1];
416           if (x > 0)
417             unspanned += rules[x];
418           w += width * unspanned * d0;
419         }
420
421       rows[x].width = MAX (rows[x].width, w / d);
422       w -= rows[x].width * d;
423     }
424 }
425
426 /* Initializes PAGE->cp[AXIS] from the row widths in ROWS and the rule widths
427    in RULES. */
428 static void
429 accumulate_row_widths (const struct render_page *page, enum table_axis axis,
430                        const struct render_row *rows, const int *rules)
431 {
432   int n = page->n[axis];
433   int *cp = page->cp[axis];
434   cp[0] = 0;
435   for (int z = 0; z < n; z++)
436     {
437       cp[1] = cp[0] + rules[z];
438       cp[2] = cp[1] + rows[z].width;
439       cp += 2;
440     }
441   cp[1] = cp[0] + rules[n];
442 }
443
444 /* Returns the sum of widths of the N ROWS and N+1 RULES. */
445 static int
446 calculate_table_width (int n, const struct render_row *rows, int *rules)
447 {
448   int width = 0;
449   for (int x = 0; x < n; x++)
450     width += rows[x].width;
451   for (int x = 0; x <= n; x++)
452     width += rules[x];
453
454   return width;
455 }
456 \f
457 /* Rendering utility functions. */
458
459 /* Returns the line style to use for drawing a rule of the given TYPE. */
460 static enum render_line_style
461 rule_to_render_type (unsigned char type)
462 {
463   switch (type)
464     {
465     case TABLE_STROKE_NONE:
466       return RENDER_LINE_NONE;
467     case TABLE_STROKE_SOLID:
468       return RENDER_LINE_SINGLE;
469     case TABLE_STROKE_DASHED:
470       return RENDER_LINE_DASHED;
471     case TABLE_STROKE_THICK:
472       return RENDER_LINE_THICK;
473     case TABLE_STROKE_THIN:
474       return RENDER_LINE_THIN;
475     case TABLE_STROKE_DOUBLE:
476       return RENDER_LINE_DOUBLE;
477     default:
478       NOT_REACHED ();
479     }
480 }
481
482 /* Returns the width of the rule in TABLE that is at offset Z along axis A, if
483    rendered with PARAMS.  */
484 static int
485 measure_rule (const struct render_params *params, const struct table *table,
486               enum table_axis a, int z)
487 {
488   enum table_axis b = !a;
489
490   /* Determine all types of rules that are present, as a bitmap in 'rules'
491      where rule type 't' is present if bit 2**t is set. */
492   struct cell_color color;
493   unsigned int rules = 0;
494   int d[TABLE_N_AXES];
495   d[a] = z;
496   for (d[b] = 0; d[b] < table->n[b]; d[b]++)
497     rules |= 1u << table_get_rule (table, a, d[H], d[V], &color);
498
499   /* Turn off TABLE_STROKE_NONE because it has width 0 and we needn't bother.
500      However, if the device doesn't support margins, make sure that there is at
501      least a small gap between cells (but we don't need any at the left or
502      right edge of the table). */
503   if (rules & (1u << TABLE_STROKE_NONE))
504     {
505       rules &= ~(1u << TABLE_STROKE_NONE);
506       if (z > 0 && z < table->n[a] && !params->supports_margins && a == H)
507         rules |= 1u << TABLE_STROKE_SOLID;
508     }
509
510   /* Calculate maximum width of the rules that are present. */
511   int width = 0;
512   for (size_t i = 0; i < TABLE_N_STROKES; i++)
513     if (rules & (1u << i))
514       width = MAX (width, params->line_widths[a][rule_to_render_type (i)]);
515   return width;
516 }
517
518 /* Allocates and returns a new render_page using PARAMS and TABLE.  Allocates
519    space for rendering a table with dimensions given in N.  The caller must
520    initialize most of the members itself. */
521 static struct render_page *
522 render_page_allocate__ (const struct render_params *params,
523                         struct table *table, int n[TABLE_N_AXES])
524 {
525   struct render_page *page = xmalloc (sizeof *page);
526   page->params = params;
527   page->table = table;
528   page->ref_cnt = 1;
529   page->n[H] = n[H];
530   page->n[V] = n[V];
531
532   for (int i = 0; i < TABLE_N_AXES; i++)
533     {
534       page->cp[i] = xmalloc ((2 * n[i] + 2) * sizeof *page->cp[i]);
535       page->join_crossing[i] = xzalloc ((n[i] + 1)
536                                         * sizeof *page->join_crossing[i]);
537     }
538
539   hmap_init (&page->overflows);
540   memset (page->is_edge_cutoff, 0, sizeof page->is_edge_cutoff);
541
542   return page;
543 }
544
545 /* Allocates and returns a new render_page using PARAMS and TABLE.  Allocates
546    space for all of the members of the new page, but the caller must initialize
547    the 'cp' member itself. */
548 static struct render_page *
549 render_page_allocate (const struct render_params *params, struct table *table)
550 {
551   struct render_page *page = render_page_allocate__ (params, table, table->n);
552   for (enum table_axis a = 0; a < TABLE_N_AXES; a++)
553     {
554       page->h[a][0] = table->h[a][0];
555       page->h[a][1] = table->h[a][1];
556       page->r[a][0] = table->h[a][0];
557       page->r[a][1] = table->n[a] - table->h[a][1];
558     }
559   return page;
560 }
561
562 /* Allocates and returns a new render_page for PARAMS and TABLE, initializing
563    cp[H] in the new page from ROWS and RULES.  The caller must still initialize
564    cp[V]. */
565 static struct render_page *
566 create_page_with_exact_widths (const struct render_params *params,
567                                struct table *table,
568                                const struct render_row *rows, int *rules)
569 {
570   struct render_page *page = render_page_allocate (params, table);
571   accumulate_row_widths (page, H, rows, rules);
572   return page;
573 }
574
575 /* Allocates and returns a new render_page for PARAMS and TABLE.
576
577    Initializes cp[H] in the new page by setting the width of each row 'i' to
578    somewhere between the minimum cell width ROW_MIN[i].width and the maximum
579    ROW_MAX[i].width.  Sets the width of rules to those in RULES.
580
581    W_MIN is the sum of ROWS_MIN[].width.
582
583    W_MAX is the sum of ROWS_MAX[].width.
584
585    The caller must still initialize cp[V]. */
586 static struct render_page *
587 create_page_with_interpolated_widths (const struct render_params *params,
588                                       struct table *table,
589                                       const struct render_row *rows_min,
590                                       const struct render_row *rows_max,
591                                       int w_min, int w_max, const int *rules)
592 {
593   const int n = table->n[H];
594   const long long int avail = params->size[H] - w_min;
595   const long long int wanted = w_max - w_min;
596
597   assert (wanted > 0);
598
599   struct render_page *page = render_page_allocate (params, table);
600
601   int *cph = page->cp[H];
602   *cph = 0;
603   long long int w = wanted / 2;
604   for (int x = 0; x < n; x++)
605     {
606       w += avail * (rows_max[x].width - rows_min[x].width);
607       int extra = w / wanted;
608       w -= extra * wanted;
609
610       cph[1] = cph[0] + rules[x];
611       cph[2] = cph[1] + rows_min[x].width + extra;
612       cph += 2;
613     }
614   cph[1] = cph[0] + rules[n];
615
616   assert (page->cp[H][n * 2 + 1] == params->size[H]);
617   return page;
618 }
619 \f
620 static void
621 set_join_crossings (struct render_page *page, enum table_axis axis,
622                     const struct table_cell *cell, int *rules)
623 {
624   for (int z = cell->d[axis][0] + 1; z <= cell->d[axis][1] - 1; z++)
625     page->join_crossing[axis][z] = rules[z];
626 }
627
628 /* Maps a contiguous range of cells from a page to the underlying table along
629    the horizpntal or vertical dimension. */
630 struct map
631   {
632     int p0;                     /* First ordinate in the page. */
633     int t0;                     /* First ordinate in the table. */
634     int n;                      /* Number of ordinates in page and table. */
635   };
636
637 /* Initializes M to a mapping from PAGE to PAGE->table along axis A.  The
638    mapping includes ordinate Z (in PAGE). */
639 static void
640 get_map (const struct render_page *page, enum table_axis a, int z,
641          struct map *m)
642 {
643   if (z < page->h[a][0])
644     {
645       m->p0 = 0;
646       m->t0 = 0;
647       m->n = page->h[a][0];
648     }
649   else if (z < page->n[a] - page->h[a][1])
650     {
651       m->p0 = page->h[a][0];
652       m->t0 = page->r[a][0];
653       m->n = page->r[a][1] - page->r[a][0];
654     }
655   else
656     {
657       m->p0 = page->n[a] - page->h[a][1];
658       m->t0 = page->table->n[a] - page->table->h[a][1];
659       m->n = page->h[a][1];
660     }
661 }
662
663 /* Initializes CELL with the contents of the table cell at column X and row Y
664    within PAGE.  When CELL is no longer needed, the caller is responsible for
665    freeing it by calling table_cell_free(CELL).
666
667    The caller must ensure that CELL is destroyed before TABLE is unref'ed.
668
669    This is equivalent to table_get_cell(), except X and Y are in terms of the
670    page's rows and columns rather than the underlying table's. */
671 static void
672 render_get_cell (const struct render_page *page, int x, int y,
673                  struct table_cell *cell)
674 {
675   int d[TABLE_N_AXES] = { [H] = x, [V] = y };
676   struct map map[TABLE_N_AXES];
677
678   for (enum table_axis a = 0; a < TABLE_N_AXES; a++)
679     {
680       struct map *m = &map[a];
681       get_map (page, a, d[a], m);
682       d[a] += m->t0 - m->p0;
683     }
684   table_get_cell (page->table, d[H], d[V], cell);
685
686   for (enum table_axis a = 0; a < TABLE_N_AXES; a++)
687     {
688       struct map *m = &map[a];
689
690       for (int i = 0; i < 2; i++)
691         cell->d[a][i] -= m->t0 - m->p0;
692       cell->d[a][0] = MAX (cell->d[a][0], m->p0);
693       cell->d[a][1] = MIN (cell->d[a][1], m->p0 + m->n);
694     }
695 }
696
697 /* Creates and returns a new render_page for rendering TABLE on a device
698    described by PARAMS.
699
700    The new render_page will be suitable for rendering on a device whose page
701    size is PARAMS->size, but the caller is responsible for actually breaking it
702    up to fit on such a device, using the render_break abstraction.  */
703 static struct render_page *
704 render_page_create (const struct render_params *params, struct table *table,
705                     int min_width)
706 {
707   enum { MIN, MAX };
708
709   int nc = table_nc (table);
710   int nr = table_nr (table);
711
712   /* Figure out rule widths. */
713   int *rules[TABLE_N_AXES];
714   for (enum table_axis axis = 0; axis < TABLE_N_AXES; axis++)
715     {
716       int n = table->n[axis] + 1;
717
718       rules[axis] = xnmalloc (n, sizeof *rules);
719       for (int z = 0; z < n; z++)
720         rules[axis][z] = measure_rule (params, table, axis, z);
721     }
722
723   /* Calculate minimum and maximum widths of cells that do not
724      span multiple columns. */
725   struct render_row *columns[2];
726   for (int i = 0; i < 2; i++)
727     columns[i] = xzalloc (nc * sizeof *columns[i]);
728   for (int y = 0; y < nr; y++)
729     for (int x = 0; x < nc;)
730       {
731         struct table_cell cell;
732
733         table_get_cell (table, x, y, &cell);
734         if (y == cell.d[V][0])
735           {
736             if (table_cell_colspan (&cell) == 1)
737               {
738                 int w[2];
739                 params->measure_cell_width (params->aux, &cell,
740                                             &w[MIN], &w[MAX]);
741                 for (int i = 0; i < 2; i++)
742                   if (columns[i][x].unspanned < w[i])
743                     columns[i][x].unspanned = w[i];
744               }
745           }
746         x = cell.d[H][1];
747       }
748
749   /* Distribute widths of spanned columns. */
750   for (int i = 0; i < 2; i++)
751     for (int x = 0; x < nc; x++)
752       columns[i][x].width = columns[i][x].unspanned;
753   for (int y = 0; y < nr; y++)
754     for (int x = 0; x < nc;)
755       {
756         struct table_cell cell;
757
758         table_get_cell (table, x, y, &cell);
759         if (y == cell.d[V][0] && table_cell_colspan (&cell) > 1)
760           {
761             int w[2];
762
763             params->measure_cell_width (params->aux, &cell, &w[MIN], &w[MAX]);
764             for (int i = 0; i < 2; i++)
765               distribute_spanned_width (w[i], &columns[i][cell.d[H][0]],
766                                         rules[H], table_cell_colspan (&cell));
767           }
768         x = cell.d[H][1];
769       }
770   if (min_width > 0)
771     for (int i = 0; i < 2; i++)
772       distribute_spanned_width (min_width, &columns[i][0], rules[H], nc);
773
774   /* In pathological cases, spans can cause the minimum width of a column to
775      exceed the maximum width.  This bollixes our interpolation algorithm
776      later, so fix it up. */
777   for (int i = 0; i < nc; i++)
778     if (columns[MIN][i].width > columns[MAX][i].width)
779       columns[MAX][i].width = columns[MIN][i].width;
780
781   /* Decide final column widths. */
782   int table_widths[2];
783   for (int i = 0; i < 2; i++)
784     table_widths[i] = calculate_table_width (table_nc (table),
785                                              columns[i], rules[H]);
786
787   struct render_page *page;
788   if (table_widths[MAX] <= params->size[H])
789     {
790       /* Fits even with maximum widths.  Use them. */
791       page = create_page_with_exact_widths (params, table, columns[MAX],
792                                             rules[H]);
793     }
794   else if (table_widths[MIN] <= params->size[H])
795     {
796       /* Fits with minimum widths, so distribute the leftover space. */
797       page = create_page_with_interpolated_widths (
798         params, table, columns[MIN], columns[MAX],
799         table_widths[MIN], table_widths[MAX], rules[H]);
800     }
801   else
802     {
803       /* Doesn't fit even with minimum widths.  Assign minimums for now, and
804          later we can break it horizontally into multiple pages. */
805       page = create_page_with_exact_widths (params, table, columns[MIN],
806                                             rules[H]);
807     }
808
809   /* Calculate heights of cells that do not span multiple rows. */
810   struct render_row *rows = xzalloc (nr * sizeof *rows);
811   for (int y = 0; y < nr; y++)
812     for (int x = 0; x < nc;)
813       {
814         struct render_row *r = &rows[y];
815         struct table_cell cell;
816
817         render_get_cell (page, x, y, &cell);
818         if (y == cell.d[V][0])
819           {
820             if (table_cell_rowspan (&cell) == 1)
821               {
822                 int w = joined_width (page, H, cell.d[H][0], cell.d[H][1]);
823                 int h = params->measure_cell_height (params->aux, &cell, w);
824                 if (h > r->unspanned)
825                   r->unspanned = r->width = h;
826               }
827             else
828               set_join_crossings (page, V, &cell, rules[V]);
829
830             if (table_cell_colspan (&cell) > 1)
831               set_join_crossings (page, H, &cell, rules[H]);
832           }
833         x = cell.d[H][1];
834       }
835   for (int i = 0; i < 2; i++)
836     free (columns[i]);
837
838   /* Distribute heights of spanned rows. */
839   for (int y = 0; y < nr; y++)
840     for (int x = 0; x < nc;)
841       {
842         struct table_cell cell;
843
844         render_get_cell (page, x, y, &cell);
845         if (y == cell.d[V][0] && table_cell_rowspan (&cell) > 1)
846           {
847             int w = joined_width (page, H, cell.d[H][0], cell.d[H][1]);
848             int h = params->measure_cell_height (params->aux, &cell, w);
849             distribute_spanned_width (h, &rows[cell.d[V][0]], rules[V],
850                                       table_cell_rowspan (&cell));
851           }
852         x = cell.d[H][1];
853       }
854
855   /* Decide final row heights. */
856   accumulate_row_widths (page, V, rows, rules[V]);
857   free (rows);
858
859   /* Measure headers.  If they are "too big", get rid of them.  */
860   for (enum table_axis axis = 0; axis < TABLE_N_AXES; axis++)
861     {
862       int hw = headers_width (page, axis);
863       if (hw * 2 >= page->params->size[axis]
864           || hw + max_cell_width (page, axis) > page->params->size[axis])
865         {
866           page->h[axis][0] = page->h[axis][1] = 0;
867           page->r[axis][0] = 0;
868           page->r[axis][1] = page->n[axis];
869         }
870     }
871
872   free (rules[H]);
873   free (rules[V]);
874
875   return page;
876 }
877
878 /* Increases PAGE's reference count. */
879 struct render_page *
880 render_page_ref (const struct render_page *page_)
881 {
882   struct render_page *page = CONST_CAST (struct render_page *, page_);
883   page->ref_cnt++;
884   return page;
885 }
886
887 /* Decreases PAGE's reference count and destroys PAGE if this causes the
888    reference count to fall to zero. */
889 static void
890 render_page_unref (struct render_page *page)
891 {
892   if (page != NULL && --page->ref_cnt == 0)
893     {
894       struct render_overflow *overflow, *next;
895       HMAP_FOR_EACH_SAFE (overflow, next, struct render_overflow, node,
896                           &page->overflows)
897         free (overflow);
898       hmap_destroy (&page->overflows);
899
900       table_unref (page->table);
901
902       for (int i = 0; i < TABLE_N_AXES; ++i)
903         {
904           free (page->join_crossing[i]);
905           free (page->cp[i]);
906         }
907
908       free (page);
909     }
910 }
911
912 /* Returns the size of PAGE along AXIS.  (This might be larger than the page
913    size specified in the parameters passed to render_page_create().  Use a
914    render_break to break up a render_page into page-sized chunks.) */
915 static int
916 render_page_get_size (const struct render_page *page, enum table_axis axis)
917 {
918   return page->cp[axis][page->n[axis] * 2 + 1];
919 }
920
921 static int
922 render_page_get_best_breakpoint (const struct render_page *page, int height)
923 {
924   /* If there's no room for at least the top row and the rules above and below
925      it, don't include any of the table. */
926   if (page->cp[V][3] > height)
927     return 0;
928
929   /* Otherwise include as many rows and rules as we can. */
930   for (int y = 5; y <= 2 * page->n[V] + 1; y += 2)
931     if (page->cp[V][y] > height)
932       return page->cp[V][y - 2];
933   return height;
934 }
935 \f
936 /* Drawing render_pages. */
937
938 /* This is like table_get_rule() except:
939
940    - D is in terms of the page's rows and column rather than the underlying
941      table's.
942
943    - The result is in the form of a render_line_style. */
944 static enum render_line_style
945 get_rule (const struct render_page *page, enum table_axis axis,
946           const int d_[TABLE_N_AXES], struct cell_color *color)
947 {
948   int d[TABLE_N_AXES] = { d_[0] / 2, d_[1] / 2 };
949   int d2 = -1;
950
951   enum table_axis a = axis;
952   if (d[a] < page->h[a][0])
953     /* Nothing to do */;
954   else if (d[a] <= page->n[a] - page->h[a][1])
955     {
956       if (page->h[a][0] && d[a] == page->h[a][0])
957         d2 = page->h[a][0];
958       else if (page->h[a][1] && d[a] == page->n[a] - page->h[a][1])
959         d2 = page->table->n[a] - page->h[a][1];
960       d[a] += page->r[a][0] - page->h[a][0];
961     }
962   else
963     d[a] += ((page->table->n[a] - page->table->h[a][1])
964              - (page->n[a] - page->h[a][1]));
965
966   enum table_axis b = !axis;
967   struct map m;
968   get_map (page, b, d[b], &m);
969   d[b] += m.t0 - m.p0;
970
971   int r = table_get_rule (page->table, axis, d[H], d[V], color);
972   if (d2 >= 0)
973     {
974       d[a] = d2;
975       int r2 = table_get_rule (page->table, axis, d[H], d[V], color);
976       r = table_stroke_combine (r, r2);
977     }
978   return rule_to_render_type (r);
979 }
980
981 static bool
982 is_rule (int z)
983 {
984   return !(z & 1);
985 }
986
987 bool
988 render_direction_rtl (void)
989 {
990   /* TRANSLATORS: Do not translate this string.  If the script of your language
991      reads from right to left (eg Persian, Arabic, Hebrew etc), then replace
992      this string with "output-direction-rtl".  Otherwise either leave it
993      untranslated or copy it verbatim. */
994   const char *dir = _("output-direction-ltr");
995   if (0 == strcmp ("output-direction-rtl", dir))
996     return true;
997
998   if (0 != strcmp ("output-direction-ltr", dir))
999     fprintf (stderr, "This localisation has been incorrectly translated.  "
1000              "Complain to the translator.\n");
1001
1002   return false;
1003 }
1004
1005 static void
1006 render_rule (const struct render_page *page, const int ofs[TABLE_N_AXES],
1007              const int d[TABLE_N_AXES])
1008 {
1009   enum render_line_style styles[TABLE_N_AXES][2];
1010   struct cell_color colors[TABLE_N_AXES][2];
1011
1012   for (enum table_axis a = 0; a < TABLE_N_AXES; a++)
1013     {
1014       enum table_axis b = !a;
1015
1016       styles[a][0] = styles[a][1] = RENDER_LINE_NONE;
1017
1018       if (!is_rule (d[a])
1019           || (page->is_edge_cutoff[a][0] && d[a] == 0)
1020           || (page->is_edge_cutoff[a][1] && d[a] == page->n[a] * 2))
1021         continue;
1022
1023       if (is_rule (d[b]))
1024         {
1025           if (d[b] > 0)
1026             {
1027               int e[TABLE_N_AXES];
1028               e[H] = d[H];
1029               e[V] = d[V];
1030               e[b]--;
1031               styles[a][0] = get_rule (page, a, e, &colors[a][0]);
1032             }
1033
1034           if (d[b] / 2 < page->n[b])
1035             styles[a][1] = get_rule (page, a, d, &colors[a][1]);
1036         }
1037       else
1038         {
1039           styles[a][0] = styles[a][1] = get_rule (page, a, d, &colors[a][0]);
1040           colors[a][1] = colors[a][0];
1041         }
1042     }
1043
1044   if (styles[H][0] != RENDER_LINE_NONE || styles[H][1] != RENDER_LINE_NONE
1045       || styles[V][0] != RENDER_LINE_NONE || styles[V][1] != RENDER_LINE_NONE)
1046     {
1047       int bb[TABLE_N_AXES][2];
1048
1049       bb[H][0] = ofs[H] + page->cp[H][d[H]];
1050       bb[H][1] = ofs[H] + page->cp[H][d[H] + 1];
1051       if (page->params->rtl)
1052         {
1053           int temp = bb[H][0];
1054           bb[H][0] = render_page_get_size (page, H) - bb[H][1];
1055           bb[H][1] = render_page_get_size (page, H) - temp;
1056         }
1057       bb[V][0] = ofs[V] + page->cp[V][d[V]];
1058       bb[V][1] = ofs[V] + page->cp[V][d[V] + 1];
1059       page->params->draw_line (page->params->aux, bb, styles, colors);
1060     }
1061 }
1062
1063 static void
1064 render_cell (const struct render_page *page, const int ofs[TABLE_N_AXES],
1065              const struct table_cell *cell)
1066 {
1067   int bb[TABLE_N_AXES][2];
1068   int clip[TABLE_N_AXES][2];
1069
1070   bb[H][0] = clip[H][0] = ofs[H] + page->cp[H][cell->d[H][0] * 2 + 1];
1071   bb[H][1] = clip[H][1] = ofs[H] + page->cp[H][cell->d[H][1] * 2];
1072   if (page->params->rtl)
1073     {
1074       int temp = bb[H][0];
1075       bb[H][0] = clip[H][0] = render_page_get_size (page, H) - bb[H][1];
1076       bb[H][1] = clip[H][1] = render_page_get_size (page, H) - temp;
1077     }
1078   bb[V][0] = clip[V][0] = ofs[V] + page->cp[V][cell->d[V][0] * 2 + 1];
1079   bb[V][1] = clip[V][1] = ofs[V] + page->cp[V][cell->d[V][1] * 2];
1080
1081   enum table_valign valign = cell->style->cell_style.valign;
1082   int valign_offset = 0;
1083   if (valign != TABLE_VALIGN_TOP)
1084     {
1085       int height = page->params->measure_cell_height (
1086         page->params->aux, cell, bb[H][1] - bb[H][0]);
1087       int extra = bb[V][1] - bb[V][0] - height;
1088       if (extra > 0)
1089         {
1090           if (valign == TABLE_VALIGN_CENTER)
1091             extra /= 2;
1092           valign_offset += extra;
1093         }
1094     }
1095
1096   const struct render_overflow *of = find_overflow (
1097     page, cell->d[H][0], cell->d[V][0]);
1098   if (of)
1099     for (enum table_axis axis = 0; axis < TABLE_N_AXES; axis++)
1100       {
1101         if (of->overflow[axis][0])
1102           {
1103             bb[axis][0] -= of->overflow[axis][0];
1104             if (cell->d[axis][0] == 0 && !page->is_edge_cutoff[axis][0])
1105               clip[axis][0] = ofs[axis] + page->cp[axis][cell->d[axis][0] * 2];
1106           }
1107         if (of->overflow[axis][1])
1108           {
1109             bb[axis][1] += of->overflow[axis][1];
1110             if (cell->d[axis][1] == page->n[axis]
1111                 && !page->is_edge_cutoff[axis][1])
1112               clip[axis][1] = ofs[axis] + page->cp[axis][cell->d[axis][1] * 2
1113                                                          + 1];
1114           }
1115       }
1116
1117   int spill[TABLE_N_AXES][2];
1118   for (enum table_axis axis = 0; axis < TABLE_N_AXES; axis++)
1119     {
1120       spill[axis][0] = rule_width (page, axis, cell->d[axis][0]) / 2;
1121       spill[axis][1] = rule_width (page, axis, cell->d[axis][1]) / 2;
1122     }
1123
1124   int color_idx = (cell->d[V][0] < page->h[V][0]
1125                    || page->n[V] - (cell->d[V][0] + 1) < page->h[V][1]
1126                    ? 0
1127                    : (cell->d[V][0] - page->h[V][0]) & 1);
1128   page->params->draw_cell (page->params->aux, cell, color_idx,
1129                            bb, valign_offset, spill, clip);
1130 }
1131
1132 /* Draws the cells of PAGE indicated in BB. */
1133 static void
1134 render_page_draw_cells (const struct render_page *page,
1135                         int ofs[TABLE_N_AXES], int bb[TABLE_N_AXES][2])
1136 {
1137   for (int y = bb[V][0]; y < bb[V][1]; y++)
1138     for (int x = bb[H][0]; x < bb[H][1];)
1139       if (!is_rule (x) && !is_rule (y))
1140         {
1141           struct table_cell cell;
1142
1143           render_get_cell (page, x / 2, y / 2, &cell);
1144           if (y / 2 == bb[V][0] / 2 || y / 2 == cell.d[V][0])
1145             render_cell (page, ofs, &cell);
1146           x = rule_ofs (cell.d[H][1]);
1147         }
1148       else
1149         x++;
1150
1151   for (int y = bb[V][0]; y < bb[V][1]; y++)
1152     for (int x = bb[H][0]; x < bb[H][1]; x++)
1153       if (is_rule (x) || is_rule (y))
1154         {
1155           int d[TABLE_N_AXES];
1156           d[H] = x;
1157           d[V] = y;
1158           render_rule (page, ofs, d);
1159         }
1160 }
1161
1162 /* Renders PAGE, by calling the 'draw_line' and 'draw_cell' functions from the
1163    render_params provided to render_page_create(). */
1164 static void
1165 render_page_draw (const struct render_page *page, int ofs[TABLE_N_AXES])
1166 {
1167   int bb[TABLE_N_AXES][2];
1168
1169   bb[H][0] = 0;
1170   bb[H][1] = page->n[H] * 2 + 1;
1171   bb[V][0] = 0;
1172   bb[V][1] = page->n[V] * 2 + 1;
1173
1174   render_page_draw_cells (page, ofs, bb);
1175 }
1176
1177 /* Returns the greatest value i, 0 <= i < n, such that cp[i] <= x0. */
1178 static int
1179 get_clip_min_extent (int x0, const int cp[], int n)
1180 {
1181   int low = 0;
1182   int high = n;
1183   int best = 0;
1184   while (low < high)
1185     {
1186       int middle = low + (high - low) / 2;
1187
1188       if (cp[middle] <= x0)
1189         {
1190           best = middle;
1191           low = middle + 1;
1192         }
1193       else
1194         high = middle;
1195     }
1196
1197   return best;
1198 }
1199
1200 /* Returns the least value i, 0 <= i < n, such that cp[i] >= x1. */
1201 static int
1202 get_clip_max_extent (int x1, const int cp[], int n)
1203 {
1204   int low = 0;
1205   int high = n;
1206   int best = n;
1207   while (low < high)
1208     {
1209       int middle = low + (high - low) / 2;
1210
1211       if (cp[middle] >= x1)
1212         best = high = middle;
1213       else
1214         low = middle + 1;
1215     }
1216
1217   while (best > 0 && cp[best - 1] == cp[best])
1218     best--;
1219
1220   return best;
1221 }
1222
1223 /* Renders the cells of PAGE that intersect (X,Y)-(X+W,Y+H), by calling the
1224    'draw_line' and 'draw_cell' functions from the render_params provided to
1225    render_page_create(). */
1226 static void
1227 render_page_draw_region (const struct render_page *page,
1228                          int ofs[TABLE_N_AXES], int clip[TABLE_N_AXES][2])
1229 {
1230   int bb[TABLE_N_AXES][2];
1231
1232   bb[H][0] = get_clip_min_extent (clip[H][0], page->cp[H], page->n[H] * 2 + 1);
1233   bb[H][1] = get_clip_max_extent (clip[H][1], page->cp[H], page->n[H] * 2 + 1);
1234   bb[V][0] = get_clip_min_extent (clip[V][0], page->cp[V], page->n[V] * 2 + 1);
1235   bb[V][1] = get_clip_max_extent (clip[V][1], page->cp[V], page->n[V] * 2 + 1);
1236
1237   render_page_draw_cells (page, ofs, bb);
1238 }
1239
1240 /* Breaking up tables to fit on a page. */
1241
1242 /* An iterator for breaking render_pages into smaller chunks. */
1243 struct render_break
1244   {
1245     struct render_page *page;   /* Page being broken up. */
1246     enum table_axis axis;       /* Axis along which 'page' is being broken. */
1247     int z;                      /* Next cell along 'axis'. */
1248     int pixel;                  /* Pixel offset within cell 'z' (usually 0). */
1249     int hw;                     /* Width of headers of 'page' along 'axis'. */
1250   };
1251
1252 static int needed_size (const struct render_break *, int cell);
1253 static bool cell_is_breakable (const struct render_break *, int cell);
1254 static struct render_page *render_page_select (const struct render_page *,
1255                                                enum table_axis,
1256                                                int z0, int p0,
1257                                                int z1, int p1);
1258
1259 /* Initializes render_break B for breaking PAGE along AXIS.
1260    Takes ownership of PAGE. */
1261 static void
1262 render_break_init (struct render_break *b, struct render_page *page,
1263                    enum table_axis axis)
1264 {
1265   b->page = page;
1266   b->axis = axis;
1267   b->z = page->h[axis][0];
1268   b->pixel = 0;
1269   b->hw = headers_width (page, axis);
1270 }
1271
1272 /* Initializes B as a render_break structure for which
1273    render_break_has_next() always returns false. */
1274 static void
1275 render_break_init_empty (struct render_break *b)
1276 {
1277   b->page = NULL;
1278   b->axis = TABLE_HORZ;
1279   b->z = 0;
1280   b->pixel = 0;
1281   b->hw = 0;
1282 }
1283
1284 /* Frees B and unrefs the render_page that it owns. */
1285 static void
1286 render_break_destroy (struct render_break *b)
1287 {
1288   if (b != NULL)
1289     {
1290       render_page_unref (b->page);
1291       b->page = NULL;
1292     }
1293 }
1294
1295 /* Returns true if B still has cells that are yet to be returned,
1296    false if all of B's page has been processed. */
1297 static bool
1298 render_break_has_next (const struct render_break *b)
1299 {
1300   const struct render_page *page = b->page;
1301   enum table_axis axis = b->axis;
1302
1303   return page != NULL && b->z < page->n[axis] - page->h[axis][1];
1304 }
1305
1306 /* Returns a new render_page that is up to SIZE pixels wide along B's axis.
1307    Returns a null pointer if B has already been completely broken up, or if
1308    SIZE is too small to reasonably render any cells.  The latter will never
1309    happen if SIZE is at least as large as the page size passed to
1310    render_page_create() along B's axis. */
1311 static struct render_page *
1312 render_break_next (struct render_break *b, int size)
1313 {
1314   const struct render_page *page = b->page;
1315   enum table_axis axis = b->axis;
1316   struct render_page *subpage;
1317
1318   if (!render_break_has_next (b))
1319     return NULL;
1320
1321   int pixel = 0;
1322   int z;
1323   for (z = b->z; z < page->n[axis] - page->h[axis][1]; z++)
1324     {
1325       int needed = needed_size (b, z + 1);
1326       if (needed > size)
1327         {
1328           if (cell_is_breakable (b, z))
1329             {
1330               /* If there is no right header and we render a partial cell on
1331                  the right side of the body, then we omit the rightmost rule of
1332                  the body.  Otherwise the rendering is deceptive because it
1333                  looks like the whole cell is present instead of a partial
1334                  cell.
1335
1336                  This is similar to code for the left side in needed_size(). */
1337               int rule_allowance = (page->h[axis][1]
1338                                     ? 0
1339                                     : rule_width (page, axis, z));
1340
1341               /* The amount that, if we added cell 'z', the rendering would
1342                  overfill the allocated 'size'. */
1343               int overhang = needed - size - rule_allowance;
1344
1345               /* The width of cell 'z'. */
1346               int cell_size = cell_width (page, axis, z);
1347
1348               /* The amount trimmed off the left side of 'z',
1349                  and the amount left to render. */
1350               int cell_ofs = z == b->z ? b->pixel : 0;
1351               int cell_left = cell_size - cell_ofs;
1352
1353               /* A small but visible width.  */
1354               int em = page->params->font_size[axis];
1355
1356               /* If some of the cell remains to render,
1357                  and there would still be some of the cell left afterward,
1358                  then partially render that much of the cell. */
1359               pixel = (cell_left && cell_left > overhang
1360                        ? cell_left - overhang + cell_ofs
1361                        : 0);
1362
1363               /* If there would be only a tiny amount of the cell left after
1364                  rendering it partially, reduce the amount rendered slightly
1365                  to make the output look a little better. */
1366               if (pixel + em > cell_size)
1367                 pixel = MAX (pixel - em, 0);
1368
1369               /* If we're breaking vertically, then consider whether the cells
1370                  being broken have a better internal breakpoint than the exact
1371                  number of pixels available, which might look bad e.g. because
1372                  it breaks in the middle of a line of text. */
1373               if (axis == TABLE_VERT && page->params->adjust_break)
1374                 for (int x = 0; x < page->n[H];)
1375                   {
1376                     struct table_cell cell;
1377
1378                     render_get_cell (page, x, z, &cell);
1379                     int w = joined_width (page, H, cell.d[H][0], cell.d[H][1]);
1380                     int better_pixel = page->params->adjust_break (
1381                       page->params->aux, &cell, w, pixel);
1382                     x = cell.d[H][1];
1383
1384                     if (better_pixel < pixel)
1385                       {
1386                         if (better_pixel > (z == b->z ? b->pixel : 0))
1387                           {
1388                             pixel = better_pixel;
1389                             break;
1390                           }
1391                         else if (better_pixel == 0 && z != b->z)
1392                           {
1393                             pixel = 0;
1394                             break;
1395                           }
1396                       }
1397                   }
1398             }
1399           break;
1400         }
1401     }
1402
1403   if (z == b->z && !pixel)
1404     return NULL;
1405
1406   subpage = render_page_select (page, axis, b->z, b->pixel,
1407                                 pixel ? z + 1 : z,
1408                                 pixel ? cell_width (page, axis, z) - pixel
1409                                 : 0);
1410   b->z = z;
1411   b->pixel = pixel;
1412   return subpage;
1413 }
1414
1415 /* Returns the width that would be required along B's axis to render a page
1416    from B's current position up to but not including CELL. */
1417 static int
1418 needed_size (const struct render_break *b, int cell)
1419 {
1420   const struct render_page *page = b->page;
1421   enum table_axis axis = b->axis;
1422
1423   /* Width of left header not including its rightmost rule.  */
1424   int size = axis_width (page, axis, 0, rule_ofs (page->h[axis][0]));
1425
1426   /* If we have a pixel offset and there is no left header, then we omit the
1427      leftmost rule of the body.  Otherwise the rendering is deceptive because
1428      it looks like the whole cell is present instead of a partial cell.
1429
1430      Otherwise (if there are headers) we will be merging two rules: the
1431      rightmost rule in the header and the leftmost rule in the body.  We assume
1432      that the width of a merged rule is the larger of the widths of either rule
1433      invidiually. */
1434   if (b->pixel == 0 || page->h[axis][0])
1435     size += MAX (rule_width (page, axis, page->h[axis][0]),
1436                  rule_width (page, axis, b->z));
1437
1438   /* Width of body, minus any pixel offset in the leftmost cell. */
1439   size += joined_width (page, axis, b->z, cell) - b->pixel;
1440
1441   /* Width of rightmost rule in body merged with leftmost rule in headers. */
1442   size += MAX (rule_width_r (page, axis, page->h[axis][1]),
1443                rule_width (page, axis, cell));
1444
1445   /* Width of right header not including its leftmost rule. */
1446   size += axis_width (page, axis, rule_ofs_r (page, axis, page->h[axis][1]),
1447                       rule_ofs_r (page, axis, 0));
1448
1449   /* Join crossing. */
1450   if (page->h[axis][0] && page->h[axis][1])
1451     size += page->join_crossing[axis][b->z];
1452
1453   return size;
1454 }
1455
1456 /* Returns true if CELL along B's axis may be broken across a page boundary.
1457
1458    This is just a heuristic.  Breaking cells across page boundaries can save
1459    space, but it looks ugly. */
1460 static bool
1461 cell_is_breakable (const struct render_break *b, int cell)
1462 {
1463   const struct render_page *page = b->page;
1464   enum table_axis axis = b->axis;
1465
1466   return cell_width (page, axis, cell) >= page->params->min_break[axis];
1467 }
1468 \f
1469 /* render_pager. */
1470
1471 struct render_pager
1472   {
1473     const struct render_params *params;
1474
1475     struct render_page **pages;
1476     size_t n_pages, allocated_pages;
1477
1478     size_t cur_page;
1479     struct render_break x_break;
1480     struct render_break y_break;
1481   };
1482
1483 static const struct render_page *
1484 render_pager_add_table (struct render_pager *p, struct table *table,
1485                         int min_width)
1486 {
1487   if (p->n_pages >= p->allocated_pages)
1488     p->pages = x2nrealloc (p->pages, &p->allocated_pages, sizeof *p->pages);
1489
1490   struct render_page *page = render_page_create (p->params, table, min_width);
1491   p->pages[p->n_pages++] = page;
1492   return page;
1493 }
1494
1495 static void
1496 render_pager_start_page (struct render_pager *p)
1497 {
1498   render_break_init (&p->x_break, render_page_ref (p->pages[p->cur_page++]),
1499                      H);
1500   render_break_init_empty (&p->y_break);
1501 }
1502
1503 static void
1504 add_footnote_page (struct render_pager *p, const struct table_item *item)
1505 {
1506   const struct footnote **f;
1507   size_t n_footnotes = table_collect_footnotes (item, &f);
1508   if (!n_footnotes)
1509     return;
1510
1511   struct table *t = table_create (1, n_footnotes, 0, 0, 0, 0);
1512
1513   for (size_t i = 0; i < n_footnotes; i++)
1514     {
1515       table_text_format (t, 0, i, 0, "%s. %s", f[i]->marker, f[i]->content);
1516       table_add_style (t, 0, i, f[i]->style);
1517     }
1518   render_pager_add_table (p, t, 0);
1519
1520   free (f);
1521 }
1522
1523 static void
1524 add_text_page (struct render_pager *p, const struct table_item_text *t,
1525                int min_width)
1526 {
1527   if (!t)
1528     return;
1529
1530   struct table *tab = table_create (1, 1, 0, 0, 0, 0);
1531   table_text (tab, 0, 0, 0, t->content);
1532   for (size_t i = 0; i < t->n_footnotes; i++)
1533     table_add_footnote (tab, 0, 0, t->footnotes[i]);
1534   if (t->style)
1535     tab->styles[0] = area_style_clone (tab->container, t->style);
1536   render_pager_add_table (p, tab, min_width);
1537 }
1538
1539 static void
1540 add_layers_page (struct render_pager *p,
1541                  const struct table_item_layers *layers, int min_width)
1542 {
1543   if (!layers)
1544     return;
1545
1546   struct table *tab = table_create (1, layers->n_layers, 0, 0, 0, 0);
1547   for (size_t i = 0; i < layers->n_layers; i++)
1548     {
1549       const struct table_item_layer *layer = &layers->layers[i];
1550       table_text (tab, 0, i, 0, layer->content);
1551       for (size_t j = 0; j < layer->n_footnotes; j++)
1552         table_add_footnote (tab, 0, i, layer->footnotes[j]);
1553     }
1554   if (layers->style)
1555     tab->styles[0] = area_style_clone (tab->container, layers->style);
1556   render_pager_add_table (p, tab, min_width);
1557 }
1558
1559 /* Creates and returns a new render_pager for rendering TABLE_ITEM on the
1560    device with the given PARAMS. */
1561 struct render_pager *
1562 render_pager_create (const struct render_params *params,
1563                      const struct table_item *table_item)
1564 {
1565   const struct table *table = table_item_get_table (table_item);
1566
1567   struct render_pager *p = xzalloc (sizeof *p);
1568   p->params = params;
1569
1570   struct render_page *page = render_page_create (params, table_ref (table), 0);
1571   struct render_break b;
1572   render_break_init (&b, page, H);
1573   struct render_page *subpage = render_break_next (&b, p->params->size[H]);
1574   int title_width = subpage ? subpage->cp[H][2 * subpage->n[H] + 1] : 0;
1575   render_page_unref (subpage);
1576   render_break_destroy (&b);
1577
1578   /* Title. */
1579   add_text_page (p, table_item_get_title (table_item), title_width);
1580
1581   /* Layers. */
1582   add_layers_page (p, table_item_get_layers (table_item), title_width);
1583
1584   /* Body. */
1585   render_pager_add_table (p, table_ref (table_item_get_table (table_item)), 0);
1586
1587   /* Caption. */
1588   add_text_page (p, table_item_get_caption (table_item), 0);
1589
1590   /* Footnotes. */
1591   add_footnote_page (p, table_item);
1592
1593   render_pager_start_page (p);
1594
1595   return p;
1596 }
1597
1598 /* Destroys P. */
1599 void
1600 render_pager_destroy (struct render_pager *p)
1601 {
1602   if (p)
1603     {
1604       render_break_destroy (&p->x_break);
1605       render_break_destroy (&p->y_break);
1606       for (size_t i = 0; i < p->n_pages; i++)
1607         render_page_unref (p->pages[i]);
1608       free (p->pages);
1609       free (p);
1610     }
1611 }
1612
1613 /* Returns true if P has content remaining to render, false if rendering is
1614    done. */
1615 bool
1616 render_pager_has_next (const struct render_pager *p_)
1617 {
1618   struct render_pager *p = CONST_CAST (struct render_pager *, p_);
1619
1620   while (!render_break_has_next (&p->y_break))
1621     {
1622       render_break_destroy (&p->y_break);
1623       if (!render_break_has_next (&p->x_break))
1624         {
1625           render_break_destroy (&p->x_break);
1626           if (p->cur_page >= p->n_pages)
1627             {
1628               render_break_init_empty (&p->x_break);
1629               render_break_init_empty (&p->y_break);
1630               return false;
1631             }
1632           render_pager_start_page (p);
1633         }
1634       else
1635         render_break_init (
1636           &p->y_break, render_break_next (&p->x_break, p->params->size[H]), V);
1637     }
1638   return true;
1639 }
1640
1641 /* Draws a chunk of content from P to fit in a space that has vertical size
1642    SPACE and the horizontal size specified in the render_params passed to
1643    render_page_create().  Returns the amount of space actually used by the
1644    rendered chunk, which will be 0 if SPACE is too small to render anything or
1645    if no content remains (use render_pager_has_next() to distinguish these
1646    cases). */
1647 int
1648 render_pager_draw_next (struct render_pager *p, int space)
1649 {
1650   int ofs[TABLE_N_AXES] = { 0, 0 };
1651   size_t start_page = SIZE_MAX;
1652
1653   while (render_pager_has_next (p))
1654     {
1655       if (start_page == p->cur_page)
1656         break;
1657       start_page = p->cur_page;
1658
1659       struct render_page *page
1660         = render_break_next (&p->y_break, space - ofs[V]);
1661       if (!page)
1662         break;
1663
1664       render_page_draw (page, ofs);
1665       ofs[V] += render_page_get_size (page, V);
1666       render_page_unref (page);
1667     }
1668   return ofs[V];
1669 }
1670
1671 /* Draws all of P's content. */
1672 void
1673 render_pager_draw (const struct render_pager *p)
1674 {
1675   render_pager_draw_region (p, 0, 0, INT_MAX, INT_MAX);
1676 }
1677
1678 /* Draws the region of P's content that lies in the region (X,Y)-(X+W,Y+H).
1679    Some extra content might be drawn; the device should perform clipping as
1680    necessary. */
1681 void
1682 render_pager_draw_region (const struct render_pager *p,
1683                           int x, int y, int w, int h)
1684 {
1685   int ofs[TABLE_N_AXES] = { 0, 0 };
1686   int clip[TABLE_N_AXES][2];
1687
1688   clip[H][0] = x;
1689   clip[H][1] = x + w;
1690   for (size_t i = 0; i < p->n_pages; i++)
1691     {
1692       const struct render_page *page = p->pages[i];
1693       int size = render_page_get_size (page, V);
1694
1695       clip[V][0] = MAX (y, ofs[V]) - ofs[V];
1696       clip[V][1] = MIN (y + h, ofs[V] + size) - ofs[V];
1697       if (clip[V][1] > clip[V][0])
1698         render_page_draw_region (page, ofs, clip);
1699
1700       ofs[V] += size;
1701     }
1702 }
1703
1704 /* Returns the size of P's content along AXIS; i.e. the content's width if AXIS
1705    is TABLE_HORZ and its length if AXIS is TABLE_VERT. */
1706 int
1707 render_pager_get_size (const struct render_pager *p, enum table_axis axis)
1708 {
1709   int size = 0;
1710
1711   for (size_t i = 0; i < p->n_pages; i++)
1712     {
1713       int subsize = render_page_get_size (p->pages[i], axis);
1714       size = axis == H ? MAX (size, subsize) : size + subsize;
1715     }
1716
1717   return size;
1718 }
1719
1720 int
1721 render_pager_get_best_breakpoint (const struct render_pager *p, int height)
1722 {
1723   int y = 0;
1724   size_t i;
1725
1726   for (i = 0; i < p->n_pages; i++)
1727     {
1728       int size = render_page_get_size (p->pages[i], V);
1729       if (y + size >= height)
1730         return render_page_get_best_breakpoint (p->pages[i], height - y) + y;
1731       y += size;
1732     }
1733
1734   return height;
1735 }
1736 \f
1737 /* render_page_select() and helpers. */
1738
1739 struct render_page_selection
1740   {
1741     const struct render_page *page; /* Page whose slice we are selecting. */
1742     struct render_page *subpage; /* New page under construction. */
1743     enum table_axis a;   /* Axis of 'page' along which 'subpage' is a slice. */
1744     enum table_axis b;   /* The opposite of 'a'. */
1745     int z0;              /* First cell along 'a' being selected. */
1746     int z1;              /* Last cell being selected, plus 1. */
1747     int p0;              /* Number of pixels to trim off left side of z0. */
1748     int p1;              /* Number of pixels to trim off right side of z1-1. */
1749   };
1750
1751 static void cell_to_subpage (struct render_page_selection *,
1752                              const struct table_cell *,
1753                              int subcell[TABLE_N_AXES]);
1754 static const struct render_overflow *find_overflow_for_cell (
1755   struct render_page_selection *, const struct table_cell *);
1756 static struct render_overflow *insert_overflow (struct render_page_selection *,
1757                                                 const struct table_cell *);
1758
1759 /* Creates and returns a new render_page whose contents are a subregion of
1760    PAGE's contents.  The new render_page includes cells Z0 through Z1
1761    (exclusive) along AXIS, plus any headers on AXIS.
1762
1763    If P0 is nonzero, then it is a number of pixels to exclude from the left or
1764    top (according to AXIS) of cell Z0.  Similarly, P1 is a number of pixels to
1765    exclude from the right or bottom of cell Z1 - 1.  (P0 and P1 are used to
1766    render cells that are too large to fit on a single page.)
1767
1768    The whole of axis !AXIS is included.  (The caller may follow up with another
1769    call to render_page_select() to select on !AXIS to select on that axis as
1770    well.)
1771
1772    The caller retains ownership of PAGE, which is not modified. */
1773 static struct render_page *
1774 render_page_select (const struct render_page *page, enum table_axis axis,
1775                     int z0, int p0, int z1, int p1)
1776 {
1777   enum table_axis a = axis;
1778   enum table_axis b = !a;
1779
1780   /* Optimize case where all of PAGE is selected by just incrementing the
1781      reference count. */
1782   if (z0 == page->h[a][0] && p0 == 0
1783       && z1 == page->n[a] - page->h[a][1] && p1 == 0)
1784     {
1785       struct render_page *page_rw = CONST_CAST (struct render_page *, page);
1786       page_rw->ref_cnt++;
1787       return page_rw;
1788     }
1789
1790   /* Allocate subpage. */
1791   int trim[2] = { z0 - page->h[a][0], (page->n[a] - page->h[a][1]) - z1 };
1792   int n[TABLE_N_AXES] = { [H] = page->n[H], [V] = page->n[V] };
1793   n[a] -= trim[0] + trim[1];
1794   struct render_page *subpage = render_page_allocate__ (
1795     page->params, table_ref (page->table), n);
1796   for (enum table_axis k = 0; k < TABLE_N_AXES; k++)
1797     {
1798       subpage->h[k][0] = page->h[k][0];
1799       subpage->h[k][1] = page->h[k][1];
1800       subpage->r[k][0] = page->r[k][0];
1801       subpage->r[k][1] = page->r[k][1];
1802     }
1803   subpage->r[a][0] += trim[0];
1804   subpage->r[a][1] -= trim[1];
1805
1806   /* An edge is cut off if it was cut off in PAGE or if we're trimming pixels
1807      off that side of the page and there are no headers. */
1808   subpage->is_edge_cutoff[a][0] =
1809     subpage->h[a][0] == 0 && (p0 || (z0 == 0 && page->is_edge_cutoff[a][0]));
1810   subpage->is_edge_cutoff[a][1] =
1811     subpage->h[a][1] == 0 && (p1 || (z1 == page->n[a]
1812                                      && page->is_edge_cutoff[a][1]));
1813   subpage->is_edge_cutoff[b][0] = page->is_edge_cutoff[b][0];
1814   subpage->is_edge_cutoff[b][1] = page->is_edge_cutoff[b][1];
1815
1816   /* Select join crossings from PAGE into subpage. */
1817   int *jc = subpage->join_crossing[a];
1818   for (int z = 0; z < page->h[a][0]; z++)
1819     *jc++ = page->join_crossing[a][z];
1820   for (int z = z0; z <= z1; z++)
1821     *jc++ = page->join_crossing[a][z];
1822   for (int z = page->n[a] - page->h[a][1]; z < page->n[a]; z++)
1823     *jc++ = page->join_crossing[a][z];
1824   assert (jc == &subpage->join_crossing[a][subpage->n[a] + 1]);
1825
1826   memcpy (subpage->join_crossing[b], page->join_crossing[b],
1827           (subpage->n[b] + 1) * sizeof **subpage->join_crossing);
1828
1829   /* Select widths from PAGE into subpage. */
1830   int *scp = page->cp[a];
1831   int *dcp = subpage->cp[a];
1832   *dcp = 0;
1833   for (int z = 0; z <= rule_ofs (subpage->h[a][0]); z++, dcp++)
1834     {
1835       int w = !z && subpage->is_edge_cutoff[a][0] ? 0 : scp[z + 1] - scp[z];
1836       dcp[1] = dcp[0] + w;
1837     }
1838   for (int z = cell_ofs (z0); z <= cell_ofs (z1 - 1); z++, dcp++)
1839     {
1840       dcp[1] = dcp[0] + (scp[z + 1] - scp[z]);
1841       if (z == cell_ofs (z0))
1842         {
1843           dcp[1] -= p0;
1844           if (page->h[a][0] && page->h[a][1])
1845             dcp[1] += page->join_crossing[a][z / 2];
1846         }
1847       if (z == cell_ofs (z1 - 1))
1848         dcp[1] -= p1;
1849     }
1850   for (int z = rule_ofs_r (page, a, subpage->h[a][1]);
1851        z <= rule_ofs_r (page, a, 0); z++, dcp++)
1852     {
1853       if (z == rule_ofs_r (page, a, 0) && subpage->is_edge_cutoff[a][1])
1854         dcp[1] = dcp[0];
1855       else
1856         dcp[1] = dcp[0] + (scp[z + 1] - scp[z]);
1857     }
1858   assert (dcp == &subpage->cp[a][2 * subpage->n[a] + 1]);
1859
1860   for (int z = 0; z < page->n[b] * 2 + 2; z++)
1861     subpage->cp[b][z] = page->cp[b][z];
1862
1863   /* Add new overflows. */
1864   struct render_page_selection s = {
1865     .page = page,
1866     .a = a,
1867     .b = b,
1868     .z0 = z0,
1869     .z1 = z1,
1870     .p0 = p0,
1871     .p1 = p1,
1872     .subpage = subpage,
1873   };
1874
1875   if (!page->h[a][0] || z0 > page->h[a][0] || p0)
1876     for (int z = 0; z < page->n[b];)
1877       {
1878         int d[TABLE_N_AXES];
1879         d[a] = z0;
1880         d[b] = z;
1881
1882         struct table_cell cell;
1883         render_get_cell (page, d[H], d[V], &cell);
1884         bool overflow0 = p0 || cell.d[a][0] < z0;
1885         bool overflow1 = cell.d[a][1] > z1 || (cell.d[a][1] == z1 && p1);
1886         if (overflow0 || overflow1)
1887           {
1888             struct render_overflow *ro = insert_overflow (&s, &cell);
1889
1890             if (overflow0)
1891               {
1892                 ro->overflow[a][0] += p0 + axis_width (
1893                   page, a, cell_ofs (cell.d[a][0]), cell_ofs (z0));
1894                 if (page->h[a][0] && page->h[a][1])
1895                   ro->overflow[a][0] -= page->join_crossing[a][cell.d[a][0]
1896                                                                + 1];
1897               }
1898
1899             if (overflow1)
1900               {
1901                 ro->overflow[a][1] += p1 + axis_width (
1902                   page, a, cell_ofs (z1), cell_ofs (cell.d[a][1]));
1903                 if (page->h[a][0] && page->h[a][1])
1904                   ro->overflow[a][1] -= page->join_crossing[a][cell.d[a][1]];
1905               }
1906           }
1907         z = cell.d[b][1];
1908       }
1909
1910   if (!page->h[a][1] || z1 < page->n[a] - page->h[a][1] || p1)
1911     for (int z = 0; z < page->n[b];)
1912       {
1913         int d[TABLE_N_AXES];
1914         d[a] = z1 - 1;
1915         d[b] = z;
1916
1917         struct table_cell cell;
1918         render_get_cell (page, d[H], d[V], &cell);
1919         if ((cell.d[a][1] > z1 || (cell.d[a][1] == z1 && p1))
1920             && find_overflow_for_cell (&s, &cell) == NULL)
1921           {
1922             struct render_overflow *ro = insert_overflow (&s, &cell);
1923             ro->overflow[a][1] += p1 + axis_width (page, a, cell_ofs (z1),
1924                                                    cell_ofs (cell.d[a][1]));
1925           }
1926         z = cell.d[b][1];
1927       }
1928
1929   /* Copy overflows from PAGE into subpage. */
1930   struct render_overflow *ro;
1931   HMAP_FOR_EACH (ro, struct render_overflow, node, &page->overflows)
1932     {
1933       struct table_cell cell;
1934
1935       table_get_cell (page->table, ro->d[H], ro->d[V], &cell);
1936       if (cell.d[a][1] > z0 && cell.d[a][0] < z1
1937           && find_overflow_for_cell (&s, &cell) == NULL)
1938         insert_overflow (&s, &cell);
1939     }
1940
1941   return subpage;
1942 }
1943
1944 /* Given CELL, a table_cell within S->page, stores in SUBCELL the (x,y)
1945    coordinates of the top-left cell as it will appear in S->subpage.
1946
1947    CELL must actually intersect the region of S->page that is being selected
1948    by render_page_select() or the results will not make any sense. */
1949 static void
1950 cell_to_subpage (struct render_page_selection *s,
1951                  const struct table_cell *cell, int subcell[TABLE_N_AXES])
1952 {
1953   enum table_axis a = s->a;
1954   enum table_axis b = s->b;
1955   int ha0 = s->subpage->h[a][0];
1956
1957   subcell[a] = MAX (cell->d[a][0] - s->z0 + ha0, ha0);
1958   subcell[b] = cell->d[b][0];
1959 }
1960
1961 /* Given CELL, a table_cell within S->page, returns the render_overflow for
1962    that cell in S->subpage, if there is one, and a null pointer otherwise.
1963
1964    CELL must actually intersect the region of S->page that is being selected
1965    by render_page_select() or the results will not make any sense. */
1966 static const struct render_overflow *
1967 find_overflow_for_cell (struct render_page_selection *s,
1968                         const struct table_cell *cell)
1969 {
1970   int subcell[2];
1971
1972   cell_to_subpage (s, cell, subcell);
1973   return find_overflow (s->subpage, subcell[H], subcell[V]);
1974 }
1975
1976 /* Given CELL, a table_cell within S->page, inserts a render_overflow for that
1977    cell in S->subpage (which must not already exist).  Initializes the new
1978    render_overflow's 'overflow' member from the overflow for CELL in S->page,
1979    if there is one.
1980
1981    CELL must actually intersect the region of S->page that is being selected
1982    by render_page_select() or the results will not make any sense. */
1983 static struct render_overflow *
1984 insert_overflow (struct render_page_selection *s,
1985                  const struct table_cell *cell)
1986 {
1987   struct render_overflow *of = xzalloc (sizeof *of);
1988   cell_to_subpage (s, cell, of->d);
1989   hmap_insert (&s->subpage->overflows, &of->node,
1990                hash_cell (of->d[H], of->d[V]));
1991
1992   const struct render_overflow *old
1993     = find_overflow (s->page, cell->d[H][0], cell->d[V][0]);
1994   if (old != NULL)
1995     memcpy (of->overflow, old->overflow, sizeof of->overflow);
1996
1997   return of;
1998 }