struct table_item;
-enum render_line_style
- {
- RENDER_LINE_NONE, /* No line. */
- RENDER_LINE_SINGLE, /* Single line. */
- RENDER_LINE_DOUBLE, /* Double line. */
- RENDER_N_LINES
- };
-
/* Parameters for rendering a table_item to a device.
corner at (0,0) in device coordinates. This is usually not the case from
the driver's perspective, so the driver should expect to apply its own
offset to coordinates passed to callback functions.
+*/
+struct render_params
+ {
+ /* Functional parameters and auxiliary data to pass to them. */
+ const struct render_ops *ops;
+ void *aux;
+
+ /* Page size to try to fit the rendering into. Some tables will, of
+ course, overflow this size. */
+ int size[TABLE_N_AXES];
+
+ /* Nominal size of a character in the most common font:
+ font_size[TABLE_HORZ]: Em width.
+ font_size[TABLE_VERT]: Line spacing. */
+ int font_size[TABLE_N_AXES];
+
+ /* Width of different kinds of lines. */
+ const int *line_widths; /* RENDER_N_LINES members. */
+ /* 1/96" of an inch (1px) in the rendering unit. Currently used only for
+ column width ranges (as specified in width_ranges in struct
+ pivot_table_look). Set to 0 to disable this feature. */
+ int px_size;
- Callback functions
- ==================
+ /* Minimum cell width or height before allowing the cell to be broken
+ across two pages. (Joined cells may always be broken at join
+ points.) */
+ int min_break[TABLE_N_AXES];
- For each of the callback functions, AUX is passed as the 'aux' member of the
- render_params structure.
+ /* True if the driver supports cell margins. (If false, the rendering
+ engine will insert a small space betweeen adjacent cells that don't have
+ an intervening rule.) */
+ bool supports_margins;
- The device is expected to transform numerical footnote index numbers into
- footnote markers. The existing drivers use str_format_26adic() to transform
- index 0 to "a", index 1 to "b", and so on. The FOOTNOTE_IDX supplied to
- each function is the footnote index number for the first footnote in the
- cell. If a cell contains more than one footnote, then the additional
- footnote indexes increase sequentially, e.g. the second footnote has index
- FOOTNOTE_IDX + 1.
-*/
-struct render_params
+ /* True if the local language has a right-to-left direction, otherwise
+ false. (Use render_direction_rtl() to find out.) */
+ bool rtl;
+
+ /* True if the table is being rendered for printing (as opposed to
+ on-screen display). */
+ bool printing;
+ };
+
+struct render_ops
{
/* Measures CELL's width. Stores in *MIN_WIDTH the minimum width required
to avoid splitting a single word across multiple lines (normally, this
minimum width required to avoid line breaks other than at new-lines.
*/
void (*measure_cell_width) (void *aux, const struct table_cell *cell,
- int footnote_idx,
int *min_width, int *max_width);
/* Returns the height required to render CELL given a width of WIDTH. */
int (*measure_cell_height) (void *aux, const struct table_cell *cell,
- int footnote_idx, int width);
+ int width);
/* Given that there is space measuring WIDTH by HEIGHT to render CELL,
where HEIGHT is insufficient to render the entire height of the cell,
Optional. If NULL, the rendering engine assumes that all breakpoints
are acceptable. */
int (*adjust_break) (void *aux, const struct table_cell *cell,
- int footnote_idx, int width, int height);
+ int width, int height);
/* Draws a generalized intersection of lines in the rectangle whose
top-left corner is (BB[TABLE_HORZ][0], BB[TABLE_VERT][0]) and whose
STYLES[TABLE_VERT][0]: style of line from left of BB to its center.
STYLES[TABLE_VERT][1]: style of line from right of BB to its center. */
void (*draw_line) (void *aux, int bb[TABLE_N_AXES][2],
- enum render_line_style styles[TABLE_N_AXES][2]);
+ const struct table_border_style styles[TABLE_N_AXES][2]);
/* Draws CELL within bounding box BB. CLIP is the same as BB (the common
case) or a subregion enclosed by BB. In the latter case only the part
of the cell that lies within CLIP should actually be drawn, although BB
- should used to determine the layout of the cell. */
- void (*draw_cell) (void *aux, const struct table_cell *cell,
- int footnote_idx,
- int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2]);
-
- /* Auxiliary data passed to each of the above functions. */
- void *aux;
-
- /* Page size to try to fit the rendering into. Some tables will, of
- course, overflow this size. */
- int size[TABLE_N_AXES];
-
- /* Nominal size of a character in the most common font:
- font_size[TABLE_HORZ]: Em width.
- font_size[TABLE_VERT]: Line spacing. */
- int font_size[TABLE_N_AXES];
-
- /* Width of different kinds of lines. */
- int line_widths[TABLE_N_AXES][RENDER_N_LINES];
-
- /* Minimum cell width or height before allowing the cell to be broken
- across two pages. (Joined cells may always be broken at join
- points.) */
- int min_break[TABLE_N_AXES];
+ should used to determine the layout of the cell.
+
+ The text in the cell needs to be vertically offset VALIGN_OFFSET units
+ from the top of the bounding box. This handles vertical alignment with
+ the cell. (The caller doesn't just reduce the bounding box size because
+ that would prevent the implementation from filling the entire cell with
+ the background color.) The implementation must handle horizontal
+ alignment itself. */
+ void (*draw_cell) (void *aux, const struct table_cell *cell, int color_idx,
+ int bb[TABLE_N_AXES][2], int valign_offset,
+ int spill[TABLE_N_AXES][2],
+ int clip[TABLE_N_AXES][2]);
+
+ /* Scales all output by FACTOR, e.g. a FACTOR of 0.5 would cause everything
+ subsequent to be drawn half-size. FACTOR will be greater than 0 and
+ less than or equal to 1.
+
+ Optional. If NULL, the rendering engine won't try to scale output. */
+ void (*scale) (void *aux, double factor);
};
/* An iterator for breaking render_pages into smaller chunks. */
struct render_pager *render_pager_create (const struct render_params *,
- const struct table_item *);
+ const struct pivot_table *,
+ const size_t *layer_indexes);
void render_pager_destroy (struct render_pager *);
bool render_pager_has_next (const struct render_pager *);
int render_pager_get_size (const struct render_pager *, enum table_axis);
int render_pager_get_best_breakpoint (const struct render_pager *, int height);
+bool render_direction_rtl (void);
+
+
#endif /* output/render.h */
projects / pspp / blobdiff