src/output/output.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007 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_OUTPUT_H
  18 #define OUTPUT_OUTPUT_H 1
  19
  20 #include <config.h>
  21
  22 #include <libpspp/str.h>
  23
  24
  25 /* Line styles.  */
  26 enum outp_line_style
  27   {
  28     OUTP_L_NONE,                /* No line. */
  29     OUTP_L_SINGLE,              /* Single line. */
  30     OUTP_L_DOUBLE,              /* Double line. */
  31     OUTP_L_COUNT
  32   };
  33
  34 /* Text justification. */
  35 enum outp_justification
  36   {
  37     OUTP_RIGHT,                 /* Right justification. */
  38     OUTP_LEFT,                  /* Left justification. */
  39     OUTP_CENTER,                /* Center justification. */
  40   };
  41
  42 enum outp_font
  43   {
  44     OUTP_FIXED,                 /* Fixed-width font. */
  45     OUTP_PROPORTIONAL,          /* Proportional font. */
  46     OUTP_EMPHASIS,              /* Proportional font used for emphasis. */
  47     OUTP_FONT_CNT               /* Number of fonts. */
  48   };
  49
  50 /* Describes text output. */
  51 struct outp_text
  52   {
  53     enum outp_font font;
  54     enum outp_justification justification;
  55     struct substring string;
  56     int h, v;                   /* Horizontal, vertical size. */
  57     int x, y;                   /* Position. */
  58   };
  59
  60 struct som_entity;
  61 struct outp_driver;
  62 struct chart;
  63
  64 /* Defines a class of output driver. */
  65 struct outp_class
  66   {
  67     const char *name;           /* Name of this driver class. */
  68     int special;                /* Boolean value. */
  69
  70     bool (*open_driver) (struct outp_driver *, struct substring options);
  71     bool (*close_driver) (struct outp_driver *);
  72
  73     void (*open_page) (struct outp_driver *);
  74     void (*close_page) (struct outp_driver *);
  75
  76     void (*flush) (struct outp_driver *);
  77
  78     /* special != 0 only. */
  79     void (*submit) (struct outp_driver *, struct som_entity *);
  80
  81     /* special == 0 only.  */
  82     void (*line) (struct outp_driver *, int x0, int y0, int x1, int y1,
  83                   enum outp_line_style top, enum outp_line_style left,
  84                   enum outp_line_style bottom, enum outp_line_style right);
  85     void (*text_metrics) (struct outp_driver *, const struct outp_text *,
  86                           int *width, int *height);
  87     void (*text_draw) (struct outp_driver *, const struct outp_text *);
  88     void (*initialise_chart)(struct outp_driver *, struct chart *);
  89     void (*finalise_chart)(struct outp_driver *, struct chart *);
  90   };
  91
  92 /* Device types. */
  93 enum
  94   {
  95     OUTP_DEV_NONE = 0,          /* None of the below. */
  96     OUTP_DEV_LISTING = 001,     /* Listing device. */
  97     OUTP_DEV_SCREEN = 002,      /* Screen device. */
  98     OUTP_DEV_PRINTER = 004,     /* Printer device. */
  99   };
 100
 101 /* Defines the configuration of an output driver. */
 102 struct outp_driver
 103   {
 104     struct outp_driver *next, *prev; /* List of drivers. */
 105     const struct outp_class *class;     /* Driver class. */
 106     char *name;                 /* Name of this driver. */
 107     bool page_open;             /* 1=page is open, 0=page is closed. */
 108     int device;                 /* Zero or more of OUTP_DEV_*. */
 109     int cp_x, cp_y;             /* Current position. */
 110
 111     int width, length;          /* Page size. */
 112     int font_height;            /* Default font character height. */
 113     int prop_em_width;          /* Proportional font em width. */
 114     int fixed_width;            /* Fixed-pitch font character width. */
 115     int horiz_line_width[OUTP_L_COUNT]; /* Width of horizontal lines. */
 116     int vert_line_width[OUTP_L_COUNT];  /* Width of vertical lines. */
 117
 118     void *ext;                  /* Private extension record. */
 119     void *prc;                  /* Per-procedure extension record. */
 120   };
 121
 122 /* Option structure for the keyword recognizer. */
 123 struct outp_option
 124   {
 125     const char *keyword;        /* Keyword name. */
 126     int cat;                    /* Category. */
 127     int subcat;                 /* Subcategory. */
 128   };
 129
 130
 131 /* Title, subtitle. */
 132 extern char *outp_title;
 133 extern char *outp_subtitle;
 134
 135 void outp_init (void);
 136 void outp_read_devices (void);
 137 void outp_configure_driver_line (struct substring);
 138 void outp_done (void);
 139
 140 void outp_configure_clear (void);
 141 void outp_configure_add (char *);
 142 void outp_configure_macro (char *);
 143
 144 void outp_list_classes (void);
 145
 146 void outp_enable_device (bool enable, int device);
 147 struct outp_driver *outp_drivers (struct outp_driver *);
 148
 149 bool outp_parse_options (struct substring options,
 150                          bool (*) (struct outp_driver *, const char *key,
 151                                    const struct string *value),
 152                          struct outp_driver *);
 153 int outp_match_keyword (const char *, const struct outp_option *, int *);
 154
 155 int outp_evaluate_dimension (const char *);
 156 bool outp_get_paper_size (const char *, int *h, int *v);
 157
 158 void outp_open_page (struct outp_driver *);
 159 void outp_close_page (struct outp_driver *);
 160 void outp_eject_page (struct outp_driver *);
 161 void outp_flush (struct outp_driver *);
 162
 163 int outp_string_width (struct outp_driver *, const char *, enum outp_font);
 164
 165 /* Imported from som-frnt.c. */
 166 void som_destroy_driver (struct outp_driver *);
 167
 168 #endif /* output/output.h */