Fix assertion for proper Huffman merge pattern: 0 == 1 modulo 1.
[pspp] / src / var.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
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.
9
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.
14
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., 59 Temple Place - Suite 330, Boston, MA
18    02111-1307, USA. */
19
20 #if !var_h
21 #define var_h 1
22
23 #include <stddef.h>
24 #include "format.h"
25 #include "val.h"
26
27 /* Script variables. */
28
29 /* Variable type. */
30 enum
31   {
32     NUMERIC,                    /* A numeric variable. */
33     ALPHA                       /* A string variable.  (STRING is pre-empted by lexer.h) */
34   };
35
36 /* Types of missing values.  Order is significant, see
37    mis-val.c:parse_numeric(), sfm-read.c, sfm-write.c,
38    sysfile-info.c:cmd_sysfile_info(), mis-val.c:copy_missing_values(),
39    pfm-read.c:read_variables(), pfm-write.c:write_variables(),
40    apply-dict.c:cmd_apply_dictionary(), and more (?). */
41 enum
42   {
43     MISSING_NONE,               /* No user-missing values. */
44     MISSING_1,                  /* One user-missing value. */
45     MISSING_2,                  /* Two user-missing values. */
46     MISSING_3,                  /* Three user-missing values. */
47     MISSING_RANGE,              /* [a,b]. */
48     MISSING_LOW,                /* (-inf,a]. */
49     MISSING_HIGH,               /* (a,+inf]. */
50     MISSING_RANGE_1,            /* [a,b], c. */
51     MISSING_LOW_1,              /* (-inf,a], b. */
52     MISSING_HIGH_1,             /* (a,+inf), b. */
53     MISSING_COUNT
54   };
55
56 /* A variable's dictionary entry.  */
57 struct variable
58   {
59     char name[9];               /* As a string. */
60     int index;                  /* Index into its dictionary's var[]. */
61     int type;                   /* NUMERIC or ALPHA. */
62
63     int width;                  /* Size of string variables in chars. */
64     int fv, nv;                 /* Index into `value's, number of values. */
65     unsigned init : 1;          /* 1=VFM must init and possibly reinit. */
66     unsigned reinit : 1;        /* Cases are: 1=reinitialized; 0=left. */
67
68     /* Missing values. */
69     int miss_type;              /* One of the MISSING_* constants. */
70     union value missing[3];     /* User-missing value. */
71
72     /* Display formats. */
73     struct fmt_spec print;      /* Default format for PRINT. */
74     struct fmt_spec write;      /* Default format for WRITE. */
75
76     /* Labels. */
77     struct val_labs *val_labs;  /* Value labels. */
78     char *label;                /* Variable label. */
79
80     /* Per-command info. */
81     void *aux;
82     void (*aux_dtor) (struct variable *);
83   };
84
85 int compare_variables (const void *, const void *, void *);
86 unsigned hash_variable (const void *, void *);
87
88 void *var_attach_aux (struct variable *,
89                       void *aux, void (*aux_dtor) (struct variable *));
90 void var_clear_aux (struct variable *);
91 void *var_detach_aux (struct variable *);
92 void var_dtor_free (struct variable *);
93
94 /* Classes of variables. */
95 enum dict_class 
96   {
97     DC_ORDINARY,                /* Ordinary identifier. */
98     DC_SYSTEM,                  /* System variable. */
99     DC_SCRATCH                  /* Scratch variable. */
100   };
101
102 enum dict_class dict_class_from_id (const char *name);
103 const char *dict_class_to_name (enum dict_class dict_class);
104 \f
105 /* Vector of variables. */
106 struct vector
107   {
108     int idx;                    /* Index for dict_get_vector(). */
109     char name[9];               /* Name. */
110     struct variable **var;      /* Vector of variables. */
111     int cnt;                    /* Number of variables. */
112   };
113 \f
114 \f
115 void discard_variables (void);
116
117 /* This is the active file dictionary. */
118 extern struct dictionary *default_dict;
119 \f
120 /* Transformation state. */
121
122 /* Default file handle for DATA LIST, REREAD, REPEATING DATA
123    commands. */
124 extern struct file_handle *default_handle;
125
126 /* PROCESS IF expression. */
127 extern struct expression *process_if_expr;
128 \f
129 /* TEMPORARY support. */
130
131 /* 1=TEMPORARY has been executed at some point. */
132 extern int temporary;
133
134 /* If temporary!=0, the saved dictionary. */
135 extern struct dictionary *temp_dict;
136
137 /* If temporary!=0, index into t_trns[] (declared far below) that
138    gives the point at which data should be written out.  -1 means that
139    the data shouldn't be changed since all transformations are
140    temporary. */
141 extern int temp_trns;
142
143 /* If FILTER is active, whether it was executed before or after
144    TEMPORARY. */
145 extern int FILTER_before_TEMPORARY;
146
147 void cancel_temporary (void);
148 \f
149 /* Functions. */
150
151 struct ccase;
152 void dump_split_vars (const struct ccase *);
153 typedef int (* is_missing_func )(const union value *, const struct variable *);
154
155 int is_num_user_missing (double, const struct variable *);
156 int is_str_user_missing (const unsigned char[], const struct variable *);
157 int is_missing (const union value *, const struct variable *);
158 int is_system_missing (const union value *, const struct variable *);
159 int is_user_missing (const union value *, const struct variable *);
160 void copy_missing_values (struct variable *dest, const struct variable *src);
161 \f
162 /* Transformations. */
163
164 struct trns_header;
165 typedef int trns_proc_func (struct trns_header *, struct ccase *, int);
166 typedef void trns_free_func (struct trns_header *);
167
168 /* Header for all transformations. */
169 struct trns_header
170   {
171     int index;                  /* Index into t_trns[]. */
172     trns_proc_func *proc;       /* Transformation proc. */
173     trns_free_func *free;       /* Garbage collector proc. */
174   };
175
176 /* Array of transformations */
177 extern struct trns_header **t_trns;
178
179 /* Number of transformations, maximum number in array currently. */
180 extern int n_trns, m_trns;
181
182 /* Index of first transformation that is really a transformation.  Any
183    transformations before this belong to INPUT PROGRAM. */
184 extern int f_trns;
185
186 void add_transformation (struct trns_header *trns);
187 void cancel_transformations (void);
188 \f
189 struct var_set;
190
191 struct var_set *var_set_create_from_dict (const struct dictionary *d);
192 struct var_set *var_set_create_from_array (struct variable *const *var,
193                                            size_t);
194
195 size_t var_set_get_cnt (const struct var_set *vs);
196 struct variable *var_set_get_var (const struct var_set *vs, size_t idx);
197 struct variable *var_set_lookup_var (const struct var_set *vs,
198                                      const char *name);
199 void var_set_destroy (struct var_set *vs);
200 \f
201 /* Variable parsers. */
202
203 enum
204   {
205     PV_NONE = 0,                /* No options. */
206     PV_SINGLE = 0001,           /* Restrict to a single name or TO use. */
207     PV_DUPLICATE = 0002,        /* Don't merge duplicates. */
208     PV_APPEND = 0004,           /* Append to existing list. */
209     PV_NO_DUPLICATE = 0010,     /* Error on duplicates. */
210     PV_NUMERIC = 0020,          /* Vars must be numeric. */
211     PV_STRING = 0040,           /* Vars must be string. */
212     PV_SAME_TYPE = 00100,       /* All vars must be the same type. */
213     PV_NO_SCRATCH = 00200       /* Disallow scratch variables. */
214   };
215
216 struct variable *parse_variable (void);
217 struct variable *parse_dict_variable (const struct dictionary *);
218 int parse_variables (const struct dictionary *, struct variable ***, int *,
219                      int opts);
220 int parse_var_set_vars (const struct var_set *, struct variable ***, int *,
221                         int opts);
222 int parse_DATA_LIST_vars (char ***names, int *cnt, int opts);
223 int parse_mixed_vars (char ***names, int *cnt, int opts);
224
225
226
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 )
230 */
231 const char * var_to_string(const struct variable *var);
232
233
234 #endif /* !var_h */