diff options
author | Arnold D. Robbins <arnold@skeeve.com> | 2017-11-08 21:55:28 +0200 |
---|---|---|
committer | Arnold D. Robbins <arnold@skeeve.com> | 2017-11-08 21:55:28 +0200 |
commit | 19905e061994bab83ffdce30dab36cea12e68fe4 (patch) | |
tree | aa18aecf423334dc24086e4feca65e0afc722882 /doc/gawktexi.in | |
parent | 260eb47384d0f212a8f1cc505d407b7022e8ee46 (diff) | |
download | egawk-19905e061994bab83ffdce30dab36cea12e68fe4.tar.gz egawk-19905e061994bab83ffdce30dab36cea12e68fe4.tar.bz2 egawk-19905e061994bab83ffdce30dab36cea12e68fe4.zip |
Fix gawkapi.h for C++. Update doc.
Diffstat (limited to 'doc/gawktexi.in')
-rw-r--r-- | doc/gawktexi.in | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/gawktexi.in b/doc/gawktexi.in index 0d38921b..861f7a6b 100644 --- a/doc/gawktexi.in +++ b/doc/gawktexi.in @@ -31902,13 +31902,18 @@ The @code{val_type} member indicates what kind of value the Using these macros makes accessing the fields of the @code{awk_value_t} more readable. +@item enum AWK_NUMBER_TYPE @{ +@itemx @ @ @ @ AWK_NUMBER_TYPE_DOUBLE, +@itemx @ @ @ @ AWK_NUMBER_TYPE_MPFR, +@itemx @ @ @ @ AWK_NUMBER_TYPE_MPZ +@itemx @}; +This @code{enum} is used in the following structure for defining the +type of numeric value that is being worked with. It is declared at the +top level of the file so that it works correctly for C++ as well as for C. + @item typedef struct awk_number @{ @itemx @ @ @ @ double d; -@itemx @ @ @ @ enum AWK_NUMBER_TYPE @{ -@itemx @ @ @ @ @ @ @ @ AWK_NUMBER_TYPE_DOUBLE, -@itemx @ @ @ @ @ @ @ @ AWK_NUMBER_TYPE_MPFR, -@itemx @ @ @ @ @ @ @ @ AWK_NUMBER_TYPE_MPZ -@itemx @ @ @ @ @} type; +@itemx @ @ @ @ enum AWK_NUMBER_TYPE type; @itemx @ @ @ @ void *ptr; @itemx @} awk_number_t; This represents a numeric value. Internally, @command{gawk} stores @@ -31923,7 +31928,6 @@ in data received from @command{gawk}. In addition, by examining the member is either a GMP integer (type @code{mpz_ptr}), or an MPFR floating-point value (type @code{mpfr_ptr_t}), and cast it appropriately. - @item typedef void *awk_scalar_t; Scalars can be represented as an opaque type. These values are obtained from @command{gawk} and then passed back into it. This is discussed |