pxd: initial work
[pspp] / src / data / variable.h
index a62902882f9fdb1e058dc902dd8b2ebeee124cb1..d2b905ad7359c9fd9e66c12efbbfcfd9bb3b3bfd 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
 
    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
@@ -27,7 +27,7 @@
 
 #define VAR_TRAIT_NAME             0x0001
 #define VAR_TRAIT_WIDTH            0x0002
-/* Available for reuse: 0x0004 */
+#define VAR_TRAIT_ROLE             0x0004
 #define VAR_TRAIT_LABEL            0x0008
 #define VAR_TRAIT_VALUE_LABELS     0x0010
 #define VAR_TRAIT_MISSING_VALUES   0x0020
@@ -120,7 +120,7 @@ struct fmt_spec var_default_formats (int width);
 /* Variable labels. */
 const char *var_to_string (const struct variable *);
 const char *var_get_label (const struct variable *);
-bool var_set_label (struct variable *, const char *label, bool issue_warning);
+void var_set_label (struct variable *, const char *label);
 void var_clear_label (struct variable *);
 bool var_has_label (const struct variable *);
 
@@ -135,12 +135,31 @@ enum measure
 
 bool measure_is_valid (enum measure);
 const char *measure_to_string (enum measure);
+const char *measure_to_syntax (enum measure);
 
 enum measure var_get_measure (const struct variable *);
 void var_set_measure (struct variable *, enum measure);
 
 enum measure var_default_measure (enum val_type);
 
+/* Intended usage of a variable, for populating dialogs. */
+enum var_role
+  {
+    ROLE_INPUT,
+    ROLE_TARGET,
+    ROLE_BOTH,
+    ROLE_NONE,
+    ROLE_PARTITION,
+    ROLE_SPLIT
+  };
+
+bool var_role_is_valid (enum var_role);
+const char *var_role_to_string (enum var_role);
+const char *var_role_to_syntax (enum var_role);
+
+enum var_role var_get_role (const struct variable *);
+void var_set_role (struct variable *, enum var_role);
+
 /* GUI display width. */
 int var_get_display_width (const struct variable *);
 void var_set_display_width (struct variable *, int display_width);
@@ -157,6 +176,7 @@ enum alignment
 
 bool alignment_is_valid (enum alignment);
 const char *alignment_to_string (enum alignment);
+const char *alignment_to_syntax (enum alignment);
 
 enum alignment var_get_alignment (const struct variable *);
 void var_set_alignment (struct variable *, enum alignment);
@@ -190,4 +210,8 @@ const char *var_get_encoding (const struct variable *);
 /* Function types. */
 typedef bool var_predicate_func (const struct variable *);
 
+/* Saving and loading. */
+struct pxd_object *var_save (const struct variable *, struct pxd *);
+struct variable *var_load (struct pxd_object *, const struct pxd *);
+
 #endif /* data/variable.h */