dictionary: Limit split file variables to 8, for compatibility.
[pspp] / src / data / dictionary.h
index fa5d0ddeb8fc355d4f48a28e69b24b5e883f0645..47317a22cbc23e61a56de8602b09123daea92499 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2004, 2007, 2009, 2010, 2011 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
@@ -26,29 +26,29 @@ struct string;
 struct ccase;
 
 /* Creating dictionaries. */
-struct dictionary *dict_create (void);
-struct dictionary *dict_clone (const struct dictionary *);
+struct dictionary *dict_create (const char *encoding);
+struct dictionary *dict_clone (const struct dictionary *) WARN_UNUSED_RESULT;
+struct dictionary *dict_ref (struct dictionary *s) WARN_UNUSED_RESULT;
 
 
 /* Clearing and destroying dictionaries. */
 void dict_clear (struct dictionary *);
-void dict_clear_aux (struct dictionary *);
-void dict_destroy (struct dictionary *);
+void dict_unref (struct dictionary *);
 
 /* Common ways to access variables. */
 struct variable *dict_lookup_var (const struct dictionary *, const char *);
 struct variable *dict_lookup_var_assert (const struct dictionary *,
                                          const char *);
 struct variable *dict_get_var (const struct dictionary *, size_t position);
-size_t dict_get_var_cnt (const struct dictionary *);
+size_t dict_get_n_vars (const struct dictionary *);
 
 /* Other access to variables. */
 bool dict_contains_var (const struct dictionary *, const struct variable *);
 void dict_get_vars (const struct dictionary *,
-                    const struct variable ***vars, size_t *cnt,
+                    const struct variable ***vars, size_t *n_vars,
                     enum dict_class exclude);
 void dict_get_vars_mutable (const struct dictionary *,
-                            struct variable ***vars, size_t *cnt,
+                            struct variable ***vars, size_t *n_vars,
                             enum dict_class exclude);
 
 /* Creating variables. */
@@ -65,6 +65,9 @@ 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 *);
 void dict_delete_vars (struct dictionary *,
@@ -80,6 +83,8 @@ 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,
@@ -87,11 +92,15 @@ bool dict_rename_vars (struct dictionary *,
 char *dict_make_unique_var_name (const struct dictionary *, const char *hint,
                                  unsigned long int *num_start);
 
+bool dict_get_names_must_be_ids (const struct dictionary *);
+void dict_set_names_must_be_ids (struct dictionary *, bool);
+
 /* Weight variable. */
 double dict_get_case_weight (const struct dictionary *,
                             const struct ccase *, bool *);
 struct variable *dict_get_weight (const struct dictionary *);
 void dict_set_weight (struct dictionary *, struct variable *);
+const struct fmt_spec *dict_get_weight_format (const struct dictionary *);
 
 /* Filter variable. */
 struct variable *dict_get_filter (const struct dictionary *);
@@ -114,11 +123,23 @@ void dict_compact_values (struct dictionary *);
 struct caseproto *dict_get_compacted_proto (const struct dictionary *,
                                             unsigned int exclude_classes);
 
-/* SPLIT FILE variables. */
+/* SPLIT FILE variables.
+
+   SPLIT_NONE is used if and only if there are no split file variables. */
+enum split_type
+  {
+    SPLIT_NONE,                 /* No split file variables. */
+    SPLIT_SEPARATE,             /* Produce separate output for each split. */
+    SPLIT_LAYERED,              /* Output splits in same table.  */
+  };
+#define MAX_SPLITS 8
 const struct variable *const *dict_get_split_vars (const struct dictionary *);
-size_t dict_get_split_cnt (const struct dictionary *);
+size_t dict_get_n_splits (const struct dictionary *);
+enum split_type dict_get_split_type (const struct dictionary *);
 void dict_set_split_vars (struct dictionary *,
-                          struct variable *const *, size_t cnt);
+                          struct variable *const *, size_t n,
+                          enum split_type);
+void dict_clear_split_vars (struct dictionary *);
 
 /* File label. */
 const char *dict_get_label (const struct dictionary *);
@@ -134,16 +155,16 @@ void dict_clear_documents (struct dictionary *);
 
 bool dict_add_document_line (struct dictionary *, const char *,
                              bool issue_warning);
-size_t dict_get_document_line_cnt (const struct dictionary *);
+size_t dict_get_document_n_lines (const struct dictionary *);
 const char *dict_get_document_line (const struct dictionary *, size_t);
 
 /* Vectors. */
 bool dict_create_vector (struct dictionary *, const char *name,
-                         struct variable **, size_t cnt);
+                         struct variable **, size_t n);
 void dict_create_vector_assert (struct dictionary *, const char *name,
-                                struct variable **, size_t cnt);
+                                struct variable **, size_t n);
 const struct vector *dict_get_vector (const struct dictionary *, size_t idx);
-size_t dict_get_vector_cnt (const struct dictionary *);
+size_t dict_get_n_vectors (const struct dictionary *);
 const struct vector *dict_lookup_vector (const struct dictionary *,
                                          const char *name);
 void dict_clear_vectors (struct dictionary *);
@@ -164,7 +185,6 @@ 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);
 
 bool dict_id_is_valid (const struct dictionary *, const char *id,
@@ -178,13 +198,12 @@ void dict_destroy_internal_var (struct variable *);
 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 *,