sys-file-reader: Better handle duplicate names without long names.
[pspp] / src / data / dictionary.h
index 02fd5cd4c0195f3ed73c994d04571b4988a796d3..1166fcd280b04ec05dda3ac7dc7033d41133f666 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2004, 2007, 2009 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2007, 2009, 2010, 2011, 2012, 2013 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
 
 #include <stdbool.h>
 #include <stddef.h>
-#include <data/case.h>
-#include <data/dict-class.h>
+#include "data/case.h"
+#include "data/dict-class.h"
 
 struct string;
 struct ccase;
 
 /* Creating dictionaries. */
-struct dictionary *dict_create (void);
+struct dictionary *dict_create (const char *encoding);
 struct dictionary *dict_clone (const struct dictionary *);
 
 
 /* Clearing and destroying dictionaries. */
 void dict_clear (struct dictionary *);
-void dict_clear_aux (struct dictionary *);
 void dict_destroy (struct dictionary *);
 
 /* Common ways to access variables. */
@@ -56,10 +55,17 @@ 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 *);
+
+struct variable *dict_clone_var_in_place_assert (struct dictionary *,
+                                                 const struct variable *);
 
 /* Deleting variables. */
 void dict_delete_var (struct dictionary *, struct variable *);
@@ -76,13 +82,14 @@ void dict_reorder_vars (struct dictionary *,
                         struct variable *const *, size_t count);
 
 /* Variable names. */
+bool dict_try_rename_var (struct dictionary *,
+                          struct variable *, const char *);
 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);
-bool dict_make_unique_var_name (const struct dictionary *, const char *hint,
-                                unsigned long int *num_start,
-                                char 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 *,
@@ -116,7 +123,6 @@ 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 *);
@@ -125,14 +131,15 @@ void dict_set_label (struct dictionary *, const char *);
 /* Documents. */
 #define DOC_LINE_LENGTH 80 /* Fixed length of document lines. */
 
-const char *dict_get_documents (const struct dictionary *);
-void dict_set_documents (struct dictionary *, const char *);
+const struct string_array *dict_get_documents (const struct dictionary *);
+void dict_set_documents (struct dictionary *, const struct string_array *);
+void dict_set_documents_string (struct dictionary *, const char *);
 void dict_clear_documents (struct dictionary *);
 
-void dict_add_document_line (struct dictionary *, const char *);
+bool dict_add_document_line (struct dictionary *, const char *,
+                             bool issue_warning);
 size_t dict_get_document_line_cnt (const struct dictionary *);
-void dict_get_document_line (const struct dictionary *,
-                             size_t, struct string *);
+const char *dict_get_document_line (const struct dictionary *, size_t);
 
 /* Vectors. */
 bool dict_create_vector (struct dictionary *, const char *name,
@@ -145,27 +152,41 @@ 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 *);
 
-
-void dict_set_encoding (struct dictionary *d, const char *enc);
+/* Data encoding. */
 const char *dict_get_encoding (const struct dictionary *d);
 
+bool dict_id_is_valid (const struct dictionary *, const char *id,
+                       bool issue_error);
+
+/* 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
  {
   void (*var_added) (struct dictionary *, int, void *);
-  void (*var_deleted) (struct dictionary *, int, int, int, void *);
-  void (*var_changed) (struct dictionary *, int, void *);
-  void (*var_resized) (struct dictionary *, int, int, void *);
+  void (*var_deleted) (struct dictionary *, const struct variable *,
+                       int dict_index, int case_index, void *);
+  void (*var_changed) (struct dictionary *, int, unsigned int, const struct variable *, void *);
   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 *,