com.goldencode.p2j.convert

Class ProgressTransformDriver

java.lang.Object

com.goldencode.p2j.convert.TransformDriver

com.goldencode.p2j.convert.ProgressTransformDriver

public class ProgressTransformDriver
extends TransformDriver

Provides a harness to drive the Progress 4GL to Progress 4GL transformation for a file or set of files.

This program provides a command line interface. See main(java.lang.String[]) for the syntax.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.convert.TransformDriver

TransformDriver.ExcludeCheck, TransformDriver.JobDefinition, TransformDriver.ListType, TransformDriver.ScanCheck

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	helpText Help text, which needs to be implemented in each subclass.
private static java.util.Map<java.lang.String,RunMode>	modes Associates mode names with detailed mode definitions.
private static java.lang.String	TITLE Job title, which needs to be implemented in each subclass.

Fields inherited from class com.goldencode.p2j.convert.TransformDriver

asts, DANGER_LIST, datanames, debug, dicts, job, mode, MSG_DEBUG, MSG_NONE, MSG_STATUS, MSG_TRACE, sdicts, source, spacer

Constructor Summary

Constructors

Constructor and Description
ProgressTransformDriver(TransformDriver.JobDefinition job) Creates an instance with a specific configuration.

Method Summary

Modifier and Type	Method and Description
protected void	back() Drive the back end of the transformation process using the file list of Progress ASTs that is already defined in this instance.
static void	main(java.lang.String[] args) Provides a command line interface for an end user to drive the scanning harness.
protected void	middle() Drive the transformation process using the file list of Progress ASTs that is already defined in this instance.

Methods inherited from class com.goldencode.p2j.convert.TransformDriver

cleanScanResults, convertSourceNamesToAstNames, convertSourceNamesToDictNames, createDatabaseList, deleteFiles, deleteFileSpecs, escapeRegex, executeJob, front, interpretRunMode, omitSchemaMetadata, printElapsed, printHeader, processCommandLine, processTrees, processTrees, replaceFilenameExtension, runCallGraphGenerator, runScanDriver, runSchemaLoader, syntax, zapFiles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

modes

private static final java.util.Map<java.lang.String,RunMode> modes

Associates mode names with detailed mode definitions.

TITLE

private static final java.lang.String TITLE

Job title, which needs to be implemented in each subclass.

See Also:

Constant Field Values

helpText

private static final java.lang.String[] helpText

Help text, which needs to be implemented in each subclass.

Constructor Detail

ProgressTransformDriver

ProgressTransformDriver(TransformDriver.JobDefinition job)

Creates an instance with a specific configuration.

Parameters:

job - The details of this driver run.

Method Detail

middle

protected void middle()
               throws ConfigurationException,
                      AstException,
                      SchemaException,
                      java.io.IOException

Drive the transformation process using the file list of Progress ASTs that is already defined in this instance. The user must have provided a TRPL rule-set to execute, otherwise this phase will be a NOP.

Specified by:

middle in class TransformDriver

Throws:

ConfigurationException - If there is problem reading/parsing the configuration.

AstException - If there is an problem processing ASTs.

SchemaException - If there is a problem with the schema.

java.io.IOException - If there is a problem with I/O.

back

protected void back()
             throws ConfigurationException,
                    AstException,
                    SchemaException,
                    java.io.IOException

Drive the back end of the transformation process using the file list of Progress ASTs that is already defined in this instance. Each AST will be anti-parsed back to Progress 4GL source code.

Specified by:

back in class TransformDriver

Throws:

ConfigurationException - If there is problem reading/parsing the configuration.

AstException - If there is an problem processing ASTs.

SchemaException - If there is a problem with the schema.

java.io.IOException - If there is a problem with I/O.

main

public static void main(java.lang.String[] args)

Provides a command line interface for an end user to drive the scanning harness.

The program will return a non-zero code if there is a fatal error running the conversion.

Syntax:

 java -DP2J_HOME=<home> ProgressTransformDriver [-options]* <mode> [user_defined_rule_set] <file-specs>

Where:

• Options (F, S, and X are mutually exclusive. If none is specified is a list of files added to command line):
  • Dn = set debug level 'n' (must be a numeric digit between MSG_NONE (0) and MSG_TRACE (3) inclusive
  • I = incremental conversion; only changed/new programs will be parsed and converted.
  • F = <file-specs> is a <filename> containing a custom FILE-LIST, instead of using the explicit command line file list
  • S = <file-specs> is composed of a root <directory> and a "<file-filter>", to select SPECIFIC files instead of an explicit command line file list
  • X = <file-specs> is similar to S but has an additional custom EXCLUDE list file "<filename>" to be ignored
  • N = NO recursion in <file-filter> (S/X options)",
  • A = ABORT scan part of front end on an error
  • Tn = specify number of THREADS 'n' to use for front end file scan ('n' must be >= 0; defaults to 1; set to 0 to use 1 thread per available CPU)
  • L = LIST files to be processed only; do not perform any further task
  • Pname = the <name> of the configuration PROFILE follows the option
• mode (one or more of the following values, use '+' to delimit if there are two or more values; don't insert spaces!)
  • Front End
    • F0 = preprocessor (in honor cache mode), lexer, parser, AST persistence and post-parse fixups
    • F1 = F0 + forced preprocessor execution
    • F2 = F1 + schema loader/fixups
    • F3 = F2 + call graph generation
  • Transformation
    • TR = execute a user-defined transformation ruleset (this requires an extra parameter after the mode and before the source file specifications)
  • Anti-Parsing
    • AP = output ASTs to Progress 4GL source code
• The optional user_defined_rule_set specifies the user-defined rule-set filename to execute (only some modes support this, see sub-class documentation for details)
• explicit command line list (default approach if none of S, P, or F are present)
  • <filelist> is arbitrary list of absolute and/or relative file names to scan, this list is hard coded in the command line itself
  • any number of files may be listed on the command line, subject to command shell limits
• custom file list (FILE approach)
  • <filename> is a single absolute or relative filename of a text file that contains a custom list of absolute and/or relative file names of files to scan
  • in other words, the file list will be read from a file instead of being hard coded on the command line
  • there must be one filename per line in the file
  • there is no limit of the number of files in the list
• file-spec mode (expressly SPECIFIED files approach)
  • <directory> is the root directory to search for files
  • "filespec" is the file specification that will be used to create a list of files to process, should be enclosed in double quotes if any of the wildcard characters '*' or '?' are used
• custom ignore list (file-spec mode with additional EXCLUDE list)
  • <directory> is the root directory to search for files
  • "filespec"" is the file specification that will be used to create a list of files to process, should be enclosed in double quotes if any of the wildcard characters '*' or '?' are used
  • <filename> is a single absolute or relative filename of a text file that contains a custom list of specifications of file names to ignore
  • asterisk (*) and question mark (?) wildcards are permitted to represent zero or more and exactly one wildcard characters, respectively
  • files specified by the primary filespec which are not matched by the ignore list are scanned as they would be in filespec mode.

Parameters:

args - List of command line arguments.