/* PSPP - computes sample statistics.
- Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
+ Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
Written by Ben Pfaff <blp@gnu.org>.
This program is free software; you can redistribute it and/or
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA. */
-#if !format_h
-#define format_h 1
+#ifndef FORMAT_H
+#define FORMAT_H 1
/* Display format types. */
#include <stdbool.h>
+#include <stddef.h>
+#include <libpspp/str.h>
-/* See the definitions of these functions and variables when modifying
- this list:
- misc.c:convert_fmt_ItoO()
- sys-file-reader.c:parse_format_spec()
- data-in.c:parse_string_as_format() */
-#define DEFFMT(LABEL, NAME, N_ARGS, IMIN_W, IMAX_W, OMIN_W, OMAX_W, \
- CAT, OUTPUT, SPSS_FMT) \
- LABEL,
-enum
+/* Format type categories. */
+enum fmt_category
{
+ /* Numeric formats. */
+ FMT_CAT_BASIC = 0x001, /* Basic numeric formats. */
+ FMT_CAT_CUSTOM = 0x002, /* Custom currency formats. */
+ FMT_CAT_LEGACY = 0x004, /* Legacy numeric formats. */
+ FMT_CAT_BINARY = 0x008, /* Binary formats. */
+ FMT_CAT_HEXADECIMAL = 0x010, /* Hexadecimal formats. */
+ FMT_CAT_DATE = 0x020, /* Date formats. */
+ FMT_CAT_TIME = 0x040, /* Time formats. */
+ FMT_CAT_DATE_COMPONENT = 0x080, /* Date component formats. */
+
+ /* String formats. */
+ FMT_CAT_STRING = 0x100 /* String formats. */
+ };
+
+enum fmt_type
+ {
+#define FMT(NAME, METHOD, IMIN, OMIN, IO, CATEGORY) FMT_##NAME,
#include "format.def"
- FMT_NUMBER_OF_FORMATS
+ FMT_NUMBER_OF_FORMATS,
};
-#undef DEFFMT
/* Length of longest format specifier name,
not including terminating null. */
#define FMT_TYPE_LEN_MAX 8
-/* Describes one of the display formats above. */
-struct fmt_desc
- {
- char name[FMT_TYPE_LEN_MAX + 1]; /* Name, in all caps. */
- int n_args; /* 1=width; 2=width.decimals. */
- int Imin_w, Imax_w; /* Bounds on input width. */
- int Omin_w, Omax_w; /* Bounds on output width. */
- int cat; /* Categories. */
- int output; /* Output format. */
- int spss; /* Equivalent SPSS output format. */
- };
-
-/* Display format categories. */
-enum
- {
- FCAT_BLANKS_SYSMIS = 001, /* 1=All-whitespace means SYSMIS. */
- FCAT_EVEN_WIDTH = 002, /* 1=Width must be even. */
- FCAT_STRING = 004, /* 1=String input/output format. */
- FCAT_SHIFT_DECIMAL = 010, /* 1=Automatically shift decimal point
- on output--used for fixed-point
- formats. */
- FCAT_OUTPUT_ONLY = 020 /* 1=This is not an input format. */
- };
+/* Length of longest string representation of fmt_spec,
+ not including terminating null. */
+#define FMT_STRING_LEN_MAX 32
/* Display format. */
struct fmt_spec
{
- int type; /* One of the above constants. */
+ enum fmt_type type; /* One of FMT_*. */
int w; /* Width. */
int d; /* Number of implied decimal places. */
};
+union value;
+
+/* Initialization. */
+void fmt_init (void);
+void fmt_done (void);
+
+/* 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 *);
+
+/* Verifying formats. */
+bool fmt_check (const struct fmt_spec *, bool for_input);
+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);
+
+/* 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]);
+
+/* Format types. */
+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_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;
+int fmt_min_output_width (enum fmt_type) PURE_FUNCTION;
+int fmt_max_output_width (enum fmt_type) PURE_FUNCTION;
+int fmt_max_output_decimals (enum fmt_type, int width) PURE_FUNCTION;
+int fmt_step_width (enum fmt_type) PURE_FUNCTION;
+
+bool fmt_is_string (enum fmt_type) PURE_FUNCTION;
+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;
+
+int fmt_to_io (enum fmt_type) PURE_FUNCTION;
+bool fmt_from_io (int io, enum fmt_type *);
+
+bool fmt_usable_for_input (enum fmt_type) PURE_FUNCTION;
+const char *fmt_date_template (enum fmt_type) PURE_FUNCTION;
+\f
+/* Maximum length of prefix or suffix string in
+ struct fmt_number_style. */
+#define FMT_STYLE_AFFIX_MAX 16
+
+/* 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_number_style *fmt_number_style_create (void);
+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 *);
+
+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);
+\f
+/* Alignment of data for display. */
enum alignment
{
ALIGN_LEFT = 0,
n_ALIGN
};
-
+/* How data is measured. */
enum measure
{
MEASURE_NOMINAL=1,
bool measure_is_valid(enum measure m);
bool alignment_is_valid(enum alignment a);
+\f
+#include <libpspp/legacy-encoding.h>
-
-/* Descriptions of all the display formats above. */
-extern const struct fmt_desc formats[];
-
-union value;
-
-/* Maximum length of formatted value, in characters. */
-#define MAX_FORMATTED_LEN 256
-
-/* Common formats. */
-extern const struct fmt_spec f8_2; /* F8.2. */
-
-int check_input_specifier (const struct fmt_spec *spec, int emit_error);
-int check_output_specifier (const struct fmt_spec *spec, int emit_error);
-bool check_specifier_type (const struct fmt_spec *, int type, bool emit_error);
-bool check_specifier_width (const struct fmt_spec *,
- int width, bool emit_error);
-void convert_fmt_ItoO (const struct fmt_spec *input, struct fmt_spec *output);
-int get_format_var_width (const struct fmt_spec *);
-int parse_string_as_format (const char *s, int len, const struct fmt_spec *fp,
- int fc, union value *v);
-int translate_fmt (int spss);
bool data_out (char *s, const struct fmt_spec *fp, const union value *v);
-bool fmt_type_from_string (const char *name, int *type);
-char *fmt_to_string (const struct fmt_spec *);
-struct fmt_spec make_input_format (int type, int w, int d);
-struct fmt_spec make_output_format (int type, int w, int d);
-bool fmt_is_binary (int type);
-#endif /* !format_h */
+#endif /* format.h */
projects / pspp-builds.git / blobdiff