65e3d24ad3d495fe4531f63da7d51443ebd4546b
[pspp] / src / ui / gui / psppire-data-store.h
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2006, 2009, 2011, 2012  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 #ifndef __PSPPIRE_DATA_STORE_H__
18 #define __PSPPIRE_DATA_STORE_H__
19
20 #include "psppire-dict.h"
21
22 #define FIRST_CASE_NUMBER 1
23
24
25 G_BEGIN_DECLS
26
27 #define PSPPIRE_TYPE_DATA_STORE        (psppire_data_store_get_type ())
28
29 #define PSPPIRE_DATA_STORE(obj) \
30   (G_TYPE_CHECK_INSTANCE_CAST ((obj),                                   \
31                                PSPPIRE_TYPE_DATA_STORE, PsppireDataStore))
32
33 #define PSPPIRE_DATA_STORE_CLASS(klass) \
34   (G_TYPE_CHECK_CLASS_CAST ((klass),                                    \
35                             PSPPIRE_TYPE_DATA_STORE,                    \
36                             PsppireDataStoreClass))
37
38
39 #define PSPPIRE_IS_DATA_STORE(obj) \
40   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PSPPIRE_TYPE_DATA_STORE))
41
42 #define PSPPIRE_IS_DATA_STORE_CLASS(klass) \
43   (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPPIRE_TYPE_DATA_STORE))
44
45 #define PSPPIRE_DATA_STORE_GET_CLASS(obj) \
46   (G_TYPE_INSTANCE_GET_CLASS ((obj),                                    \
47                               PSPPIRE_TYPE_DATA_STORE,                  \
48                               PsppireDataStoreClass))
49
50 typedef struct _PsppireDataStore       PsppireDataStore;
51 typedef struct _PsppireDataStoreClass  PsppireDataStoreClass;
52
53 struct dictionary;
54
55
56 enum dict_signal_handler {
57   VARIABLE_INSERTED,
58   VARIABLE_CHANGED,
59   VARIABLE_DELETED,
60   n_dict_signals
61 };
62
63
64 struct datasheet;
65 struct casereader;
66
67 struct _PsppireDataStore
68 {
69   GObject parent;
70
71   /*< private >*/
72   gboolean dispose_has_run ;
73   PsppireDict *dict;
74   struct datasheet *datasheet;
75   gint stamp;
76
77   gint dict_handler_id [n_dict_signals];
78 };
79
80 struct _PsppireDataStoreClass
81 {
82   GObjectClass parent_class;
83 };
84
85
86 GType psppire_data_store_get_type (void) G_GNUC_CONST;
87 PsppireDataStore *psppire_data_store_new     (PsppireDict *dict);
88
89
90 void psppire_data_store_set_reader (PsppireDataStore *ds,
91                                     struct casereader *reader);
92
93 void psppire_data_store_set_dictionary (PsppireDataStore *data_store,
94                                         PsppireDict *dict);
95
96 void psppire_data_store_clear (PsppireDataStore *data_store);
97
98 gboolean psppire_data_store_insert_new_case (PsppireDataStore *ds, casenumber posn);
99
100 gboolean psppire_data_store_insert_value (PsppireDataStore *ds,
101                                           gint width, gint where);
102
103 gboolean psppire_data_store_delete_cases (PsppireDataStore *ds, casenumber first, casenumber count);
104
105
106 struct casereader * psppire_data_store_get_reader (PsppireDataStore *ds);
107
108 gchar *psppire_data_store_get_string (PsppireDataStore *,
109                                       glong row, const struct variable *,
110                                       bool use_value_label);
111
112 gchar * psppire_data_store_value_to_string (gpointer unused, PsppireDataStore *store,
113                                             gint col, gint row,
114                                             const GValue *v);
115
116 gchar * psppire_data_store_value_to_string_with_labels (gpointer unused, PsppireDataStore *store,
117                                             gint col, gint row,
118                                             const GValue *v);
119
120
121 gboolean psppire_data_store_get_value (PsppireDataStore *store,
122                                        glong row, const struct variable *var,
123                                        union value *val);
124
125 gboolean psppire_data_store_set_value (PsppireDataStore *,
126                                        casenumber casenum,
127                                        const struct variable *,
128                                        const union value *);
129
130
131 gboolean psppire_data_store_set_string (PsppireDataStore *ds,
132                                         const gchar *text,
133                                         glong row, const struct variable *,
134                                         gboolean use_value_label);
135
136
137 gboolean psppire_data_store_filtered (PsppireDataStore *ds,
138                                       glong row);
139
140
141 casenumber psppire_data_store_get_case_count (const PsppireDataStore *ds);
142 size_t psppire_data_store_get_value_count (const PsppireDataStore *ds);
143 const struct caseproto *psppire_data_store_get_proto (const PsppireDataStore *);
144
145 \f
146
147 struct ccase *psppire_data_store_get_case (const PsppireDataStore *ds,
148                                            casenumber casenum);
149
150
151
152
153 G_END_DECLS
154
155 #endif /* __PSPPIRE_DATA_STORE_H__ */