1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006 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/>. */
18 #define DATA_FORMAT_H 1
20 /* Display format types. */
23 #include <libpspp/str.h>
24 #include <data/val-type.h>
26 /* Format type categories.
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. */
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. */
45 FMT_CAT_STRING = 0x100 /* String formats. */
51 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) FMT_##NAME,
53 FMT_NUMBER_OF_FORMATS,
56 /* Length of longest format specifier name,
57 not including terminating null. */
58 #define FMT_TYPE_LEN_MAX 8
60 /* Length of longest string representation of fmt_spec,
61 not including terminating null. */
62 #define FMT_STRING_LEN_MAX 32
67 enum fmt_type type; /* One of FMT_*. */
69 int d; /* Number of implied decimal places. */
76 /* Constructing formats. */
77 struct fmt_spec fmt_for_input (enum fmt_type, int w, int d) PURE_FUNCTION;
78 struct fmt_spec fmt_for_output (enum fmt_type, int w, int d) PURE_FUNCTION;
79 struct fmt_spec fmt_for_output_from_input (const struct fmt_spec *);
80 struct fmt_spec fmt_default_for_width (int width);
82 /* Verifying formats. */
83 bool fmt_check (const struct fmt_spec *, bool for_input);
84 bool fmt_check_input (const struct fmt_spec *);
85 bool fmt_check_output (const struct fmt_spec *);
86 bool fmt_check_type_compat (const struct fmt_spec *, enum val_type);
87 bool fmt_check_width_compat (const struct fmt_spec *, int var_width);
89 /* Working with formats. */
90 int fmt_var_width (const struct fmt_spec *);
91 char *fmt_to_string (const struct fmt_spec *, char s[FMT_STRING_LEN_MAX + 1]);
92 bool fmt_equal (const struct fmt_spec *, const struct fmt_spec *);
93 void fmt_resize (struct fmt_spec *, int new_width);
96 const char *fmt_name (enum fmt_type) PURE_FUNCTION;
97 bool fmt_from_name (const char *name, enum fmt_type *);
99 bool fmt_takes_decimals (enum fmt_type) PURE_FUNCTION;
101 int fmt_min_input_width (enum fmt_type) PURE_FUNCTION;
102 int fmt_max_input_width (enum fmt_type) PURE_FUNCTION;
103 int fmt_max_input_decimals (enum fmt_type, int width) PURE_FUNCTION;
104 int fmt_min_output_width (enum fmt_type) PURE_FUNCTION;
105 int fmt_max_output_width (enum fmt_type) PURE_FUNCTION;
106 int fmt_max_output_decimals (enum fmt_type, int width) PURE_FUNCTION;
107 int fmt_step_width (enum fmt_type) PURE_FUNCTION;
109 bool fmt_is_string (enum fmt_type) PURE_FUNCTION;
110 bool fmt_is_numeric (enum fmt_type) PURE_FUNCTION;
111 enum fmt_category fmt_get_category (enum fmt_type) PURE_FUNCTION;
113 enum fmt_type fmt_input_to_output (enum fmt_type) PURE_FUNCTION;
114 bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION;
116 int fmt_to_io (enum fmt_type) PURE_FUNCTION;
117 bool fmt_from_io (int io, enum fmt_type *);
119 const char *fmt_date_template (enum fmt_type) PURE_FUNCTION;
120 char *fmt_dollar_template (const struct fmt_spec *);
122 /* Maximum length of prefix or suffix string in
123 struct fmt_number_style. */
124 #define FMT_STYLE_AFFIX_MAX 16
126 /* A numeric output style. */
127 struct fmt_number_style
129 struct substring neg_prefix; /* Negative prefix. */
130 struct substring prefix; /* Prefix. */
131 struct substring suffix; /* Suffix. */
132 struct substring neg_suffix; /* Negative suffix. */
133 char decimal; /* Decimal point: '.' or ','. */
134 char grouping; /* Grouping character: ',', '.', or 0. */
137 struct fmt_number_style *fmt_number_style_create (void);
138 void fmt_number_style_destroy (struct fmt_number_style *);
140 int fmt_affix_width (const struct fmt_number_style *);
141 int fmt_neg_affix_width (const struct fmt_number_style *);
143 const struct fmt_number_style *fmt_get_style (enum fmt_type);
144 void fmt_set_style (enum fmt_type, struct fmt_number_style *);
146 int fmt_decimal_char (enum fmt_type);
147 int fmt_grouping_char (enum fmt_type);
149 void fmt_set_decimal (char);
151 #endif /* data/format.h */