1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2010, 2011, 2012 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/>. */
26 #include "data/identifier.h"
27 #include "data/settings.h"
28 #include "data/value.h"
29 #include "data/variable.h"
30 #include "libpspp/assertion.h"
31 #include "libpspp/cast.h"
32 #include "libpspp/compiler.h"
33 #include "libpspp/message.h"
34 #include "libpspp/misc.h"
35 #include "libpspp/str.h"
37 #include "gl/c-strcase.h"
38 #include "gl/minmax.h"
39 #include "gl/xalloc.h"
40 #include "gl/xmemdup0.h"
43 #define _(msgid) gettext (msgid)
45 bool is_fmt_type (enum fmt_type);
47 static bool valid_width (enum fmt_type, int width, enum fmt_use);
49 static int max_digits_for_bytes (int bytes);
50 static void fmt_clamp_width (struct fmt_spec *, enum fmt_use);
51 static void fmt_clamp_decimals (struct fmt_spec *, enum fmt_use);
54 fmt_settings_init (struct fmt_settings *settings)
56 *settings = (struct fmt_settings) FMT_SETTINGS_INIT;
60 fmt_settings_uninit (struct fmt_settings *settings)
62 for (int i = 0; i < FMT_N_CCS; i++)
63 fmt_number_style_destroy (settings->ccs[i]);
67 fmt_settings_copy (const struct fmt_settings *old)
69 struct fmt_settings new = *old;
70 for (int i = 0; i < FMT_N_CCS; i++)
71 new.ccs[i] = fmt_number_style_clone (old->ccs[i]);
76 fmt_type_to_cc_index (enum fmt_type type)
80 case FMT_CCA: return 0;
81 case FMT_CCB: return 1;
82 case FMT_CCC: return 2;
83 case FMT_CCD: return 3;
84 case FMT_CCE: return 4;
85 default: NOT_REACHED ();
89 /* Returns the number formatting style associated with the given
91 const struct fmt_number_style *
92 fmt_settings_get_style (const struct fmt_settings *settings,
96 verify (FMT_COMMA < 6);
98 verify (FMT_DOLLAR < 6);
102 #define OPPOSITE(C) ((C) == ',' ? '.' : ',')
103 #define AFFIX(S) { .s = (char *) (S), .width = sizeof (S) - 1 }
104 #define NS(PREFIX, SUFFIX, DECIMAL, GROUPING, INCLUDE_LEADING_ZERO) { \
105 .neg_prefix = AFFIX ("-"), \
106 .prefix = AFFIX (PREFIX), \
107 .suffix = AFFIX (SUFFIX), \
108 .neg_suffix = AFFIX (""), \
109 .decimal = DECIMAL, \
110 .grouping = GROUPING, \
111 .include_leading_zero = INCLUDE_LEADING_ZERO \
113 #define ANS(DECIMAL, GROUPING, INCLUDE_LEADING_ZERO) { \
114 [FMT_F] = NS( "", "", DECIMAL, 0, INCLUDE_LEADING_ZERO), \
115 [FMT_E] = NS( "", "", DECIMAL, 0, INCLUDE_LEADING_ZERO), \
116 [FMT_COMMA] = NS( "", "", DECIMAL, GROUPING, INCLUDE_LEADING_ZERO), \
117 [FMT_DOT] = NS( "", "", GROUPING, DECIMAL, INCLUDE_LEADING_ZERO), \
118 [FMT_DOLLAR] = NS("$", "", DECIMAL, GROUPING, false), \
119 [FMT_PCT] = NS( "", "%", DECIMAL, 0, false), \
121 #define ANS2(DECIMAL, GROUPING) { \
122 ANS(DECIMAL, GROUPING, false), \
123 ANS(DECIMAL, GROUPING, true), \
126 /* First index: 0 for ',' decimal point, 1 for '.' decimal point.
127 Second index: 0 for no leading zero, 1 for leading zero.
130 static const struct fmt_number_style styles[2][2][6] = {
135 static const struct fmt_number_style default_style = NS ("", "", '.', 0, false);
146 int decimal_idx = settings->decimal == '.';
147 int leadzero_idx = settings->include_leading_zero;
148 return &styles[decimal_idx][leadzero_idx][type];
157 size_t idx = fmt_type_to_cc_index (type);
158 return settings->ccs[idx] ? settings->ccs[idx] : &default_style;
162 return &default_style;
169 static int epoch = 0;
173 struct tm *tm = localtime (&t);
174 epoch = (tm != NULL ? tm->tm_year + 1900 : 2000) - 69;
180 fmt_settings_get_epoch (const struct fmt_settings *settings)
182 return !settings->epoch ? default_epoch () : settings->epoch;
186 fmt_settings_set_cc (struct fmt_settings *settings, enum fmt_type type,
187 struct fmt_number_style *style)
189 size_t idx = fmt_type_to_cc_index (type);
191 fmt_number_style_destroy (settings->ccs[idx]);
192 settings->ccs[idx] = style;
196 /* Returns an input format specification with type TYPE, width W,
199 fmt_for_input (enum fmt_type type, int w, int d)
201 struct fmt_spec f = { .type = type, .w = w, .d = d };
202 assert (fmt_check_input (&f));
206 /* Returns an output format specification with type TYPE, width
207 W, and D decimals. */
209 fmt_for_output (enum fmt_type type, int w, int d)
211 struct fmt_spec f = { .type = type, .w = w, .d = d };
212 assert (fmt_check_output (&f));
216 /* Returns the output format specifier corresponding to input
217 format specifier INPUT. */
219 fmt_for_output_from_input (const struct fmt_spec *input,
220 const struct fmt_settings *settings)
222 struct fmt_spec output;
224 assert (fmt_check_input (input));
226 output.type = fmt_input_to_output (input->type);
228 if (output.w > fmt_max_output_width (output.type))
229 output.w = fmt_max_output_width (output.type);
230 else if (output.w < fmt_min_output_width (output.type))
231 output.w = fmt_min_output_width (output.type);
248 const struct fmt_number_style *style =
249 fmt_settings_get_style (settings, input->type);
251 output.w += fmt_affix_width (style);
252 if (style->grouping != 0 && input->w - input->d >= 3)
253 output.w += (input->w - input->d - 1) / 3;
265 output.d = MAX (input->d, 3);
266 output.w = MAX (input->w, output.d + 7);
270 output.w = max_digits_for_bytes (input->w / 2) + 1;
281 output.w = 2 * input->w + (input->d > 0);
286 output.w = max_digits_for_bytes (input->w) + 1;
302 output.w = input->w / 2;
322 output.w = MAX (input->w, input->d + 6);
327 output.w = MAX (input->w, input->d + 20);
334 if (output.w > fmt_max_output_width (output.type))
335 output.w = fmt_max_output_width (output.type);
337 assert (fmt_check_output (&output));
341 /* Returns the default format for the given WIDTH: F8.2 format
342 for a numeric value, A format for a string value. */
344 fmt_default_for_width (int width)
347 ? fmt_for_output (FMT_F, 8, 2)
348 : fmt_for_output (FMT_A, width, 0));
351 /* Checks whether SPEC is valid for USE and returns NULL if so. Otherwise,
352 returns a malloc()'d string that describes the error. The caller must
353 eventually free() the string. */
355 fmt_check__ (const struct fmt_spec *spec, enum fmt_use use)
357 char str[FMT_STRING_LEN_MAX + 1];
358 int min_w, max_w, max_d;
360 assert (is_fmt_type (spec->type));
361 fmt_to_string (spec, str);
363 if (use == FMT_FOR_INPUT && !fmt_usable_for_input (spec->type))
364 return xasprintf (_("Format %s may not be used for input."), str);
366 if (spec->w % fmt_step_width (spec->type))
368 assert (fmt_step_width (spec->type) == 2);
369 return (use == FMT_FOR_INPUT
370 ? xasprintf (_("Input format %s specifies width %d, "
371 "but %s requires an even width."),
372 str, spec->w, fmt_name (spec->type))
373 : xasprintf (_("Output format %s specifies width %d, "
374 "but %s requires an even width."),
375 str, spec->w, fmt_name (spec->type)));
378 min_w = fmt_min_width (spec->type, use);
379 max_w = fmt_max_width (spec->type, use);
380 if (spec->w < min_w || spec->w > max_w)
381 return (use == FMT_FOR_INPUT
382 ? xasprintf (_("Input format %s specifies width %d, but "
383 "%s requires a width between %d and %d."),
384 str, spec->w, fmt_name (spec->type), min_w, max_w)
385 : xasprintf (_("Output format %s specifies width %d, but "
386 "%s requires a width between %d and %d."),
387 str, spec->w, fmt_name (spec->type), min_w, max_w));
389 max_d = fmt_max_decimals (spec->type, spec->w, use);
390 if (!fmt_takes_decimals (spec->type) && spec->d != 0)
391 return (use == FMT_FOR_INPUT
392 ? xasprintf (ngettext (
393 "Input format %s specifies %d decimal "
394 "place, but %s does not allow any decimals.",
395 "Input format %s specifies %d decimal "
396 "places, but %s does not allow any "
399 str, spec->d, fmt_name (spec->type))
400 : xasprintf (ngettext (
401 "Output format %s specifies %d decimal "
402 "place, but %s does not allow any decimals.",
403 "Output format %s specifies %d decimal places, but "
404 "%s does not allow any decimals.",
406 str, spec->d, fmt_name (spec->type)));
407 else if (spec->d > max_d)
410 return (use == FMT_FOR_INPUT
411 ? xasprintf (ngettext (
412 "Input format %s specifies %d decimal place, "
413 "but the given width allows at most "
415 "Input format %s specifies %d decimal places, "
416 "but the given width allows at most "
420 : xasprintf (ngettext (
421 "Output format %s specifies %d decimal place, "
422 "but the given width allows at most "
424 "Output format %s specifies %d decimal places, "
425 "but the given width allows at most "
428 str, spec->d, max_d));
430 return (use == FMT_FOR_INPUT
431 ? xasprintf (ngettext (
432 "Input format %s specifies %d decimal place, "
433 "but the given width does not allow "
435 "Input format %s specifies %d decimal places, "
436 "but the given width does not allow "
440 : xasprintf (ngettext (
441 "Output format %s specifies %d decimal place, "
442 "but the given width does not allow "
444 "Output format %s specifies %d decimal places, "
445 "but the given width does not allow "
455 fmt_emit_and_free_error (char *error)
459 msg (SE, "%s", error);
467 /* Checks whether SPEC is valid for USE and returns nonzero if so. Otherwise,
468 emits an error message for the current source location and returns zero. */
470 fmt_check (const struct fmt_spec *spec, enum fmt_use use)
472 return fmt_emit_and_free_error (fmt_check__ (spec, use));
475 /* Checks whether SPEC is valid as an input format and returns
476 nonzero if so. Otherwise, emits an error message and returns
479 fmt_check_input (const struct fmt_spec *spec)
481 return fmt_check (spec, FMT_FOR_INPUT);
484 /* Checks whether SPEC is valid as an output format and returns
485 true if so. Otherwise, emits an error message and returns false. */
487 fmt_check_output (const struct fmt_spec *spec)
489 return fmt_check (spec, FMT_FOR_OUTPUT);
492 /* Checks that FORMAT is appropriate for a variable of the given VAR_TYPE and
493 returns NULL if so. Otherwise returns a malloc()'d error message that the
494 calelr must eventually free(). */
496 fmt_check_type_compat__ (const struct fmt_spec *format, enum val_type var_type)
498 assert (val_type_is_valid (var_type));
499 if ((var_type == VAL_STRING) != (fmt_is_string (format->type) != 0))
501 char str[FMT_STRING_LEN_MAX + 1];
502 return xasprintf (_("%s variables are not compatible with %s format %s."),
503 var_type == VAL_STRING ? _("String") : _("Numeric"),
504 var_type == VAL_STRING ? _("numeric") : _("string"),
505 fmt_to_string (format, str));
510 /* Checks that FORMAT is appropriate for a variable of the given
511 VAR_TYPE and returns true if so. Otherwise returns false and
512 emits an error message. */
514 fmt_check_type_compat (const struct fmt_spec *format, enum val_type var_type)
516 return fmt_emit_and_free_error (fmt_check_type_compat__ (format, var_type));
519 /* Checks that FORMAT is appropriate for a variable of the given WIDTH and
520 returns NULL if so. Otherwise returns a malloc()'d error message that the
521 calelr must eventually free(). */
523 fmt_check_width_compat__ (const struct fmt_spec *format, int width)
525 char *error = fmt_check_type_compat__ (format, val_type_from_width (width));
529 if (fmt_var_width (format) != width)
531 char str[FMT_STRING_LEN_MAX + 1];
532 return xasprintf (_("String variable with width %d is not compatible "
534 width, fmt_to_string (format, str));
540 /* Checks that FORMAT is appropriate for a variable of the given
541 WIDTH and returns true if so. Otherwise returns false and
542 emits an error message. */
544 fmt_check_width_compat (const struct fmt_spec *format, int width)
546 return fmt_emit_and_free_error (fmt_check_width_compat__ (format, width));
549 /* Returns the width corresponding to FORMAT. The return value
550 is the width of the `union value's required by FORMAT. */
552 fmt_var_width (const struct fmt_spec *format)
554 return (format->type == FMT_AHEX ? format->w / 2
555 : format->type == FMT_A ? format->w
559 /* Converts F to its string representation (for instance, "F8.2")
560 in BUFFER. Returns BUFFER.
562 If F has decimals, they are included in the output string,
563 even if F's format type does not allow decimals, to allow
564 accurately presenting incorrect formats to the user. */
566 fmt_to_string (const struct fmt_spec *f, char buffer[FMT_STRING_LEN_MAX + 1])
568 if (fmt_takes_decimals (f->type) || f->d > 0)
569 snprintf (buffer, FMT_STRING_LEN_MAX + 1,
570 "%s%d.%d", fmt_name (f->type), f->w, f->d);
572 snprintf (buffer, FMT_STRING_LEN_MAX + 1,
573 "%s%d", fmt_name (f->type), f->w);
577 /* Returns true if A and B are identical formats,
580 fmt_equal (const struct fmt_spec *a, const struct fmt_spec *b)
582 return a->type == b->type && a->w == b->w && a->d == b->d;
585 /* Adjusts FMT to be valid for a value of the given WIDTH if necessary.
586 If nothing needed to be changed the return value is false
589 fmt_resize (struct fmt_spec *fmt, int width)
591 if ((width > 0) != fmt_is_string (fmt->type))
593 /* Changed from numeric to string or vice versa. Set to
594 default format for new width. */
595 *fmt = fmt_default_for_width (width);
599 /* Changed width of string. Preserve format type, adjust
601 fmt->w = fmt->type == FMT_AHEX ? width * 2 : width;
611 /* Adjusts FMT's width and decimal places to be valid for USE. */
613 fmt_fix (struct fmt_spec *fmt, enum fmt_use use)
615 /* Clamp width to those allowed by format. */
616 fmt_clamp_width (fmt, use);
618 /* If FMT has more decimal places than allowed, attempt to increase FMT's
619 width until that number of decimal places can be achieved. */
620 if (fmt->d > fmt_max_decimals (fmt->type, fmt->w, use)
621 && fmt_takes_decimals (fmt->type))
623 int max_w = fmt_max_width (fmt->type, use);
624 for (; fmt->w < max_w; fmt->w++)
625 if (fmt->d <= fmt_max_decimals (fmt->type, fmt->w, use))
629 /* Clamp decimals to those allowed by format and width. */
630 fmt_clamp_decimals (fmt, use);
633 /* Adjusts FMT's width and decimal places to be valid for an
636 fmt_fix_input (struct fmt_spec *fmt)
638 fmt_fix (fmt, FMT_FOR_INPUT);
641 /* Adjusts FMT's width and decimal places to be valid for an
644 fmt_fix_output (struct fmt_spec *fmt)
646 fmt_fix (fmt, FMT_FOR_OUTPUT);
649 /* Sets FMT's width to WIDTH (or the nearest width allowed by FMT's type) and
650 reduces its decimal places as necessary (if necessary) for that width. */
652 fmt_change_width (struct fmt_spec *fmt, int width, enum fmt_use use)
655 fmt_clamp_width (fmt, use);
656 fmt_clamp_decimals (fmt, use);
659 /* Sets FMT's decimal places to DECIMALS (or the nearest number of decimal
660 places allowed by FMT's type) and increases its width as necessary (if
661 necessary) for that number of decimal places. */
663 fmt_change_decimals (struct fmt_spec *fmt, int decimals, enum fmt_use use)
669 /* Describes a display format. */
673 int min_input_width, min_output_width;
675 enum fmt_category category;
678 static const struct fmt_desc *get_fmt_desc (enum fmt_type type);
680 /* Returns the name of the given format TYPE. */
682 fmt_name (enum fmt_type type)
684 return get_fmt_desc (type)->name;
687 /* Tries to parse NAME as a format type.
688 If successful, stores the type in *TYPE and returns true.
689 On failure, returns false. */
691 fmt_from_name (const char *name, enum fmt_type *type)
695 for (i = 0; i < FMT_NUMBER_OF_FORMATS; i++)
696 if (!c_strcasecmp (name, get_fmt_desc (i)->name))
704 /* Returns true if TYPE accepts decimal places,
707 fmt_takes_decimals (enum fmt_type type)
709 return fmt_max_output_decimals (type, fmt_max_output_width (type)) > 0;
712 /* Returns the minimum width of the given format TYPE for the given USE. */
714 fmt_min_width (enum fmt_type type, enum fmt_use use)
716 return (use == FMT_FOR_INPUT
717 ? fmt_min_input_width (type)
718 : fmt_min_output_width (type));
721 /* Returns the maximum width of the given format TYPE,
722 for input if FOR_INPUT is true,
723 for output otherwise. */
725 fmt_max_width (enum fmt_type type, enum fmt_use use UNUSED)
727 /* Maximum width is actually invariant of whether the format is
728 for input or output, so FOR_INPUT is unused. */
729 assert (is_fmt_type (type));
747 return 2 * MAX_STRING;
754 /* Returns the maximum number of decimal places allowed for the
755 given format TYPE with a width of WIDTH places, for the given USE. */
757 fmt_max_decimals (enum fmt_type type, int width, enum fmt_use use)
766 max_d = use == FMT_FOR_INPUT ? width : width - 1;
771 max_d = use == FMT_FOR_INPUT ? width : width - 2;
775 max_d = use == FMT_FOR_INPUT ? width : width - 7;
783 assert (use == FMT_FOR_OUTPUT);
793 max_d = width * 2 - 1;
802 max_d = max_digits_for_bytes (width);
863 /* Returns the minimum acceptable width for an input field
864 formatted with the given TYPE. */
866 fmt_min_input_width (enum fmt_type type)
868 return get_fmt_desc (type)->min_input_width;
871 /* Returns the maximum acceptable width for an input field
872 formatted with the given TYPE. */
874 fmt_max_input_width (enum fmt_type type)
876 return fmt_max_width (type, FMT_FOR_INPUT);
879 /* Returns the maximum number of decimal places allowed in an
880 input field of the given TYPE and WIDTH. */
882 fmt_max_input_decimals (enum fmt_type type, int width)
884 assert (valid_width (type, width, true));
885 return fmt_max_decimals (type, width, FMT_FOR_INPUT);
888 /* Returns the minimum acceptable width for an output field
889 formatted with the given TYPE. */
891 fmt_min_output_width (enum fmt_type type)
893 return get_fmt_desc (type)->min_output_width;
896 /* Returns the maximum acceptable width for an output field
897 formatted with the given TYPE. */
899 fmt_max_output_width (enum fmt_type type)
901 return fmt_max_width (type, FMT_FOR_OUTPUT);
904 /* Returns the maximum number of decimal places allowed in an
905 output field of the given TYPE and WIDTH. */
907 fmt_max_output_decimals (enum fmt_type type, int width)
909 assert (valid_width (type, width, false));
910 return fmt_max_decimals (type, width, FMT_FOR_OUTPUT);
913 /* Returns the width step for a field formatted with the given
914 TYPE. Field width must be a multiple of the width step. */
916 fmt_step_width (enum fmt_type type)
918 return (fmt_get_category (type) == FMT_CAT_HEXADECIMAL || type == FMT_AHEX
922 /* Returns true if TYPE is used for string fields,
923 false if it is used for numeric fields. */
925 fmt_is_string (enum fmt_type type)
927 return fmt_get_category (type) == FMT_CAT_STRING;
930 /* Returns true if TYPE is used for numeric fields,
931 false if it is used for string fields. */
933 fmt_is_numeric (enum fmt_type type)
935 return !fmt_is_string (type);
938 /* Returns the format TYPE's category.
939 Each format type is in exactly one category,
940 and each category's value is bitwise disjoint from every other
941 category. Thus, the return value may be tested for equality
942 or compared bitwise against a mask of FMT_CAT_* values. */
944 fmt_get_category (enum fmt_type type)
946 return get_fmt_desc (type)->category;
949 /* Returns the output format selected by default when TYPE is
950 used as an input format. */
952 fmt_input_to_output (enum fmt_type type)
954 switch (fmt_get_category (type))
961 case FMT_CAT_HEXADECIMAL:
969 /* Returns the SPSS format type corresponding to the given PSPP
972 fmt_to_io (enum fmt_type type)
974 return get_fmt_desc (type)->io;
977 /* Determines the PSPP format corresponding to the given SPSS
978 format type. If successful, sets *FMT_TYPE to the PSPP format
979 and returns true. On failure, return false. */
981 fmt_from_io (int io, enum fmt_type *fmt_type)
985 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) \
987 *fmt_type = FMT_##NAME; \
989 #include "format.def"
995 /* Translate U32, which is in the form found in SAV and SPV files, into a
996 format specification, and stores the new specification in *F.
998 If LOOSE is false, checks that the format specification is appropriate as an
999 output format for a variable with the given WIDTH and reports an error if
1000 not. If LOOSE is true, instead adjusts the format's width and decimals as
1001 necessary to be suitable.
1003 Return true if successful, false if there was an error.. */
1005 fmt_from_u32 (uint32_t u32, int width, bool loose, struct fmt_spec *f)
1007 uint8_t raw_type = u32 >> 16;
1008 uint8_t w = u32 >> 8;
1014 bool ok = fmt_from_io (raw_type, &f->type);
1020 ok = fmt_check_output (f);
1023 ok = fmt_check_width_compat (f, width);
1029 /* Returns true if TYPE may be used as an input format,
1032 fmt_usable_for_input (enum fmt_type type)
1034 assert (is_fmt_type (type));
1035 return fmt_get_category (type) != FMT_CAT_CUSTOM;
1038 /* For time and date formats, returns a template used for input and output in a
1039 field of the given WIDTH.
1041 WIDTH only affects whether a 2-digit year or a 4-digit year is used, that
1042 is, whether the returned string contains "yy" or "yyyy", and whether seconds
1043 are include, that is, whether the returned string contains ":SS". A caller
1044 that doesn't care whether the returned string contains "yy" or "yyyy" or
1045 ":SS" can just specify 0 to omit them. */
1047 fmt_date_template (enum fmt_type type, int width)
1049 const char *s1, *s2;
1094 s1 = "dd-mmm-yyyy HH:MM";
1095 s2 = "dd-mmm-yyyy HH:MM:SS";
1099 s1 = "yyyy-mm-dd HH:MM";
1100 s2 = "yyyy-mm-dd HH:MM:SS";
1122 return width >= strlen (s2) ? s2 : s1;
1125 /* Returns a string representing the format TYPE for use in a GUI dialog. */
1127 fmt_gui_name (enum fmt_type type)
1132 return _("Numeric");
1141 return _("Scientific");
1174 return fmt_name (type);
1178 /* Returns true if TYPE is a valid format type,
1181 is_fmt_type (enum fmt_type type)
1183 return type < FMT_NUMBER_OF_FORMATS;
1186 /* Returns true if WIDTH is a valid width for the given format
1187 TYPE, for the given USE. */
1189 valid_width (enum fmt_type type, int width, enum fmt_use use)
1191 return (width >= fmt_min_width (type, use)
1192 && width <= fmt_max_width (type, use));
1195 /* Returns the maximum number of decimal digits in an unsigned
1196 binary number that is BYTES bytes long. */
1198 max_digits_for_bytes (int bytes)
1200 int map[8] = {3, 5, 8, 10, 13, 15, 17, 20};
1201 assert (bytes > 0 && bytes <= sizeof map / sizeof *map);
1202 return map[bytes - 1];
1205 /* Clamp FMT's width to the range and values allowed by FMT's type. */
1207 fmt_clamp_width (struct fmt_spec *fmt, enum fmt_use use)
1212 min_w = fmt_min_width (fmt->type, use);
1213 max_w = fmt_max_width (fmt->type, use);
1216 else if (fmt->w > max_w)
1219 /* Round width to step. */
1220 step = fmt_step_width (fmt->type);
1221 fmt->w = ROUND_DOWN (fmt->w, step);
1224 /* Clamp FMT's decimal places to the range allowed by FMT's type and width. */
1226 fmt_clamp_decimals (struct fmt_spec *fmt, enum fmt_use use)
1228 int max_d = fmt_max_decimals (fmt->type, fmt->w, use);
1233 static struct fmt_affix
1234 fmt_affix_clone (const struct fmt_affix *old)
1236 return (struct fmt_affix) {
1237 .s = xstrdup_if_nonnull (old->s),
1238 .width = old->width,
1242 /* Frees data in AFFIX. */
1244 fmt_affix_free (struct fmt_affix *affix)
1250 /* Find and returns the grouping character in CC_STRING (either '.' or ',') or
1253 find_cc_separators (const char *cc_string)
1255 /* Count commas and periods. There must be exactly three of
1256 one or the other, except that an apostrophe escapes a
1257 following comma or period. */
1260 for (const char *p = cc_string; *p; p++)
1265 else if (*p == '\'' && (p[1] == '.' || p[1] == ',' || p[1] == '\''))
1268 return (n_commas == 3 ? (n_dots != 3 ? ',' : 0)
1273 /* Extracts a token from IN into a newly allocated string AFFIXP. Tokens are
1274 delimited by GROUPING. Returns the first character following the token. */
1275 static struct fmt_affix
1276 extract_cc_token (const char **sp, int grouping, size_t *extra_bytes)
1278 const char *p = *sp;
1279 for (; *p && *p != grouping; p++)
1280 if (*p == '\'' && p[1] == grouping)
1283 size_t length = p - *sp;
1284 char *affix = xmemdup0 (*sp, length);
1285 size_t width = u8_strwidth (CHAR_CAST (const uint8_t *, affix), "UTF-8");
1287 *extra_bytes += length - width;
1289 *sp = p + (*p != 0);
1291 return (struct fmt_affix) { .s = affix, .width = width };
1294 struct fmt_number_style *
1295 fmt_number_style_from_string (const char *s)
1297 char grouping = find_cc_separators (s);
1301 size_t extra_bytes = 0;
1302 struct fmt_affix neg_prefix = extract_cc_token (&s, grouping, &extra_bytes);
1303 struct fmt_affix prefix = extract_cc_token (&s, grouping, &extra_bytes);
1304 struct fmt_affix suffix = extract_cc_token (&s, grouping, &extra_bytes);
1305 struct fmt_affix neg_suffix = extract_cc_token (&s, grouping, &extra_bytes);
1307 struct fmt_number_style *style = xmalloc (sizeof *style);
1308 *style = (struct fmt_number_style) {
1309 .neg_prefix = neg_prefix,
1312 .neg_suffix = neg_suffix,
1313 .decimal = grouping == '.' ? ',' : '.',
1314 .grouping = grouping,
1315 .include_leading_zero = false,
1316 .extra_bytes = extra_bytes,
1322 format_cc (struct string *out, const char *in, char grouping)
1327 if (c == grouping || c == '\'')
1328 ds_put_byte (out, '\'');
1330 ds_put_byte (out, '"');
1331 ds_put_byte (out, c);
1336 fmt_number_style_to_string (const struct fmt_number_style *cc)
1338 struct string out = DS_EMPTY_INITIALIZER;
1339 format_cc (&out, cc->neg_prefix.s, cc->grouping);
1340 ds_put_byte (&out, cc->grouping);
1341 format_cc (&out, cc->prefix.s, cc->grouping);
1342 ds_put_byte (&out, cc->grouping);
1343 format_cc (&out, cc->suffix.s, cc->grouping);
1344 ds_put_byte (&out, cc->grouping);
1345 format_cc (&out, cc->neg_suffix.s, cc->grouping);
1346 return ds_steal_cstr (&out);
1349 struct fmt_number_style *
1350 fmt_number_style_clone (const struct fmt_number_style *old)
1354 struct fmt_number_style *new = xmalloc (sizeof *new);
1355 *new = (struct fmt_number_style) {
1356 .neg_prefix = fmt_affix_clone (&old->neg_prefix),
1357 .prefix = fmt_affix_clone (&old->prefix),
1358 .suffix = fmt_affix_clone (&old->suffix),
1359 .neg_suffix = fmt_affix_clone (&old->neg_suffix),
1360 .decimal = old->decimal,
1361 .grouping = old->grouping,
1362 .extra_bytes = old->extra_bytes,
1370 /* Destroys a struct fmt_number_style. */
1372 fmt_number_style_destroy (struct fmt_number_style *style)
1376 fmt_affix_free (&style->neg_prefix);
1377 fmt_affix_free (&style->prefix);
1378 fmt_affix_free (&style->suffix);
1379 fmt_affix_free (&style->neg_suffix);
1384 /* Returns the total width of the standard prefix and suffix for STYLE, in
1385 display columns (e.g. as returned by u8_strwidth()). */
1387 fmt_affix_width (const struct fmt_number_style *style)
1389 return style->prefix.width + style->suffix.width;
1392 /* Returns the total width of the negative prefix and suffix for STYLE, in
1393 display columns (e.g. as returned by u8_strwidth()). */
1395 fmt_neg_affix_width (const struct fmt_number_style *style)
1397 return style->neg_prefix.width + style->neg_suffix.width;
1400 /* Returns the struct fmt_desc for the given format TYPE. */
1401 static const struct fmt_desc *
1402 get_fmt_desc (enum fmt_type type)
1404 static const struct fmt_desc formats[FMT_NUMBER_OF_FORMATS] =
1406 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) \
1407 {#NAME, IMIN, OMIN, IO, CATEGORY},
1408 #include "format.def"
1411 assert (is_fmt_type (type));
1412 return &formats[type];
1415 const struct fmt_spec F_8_0 = { .type = FMT_F, .w = 8, .d = 0 };
1416 const struct fmt_spec F_8_2 = { .type = FMT_F, .w = 8, .d = 2 };
1417 const struct fmt_spec F_4_3 = { .type = FMT_F, .w = 4, .d = 3 };
1418 const struct fmt_spec F_5_1 = { .type = FMT_F, .w = 5, .d = 1 };