Main (LBJava 1.2.22 API)

java.lang.Object
- edu.illinois.cs.cogcomp.lbjava.Main

public class Main
extends Object

LBJava's command line interface. Passing a source file to this class will invoke LBJava's frontend and optimization passes, resulting in the execution of the source file's code including creation of java files that implement the source file's semantics.

LBJava stands for Learning Based Java. LBJava is a language for building systems that learn.

Usage:

java edu.illinois.cs.cogcomp.lbjava.Main [options] <source file>

where [options] is one or more of the following:

`-c`	Compile only: This option tells LBJava to translate the given source to Java, but not to compile the generated Java sources or do any training.
`-d <directory>`	Any class files generated during compilation will be written in the specified directory, just like `javac`'s `-d` command line parameter.
`-j <a>`	Sends the contents of `<a>` to `javac` as command line arguments while compiling. Don't forget to put quotes around `<a>` if there is more than one such argument or if the argument has a parameter.
`-s`	Print the names of all declarations and quit.
`-t <n>`	Enables default progress output during training. A message is printed every `<n>` examples while training any classifier whose `learn` expression doesn't contain a `progressOutput` clause.
`-v`	Prints the version number and exits.
`-w`	Disables the output of warning messages. Currenlty, there are only two types of warnings. A warning is reported if a constraint declaration does not contain any constraint statements, and a warning is reported if a learner's type is less specific than the declared type of the classifier it's being used in.
`-x`	Clean: Delete all files that would otherwise be generated. No code is generated and no training takes place.
`-generatedsourcepath <directory>` `-gsp <directory>`	LBJava will potentially generate many Java source files. Use this option to have LBJava write them to the specified directory instead of the current directory. `<directory>` must already exist. Note that LBJava will also compile these files which can result in even more class files than there were sources. Those class files will also be written in `<directory>` unless the `-d` command line parameter is utilized as well.
`-sourcepath <path>`	If the LBJava source depends on classes whose source files cannot be found on the user's classpath, specify the directories where they can be found using this parameter. It works just like `javac`'s `-sourcepath` command line parameter.
`--parserDebug`	Debug: Debug output for parse phase only.
`--lexerOutput`	Lexer output: Print lexical token stream and quit.
`--parserOutput`	Parser output: Print the parsed AST and quit.
`--semanticOutput`	Semantic analysis output: Print semantic analysis information and quit.

Author:: Nick Rizzolo

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`classDirectory` The directory in which Javac will place class files (with subdirectories mimicing the package name included).
`static String`	`classPackageDirectory` The directory in which class files should be written, not including the subdirectory structure that mimics the package.
`static String`	`classPath` The directory in which to search for source files.
`static boolean`	`clean` This flag is set to `true` if cleaning has been enabled on the command line.
`static boolean`	`concurrentTraining` This flag is set if concurrent training has been enabled.
`static HashSet<String>`	`fileNames` A list of names of files generated by the compiler, created as they are generated.
`static String`	`generatedSourceDirectory` The directory in which to write generated Java source files (with subdirectories mimicing the package name included).
`static String`	`javacArguments` Holds command line arguments to be sent to `javac` when compiling.
`static boolean`	`printSymbols` This flag is set if symbol printing is enabled on the command line.
`static String`	`sourceDirectory` The relative path to the LBJava source file.
`static String`	`sourceFileBase` The source file's name without the `.lbj` extension.
`static String`	`sourceFilename` The name of the LBJava source file as specified on the command line.
`static String`	`sourcePath` The directory in which to search for source files.
`static boolean`	`warningsDisabled` This flag is set if warnings have been disabled on the command line.

Constructor Summary

Constructors
Constructor and Description

Main()

Constructors
Constructor and Description
`Main()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(String[] args)` The main compiler driver.
`static void`	`PrintUsage()` Print a usage message.
`static void`	`runSemanticAnalysis(AST ast)` Runs the semantic analysis pass on the specified AST, then prints errors and warnings if they exist, and finally sets the `generatedSourceDirectory` and `classDirectory` variables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - clean
```
public static boolean clean
```
    This flag is set to true if cleaning has been enabled on the command line.
  - concurrentTraining
```
public static boolean concurrentTraining
```
    This flag is set if concurrent training has been enabled.
  - warningsDisabled
```
public static boolean warningsDisabled
```
    This flag is set if warnings have been disabled on the command line.
  - printSymbols
```
public static boolean printSymbols
```
    This flag is set if symbol printing is enabled on the command line.
  - sourceDirectory
```
public static String sourceDirectory
```
    The relative path to the LBJava source file.
  - sourceFilename
```
public static String sourceFilename
```
    The name of the LBJava source file as specified on the command line.
  - sourceFileBase
```
public static String sourceFileBase
```
    The source file's name without the .lbj extension.
  - javacArguments
```
public static String javacArguments
```
    Holds command line arguments to be sent to javac when compiling.
  - fileNames
```
public static HashSet<String> fileNames
```
    A list of names of files generated by the compiler, created as they are generated.
  - classDirectory
```
public static String classDirectory
```
    The directory in which Javac will place class files (with subdirectories mimicing the package name included).
  - classPackageDirectory
```
public static String classPackageDirectory
```
    The directory in which class files should be written, not including the subdirectory structure that mimics the package.
  - classPath
```
public static String classPath
```
    The directory in which to search for source files.
  - sourcePath
```
public static String sourcePath
```
    The directory in which to search for source files.
  - generatedSourceDirectory
```
public static String generatedSourceDirectory
```
    The directory in which to write generated Java source files (with subdirectories mimicing the package name included).
- Constructor Detail
  - Main
```
public Main()
```
- Method Detail
  - main
```
public static void main(String[] args)
                 throws Exception
```
    The main compiler driver. This method parses command line options and then calls all of LBJava's components.
    
    Parameters:
    
    args - The user's command line arguments are found here.
    
    Throws:
    
    Exception - An exception is thrown when any error occurs.
  - runSemanticAnalysis
```
public static void runSemanticAnalysis(AST ast)
```
    Runs the semantic analysis pass on the specified AST, then prints errors and warnings if they exist, and finally sets the generatedSourceDirectory and classDirectory variables.
    
    Parameters:
    
    ast - The AST.
  - PrintUsage
```
public static void PrintUsage()
```
    Print a usage message. This method is called when the user's command line cannot be interpreted.

Class Main

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clean

concurrentTraining

warningsDisabled

printSymbols

sourceDirectory

sourceFilename

sourceFileBase

javacArguments

fileNames

classDirectory

classPackageDirectory

classPath

sourcePath

generatedSourceDirectory

Constructor Detail

Main

Method Detail

main

runSemanticAnalysis

PrintUsage