All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class epp.Epp

java.lang.Object
   |
   +----epp.Epp

public class Epp

extends Object

When you execute the "epp" command from the command line, initially, a program called "EPP main routine" will be invoked. The EPP main routine will first interpret optional arguments specified at the command line. Then, it will compare the timestamps of the specified files to select the files to expand and will begin expanding those files.

Files are processed as follows. First, the files are scanned and a list of plug-ins specified by the #epp command is created. Following that, system mixins that comprise the "standard Java preprocessor" and all system mixins that were specified by the #epp command are combined together to build a single class. (This is not a Java class but an Ld-2 class.) Then, an instance of that class is created, its initialization method is called, and the file conversion process begins.

Plug-ins cannot extend the behaviour of an Epp class. Instead, a subclass of an Epp class can be created and invoked to extend the behaviour of the main routine. Assuming this approach will be taken, most of the methods of the Epp class are defined as non-static methods.

Epp()

allOptions()

checkEppoutDirectory()

collectEppCommands(String)

collectInputFileNames(String, Vector)

eppCommandUsage(EppInputStream)

eppMain(String[])

Called from main and is the actual main routine.

eppMainRoutineError(String)

error(String)

Throws EppUserError.

fatal(String)

Throws a fatal error message.

getClassNameFromFileName(String)

Retrieves the class name from a file name.

globalEpp(String[])

importantOptions()

isGeneratedFile(String)

Returns true if the file specified by path is a "file generated by EPP or javac", and otherwise returns false.

loadDefaultConfiguration()

main(String[])

Calls eppMain, which is the actual main routine.

makeEppGlobalProcessor()

makeEppObject(String, String, Object[][])

makeEppPreProcessor(String, String)

makeFileInfo(String, Obj, Hashtable, DVenv)

makeInputFileNameList(String[], int)

parseEppCommand(EppInputStream, Vector)

parseOption(String[], int)

printAllOptions()

printUsage()

processFiles(String[], int)

processFilesAndCatchEppUserError(String[], int)

processPhase1(FileInfo)

processPhase2(FileInfo)

separateEpp(String[])

skipComment(EppInputStream)

skipSpace(EppInputStream)

 public Epp()

 public static void main(String argv[])

Calls eppMain, which is the actual main routine. This method is called when epp is invoked. The implementation is shown below.

    new Epp().eppMain(argv);

See Also:

eppMain

 public void eppMain(String argv[])

Called from main and is the actual main routine.

See Also:

main

 public int parseOption(String argv[],
                        int argp)

 public void printUsage()

 public void printAllOptions()

 public String[] importantOptions()

 public String[] allOptions()

 public void checkEppoutDirectory()

 public void processFilesAndCatchEppUserError(String argv[],
                                              int argp)

 public void processFiles(String argv[],
                          int argp)

 public String[] makeInputFileNameList(String argv[],
                                       int argp)

 public void collectInputFileNames(String inputFileName,
                                   Vector names)

 public void globalEpp(String inputFileNames[])

 public FileInfo makeEppGlobalProcessor()

 public void separateEpp(String inputFileNames[])

 public FileInfo makeEppPreProcessor(String inputFileName,
                                     String outputFileName)

 public void processPhase1(FileInfo fileInfo)

 public void processPhase2(FileInfo fileInfo)

 public FileInfo makeEppObject(String inputFileName,
                               String outputFileName,
                               Object eppCommands[][])

 public FileInfo makeFileInfo(String inputFileName,
                              Obj preprocessor,
                              Hashtable classTable,
                              DVenv env)

 public void loadDefaultConfiguration()

 public Object[][] collectEppCommands(String inputFileName)

 public void parseEppCommand(EppInputStream in,
                             Vector commands)

 public Error eppCommandUsage(EppInputStream in)

 public void skipSpace(EppInputStream in)

 public void skipComment(EppInputStream in)

 public Error eppMainRoutineError(String str)

 public static String getClassNameFromFileName(String inputFileName)

Retrieves the class name from a file name. For example, this utility can retrieve the class name "File" from the file name "foo/bar/File.java".

 public static boolean isGeneratedFile(String path)

Returns true if the file specified by path is a "file generated by EPP or javac", and otherwise returns false. If the return value is true, EPP assumes it may overwrite the file completely.

See Also:

emit1

 public static Error error(String str)

Throws EppUserError. Call this method when a user generated error occurs. User generated errors are EPP and EPP plug-in user (normal Java programmers) errors that may be caused by input program syntax errors, for example.

EppUserError exceptions are normally caught and handled by the EPP error recovery mechanism.

See Also:

error, fatal

 public static Error fatal(String str)

Throws a fatal error message. Call this method when a fatal error occurs. Fatal errors may be caused by errors such as a bug in the EPP main portion, a bug in an EPP plug-in, or a collision between EPP plug-ins. Typically, you would use this method as follows.

	throw Epp.fatal("message");

This method is defined as follows.

  public static Error fatal(String str){
    return new Error("EPP FATAL: "+ str);
  }

See Also:

error

All Packages  Class Hierarchy  This Package  Previous  Next  Index