X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fdev%2Fconcepts.texi;h=053d2521c1298045b0ca774509f0d0379aada084;hb=9ade26c8349b4434008c46cf09bc7473ec743972;hp=06652d62653b1ec21ccdbc387f8993ae8f762b1f;hpb=3bbb4370239deb29ebbf813d258aef6249e2a431;p=pspp-builds.git diff --git a/doc/dev/concepts.texi b/doc/dev/concepts.texi index 06652d62..053d2521 100644 --- a/doc/dev/concepts.texi +++ b/doc/dev/concepts.texi @@ -637,11 +637,6 @@ work with these global styles: Returns the numeric style for the given format @var{type}. @end deftypefun -@deftypefun void fmt_check_style (const struct fmt_number_style *@var{style}) -Asserts that style is self consistent. -@end deftypefun - - @deftypefun {const char *} fmt_name (enum fmt_type @var{type}) Returns the name of the given format @var{type}. @end deftypefun @@ -1225,12 +1220,12 @@ The following sections describe variable-related functions and macros. @node Variable Name @subsection Variable Name -A variable name is a string between 1 and @code{VAR_NAME_LEN} bytes +A variable name is a string between 1 and @code{ID_MAX_LEN} bytes long that satisfies the rules for PSPP identifiers (@pxref{Tokens,,,pspp, PSPP Users Guide}). Variable names are mixed-case and treated case-insensitively. -@deftypefn Macro int VAR_NAME_LEN +@deftypefn Macro int ID_MAX_LEN Maximum length of a variable name, in bytes, currently 64. @end deftypefn @@ -1253,23 +1248,6 @@ dictionary. Use @func{dict_rename_var} instead (@pxref{Dictionary Renaming Variables}). @end deftypefun -@anchor{var_is_plausible_name} -@deftypefun {bool} var_is_valid_name (const char *@var{name}, bool @var{issue_error}) -@deftypefunx {bool} var_is_plausible_name (const char *@var{name}, bool @var{issue_error}) -Tests @var{name} for validity or ``plausibility.'' Returns true if -the name is acceptable, false otherwise. If the name is not -acceptable and @var{issue_error} is true, also issues an error message -explaining the violation. - -A valid name is one that fully satisfies all of the requirements for -variable names (@pxref{Tokens,,,pspp, PSPP Users Guide}). A -``plausible'' name is simply a string whose length is in the valid -range and that is not a reserved word. PSPP accepts plausible but -invalid names as variable names in some contexts where the character -encoding scheme is ambiguous, as when reading variable names from -system files. -@end deftypefun - @deftypefun {enum dict_class} var_get_dict_class (const struct variable *@var{var}) Returns the dictionary class of @var{var}'s name (@pxref{Dictionary Class}). @@ -1769,7 +1747,7 @@ To delete a variable from a dictionary and destroy it, use @node Variable Short Names @subsection Variable Short Names -PSPP variable names may be up to 64 (@code{VAR_NAME_LEN}) bytes long. +PSPP variable names may be up to 64 (@code{ID_MAX_LEN}) bytes long. The system and portable file formats, however, were designed when variable names were limited to 8 bytes in length. Since then, the system file format has been augmented with an extension record that @@ -1834,7 +1812,7 @@ been assigned a short name. Sets @var{var}'s short name to @var{short_name}, or removes @var{var}'s short name if @var{short_name} is a null pointer. If it is non-null, then @var{short_name} must be a plausible name for a -variable (@pxref{var_is_plausible_name}). The name will be truncated +variable. The name will be truncated to 8 bytes in length and converted to all-uppercase. @end deftypefun @@ -2106,17 +2084,23 @@ if through a call to @code{var_create} with those arguments of variables, and returns the new variable. @end deftypefun -@deftypefun {struct variable *} dict_clone_var (struct dictionary *@var{dict}, const struct variable *@var{old_var}, const char *@var{name}) -@deftypefunx {struct variable *} dict_clone_var_assert (struct dictionary *@var{dict}, const struct variable *@var{old_var}, const char *@var{name}) +@deftypefun {struct variable *} dict_clone_var (struct dictionary *@var{dict}, const struct variable *@var{old_var}) +@deftypefunx {struct variable *} dict_clone_var_assert (struct dictionary *@var{dict}, const struct variable *@var{old_var}) Creates a new variable as a clone of @var{var}, inserts the new -variable into @var{dict}, and returns the new variable. The new -variable is named @var{name}. Other properties of the new variable -are copied from @var{old_var}, except for those not copied by -@code{var_clone} (@pxref{var_clone}). +variable into @var{dict}, and returns the new variable. Other +properties of the new variable are copied from @var{old_var}, except +for those not copied by @code{var_clone} (@pxref{var_clone}). @var{var} does not need to be a member of any dictionary. @end deftypefun +@deftypefun {struct variable *} dict_clone_var_as (struct dictionary *@var{dict}, const struct variable *@var{old_var}, const char *@var{name}) +@deftypefunx {struct variable *} dict_clone_var_as_assert (struct dictionary *@var{dict}, const struct variable *@var{old_var}, const char *@var{name}) +These functions are similar to @code{dict_clone_var} and +@code{dict_clone_var_assert}, respectively, except that the new +variable is named @var{name} instead of keeping @var{old_var}'s name. +@end deftypefun + @node Dictionary Deleting Variables @subsection Deleting Variables