Add an appropriate help page for the Variable Info dialog box
[pspp] / src / ui / gui / helper.c
index f5803d9f244fe88413a15ff55161b75f45a6bf35..d453f2a66593e79548e95e7a8d5b62d478a821d5 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPPIRE - a graphical user interface for PSPP.
-   Copyright (C) 2007, 2009, 2010, 2011  Free Software Foundation
+   Copyright (C) 2007, 2009, 2010, 2011, 2012, 2013  Free Software Foundation
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 #include <data/settings.h>
 
 #include "psppire-data-store.h"
-#include "psppire.h"
 
 #include "gl/configmake.h"
 #include "xalloc.h"
 
 #include <gettext.h>
 
-/* Formats a value according to VAR's print format.
-   The returned string must be freed when no longer required. */
+/* Returns a copy of IN with each underscore doubled.  The caller should free
+   the returned string (with free()) when it is no longer needed. */
+char *
+escape_underscores (const char *in)
+{
+  char *out = xmalloc (2 * strlen (in) + 1);
+  char *p;
+
+  p = out;
+  for (; *in != '\0'; in++)
+    {
+      if (*in == '_')
+        *p++ = '_';
+      *p++ = *in;
+    }
+  *p = '\0';
+
+  return out;
+}
+
+/* Formats a value according to VAR's print format and strips white space
+   appropriately for VAR's type.  That is, if VAR is numeric, strips leading
+   white space (because numbers are right-justified within their fields), and
+   if VAR is string, strips trailing white space (because spaces pad out string
+   values on the right).
+
+   Returns an allocated string.  The returned string must be freed when no
+   longer required. */
 gchar *
 value_to_text (union value v, const struct variable *var)
 {
-  gchar *s = data_out (&v, var_get_encoding (var), var_get_print_format (var));
-  return g_strchug (s);
+  return value_to_text__ (v, var_get_print_format (var),
+                          var_get_encoding (var));
 }
 
+/* Formats a value with format FORMAT and strips white space appropriately for
+   FORMATs' type.  That is, if FORMAT is numeric, strips leading white space
+   (because numbers are right-justified within their fields), and if FORMAT is
+   string, strips trailing white space (because spaces pad out string values on
+   the right).
+
+   Returns an allocated string.  The returned string must be freed when no
+   longer required. */
+gchar *
+value_to_text__ (union value v,
+                 const struct fmt_spec *format, const char *encoding)
+{
+  gchar *s;
+
+  s = data_out_stretchy (&v, encoding, format, NULL);
+  if (fmt_is_numeric (format->type))
+    g_strchug (s);
+  else
+    g_strchomp (s);
+
+  return s;
+}
 
 /* Converts TEXT to a value.
 
@@ -70,8 +117,25 @@ text_to_value (const gchar *text,
               const struct variable *var,
               union value *val)
 {
-  const struct fmt_spec *format = var_get_print_format (var);
-  int width = var_get_width (var);
+  return text_to_value__ (text, var_get_print_format (var),
+                          var_get_encoding (var), val);
+}
+
+/* Converts TEXT, which contains a value in the given FORMAT encoding in
+   ENCODING, into a value.
+
+   VAL will be initialised and filled by this function.
+   It is the caller's responsibility to destroy VAL when no longer needed.
+
+   On success, VAL is returned, NULL otherwise.
+*/
+union value *
+text_to_value__ (const gchar *text,
+                 const struct fmt_spec *format,
+                 const gchar *encoding,
+                 union value *val)
+{
+  int width = fmt_var_width (format);
 
   if ( format->type != FMT_A)
     {
@@ -91,61 +155,12 @@ text_to_value (const gchar *text,
     }
 
   value_init (val, width);
-  free (data_in (ss_cstr (text), UTF8, format->type, val, width,
-                 var_get_encoding (var)));
+  free (data_in (ss_cstr (text), UTF8, format->type, val, width, encoding));
 
   return val;
 }
 
 
-GtkBuilder *
-builder_new_real (const gchar *name)
-{
-  GtkBuilder *builder = gtk_builder_new ();
-
-  GError *err = NULL;
-  if ( ! gtk_builder_add_from_file (builder, name,  &err))
-    {
-      g_critical ("Couldnt open user interface  file %s: %s", name, err->message);
-      g_clear_error (&err);
-    }
-
-  return builder;
-}
-
-
-GObject *
-get_object_assert (GtkBuilder *builder, const gchar *name, GType type)
-{
-  GObject *o = NULL;
-  g_assert (name);
-
-  o = gtk_builder_get_object (builder, name);
-
-  if ( !o )
-    g_critical ("Object `%s' could not be found\n", name);
-  else if ( ! g_type_is_a (G_OBJECT_TYPE (o), type))
-   {
-     g_critical ("Object `%s' was expected to have type %s, but in fact has type %s", 
-       name, g_type_name (type), G_OBJECT_TYPE_NAME (o));
-   }
-
-  return o;
-}
-
-
-GtkAction *
-get_action_assert (GtkBuilder *builder, const gchar *name)
-{
-  return GTK_ACTION (get_object_assert (builder, name, GTK_TYPE_ACTION));
-}
-
-GtkWidget *
-get_widget_assert (GtkBuilder *builder, const gchar *name)
-{
-  return GTK_WIDGET (get_object_assert (builder, name, GTK_TYPE_WIDGET));
-}
-
 /* This function must be used whenever a filename generated by glib,
    (eg, from gtk_file_chooser_get_filename) and passed to the C library,
    (eg through a pspp syntax string).