Warnings: missing initializer for value_tables and function type cast (GObject)
[pspp] / src / ui / gui / psppire-spreadsheet-model.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2013, 2014  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 /* This file implements a GtkTreeModel.  It allows GtkComboBox and
18    GtkTreeView to display the names and non-empty cell ranges of the
19    sheets aka "Tables" of spreadsheet files.
20    It doesn't take any notice of the spreadsheet data itself.
21 */
22
23 #include <config.h>
24 #include <glib.h>
25
26 #include <stdint.h>
27
28 #include <gettext.h>
29 #define _(msgid) gettext (msgid)
30 #define N_(msgid) msgid
31
32
33 #include "psppire-spreadsheet-model.h"
34 #include "data/spreadsheet-reader.h"
35
36 static void psppire_spreadsheet_model_finalize (GObject * object);
37 static void psppire_spreadsheet_model_dispose (GObject * object);
38
39 static GObjectClass *parent_class = NULL;
40
41 static void spreadsheet_tree_model_init (GtkTreeModelIface * iface);
42
43 G_DEFINE_TYPE_WITH_CODE (PsppireSpreadsheetModel,\
44                          psppire_spreadsheet_model,\
45                          G_TYPE_OBJECT,
46                          G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
47                                                 spreadsheet_tree_model_init))
48
49 /* Properties */
50 enum
51 {
52   PROP_0,
53   PROP_SPREADSHEET
54 };
55
56
57 static void
58 psppire_spreadsheet_model_set_property (GObject * object,
59                                         guint prop_id,
60                                         const GValue * value,
61                                         GParamSpec * pspec)
62 {
63   PsppireSpreadsheetModel *spreadsheetModel =
64     PSPPIRE_SPREADSHEET_MODEL (object);
65
66   switch (prop_id)
67     {
68     case PROP_SPREADSHEET:
69       spreadsheetModel->spreadsheet = g_value_get_pointer (value);
70       spreadsheet_ref (spreadsheetModel->spreadsheet);
71       break;
72     default:
73       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
74       break;
75     };
76 }
77
78
79 static void
80 psppire_spreadsheet_model_dispose (GObject * object)
81 {
82   PsppireSpreadsheetModel *spreadsheetModel = PSPPIRE_SPREADSHEET_MODEL (object);
83
84   if (!spreadsheetModel->dispose_has_run)
85     {
86       spreadsheet_unref (spreadsheetModel->spreadsheet);
87
88       spreadsheetModel->dispose_has_run = TRUE;
89     }
90 }
91
92 static void
93 psppire_spreadsheet_model_finalize (GObject * object)
94 {
95   //  PsppireSpreadsheetModel *spreadsheetModel = PSPPIRE_SPREADSHEET_MODEL (object);
96 }
97
98 static void
99 psppire_spreadsheet_model_class_init (PsppireSpreadsheetModelClass * class)
100 {
101   GObjectClass *object_class;
102
103   GParamSpec *spreadsheet_spec = g_param_spec_pointer ("spreadsheet",
104                                                        "Spreadsheet",
105                                                        "The spreadsheet that this model represents",
106                                                        G_PARAM_CONSTRUCT_ONLY
107                                                        | G_PARAM_WRITABLE);
108
109   parent_class = g_type_class_peek_parent (class);
110
111   object_class = (GObjectClass *) class;
112
113   object_class->set_property = psppire_spreadsheet_model_set_property;
114
115   g_object_class_install_property (object_class,
116                                    PROP_SPREADSHEET, spreadsheet_spec);
117
118   object_class->finalize = psppire_spreadsheet_model_finalize;
119   object_class->dispose = psppire_spreadsheet_model_dispose;
120 }
121
122
123 static void
124 psppire_spreadsheet_model_init (PsppireSpreadsheetModel * spreadsheetModel)
125 {
126   spreadsheetModel->dispose_has_run = FALSE;
127   spreadsheetModel->stamp = g_random_int ();
128 }
129
130
131 GtkTreeModel *
132 psppire_spreadsheet_model_new (struct spreadsheet *sp)
133 {
134   return g_object_new (psppire_spreadsheet_model_get_type (),
135                        "spreadsheet", sp, NULL);
136 }
137
138
139 \f
140
141 static gint
142 tree_model_n_columns (GtkTreeModel * model)
143 {
144   return PSPPIRE_SPREADSHEET_MODEL_N_COLS;
145 }
146
147 static GtkTreeModelFlags
148 tree_model_get_flags (GtkTreeModel * model)
149 {
150   g_return_val_if_fail (PSPPIRE_IS_SPREADSHEET_MODEL (model),
151                         (GtkTreeModelFlags) 0);
152
153   return GTK_TREE_MODEL_LIST_ONLY;
154 }
155
156 static GType
157 tree_model_column_type (GtkTreeModel * model, gint index)
158 {
159   g_return_val_if_fail (PSPPIRE_IS_SPREADSHEET_MODEL (model), (GType) 0);
160   g_return_val_if_fail (index < PSPPIRE_SPREADSHEET_MODEL_N_COLS, (GType) 0);
161
162   return G_TYPE_STRING;
163 }
164
165
166 static gboolean
167 tree_model_get_iter (GtkTreeModel * model, GtkTreeIter * iter,
168                      GtkTreePath * path)
169 {
170   PsppireSpreadsheetModel *spreadsheetModel =
171     PSPPIRE_SPREADSHEET_MODEL (model);
172   gint *indices, depth;
173   gint n;
174
175   g_return_val_if_fail (path, FALSE);
176
177   depth = gtk_tree_path_get_depth (path);
178
179   g_return_val_if_fail (depth == 1, FALSE);
180
181   indices = gtk_tree_path_get_indices (path);
182
183   n = indices[0];
184
185   iter->stamp = spreadsheetModel->stamp;
186   iter->user_data = (gpointer) (intptr_t) n;
187
188   return TRUE;
189 }
190
191 static gboolean
192 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
193 {
194   PsppireSpreadsheetModel *spreadsheetModel = PSPPIRE_SPREADSHEET_MODEL (model);
195   g_assert (iter);
196   g_return_val_if_fail (iter->stamp == spreadsheetModel->stamp, FALSE);
197
198   if ((intptr_t) iter->user_data >= spreadsheetModel->spreadsheet->n_sheets - 1)
199     {
200       iter->user_data = NULL;
201       iter->stamp = 0;
202       return FALSE;
203     }
204
205   iter->user_data++;
206
207   return TRUE;
208 }
209
210
211 static void
212 tree_model_get_value (GtkTreeModel * model, GtkTreeIter * iter,
213                       gint column, GValue * value)
214 {
215   PsppireSpreadsheetModel *spreadsheetModel =
216     PSPPIRE_SPREADSHEET_MODEL (model);
217   g_return_if_fail (column < PSPPIRE_SPREADSHEET_MODEL_N_COLS);
218   g_return_if_fail (iter->stamp == spreadsheetModel->stamp);
219
220   g_value_init (value, G_TYPE_STRING);
221   switch (column)
222     {
223     case PSPPIRE_SPREADSHEET_MODEL_COL_NAME:
224       {
225         const char *x =
226           spreadsheet_get_sheet_name (spreadsheetModel->spreadsheet,
227                                       (intptr_t) iter->user_data);
228
229         g_value_set_string (value, x);
230       }
231       break;
232     case PSPPIRE_SPREADSHEET_MODEL_COL_RANGE:
233       {
234         char *x =
235           spreadsheet_get_sheet_range (spreadsheetModel->spreadsheet,
236                                        (intptr_t) iter->user_data);
237
238         g_value_set_string (value, x ? x : _("(empty)"));
239         g_free (x);
240       }
241       break;
242     default:
243       g_error ("%s:%d Invalid column in spreadsheet model",
244                __FILE__, __LINE__);
245       break;
246     }
247 }
248
249 static gboolean
250 tree_model_nth_child (GtkTreeModel * model, GtkTreeIter * iter,
251                       GtkTreeIter * parent, gint n)
252 {
253   PsppireSpreadsheetModel *spreadsheetModel =
254     PSPPIRE_SPREADSHEET_MODEL (model);
255
256   if (parent)
257     return FALSE;
258
259   if (n >= spreadsheetModel->spreadsheet->n_sheets)
260     return FALSE;
261
262   iter->stamp = spreadsheetModel->stamp;
263   iter->user_data = (gpointer) (intptr_t) n;
264
265   return TRUE;
266 }
267
268 static gint
269 tree_model_n_children (GtkTreeModel * model, GtkTreeIter * iter)
270 {
271   PsppireSpreadsheetModel *spreadsheetModel =
272     PSPPIRE_SPREADSHEET_MODEL (model);
273
274   if (iter == NULL)
275     return spreadsheetModel->spreadsheet->n_sheets;
276
277   return 0;
278 }
279
280 static gboolean
281 tree_model_iter_has_child (GtkTreeModel *tree_model, GtkTreeIter *iter)
282 {
283   return FALSE;
284 }
285
286 static GtkTreePath *
287 tree_model_get_path (GtkTreeModel * model, GtkTreeIter * iter)
288 {
289   PsppireSpreadsheetModel *spreadsheetModel =
290     PSPPIRE_SPREADSHEET_MODEL (model);
291   GtkTreePath *path;
292   gint index = (intptr_t) iter->user_data;
293
294   g_return_val_if_fail (iter->stamp == spreadsheetModel->stamp, NULL);
295
296   path = gtk_tree_path_new ();
297
298   gtk_tree_path_append_index (path, index);
299
300   return path;
301 }
302
303
304 static gboolean
305 tree_model_children (GtkTreeModel *model, GtkTreeIter *iter, GtkTreeIter *parent)
306 {
307   PsppireSpreadsheetModel *spreadsheetModel = PSPPIRE_SPREADSHEET_MODEL (model);
308
309   if (parent != NULL)
310     return FALSE;
311
312   iter->stamp = spreadsheetModel->stamp;
313   iter->user_data = 0;
314
315   return TRUE;
316 }
317
318
319
320 static void
321 spreadsheet_tree_model_init (GtkTreeModelIface * iface)
322 {
323   iface->get_flags = tree_model_get_flags;
324   iface->get_n_columns = tree_model_n_columns;
325   iface->get_column_type = tree_model_column_type;
326   iface->get_iter = tree_model_get_iter;
327   iface->iter_next = tree_model_iter_next;
328   iface->get_value = tree_model_get_value;
329
330   iface->iter_children = tree_model_children;
331   iface->iter_parent = NULL;
332
333   iface->get_path = tree_model_get_path;
334   iface->iter_has_child = tree_model_iter_has_child;
335   iface->iter_n_children = tree_model_n_children;
336   iface->iter_nth_child = tree_model_nth_child;
337 }