1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful, but
10 WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 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, write to the Free Software
16 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 /* Display format types. */
26 #include <data/variable.h>
27 #include <libpspp/str.h>
29 /* Format type categories. */
32 /* Numeric formats. */
33 FMT_CAT_BASIC = 0x001, /* Basic numeric formats. */
34 FMT_CAT_CUSTOM = 0x002, /* Custom currency formats. */
35 FMT_CAT_LEGACY = 0x004, /* Legacy numeric formats. */
36 FMT_CAT_BINARY = 0x008, /* Binary formats. */
37 FMT_CAT_HEXADECIMAL = 0x010, /* Hexadecimal formats. */
38 FMT_CAT_DATE = 0x020, /* Date formats. */
39 FMT_CAT_TIME = 0x040, /* Time formats. */
40 FMT_CAT_DATE_COMPONENT = 0x080, /* Date component formats. */
43 FMT_CAT_STRING = 0x100 /* String formats. */
48 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) FMT_##NAME,
50 FMT_NUMBER_OF_FORMATS,
53 /* Length of longest format specifier name,
54 not including terminating null. */
55 #define FMT_TYPE_LEN_MAX 8
57 /* Length of longest string representation of fmt_spec,
58 not including terminating null. */
59 #define FMT_STRING_LEN_MAX 32
64 enum fmt_type type; /* One of FMT_*. */
66 int d; /* Number of implied decimal places. */
75 /* Constructing formats. */
76 struct fmt_spec fmt_for_input (enum fmt_type, int w, int d) PURE_FUNCTION;
77 struct fmt_spec fmt_for_output (enum fmt_type, int w, int d) PURE_FUNCTION;
78 struct fmt_spec fmt_for_output_from_input (const struct fmt_spec *);
79 struct fmt_spec fmt_default_for_width (int var_width);
81 /* Verifying formats. */
82 bool fmt_check (const struct fmt_spec *, bool for_input);
83 bool fmt_check_input (const struct fmt_spec *);
84 bool fmt_check_output (const struct fmt_spec *);
85 bool fmt_check_type_compat (const struct fmt_spec *, enum var_type);
86 bool fmt_check_width_compat (const struct fmt_spec *, int var_width);
88 /* Working with formats. */
89 int fmt_var_width (const struct fmt_spec *);
90 char *fmt_to_string (const struct fmt_spec *, char s[FMT_STRING_LEN_MAX + 1]);
91 bool fmt_equal (const struct fmt_spec *, const struct fmt_spec *);
94 const char *fmt_name (enum fmt_type) PURE_FUNCTION;
95 bool fmt_from_name (const char *name, enum fmt_type *);
97 bool fmt_takes_decimals (enum fmt_type) PURE_FUNCTION;
99 int fmt_min_input_width (enum fmt_type) PURE_FUNCTION;
100 int fmt_max_input_width (enum fmt_type) PURE_FUNCTION;
101 int fmt_max_input_decimals (enum fmt_type, int width) PURE_FUNCTION;
102 int fmt_min_output_width (enum fmt_type) PURE_FUNCTION;
103 int fmt_max_output_width (enum fmt_type) PURE_FUNCTION;
104 int fmt_max_output_decimals (enum fmt_type, int width) PURE_FUNCTION;
105 int fmt_step_width (enum fmt_type) PURE_FUNCTION;
107 bool fmt_is_string (enum fmt_type) PURE_FUNCTION;
108 bool fmt_is_numeric (enum fmt_type) PURE_FUNCTION;
109 enum fmt_category fmt_get_category (enum fmt_type) PURE_FUNCTION;
111 enum fmt_type fmt_input_to_output (enum fmt_type) PURE_FUNCTION;
113 int fmt_to_io (enum fmt_type) PURE_FUNCTION;
114 bool fmt_from_io (int io, enum fmt_type *);
116 bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION;
117 const char *fmt_date_template (enum fmt_type) PURE_FUNCTION;
118 char *fmt_dollar_template (const struct fmt_spec *);
120 /* Maximum length of prefix or suffix string in
121 struct fmt_number_style. */
122 #define FMT_STYLE_AFFIX_MAX 16
124 /* A numeric output style. */
125 struct fmt_number_style
127 struct substring neg_prefix; /* Negative prefix. */
128 struct substring prefix; /* Prefix. */
129 struct substring suffix; /* Suffix. */
130 struct substring neg_suffix; /* Negative suffix. */
131 char decimal; /* Decimal point: '.' or ','. */
132 char grouping; /* Grouping character: ',', '.', or 0. */
135 struct fmt_number_style *fmt_number_style_create (void);
136 void fmt_number_style_destroy (struct fmt_number_style *);
138 const struct fmt_number_style *fmt_get_style (enum fmt_type);
139 void fmt_set_style (enum fmt_type, struct fmt_number_style *);
141 int fmt_affix_width (const struct fmt_number_style *);
142 int fmt_neg_affix_width (const struct fmt_number_style *);
144 int fmt_decimal_char (enum fmt_type);
145 int fmt_grouping_char (enum fmt_type);
147 void fmt_set_decimal (char);
149 #endif /* format.h */