refactor
[pspp] / src / ui / gui / psppire-dict.h
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2004, 2009, 2011  Free Software Foundation
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17
18 #ifndef __PSPPIRE_DICT_H__
19 #define __PSPPIRE_DICT_H__
20
21
22 #include <glib-object.h>
23 #include <glib.h>
24
25 #include <data/dictionary.h>
26 #include <data/variable.h>
27
28
29 G_BEGIN_DECLS
30
31
32 /* --- type macros --- */
33 #define PSPPIRE_TYPE_DICT              (psppire_dict_get_type ())
34 #define PSPPIRE_DICT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PSPPIRE_TYPE_DICT, PsppireDict))
35 #define PSPPIRE_DICT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), PSPPIRE_TYPE_DICT, PsppireDictClass))
36 #define PSPPIRE_IS_DICT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PSPPIRE_TYPE_DICT))
37 #define PSPPIRE_IS_DICT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPPIRE_TYPE_DICT))
38 #define PSPPIRE_DICT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PSPPIRE_TYPE_DICT, PsppireDictClass))
39
40
41 /* --- typedefs & structures --- */
42 typedef struct _PsppireDict        PsppireDict;
43 typedef struct _PsppireDictClass PsppireDictClass;
44
45 enum {DICT_TVM_COL_NAME=0,
46       DICT_TVM_COL_TYPE,
47       DICT_TVM_COL_WIDTH,
48       DICT_TVM_COL_DECIMAL,
49       DICT_TVM_COL_LABEL,
50       DICT_TVM_COL_VALUE_LABELS,
51       DICT_TVM_COL_MISSING_VALUES,
52       DICT_TVM_COL_COLUMNS,
53       DICT_TVM_COL_ALIGNMENT,
54       DICT_TVM_COL_MEASURE,
55       DICT_TVM_COL_ROLE,
56       DICT_TVM_COL_VAR,
57       n_DICT_COLS} ;
58
59 struct _PsppireDict
60 {
61   GObject             parent;
62   struct dictionary   *dict;
63
64   gboolean dispose_has_run;
65
66   gboolean disable_insert_signal;
67   /* For GtkTreeModelIface */
68   gint stamp;
69 };
70
71 struct _PsppireDictClass
72 {
73   GObjectClass parent_class;
74 };
75
76
77 /* -- PsppireDict --- */
78 GType          psppire_dict_get_type (void);
79 PsppireDict*   psppire_dict_new_from_dict (struct dictionary *d);
80 gboolean       psppire_dict_set_name (PsppireDict* s, gint idx, const gchar *name);
81 void           psppire_dict_delete_var (PsppireDict *s, gint idx);
82
83 /* Return the number of variables in the dictionary */
84 gint psppire_dict_get_n_vars (const PsppireDict *d);
85
86 /* Return the number of `union value's in the dictionary */
87 size_t psppire_dict_get_n_values (const PsppireDict *d);
88
89 /* Returns the prototype for the cases that match the dictionary */
90 const struct caseproto *psppire_dict_get_proto (const PsppireDict *d);
91
92 /* Return a variable by name.
93    Return NULL if it doesn't exist
94 */
95 struct variable * psppire_dict_lookup_var (const PsppireDict *d, const gchar *name);
96
97 /* Clears the contents of D */
98 void psppire_dict_clear (PsppireDict *d);
99
100 /* Return the IDXth variable */
101 struct variable * psppire_dict_get_variable (const PsppireDict *d, gint idx);
102
103 /* Delete N variables beginning at FIRST */
104 void psppire_dict_delete_variables (PsppireDict *d, gint first, gint n);
105
106 /* Insert a new variable at posn IDX */
107 struct variable *psppire_dict_insert_variable (PsppireDict *d, gint idx,
108                                                const gchar *name);
109
110 gboolean psppire_dict_check_name (const PsppireDict *dict,
111                               const gchar *name, gboolean report);
112
113 bool psppire_dict_generate_name (const PsppireDict *, char *name, size_t size);
114
115 gint psppire_dict_get_next_value_idx (const PsppireDict *dict);
116
117 gboolean psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
118                               const gchar *text);
119
120 void psppire_dict_replace_dictionary (PsppireDict *, struct dictionary *);
121
122 struct variable * psppire_dict_get_weight_variable (const PsppireDict *);
123
124 const gchar *psppire_dict_encoding (const PsppireDict *);
125
126 G_END_DECLS
127
128 #endif /* __PSPPIRE_DICT_H__ */