dict: Make dict_make_unique_var_name() return an allocated string.
[pspp-builds.git] / src / data / dictionary.h
index 167487fbd10a34182ed5457c62a7770262c8e794..3455a74f9677dcbb7be4ae50ff8e3844c9963b7b 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2004, 2007 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2007, 2009, 2010, 2011 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
@@ -56,10 +56,14 @@ struct variable *dict_create_var (struct dictionary *, const char *,
                                   int width);
 struct variable *dict_create_var_assert (struct dictionary *, const char *,
                                          int width);
-struct variable *dict_clone_var (struct dictionary *, const struct variable *,
-                                 const char *);
+struct variable *dict_clone_var (struct dictionary *, const struct variable *);
 struct variable *dict_clone_var_assert (struct dictionary *,
-                                        const struct variable *, const char *);
+                                        const struct variable *);
+struct variable *dict_clone_var_as (struct dictionary *,
+                                    const struct variable *, const char *);
+struct variable *dict_clone_var_as_assert (struct dictionary *,
+                                           const struct variable *,
+                                           const char *);
 
 /* Deleting variables. */
 void dict_delete_var (struct dictionary *, struct variable *);
@@ -75,11 +79,13 @@ void dict_reorder_var (struct dictionary *, struct variable *,
 void dict_reorder_vars (struct dictionary *,
                         struct variable *const *, size_t count);
 
-/* Changing variable names. */
+/* Variable names. */
 void dict_rename_var (struct dictionary *, struct variable *, const char *);
 bool dict_rename_vars (struct dictionary *,
                        struct variable **, char **new_names,
                        size_t count, char **err_name);
+char *dict_make_unique_var_name (const struct dictionary *, const char *hint,
+                                 unsigned long int *num_start);
 
 /* Weight variable. */
 double dict_get_case_weight (const struct dictionary *,
@@ -96,6 +102,7 @@ casenumber dict_get_case_limit (const struct dictionary *);
 void dict_set_case_limit (struct dictionary *, casenumber);
 
 /* Size of cases for this dictionary. */
+const struct caseproto *dict_get_proto (const struct dictionary *);
 int dict_get_next_value_idx (const struct dictionary *);
 size_t dict_get_case_size (const struct dictionary *);
 
@@ -104,13 +111,14 @@ size_t dict_get_case_size (const struct dictionary *);
 size_t dict_count_values (const struct dictionary *,
                           unsigned int exclude_classes);
 void dict_compact_values (struct dictionary *);
+struct caseproto *dict_get_compacted_proto (const struct dictionary *,
+                                            unsigned int exclude_classes);
 
 /* SPLIT FILE variables. */
 const struct variable *const *dict_get_split_vars (const struct dictionary *);
 size_t dict_get_split_cnt (const struct dictionary *);
 void dict_set_split_vars (struct dictionary *,
                           struct variable *const *, size_t cnt);
-void dict_unset_split_var (struct dictionary *, struct variable *);
 
 /* File label. */
 const char *dict_get_label (const struct dictionary *);
@@ -139,6 +147,29 @@ const struct vector *dict_lookup_vector (const struct dictionary *,
                                          const char *name);
 void dict_clear_vectors (struct dictionary *);
 
+/* Multiple response sets. */
+const struct mrset *dict_get_mrset (const struct dictionary *, size_t idx);
+size_t dict_get_n_mrsets (const struct dictionary *);
+const struct mrset *dict_lookup_mrset (const struct dictionary *,
+                                       const char *name);
+
+bool dict_add_mrset (struct dictionary *, struct mrset *);
+bool dict_delete_mrset (struct dictionary *, const char *name);
+void dict_clear_mrsets (struct dictionary *);
+
+/* Attributes. */
+struct attrset *dict_get_attributes (const struct dictionary *);
+void dict_set_attributes (struct dictionary *, const struct attrset *);
+bool dict_has_attributes (const struct dictionary *);
+
+/* Data encoding. */
+void dict_set_encoding (struct dictionary *d, const char *enc);
+const char *dict_get_encoding (const struct dictionary *d);
+
+/* Internal variables. */
+struct variable *dict_create_internal_var (int case_idx, int width);
+void dict_destroy_internal_var (struct variable *);
+
 /* Functions to be called upon dictionary changes. */
 struct dict_callbacks
  {
@@ -149,12 +180,18 @@ struct dict_callbacks
   void (*weight_changed) (struct dictionary *, int, void *);
   void (*filter_changed) (struct dictionary *, int, void *);
   void (*split_changed) (struct dictionary *, void *);
+  void (*var_display_width_changed) (struct dictionary *, int, void *);
  };
 
 void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *,
                         void *);
 void dict_copy_callbacks (struct dictionary *, const struct dictionary *);
 
+void dict_set_change_callback (struct dictionary *d,
+                              void (*changed) (struct dictionary *, void*),
+                              void *data);
+
+
 /* Debug use only. */
 void dict_dump (const struct dictionary *);