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_check_input__ (const struct fmt_spec *spec)
457 return fmt_check__ (spec, FMT_FOR_INPUT);
461 fmt_check_output__ (const struct fmt_spec *spec)
463 return fmt_check__ (spec, FMT_FOR_OUTPUT);
467 error_to_bool (char *error)
478 /* Returns true if SPEC is valid for USE, false otherwise. */
480 fmt_check (const struct fmt_spec *spec, enum fmt_use use)
482 return error_to_bool (fmt_check__ (spec, use));
485 /* Returns true if SPEC is valid as an input format, otherwise false. */
487 fmt_check_input (const struct fmt_spec *spec)
489 return fmt_check (spec, FMT_FOR_INPUT);
492 /* Returnst true SPEC is valid as an output format, false otherwise. */
494 fmt_check_output (const struct fmt_spec *spec)
496 return fmt_check (spec, FMT_FOR_OUTPUT);
499 /* Checks that FORMAT is appropriate for a variable of the given VAR_TYPE and
500 returns NULL if so. Otherwise returns a malloc()'d error message that the
501 caller must eventually free(). */
503 fmt_check_type_compat__ (const struct fmt_spec *format, enum val_type var_type)
505 assert (val_type_is_valid (var_type));
506 if ((var_type == VAL_STRING) != (fmt_is_string (format->type) != 0))
508 char str[FMT_STRING_LEN_MAX + 1];
509 fmt_to_string (format, str);
510 if (var_type == VAL_STRING)
511 return xasprintf (_("String variables are not compatible with "
512 "numeric format %s."), str);
514 return xasprintf (_("Numeric variables are not compatible with "
515 "string format %s."), str);
520 /* Returns FORMAT is appropriate for a variable of the given
521 VAR_TYPE and returns true if so, otherwise false. */
523 fmt_check_type_compat (const struct fmt_spec *format, enum val_type var_type)
525 return error_to_bool (fmt_check_type_compat__ (format, var_type));
528 /* Checks that FORMAT is appropriate for a variable of the given WIDTH and
529 returns NULL if so. Otherwise returns a malloc()'d error message that the
530 caller must eventually free(). VARNAME is optional and only used in the
533 fmt_check_width_compat__ (const struct fmt_spec *format, const char *varname,
536 char *error = fmt_check_type_compat__ (format, val_type_from_width (width));
540 if (fmt_var_width (format) != width)
542 char format_str[FMT_STRING_LEN_MAX + 1];
543 fmt_to_string (format, format_str);
545 char better_str[FMT_STRING_LEN_MAX + 1];
546 if (format->type == FMT_A)
547 snprintf (better_str, sizeof better_str, "A%d", width);
549 snprintf (better_str, sizeof better_str, "AHEX%d", width * 2);
552 return xasprintf (_("String variable %s with width %d is not "
553 "compatible with format %s. "
554 "Use format %s instead."),
555 varname, width, format_str, better_str);
557 return xasprintf (_("String variable with width %d is not compatible "
558 "with format %s. Use format %s instead."),
559 width, format_str, better_str);
565 /* Checks that FORMAT is appropriate for a variable of the given WIDTH and
566 returns true if so, otherwise false. */
568 fmt_check_width_compat (const struct fmt_spec *format, const char *varname,
571 return error_to_bool (fmt_check_width_compat__ (format, varname, width));
574 /* Returns the width corresponding to FORMAT. The return value
575 is the width of the `union value's required by FORMAT. */
577 fmt_var_width (const struct fmt_spec *format)
579 return (format->type == FMT_AHEX ? format->w / 2
580 : format->type == FMT_A ? format->w
584 /* Converts F to its string representation (for instance, "F8.2")
585 in BUFFER. Returns BUFFER.
587 If F has decimals, they are included in the output string,
588 even if F's format type does not allow decimals, to allow
589 accurately presenting incorrect formats to the user. */
591 fmt_to_string (const struct fmt_spec *f, char buffer[FMT_STRING_LEN_MAX + 1])
593 if (fmt_takes_decimals (f->type) || f->d > 0)
594 snprintf (buffer, FMT_STRING_LEN_MAX + 1,
595 "%s%d.%d", fmt_name (f->type), f->w, f->d);
597 snprintf (buffer, FMT_STRING_LEN_MAX + 1,
598 "%s%d", fmt_name (f->type), f->w);
602 /* Returns true if A and B are identical formats,
605 fmt_equal (const struct fmt_spec *a, const struct fmt_spec *b)
607 return a->type == b->type && a->w == b->w && a->d == b->d;
610 /* Adjusts FMT to be valid for a value of the given WIDTH if necessary.
611 If nothing needed to be changed the return value is false
614 fmt_resize (struct fmt_spec *fmt, int width)
616 if ((width > 0) != fmt_is_string (fmt->type))
618 /* Changed from numeric to string or vice versa. Set to
619 default format for new width. */
620 *fmt = fmt_default_for_width (width);
624 /* Changed width of string. Preserve format type, adjust
626 fmt->w = fmt->type == FMT_AHEX ? width * 2 : width;
636 /* Adjusts FMT's width and decimal places to be valid for USE. */
638 fmt_fix (struct fmt_spec *fmt, enum fmt_use use)
640 /* Clamp width to those allowed by format. */
641 fmt_clamp_width (fmt, use);
643 /* If FMT has more decimal places than allowed, attempt to increase FMT's
644 width until that number of decimal places can be achieved. */
645 if (fmt->d > fmt_max_decimals (fmt->type, fmt->w, use)
646 && fmt_takes_decimals (fmt->type))
648 int max_w = fmt_max_width (fmt->type, use);
649 for (; fmt->w < max_w; fmt->w++)
650 if (fmt->d <= fmt_max_decimals (fmt->type, fmt->w, use))
654 /* Clamp decimals to those allowed by format and width. */
655 fmt_clamp_decimals (fmt, use);
658 /* Adjusts FMT's width and decimal places to be valid for an
661 fmt_fix_input (struct fmt_spec *fmt)
663 fmt_fix (fmt, FMT_FOR_INPUT);
666 /* Adjusts FMT's width and decimal places to be valid for an
669 fmt_fix_output (struct fmt_spec *fmt)
671 fmt_fix (fmt, FMT_FOR_OUTPUT);
674 /* Sets FMT's width to WIDTH (or the nearest width allowed by FMT's type) and
675 reduces its decimal places as necessary (if necessary) for that width. */
677 fmt_change_width (struct fmt_spec *fmt, int width, enum fmt_use use)
680 fmt_clamp_width (fmt, use);
681 fmt_clamp_decimals (fmt, use);
684 /* Sets FMT's decimal places to DECIMALS (or the nearest number of decimal
685 places allowed by FMT's type) and increases its width as necessary (if
686 necessary) for that number of decimal places. */
688 fmt_change_decimals (struct fmt_spec *fmt, int decimals, enum fmt_use use)
694 /* Describes a display format. */
698 int min_input_width, min_output_width;
700 enum fmt_category category;
703 static const struct fmt_desc *get_fmt_desc (enum fmt_type type);
705 /* Returns the name of the given format TYPE. */
707 fmt_name (enum fmt_type type)
709 return get_fmt_desc (type)->name;
712 /* Tries to parse NAME as a format type.
713 If successful, stores the type in *TYPE and returns true.
714 On failure, returns false. */
716 fmt_from_name (const char *name, enum fmt_type *type)
720 for (i = 0; i < FMT_NUMBER_OF_FORMATS; i++)
721 if (!c_strcasecmp (name, get_fmt_desc (i)->name))
729 /* Returns true if TYPE accepts decimal places,
732 fmt_takes_decimals (enum fmt_type type)
734 return fmt_max_output_decimals (type, fmt_max_output_width (type)) > 0;
737 /* Returns the minimum width of the given format TYPE for the given USE. */
739 fmt_min_width (enum fmt_type type, enum fmt_use use)
741 return (use == FMT_FOR_INPUT
742 ? fmt_min_input_width (type)
743 : fmt_min_output_width (type));
746 /* Returns the maximum width of the given format TYPE,
747 for input if FOR_INPUT is true,
748 for output otherwise. */
750 fmt_max_width (enum fmt_type type, enum fmt_use use UNUSED)
752 /* Maximum width is actually invariant of whether the format is
753 for input or output, so FOR_INPUT is unused. */
754 assert (is_fmt_type (type));
772 return 2 * MAX_STRING;
779 /* Returns the maximum number of decimal places allowed for the
780 given format TYPE with a width of WIDTH places, for the given USE. */
782 fmt_max_decimals (enum fmt_type type, int width, enum fmt_use use)
791 max_d = use == FMT_FOR_INPUT ? width : width - 1;
796 max_d = use == FMT_FOR_INPUT ? width : width - 2;
800 max_d = use == FMT_FOR_INPUT ? width : width - 7;
808 assert (use == FMT_FOR_OUTPUT);
818 max_d = width * 2 - 1;
827 max_d = max_digits_for_bytes (width);
888 /* Returns the minimum acceptable width for an input field
889 formatted with the given TYPE. */
891 fmt_min_input_width (enum fmt_type type)
893 return get_fmt_desc (type)->min_input_width;
896 /* Returns the maximum acceptable width for an input field
897 formatted with the given TYPE. */
899 fmt_max_input_width (enum fmt_type type)
901 return fmt_max_width (type, FMT_FOR_INPUT);
904 /* Returns the maximum number of decimal places allowed in an
905 input field of the given TYPE and WIDTH. */
907 fmt_max_input_decimals (enum fmt_type type, int width)
909 assert (valid_width (type, width, true));
910 return fmt_max_decimals (type, width, FMT_FOR_INPUT);
913 /* Returns the minimum acceptable width for an output field
914 formatted with the given TYPE. */
916 fmt_min_output_width (enum fmt_type type)
918 return get_fmt_desc (type)->min_output_width;
921 /* Returns the maximum acceptable width for an output field
922 formatted with the given TYPE. */
924 fmt_max_output_width (enum fmt_type type)
926 return fmt_max_width (type, FMT_FOR_OUTPUT);
929 /* Returns the maximum number of decimal places allowed in an
930 output field of the given TYPE and WIDTH. */
932 fmt_max_output_decimals (enum fmt_type type, int width)
934 assert (valid_width (type, width, false));
935 return fmt_max_decimals (type, width, FMT_FOR_OUTPUT);
938 /* Returns the width step for a field formatted with the given
939 TYPE. Field width must be a multiple of the width step. */
941 fmt_step_width (enum fmt_type type)
943 return (fmt_get_category (type) == FMT_CAT_HEXADECIMAL || type == FMT_AHEX
947 /* Returns true if TYPE is used for string fields,
948 false if it is used for numeric fields. */
950 fmt_is_string (enum fmt_type type)
952 return fmt_get_category (type) == FMT_CAT_STRING;
955 /* Returns true if TYPE is used for numeric fields,
956 false if it is used for string fields. */
958 fmt_is_numeric (enum fmt_type type)
960 return !fmt_is_string (type);
963 /* Returns the format TYPE's category.
964 Each format type is in exactly one category,
965 and each category's value is bitwise disjoint from every other
966 category. Thus, the return value may be tested for equality
967 or compared bitwise against a mask of FMT_CAT_* values. */
969 fmt_get_category (enum fmt_type type)
971 return get_fmt_desc (type)->category;
974 /* Returns the output format selected by default when TYPE is
975 used as an input format. */
977 fmt_input_to_output (enum fmt_type type)
979 switch (fmt_get_category (type))
986 case FMT_CAT_HEXADECIMAL:
994 /* Returns the SPSS format type corresponding to the given PSPP
997 fmt_to_io (enum fmt_type type)
999 return get_fmt_desc (type)->io;
1002 /* Determines the PSPP format corresponding to the given SPSS
1003 format type. If successful, sets *FMT_TYPE to the PSPP format
1004 and returns true. On failure, return false. */
1006 fmt_from_io (int io, enum fmt_type *fmt_type)
1010 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) \
1012 *fmt_type = FMT_##NAME; \
1014 #include "format.def"
1020 /* Translate U32, which is in the form found in SAV and SPV files, into a
1021 format specification, and stores the new specification in *F.
1023 If LOOSE is false, checks that the format specification is appropriate as an
1024 output format for a variable with the given WIDTH and reports an error if
1025 not. If LOOSE is true, instead adjusts the format's width and decimals as
1026 necessary to be suitable.
1028 Return true if successful, false if there was an error.. */
1030 fmt_from_u32 (uint32_t u32, int width, bool loose, struct fmt_spec *f)
1032 uint8_t raw_type = u32 >> 16;
1033 uint8_t w = u32 >> 8;
1037 if (!fmt_from_io (raw_type, &type))
1040 *f = (struct fmt_spec) { .type = type, .w = w, .d = d };
1044 else if (!fmt_check_output (f))
1047 return fmt_check_width_compat (f, NULL, width);
1050 /* Returns true if TYPE may be used as an input format,
1053 fmt_usable_for_input (enum fmt_type type)
1055 assert (is_fmt_type (type));
1056 return fmt_get_category (type) != FMT_CAT_CUSTOM;
1059 /* For time and date formats, returns a template used for input and output in a
1060 field of the given WIDTH.
1062 WIDTH only affects whether a 2-digit year or a 4-digit year is used, that
1063 is, whether the returned string contains "yy" or "yyyy", and whether seconds
1064 are include, that is, whether the returned string contains ":SS". A caller
1065 that doesn't care whether the returned string contains "yy" or "yyyy" or
1066 ":SS" can just specify 0 to omit them. */
1068 fmt_date_template (enum fmt_type type, int width)
1070 const char *s1, *s2;
1115 s1 = "dd-mmm-yyyy HH:MM";
1116 s2 = "dd-mmm-yyyy HH:MM:SS";
1120 s1 = "yyyy-mm-dd HH:MM";
1121 s2 = "yyyy-mm-dd HH:MM:SS";
1143 return width >= strlen (s2) ? s2 : s1;
1146 /* Returns a string representing the format TYPE for use in a GUI dialog. */
1148 fmt_gui_name (enum fmt_type type)
1153 return _("Numeric");
1162 return _("Scientific");
1195 return fmt_name (type);
1199 /* Returns true if TYPE is a valid format type,
1202 is_fmt_type (enum fmt_type type)
1204 return type < FMT_NUMBER_OF_FORMATS;
1207 /* Returns true if WIDTH is a valid width for the given format
1208 TYPE, for the given USE. */
1210 valid_width (enum fmt_type type, int width, enum fmt_use use)
1212 return (width >= fmt_min_width (type, use)
1213 && width <= fmt_max_width (type, use));
1216 /* Returns the maximum number of decimal digits in an unsigned
1217 binary number that is BYTES bytes long. */
1219 max_digits_for_bytes (int bytes)
1221 int map[8] = {3, 5, 8, 10, 13, 15, 17, 20};
1222 assert (bytes > 0 && bytes <= sizeof map / sizeof *map);
1223 return map[bytes - 1];
1226 /* Clamp FMT's width to the range and values allowed by FMT's type. */
1228 fmt_clamp_width (struct fmt_spec *fmt, enum fmt_use use)
1233 min_w = fmt_min_width (fmt->type, use);
1234 max_w = fmt_max_width (fmt->type, use);
1237 else if (fmt->w > max_w)
1240 /* Round width to step. */
1241 step = fmt_step_width (fmt->type);
1242 fmt->w = ROUND_DOWN (fmt->w, step);
1245 /* Clamp FMT's decimal places to the range allowed by FMT's type and width. */
1247 fmt_clamp_decimals (struct fmt_spec *fmt, enum fmt_use use)
1249 int max_d = fmt_max_decimals (fmt->type, fmt->w, use);
1254 static struct fmt_affix
1255 fmt_affix_clone (const struct fmt_affix *old)
1257 return (struct fmt_affix) {
1258 .s = xstrdup_if_nonnull (old->s),
1259 .width = old->width,
1263 /* Frees data in AFFIX. */
1265 fmt_affix_free (struct fmt_affix *affix)
1271 /* Find and returns the grouping character in CC_STRING (either '.' or ',') or
1274 find_cc_separators (const char *cc_string)
1276 /* Count commas and periods. There must be exactly three of
1277 one or the other, except that an apostrophe escapes a
1278 following comma or period. */
1281 for (const char *p = cc_string; *p; p++)
1286 else if (*p == '\'' && (p[1] == '.' || p[1] == ',' || p[1] == '\''))
1289 return (n_commas == 3 ? (n_dots != 3 ? ',' : 0)
1294 /* Extracts a token from IN into a newly allocated string AFFIXP. Tokens are
1295 delimited by GROUPING. Returns the first character following the token. */
1296 static struct fmt_affix
1297 extract_cc_token (const char **sp, int grouping, size_t *extra_bytes)
1299 const char *p = *sp;
1300 for (; *p && *p != grouping; p++)
1301 if (*p == '\'' && p[1] == grouping)
1304 size_t length = p - *sp;
1305 char *affix = xmemdup0 (*sp, length);
1306 size_t width = u8_strwidth (CHAR_CAST (const uint8_t *, affix), "UTF-8");
1308 *extra_bytes += length - width;
1310 *sp = p + (*p != 0);
1312 return (struct fmt_affix) { .s = affix, .width = width };
1315 struct fmt_number_style *
1316 fmt_number_style_from_string (const char *s)
1318 char grouping = find_cc_separators (s);
1322 size_t extra_bytes = 0;
1323 struct fmt_affix neg_prefix = extract_cc_token (&s, grouping, &extra_bytes);
1324 struct fmt_affix prefix = extract_cc_token (&s, grouping, &extra_bytes);
1325 struct fmt_affix suffix = extract_cc_token (&s, grouping, &extra_bytes);
1326 struct fmt_affix neg_suffix = extract_cc_token (&s, grouping, &extra_bytes);
1328 struct fmt_number_style *style = xmalloc (sizeof *style);
1329 *style = (struct fmt_number_style) {
1330 .neg_prefix = neg_prefix,
1333 .neg_suffix = neg_suffix,
1334 .decimal = grouping == '.' ? ',' : '.',
1335 .grouping = grouping,
1336 .include_leading_zero = false,
1337 .extra_bytes = extra_bytes,
1343 format_cc (struct string *out, const char *in, char grouping)
1348 if (c == grouping || c == '\'')
1349 ds_put_byte (out, '\'');
1351 ds_put_byte (out, '"');
1352 ds_put_byte (out, c);
1357 fmt_number_style_to_string (const struct fmt_number_style *cc)
1359 struct string out = DS_EMPTY_INITIALIZER;
1360 format_cc (&out, cc->neg_prefix.s, cc->grouping);
1361 ds_put_byte (&out, cc->grouping);
1362 format_cc (&out, cc->prefix.s, cc->grouping);
1363 ds_put_byte (&out, cc->grouping);
1364 format_cc (&out, cc->suffix.s, cc->grouping);
1365 ds_put_byte (&out, cc->grouping);
1366 format_cc (&out, cc->neg_suffix.s, cc->grouping);
1367 return ds_steal_cstr (&out);
1370 struct fmt_number_style *
1371 fmt_number_style_clone (const struct fmt_number_style *old)
1375 struct fmt_number_style *new = xmalloc (sizeof *new);
1376 *new = (struct fmt_number_style) {
1377 .neg_prefix = fmt_affix_clone (&old->neg_prefix),
1378 .prefix = fmt_affix_clone (&old->prefix),
1379 .suffix = fmt_affix_clone (&old->suffix),
1380 .neg_suffix = fmt_affix_clone (&old->neg_suffix),
1381 .decimal = old->decimal,
1382 .grouping = old->grouping,
1383 .extra_bytes = old->extra_bytes,
1391 /* Destroys a struct fmt_number_style. */
1393 fmt_number_style_destroy (struct fmt_number_style *style)
1397 fmt_affix_free (&style->neg_prefix);
1398 fmt_affix_free (&style->prefix);
1399 fmt_affix_free (&style->suffix);
1400 fmt_affix_free (&style->neg_suffix);
1405 /* Returns the total width of the standard prefix and suffix for STYLE, in
1406 display columns (e.g. as returned by u8_strwidth()). */
1408 fmt_affix_width (const struct fmt_number_style *style)
1410 return style->prefix.width + style->suffix.width;
1413 /* Returns the total width of the negative prefix and suffix for STYLE, in
1414 display columns (e.g. as returned by u8_strwidth()). */
1416 fmt_neg_affix_width (const struct fmt_number_style *style)
1418 return style->neg_prefix.width + style->neg_suffix.width;
1421 /* Returns the struct fmt_desc for the given format TYPE. */
1422 static const struct fmt_desc *
1423 get_fmt_desc (enum fmt_type type)
1425 static const struct fmt_desc formats[FMT_NUMBER_OF_FORMATS] =
1427 #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) \
1428 {#NAME, IMIN, OMIN, IO, CATEGORY},
1429 #include "format.def"
1432 assert (is_fmt_type (type));
1433 return &formats[type];
1436 const struct fmt_spec F_8_0 = { .type = FMT_F, .w = 8, .d = 0 };
1437 const struct fmt_spec F_8_2 = { .type = FMT_F, .w = 8, .d = 2 };
1438 const struct fmt_spec F_4_3 = { .type = FMT_F, .w = 4, .d = 3 };
1439 const struct fmt_spec F_5_1 = { .type = FMT_F, .w = 5, .d = 1 };