X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fdata%2Fformat.h;h=4cde16b17a0b1352356f6b522c602bc18150b70e;hb=d26105c398be227dc38668ce3e742c31adef15f7;hp=3678632ea8029b7a5a7022670a8445746186633a;hpb=3a61659a8fc11c51ad5af02b20f5613dcde50382;p=pspp diff --git a/src/data/format.h b/src/data/format.h index 3678632ea8..4cde16b17a 100644 --- a/src/data/format.h +++ b/src/data/format.h @@ -1,33 +1,45 @@ -/* PSPP - computes sample statistics. - Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc. - Written by Ben Pfaff . +/* PSPP - a program for statistical analysis. + Copyright (C) 1997-9, 2000, 2006, 2010, 2011, 2012 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 the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. + 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 + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - 02110-1301, USA. */ + along with this program. If not, see . */ -#ifndef FORMAT_H -#define FORMAT_H 1 +#ifndef DATA_FORMAT_H +#define DATA_FORMAT_H 1 /* Display format types. */ #include -#include -#include +#include +#include "data/val-type.h" +#include "libpspp/str.h" -/* Format type categories. */ -enum fmt_category +struct fmt_settings; + +/* How a format is going to be used. */ +enum fmt_use + { + FMT_FOR_INPUT, /* For parsing data input, e.g. data_in(). */ + FMT_FOR_OUTPUT /* For formatting data output, e.g. data_out(). */ + }; + +/* Format type categories. + + Each format is in exactly one category. We give categories + bitwise disjoint values only to enable bitwise comparisons + against a mask of FMT_CAT_* values, not to allow multiple + categories per format. */ +enum fmt_category { /* Numeric formats. */ FMT_CAT_BASIC = 0x001, /* Basic numeric formats. */ @@ -43,7 +55,8 @@ enum fmt_category FMT_CAT_STRING = 0x100 /* String formats. */ }; -enum fmt_type +/* Format type. */ +enum ATTRIBUTE ((packed)) fmt_type { #define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) FMT_##NAME, #include "format.def" @@ -62,38 +75,51 @@ enum fmt_type struct fmt_spec { enum fmt_type type; /* One of FMT_*. */ - int w; /* Width. */ - int d; /* Number of implied decimal places. */ + uint8_t d; /* Number of decimal places. */ + uint16_t w; /* Width. */ }; -union value; - -/* Initialization. */ -void fmt_init (void); -void fmt_done (void); +/* Maximum width of any numeric format. */ +#define FMT_MAX_NUMERIC_WIDTH 40 /* Constructing formats. */ struct fmt_spec fmt_for_input (enum fmt_type, int w, int d) PURE_FUNCTION; struct fmt_spec fmt_for_output (enum fmt_type, int w, int d) PURE_FUNCTION; -struct fmt_spec fmt_for_output_from_input (const struct fmt_spec *); +struct fmt_spec fmt_for_output_from_input (const struct fmt_spec *, + const struct fmt_settings *); +struct fmt_spec fmt_default_for_width (int width); /* Verifying formats. */ -bool fmt_check (const struct fmt_spec *, bool for_input); +bool fmt_check (const struct fmt_spec *, enum fmt_use); bool fmt_check_input (const struct fmt_spec *); bool fmt_check_output (const struct fmt_spec *); -bool fmt_check_type_compat (const struct fmt_spec *, int var_type); -bool fmt_check_width_compat (const struct fmt_spec *, int width); +bool fmt_check_type_compat (const struct fmt_spec *, enum val_type); +bool fmt_check_width_compat (const struct fmt_spec *, int var_width); /* Working with formats. */ int fmt_var_width (const struct fmt_spec *); char *fmt_to_string (const struct fmt_spec *, char s[FMT_STRING_LEN_MAX + 1]); +bool fmt_equal (const struct fmt_spec *, const struct fmt_spec *); +bool fmt_resize (struct fmt_spec *, int new_width); + +void fmt_fix (struct fmt_spec *, enum fmt_use); +void fmt_fix_input (struct fmt_spec *); +void fmt_fix_output (struct fmt_spec *); + +void fmt_change_width (struct fmt_spec *, int width, enum fmt_use); +void fmt_change_decimals (struct fmt_spec *, int decimals, enum fmt_use); /* Format types. */ +bool is_fmt_type (enum fmt_type); + const char *fmt_name (enum fmt_type) PURE_FUNCTION; bool fmt_from_name (const char *name, enum fmt_type *); bool fmt_takes_decimals (enum fmt_type) PURE_FUNCTION; +int fmt_min_width (enum fmt_type, enum fmt_use) PURE_FUNCTION; +int fmt_max_width (enum fmt_type, enum fmt_use) PURE_FUNCTION; +int fmt_max_decimals (enum fmt_type, int width, enum fmt_use) PURE_FUNCTION; int fmt_min_input_width (enum fmt_type) PURE_FUNCTION; int fmt_max_input_width (enum fmt_type) PURE_FUNCTION; int fmt_max_input_decimals (enum fmt_type, int width) PURE_FUNCTION; @@ -107,65 +133,78 @@ bool fmt_is_numeric (enum fmt_type) PURE_FUNCTION; enum fmt_category fmt_get_category (enum fmt_type) PURE_FUNCTION; enum fmt_type fmt_input_to_output (enum fmt_type) PURE_FUNCTION; +bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION; int fmt_to_io (enum fmt_type) PURE_FUNCTION; bool fmt_from_io (int io, enum fmt_type *); +bool fmt_from_u32 (uint32_t, int var_width, bool loose, struct fmt_spec *); -bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION; -const char *fmt_date_template (enum fmt_type) PURE_FUNCTION; +const char *fmt_date_template (enum fmt_type, int width) PURE_FUNCTION; +const char *fmt_gui_name (enum fmt_type); -/* Maximum length of prefix or suffix string in - struct fmt_number_style. */ -#define FMT_STYLE_AFFIX_MAX 16 +/* 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. */ +/* A numeric output style. This can express the basic numeric formats (in the + FMT_CAT_BASIC category) and custom currency formats (FMT_CCx). */ 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 2 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; }; -struct fmt_number_style *fmt_number_style_create (void); +struct fmt_number_style *fmt_number_style_from_string (const char *); +struct fmt_number_style *fmt_number_style_clone ( + const struct fmt_number_style *); void fmt_number_style_destroy (struct fmt_number_style *); -const struct fmt_number_style *fmt_get_style (enum fmt_type); -void fmt_set_style (enum fmt_type, struct fmt_number_style *); +char *fmt_number_style_to_string (const struct fmt_number_style *); int fmt_affix_width (const struct fmt_number_style *); int fmt_neg_affix_width (const struct fmt_number_style *); - -int fmt_decimal_char (enum fmt_type); -int fmt_grouping_char (enum fmt_type); - -void fmt_set_decimal (char); -/* Alignment of data for display. */ -enum alignment - { - ALIGN_LEFT = 0, - ALIGN_RIGHT = 1, - ALIGN_CENTRE = 2, - n_ALIGN - }; +/* Number of custom currency styles. */ +#define FMT_N_CCS 5 /* FMT_CCA through FMT_CCE. */ -/* How data is measured. */ -enum measure +struct fmt_settings { - MEASURE_NOMINAL=1, - MEASURE_ORDINAL=2, - MEASURE_SCALE=3, - n_MEASURES + int epoch; /* 0 for default epoch. */ + char decimal; /* '.' or ','. */ + struct fmt_number_style *ccs[FMT_N_CCS]; /* CCA through CCE. */ }; +#define FMT_SETTINGS_INIT { .decimal = '.' } -bool measure_is_valid(enum measure m); -bool alignment_is_valid(enum alignment a); - -#include +void fmt_settings_init (struct fmt_settings *); +void fmt_settings_uninit (struct fmt_settings *); +struct fmt_settings fmt_settings_copy (const struct fmt_settings *); -bool data_out (char *s, const struct fmt_spec *fp, const union value *v); +const struct fmt_number_style *fmt_settings_get_style ( + const struct fmt_settings *, enum fmt_type); +int fmt_settings_get_epoch (const struct fmt_settings *); + +void fmt_settings_set_cc (struct fmt_settings *, enum fmt_type, + struct fmt_number_style *); + +extern const struct fmt_spec F_8_0 ; +extern const struct fmt_spec F_8_2 ; +extern const struct fmt_spec F_4_3 ; +extern const struct fmt_spec F_5_1 ; -#endif /* format.h */ +#endif /* data/format.h */