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