Merge master into output branch.
[pspp-builds.git] / src / ui / gui / helper.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2007, 2009  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 /* This file is a rubbish bin where stuff gets put when it doesn't seem to
19    belong anywhere else.
20 */
21 #include <config.h>
22
23 #include        <glib-object.h>
24
25 #include <glib.h>
26 #include "helper.h"
27 #include "message-dialog.h"
28 #include <data/format.h>
29 #include <data/data-in.h>
30 #include <data/data-out.h>
31 #include <data/dictionary.h>
32 #include <data/casereader-provider.h>
33 #include <libpspp/message.h>
34 #include "psppire-syntax-window.h"
35 #include <gtk/gtkbuilder.h>
36 #include <libpspp/i18n.h>
37
38 #include <ctype.h>
39 #include <string.h>
40 #include <stdlib.h>
41 #include <data/settings.h>
42
43 #include "psppire-data-store.h"
44
45 #include "xalloc.h"
46
47 #include <gettext.h>
48
49 /* Formats a value according to FORMAT
50    The returned string must be freed when no longer required */
51 gchar *
52 value_to_text (union value v, const PsppireDict *dict, struct fmt_spec format)
53 {
54   gchar *s = 0;
55
56   s = data_out (&v, dict_get_encoding (dict->dict),  &format);
57   g_strchug (s);
58
59   return s;
60 }
61
62
63 /* Converts TEXT to a value.
64
65    VAL will be initialised and filled by this function.
66    It is the caller's responsibility to destroy VAL when no longer needed.
67    VAR and DICT must be the variable and dictionary with which VAL
68    is associated.
69
70    On success, VAL is returned, NULL otherwise.
71 */
72 union value *
73 text_to_value (const gchar *text,
74                const PsppireDict *dict,
75                const struct variable *var,
76                union value *val)
77 {
78   const struct fmt_spec *format = var_get_print_format (var);
79   int width = var_get_width (var);
80
81   if ( format->type != FMT_A)
82     {
83       if ( ! text ) return NULL;
84
85       {
86         const gchar *s = text;
87         while (*s)
88           {
89             if ( !isspace (*s))
90               break;
91             s++;
92           }
93
94         if ( !*s) return NULL;
95       }
96     }
97
98   value_init (val, width);
99   msg_disable ();
100   data_in (ss_cstr (text), UTF8, format->type, 0, 0, 0,
101                 dict->dict,
102                 val, width);
103   msg_enable ();
104
105   return val;
106 }
107
108
109 GtkBuilder *
110 builder_new_real (const gchar *name)
111 {
112   GtkBuilder *builder = gtk_builder_new ();
113
114   GError *err = NULL;
115   if ( ! gtk_builder_add_from_file (builder, name,  &err))
116     {
117       g_critical ("Couldnt open user interface  file %s: %s", name, err->message);
118       g_clear_error (&err);
119     }
120
121   return builder;
122 }
123
124
125 GObject *
126 get_object_assert (GtkBuilder *builder, const gchar *name, GType type)
127 {
128   GObject *o = NULL;
129   g_assert (name);
130
131   o = gtk_builder_get_object (builder, name);
132
133   if ( !o )
134     g_critical ("Object \"%s\" could not be found\n", name);
135
136   if ( ! g_type_is_a (G_OBJECT_TYPE (o), type))
137    {
138      g_critical ("Object \"%s\" was expected to have type %s, but in fact has type %s", 
139         name, g_type_name (type), G_OBJECT_TYPE_NAME (o));
140    }
141
142   return o;
143 }
144
145
146 GtkAction *
147 get_action_assert (GtkBuilder *builder, const gchar *name)
148 {
149   return GTK_ACTION (get_object_assert (builder, name, GTK_TYPE_ACTION));
150 }
151
152 GtkWidget *
153 get_widget_assert (GtkBuilder *builder, const gchar *name)
154 {
155   return GTK_WIDGET (get_object_assert (builder, name, GTK_TYPE_WIDGET));
156 }
157
158 /* This function must be used whenever a filename generated by glib,
159    (eg, from gtk_file_chooser_get_filename) and passed to the C library,
160    (eg through a pspp syntax string).
161 */
162 gchar *
163 convert_glib_filename_to_system_filename (const gchar *fname, GError **err)
164 {
165   gchar *output_name;
166
167 #ifdef G_OS_WIN32
168   const gchar *target_encoding;
169   gchar *utf8_name = NULL;
170
171   g_get_charset (&target_encoding);
172
173   output_name = g_convert (fname, -1, target_encoding,
174                         "UTF-8", NULL, NULL, err);
175 #else
176   output_name = xstrdup (fname);
177 #endif
178
179   return output_name;
180 }
181
182
183
184 #define _(msgid) gettext (msgid)
185 #define N_(msgid) msgid
186
187
188 static void
189 give_help (void)
190 {
191   GtkWidget *dialog;
192
193   dialog = gtk_message_dialog_new (NULL,
194                                    GTK_DIALOG_MODAL,
195                                    GTK_MESSAGE_INFO,
196                                    GTK_BUTTONS_CLOSE,
197                                    _("Sorry. The help system hasn't yet "
198                                      "been implemented."));
199   gtk_dialog_run (GTK_DIALOG (dialog));
200   gtk_widget_destroy (dialog);
201 }
202
203 void
204 connect_help (GtkBuilder *xml)
205 {
206   GSList *helps = gtk_builder_get_objects (xml);
207
208   GSList *i;
209   for ( i = helps; i ; i = g_slist_next (i))
210     {
211       GObject *o = i->data;
212       if ( GTK_IS_WIDGET (o) )
213         {
214           gchar *name = NULL;
215           gchar s[12] = {0};
216           g_object_get (o, "name", &name, NULL);
217
218           if ( name)
219             strncpy (s, name, 11);
220           s[11] = '\0';
221
222
223           if ( 0 == strcmp ("help_button", s))
224             {
225             g_signal_connect (o, "clicked", give_help, 0);
226             }
227         }
228     }
229
230   g_slist_free (helps);
231 }
232
233
234 void
235 reference_manual (GtkMenuItem *menu, gpointer data)
236 {
237   GError *err = NULL;
238   gchar *cmd = g_strdup_printf ("yelp file://%s", relocate (DOCDIR "/pspp.xml"));
239
240   if ( ! g_spawn_command_line_async (cmd, &err) )
241     {
242       msg (ME, _("Cannot open reference manual: %s"), err->message);
243     }
244
245   g_free (cmd);
246   g_clear_error (&err);
247 }
248
249
250 /* Create a deep copy of SRC */
251 GtkListStore *
252 clone_list_store (const GtkListStore *src)
253 {
254   GtkTreeIter src_iter;
255   gboolean ok;
256   gint i;
257   const gint n_cols =  gtk_tree_model_get_n_columns (GTK_TREE_MODEL (src));
258   GType *types = g_malloc (sizeof (*types) *  n_cols);
259
260   int row = 0;
261   GtkListStore *dest;
262
263   for (i = 0 ; i < n_cols; ++i )
264     types[i] = gtk_tree_model_get_column_type (GTK_TREE_MODEL (src), i);
265
266   dest = gtk_list_store_newv (n_cols, types);
267
268   for (ok = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (src),
269                                            &src_iter);
270        ok;
271        ok = gtk_tree_model_iter_next (GTK_TREE_MODEL (src), &src_iter))
272     {
273       GtkTreeIter dest_iter;
274       gtk_list_store_append  (dest, &dest_iter);
275
276       for (i = 0 ; i < n_cols; ++i )
277         {
278           GValue val = {0};
279
280           gtk_tree_model_get_value (GTK_TREE_MODEL (src), &src_iter, i, &val);
281           gtk_list_store_set_value (dest, &dest_iter, i, &val);
282
283           g_value_unset (&val);
284         }
285       row++;
286     }
287
288   g_free (types);
289
290   return dest;
291 }
292
293
294 void
295 paste_syntax_in_new_window (const gchar *syntax)
296 {
297   GtkWidget *se = psppire_syntax_window_new ();
298
299   gtk_text_buffer_insert_at_cursor (PSPPIRE_SYNTAX_WINDOW (se)->buffer, syntax, -1);
300
301   gtk_widget_show (se);
302 }