doc: Distribute doc/pspp.xml, so that users don't need makeinfo or xmllint.
[pspp] / src / data / format.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006 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 DATA_FORMAT_H
18 #define DATA_FORMAT_H 1
19
20 /* Display format types. */
21
22 #include <stdbool.h>
23 #include <libpspp/str.h>
24 #include <data/val-type.h>
25
26 /* Format type categories.
27
28    Each format is in exactly one category.  We give categories
29    bitwise disjoint values only to enable bitwise comparisons
30    against a mask of FMT_CAT_* values, not to allow multiple
31    categories per format. */
32 enum fmt_category
33   {
34     /* Numeric formats. */
35     FMT_CAT_BASIC          = 0x001,     /* Basic numeric formats. */
36     FMT_CAT_CUSTOM         = 0x002,     /* Custom currency formats. */
37     FMT_CAT_LEGACY         = 0x004,     /* Legacy numeric formats. */
38     FMT_CAT_BINARY         = 0x008,     /* Binary formats. */
39     FMT_CAT_HEXADECIMAL    = 0x010,     /* Hexadecimal formats. */
40     FMT_CAT_DATE           = 0x020,     /* Date formats. */
41     FMT_CAT_TIME           = 0x040,     /* Time formats. */
42     FMT_CAT_DATE_COMPONENT = 0x080,     /* Date component formats. */
43
44     /* String formats. */
45     FMT_CAT_STRING         = 0x100      /* String formats. */
46   };
47
48 /* Format type. */
49 enum fmt_type
50   {
51 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) FMT_##NAME,
52 #include "format.def"
53     FMT_NUMBER_OF_FORMATS,
54   };
55
56 /* Length of longest format specifier name,
57    not including terminating null. */
58 #define FMT_TYPE_LEN_MAX 8
59
60 /* Length of longest string representation of fmt_spec,
61    not including terminating null. */
62 #define FMT_STRING_LEN_MAX 32
63
64 /* Display format. */
65 struct fmt_spec
66   {
67     enum fmt_type type;         /* One of FMT_*. */
68     int w;                      /* Width. */
69     int d;                      /* Number of implied decimal places. */
70   };
71
72 /* Maximum width of any numeric format. */
73 #define FMT_MAX_NUMERIC_WIDTH 40
74
75 /* A numeric output style. */
76 struct fmt_number_style
77   {
78     struct substring neg_prefix;      /* Negative prefix. */
79     struct substring prefix;          /* Prefix. */
80     struct substring suffix;          /* Suffix. */
81     struct substring neg_suffix;      /* Negative suffix. */
82     char decimal;                     /* Decimal point: '.' or ','. */
83     char grouping;                    /* Grouping character: ',', '.', or 0. */
84   };
85
86
87 extern struct fmt_number_style *the_styles ;
88
89
90 /* Initialization. */
91 struct fmt_number_style * fmt_create (void);
92 void fmt_done (struct fmt_number_style *);
93
94 /* Constructing formats. */
95 struct fmt_spec fmt_for_input (enum fmt_type, int w, int d) PURE_FUNCTION;
96 struct fmt_spec fmt_for_output (enum fmt_type, int w, int d) PURE_FUNCTION;
97 struct fmt_spec fmt_for_output_from_input (const struct fmt_spec *);
98 struct fmt_spec fmt_default_for_width (int width);
99
100 /* Verifying formats. */
101 bool fmt_check (const struct fmt_spec *, bool for_input);
102 bool fmt_check_input (const struct fmt_spec *);
103 bool fmt_check_output (const struct fmt_spec *);
104 bool fmt_check_type_compat (const struct fmt_spec *, enum val_type);
105 bool fmt_check_width_compat (const struct fmt_spec *, int var_width);
106
107 /* Working with formats. */
108 int fmt_var_width (const struct fmt_spec *);
109 char *fmt_to_string (const struct fmt_spec *, char s[FMT_STRING_LEN_MAX + 1]);
110 bool fmt_equal (const struct fmt_spec *, const struct fmt_spec *);
111 void fmt_resize (struct fmt_spec *, int new_width);
112
113 void fmt_fix (struct fmt_spec *, bool for_input);
114 void fmt_fix_input (struct fmt_spec *);
115 void fmt_fix_output (struct fmt_spec *);
116
117 /* Format types. */
118 const char *fmt_name (enum fmt_type) PURE_FUNCTION;
119 bool fmt_from_name (const char *name, enum fmt_type *);
120
121 bool fmt_takes_decimals (enum fmt_type) PURE_FUNCTION;
122
123 int fmt_min_width (enum fmt_type, bool for_input) PURE_FUNCTION;
124 int fmt_max_width (enum fmt_type, bool for_input) PURE_FUNCTION;
125 int fmt_max_decimals (enum fmt_type, int width, bool for_input) PURE_FUNCTION;
126 int fmt_min_input_width (enum fmt_type) PURE_FUNCTION;
127 int fmt_max_input_width (enum fmt_type) PURE_FUNCTION;
128 int fmt_max_input_decimals (enum fmt_type, int width) PURE_FUNCTION;
129 int fmt_min_output_width (enum fmt_type) PURE_FUNCTION;
130 int fmt_max_output_width (enum fmt_type) PURE_FUNCTION;
131 int fmt_max_output_decimals (enum fmt_type, int width) PURE_FUNCTION;
132 int fmt_step_width (enum fmt_type) PURE_FUNCTION;
133
134 bool fmt_is_string (enum fmt_type) PURE_FUNCTION;
135 bool fmt_is_numeric (enum fmt_type) PURE_FUNCTION;
136 enum fmt_category fmt_get_category (enum fmt_type) PURE_FUNCTION;
137
138 enum fmt_type fmt_input_to_output (enum fmt_type) PURE_FUNCTION;
139 bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION;
140
141 int fmt_to_io (enum fmt_type) PURE_FUNCTION;
142 bool fmt_from_io (int io, enum fmt_type *);
143
144 const char *fmt_date_template (enum fmt_type) PURE_FUNCTION;
145 \f
146 /* Maximum length of prefix or suffix string in
147    struct fmt_number_style. */
148 #define FMT_STYLE_AFFIX_MAX 16
149
150
151 struct fmt_number_style *fmt_number_style_create (void);
152 void fmt_number_style_destroy (struct fmt_number_style *);
153
154 int fmt_affix_width (const struct fmt_number_style *);
155 int fmt_neg_affix_width (const struct fmt_number_style *);
156
157 bool is_fmt_type (enum fmt_type);
158
159 const struct fmt_number_style *fmt_get_style (const struct fmt_number_style *,      enum fmt_type);
160
161 void fmt_check_style (const struct fmt_number_style *style);
162
163 int fmt_grouping_char (const struct fmt_number_style *, enum fmt_type);
164
165 void fmt_set_decimal (struct fmt_number_style *, char);
166
167 extern const struct fmt_spec F_8_0 ;
168
169 #endif /* data/format.h */