ftnmangle: preprocessing mangle Fortran names

Overview

ftnmangle reads from one or more files and writes its output to standard output. The input is unchanged except for the following expressions:

FtnMangle(name)

Is replaced with the mangled form of name that the Fortran compiler would pass to the linker.

HasAltFtnMangle(name)

Is replaced with 1 if there is an alternate mangling for name and 0 if there is not.

AltFtnMangle(name)

Is replaced with the alternate mangled form of name that the Fortran compiler would pass to the linker.

The type of mangling done is controlled by command line options.

Invoking ftnmangle

The command-line syntax for ftnmangle is

     ftnmangle [-P] [-p style] [-a style] [files]

The files are processed in the order in which they appear on the command line. If - is used as a filename, ftnmangle will read from standard input. If no files are listed, ftnmangle reads from standard input.

-P disables the output of line control information for the C/C++ preprocessor.

-p controls the mangling done by FtnMangle and, if specified, -a controls the mangling done by AltFtnMangle. The style can be a combination of any of the following letters (for contradictory options, ftnmangle will exit with an error).

l

In the mangled name all uppercase letters are converted to lowercase.

c

In the mangled name all lowercase letters are converted to uppercase.

u

The mangled name has an underscore appended.

s

The mangled name has two underscores appended if the name already contained an underscore; otherwise a single underscore is appended.

The default style for FtnMangle() is to convert all uppercase letters to lowercase and to append an underscore. The default for the alternative name mangling is that HasAltFtnMangle() always returns 0 and AltFtnMangle() has has the same effect as FtnMangle(). When the -a option is supplied, HasAltFtnMangle() will return one if the alternate mangling is different than that given by FtnMangle( and AltFtnMangle() will apply the mangling set with the -a option.

Limitations

If multiple macros appear on the same line, the order of evaluation is that HasAltFtnMangle() macros are evaluated before AltFtnMangle() macros which are evaluated before FtnMangle() macros. For macros of the same type, the order of evaluation is from left to right. To be safe, it is best to avoid nesting macros or concatenating them without intervening whitespace or non-alphanumeric characters (i.e. HasAltFtnMangle(x)HasAltFtnMangle(x)).

modified $Date: 2003/12/09 05:24:24 $