aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gawk.texi
diff options
context:
space:
mode:
authorArnold D. Robbins <arnold@skeeve.com>2012-12-09 22:11:01 +0200
committerArnold D. Robbins <arnold@skeeve.com>2012-12-09 22:11:01 +0200
commitae9e583a257264f4580d07354e79aac63db72695 (patch)
tree5a03a771ec6588c0dede291c56df8ec9cb783f7a /doc/gawk.texi
parenta5a114bf6c6f2efdcd7889ebf0d7f9f3ec235a74 (diff)
parentd283194601bc7cb7c071317a8d53a89a3cbac40d (diff)
downloadegawk-ae9e583a257264f4580d07354e79aac63db72695.tar.gz
egawk-ae9e583a257264f4580d07354e79aac63db72695.tar.bz2
egawk-ae9e583a257264f4580d07354e79aac63db72695.zip
Merge branch 'master' into array-iface
Diffstat (limited to 'doc/gawk.texi')
-rw-r--r--doc/gawk.texi13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/gawk.texi b/doc/gawk.texi
index 5b6ea931..fca7cebb 100644
--- a/doc/gawk.texi
+++ b/doc/gawk.texi
@@ -28722,7 +28722,7 @@ The following types and/or macros and/or functions are referenced
in @file{gawkapi.h}. For correct use, you must therefore include the
corresponding standard header file @emph{before} including @file{gawkapi.h}:
-@multitable {C Entity} {@code{<sys/types.h>}}
+@multitable {@code{memset()}, @code{memcpy()}} {@code{<sys/types.h>}}
@headitem C Entity @tab Header File
@item @code{FILE} @tab @code{<stdio.h>}
@item @code{NULL} @tab @code{<stddef.h>}
@@ -29110,6 +29110,11 @@ The name of the new function.
@command{awk} level code calls the function by this name.
This is a regular C string.
+Function names must obey the rules for @command{awk}
+identifiers. That is, they must begin with either a letter
+or an underscore, which may be followed by any number of
+letters, digits, and underscores.
+
@item awk_value_t *(*function)(int num_actual_args, awk_value_t *result);
This is a pointer to the C function that provides the desired
functionality.
@@ -29117,6 +29122,9 @@ The function must fill in the result with either a number
or a string. @command{awk} takes ownership of any string memory.
As mentioned earlier, string memory @strong{must} come from @code{malloc()}.
+The @code{num_actual_args} argument tells the C function how many
+actual parameters were passed from the calling @command{awk} code.
+
The function must return the value of @code{result}.
This is for the convenience of the calling code inside @command{gawk}.
@@ -33114,7 +33122,8 @@ as a list of things that the POSIX standard should describe but does not.
@cindex artificial intelligence@comma{} @command{gawk} and
@item doc/awkforai.txt
-A short article describing why @command{gawk} is a good language for
+Pointers to the original draft of
+a short article describing why @command{gawk} is a good language for
Artificial Intelligence (AI) programming.
@item doc/bc_notes