diff options
Diffstat (limited to 'doc/gawk.info')
| -rw-r--r-- | doc/gawk.info | 254 |
1 files changed, 135 insertions, 119 deletions
diff --git a/doc/gawk.info b/doc/gawk.info index 9a66843c..c7f60987 100644 --- a/doc/gawk.info +++ b/doc/gawk.info @@ -21814,13 +21814,29 @@ operations: Some points about using the API: - * You must include `<sys/types.h>' and `<sys/stat.h>' before - including the `gawkapi.h' header file. In addition, you must - include either `<stddef.h>' or `<stdlib.h>' to get the definition - of `size_t'. If you wish to use the boilerplate `dl_load_func()' - macro, you will need to include `<stdio.h>' as well. Finally, to - pass reasonable integer values for `ERRNO', you will need to - include `<errno.h>'. + * The following types and/or macros and/or functions are referenced + in `gawkapi.h'. For correct use, you must therefore include the + corresponding standard header file _before_ including `gawkapi.h': + + C Entity Header File + ----------------------------- + `FILE' `<stdio.h>' + `NULL' `<stddef.h>' + `malloc()' `<stdlib.h>' + `memset()',`<string.h>' + `memcpy()' + `size_t' `<sys/types.h>' + `struct `<sys/stat.h>' + stat' + + Due to portability concerns, especially to systems that are not + fully standards-compliant, it is your responsibility to include + the correct files in the correct way. This requirement is + necessary in order to keep `gawkapi.h' clean, instead of becoming + a portability hodge-podge as can be seen in the `gawk' source code. + + To pass reasonable integer values for `ERRNO', you will also need + to include `<errno.h>'. * The `gawkapi.h' file may be included more than once without ill effect. Doing so, however, is poor coding practice. @@ -32134,117 +32150,117 @@ Ref: call-new-function876148 Node: Extension Future Growth878142 Node: Extension API Description878960 Node: Extension API Functions Introduction880288 -Node: General Data Types884486 -Ref: General Data Types-Footnote-1890119 -Node: Requesting Values890418 -Ref: table-value-types-returned891149 -Node: Constructor Functions892103 -Node: Registration Functions895099 -Node: Extension Functions895784 -Node: Exit Callback Functions897603 -Node: Extension Version String898846 -Node: Input Parsers899496 -Node: Output Wrappers908075 -Node: Two-way processors912468 -Node: Printing Messages914590 -Ref: Printing Messages-Footnote-1915667 -Node: Updating `ERRNO'915819 -Node: Accessing Parameters916558 -Node: Symbol Table Access917788 -Node: Symbol table by name918300 -Ref: Symbol table by name-Footnote-1920470 -Node: Symbol table by cookie920550 -Ref: Symbol table by cookie-Footnote-1924679 -Node: Cached values924742 -Ref: Cached values-Footnote-1928185 -Node: Array Manipulation928276 -Ref: Array Manipulation-Footnote-1929374 -Node: Array Data Types929413 -Ref: Array Data Types-Footnote-1932116 -Node: Array Functions932208 -Node: Flattening Arrays935974 -Node: Creating Arrays942807 -Node: Extension API Variables947602 -Node: Extension Versioning948238 -Node: Extension API Informational Variables950139 -Node: Extension API Boilerplate951225 -Node: Finding Extensions955059 -Node: Extension Example955606 -Node: Internal File Description956344 -Node: Internal File Ops960032 -Ref: Internal File Ops-Footnote-1971479 -Node: Using Internal File Ops971619 -Ref: Using Internal File Ops-Footnote-1973975 -Node: Extension Samples974241 -Node: Extension Sample File Functions975684 -Node: Extension Sample Fnmatch984157 -Node: Extension Sample Fork985883 -Node: Extension Sample Ord987097 -Node: Extension Sample Readdir987873 -Node: Extension Sample Revout989377 -Node: Extension Sample Rev2way989970 -Node: Extension Sample Read write array990660 -Node: Extension Sample Readfile992543 -Node: Extension Sample API Tests993298 -Node: Extension Sample Time993823 -Node: gawkextlib995130 -Node: Language History997511 -Node: V7/SVR3.1999033 -Node: SVR41001354 -Node: POSIX1002796 -Node: BTL1003804 -Node: POSIX/GNU1004538 -Node: Common Extensions1010073 -Node: Ranges and Locales1011180 -Ref: Ranges and Locales-Footnote-11015798 -Ref: Ranges and Locales-Footnote-21015825 -Ref: Ranges and Locales-Footnote-31016085 -Node: Contributors1016306 -Node: Installation1020602 -Node: Gawk Distribution1021496 -Node: Getting1021980 -Node: Extracting1022806 -Node: Distribution contents1024498 -Node: Unix Installation1029720 -Node: Quick Installation1030337 -Node: Additional Configuration Options1032299 -Node: Configuration Philosophy1033776 -Node: Non-Unix Installation1036118 -Node: PC Installation1036576 -Node: PC Binary Installation1037875 -Node: PC Compiling1039723 -Node: PC Testing1042667 -Node: PC Using1043843 -Node: Cygwin1048028 -Node: MSYS1049028 -Node: VMS Installation1049542 -Node: VMS Compilation1050145 -Ref: VMS Compilation-Footnote-11051152 -Node: VMS Installation Details1051210 -Node: VMS Running1052845 -Node: VMS Old Gawk1054452 -Node: Bugs1054926 -Node: Other Versions1058778 -Node: Notes1064093 -Node: Compatibility Mode1064680 -Node: Additions1065463 -Node: Accessing The Source1066390 -Node: Adding Code1067816 -Node: New Ports1073858 -Node: Derived Files1077993 -Ref: Derived Files-Footnote-11083301 -Ref: Derived Files-Footnote-21083335 -Ref: Derived Files-Footnote-31083935 -Node: Future Extensions1084033 -Node: Basic Concepts1085520 -Node: Basic High Level1086201 -Ref: figure-general-flow1086472 -Ref: figure-process-flow1087071 -Ref: Basic High Level-Footnote-11090300 -Node: Basic Data Typing1090485 -Node: Glossary1093840 -Node: Copying1119151 -Node: GNU Free Documentation License1156708 -Node: Index1181845 +Node: General Data Types884988 +Ref: General Data Types-Footnote-1890621 +Node: Requesting Values890920 +Ref: table-value-types-returned891651 +Node: Constructor Functions892605 +Node: Registration Functions895601 +Node: Extension Functions896286 +Node: Exit Callback Functions898105 +Node: Extension Version String899348 +Node: Input Parsers899998 +Node: Output Wrappers908577 +Node: Two-way processors912970 +Node: Printing Messages915092 +Ref: Printing Messages-Footnote-1916169 +Node: Updating `ERRNO'916321 +Node: Accessing Parameters917060 +Node: Symbol Table Access918290 +Node: Symbol table by name918802 +Ref: Symbol table by name-Footnote-1920972 +Node: Symbol table by cookie921052 +Ref: Symbol table by cookie-Footnote-1925181 +Node: Cached values925244 +Ref: Cached values-Footnote-1928687 +Node: Array Manipulation928778 +Ref: Array Manipulation-Footnote-1929876 +Node: Array Data Types929915 +Ref: Array Data Types-Footnote-1932618 +Node: Array Functions932710 +Node: Flattening Arrays936476 +Node: Creating Arrays943309 +Node: Extension API Variables948104 +Node: Extension Versioning948740 +Node: Extension API Informational Variables950641 +Node: Extension API Boilerplate951727 +Node: Finding Extensions955561 +Node: Extension Example956108 +Node: Internal File Description956846 +Node: Internal File Ops960534 +Ref: Internal File Ops-Footnote-1971981 +Node: Using Internal File Ops972121 +Ref: Using Internal File Ops-Footnote-1974477 +Node: Extension Samples974743 +Node: Extension Sample File Functions976186 +Node: Extension Sample Fnmatch984659 +Node: Extension Sample Fork986385 +Node: Extension Sample Ord987599 +Node: Extension Sample Readdir988375 +Node: Extension Sample Revout989879 +Node: Extension Sample Rev2way990472 +Node: Extension Sample Read write array991162 +Node: Extension Sample Readfile993045 +Node: Extension Sample API Tests993800 +Node: Extension Sample Time994325 +Node: gawkextlib995632 +Node: Language History998013 +Node: V7/SVR3.1999535 +Node: SVR41001856 +Node: POSIX1003298 +Node: BTL1004306 +Node: POSIX/GNU1005040 +Node: Common Extensions1010575 +Node: Ranges and Locales1011682 +Ref: Ranges and Locales-Footnote-11016300 +Ref: Ranges and Locales-Footnote-21016327 +Ref: Ranges and Locales-Footnote-31016587 +Node: Contributors1016808 +Node: Installation1021104 +Node: Gawk Distribution1021998 +Node: Getting1022482 +Node: Extracting1023308 +Node: Distribution contents1025000 +Node: Unix Installation1030222 +Node: Quick Installation1030839 +Node: Additional Configuration Options1032801 +Node: Configuration Philosophy1034278 +Node: Non-Unix Installation1036620 +Node: PC Installation1037078 +Node: PC Binary Installation1038377 +Node: PC Compiling1040225 +Node: PC Testing1043169 +Node: PC Using1044345 +Node: Cygwin1048530 +Node: MSYS1049530 +Node: VMS Installation1050044 +Node: VMS Compilation1050647 +Ref: VMS Compilation-Footnote-11051654 +Node: VMS Installation Details1051712 +Node: VMS Running1053347 +Node: VMS Old Gawk1054954 +Node: Bugs1055428 +Node: Other Versions1059280 +Node: Notes1064595 +Node: Compatibility Mode1065182 +Node: Additions1065965 +Node: Accessing The Source1066892 +Node: Adding Code1068318 +Node: New Ports1074360 +Node: Derived Files1078495 +Ref: Derived Files-Footnote-11083803 +Ref: Derived Files-Footnote-21083837 +Ref: Derived Files-Footnote-31084437 +Node: Future Extensions1084535 +Node: Basic Concepts1086022 +Node: Basic High Level1086703 +Ref: figure-general-flow1086974 +Ref: figure-process-flow1087573 +Ref: Basic High Level-Footnote-11090802 +Node: Basic Data Typing1090987 +Node: Glossary1094342 +Node: Copying1119653 +Node: GNU Free Documentation License1157210 +Node: Index1182347 End Tag Table |