1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007 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/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) (struct outp_driver *, struct substring options);
69 bool (*close_driver) (struct outp_driver *);
71 void (*open_page) (struct outp_driver *);
72 void (*close_page) (struct outp_driver *);
74 void (*flush) (struct outp_driver *);
76 /* special != 0 only. */
77 void (*submit) (struct outp_driver *, struct som_entity *);
79 /* special == 0 only. */
80 void (*line) (struct outp_driver *, int x0, int y0, int x1, int y1,
81 enum outp_line_style top, enum outp_line_style left,
82 enum outp_line_style bottom, enum outp_line_style right);
83 void (*text_metrics) (struct outp_driver *, const struct outp_text *,
84 int *width, int *height);
85 void (*text_draw) (struct outp_driver *, const struct outp_text *);
86 void (*initialise_chart)(struct outp_driver *, struct chart *);
87 void (*finalise_chart)(struct outp_driver *, struct chart *);
93 OUTP_DEV_NONE = 0, /* None of the below. */
94 OUTP_DEV_LISTING = 001, /* Listing device. */
95 OUTP_DEV_SCREEN = 002, /* Screen device. */
96 OUTP_DEV_PRINTER = 004, /* Printer device. */
99 /* Defines the configuration of an output driver. */
102 struct outp_driver *next, *prev; /* List of drivers. */
103 const struct outp_class *class; /* Driver class. */
104 char *name; /* Name of this driver. */
105 bool page_open; /* 1=page is open, 0=page is closed. */
106 int device; /* Zero or more of OUTP_DEV_*. */
107 int cp_x, cp_y; /* Current position. */
109 int width, length; /* Page size. */
110 int font_height; /* Default font character height. */
111 int prop_em_width; /* Proportional font em width. */
112 int fixed_width; /* Fixed-pitch font character width. */
113 int horiz_line_width[OUTP_L_COUNT]; /* Width of horizontal lines. */
114 int vert_line_width[OUTP_L_COUNT]; /* Width of vertical lines. */
116 void *ext; /* Private extension record. */
117 void *prc; /* Per-procedure extension record. */
120 /* Option structure for the keyword recognizer. */
123 const char *keyword; /* Keyword name. */
124 int cat; /* Category. */
125 int subcat; /* Subcategory. */
129 /* Title, subtitle. */
130 extern char *outp_title;
131 extern char *outp_subtitle;
133 void outp_init (void);
134 void outp_read_devices (void);
135 void outp_configure_driver_line (struct substring);
136 void outp_done (void);
138 void outp_configure_clear (void);
139 void outp_configure_add (char *);
140 void outp_configure_macro (char *);
142 void outp_list_classes (void);
144 void outp_enable_device (bool enable, int device);
145 struct outp_driver *outp_drivers (struct outp_driver *);
147 bool outp_parse_options (struct substring options,
148 bool (*) (struct outp_driver *, const char *key,
149 const struct string *value),
150 struct outp_driver *);
151 int outp_match_keyword (const char *, const struct outp_option *, int *);
153 int outp_evaluate_dimension (const char *);
154 bool outp_get_paper_size (const char *, int *h, int *v);
156 void outp_open_page (struct outp_driver *);
157 void outp_close_page (struct outp_driver *);
158 void outp_eject_page (struct outp_driver *);
159 void outp_flush (struct outp_driver *);
161 int outp_string_width (struct outp_driver *, const char *, enum outp_font);
163 /* Imported from som-frnt.c. */
164 void som_destroy_driver (struct outp_driver *);
166 #endif /* output/output.h */