treewide: Replace <name>_cnt by n_<name>s and <name>_cap by allocated_<name>.
[pspp] / src / data / dictionary.h
index 1166fcd280b04ec05dda3ac7dc7033d41133f666..d1f7f2828bc1b902603dc93d749c26dcbda0f0f1 100644 (file)
@@ -27,27 +27,28 @@ struct ccase;
 
 /* Creating dictionaries. */
 struct dictionary *dict_create (const char *encoding);
-struct dictionary *dict_clone (const struct dictionary *);
+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_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. */
@@ -91,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 *);
@@ -120,9 +125,9 @@ struct caseproto *dict_get_compacted_proto (const struct dictionary *,
 
 /* SPLIT FILE variables. */
 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 *);
 void dict_set_split_vars (struct dictionary *,
-                          struct variable *const *, size_t cnt);
+                          struct variable *const *, size_t n);
 
 /* File label. */
 const char *dict_get_label (const struct dictionary *);
@@ -138,16 +143,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 *);