Remove unneeded dependency on variable.h.
[pspp-builds.git] / src / data / value-labels.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., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #ifndef VAL_LABS_H
21 #define VAL_LABS_H 1
22
23 #include <stddef.h>
24
25 #include <data/value.h>
26
27 struct val_labs;
28 struct variable;
29
30 struct val_lab 
31   {
32     union value value;
33     const char *label;
34   };
35
36 struct val_labs *val_labs_create (int width);
37 struct val_labs *val_labs_copy (const struct val_labs *);
38 void val_labs_set_width (struct val_labs *, int new_width);
39 void val_labs_destroy (struct val_labs *);
40 void val_labs_clear (struct val_labs *);
41 size_t val_labs_count (const struct val_labs *);
42
43 int val_labs_add (struct val_labs *, union value, const char *);
44 int val_labs_replace (struct val_labs *, union value, const char *);
45 int val_labs_remove (struct val_labs *, union value);
46 char *val_labs_find (const struct val_labs *, union value);
47
48 struct val_labs_iterator;
49
50 struct val_lab *val_labs_first (const struct val_labs *,
51                                 struct val_labs_iterator **);
52 struct val_lab *val_labs_first_sorted (const struct val_labs *,
53                                        struct val_labs_iterator **);
54 struct val_lab *val_labs_next (const struct val_labs *,
55                                struct val_labs_iterator **);
56 void val_labs_done (struct val_labs_iterator **);
57
58 /* Return a string representing this value, in the form most 
59    appropriate from a human factors perspective.
60    (IE: the label if it has one, otherwise the alpha/numeric )
61 */
62 const char *value_to_string(const union value *, const struct variable *);
63
64 #endif /* value-labels.h */