[ Home Page ] [ Eiffel Archive ] [ Eiffel Classes and Clusters ]

Eiffel Class Tools

Written by Neil Wilson

• Targets Eiffel/S 1.3.
• Revision 1.3, 22 August 1993.

tool-1_3.tar.zip (60,790 bytes)

Licence

Gnu Library GPL - see file README.LIB

Requirements

• Eiffel/S 1.3
• Eiffel/S Container cluster
• Eiffel/S Basic cluster
• Eiffel/S File cluster
• Neil Wilson's Command-line Arguments Processing cluster.

SHORT CLASS ABSTRACTION TOOL

Produces an abstract version of the input Eiffel class text files on the standard output.

Usage

short [--abstract] [--eiffel] [--full] [--help] [--parents] [--version]     [--blank number] [--column number] [--view class_name] [-Vefhp]     [-b number] [-c number] [-l class_name] [filename ...]

Short outputs the information required by a client to use the class on the standard output.

If no filenames are present the standard input is parsed for an Eiffel class, otherwise each file in turn is parsed and output.

By default the inheritance clause, obsolete features, and routine implementation details are discarded. All assertions, header comments, constant details and class/type modifiers (deferred, expanded, separate) are retained.

Short supports the following options:

-V, --version, -h, --help	Displays the 'short' version information and gives the usage help message for the command.
-e, --abstract, --eiffel	Produces a fully deferred version of the input class(es) which will compile just like any other class (hopefully :-)
-l <class_name>,  --view <class_name>	Produces the output from the point of view of the class <class_name> - the "short form for <class_name>". Special handling for ANY and NONE of course. By default short outputs the "short form for ANY".
-f, --full	Produces the short form including all the feature blocks. (Implemented as the "short form for NONE".)
-p, --parents	Retains the inheritance clause in the output. The default is to drop it
-b <number>, --blank <number>	Indent levels by <number> characters.
-c <number>, --column <number>	Width of the output is <number> characters. Should be greater than 20.

Output conforms to layout guidelines for short, such as they are.

LONG CLASS PRETTY-PRINT TOOL

Produces a 'pretty-printed' version of the input Eiffel class text files on the standard output.

Usage

long [--help] [--version] [--blank number] [--column number] [-Vh]     [-b number] [-c number] [filename ...]

Long formats the class text according to a layout standard.

If no filenames are present the standard input is parsed for an Eiffel class, otherwise each file in turn is parsed and output.

Long supports the following options:

-V, --version, -h, --help	Displays the 'long' version information and gives the usage help message for the command.
-b <number>, --blank <number>	Indent levels by <number> characters.
-c <number>, --column <number>	Width of the output is <number> characters. Should be greater than 20.

Output conforms to the ETL Appendix A layout guidelines

Tool restrictions

• Tools expect classes that have been compiled cleanly. Both tools only do straightforward syntax checking.Short retains unavailable clauses in post-conditions and invariants. (Pre-conditions can't have unavailable clauses, validity clause VAPE deals with those.)
• Short retains unavailable inherited classes and features.
• Tools currently outputs ASCII text only. Bold and italics are not displayed. No other format is available.
• Comment and string output processing is primitive.
• Lines tend to break at awkward spots.
• Long discards free comments.

Technical Comments

Thanks to David Morgan for the ELEXER Eiffel 3 parser plus his previous versions of short. Both tools are really only a tiny modification of his work.

Comments and suggestions for improvements always welcomed.

[ Home Page ] [ Eiffel Archive ] [ Eiffel Classes and Clusters ]