---

3.4 AutoGen Scheme Functions

AutoGen uses Guile to interpret Scheme expressions within AutoGen macros. All of the normal Guile functions are available, plus several extensions (see Common Scheme Functions) have been added to augment the repertoire of string manipulation functions and manage the state of AutoGen processing.

This section describes those functions that are specific to AutoGen. Please take note that these AutoGen specific functions are not loaded and thus not made available until after the command line options have been processed and the AutoGen definitions have been loaded. They may, of course, be used in Scheme functions that get defined at those times, but they cannot be invoked.

• ag-fprintf - format to autogen stream
• ag-function? - test for function
• base-name - base output name
• chdir - Change current directory
• count - definition count
• def-file - definitions file name
• def-file-line - get a definition file+line number
• dne - "Do Not Edit" warning
• emit - emit the text for each argument
• emit-string-table - output a string table
• error - display message and exit
• exist? - test for value name
• find-file - locate a file in the search path
• first-for? - detect first iteration
• for-by - set iteration step
• for-from - set initial index
• for-index - get current loop index
• for-sep - set loop separation string
• for-to - set ending index
• found-for? - is current index in list?
• get - get named value
• get-c-name - get named value, mapped to C name syntax
• get-down-name - get lower cased named value, mapped to C name syntax
• get-up-name - get upper cased named value, mapped to C name syntax
• high-lim - get highest value index
• insert-file - insert the contents of a (list of) files.
• insert-suspended - insert a named suspension in current output
• last-for? - detect last iteration
• len - get count of values
• low-lim - get lowest value index
• make-header-guard - make self-inclusion guard
• make-tmp-dir - create a temporary directory
• match-value? - test for matching value
• max-file-time - get the maximum input file modification time
• mk-gettextable - print a string in a gettext-able format
• out-delete - delete current output file
• out-depth - output file stack depth
• out-emit-suspended - emit the text of suspended output
• out-line - output file line number
• out-move - change name of output file
• out-name - current output file name
• out-pop - close current output file
• out-push-add - append output to file
• out-push-new - purge and create output file
• out-resume - resume suspended output file
• out-suspend - suspend current output file
• out-switch - close and create new output
• output-file-next-line - print the file name and next line number
• set-option - Set a command line option
• set-writable - Make the output file be writable
• stack - make list of AutoGen values
• stack-join - stack values then join them
• suffix - get the current suffix
• tpl-file - get the template file name
• tpl-file-line - get the template file+line number
• tpl-file-next-line - get the template file plus next line number
• warn - display warning message and continue
• autogen-version - autogen version number
• format file info as, “#line nn "file"”