src/output/output.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #if !output_h
  21 #define output_h 1
  22
  23 #include <config.h>
  24
  25 #include <libpspp/str.h>
  26
  27
  28 /* A rectangle. */
  29 struct rect
  30   {
  31     int x1, y1;                 /* Upper left. */
  32     int x2, y2;                 /* Lower right, not part of the rectangle. */
  33   };
  34
  35 /* Color descriptor. */
  36 struct color
  37   {
  38     int flags;                  /* 0=normal, 1=transparent (ignore r,g,b). */
  39     int r;                      /* Red component, 0-65535. */
  40     int g;                      /* Green component, 0-65535. */
  41     int b;                      /* Blue component, 0-65535. */
  42   };
  43
  44 /* Mount positions for the four basic fonts.  Do not change the values. */
  45 enum
  46   {
  47     OUTP_F_R,                   /* Roman font. */
  48     OUTP_F_I,                   /* Italic font. */
  49     OUTP_F_B,                   /* Bold font. */
  50     OUTP_F_BI                   /* Bold-italic font. */
  51   };
  52
  53 /* Line styles.  These must match:
  54    som.h:SLIN_*
  55    ascii.c:ascii_line_*()
  56    postscript.c:ps_line_*() */
  57 enum
  58   {
  59     OUTP_L_NONE = 0,            /* No line. */
  60     OUTP_L_SINGLE = 1,          /* Single line. */
  61     OUTP_L_DOUBLE = 2,          /* Double line. */
  62     OUTP_L_SPECIAL = 3,         /* Special line of driver-defined style. */
  63
  64     OUTP_L_COUNT                /* Number of line styles. */
  65   };
  66
  67 /* Contains a line style for each part of an intersection. */
  68 struct outp_styles
  69   {
  70     int l;                      /* left */
  71     int t;                      /* top */
  72     int r;                      /* right */
  73     int b;                      /* bottom */
  74   };
  75
  76 /* Text display options. */
  77 enum
  78   {
  79     OUTP_T_NONE = 0,
  80
  81     /* Must match tab.h:TAB_*. */
  82     OUTP_T_JUST_MASK = 00003,   /* Justification mask. */
  83     OUTP_T_JUST_RIGHT = 00000,  /* Right justification. */
  84     OUTP_T_JUST_LEFT = 00001,   /* Left justification. */
  85     OUTP_T_JUST_CENTER = 00002, /* Center justification. */
  86
  87     OUTP_T_HORZ = 00010,        /* Horizontal size is specified. */
  88     OUTP_T_VERT = 00020,        /* (Max) vertical size is specified. */
  89
  90     OUTP_T_0 = 00140,           /* Normal orientation. */
  91     OUTP_T_CC90 = 00040,        /* 90 degrees counterclockwise. */
  92     OUTP_T_CC180 = 00100,       /* 180 degrees counterclockwise. */
  93     OUTP_T_CC270 = 00140,       /* 270 degrees counterclockwise. */
  94     OUTP_T_C90 = 00140,         /* 90 degrees clockwise. */
  95     OUTP_T_C180 = 00100,        /* 180 degrees clockwise. */
  96     OUTP_T_C270 = 00040,        /* 270 degrees clockwise. */
  97
  98     /* Internal use by drivers only. */
  99     OUTP_T_INTERNAL_DRAW = 01000        /* 1=Draw the text, 0=Metrics only. */
 100   };
 101
 102 /* Describes text output. */
 103 struct outp_text
 104   {
 105     /* Public. */
 106     int options;                /* What is specified. */
 107     struct fixed_string s;      /* String. */
 108     int h, v;                   /* Horizontal, vertical size. */
 109     int x, y;                   /* Position. */
 110
 111     /* Internal use only. */
 112     int w, l;                   /* Width, length. */
 113   };
 114
 115 struct som_entity;
 116 struct outp_driver;
 117 struct chart;
 118
 119 /* Defines a class of output driver. */
 120 struct outp_class
 121   {
 122     /* Basic class information. */
 123     const char *name;           /* Name of this driver class. */
 124     int magic;                  /* Driver-specific constant. */
 125     int special;                /* Boolean value. */
 126
 127     /* Static member functions. */
 128     int (*open_global) (struct outp_class *);
 129     int (*close_global) (struct outp_class *);
 130     int *(*font_sizes) (struct outp_class *, int *n_valid_sizes);
 131
 132     /* Virtual member functions. */
 133     int (*preopen_driver) (struct outp_driver *);
 134     void (*option) (struct outp_driver *, const char *key,
 135                     const struct string *value);
 136     int (*postopen_driver) (struct outp_driver *);
 137     int (*close_driver) (struct outp_driver *);
 138
 139     int (*open_page) (struct outp_driver *);
 140     int (*close_page) (struct outp_driver *);
 141
 142     /* special != 0: Used to submit entities for output. */
 143     void (*submit) (struct outp_driver *, struct som_entity *);
 144
 145     /* special != 0: Methods below need not be defined. */
 146
 147     /* Line methods. */
 148     void (*line_horz) (struct outp_driver *, const struct rect *,
 149                        const struct color *, int style);
 150     void (*line_vert) (struct outp_driver *, const struct rect *,
 151                        const struct color *, int style);
 152     void (*line_intersection) (struct outp_driver *, const struct rect *,
 153                                const struct color *,
 154                                const struct outp_styles *style);
 155
 156     /* Drawing methods. */
 157     void (*box) (struct outp_driver *, const struct rect *,
 158                  const struct color *bord, const struct color *fill);
 159     void (*polyline_begin) (struct outp_driver *, const struct color *);
 160     void (*polyline_point) (struct outp_driver *, int, int);
 161     void (*polyline_end) (struct outp_driver *);
 162
 163     /* Text methods. */
 164     void (*text_set_font_by_name) (struct outp_driver *, const char *s);
 165     void (*text_set_font_by_position) (struct outp_driver *, int);
 166     void (*text_set_font_family) (struct outp_driver *, const char *s);
 167     const char *(*text_get_font_name) (struct outp_driver *);
 168     const char *(*text_get_font_family) (struct outp_driver *);
 169     int (*text_set_size) (struct outp_driver *, int);
 170     int (*text_get_size) (struct outp_driver *, int *em_width);
 171     void (*text_metrics) (struct outp_driver *, struct outp_text *);
 172     void (*text_draw) (struct outp_driver *, struct outp_text *);
 173
 174     void (*initialise_chart)(struct outp_driver *, struct chart *);
 175     void (*finalise_chart)(struct outp_driver *, struct chart *);
 176
 177   };
 178
 179 /* Device types. */
 180 enum
 181   {
 182     OUTP_DEV_NONE = 0,          /* None of the below. */
 183     OUTP_DEV_LISTING = 001,     /* Listing device. */
 184     OUTP_DEV_SCREEN = 002,      /* Screen device. */
 185     OUTP_DEV_PRINTER = 004,     /* Printer device. */
 186     OUTP_DEV_DISABLED = 010     /* Broken device. */
 187   };
 188
 189 /* Defines the configuration of an output driver. */
 190 struct outp_driver
 191   {
 192     struct outp_class *class;           /* Driver class. */
 193     char *name;                 /* Name of this driver. */
 194     int driver_open;            /* 1=driver is open, 0=driver is closed. */
 195     int page_open;              /* 1=page is open, 0=page is closed. */
 196
 197     struct outp_driver *next, *prev;    /* Next, previous output driver in list. */
 198
 199     int device;                 /* Zero or more of OUTP_DEV_*. */
 200     int res, horiz, vert;       /* Device resolution. */
 201     int width, length;          /* Page size. */
 202
 203     int cp_x, cp_y;             /* Current position. */
 204     int font_height;            /* Default font character height. */
 205     int prop_em_width;          /* Proportional font em width. */
 206     int fixed_width;            /* Fixed-pitch font character width. */
 207     int horiz_line_width[OUTP_L_COUNT]; /* Width of horizontal lines. */
 208     int vert_line_width[OUTP_L_COUNT];  /* Width of vertical lines. */
 209     int horiz_line_spacing[1 << OUTP_L_COUNT];
 210     int vert_line_spacing[1 << OUTP_L_COUNT];
 211
 212     void *ext;                  /* Private extension record. */
 213     void *prc;                  /* Per-procedure extension record. */
 214   };
 215
 216 /* Option structure for the keyword recognizer. */
 217 struct outp_option
 218   {
 219     const char *keyword;        /* Keyword name. */
 220     int cat;                    /* Category. */
 221     int subcat;                 /* Subcategory. */
 222   };
 223
 224 /* Information structure for the keyword recognizer. */
 225 struct outp_option_info
 226   {
 227     char *initial;                      /* Initial characters. */
 228     struct outp_option **options;       /* Search starting points. */
 229   };
 230
 231 /* A list of driver classes. */
 232 struct outp_driver_class_list
 233   {
 234     int ref_count;
 235     struct outp_class *class;
 236     struct outp_driver_class_list *next;
 237   };
 238
 239 /* List of configured output drivers. */
 240 extern struct outp_driver *outp_driver_list;
 241
 242 /* Title, subtitle. */
 243 extern char *outp_title;
 244 extern char *outp_subtitle;
 245
 246 void outp_init (void);
 247 void outp_read_devices (void);
 248 void outp_done (void);
 249
 250 void outp_configure_clear (void);
 251 void outp_configure_add (char *);
 252 void outp_configure_macro (char *);
 253
 254 void outp_list_classes (void);
 255
 256 void outp_enable_device (int enable, int device);
 257 struct outp_driver *outp_drivers (struct outp_driver *);
 258
 259 int outp_match_keyword (const char *, struct outp_option *,
 260                         struct outp_option_info *, int *);
 261
 262 int outp_evaluate_dimension (char *, char **);
 263 int outp_get_paper_size (char *, int *h, int *v);
 264
 265 int outp_eject_page (struct outp_driver *);
 266
 267 int outp_string_width (struct outp_driver *, const char *);
 268
 269 /* Imported from som-frnt.c. */
 270 void som_destroy_driver (struct outp_driver *);
 271
 272 #endif /* output.h */