1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007, 2009 Free Software Foundation, Inc.
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.
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.
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/>. */
17 #ifndef OUTPUT_OUTPUT_H
18 #define OUTPUT_OUTPUT_H 1
20 #include <libpspp/ll.h>
21 #include <libpspp/str.h>
26 OUTP_L_NONE, /* No line. */
27 OUTP_L_SINGLE, /* Single line. */
28 OUTP_L_DOUBLE, /* Double line. */
32 /* Text justification. */
33 enum outp_justification
35 OUTP_RIGHT, /* Right justification. */
36 OUTP_LEFT, /* Left justification. */
37 OUTP_CENTER, /* Center justification. */
42 OUTP_FIXED, /* Fixed-width font. */
43 OUTP_PROPORTIONAL, /* Proportional font. */
44 OUTP_EMPHASIS, /* Proportional font used for emphasis. */
45 OUTP_FONT_CNT /* Number of fonts. */
48 /* Describes text output. */
52 enum outp_justification justification;
53 struct substring string;
54 int h, v; /* Horizontal, vertical size. */
55 int x, y; /* Position. */
62 /* Defines a class of output driver. */
65 const char *name; /* Name of this driver class. */
66 int special; /* Boolean value. */
68 bool (*open_driver) (const char *name, int types,
69 struct substring options);
70 bool (*close_driver) (struct outp_driver *);
72 void (*open_page) (struct outp_driver *);
73 void (*close_page) (struct outp_driver *);
75 void (*flush) (struct outp_driver *);
77 /* special != 0 only. */
78 void (*submit) (struct outp_driver *, struct som_entity *);
80 /* special == 0 only. */
81 void (*line) (struct outp_driver *, int x0, int y0, int x1, int y1,
82 enum outp_line_style top, enum outp_line_style left,
83 enum outp_line_style bottom, enum outp_line_style right);
84 void (*text_metrics) (struct outp_driver *, const struct outp_text *,
85 int *width, int *height);
86 void (*text_draw) (struct outp_driver *, const struct outp_text *);
87 void (*initialise_chart)(struct outp_driver *, struct chart *);
88 void (*finalise_chart)(struct outp_driver *, struct chart *);
94 OUTP_DEV_NONE = 0, /* None of the below. */
95 OUTP_DEV_LISTING = 001, /* Listing device. */
96 OUTP_DEV_SCREEN = 002, /* Screen device. */
97 OUTP_DEV_PRINTER = 004, /* Printer device. */
100 /* Defines the configuration of an output driver. */
103 struct ll node; /* Node in list of drivers. */
104 const struct outp_class *class; /* Driver class. */
105 char *name; /* Name of this driver. */
106 bool page_open; /* 1=page is open, 0=page is closed. */
107 int device; /* Zero or more of OUTP_DEV_*. */
108 int cp_x, cp_y; /* Current position. */
110 int width, length; /* Page size. */
111 int font_height; /* Default font character height. */
112 int prop_em_width; /* Proportional font em width. */
113 int fixed_width; /* Fixed-pitch font character width. */
114 int horiz_line_width[OUTP_L_COUNT]; /* Width of horizontal lines. */
115 int vert_line_width[OUTP_L_COUNT]; /* Width of vertical lines. */
117 void *ext; /* Private extension record. */
118 void *prc; /* Per-procedure extension record. */
121 /* Option structure for the keyword recognizer. */
124 const char *keyword; /* Keyword name. */
125 int cat; /* Category. */
126 int subcat; /* Subcategory. */
130 /* Title, subtitle. */
131 extern char *outp_title;
132 extern char *outp_subtitle;
134 void outp_init (void);
135 void outp_done (void);
136 void outp_read_devices (void);
137 void outp_configure_driver_line (struct substring);
139 struct outp_driver *outp_allocate_driver (const struct outp_class *class,
140 const char *name, int types);
141 void outp_free_driver (struct outp_driver *);
142 void outp_register_driver (struct outp_driver *);
143 void outp_unregister_driver (struct outp_driver *);
145 void outp_configure_clear (void);
146 void outp_configure_add (char *);
147 void outp_configure_macro (char *);
149 void outp_list_classes (void);
151 void outp_enable_device (bool enable, int device);
152 struct outp_driver *outp_drivers (struct outp_driver *);
154 bool outp_parse_options (const char *driver_name, struct substring options,
155 bool (*callback) (void *aux, const char *key,
156 const struct string *value),
158 int outp_match_keyword (const char *, const struct outp_option *, int *);
160 int outp_evaluate_dimension (const char *);
161 bool outp_get_paper_size (const char *, int *h, int *v);
163 void outp_open_page (struct outp_driver *);
164 void outp_close_page (struct outp_driver *);
165 void outp_eject_page (struct outp_driver *);
166 void outp_flush (struct outp_driver *);
168 int outp_string_width (struct outp_driver *, const char *, enum outp_font);
170 /* Imported from som-frnt.c. */
171 void som_destroy_driver (struct outp_driver *);
173 /* Common drivers. */
174 extern const struct outp_class ascii_class;
175 extern const struct outp_class postscript_class;
177 extern const struct outp_class cairo_class;
180 #endif /* output/output.h */