fpt Reference: BUILD DATA DICTIONARY

fpt and WinFPT Reference Manual - Command-line Commands

| SimCon Home | Ref Manual Home |

BUILD DATA DICTIONARY

Syntax:

[BUILD] DATA DICTIONARY
DO NOT BUILD DATA DICTIONARY

Function:

The DATA DICTIONARY command generates a data dictionary for the entire program in the form of Fortran INCLUDE files. Four files are generated:

name_par.fpi

- An INCLUDE file for the declaration of all Fortran PARAMETERS and STRUCTURES.

name_stf.fpi

- An INCLUDE file for statement functions.

name_cmn.fpi

- An INCLUDE file for the declaration of all static variables. Local variables are moved to new COMMON blocks. The structure of existing COMMON blocks is preserved, and new EQUIVALENCE statements are written so as to make explicit any implied equivalences through differences in naming of COMMON block locations in different sub-programs. All variables are given unique names.

name_bda.fpi

- A primary file for a new BLOCK DATA sub-program. This sub-program contains all DATA statements in the program.
PLEASE REMEMBER TO COMPILE AND LINK THIS SUB-PROGRAM

The objects in the data dictionary are declared one to each line. trailing comments attached to the original declarations are transcribed to the data dictionary. INCLUDE statements are written in all sub-programs for the new INCLUDE files.

The data dictionary is a complete representation of the static memory space of the program. It is useful in documentation, and in removing sub-program arguments in order to optimise for speed of execution.

There is a disadvantage that all objects are declared in all sub-programs, and this may lead to long compilation times. Also, moving all static variables to COMMON blocks may interfere with compiler optimisations.

A sub-set of the data dictionary is generated during inline expansion of subroutines and functions. This contains only the objects declared in the sub-programs which are expanded inline.

Where to Use this Command

Operating system command line	Yes
Configuration file, config.fsp	No
Specification (fsp) files, *.fsp	Yes
Interactively, to FPT> prompt	Yes
Interactive command files	Yes
Embedded in the Fortran code	No

Default

The data dictionary is not built by default (Note that defaults may be changed in the configuration file).

Examples

On the operating system command-line:

$ fpt "%data dictionary" anova.fsp