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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2014, 2020 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_CAIRO_FSM_H
  18 #define OUTPUT_CAIRO_FSM_H 1
  19
  20 #include <stdbool.h>
  21
  22 #ifdef HAVE_CAIRO
  23
  24 #include <cairo/cairo.h>
  25 #include <pango/pango-font.h>
  26 #include "output/table.h"
  27
  28 struct xr_fsm;
  29 struct output_item;
  30
  31 /* The unit used for internal measurements is inch/(72 * XR_POINT).
  32    (Thus, XR_POINT units represent one point.) */
  33 #define XR_POINT PANGO_SCALE
  34
  35 enum xr_font_type
  36   {
  37     XR_FONT_PROPORTIONAL,
  38     XR_FONT_FIXED,
  39     XR_N_FONTS
  40   };
  41
  42 struct xr_fsm_style
  43   {
  44     int ref_cnt;
  45
  46     int size[TABLE_N_AXES];      /* Page size. */
  47     int min_break[TABLE_N_AXES]; /* Minimum cell size to allow breaking. */
  48     PangoFontDescription *fonts[XR_N_FONTS];
  49     struct cell_color fg;
  50     bool use_system_colors;
  51
  52     int object_spacing;
  53
  54     /* Resolution, in units per inch, used for measuring font "points".  If
  55        this is 72.0, for example, then 1pt = 1 device unit, which is
  56        appropriate for rendering to a surface created by
  57        cairo_ps_surface_create() with its default transformation matrix of 72
  58        units/inch.  For a screen-based surface, it is traditionally 96.0. */
  59     double font_resolution;
  60   };
  61 struct xr_fsm_style *xr_fsm_style_ref (const struct xr_fsm_style *);
  62 struct xr_fsm_style *xr_fsm_style_unshare (struct xr_fsm_style *);
  63 void xr_fsm_style_unref (struct xr_fsm_style *);
  64 bool xr_fsm_style_equals (const struct xr_fsm_style *,
  65                           const struct xr_fsm_style *);
  66
  67 /* Interface used for rendering output items in a single on-screen region. */
  68 struct xr_fsm *xr_fsm_create_for_scrolling (const struct output_item *,
  69                                             const struct xr_fsm_style *,
  70                                             cairo_t *);
  71 void xr_fsm_measure (struct xr_fsm *, cairo_t *, int *w, int *h);
  72 void xr_fsm_draw_all (struct xr_fsm *, cairo_t *);
  73 void xr_fsm_draw_region (struct xr_fsm *, cairo_t *,
  74                          int x, int y, int w, int h);
  75
  76 /* Interface used for rendering output items to a series of printed pages. */
  77 struct xr_fsm *xr_fsm_create_for_printing (const struct output_item *,
  78                                            const struct xr_fsm_style *,
  79                                            cairo_t *);
  80 void xr_fsm_destroy (struct xr_fsm *);
  81 int xr_fsm_draw_slice (struct xr_fsm *, cairo_t *, int space);
  82 bool xr_fsm_is_empty (const struct xr_fsm *);
  83
  84 #endif  /* HAVE_CAIRO */
  85
  86 #endif /* output/cairo-fsm.h */