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