Ada Resources

Ada 95 Pretty Printer (based on ASIS)


written by Armin Descloux (java interface by Jörg Kienzle)

This package contains the following formatting utilities:

  • format_identifiers
  • format_keywords
  • format_numbers
  • ada2html

It also provides a java-based user interface.

General Description

The following paragraphs describe the different formatting utilities in more detail.

format_identifiers
------------------

NAME
   format_identifiers

SYNOPSIS
   format_identifiers ( [ -lower | -upper | -mixed ]
                        [ -a name ] ) filename
   format_identifiers -h

DESCRIPTION
   format_identifiers takes the Ada source file with the given
   filename. It formats all identifiers to the specified case
   and displays the result on the standard output.
   By default, identifiers are formatted to mixed case.

OPTIONS
   The following options are available in format_identifiers:

   -lower | -l    Format identifiers to lower case.

   -upper | -u    Format identifiers to upper case.

   -mixed | -m    Format identifiers to mixed case.

   -a name        The file «name» contains abbreviations
                  always to be written in upper case.
                  At most one abbreviation per line is
                  expected. Comments starting with «--» are
                  allowed to the end of a line.

   -h             Display this manual page.

OPERANDS
   filename       The file whose identifiers are to be
                  formatted. It has to reside in the working
                  directory.

format_keywords
---------------

NAME
   format_keywords

SYNOPSIS
   format_keywords [ -lower | -upper ] filename
   format_keywords -h

DESCRIPTION
   format_keywords takes the Ada source file with the given
   filename. It formats all reserved words to the specified
   case and displays the result on the standard output.
   By default, reserved words are formatted to lower case.

OPTIONS
   The following options are available in format_keywords:

   -lower | -l    Format reserved words to lower case.

   -upper | -u    Format reserved words to upper case.

   -h             Display this manual page.

OPERANDS
   filename       The file whose reserved words are to be
                  formatted. It has to reside in the working
                  directory.

format_numbers
--------------

NAME
   format_numbers

SYNOPSIS
   format_numbers filename
   format_numbers -h

DESCRIPTION
   format_numbers takes the Ada source file with the given
   filename. It formats all numeric literals and displays the
   result on the standard output.

OPTIONS
   The following option is available in format_numbers:

   -h             Display this manual page.

OPERANDS
   filename       The file whose numeric literals are to be
                  formatted. It has to reside in the working
                  directory.

ada2html
--------

NAME
   ada2html

SYNOPSIS
   ada2html [ -r style ] [ -c style ] filename
   ada2html -h

DESCRIPTION
   ada2html takes the Ada source file with the given filename.
   It creates an HTML output of the file and displays it on
   the standard output.

OPTIONS
   The following options are available in ada2html:

   -r style       Format reserved words to the specified style.

   -c style       Format comments to the specified style.

   For both options, acceptable values for style are defined
   below:
                  bold | b       Format to bold.
                  italics | i    Format to italics.

OPERANDS
   filename       The Ada source file which has to be converted
                  to HTML. It has to reside in the working
                  directory.

remove_tags
-----------

NAME
   remove_tags

SYNOPSIS
   remove_tags -bold | -italics

DESCRIPTION
   remove_tags reads an HTML file from the standard input.
   It removes tag sequences of a line, either   or
    . The result is written on the standard output.

OPTIONS
   The following options are available in remove_tags:

   -bold | -b     Remove all tag sequences   of a line.

   -italics | -i  Remove all tag sequences   of a line.

   For both options, the case of the tags is of no importance.
   So, as an example, there is no difference neither between
   <b> and <B> nor between </b> and </B>.
   Between an opening and a closing tag, there might be any
   number of spaces.


Installation

  • Get an ASIS version.
  • Get the file format.tar.gz
  • Decompress the file format.tar.gz with the following commands:
    • gunzip format.tar.gz
    • tar -xvf format.tar

    You obtain a directory ~/formatting_utilities.

  • Change the Makefile:
    The LDIR, IDIR and OBJ paths should point to the corresponding asis files
  • Execute make


EPFL | IC | LGL | Teaching | Ada
URL: http://lgl.epfl.ch/ada/formatter.html
Last modified 10/22/2002, Webmaster.