X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fdata%2Fvariable.h;h=b5562ba827c5ca538b1bc3590b52f15113877fd1;hb=5327d77be2296f6be3f532c20456eab839dc7c62;hp=ecfa6b765ec8447da8ce58f53506d77035cf2bec;hpb=7fbfc32fc3c636959b0a25b3e76609f86519e84a;p=pspp diff --git a/src/data/variable.h b/src/data/variable.h index ecfa6b765e..b5562ba827 100644 --- a/src/data/variable.h +++ b/src/data/variable.h @@ -1,5 +1,6 @@ /* PSPP - a program for statistical analysis. - Copyright (C) 1997-9, 2000 Free Software Foundation, Inc. + Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2013, + 2014, 2020 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 @@ -19,9 +20,28 @@ #include #include -#include -#include -#include +#include "data/dict-class.h" +#include "data/missing-values.h" +#include "data/val-type.h" +#include "data/settings.h" + +/* Bitfields to identify traits of a variable */ + +#define VAR_TRAIT_NAME 0x0001 +#define VAR_TRAIT_WIDTH 0x0002 +#define VAR_TRAIT_ROLE 0x0004 +#define VAR_TRAIT_LABEL 0x0008 +#define VAR_TRAIT_VALUE_LABELS 0x0010 +#define VAR_TRAIT_MISSING_VALUES 0x0020 +#define VAR_TRAIT_ALIGNMENT 0x0040 +#define VAR_TRAIT_MEASURE 0x0080 +#define VAR_TRAIT_DISPLAY_WIDTH 0x0100 +#define VAR_TRAIT_LEAVE 0x0200 +#define VAR_TRAIT_POSITION 0x0400 +#define VAR_TRAIT_ATTRIBUTES 0x0800 +#define VAR_TRAIT_PRINT_FORMAT 0x1000 +#define VAR_TRAIT_WRITE_FORMAT 0x2000 + union value; @@ -31,17 +51,12 @@ union value; instead. */ struct variable *var_create (const char *name, int width); struct variable *var_clone (const struct variable *); -void var_destroy (struct variable *); -struct variable *var_create_internal (int case_idx); - +struct variable * var_ref (struct variable *) WARN_UNUSED_RESULT; +void var_unref (struct variable *); /* Variable names. */ -#define VAR_NAME_LEN 64 /* Maximum length of variable name, in bytes. */ - const char *var_get_name (const struct variable *); void var_set_name (struct variable *, const char *); -bool var_is_valid_name (const char *, bool issue_error); -bool var_is_plausible_name (const char *name, bool issue_error); enum dict_class var_get_dict_class (const struct variable *); int compare_vars_by_name (const void *, const void *, const void *); @@ -52,17 +67,17 @@ unsigned hash_var_ptr_by_name (const void *, const void *); int compare_var_ptrs_by_dict_index (const void *, const void *, const void *); +struct fmt_spec; + /* Types and widths of values associated with a variable. */ enum val_type var_get_type (const struct variable *); int var_get_width (const struct variable *); void var_set_width (struct variable *, int width); +void var_set_width_and_formats (struct variable *v, int new_width, + const struct fmt_spec *print, const struct fmt_spec *write); bool var_is_numeric (const struct variable *); bool var_is_alpha (const struct variable *); -bool var_is_short_string (const struct variable *); -bool var_is_long_string (const struct variable *); - -size_t var_get_value_cnt (const struct variable *); /* Variables' missing values. */ const struct missing_values *var_get_missing_values (const struct variable *); @@ -70,10 +85,9 @@ void var_set_missing_values (struct variable *, const struct missing_values *); void var_clear_missing_values (struct variable *); bool var_has_missing_values (const struct variable *); -bool var_is_value_missing (const struct variable *, const union value *, - enum mv_class); -bool var_is_num_missing (const struct variable *, double, enum mv_class); -bool var_is_str_missing (const struct variable *, const char[], enum mv_class); +enum mv_class var_is_value_missing (const struct variable *, const union value *); +enum mv_class var_is_num_missing (const struct variable *, double); +enum mv_class var_is_str_missing (const struct variable *, const uint8_t[]); /* Value labels. */ const char *var_lookup_value_label (const struct variable *, @@ -81,10 +95,8 @@ const char *var_lookup_value_label (const struct variable *, struct string; void var_append_value_name (const struct variable *, const union value *, struct string *); - -const char * -var_get_value_name (const struct variable *v, const union value *value); - +void var_append_value_name__ (const struct variable *, const union value *, + enum settings_value_show, struct string *); bool var_has_value_labels (const struct variable *); const struct val_labs *var_get_value_labels (const struct variable *); @@ -108,24 +120,47 @@ struct fmt_spec var_default_formats (int width); /* Variable labels. */ const char *var_to_string (const struct variable *); const char *var_get_label (const struct variable *); -void var_set_label (struct variable *, const char *); +void var_set_label (struct variable *, const char *label); void var_clear_label (struct variable *); bool var_has_label (const struct variable *); /* How data is measured. */ enum measure { - MEASURE_NOMINAL = 0, - MEASURE_ORDINAL = 1, - MEASURE_SCALE = 2, + MEASURE_UNKNOWN = 0, + MEASURE_NOMINAL = 1, + MEASURE_ORDINAL = 2, + MEASURE_SCALE = 3, n_MEASURES }; bool measure_is_valid (enum measure); +const char *measure_to_string (enum measure); +const char *measure_to_syntax (enum measure); + enum measure var_get_measure (const struct variable *); void var_set_measure (struct variable *, enum measure); -enum measure var_default_measure (enum val_type); +enum measure var_default_measure_for_type (enum val_type); +enum measure var_default_measure_for_format (enum fmt_type); + +/* Intended usage of a variable, for populating dialogs. */ +enum var_role + { + ROLE_INPUT, + ROLE_TARGET, + ROLE_BOTH, + ROLE_NONE, + ROLE_PARTITION, + ROLE_SPLIT + }; + +bool var_role_is_valid (enum var_role); +const char *var_role_to_string (enum var_role); +const char *var_role_to_syntax (enum var_role); + +enum var_role var_get_role (const struct variable *); +void var_set_role (struct variable *, enum var_role); /* GUI display width. */ int var_get_display_width (const struct variable *); @@ -138,11 +173,13 @@ enum alignment { ALIGN_LEFT = 0, ALIGN_RIGHT = 1, - ALIGN_CENTRE = 2, - n_ALIGN + ALIGN_CENTRE = 2 }; bool alignment_is_valid (enum alignment); +const char *alignment_to_string (enum alignment); +const char *alignment_to_syntax (enum alignment); + enum alignment var_get_alignment (const struct variable *); void var_set_alignment (struct variable *, enum alignment); @@ -155,7 +192,7 @@ void var_set_leave (struct variable *, bool leave); bool var_must_leave (const struct variable *); /* Short names. */ -size_t var_get_short_name_cnt (const struct variable *); +size_t var_get_n_short_names (const struct variable *); const char *var_get_short_name (const struct variable *, size_t idx); void var_set_short_name (struct variable *, size_t, const char *); void var_clear_short_names (struct variable *); @@ -164,25 +201,18 @@ void var_clear_short_names (struct variable *); size_t var_get_dict_index (const struct variable *); size_t var_get_case_index (const struct variable *); -/* Variable auxiliary data. */ -void *var_get_aux (const struct variable *); -void *var_attach_aux (const struct variable *, - void *aux, void (*aux_dtor) (struct variable *)); -void var_clear_aux (struct variable *); -void *var_detach_aux (struct variable *); -void var_dtor_free (struct variable *); - -/* Observed categorical values. */ -struct cat_vals *var_get_obs_vals (const struct variable *); -void var_set_obs_vals (const struct variable *, struct cat_vals *); -bool var_has_obs_vals (const struct variable *); - /* Custom attributes. */ struct attrset *var_get_attributes (const struct variable *); void var_set_attributes (struct variable *, const struct attrset *); bool var_has_attributes (const struct variable *); +/* Encoding. */ +const char *var_get_encoding (const struct variable *); + /* Function types. */ typedef bool var_predicate_func (const struct variable *); +double var_force_valid_weight (const struct variable *wv, double w, + bool *warn_on_invalid); + #endif /* data/variable.h */