NAME

ada.format − Ada source program formatter

SYNOPSIS

ada.format [ -c | -i | -s ] [ -k ] [ -m ] [ -p ] [ -t n ] file

Remarks:

This command requires installation of optional Ada software (not included with the standard HP-UX operating system) before it can be used. 

DESCRIPTION

Ada.format takes an Ada source file and produces a listing of the formatted source on the standard output.  Ada.format requires the source file suffix to be .ad?, where ? is any single alphanumeric character.  If the source contains any syntax errors, ada.format terminates with a diagnostic error message and the line number indicating where the first error occurred.  No listing of the formatted source is generated. 

By default, ada.format formats the Ada source file according to the syntactic structure used in the Reference Manual for the Ada Programming Language.  The extent and nature of the transformations performed can be optionally controlled by specifying ada.format options and by using pragma INDENT within the source file to protect regions of source from being formatted. 

The following options are recognized:

−c Capitalize the first letter of each word component (separated by underscore) of an identifier.  By default, identifiers are converted to uppercase.  Only one of the options -c, −i or −s may be selected. 

−i All identifiers are converted to lowercase.  By default, identifiers are converted to uppercase.  Only one of the options -c, −i or −s may be selected. 

−k All Ada keywords are converted to uppercase.  By default, keywords are converted to lowercase. 

−m Parameters of unspecified mode (by implication, mode in) are converted to explicit in parameters.  Note that if either the specification or body of a unit is formatted with this option while the other is not, the compiler indicates that the two parameter specifications do not conform, according to the Reference Manual for the Ada Programming Language [6.3.1 (8)]. 

−p The source structure is preserved so that each source line is treated as an indivisible entity.  The source structure is indented according to its lexical elements, but individual source lines are not restructured. 

−s All of the identifiers are preserved as in the source file.  By default, identifiers are converted to uppercase.  Only one of the options -c, −i or −s may be selected. 

−t  n Use n spaces for indentation; legal range 2 .. 6, default 3. 

Use of the pragma INDENT in the source file has the following effects:

pragma INDENT (OFF); Disable ada.format so that subsequent source lines are not formatted. 

pragma INDENT (ON); Enable ada.format so that subsequent source lines are formatted. 

Environment Variables

The environment variable ADA_PATH is associated with all components of the Ada compilation system.  It must be set properly and exported before any component of the Ada compilation system (including ada.format) can be used (see ada(1), Environment Variables). 

AUTHOR

Ada.format was developed by HP and Alsys. 

FILES

$ADA_PATH/ada.format Ada source program formatter command. 

$ADA_PATH/ada.format.bin
Ada source program formatter subprocess.

SEE ALSO

ada(1), ada.fmgr(1), ada.funlock(1), ada.lmgr(1), ada.lsfam(1), ada.lslib(1), ada.make(1), ada.mkfam(1), ada.mklib(1), ada.mvfam(1), ada.mvlib(1), ada.probe(1), ada.protect(1), ada.rmfam(1), ada.rmlib(1), ada.umgr(1), ada.unlock(1), ada.xref(1),

Ada User’s Guide (Series 300),

Ada Tools Manual (Series 300).

EXTERNAL INFLUENCES

International Code Set Support

Single-byte character code sets are supported within file names. 

Hewlett-Packard Company  —  HP-UX Release 7.0: Sept 1989