~vcs-imports/gawk/master

« back to all changes in this revision

Viewing changes to doc/gawktexi.in

  • Committer: Arnold D. Robbins
  • Date: 2016-12-22 16:30:05 UTC
  • mto: (731.14.2) (1056.1.1)
  • mto: This revision was merged to the branch mainline in revision 742.
  • Revision ID: git-v1:af31a6de1bd15d4d5f5520ebfcb1d24239b9a683
Doc cleanups after merge. Totally break binary compat in the API.

Show diffs side-by-side

added added

removed removed

Lines of Context:
31571
31571
@itemx @ @ @ @ AWK_UNDEFINED,
31572
31572
@itemx @ @ @ @ AWK_NUMBER,
31573
31573
@itemx @ @ @ @ AWK_STRING,
 
31574
@itemx @ @ @ @ AWK_REGEX,
 
31575
@itemx @ @ @ @ AWK_STRNUM,
31574
31576
@itemx @ @ @ @ AWK_ARRAY,
31575
31577
@itemx @ @ @ @ AWK_SCALAR,@ @ @ @ @ @ @ @ @ /* opaque access to a variable */
31576
 
@itemx @ @ @ @ AWK_VALUE_COOKIE,@ @ @ /* for updating a previously created value */
31577
 
@itemx @ @ @ @ AWK_REGEX,
31578
 
@itemx @ @ @ @ AWK_STRNUM
 
31578
@itemx @ @ @ @ AWK_VALUE_COOKIE@ @ @ @ /* for updating a previously created value */
31579
31579
@itemx @} awk_valtype_t;
31580
31580
This @code{enum} indicates the type of a value.
31581
31581
It is used in the following @code{struct}.
31628
31628
 
31629
31629
A strnum (numeric string) value is represented as a string and consists
31630
31630
of user input data that appears to be numeric.
31631
 
When an extension attempts to create a strnum value, a string flagged
31632
 
as user input is created. Subsequent parsing will determine whether it
31633
 
looks like a number and should be treated as a strnum or a regular string.
 
31631
When an extension creates a strnum value, the result is a string flagged
 
31632
as user input. Subsequent parsing by @command{gawk} then determines whether it
 
31633
looks like a number and should be treated as a strnum, or as a regular string.
31634
31634
 
31635
31635
Typed regexp values (@pxref{Strong Regexp Constants}) are not of
31636
31636
much use to extension functions.  Extension functions can tell that
31807
31807
 
31808
31808
@item static inline awk_value_t *
31809
31809
@itemx make_const_user_input(const char *string, size_t length, awk_value_t *result);
31810
 
This function is identical to @code{make_const_string}, but the string is
 
31810
This function is identical to @code{make_const_string()}, but the string is
31811
31811
flagged as user input that should be treated as a strnum value if the contents
31812
31812
of the string are numeric.
31813
31813
 
31814
31814
@item static inline awk_value_t *
31815
31815
@itemx make_malloced_user_input(const char *string, size_t length, awk_value_t *result);
31816
 
This function is identical to @code{make_malloced_string}, but the string is
 
31816
This function is identical to @code{make_malloced_string()}, but the string is
31817
31817
flagged as user input that should be treated as a strnum value if the contents
31818
31818
of the string are numeric.
31819
31819
 
33082
33082
 
33083
33083
@item awk_bool_t flatten_array_typed(awk_array_t a_cookie, awk_flat_array_t **data, awk_valtype_t index_type, awk_valtype_t value_type);
33084
33084
For the array represented by @code{a_cookie}, create an @code{awk_flat_array_t}
33085
 
structure and fill it in with indices and values of the requested types. Set the pointer whose address is passed as @code{data}
 
33085
structure and fill it in with indices and values of the requested types.
 
33086
Set the pointer whose address is passed as @code{data}
33086
33087
to point to this structure.
33087
33088
Return true upon success, or false otherwise.
33088
33089
@ifset FOR_PRINT
33097
33098
@item awk_bool_t flatten_array(awk_array_t a_cookie, awk_flat_array_t **data);
33098
33099
For the array represented by @code{a_cookie}, create an @code{awk_flat_array_t}
33099
33100
structure and fill it in with @code{AWK_STRING} indices and
33100
 
@code{AWK_UNDEFINED} values.  This is superseded by @code{flatten_array_typed}
33101
 
and retained only for legacy binary compatibility.
 
33101
@code{AWK_UNDEFINED} values.
 
33102
This is superseded by @code{flatten_array_typed()}.
 
33103
It is provided as a macro, and remains convenience and for source code
 
33104
compatibility with the previous version of the API.
33102
33105
 
33103
33106
@item awk_bool_t release_flattened_array(awk_array_t a_cookie,
33104
33107
@itemx @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ awk_flat_array_t *data);
37260
37263
@end table
37261
37264
 
37262
37265
@table @file
 
37266
@item support/*
 
37267
C header and source files for routines that @command{gawk}
 
37268
uses, but that are not part of its core functionality.
 
37269
For example, argument parsing, regular expression matching,
 
37270
and random number generating routines are all kept here.
 
37271
 
37263
37272
@item ABOUT-NLS
37264
37273
A file containing information about GNU @command{gettext} and translations.
37265
37274