1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
29 #include "missing-values.h"
31 /* Script variables. */
36 NUMERIC, /* A numeric variable. */
37 ALPHA /* A string variable. */
40 const char *var_type_adj (enum var_type);
41 const char *var_type_noun (enum var_type);
43 /* A variable's dictionary entry. */
46 /* Dictionary information. */
47 char name[LONG_NAME_LEN + 1]; /* Variable name. Mixed case. */
48 enum var_type type; /* NUMERIC or ALPHA. */
49 int width; /* Size of string variables in chars. */
50 struct missing_values miss; /* Missing values. */
51 struct fmt_spec print; /* Default format for PRINT. */
52 struct fmt_spec write; /* Default format for WRITE. */
53 struct val_labs *val_labs; /* Value labels. */
54 char *label; /* Variable label. */
55 enum measure measure; /* Nominal, ordinal, or continuous. */
56 int display_width; /* Width of data editor column. */
57 enum alignment alignment; /* Alignment of data in GUI. */
59 /* Case information. */
60 int fv, nv; /* Index into `value's, number of values. */
61 bool init; /* True if needs init and possibly reinit. */
62 bool reinit; /* True: reinitialize; false: leave. */
64 /* Data for use by containing dictionary. */
65 int index; /* Dictionary index. */
67 /* Short name, used only for system and portable file input
68 and output. Upper case only. There is no index for short
69 names. Short names are not necessarily unique. Any
70 variable may have no short name, indicated by an empty
72 char short_name[SHORT_NAME_LEN + 1];
74 /* Each command may use these fields as needed. */
76 void (*aux_dtor) (struct variable *);
80 bool var_is_valid_name (const char *, bool issue_error);
81 int compare_var_names (const void *, const void *, void *);
82 unsigned hash_var_name (const void *, void *);
85 void var_set_short_name (struct variable *, const char *);
86 void var_set_short_name_suffix (struct variable *, const char *, int suffix);
87 void var_clear_short_name (struct variable *);
89 /* Pointers to `struct variable', by name. */
90 int compare_var_ptr_names (const void *, const void *, void *);
91 unsigned hash_var_ptr_name (const void *, void *);
93 /* Variable auxiliary data. */
94 void *var_attach_aux (struct variable *,
95 void *aux, void (*aux_dtor) (struct variable *));
96 void var_clear_aux (struct variable *);
97 void *var_detach_aux (struct variable *);
98 void var_dtor_free (struct variable *);
100 /* Classes of variables. */
103 DC_ORDINARY, /* Ordinary identifier. */
104 DC_SYSTEM, /* System variable. */
105 DC_SCRATCH /* Scratch variable. */
108 enum dict_class dict_class_from_id (const char *name);
109 const char *dict_class_to_name (enum dict_class dict_class);
111 /* Vector of variables. */
114 int idx; /* Index for dict_get_vector(). */
115 char name[LONG_NAME_LEN + 1]; /* Name. */
116 struct variable **var; /* Vector of variables. */
117 int cnt; /* Number of variables. */
120 void discard_variables (void);
122 /* This is the active file dictionary. */
123 extern struct dictionary *default_dict;
125 /* Transformation state. */
127 /* Default file handle for DATA LIST, REREAD, REPEATING DATA
129 extern struct file_handle *default_handle;
131 /* PROCESS IF expression. */
132 extern struct expression *process_if_expr;
134 /* TEMPORARY support. */
136 /* 1=TEMPORARY has been executed at some point. */
137 extern int temporary;
139 /* If temporary!=0, the saved dictionary. */
140 extern struct dictionary *temp_dict;
142 /* If temporary!=0, index into t_trns[] (declared far below) that
143 gives the point at which data should be written out. -1 means that
144 the data shouldn't be changed since all transformations are
146 extern size_t temp_trns;
148 /* If FILTER is active, whether it was executed before or after
150 extern int FILTER_before_TEMPORARY;
152 void cancel_temporary (void);
155 void dump_split_vars (const struct ccase *);
157 /* Transformations. */
159 struct transformation;
160 typedef int trns_proc_func (void *, struct ccase *, int);
161 typedef void trns_free_func (void *);
163 /* A transformation. */
164 struct transformation
166 trns_proc_func *proc; /* Transformation proc. */
167 trns_free_func *free; /* Garbage collector proc. */
168 void *private; /* Private data. */
171 /* Array of transformations */
172 extern struct transformation *t_trns;
174 /* Number of transformations, maximum number in array currently. */
175 extern size_t n_trns, m_trns;
177 /* Index of first transformation that is really a transformation. Any
178 transformations before this belong to INPUT PROGRAM. */
179 extern size_t f_trns;
181 void add_transformation (trns_proc_func *, trns_free_func *, void *);
182 size_t next_transformation (void);
183 void cancel_transformations (void);
187 struct var_set *var_set_create_from_dict (const struct dictionary *d);
188 struct var_set *var_set_create_from_array (struct variable *const *var,
191 size_t var_set_get_cnt (const struct var_set *vs);
192 struct variable *var_set_get_var (const struct var_set *vs, size_t idx);
193 struct variable *var_set_lookup_var (const struct var_set *vs,
195 bool var_set_lookup_var_idx (const struct var_set *vs, const char *name,
197 void var_set_destroy (struct var_set *vs);
199 /* Variable parsers. */
203 PV_NONE = 0, /* No options. */
204 PV_SINGLE = 0001, /* Restrict to a single name or TO use. */
205 PV_DUPLICATE = 0002, /* Don't merge duplicates. */
206 PV_APPEND = 0004, /* Append to existing list. */
207 PV_NO_DUPLICATE = 0010, /* Error on duplicates. */
208 PV_NUMERIC = 0020, /* Vars must be numeric. */
209 PV_STRING = 0040, /* Vars must be string. */
210 PV_SAME_TYPE = 00100, /* All vars must be the same type. */
211 PV_NO_SCRATCH = 00200 /* Disallow scratch variables. */
215 struct variable *parse_variable (void);
216 struct variable *parse_dict_variable (const struct dictionary *);
217 int parse_variables (const struct dictionary *, struct variable ***, size_t *,
219 int parse_var_set_vars (const struct var_set *, struct variable ***, size_t *,
221 int parse_DATA_LIST_vars (char ***names, size_t *cnt, int opts);
222 int parse_mixed_vars (char ***names, size_t *cnt, int opts);
223 int parse_mixed_vars_pool (struct pool *,
224 char ***names, size_t *cnt, int opts);
227 /* Return a string representing this variable, in the form most
228 appropriate from a human factors perspective.
229 (IE: the label if it has one, otherwise the name )
231 const char * var_to_string(const struct variable *var);