#include "format.h"
#include "missing-values.h"
-/* Script variables. */
-
/* Variable type. */
enum var_type
{
ALPHA /* A string variable. */
};
+bool var_type_is_valid (enum var_type);
const char *var_type_adj (enum var_type);
const char *var_type_noun (enum var_type);
+/* Alignment of data for display. */
+enum alignment
+ {
+ ALIGN_LEFT = 0,
+ ALIGN_RIGHT = 1,
+ ALIGN_CENTRE = 2,
+ n_ALIGN
+ };
+
+bool alignment_is_valid (enum alignment);
+
+/* How data is measured. */
+enum measure
+ {
+ MEASURE_NOMINAL = 1,
+ MEASURE_ORDINAL = 2,
+ MEASURE_SCALE = 3,
+ n_MEASURES
+ };
+
+bool measure_is_valid (enum measure);
+
/* Maximum lengths of short and long variable names.
Most operations support long variable names,
but some file formats are limited to short names. */
{
/* Dictionary information. */
char name[LONG_NAME_LEN + 1]; /* Variable name. Mixed case. */
- enum var_type type; /* NUMERIC or ALPHA. */
- int width; /* Size of string variables in chars. */
+ int width; /* 0 for numeric, otherwise string width. */
struct missing_values miss; /* Missing values. */
struct fmt_spec print; /* Default format for PRINT. */
struct fmt_spec write; /* Default format for WRITE. */
struct val_labs *val_labs; /* Value labels. */
char *label; /* Variable label. */
+
+ /* GUI information. */
enum measure measure; /* Nominal, ordinal, or continuous. */
int display_width; /* Width of data editor column. */
enum alignment alignment; /* Alignment of data in GUI. */
/* Case information. */
- int fv, nv; /* Index into `value's, number of values. */
- bool init; /* True if needs init and possibly reinit. */
- bool reinit; /* True: reinitialize; false: leave. */
+ int fv; /* Index into `value's. */
+ bool leave; /* Leave value from case to case? */
/* Data for use by containing dictionary. */
int index; /* Dictionary index. */
};
/* Variable names. */
+const char *var_get_name (const struct variable *);
+void var_set_name (struct variable *, const char *);
bool var_is_valid_name (const char *, bool issue_error);
bool var_is_plausible_name (const char *name, bool issue_error);
-int compare_var_names (const void *, const void *, void *);
-unsigned hash_var_name (const void *, void *);
+int compare_var_names (const void *, const void *, const void *);
+unsigned hash_var_name (const void *, const void *);
+
+/* Variable types and widths. */
+enum var_type var_get_type (const struct variable *);
+int var_get_width (const struct variable *);
+void var_set_width (struct variable *, int width);
+bool var_is_numeric (const struct variable *);
+bool var_is_alpha (const struct variable *);
+bool var_is_short_string (const struct variable *);
+bool var_is_long_string (const struct variable *);
+bool var_is_very_long_string (const struct variable *);
+
+/* Variables' missing values. */
+const struct missing_values *var_get_missing_values (const struct variable *);
+void var_set_missing_values (struct variable *, const struct missing_values *);
+void var_clear_missing_values (struct variable *);
+bool var_has_missing_values (const struct variable *);
+
+typedef bool var_is_missing_func (const struct variable *,
+ const union value *);
+bool var_is_value_missing (const struct variable *, const union value *);
+bool var_is_num_missing (const struct variable *, double);
+bool var_is_str_missing (const struct variable *, const char[]);
+bool var_is_value_user_missing (const struct variable *,
+ const union value *);
+bool var_is_num_user_missing (const struct variable *, double);
+bool var_is_str_user_missing (const struct variable *, const char[]);
+bool var_is_value_system_missing (const struct variable *,
+ const union value *);
+
+/* Print and write formats. */
+const struct fmt_spec *var_get_print_format (const struct variable *);
+void var_set_print_format (struct variable *, const struct fmt_spec *);
+const struct fmt_spec *var_get_write_format (const struct variable *);
+void var_set_write_format (struct variable *, const struct fmt_spec *);
+void var_set_both_formats (struct variable *, const struct fmt_spec *);
+
+/* Variable labels. */
+const char *var_get_label (const struct variable *);
+void var_set_label (struct variable *, const char *);
+void var_clear_label (struct variable *);
+bool var_has_label (const struct variable *);
+
+/* GUI information. */
+enum measure var_get_measure (const struct variable *);
+void var_set_measure (struct variable *, enum measure);
+
+int var_get_display_width (const struct variable *);
+void var_set_display_width (struct variable *, int display_width);
+
+enum alignment var_get_alignment (const struct variable *);
+void var_set_alignment (struct variable *, enum alignment);
+
+/* Variable location in cases. */
+size_t var_get_value_cnt (const struct variable *);
+
+/* Whether variables' values should be preserved from case to
+ case. */
+bool var_get_leave (const struct variable *);
/* Short names. */
+const char *var_get_short_name (const struct variable *);
void var_set_short_name (struct variable *, const char *);
void var_set_short_name_suffix (struct variable *, const char *, int suffix);
void var_clear_short_name (struct variable *);
/* Pointers to `struct variable', by name. */
-int compare_var_ptr_names (const void *, const void *, void *);
-unsigned hash_var_ptr_name (const void *, void *);
+int compare_var_ptr_names (const void *, const void *, const void *);
+unsigned hash_var_ptr_name (const void *, const void *);
/* Variable auxiliary data. */
void *var_attach_aux (struct variable *,
struct variable **var; /* Vector of variables. */
int cnt; /* Number of variables. */
};
-\f
-void discard_variables (void);
-
-/* This is the active file dictionary. */
-extern struct dictionary *default_dict;
-\f
-/* Transformation state. */
-
-/* PROCESS IF expression. */
-extern struct expression *process_if_expr;
-\f
-/* TEMPORARY support. */
-
-/* 1=TEMPORARY has been executed at some point. */
-extern int temporary;
-
-/* If temporary!=0, the saved dictionary. */
-extern struct dictionary *temp_dict;
-
-/* If temporary!=0, index into t_trns[] (declared far below) that
- gives the point at which data should be written out. -1 means that
- the data shouldn't be changed since all transformations are
- temporary. */
-extern size_t temp_trns;
-
-void cancel_temporary (void);
-\f
-struct ccase;
-void dump_split_vars (const struct ccase *);
-\f
-/* Transformations. */
-
-/* trns_proc_func return values. */
-#define TRNS_CONTINUE -1 /* Continue to next transformation. */
-#define TRNS_DROP_CASE -2 /* Drop this case. */
-#define TRNS_ERROR -3 /* A serious error, so stop the procedure. */
-#define TRNS_NEXT_CASE -4 /* Skip to next case. INPUT PROGRAM only. */
-#define TRNS_END_FILE -5 /* End of input. INPUT PROGRAM only. */
-
-typedef int trns_proc_func (void *, struct ccase *, int);
-typedef bool trns_free_func (void *);
-
-/* A transformation. */
-struct transformation
- {
- trns_proc_func *proc; /* Transformation proc. */
- trns_free_func *free; /* Garbage collector proc. */
- void *private; /* Private data. */
- };
-
-/* Array of transformations */
-extern struct transformation *t_trns;
-
-/* Number of transformations, maximum number in array currently. */
-extern size_t n_trns, m_trns;
-
-/* Index of first transformation that is really a transformation. Any
- transformations before this belong to INPUT PROGRAM. */
-extern size_t f_trns;
-
-void add_transformation (trns_proc_func *, trns_free_func *, void *);
-size_t next_transformation (void);
-bool cancel_transformations (void);
-\f
-struct var_set;
-
-struct var_set *var_set_create_from_dict (const struct dictionary *d);
-struct var_set *var_set_create_from_array (struct variable *const *var,
- size_t);
-
-size_t var_set_get_cnt (const struct var_set *vs);
-struct variable *var_set_get_var (const struct var_set *vs, size_t idx);
-struct variable *var_set_lookup_var (const struct var_set *vs,
- const char *name);
-bool var_set_lookup_var_idx (const struct var_set *vs, const char *name,
- size_t *idx);
-void var_set_destroy (struct var_set *vs);
-\f
-/* Variable parsers. */
-
-enum
- {
- PV_NONE = 0, /* No options. */
- PV_SINGLE = 0001, /* Restrict to a single name or TO use. */
- PV_DUPLICATE = 0002, /* Don't merge duplicates. */
- PV_APPEND = 0004, /* Append to existing list. */
- PV_NO_DUPLICATE = 0010, /* Error on duplicates. */
- PV_NUMERIC = 0020, /* Vars must be numeric. */
- PV_STRING = 0040, /* Vars must be string. */
- PV_SAME_TYPE = 00100, /* All vars must be the same type. */
- PV_NO_SCRATCH = 00200 /* Disallow scratch variables. */
- };
-
-struct pool;
-struct variable *parse_variable (void);
-struct variable *parse_dict_variable (const struct dictionary *);
-int parse_variables (const struct dictionary *, struct variable ***, size_t *,
- int opts);
-int parse_var_set_vars (const struct var_set *, struct variable ***, size_t *,
- int opts);
-int parse_DATA_LIST_vars (char ***names, size_t *cnt, int opts);
-int parse_mixed_vars (char ***names, size_t *cnt, int opts);
-int parse_mixed_vars_pool (struct pool *,
- char ***names, size_t *cnt, int opts);
/* Return a string representing this variable, in the form most
const char * var_to_string(const struct variable *var);
+int width_to_bytes(int width);
+
+
#endif /* !variable.h */
projects / pspp-builds.git / blobdiff