format: Count prefix and suffix width in terms of display columns.
[pspp-builds.git] / src / data / format.h
index 568dd3d38537fe76e3e58d226e1d5e13f39c16a2..7df374453def01b5392c2149c57bb203f2723d0e 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2006, 2010 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2006, 2010, 2011 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -143,15 +143,31 @@ void fmt_settings_set_style (struct fmt_settings *, enum fmt_type,
                              const char *neg_prefix, const char *prefix,
                              const char *suffix, const char *neg_suffix);
 \f
+/* A prefix or suffix for a numeric output format. */
+struct fmt_affix
+  {
+    char *s;                    /* String contents of affix, in UTF-8. */
+    int width;                  /* Display width in columns (see wcwidth()). */
+  };
+
 /* A numeric output style. */
 struct fmt_number_style
   {
-    struct substring neg_prefix;      /* Negative prefix. */
-    struct substring prefix;          /* Prefix. */
-    struct substring suffix;          /* Suffix. */
-    struct substring neg_suffix;      /* Negative suffix. */
-    char decimal;                     /* Decimal point: '.' or ','. */
-    char grouping;                    /* Grouping character: ',', '.', or 0. */
+    struct fmt_affix neg_prefix; /* Negative prefix. */
+    struct fmt_affix prefix;     /* Prefix. */
+    struct fmt_affix suffix;     /* Suffix. */
+    struct fmt_affix neg_suffix; /* Negative suffix. */
+    char decimal;                /* Decimal point: '.' or ','. */
+    char grouping;               /* Grouping character: ',', '.', or 0. */
+
+    /* A fmt_affix may require more bytes than its display width; for example,
+       U+00A5 (¥) is 3 bytes in UTF-8 but occupies only one display column.
+       This member is the sum of the number of bytes required by all of the
+       fmt_affix members in this struct, minus their display widths.  Thus, it
+       can be used to size memory allocations: for example, the formatted
+       result of CCA20.5 requires no more than (20 + extra_bytes) bytes in
+       UTF-8. */
+    int extra_bytes;
   };
 
 int fmt_affix_width (const struct fmt_number_style *);