pintos-os.org Git - pspp/blob - src/data/format.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2010, 2011, 2012 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 <stdint.h>
  24 #include "data/val-type.h"
  25 #include "libpspp/str.h"
  26
  27 struct fmt_settings;
  28
  29 /* How a format is going to be used. */
  30 enum fmt_use
  31   {
  32     FMT_FOR_INPUT,           /* For parsing data input, e.g. data_in(). */
  33     FMT_FOR_OUTPUT           /* For formatting data output, e.g. data_out(). */
  34   };
  35
  36 /* Format type categories.
  37
  38    Each format is in exactly one category.  We give categories
  39    bitwise disjoint values only to enable bitwise comparisons
  40    against a mask of FMT_CAT_* values, not to allow multiple
  41    categories per format. */
  42 enum fmt_category
  43   {
  44     /* Numeric formats. */
  45     FMT_CAT_BASIC          = 0x001,     /* Basic numeric formats. */
  46     FMT_CAT_CUSTOM         = 0x002,     /* Custom currency formats. */
  47     FMT_CAT_LEGACY         = 0x004,     /* Legacy numeric formats. */
  48     FMT_CAT_BINARY         = 0x008,     /* Binary formats. */
  49     FMT_CAT_HEXADECIMAL    = 0x010,     /* Hexadecimal formats. */
  50     FMT_CAT_DATE           = 0x020,     /* Date formats. */
  51     FMT_CAT_TIME           = 0x040,     /* Time formats. */
  52     FMT_CAT_DATE_COMPONENT = 0x080,     /* Date component formats. */
  53
  54     /* String formats. */
  55     FMT_CAT_STRING         = 0x100      /* String formats. */
  56   };
  57
  58 /* Format type. */
  59 enum fmt_type
  60   {
  61 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) FMT_##NAME,
  62 #include "format.def"
  63     FMT_NUMBER_OF_FORMATS,
  64   };
  65
  66 /* Length of longest format specifier name,
  67    not including terminating null. */
  68 #define FMT_TYPE_LEN_MAX 8
  69
  70 /* Length of longest string representation of fmt_spec,
  71    not including terminating null. */
  72 #define FMT_STRING_LEN_MAX 32
  73
  74 /* Display format. */
  75 struct fmt_spec
  76   {
  77     enum fmt_type type;         /* One of FMT_*. */
  78     int w;                      /* Width. */
  79     int d;                      /* Number of decimal places. */
  80   };
  81
  82 /* Maximum width of any numeric format. */
  83 #define FMT_MAX_NUMERIC_WIDTH 40
  84
  85 /* Constructing formats. */
  86 struct fmt_spec fmt_for_input (enum fmt_type, int w, int d) PURE_FUNCTION;
  87 struct fmt_spec fmt_for_output (enum fmt_type, int w, int d) PURE_FUNCTION;
  88 struct fmt_spec fmt_for_output_from_input (const struct fmt_spec *,
  89                                            const struct fmt_settings *);
  90 struct fmt_spec fmt_default_for_width (int width);
  91
  92 /* Verifying formats. */
  93 bool fmt_check (const struct fmt_spec *, enum fmt_use);
  94 bool fmt_check_input (const struct fmt_spec *);
  95 bool fmt_check_output (const struct fmt_spec *);
  96 bool fmt_check_type_compat (const struct fmt_spec *, enum val_type);
  97 bool fmt_check_width_compat (const struct fmt_spec *, int var_width);
  98
  99 /* Working with formats. */
 100 int fmt_var_width (const struct fmt_spec *);
 101 char *fmt_to_string (const struct fmt_spec *, char s[FMT_STRING_LEN_MAX + 1]);
 102 bool fmt_equal (const struct fmt_spec *, const struct fmt_spec *);
 103 bool fmt_resize (struct fmt_spec *, int new_width);
 104
 105 void fmt_fix (struct fmt_spec *, enum fmt_use);
 106 void fmt_fix_input (struct fmt_spec *);
 107 void fmt_fix_output (struct fmt_spec *);
 108
 109 void fmt_change_width (struct fmt_spec *, int width, enum fmt_use);
 110 void fmt_change_decimals (struct fmt_spec *, int decimals, enum fmt_use);
 111
 112 /* Format types. */
 113 bool is_fmt_type (enum fmt_type);
 114
 115 const char *fmt_name (enum fmt_type) PURE_FUNCTION;
 116 bool fmt_from_name (const char *name, enum fmt_type *);
 117
 118 bool fmt_takes_decimals (enum fmt_type) PURE_FUNCTION;
 119
 120 int fmt_min_width (enum fmt_type, enum fmt_use) PURE_FUNCTION;
 121 int fmt_max_width (enum fmt_type, enum fmt_use) PURE_FUNCTION;
 122 int fmt_max_decimals (enum fmt_type, int width, enum fmt_use) PURE_FUNCTION;
 123 int fmt_min_input_width (enum fmt_type) PURE_FUNCTION;
 124 int fmt_max_input_width (enum fmt_type) PURE_FUNCTION;
 125 int fmt_max_input_decimals (enum fmt_type, int width) PURE_FUNCTION;
 126 int fmt_min_output_width (enum fmt_type) PURE_FUNCTION;
 127 int fmt_max_output_width (enum fmt_type) PURE_FUNCTION;
 128 int fmt_max_output_decimals (enum fmt_type, int width) PURE_FUNCTION;
 129 int fmt_step_width (enum fmt_type) PURE_FUNCTION;
 130
 131 bool fmt_is_string (enum fmt_type) PURE_FUNCTION;
 132 bool fmt_is_numeric (enum fmt_type) PURE_FUNCTION;
 133 enum fmt_category fmt_get_category (enum fmt_type) PURE_FUNCTION;
 134
 135 enum fmt_type fmt_input_to_output (enum fmt_type) PURE_FUNCTION;
 136 bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION;
 137
 138 int fmt_to_io (enum fmt_type) PURE_FUNCTION;
 139 bool fmt_from_io (int io, enum fmt_type *);
 140 bool fmt_from_u32 (uint32_t, int var_width, bool loose, struct fmt_spec *);
 141
 142 const char *fmt_date_template (enum fmt_type, int width) PURE_FUNCTION;
 143 const char *fmt_gui_name (enum fmt_type);
 144 \f
 145 /* A prefix or suffix for a numeric output format. */
 146 struct fmt_affix
 147   {
 148     char *s;                    /* String contents of affix, in UTF-8. */
 149     int width;                  /* Display width in columns (see wcwidth()). */
 150   };
 151
 152 /* A numeric output style.  This can express the basic numeric formats (in the
 153    FMT_CAT_BASIC category) and custom currency formats (FMT_CCx). */
 154 struct fmt_number_style
 155   {
 156     struct fmt_affix neg_prefix; /* Negative prefix. */
 157     struct fmt_affix prefix;     /* Prefix. */
 158     struct fmt_affix suffix;     /* Suffix. */
 159     struct fmt_affix neg_suffix; /* Negative suffix. */
 160     char decimal;                /* Decimal point: '.' or ','. */
 161     char grouping;               /* Grouping character: ',', '.', or 0. */
 162
 163     /* A fmt_affix may require more bytes than its display width; for example,
 164        U+00A5 (¥) is 2 bytes in UTF-8 but occupies only one display column.
 165        This member is the sum of the number of bytes required by all of the
 166        fmt_affix members in this struct, minus their display widths.  Thus, it
 167        can be used to size memory allocations: for example, the formatted
 168        result of CCA20.5 requires no more than (20 + extra_bytes) bytes in
 169        UTF-8. */
 170     int extra_bytes;
 171   };
 172
 173 struct fmt_number_style *fmt_number_style_from_string (const char *);
 174 struct fmt_number_style *fmt_number_style_clone (
 175   const struct fmt_number_style *);
 176 void fmt_number_style_destroy (struct fmt_number_style *);
 177
 178 int fmt_affix_width (const struct fmt_number_style *);
 179 int fmt_neg_affix_width (const struct fmt_number_style *);
 180 \f
 181 /* Number of custom currency styles. */
 182 #define FMT_N_CCS 5             /* FMT_CCA through FMT_CCE. */
 183
 184 struct fmt_settings
 185   {
 186     int epoch;                               /* 0 for default epoch. */
 187     char decimal;                            /* '.' or ','. */
 188     struct fmt_number_style *ccs[FMT_N_CCS]; /* CCA through CCE. */
 189   };
 190 #define FMT_SETTINGS_INIT { .decimal = '.' }
 191
 192 void fmt_settings_init (struct fmt_settings *);
 193 void fmt_settings_uninit (struct fmt_settings *);
 194 void fmt_settings_copy (struct fmt_settings *, const struct fmt_settings *);
 195
 196 const struct fmt_number_style *fmt_settings_get_style (
 197   const struct fmt_settings *, enum fmt_type);
 198 int fmt_settings_get_epoch (const struct fmt_settings *);
 199
 200 void fmt_settings_set_cc (struct fmt_settings *, enum fmt_type,
 201                           struct fmt_number_style *);
 202 \f
 203 extern const struct fmt_spec F_8_0 ;
 204 extern const struct fmt_spec F_8_2 ;
 205 extern const struct fmt_spec F_4_3 ;
 206 extern const struct fmt_spec F_5_1 ;
 207
 208 #endif /* data/format.h */