fpp.1

变尺度法的源程序

.\" @(#)fpp.1 1.1 96/06/05 SMI; from S5R3
.na
.TH fpp 1 "19 Aug 1996"                    
.SH NAME
fpp \- the Fortran language preprocessor for FORTRAN 77 and Fortran 90.
.SH SYNOPSIS
.B fpp 
[
.B options
] [
.I input-file
[
.I output-file
] ]
.SH DESCRIPTION
.B fpp 
is the  preprocessor  for FORTRAN 77 and Fortran  90.
.B fpp  
optionally  accepts  two  filenames  as   arguments.
input-file and output-file  are, respectively, the  input file read
and the output file written by the preprocessor.  By default 
standard input and output are used.
.B fpp 
should be used instead of the cpp preprocessor
with the Sun FORTRAN 77 compiler.
.SH OPTIONS
.TP
.BI \-c_com = {yes|no}
By default, C style 
.B comments 
are recognized. Turn this off by specifying
.I -c_com=no
.TP
.BI \-D name
Define the preprocessor variable
.I name 
as 1 (one). This
is the same as if a
.BI \-D name=1
option appeared on the
.B fpp 
command line, or as if a
.RS
.IP
.BI #define " name " 1 
.RE
.IP
line appeared in the source file, which is processed by 
.B fpp.
.br
.ne 5

.TP
.BI \-D name = def
Define
.I name
as if by a
.B #define
directive.
This is the same as if a
.RS
.IP
.BI #define " name " def
.RE
.IP
line appeared in the source file that 
.B fpp
is processing.
The
.B \-D
option has lower precedence than the
.B \-U
option.
That is, if the same name is used in both a
.B \-U
option and a
.B \-D
option, the name will be undefined regardless of the order of the options.
.TP
.BI \-fixed
Assumes fixed format input source.
.TP
.BI \-free
Assumes free format input source.
.TP
.BI \-I directory
Insert 
.I directory
into the search path for
.B #include
files with names not beginning with
.RB  ` / '.
.I directory
is inserted ahead of the
standard list of ``include'' directories.
Thus,
.B #include
files with names enclosed in
double-quotes (\f3"\f1)
are searched for first in the directory of the file with the
.B #include
line, then in directories named with
.B \-I
options, and lastly, in directories from the standard list.
For
.B #include
files with names enclosed in angle-brackets
.RB  ( <\|> ),
the directory of the file with the
.B #include
line is not searched.
.TP
.BI \-M
Generate a list of makefile dependencies and
.B write
them to the standard output. This list
indicates that the object file which would be
generated  from the input file depends on the
input file  as  well  as  the  include  files
referenced.
.TP
.BI \-macro = {yes|no_com|no}
By default, macros are expanded 
.B everywhere.
Turn off macro expansion in comments by specifying
.I -macro=no_com
and turn off macro expansion all together by specifying
.I -macro=no
.TP
.BI \-P  
Do not put line numbering directives to the output file. This directive appears
as
.RS
\f2#line-number file-name\f1
.RE
.TP
.BI \-U name
Remove any initial definition of
.IR name ,
where
.I name
is a 
.B fpp
variable that is predefined by a particular preprocessor.
Here is a partial list of symbols that may be predefined, depending upon
the architecture of the system:
.RS
.RS
.TP 20
Operating System:
.PD 0
.BR unix ,
.BR __unix ,
.BR and __SVR4
.TP 20
Hardware:
.BR sun ,
.BR __sun ,
.BR sparc ,
.BR and __sparc
.PD
.RE
.RE
.TP
.BI \-undef
Remove initial definitions for all predefined symbols.
.TP
.BI \-w0
Don't output warnings from
.B fpp 
to stderr.
.TP
.B \-Xu 
Convert upper-case letters 
.B to 
lower-case, except within character-string constants. The default is 
to not convert upper-case letters  to  lower-case.
.TP
.BI \-Xw
For fixed form source files (See below)
.B fpp
assumes that the symbol ' ' (space) is insignificant.
By default for this form the 'space' symbol is the
delimiter of tokens.
.TP
.BI \-Y directory
Use the specified 
.BI " directory "
in place of the 
standard list of directories when searching for
.B#include
files.
.TP
.B fpp 
also understands some FORTRAN 77 compiler options (See f77(1)):
.TP
.BI \-e  
Accept extended source lines, up to 132 characters
long.
.TP
.BI \-w 
Do not output warnings to stderr.
.SH USAGE
.SS Source files
.LP
.B fpp
operates on both fixed and free form
source files. Files with '.F' extension are assumed to be in
fixed form, and files with '.F90' extensions (and all others) are 
assumed to be in free form by default. There is the '-fixed' option 
for using fixed form in Fortran 90. 
.B fpp 
recognizes the tab format of a source line when in 
fixed mode.
.LP
A source file may contain 
.B fpp 
tokens. 
.B fpp 
tokens are close
to those of Fortran. They are:
.RS
.TP
- 
fpp directive names.
.TP
- 
symbolic names including Fortran keywords. fpp
permits all symbols in names that Fortran does.
.TP
- 
constants. Integer, real, double and quadruple
precision, binary, octal, hexadecimal including
alternate notation, character and hollerith.
.TP
- 
comments. There are Fortran comments and 
.B fpp
comments.
.TP
- 
others. Special characters, space, tab, newline, etc.
.RE
.SS Output
Output consists of a modified copy of the input,
plus lines of the form:

     \f2#line_number  file_name\f1
.LP
inserted to indicate the original source line number and filename of
the output line that follows.
There is the '-P' option (See above) which disables the generation
of these lines.
.SS Directives
Syntax and semantics of 
.B fpp 
directives are the same as 
.B cpp
directives (See cpp(1)).
.LP
All 
.B fpp 
directives  start with the hash symbol (#)  as the
first character on a line. White space (SPACE or TAB
characters) can  appear after the initial '#' for proper
indentation.  The  directives can be divided  into the following
groups:  
.LP
- macro definitions;
.LP
- conditional source code selection;
.LP
- inclusion of external files;
.LP
- line control.
.SS Macro definition.
.LP
The #define directive is used to define both simple string variables and 
more complicated macros:
.LP
\f3#define \f2name  token-string\f1
.LP
This is the definition of a 
.B fpp 
variable. Wherever 'name' appears in the source lines 
following the definition, 'token-string' will be substituted for 'name'.
.LP
\f3#define \f2name(argument [, argument] ...  )  token-string\f1
.LP
This is the definition of a function-like macro.
Occurrences of the macro 'name' followed by
the comma-separated list of arguments within parentheses
are substituted by the token string
produced from the macro definition. Every occurrence
of an argument identifier from the macro definition's arguments list is
substituted by the token sequence representing the
corresponding macro actual argument.
.LP
In these definitions, spaces between the macro name and
the '(' symbol are prohibited to prevent the
directive being interpreted as a 
.B fpp 
variable
definition with the rest of the line beginning
with the '(' symbol being interpreted as a token-string.
.LP
\f3#undef \f2name\f1
.LP
Remove any definition for 'name' (produced by 'D' options,
#define directives or by default). No additional tokens 
are permitted on the directive line after the name.
.SS Including External Files.
There are two forms of file inclusion:
.LP
\f3#include "\f2filename\|\f3"\f1
.LP
.BI #include " " < filename >
.LP
Read in the contents of filename at this location.  
The lines read in from the file are processed by
.B fpp 
as  if it were a part
of the current file. 
.LP
When the  <filename> notation
is  used, filename is only searched for in the
standard ``include'' directories.  See the 'I' and 'Y' 
options above for more detail.
No additional tokens are permitted in the directive
line after the final  `"'  or `>'.
.SS Line control.
.LP
\f2#line-number "filename"\f1
.LP
Generate line control information for the next  pass
of the compiler. The integer-constant is  interpreted
as the line number of  the next line and the filename
is  interpreted  as the name of the file from where it comes.
If "filename" is not given, the current filename is
unchanged.  
.SS Conditional selection of source text.
There are two forms of conditional selection of source text
.LP
.TP 
1) 
      \f3#if \f2condition_1\f1
           block_1
      \f3#elif \f2condition_2\f1
           block_2
      \f3#else\f1 
           block_n
      \f3#endif\f1
.TP 
2)
      \f3#ifdef \f2name\f1
           block_1
      \f3#elif \f2condition\f1
           block_2
      \f3#else\f1
           block_n
      \f3#endif\f1
.TP
or
      \f3#ifndef \f2name\f1