dictionary: Always compact immediately upon deletion of a variable.
[pspp] / src / data / dictionary.h
index 0eb175063dc09a8958072138e493c73098a30e36..d6823ed854ae9008f9663e60e39dde80906972ee 100644 (file)
@@ -40,15 +40,15 @@ 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. */
@@ -98,9 +98,11 @@ void dict_set_names_must_be_ids (struct dictionary *, bool);
 /* Weight variable. */
 double dict_get_case_weight (const struct dictionary *,
                             const struct ccase *, bool *);
+double dict_get_rounded_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 *);
+struct fmt_spec dict_get_weight_format (const struct dictionary *);
 
 /* Filter variable. */
 struct variable *dict_get_filter (const struct dictionary *);
@@ -112,22 +114,30 @@ 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 *);
 
 /* Making this dictionary's cases smaller (if some variables were
    deleted). */
 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. */
+/* 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 *);
@@ -143,16 +153,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 *);
@@ -167,6 +177,16 @@ bool dict_add_mrset (struct dictionary *, struct mrset *);
 bool dict_delete_mrset (struct dictionary *, const char *name);
 void dict_clear_mrsets (struct dictionary *);
 
+/* Variable sets. */
+const struct varset *dict_get_varset (const struct dictionary *, size_t idx);
+size_t dict_get_n_varsets (const struct dictionary *);
+const struct varset *dict_lookup_varset (const struct dictionary *,
+                                         const char *name);
+
+bool dict_add_varset (struct dictionary *, struct varset *);
+bool dict_delete_varset (struct dictionary *, const char *name);
+void dict_clear_varsets (struct dictionary *);
+
 /* Attributes. */
 struct attrset *dict_get_attributes (const struct dictionary *);
 void dict_set_attributes (struct dictionary *, const struct attrset *);
@@ -175,19 +195,15 @@ bool dict_has_attributes (const struct dictionary *);
 /* 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 *);
+char *dict_id_is_valid__ (const struct dictionary *, const char *id)
+  WARN_UNUSED_RESULT;
+bool dict_id_is_valid (const struct dictionary *, const char *id);
 
 /* Functions to be called upon dictionary changes. */
 struct dict_callbacks
  {
   void (*var_added) (struct dictionary *, int, void *);
-  void (*var_deleted) (struct dictionary *, const struct variable *,
-                       int dict_index, int case_index, void *);
+  void (*vars_deleted) (struct dictionary *, int dict_index, unsigned int n, 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 *);