AutoGen - The Automated Program Generator

For version 5.2, October 2001

This file documents AutoGen, a tool designed for generating program files that contain repetitive text with varied substitutions. This document is very long because it is intended as a reference document. For a quick start example, See section A Simple Example. For a simple example of Automated Option processing, See section Quick Start. For a full list of the Automated Option features, See section AutoOpts Features.

This edition documents version 5.2, October 2001.

• Introduction
  • The Purpose of AutoGen
  • A Simple Example
  • csh/zsh caveat
  • A User's Perspective
• AutoGen Definitions File
  • The Identification Definition
  • Named Definitions
    • Naming a Value
    • Definition List
    • Double Quote String
    • Single Quote String
    • Shell Output String
    • An Unquoted String
    • Scheme Result String
    • A Here String
    • Concatenated Strings
  • Dynamic Text
  • Controlling What Gets Processed
  • Pre-defined Names
  • Commenting Your Definitions
  • What it all looks like.
  • YACC Language Grammar
  • AutoGen without Definitions
• AutoGen Template
  • Format of the Pseudo Macro
  • Naming a value
  • Macro Expression Syntax
  • AutoGen Scheme Functions
    • `ag-function?' - test for function
    • `base-name' - base output name
    • `count' - definition count
    • `def-file' - definitions file name
    • `dne' - "Do Not Edit" warning
    • `error' - display message and exit
    • `error-source-line' - display of file & line
    • `exist?' - test for value name
    • `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
    • `get' - get named value
    • `high-lim' - get highest value index
    • `last-for?' - detect last iteration
    • `len' - get count of values
    • `low-lim' - get lowest value index
    • `match-value?' - test for matching value
    • `out-delete' - delete current output file
    • `out-depth' - output file stack depth
    • `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 current output file
    • `out-suspend' - suspend current output file
    • `out-switch' - close and create new output
    • `set-writable' - Make the output file be writable
    • `stack' - make list of AutoGen values
    • `suffix' - get the current suffix
    • `tpl-file' - get the template file name
    • `tpl-file-line' - get the template file and line number
  • Common Scheme Functions
    • `bsd' - Free BSD public license
    • `c-string' - emit string for ANSI C
    • `extract' - extract text from another file
    • `fprintf' - format to a file
    • `gperf' - perform a perfect hash function
    • `gpl' - GNU public license
    • `in?' - test for string in list
    • `join' - join string list with separator
    • `kr-string' - emit string for K&R C
    • `lgpl' - GNU lib public license
    • `license' - an arbitrary license
    • `make-gperf' - build a perfect hash function program
    • `max' - maximum value in list
    • `min' - minimum value in list
    • `prefix' - prefix lines with a string
    • `printf' - format to stdout
    • `raw-shell-str' - single quote shell string
    • `shell' - invoke a shell script
    • `shell-str' - double quote shell string
    • `shellf' - format a string, run shell
    • `sprintf' - format a string
    • `string-capitalize' - make a new string be capitalized
    • `string-capitalize!' - capitalize a string
    • `string-contains-eqv?' - caseless substring
    • `string-contains?' - substring match
    • `string-downcase' - make a new string be lower case
    • `string-downcase!' - make a string be lower case
    • `string-end-eqv-match?' - caseless regex ending
    • `string-end-match?' - regex match end
    • `string-ends-eqv?' - caseless string ending
    • `string-ends-with?' - string ending
    • `string-equals?' - string matching
    • `string-eqv-match?' - caseless regex match
    • `string-eqv?' - caseless string match
    • `string-has-eqv-match?' - caseless regex contains
    • `string-has-match?' - contained regex match
    • `string-match?' - regex match
    • `string-start-eqv-match?' - caseless regex start
    • `string-start-match?' - regex match start
    • `string-starts-eqv?' - caseless string start
    • `string-starts-with?' - string starting
    • `string->c-name!' - map non-name chars to underscore
    • `string-tr!' - convert characters
    • `string-upcase' - make a new string be upper case
    • `string-upcase!' - make a string be upper case
    • `sum' - sum of values in list
  • AutoGen Native Macros
    • AutoGen Macro Syntax
    • CASE - Select one of several template blocks
    • COMMENT - A block of comment to be ignored
    • DEFINE - Define a user AutoGen macro
    • ELIF - Alternate Conditional Template Block
    • ELSE - Alternate Template Block
    • ENDDEF - Ends a macro definition.
    • ENDFOR - Terminates the FOR function template block
    • ENDIF - Terminate the IF Template Block
    • ENDWHILE - Terminate the WHILE Template Block
    • ESAC - Terminate the CASE Template Block
    • EXPR - Evaluate and emit an Expression
    • FOR - Emit a template block multiple times
    • IF - Conditionally Emit a Template Block
    • INCLUDE - Read in and emit a template block
    • INVOKE - Invoke a User Defined Macro
    • SELECT - Selection block for CASE function
    • UNKNOWN - Either a user macro or a value name.
    • WHILE - Conditionally loop over a Template Block
  • Redirecting Output
• Augmenting AutoGen
  • Shell Output Commands
  • Guile Macros
  • Guile Callout Functions
  • AutoGen Macros
• Invoking autogen
  • autogen usage help (-?)
  • templ-dirs option (-L)
  • override-tpl option (-T)
  • lib-template option (-l)
  • base-name option (-b)
  • definitions option
  • load-scheme option (-S)
  • load-functions option (-F)
  • skip-suffix option (-s)
  • select-suffix option (-o)
  • source-time option
  • equate option
  • writable option
  • loop-limit option
  • timeout option (-t)
  • trace option
  • trace-out option
  • show-defs option
  • show-shell option
  • define option (-D)
  • undefine option (-U)
• What Gets Installed Where
• Automated Option Processing
  • AutoOpts Features
    • loading rc files
    • saving rc files
    • process a text string for options
  • Competitive Feature Analysis
  • Quick Start
  • Option Definitions
    • Program Description Attributes
    • Option Attributes
      • Required Attributes
      • Common Option Attributes
      • Special Option Handling
      • Immediate Action Attributes
      • Option Conflict Attributes
      • Option Argument Specification
      • Option Argument Handling
    • Man and Info doc Attributes
    • Automatically Supported Options
    • Library of Standard Options
  • Programmatic Interface
    • Data for Option Processing
    • CLEAR_OPT( <NAME> ) - Clear Option Markings
    • COUNT_OPT( <NAME> ) - Definition Count
    • DESC( <NAME> ) - Option Descriptor
    • DISABLE_OPT_name - Disable an option
    • ENABLED( <NAME> ) - Is Option Enabled?
    • ERRSKIP_OPTERR - Ignore Option Errors
    • ERRSTOP_OPTERR - Stop on Errors
    • HAVE_OPT( <NAME> ) - Have this option?
    • ISSEL_OPT( <NAME> ) - Is Option Selected?
    • ISUNUSED_OPT( <NAME> ) - Never Specified?
    • OPTION_CT - Full Count of Options
    • OPT_ARG( <NAME> ) - Option Argument String
    • OPT_VALUE_name - Option Argument Value
    • RESTART_OPT( n ) - Resume Option Processing
    • SET_OPT_name - Force an option to be set
    • STACKCT_OPT( <NAME> ) - Stacked Arg Count
    • STACKLST_OPT( <NAME> ) - Argument Stack
    • START_OPT - Restart Option Processing
    • STATE_OPT( <NAME> ) - Option State
    • USAGE( exit-code ) - Usage invocation macro
    • VALUE_OPT_name - Option Flag Value
    • VERSION - Version and Full Version
    • WHICH_IDX_name - Which Equivalenced Index
    • WHICH_OPT_name - Which Equivalenced Option
    • teOptIndex - Option Index and Enumeration
    • OPTIONS_STRUCT_VERSION - active version
    • libopts procedures
  • Option Descriptor File
  • Using AutoOpts
  • AutoOpts for Shell Scripts
  • Automated `Invoking Info' Doc
  • Automated Man Pages
• Add-on packages for AutoGen
  • Automated Finite State Machine
  • Combined RPC Marshalling
  • Automated Event Management
  • Invoking columns
    • columns usage help (-?)
    • width option (-W)
    • columns option (-c)
    • col-width option (-w)
    • spread option
    • indent option (-I)
    • first-indent option
    • tab-width option
    • sort option (-s)
    • format option (-f)
    • separation option (-S)
    • line-separation option
    • by-columns option
    • input option (-i)
  • Invoking getdefs
    • getdefs usage help
    • defs-to-get option
    • ordering option
    • first-index option
    • input option
    • subblock option
    • filelist option
    • assign option
    • common-assign option
    • copy option
    • srcfile option
    • linenum option
    • output option
    • autogen option
    • template option
    • agarg option
    • base-name option
  • Replacement for Stdio Formatting Library
• Some ideas for the future.
• Concept Index
• Function Index

This document was generated on 27 October 2001 using the texi2html translator version 1.54.