pintos-os.org Git - pspp/blob - src/output/render.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2011, 2014 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 #ifndef OUTPUT_RENDER_H
  18 #define OUTPUT_RENDER_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include "output/table-provider.h"
  23
  24 struct table_item;
  25
  26 /* Parameters for rendering a table_item to a device.
  27
  28
  29    Coordinate system
  30    =================
  31
  32    The rendering code assumes that larger 'x' is to the right and larger 'y'
  33    toward the bottom of the page.
  34
  35    The rendering code assumes that the table being rendered has its upper left
  36    corner at (0,0) in device coordinates.  This is usually not the case from
  37    the driver's perspective, so the driver should expect to apply its own
  38    offset to coordinates passed to callback functions.
  39 */
  40 struct render_params
  41   {
  42     /* Functional parameters and auxiliary data to pass to them. */
  43     const struct render_ops *ops;
  44     void *aux;
  45
  46     /* Page size to try to fit the rendering into.  Some tables will, of
  47        course, overflow this size. */
  48     int size[TABLE_N_AXES];
  49
  50     /* Nominal size of a character in the most common font:
  51        font_size[TABLE_HORZ]: Em width.
  52        font_size[TABLE_VERT]: Line spacing. */
  53     int font_size[TABLE_N_AXES];
  54
  55     /* Width of different kinds of lines. */
  56     const int *line_widths;           /* RENDER_N_LINES members. */
  57
  58     /* Minimum cell width or height before allowing the cell to be broken
  59        across two pages.  (Joined cells may always be broken at join
  60        points.) */
  61     int min_break[TABLE_N_AXES];
  62
  63     /* True if the driver supports cell margins.  (If false, the rendering
  64        engine will insert a small space betweeen adjacent cells that don't have
  65        an intervening rule.)  */
  66     bool supports_margins;
  67
  68     /* True if the local language has a right-to-left direction, otherwise
  69        false.  (Use render_direction_rtl() to find out.) */
  70     bool rtl;
  71
  72     /* True if the table is being rendered for printing (as opposed to
  73        on-screen display). */
  74     bool printing;
  75   };
  76
  77 struct render_ops
  78   {
  79     /* Measures CELL's width.  Stores in *MIN_WIDTH the minimum width required
  80        to avoid splitting a single word across multiple lines (normally, this
  81        is the width of the longest word in the cell) and in *MAX_WIDTH the
  82        minimum width required to avoid line breaks other than at new-lines.
  83        */
  84     void (*measure_cell_width) (void *aux, const struct table_cell *cell,
  85                                 int *min_width, int *max_width);
  86
  87     /* Returns the height required to render CELL given a width of WIDTH. */
  88     int (*measure_cell_height) (void *aux, const struct table_cell *cell,
  89                                 int width);
  90
  91     /* Given that there is space measuring WIDTH by HEIGHT to render CELL,
  92        where HEIGHT is insufficient to render the entire height of the cell,
  93        returns the largest height less than HEIGHT at which it is appropriate
  94        to break the cell.  For example, if breaking at the specified HEIGHT
  95        would break in the middle of a line of text, the return value would be
  96        just sufficiently less that the breakpoint would be between lines of
  97        text.
  98
  99        Optional.  If NULL, the rendering engine assumes that all breakpoints
 100        are acceptable. */
 101     int (*adjust_break) (void *aux, const struct table_cell *cell,
 102                          int width, int height);
 103
 104     /* Draws a generalized intersection of lines in the rectangle whose
 105        top-left corner is (BB[TABLE_HORZ][0], BB[TABLE_VERT][0]) and whose
 106        bottom-right corner is (BB[TABLE_HORZ][1], BB[TABLE_VERT][1]).
 107
 108        STYLES is interpreted this way:
 109
 110        STYLES[TABLE_HORZ][0]: style of line from top of BB to its center.
 111        STYLES[TABLE_HORZ][1]: style of line from bottom of BB to its center.
 112        STYLES[TABLE_VERT][0]: style of line from left of BB to its center.
 113        STYLES[TABLE_VERT][1]: style of line from right of BB to its center. */
 114     void (*draw_line) (void *aux, int bb[TABLE_N_AXES][2],
 115                        enum table_stroke styles[TABLE_N_AXES][2],
 116                        struct cell_color colors[TABLE_N_AXES][2]);
 117
 118     /* Draws CELL within bounding box BB.  CLIP is the same as BB (the common
 119        case) or a subregion enclosed by BB.  In the latter case only the part
 120        of the cell that lies within CLIP should actually be drawn, although BB
 121        should used to determine the layout of the cell.
 122
 123        The text in the cell needs to be vertically offset VALIGN_OFFSET units
 124        from the top of the bounding box.  This handles vertical alignment with
 125        the cell.  (The caller doesn't just reduce the bounding box size because
 126        that would prevent the implementation from filling the entire cell with
 127        the background color.)  The implementation must handle horizontal
 128        alignment itself. */
 129     void (*draw_cell) (void *aux, const struct table_cell *cell, int color_idx,
 130                        int bb[TABLE_N_AXES][2], int valign_offset,
 131                        int spill[TABLE_N_AXES][2],
 132                        int clip[TABLE_N_AXES][2]);
 133
 134     /* Scales all output by FACTOR, e.g. a FACTOR of 0.5 would cause everything
 135        subsequent to be drawn half-size.  FACTOR will be greater than 0 and
 136        less than or equal to 1.
 137
 138        Optional.  If NULL, the rendering engine won't try to scale output. */
 139     void (*scale) (void *aux, double factor);
 140   };
 141
 142 /* An iterator for breaking render_pages into smaller chunks. */
 143 struct render_pager *render_pager_create (const struct render_params *,
 144                                           const struct pivot_table *,
 145                                           const size_t *layer_indexes);
 146 void render_pager_destroy (struct render_pager *);
 147
 148 bool render_pager_has_next (const struct render_pager *);
 149 int render_pager_draw_next (struct render_pager *, int space);
 150
 151 void render_pager_draw (const struct render_pager *);
 152 void render_pager_draw_region (const struct render_pager *,
 153                                int x, int y, int w, int h);
 154
 155 int render_pager_get_size (const struct render_pager *, enum table_axis);
 156 int render_pager_get_best_breakpoint (const struct render_pager *, int height);
 157
 158 bool render_direction_rtl (void);
 159
 160
 161 #endif /* output/render.h */