1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2013, 2014, 2016 Free Software Foundation, Inc.
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.
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.
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/>. */
25 #include "libpspp/assertion.h"
26 #include "libpspp/hash-functions.h"
27 #include "libpspp/hmap.h"
28 #include "output/render.h"
29 #include "output/tab.h"
30 #include "output/table-item.h"
31 #include "output/table.h"
33 #include "gl/minmax.h"
34 #include "gl/xalloc.h"
37 #define _(msgid) gettext (msgid)
39 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
43 /* A layout for rendering a specific table on a specific device.
45 May represent the layout of an entire table presented to
46 render_page_create(), or a rectangular subregion of a table broken out using
47 render_break_next() to allow a table to be broken across multiple pages.
49 A page's size is not limited to the size passed in as part of render_params.
50 render_pager breaks a render_page into smaller render_pages that will fit in
51 the available space. */
54 const struct render_params *params; /* Parameters of the target device. */
55 struct table *table; /* Table rendered. */
58 /* Local copies of table->n and table->h, for convenience. */
60 int h[TABLE_N_AXES][2];
64 cp[H] represents x positions within the table.
66 cp[H][1] = the width of the leftmost vertical rule.
67 cp[H][2] = cp[H][1] + the width of the leftmost column.
68 cp[H][3] = cp[H][2] + the width of the second-from-left vertical rule.
70 cp[H][2 * nc] = x position of the rightmost vertical rule.
71 cp[H][2 * nc + 1] = total table width including all rules.
73 Similarly, cp[V] represents y positions within the table.
75 cp[V][1] = the height of the topmost horizontal rule.
76 cp[V][2] = cp[V][1] + the height of the topmost row.
77 cp[V][3] = cp[V][2] + the height of the second-from-top horizontal rule.
79 cp[V][2 * nr] = y position of the bottommost horizontal rule.
80 cp[V][2 * nr + 1] = total table height including all rules.
82 Rules and columns can have width or height 0, in which case consecutive
83 values in this array are equal. */
84 int *cp[TABLE_N_AXES];
86 /* render_break_next() can break a table such that some cells are not fully
87 contained within a render_page. This will happen if a cell is too wide
88 or two tall to fit on a single page, or if a cell spans multiple rows or
89 columns and the page only includes some of those rows or columns.
91 This hash table contains "struct render_overflow"s that represents each
92 such cell that doesn't completely fit on this page.
94 Each overflow cell borders at least one header edge of the table and may
95 border more. (A single table cell that is so large that it fills the
96 entire page can overflow on all four sides!) */
97 struct hmap overflows;
99 /* If a single column (or row) is too wide (or tall) to fit on a page
100 reasonably, then render_break_next() will split a single row or column
101 across multiple render_pages. This member indicates when this has
104 is_edge_cutoff[H][0] is true if pixels have been cut off the left side
105 of the leftmost column in this page, and false otherwise.
107 is_edge_cutoff[H][1] is true if pixels have been cut off the right side
108 of the rightmost column in this page, and false otherwise.
110 is_edge_cutoff[V][0] and is_edge_cutoff[V][1] are similar for the top
111 and bottom of the table.
113 The effect of is_edge_cutoff is to prevent rules along the edge in
114 question from being rendered.
116 When is_edge_cutoff is true for a given edge, the 'overflows' hmap will
117 contain a node for each cell along that edge. */
118 bool is_edge_cutoff[TABLE_N_AXES][2];
120 /* If part of a joined cell would be cut off by breaking a table along
121 'axis' at the rule with offset 'z' (where 0 <= z <= n[axis]), then
122 join_crossing[axis][z] is the thickness of the rule that would be cut
125 This is used to know to allocate extra space for breaking at such a
126 position, so that part of the cell's content is not lost.
128 This affects breaking a table only when headers are present. When
129 headers are not present, the rule's thickness is used for cell content,
130 so no part of the cell's content is lost (and in fact it is duplicated
131 across both pages). */
132 int *join_crossing[TABLE_N_AXES];
135 static struct render_page *render_page_create (const struct render_params *,
138 struct render_page *render_page_ref (const struct render_page *page_);
139 static void render_page_unref (struct render_page *);
141 /* Returns the offset in struct render_page's cp[axis] array of the rule with
142 index RULE_IDX. That is, if RULE_IDX is 0, then the offset is that of the
143 leftmost or topmost rule; if RULE_IDX is 1, then the offset is that of the
144 next rule to the right (or below); and so on. */
146 rule_ofs (int rule_idx)
151 /* Returns the offset in struct render_page's cp[axis] array of the rule with
152 index RULE_IDX_R, which counts from the right side (or bottom) of the page
153 left (or up), according to whether AXIS is H or V, respectively. That is,
154 if RULE_IDX_R is 0, then the offset is that of the rightmost or bottommost
155 rule; if RULE_IDX is 1, then the offset is that of the next rule to the left
156 (or above); and so on. */
158 rule_ofs_r (const struct render_page *page, int axis, int rule_idx_r)
160 return (page->n[axis] - rule_idx_r) * 2;
163 /* Returns the offset in struct render_page's cp[axis] array of the cell with
164 index CELL_IDX. That is, if CELL_IDX is 0, then the offset is that of the
165 leftmost or topmost cell; if CELL_IDX is 1, then the offset is that of the
166 next cell to the right (or below); and so on. */
168 cell_ofs (int cell_idx)
170 return cell_idx * 2 + 1;
173 /* Returns the width of PAGE along AXIS from OFS0 to OFS1, exclusive. */
175 axis_width (const struct render_page *page, int axis, int ofs0, int ofs1)
177 return page->cp[axis][ofs1] - page->cp[axis][ofs0];
180 /* Returns the width of the headers in PAGE along AXIS. */
182 headers_width (const struct render_page *page, int axis)
184 int h0 = page->h[axis][0];
185 int w0 = axis_width (page, axis, rule_ofs (0), cell_ofs (h0));
186 int n = page->n[axis];
187 int h1 = page->h[axis][1];
188 int w1 = axis_width (page, axis, rule_ofs_r (page, axis, h1), cell_ofs (n));
192 /* Returns the width of cell X along AXIS in PAGE. */
194 cell_width (const struct render_page *page, int axis, int x)
196 return axis_width (page, axis, cell_ofs (x), cell_ofs (x) + 1);
199 /* Returns the width of rule X along AXIS in PAGE. */
201 rule_width (const struct render_page *page, int axis, int x)
203 return axis_width (page, axis, rule_ofs (x), rule_ofs (x) + 1);
206 /* Returns the width of rule X along AXIS in PAGE. */
208 rule_width_r (const struct render_page *page, int axis, int x)
210 int ofs = rule_ofs_r (page, axis, x);
211 return axis_width (page, axis, ofs, ofs + 1);
214 /* Returns the width of cells X0 through X1, exclusive, along AXIS in PAGE. */
216 joined_width (const struct render_page *page, int axis, int x0, int x1)
218 return axis_width (page, axis, cell_ofs (x0), cell_ofs (x1) - 1);
221 /* Returns the width of the widest cell, excluding headers, along AXIS in
224 max_cell_width (const struct render_page *page, int axis)
226 int n = page->n[axis];
227 int x0 = page->h[axis][0];
228 int x1 = n - page->h[axis][1];
232 for (x = x0; x < x1; x++)
234 int w = cell_width (page, axis, x);
241 /* A cell that doesn't completely fit on the render_page. */
242 struct render_overflow
244 struct hmap_node node; /* In render_page's 'overflows' hmap. */
246 /* Occupied region of page.
248 d[H][0] is the leftmost column.
249 d[H][1] is the rightmost column, plus 1.
250 d[V][0] is the top row.
251 d[V][1] is the bottom row, plus 1.
253 The cell in its original table might occupy a larger region. This
254 member reflects the size of the cell in the current render_page, after
255 trimming off any rows or columns due to page-breaking. */
258 /* The space that has been trimmed off the cell:
260 overflow[H][0]: space trimmed off its left side.
261 overflow[H][1]: space trimmed off its right side.
262 overflow[V][0]: space trimmed off its top.
263 overflow[V][1]: space trimmed off its bottom.
265 During rendering, this information is used to position the rendered
266 portion of the cell within the available space.
268 When a cell is rendered, sometimes it is permitted to spill over into
269 space that is ordinarily reserved for rules. Either way, this space is
270 still included in overflow values.
272 Suppose, for example, that a cell that joins 2 columns has a width of 60
273 pixels and content "abcdef", that the 2 columns that it joins have
274 widths of 20 and 30 pixels, respectively, and that therefore the rule
275 between the two joined columns has a width of 10 (20 + 10 + 30 = 60).
276 It might render like this, if each character is 10x10, and showing a few
277 extra table cells for context:
285 If this render_page is broken at the rule that separates "gh" from
286 "ijk", then the page that contains the left side of the "abcdef" cell
287 will have overflow[H][1] of 10 + 30 = 40 for its portion of the cell,
288 and the page that contains the right side of the cell will have
289 overflow[H][0] of 20 + 10 = 30. The two resulting pages would look like
307 int overflow[TABLE_N_AXES][2];
310 /* Returns a hash value for (,Y). */
312 hash_cell (int x, int y)
314 return hash_int (x + (y << 16), 0);
317 /* Searches PAGE's set of render_overflow for one whose top-left cell is
318 (X,Y). Returns it, if there is one, otherwise a null pointer. */
319 static const struct render_overflow *
320 find_overflow (const struct render_page *page, int x, int y)
322 if (!hmap_is_empty (&page->overflows))
324 const struct render_overflow *of;
326 HMAP_FOR_EACH_WITH_HASH (of, struct render_overflow, node,
327 hash_cell (x, y), &page->overflows)
328 if (x == of->d[H] && y == of->d[V])
335 /* Row or column dimensions. Used to figure the size of a table in
336 render_page_create() and discarded after that. */
339 /* Width without considering rows (or columns) that span more than one (or
343 /* Width taking spanned rows (or columns) into consideration. */
347 /* Modifies the 'width' members of the N elements of ROWS so that their sum,
348 when added to rule widths RULES[1] through RULES[N - 1] inclusive, is at
351 distribute_spanned_width (int width,
352 struct render_row *rows, const int *rules, int n)
354 /* Sum up the unspanned widths of the N rows for use as weights. */
355 int total_unspanned = 0;
356 for (int x = 0; x < n; x++)
357 total_unspanned += rows[x].unspanned;
358 for (int x = 0; x < n - 1; x++)
359 total_unspanned += rules[x + 1];
360 if (total_unspanned >= width)
363 /* The algorithm used here is based on the following description from HTML 4:
365 For cells that span multiple columns, a simple approach consists of
366 apportioning the min/max widths evenly to each of the constituent
367 columns. A slightly more complex approach is to use the min/max
368 widths of unspanned cells to weight how spanned widths are
369 apportioned. Experiments suggest that a blend of the two approaches
370 gives good results for a wide range of tables.
372 We blend the two approaches half-and-half, except that we cannot use the
373 unspanned weights when 'total_unspanned' is 0 (because that would cause a
376 The calculation we want to do is this:
379 w1 = width * (column's unspanned width) / (total unspanned width)
380 (column's width) = (w0 + w1) / 2
382 We implement it as a precise calculation in integers by multiplying w0 and
383 w1 by the common denominator of all three calculations (d), dividing that
384 out in the column width calculation, and then keeping the remainder for
387 (We actually compute the unspanned width of a column as twice the
388 unspanned width, plus the width of the rule on the left, plus the width of
389 the rule on the right. That way each rule contributes to both the cell on
390 its left and on its right.)
392 long long int d0 = n;
393 long long int d1 = 2LL * MAX (total_unspanned, 1);
394 long long int d = d0 * d1;
395 if (total_unspanned > 0)
397 long long int w = d / 2;
398 for (int x = 0; x < n; x++)
401 if (total_unspanned > 0)
403 long long int unspanned = rows[x].unspanned * 2LL;
405 unspanned += rules[x + 1];
407 unspanned += rules[x];
408 w += width * unspanned * d0;
411 rows[x].width = MAX (rows[x].width, w / d);
412 w -= rows[x].width * d;
416 /* Initializes PAGE->cp[AXIS] from the row widths in ROWS and the rule widths
419 accumulate_row_widths (const struct render_page *page, enum table_axis axis,
420 const struct render_row *rows, const int *rules)
422 int n = page->n[axis];
428 for (z = 0; z < n; z++)
430 cp[1] = cp[0] + rules[z];
431 cp[2] = cp[1] + rows[z].width;
434 cp[1] = cp[0] + rules[n];
437 /* Returns the sum of widths of the N ROWS and N+1 RULES. */
439 calculate_table_width (int n, const struct render_row *rows, int *rules)
445 for (x = 0; x < n; x++)
446 width += rows[x].width;
447 for (x = 0; x <= n; x++)
453 /* Rendering utility functions. */
455 /* Returns the line style to use for drawing a rule of the given TYPE. */
456 static enum render_line_style
457 rule_to_render_type (unsigned char type)
462 return RENDER_LINE_NONE;
464 return RENDER_LINE_SINGLE;
466 return RENDER_LINE_DOUBLE;
472 /* Returns the width of the rule in TABLE that is at offset Z along axis A, if
473 rendered with PARAMS. */
475 measure_rule (const struct render_params *params, const struct table *table,
476 enum table_axis a, int z)
478 enum table_axis b = !a;
483 /* Determine all types of rules that are present, as a bitmap in 'rules'
484 where rule type 't' is present if bit 2**t is set. */
487 for (d[b] = 0; d[b] < table->n[b]; d[b]++)
488 rules |= 1u << table_get_rule (table, a, d[H], d[V]);
490 /* Turn off TAL_NONE because it has width 0 and we needn't bother. However,
491 if the device doesn't support margins, make sure that there is at least a
492 small gap between cells (but we don't need any at the left or right edge
494 if (rules & (1u << TAL_0))
496 rules &= ~(1u << TAL_0);
497 if (z > 0 && z < table->n[a] && !params->supports_margins && a == H)
498 rules |= 1u << TAL_1;
501 /* Calculate maximum width of the rules that are present. */
503 if (rules & (1u << TAL_1)
504 || (z > 0 && z < table->n[a] && rules & (1u << TAL_0)))
505 width = params->line_widths[a][RENDER_LINE_SINGLE];
506 if (rules & (1u << TAL_2))
507 width = MAX (width, params->line_widths[a][RENDER_LINE_DOUBLE]);
511 /* Allocates and returns a new render_page using PARAMS and TABLE. Allocates
512 space for all of the members of the new page, but the caller must initialize
513 the 'cp' member itself. */
514 static struct render_page *
515 render_page_allocate (const struct render_params *params,
518 struct render_page *page;
521 page = xmalloc (sizeof *page);
522 page->params = params;
525 page->n[H] = table->n[H];
526 page->n[V] = table->n[V];
527 page->h[H][0] = table->h[H][0];
528 page->h[H][1] = table->h[H][1];
529 page->h[V][0] = table->h[V][0];
530 page->h[V][1] = table->h[V][1];
532 for (i = 0; i < TABLE_N_AXES; i++)
534 page->cp[i] = xmalloc ((2 * page->n[i] + 2) * sizeof *page->cp[i]);
535 page->join_crossing[i] = xzalloc ((page->n[i] + 1) * sizeof *page->join_crossing[i]);
538 hmap_init (&page->overflows);
539 memset (page->is_edge_cutoff, 0, sizeof page->is_edge_cutoff);
544 /* Allocates and returns a new render_page for PARAMS and TABLE, initializing
545 cp[H] in the new page from ROWS and RULES. The caller must still initialize
547 static struct render_page *
548 create_page_with_exact_widths (const struct render_params *params,
550 const struct render_row *rows, int *rules)
552 struct render_page *page = render_page_allocate (params, table);
553 accumulate_row_widths (page, H, rows, rules);
557 /* Allocates and returns a new render_page for PARAMS and TABLE.
559 Initializes cp[H] in the new page by setting the width of each row 'i' to
560 somewhere between the minimum cell width ROW_MIN[i].width and the maximum
561 ROW_MAX[i].width. Sets the width of rules to those in RULES.
563 W_MIN is the sum of ROWS_MIN[].width.
565 W_MAX is the sum of ROWS_MAX[].width.
567 The caller must still initialize cp[V]. */
568 static struct render_page *
569 create_page_with_interpolated_widths (const struct render_params *params,
571 const struct render_row *rows_min,
572 const struct render_row *rows_max,
573 int w_min, int w_max, const int *rules)
575 const int n = table->n[H];
576 const long long int avail = params->size[H] - w_min;
577 const long long int wanted = w_max - w_min;
581 struct render_page *page = render_page_allocate (params, table);
583 int *cph = page->cp[H];
585 long long int w = wanted / 2;
586 for (int x = 0; x < n; x++)
588 w += avail * (rows_max[x].width - rows_min[x].width);
589 int extra = w / wanted;
592 cph[1] = cph[0] + rules[x];
593 cph[2] = cph[1] + rows_min[x].width + extra;
596 cph[1] = cph[0] + rules[n];
598 assert (page->cp[H][n * 2 + 1] == params->size[H]);
604 set_join_crossings (struct render_page *page, enum table_axis axis,
605 const struct table_cell *cell, int *rules)
609 for (z = cell->d[axis][0] + 1; z <= cell->d[axis][1] - 1; z++)
610 page->join_crossing[axis][z] = rules[z];
613 /* Creates and returns a new render_page for rendering TABLE on a device
616 The new render_page will be suitable for rendering on a device whose page
617 size is PARAMS->size, but the caller is responsible for actually breaking it
618 up to fit on such a device, using the render_break abstraction. */
619 static struct render_page *
620 render_page_create (const struct render_params *params, struct table *table)
622 struct render_page *page;
624 struct render_row *columns[2];
625 struct render_row *rows;
627 int *rules[TABLE_N_AXES];
631 enum table_axis axis;
633 nc = table_nc (table);
634 nr = table_nr (table);
636 /* Figure out rule widths. */
637 for (axis = 0; axis < TABLE_N_AXES; axis++)
639 int n = table->n[axis] + 1;
642 rules[axis] = xnmalloc (n, sizeof *rules);
643 for (z = 0; z < n; z++)
644 rules[axis][z] = measure_rule (params, table, axis, z);
647 /* Calculate minimum and maximum widths of cells that do not
648 span multiple columns. */
649 for (i = 0; i < 2; i++)
650 columns[i] = xzalloc (nc * sizeof *columns[i]);
651 for (y = 0; y < nr; y++)
652 for (x = 0; x < nc; )
654 struct table_cell cell;
656 table_get_cell (table, x, y, &cell);
657 if (y == cell.d[V][0])
659 if (table_cell_colspan (&cell) == 1)
664 params->measure_cell_width (params->aux, &cell,
666 for (i = 0; i < 2; i++)
667 if (columns[i][x].unspanned < w[i])
668 columns[i][x].unspanned = w[i];
672 table_cell_free (&cell);
675 /* Distribute widths of spanned columns. */
676 for (i = 0; i < 2; i++)
677 for (x = 0; x < nc; x++)
678 columns[i][x].width = columns[i][x].unspanned;
679 for (y = 0; y < nr; y++)
680 for (x = 0; x < nc; )
682 struct table_cell cell;
684 table_get_cell (table, x, y, &cell);
685 if (y == cell.d[V][0] && table_cell_colspan (&cell) > 1)
689 params->measure_cell_width (params->aux, &cell, &w[MIN], &w[MAX]);
690 for (i = 0; i < 2; i++)
691 distribute_spanned_width (w[i], &columns[i][cell.d[H][0]],
692 rules[H], table_cell_colspan (&cell));
695 table_cell_free (&cell);
698 /* In pathological cases, spans can cause the minimum width of a column to
699 exceed the maximum width. This bollixes our interpolation algorithm
700 later, so fix it up. */
701 for (i = 0; i < nc; i++)
702 if (columns[MIN][i].width > columns[MAX][i].width)
703 columns[MAX][i].width = columns[MIN][i].width;
705 /* Decide final column widths. */
706 for (i = 0; i < 2; i++)
707 table_widths[i] = calculate_table_width (table_nc (table),
708 columns[i], rules[H]);
709 if (table_widths[MAX] <= params->size[H])
711 /* Fits even with maximum widths. Use them. */
712 page = create_page_with_exact_widths (params, table, columns[MAX],
715 else if (table_widths[MIN] <= params->size[H])
717 /* Fits with minimum widths, so distribute the leftover space. */
718 page = create_page_with_interpolated_widths (
719 params, table, columns[MIN], columns[MAX],
720 table_widths[MIN], table_widths[MAX], rules[H]);
724 /* Doesn't fit even with minimum widths. Assign minimums for now, and
725 later we can break it horizontally into multiple pages. */
726 page = create_page_with_exact_widths (params, table, columns[MIN],
730 /* Calculate heights of cells that do not span multiple rows. */
731 rows = xzalloc (nr * sizeof *rows);
732 for (y = 0; y < nr; y++)
734 for (x = 0; x < nc; )
736 struct render_row *r = &rows[y];
737 struct table_cell cell;
739 table_get_cell (table, x, y, &cell);
740 if (y == cell.d[V][0])
742 if (table_cell_rowspan (&cell) == 1)
744 int w = joined_width (page, H, cell.d[H][0], cell.d[H][1]);
745 int h = params->measure_cell_height (params->aux, &cell, w);
746 if (h > r->unspanned)
747 r->unspanned = r->width = h;
750 set_join_crossings (page, V, &cell, rules[V]);
752 if (table_cell_colspan (&cell) > 1)
753 set_join_crossings (page, H, &cell, rules[H]);
756 table_cell_free (&cell);
759 for (i = 0; i < 2; i++)
762 /* Distribute heights of spanned rows. */
763 for (y = 0; y < nr; y++)
764 for (x = 0; x < nc; )
766 struct table_cell cell;
768 table_get_cell (table, x, y, &cell);
769 if (y == cell.d[V][0] && table_cell_rowspan (&cell) > 1)
771 int w = joined_width (page, H, cell.d[H][0], cell.d[H][1]);
772 int h = params->measure_cell_height (params->aux, &cell, w);
773 distribute_spanned_width (h, &rows[cell.d[V][0]], rules[V],
774 table_cell_rowspan (&cell));
777 table_cell_free (&cell);
780 /* Decide final row heights. */
781 accumulate_row_widths (page, V, rows, rules[V]);
784 /* Measure headers. If they are "too big", get rid of them. */
785 for (axis = 0; axis < TABLE_N_AXES; axis++)
787 int hw = headers_width (page, axis);
788 if (hw * 2 >= page->params->size[axis]
789 || hw + max_cell_width (page, axis) > page->params->size[axis])
791 page->table = table_unshare (page->table);
792 page->table->h[axis][0] = page->table->h[axis][1] = 0;
793 page->h[axis][0] = page->h[axis][1] = 0;
803 /* Increases PAGE's reference count. */
805 render_page_ref (const struct render_page *page_)
807 struct render_page *page = CONST_CAST (struct render_page *, page_);
812 /* Decreases PAGE's reference count and destroys PAGE if this causes the
813 reference count to fall to zero. */
815 render_page_unref (struct render_page *page)
817 if (page != NULL && --page->ref_cnt == 0)
820 struct render_overflow *overflow, *next;
822 HMAP_FOR_EACH_SAFE (overflow, next, struct render_overflow, node,
825 hmap_destroy (&page->overflows);
827 table_unref (page->table);
829 for (i = 0; i < TABLE_N_AXES; ++i)
831 free (page->join_crossing[i]);
839 /* Returns the size of PAGE along AXIS. (This might be larger than the page
840 size specified in the parameters passed to render_page_create(). Use a
841 render_break to break up a render_page into page-sized chunks.) */
843 render_page_get_size (const struct render_page *page, enum table_axis axis)
845 return page->cp[axis][page->n[axis] * 2 + 1];
849 render_page_get_best_breakpoint (const struct render_page *page, int height)
853 /* If there's no room for at least the top row and the rules above and below
854 it, don't include any of the table. */
855 if (page->cp[V][3] > height)
858 /* Otherwise include as many rows and rules as we can. */
859 for (y = 5; y <= 2 * page->n[V] + 1; y += 2)
860 if (page->cp[V][y] > height)
861 return page->cp[V][y - 2];
865 /* Drawing render_pages. */
867 static inline enum render_line_style
868 get_rule (const struct render_page *page, enum table_axis axis,
869 const int d[TABLE_N_AXES])
871 return rule_to_render_type (table_get_rule (page->table,
872 axis, d[H] / 2, d[V] / 2));
882 render_direction_rtl (void)
884 /* TRANSLATORS: Do not translate this string. If the script of your language
885 reads from right to left (eg Persian, Arabic, Hebrew etc), then replace
886 this string with "output-direction-rtl". Otherwise either leave it
887 untranslated or copy it verbatim. */
888 const char *dir = _("output-direction-ltr");
889 if ( 0 == strcmp ("output-direction-rtl", dir))
892 if ( 0 != strcmp ("output-direction-ltr", dir))
893 fprintf (stderr, "This localisation has been incorrectly translated. Complain to the translator.\n");
899 render_rule (const struct render_page *page, const int ofs[TABLE_N_AXES],
900 const int d[TABLE_N_AXES])
902 enum render_line_style styles[TABLE_N_AXES][2];
905 for (a = 0; a < TABLE_N_AXES; a++)
907 enum table_axis b = !a;
909 styles[a][0] = styles[a][1] = RENDER_LINE_NONE;
912 || (page->is_edge_cutoff[a][0] && d[a] == 0)
913 || (page->is_edge_cutoff[a][1] && d[a] == page->n[a] * 2))
924 styles[a][0] = get_rule (page, a, e);
927 if (d[b] / 2 < page->table->n[b])
928 styles[a][1] = get_rule (page, a, d);
931 styles[a][0] = styles[a][1] = get_rule (page, a, d);
934 if (styles[H][0] != RENDER_LINE_NONE || styles[H][1] != RENDER_LINE_NONE
935 || styles[V][0] != RENDER_LINE_NONE || styles[V][1] != RENDER_LINE_NONE)
937 int bb[TABLE_N_AXES][2];
939 bb[H][0] = ofs[H] + page->cp[H][d[H]];
940 bb[H][1] = ofs[H] + page->cp[H][d[H] + 1];
941 if (render_direction_rtl ())
944 bb[H][0] = render_page_get_size (page, H) - bb[H][1];
945 bb[H][1] = render_page_get_size (page, H) - temp;
947 bb[V][0] = ofs[V] + page->cp[V][d[V]];
948 bb[V][1] = ofs[V] + page->cp[V][d[V] + 1];
949 page->params->draw_line (page->params->aux, bb, styles);
954 render_cell (const struct render_page *page, const int ofs[TABLE_N_AXES],
955 const struct table_cell *cell)
957 const struct render_overflow *of;
958 int bb[TABLE_N_AXES][2];
959 int clip[TABLE_N_AXES][2];
961 bb[H][0] = clip[H][0] = ofs[H] + page->cp[H][cell->d[H][0] * 2 + 1];
962 bb[H][1] = clip[H][1] = ofs[H] + page->cp[H][cell->d[H][1] * 2];
963 if (render_direction_rtl ())
966 bb[H][0] = clip[H][0] = render_page_get_size (page, H) - bb[H][1];
967 bb[H][1] = clip[H][1] = render_page_get_size (page, H) - temp;
969 bb[V][0] = clip[V][0] = ofs[V] + page->cp[V][cell->d[V][0] * 2 + 1];
970 bb[V][1] = clip[V][1] = ofs[V] + page->cp[V][cell->d[V][1] * 2];
972 int valign = (cell->n_contents
973 ? cell->contents->options & TAB_VALIGN
975 if (valign != TAB_TOP)
977 int height = page->params->measure_cell_height (
978 page->params->aux, cell, bb[H][1] - bb[H][0]);
979 int extra = bb[V][1] - bb[V][0] - height;
982 if (valign == TAB_MIDDLE)
988 of = find_overflow (page, cell->d[H][0], cell->d[V][0]);
991 enum table_axis axis;
993 for (axis = 0; axis < TABLE_N_AXES; axis++)
995 if (of->overflow[axis][0])
997 bb[axis][0] -= of->overflow[axis][0];
998 if (cell->d[axis][0] == 0 && !page->is_edge_cutoff[axis][0])
999 clip[axis][0] = ofs[axis] + page->cp[axis][cell->d[axis][0] * 2];
1001 if (of->overflow[axis][1])
1003 bb[axis][1] += of->overflow[axis][1];
1004 if (cell->d[axis][1] == page->n[axis] && !page->is_edge_cutoff[axis][1])
1005 clip[axis][1] = ofs[axis] + page->cp[axis][cell->d[axis][1] * 2 + 1];
1010 page->params->draw_cell (page->params->aux, cell, bb, clip);
1013 /* Draws the cells of PAGE indicated in BB. */
1015 render_page_draw_cells (const struct render_page *page,
1016 int ofs[TABLE_N_AXES], int bb[TABLE_N_AXES][2])
1020 for (y = bb[V][0]; y < bb[V][1]; y++)
1021 for (x = bb[H][0]; x < bb[H][1]; )
1022 if (is_rule (x) || is_rule (y))
1024 int d[TABLE_N_AXES];
1027 render_rule (page, ofs, d);
1032 struct table_cell cell;
1034 table_get_cell (page->table, x / 2, y / 2, &cell);
1035 if (y / 2 == bb[V][0] / 2 || y / 2 == cell.d[V][0])
1036 render_cell (page, ofs, &cell);
1037 x = rule_ofs (cell.d[H][1]);
1038 table_cell_free (&cell);
1042 /* Renders PAGE, by calling the 'draw_line' and 'draw_cell' functions from the
1043 render_params provided to render_page_create(). */
1045 render_page_draw (const struct render_page *page, int ofs[TABLE_N_AXES])
1047 int bb[TABLE_N_AXES][2];
1050 bb[H][1] = page->n[H] * 2 + 1;
1052 bb[V][1] = page->n[V] * 2 + 1;
1054 render_page_draw_cells (page, ofs, bb);
1057 /* Returns the greatest value i, 0 <= i < n, such that cp[i] <= x0. */
1059 get_clip_min_extent (int x0, const int cp[], int n)
1061 int low, high, best;
1068 int middle = low + (high - low) / 2;
1070 if (cp[middle] <= x0)
1082 /* Returns the least value i, 0 <= i < n, such that cp[i] >= x1. */
1084 get_clip_max_extent (int x1, const int cp[], int n)
1086 int low, high, best;
1093 int middle = low + (high - low) / 2;
1095 if (cp[middle] >= x1)
1096 best = high = middle;
1101 while (best > 0 && cp[best - 1] == cp[best])
1107 /* Renders the cells of PAGE that intersect (X,Y)-(X+W,Y+H), by calling the
1108 'draw_line' and 'draw_cell' functions from the render_params provided to
1109 render_page_create(). */
1111 render_page_draw_region (const struct render_page *page,
1112 int ofs[TABLE_N_AXES], int clip[TABLE_N_AXES][2])
1114 int bb[TABLE_N_AXES][2];
1116 bb[H][0] = get_clip_min_extent (clip[H][0], page->cp[H], page->n[H] * 2 + 1);
1117 bb[H][1] = get_clip_max_extent (clip[H][1], page->cp[H], page->n[H] * 2 + 1);
1118 bb[V][0] = get_clip_min_extent (clip[V][0], page->cp[V], page->n[V] * 2 + 1);
1119 bb[V][1] = get_clip_max_extent (clip[V][1], page->cp[V], page->n[V] * 2 + 1);
1121 render_page_draw_cells (page, ofs, bb);
1124 /* Breaking up tables to fit on a page. */
1126 /* An iterator for breaking render_pages into smaller chunks. */
1129 struct render_page *page; /* Page being broken up. */
1130 enum table_axis axis; /* Axis along which 'page' is being broken. */
1131 int z; /* Next cell along 'axis'. */
1132 int pixel; /* Pixel offset within cell 'z' (usually 0). */
1133 int hw; /* Width of headers of 'page' along 'axis'. */
1136 static int needed_size (const struct render_break *, int cell);
1137 static bool cell_is_breakable (const struct render_break *, int cell);
1138 static struct render_page *render_page_select (const struct render_page *,
1143 /* Initializes render_break B for breaking PAGE along AXIS.
1144 Takes ownership of PAGE. */
1146 render_break_init (struct render_break *b, struct render_page *page,
1147 enum table_axis axis)
1151 b->z = page->h[axis][0];
1153 b->hw = headers_width (page, axis);
1156 /* Initializes B as a render_break structure for which
1157 render_break_has_next() always returns false. */
1159 render_break_init_empty (struct render_break *b)
1162 b->axis = TABLE_HORZ;
1168 /* Frees B and unrefs the render_page that it owns. */
1170 render_break_destroy (struct render_break *b)
1174 render_page_unref (b->page);
1179 /* Returns true if B still has cells that are yet to be returned,
1180 false if all of B's page has been processed. */
1182 render_break_has_next (const struct render_break *b)
1184 const struct render_page *page = b->page;
1185 enum table_axis axis = b->axis;
1187 return page != NULL && b->z < page->n[axis] - page->h[axis][1];
1190 /* Returns a new render_page that is up to SIZE pixels wide along B's axis.
1191 Returns a null pointer if B has already been completely broken up, or if
1192 SIZE is too small to reasonably render any cells. The latter will never
1193 happen if SIZE is at least as large as the page size passed to
1194 render_page_create() along B's axis. */
1195 static struct render_page *
1196 render_break_next (struct render_break *b, int size)
1198 const struct render_page *page = b->page;
1199 enum table_axis axis = b->axis;
1200 struct render_page *subpage;
1203 if (!render_break_has_next (b))
1207 for (z = b->z; z < page->n[axis] - page->h[axis][1]; z++)
1209 int needed = needed_size (b, z + 1);
1212 if (cell_is_breakable (b, z))
1214 /* If there is no right header and we render a partial cell on
1215 the right side of the body, then we omit the rightmost rule of
1216 the body. Otherwise the rendering is deceptive because it
1217 looks like the whole cell is present instead of a partial
1220 This is similar to code for the left side in needed_size(). */
1221 int rule_allowance = (page->h[axis][1]
1223 : rule_width (page, axis, z));
1225 /* The amount that, if we added cell 'z', the rendering would
1226 overfill the allocated 'size'. */
1227 int overhang = needed - size - rule_allowance;
1229 /* The width of cell 'z'. */
1230 int cell_size = cell_width (page, axis, z);
1232 /* The amount trimmed off the left side of 'z',
1233 and the amount left to render. */
1234 int cell_ofs = z == b->z ? b->pixel : 0;
1235 int cell_left = cell_size - cell_ofs;
1237 /* A small but visible width. */
1238 int em = page->params->font_size[axis];
1240 /* If some of the cell remains to render,
1241 and there would still be some of the cell left afterward,
1242 then partially render that much of the cell. */
1243 pixel = (cell_left && cell_left > overhang
1244 ? cell_left - overhang + cell_ofs
1247 /* If there would be only a tiny amount of the cell left after
1248 rendering it partially, reduce the amount rendered slightly
1249 to make the output look a little better. */
1250 if (pixel + em > cell_size)
1251 pixel = MAX (pixel - em, 0);
1253 /* If we're breaking vertically, then consider whether the cells
1254 being broken have a better internal breakpoint than the exact
1255 number of pixels available, which might look bad e.g. because
1256 it breaks in the middle of a line of text. */
1257 if (axis == TABLE_VERT && page->params->adjust_break)
1261 for (x = 0; x < page->n[H]; )
1263 struct table_cell cell;
1267 table_get_cell (page->table, x, z, &cell);
1268 w = joined_width (page, H, cell.d[H][0], cell.d[H][1]);
1269 better_pixel = page->params->adjust_break (
1270 page->params->aux, &cell, w, pixel);
1272 table_cell_free (&cell);
1274 if (better_pixel < pixel)
1276 if (better_pixel > (z == b->z ? b->pixel : 0))
1278 pixel = better_pixel;
1281 else if (better_pixel == 0 && z != b->z)
1294 if (z == b->z && !pixel)
1297 subpage = render_page_select (page, axis, b->z, b->pixel,
1299 pixel ? cell_width (page, axis, z) - pixel
1306 /* Returns the width that would be required along B's axis to render a page
1307 from B's current position up to but not including CELL. */
1309 needed_size (const struct render_break *b, int cell)
1311 const struct render_page *page = b->page;
1312 enum table_axis axis = b->axis;
1315 /* Width of left header not including its rightmost rule. */
1316 size = axis_width (page, axis, 0, rule_ofs (page->h[axis][0]));
1318 /* If we have a pixel offset and there is no left header, then we omit the
1319 leftmost rule of the body. Otherwise the rendering is deceptive because
1320 it looks like the whole cell is present instead of a partial cell.
1322 Otherwise (if there are headers) we will be merging two rules: the
1323 rightmost rule in the header and the leftmost rule in the body. We assume
1324 that the width of a merged rule is the larger of the widths of either rule
1326 if (b->pixel == 0 || page->h[axis][0])
1327 size += MAX (rule_width (page, axis, page->h[axis][0]),
1328 rule_width (page, axis, b->z));
1330 /* Width of body, minus any pixel offset in the leftmost cell. */
1331 size += joined_width (page, axis, b->z, cell) - b->pixel;
1333 /* Width of rightmost rule in body merged with leftmost rule in headers. */
1334 size += MAX (rule_width_r (page, axis, page->h[axis][1]),
1335 rule_width (page, axis, cell));
1337 /* Width of right header not including its leftmost rule. */
1338 size += axis_width (page, axis, rule_ofs_r (page, axis, page->h[axis][1]),
1339 rule_ofs_r (page, axis, 0));
1341 /* Join crossing. */
1342 if (page->h[axis][0] && page->h[axis][1])
1343 size += page->join_crossing[axis][b->z];
1348 /* Returns true if CELL along B's axis may be broken across a page boundary.
1350 This is just a heuristic. Breaking cells across page boundaries can save
1351 space, but it looks ugly. */
1353 cell_is_breakable (const struct render_break *b, int cell)
1355 const struct render_page *page = b->page;
1356 enum table_axis axis = b->axis;
1358 return cell_width (page, axis, cell) >= page->params->min_break[axis];
1365 const struct render_params *params;
1367 struct render_page **pages;
1368 size_t n_pages, allocated_pages;
1371 struct render_break x_break;
1372 struct render_break y_break;
1375 static const struct render_page *
1376 render_pager_add_table (struct render_pager *p, struct table *table)
1378 struct render_page *page;
1380 if (p->n_pages >= p->allocated_pages)
1381 p->pages = x2nrealloc (p->pages, &p->allocated_pages, sizeof *p->pages);
1382 page = p->pages[p->n_pages++] = render_page_create (p->params, table);
1387 render_pager_start_page (struct render_pager *p)
1389 render_break_init (&p->x_break, render_page_ref (p->pages[p->cur_page++]),
1391 render_break_init_empty (&p->y_break);
1395 add_footnote_page (struct render_pager *p, const struct table_item *item)
1397 const struct footnote **f;
1398 size_t n_footnotes = table_collect_footnotes (item, &f);
1402 struct tab_table *t = tab_create (2, n_footnotes);
1404 for (size_t i = 0; i < n_footnotes; i++)
1407 tab_text_format (t, 0, i, TAB_LEFT, "%s.", f[i]->marker);
1408 tab_text (t, 1, i, TAB_LEFT, f[i]->content);
1410 render_pager_add_table (p, &t->table);
1416 add_text_page (struct render_pager *p, const struct table_item_text *t)
1421 struct tab_table *tab = tab_create (1, 1);
1422 tab_text (tab, 0, 0, TAB_LEFT, t->content);
1423 for (size_t i = 0; i < t->n_footnotes; i++)
1424 tab_add_footnote (tab, 0, 0, t->footnotes[i]);
1425 render_pager_add_table (p, &tab->table);
1428 /* Creates and returns a new render_pager for rendering TABLE_ITEM on the
1429 device with the given PARAMS. */
1430 struct render_pager *
1431 render_pager_create (const struct render_params *params,
1432 const struct table_item *table_item)
1434 struct render_pager *p;
1436 p = xzalloc (sizeof *p);
1440 add_text_page (p, table_item_get_title (table_item));
1443 render_pager_add_table (p, table_ref (table_item_get_table (table_item)));
1446 add_text_page (p, table_item_get_caption (table_item));
1449 add_footnote_page (p, table_item);
1451 render_pager_start_page (p);
1458 render_pager_destroy (struct render_pager *p)
1464 render_break_destroy (&p->x_break);
1465 render_break_destroy (&p->y_break);
1466 for (i = 0; i < p->n_pages; i++)
1467 render_page_unref (p->pages[i]);
1473 /* Returns true if P has content remaining to render, false if rendering is
1476 render_pager_has_next (const struct render_pager *p_)
1478 struct render_pager *p = CONST_CAST (struct render_pager *, p_);
1480 while (!render_break_has_next (&p->y_break))
1482 render_break_destroy (&p->y_break);
1483 if (!render_break_has_next (&p->x_break))
1485 render_break_destroy (&p->x_break);
1486 if (p->cur_page >= p->n_pages)
1488 render_break_init_empty (&p->x_break);
1489 render_break_init_empty (&p->y_break);
1492 render_pager_start_page (p);
1495 render_break_init (&p->y_break,
1496 render_break_next (&p->x_break, p->params->size[H]), V);
1501 /* Draws a chunk of content from P to fit in a space that has vertical size
1502 SPACE and the horizontal size specified in the render_params passed to
1503 render_page_create(). Returns the amount of space actually used by the
1504 rendered chunk, which will be 0 if SPACE is too small to render anything or
1505 if no content remains (use render_pager_has_next() to distinguish these
1508 render_pager_draw_next (struct render_pager *p, int space)
1510 int ofs[TABLE_N_AXES] = { 0, 0 };
1511 size_t start_page = SIZE_MAX;
1513 while (render_pager_has_next (p))
1515 struct render_page *page;
1517 if (start_page == p->cur_page)
1519 start_page = p->cur_page;
1521 page = render_break_next (&p->y_break, space - ofs[V]);
1525 render_page_draw (page, ofs);
1526 ofs[V] += render_page_get_size (page, V);
1527 render_page_unref (page);
1532 /* Draws all of P's content. */
1534 render_pager_draw (const struct render_pager *p)
1536 render_pager_draw_region (p, 0, 0, INT_MAX, INT_MAX);
1539 /* Draws the region of P's content that lies in the region (X,Y)-(X+W,Y+H).
1540 Some extra content might be drawn; the device should perform clipping as
1543 render_pager_draw_region (const struct render_pager *p,
1544 int x, int y, int w, int h)
1546 int ofs[TABLE_N_AXES] = { 0, 0 };
1547 int clip[TABLE_N_AXES][2];
1552 for (i = 0; i < p->n_pages; i++)
1554 const struct render_page *page = p->pages[i];
1555 int size = render_page_get_size (page, V);
1557 clip[V][0] = MAX (y, ofs[V]) - ofs[V];
1558 clip[V][1] = MIN (y + h, ofs[V] + size) - ofs[V];
1559 if (clip[V][1] > clip[V][0])
1560 render_page_draw_region (page, ofs, clip);
1566 /* Returns the size of P's content along AXIS; i.e. the content's width if AXIS
1567 is TABLE_HORZ and its length if AXIS is TABLE_VERT. */
1569 render_pager_get_size (const struct render_pager *p, enum table_axis axis)
1574 for (i = 0; i < p->n_pages; i++)
1576 int subsize = render_page_get_size (p->pages[i], axis);
1577 size = axis == H ? MAX (size, subsize) : size + subsize;
1584 render_pager_get_best_breakpoint (const struct render_pager *p, int height)
1589 for (i = 0; i < p->n_pages; i++)
1591 int size = render_page_get_size (p->pages[i], V);
1592 if (y + size >= height)
1593 return render_page_get_best_breakpoint (p->pages[i], height - y) + y;
1600 /* render_page_select() and helpers. */
1602 struct render_page_selection
1604 const struct render_page *page; /* Page whose slice we are selecting. */
1605 struct render_page *subpage; /* New page under construction. */
1606 enum table_axis a; /* Axis of 'page' along which 'subpage' is a slice. */
1607 enum table_axis b; /* The opposite of 'a'. */
1608 int z0; /* First cell along 'a' being selected. */
1609 int z1; /* Last cell being selected, plus 1. */
1610 int p0; /* Number of pixels to trim off left side of z0. */
1611 int p1; /* Number of pixels to trim off right side of z1-1. */
1614 static void cell_to_subpage (struct render_page_selection *,
1615 const struct table_cell *,
1616 int subcell[TABLE_N_AXES]);
1617 static const struct render_overflow *find_overflow_for_cell (
1618 struct render_page_selection *, const struct table_cell *);
1619 static struct render_overflow *insert_overflow (struct render_page_selection *,
1620 const struct table_cell *);
1622 /* Creates and returns a new render_page whose contents are a subregion of
1623 PAGE's contents. The new render_page includes cells Z0 through Z1
1624 (exclusive) along AXIS, plus any headers on AXIS.
1626 If P0 is nonzero, then it is a number of pixels to exclude from the left or
1627 top (according to AXIS) of cell Z0. Similarly, P1 is a number of pixels to
1628 exclude from the right or bottom of cell Z1 - 1. (P0 and P1 are used to
1629 render cells that are too large to fit on a single page.)
1631 The whole of axis !AXIS is included. (The caller may follow up with another
1632 call to render_page_select() to select on !AXIS to select on that axis as
1635 The caller retains ownership of PAGE, which is not modified. */
1636 static struct render_page *
1637 render_page_select (const struct render_page *page, enum table_axis axis,
1638 int z0, int p0, int z1, int p1)
1640 struct render_page_selection s;
1641 enum table_axis a = axis;
1642 enum table_axis b = !a;
1643 struct render_page *subpage;
1644 struct render_overflow *ro;
1650 /* Optimize case where all of PAGE is selected by just incrementing the
1652 if (z0 == page->h[a][0] && p0 == 0
1653 && z1 == page->n[a] - page->h[a][1] && p1 == 0)
1655 struct render_page *page_rw = CONST_CAST (struct render_page *, page);
1660 /* Allocate subpage. */
1661 subpage = render_page_allocate (page->params,
1662 table_select_slice (
1663 table_ref (page->table),
1666 /* An edge is cut off if it was cut off in PAGE or if we're trimming pixels
1667 off that side of the page and there are no headers. */
1668 subpage->is_edge_cutoff[a][0] =
1669 subpage->h[a][0] == 0 && (p0 || (z0 == 0 && page->is_edge_cutoff[a][0]));
1670 subpage->is_edge_cutoff[a][1] =
1671 subpage->h[a][1] == 0 && (p1 || (z1 == page->n[a]
1672 && page->is_edge_cutoff[a][1]));
1673 subpage->is_edge_cutoff[b][0] = page->is_edge_cutoff[b][0];
1674 subpage->is_edge_cutoff[b][1] = page->is_edge_cutoff[b][1];
1676 /* Select join crossings from PAGE into subpage. */
1677 jc = subpage->join_crossing[a];
1678 for (z = 0; z < page->h[a][0]; z++)
1679 *jc++ = page->join_crossing[a][z];
1680 for (z = z0; z <= z1; z++)
1681 *jc++ = page->join_crossing[a][z];
1682 for (z = page->n[a] - page->h[a][1]; z < page->n[a]; z++)
1683 *jc++ = page->join_crossing[a][z];
1684 assert (jc == &subpage->join_crossing[a][subpage->n[a] + 1]);
1686 memcpy (subpage->join_crossing[b], page->join_crossing[b],
1687 (subpage->n[b] + 1) * sizeof **subpage->join_crossing);
1689 /* Select widths from PAGE into subpage. */
1691 dcp = subpage->cp[a];
1693 for (z = 0; z <= rule_ofs (subpage->h[a][0]); z++, dcp++)
1695 if (z == 0 && subpage->is_edge_cutoff[a][0])
1698 dcp[1] = dcp[0] + (scp[z + 1] - scp[z]);
1700 for (z = cell_ofs (z0); z <= cell_ofs (z1 - 1); z++, dcp++)
1702 dcp[1] = dcp[0] + (scp[z + 1] - scp[z]);
1703 if (z == cell_ofs (z0))
1706 if (page->h[a][0] && page->h[a][1])
1707 dcp[1] += page->join_crossing[a][z / 2];
1709 if (z == cell_ofs (z1 - 1))
1712 for (z = rule_ofs_r (page, a, subpage->h[a][1]);
1713 z <= rule_ofs_r (page, a, 0); z++, dcp++)
1715 if (z == rule_ofs_r (page, a, 0) && subpage->is_edge_cutoff[a][1])
1718 dcp[1] = dcp[0] + (scp[z + 1] - scp[z]);
1720 assert (dcp == &subpage->cp[a][2 * subpage->n[a] + 1]);
1722 for (z = 0; z < page->n[b] * 2 + 2; z++)
1723 subpage->cp[b][z] = page->cp[b][z];
1725 /* Add new overflows. */
1733 s.subpage = subpage;
1735 if (!page->h[a][0] || z0 > page->h[a][0] || p0)
1736 for (z = 0; z < page->n[b]; )
1738 struct table_cell cell;
1739 int d[TABLE_N_AXES];
1746 table_get_cell (page->table, d[H], d[V], &cell);
1747 overflow0 = p0 || cell.d[a][0] < z0;
1748 overflow1 = cell.d[a][1] > z1 || (cell.d[a][1] == z1 && p1);
1749 if (overflow0 || overflow1)
1751 ro = insert_overflow (&s, &cell);
1755 ro->overflow[a][0] += p0 + axis_width (
1756 page, a, cell_ofs (cell.d[a][0]), cell_ofs (z0));
1757 if (page->h[a][0] && page->h[a][1])
1758 ro->overflow[a][0] -= page->join_crossing[a][cell.d[a][0]
1764 ro->overflow[a][1] += p1 + axis_width (
1765 page, a, cell_ofs (z1), cell_ofs (cell.d[a][1]));
1766 if (page->h[a][0] && page->h[a][1])
1767 ro->overflow[a][1] -= page->join_crossing[a][cell.d[a][1]];
1771 table_cell_free (&cell);
1774 if (!page->h[a][1] || z1 < page->n[a] - page->h[a][1] || p1)
1775 for (z = 0; z < page->n[b]; )
1777 struct table_cell cell;
1778 int d[TABLE_N_AXES];
1782 table_get_cell (page->table, d[H], d[V], &cell);
1783 if ((cell.d[a][1] > z1 || (cell.d[a][1] == z1 && p1))
1784 && find_overflow_for_cell (&s, &cell) == NULL)
1786 ro = insert_overflow (&s, &cell);
1787 ro->overflow[a][1] += p1 + axis_width (page, a, cell_ofs (z1),
1788 cell_ofs (cell.d[a][1]));
1791 table_cell_free (&cell);
1794 /* Copy overflows from PAGE into subpage. */
1795 HMAP_FOR_EACH (ro, struct render_overflow, node, &page->overflows)
1797 struct table_cell cell;
1799 table_get_cell (page->table, ro->d[H], ro->d[V], &cell);
1800 if (cell.d[a][1] > z0 && cell.d[a][0] < z1
1801 && find_overflow_for_cell (&s, &cell) == NULL)
1802 insert_overflow (&s, &cell);
1803 table_cell_free (&cell);
1809 /* Given CELL, a table_cell within S->page, stores in SUBCELL the (x,y)
1810 coordinates of the top-left cell as it will appear in S->subpage.
1812 CELL must actually intersect the region of S->page that is being selected
1813 by render_page_select() or the results will not make any sense. */
1815 cell_to_subpage (struct render_page_selection *s,
1816 const struct table_cell *cell, int subcell[TABLE_N_AXES])
1818 enum table_axis a = s->a;
1819 enum table_axis b = s->b;
1820 int ha0 = s->subpage->h[a][0];
1822 subcell[a] = MAX (cell->d[a][0] - s->z0 + ha0, ha0);
1823 subcell[b] = cell->d[b][0];
1826 /* Given CELL, a table_cell within S->page, returns the render_overflow for
1827 that cell in S->subpage, if there is one, and a null pointer otherwise.
1829 CELL must actually intersect the region of S->page that is being selected
1830 by render_page_select() or the results will not make any sense. */
1831 static const struct render_overflow *
1832 find_overflow_for_cell (struct render_page_selection *s,
1833 const struct table_cell *cell)
1837 cell_to_subpage (s, cell, subcell);
1838 return find_overflow (s->subpage, subcell[H], subcell[V]);
1841 /* Given CELL, a table_cell within S->page, inserts a render_overflow for that
1842 cell in S->subpage (which must not already exist). Initializes the new
1843 render_overflow's 'overflow' member from the overflow for CELL in S->page,
1846 CELL must actually intersect the region of S->page that is being selected
1847 by render_page_select() or the results will not make any sense. */
1848 static struct render_overflow *
1849 insert_overflow (struct render_page_selection *s,
1850 const struct table_cell *cell)
1852 const struct render_overflow *old;
1853 struct render_overflow *of;
1855 of = xzalloc (sizeof *of);
1856 cell_to_subpage (s, cell, of->d);
1857 hmap_insert (&s->subpage->overflows, &of->node,
1858 hash_cell (of->d[H], of->d[V]));
1860 old = find_overflow (s->page, cell->d[H][0], cell->d[V][0]);
1862 memcpy (of->overflow, old->overflow, sizeof of->overflow);