gov.llnl.babel
Class BabelConfiguration

java.lang.Object
  extended bygov.llnl.babel.BabelConfiguration

public class BabelConfiguration
extends java.lang.Object

This class provides access to configuration information (including user options) required by the parsers and backend.


Constructor Summary
protected BabelConfiguration()
          Since this is a singleton class, its constructor is protected.
 
Method Summary
 void addExcluded(RegexMatch rm)
          Add another regular expression to the list of excluded regular expressions.
 void addIncluded(java.lang.String str)
          Add another regular expression to the list of included regular expressions.
 void addToRepositoryPath(java.lang.String new_path)
          Adds a new entry to the repository path.
 boolean excludeExternal()
          Return the value of the exclude external symbol code generation user option.
 boolean generateClient()
          Return the value of the client generation user option.
 boolean generateRemote()
          Return the value of the remote generation user option.
 boolean generateServer()
          Return the value of the server generation user option.
 boolean generateStdlib()
          Return the value of the sidl stdlib generation user option.
 boolean generateText()
          Return the value of the text generation user option.
static java.lang.String getBaseClass()
          Return the full name of the root of the class type hierarchy.
static java.lang.String getBaseExceptionClass()
          Return the full name of the base exception class.
static java.lang.String getBaseExceptionInterface()
          The full name of the base of the exception type hierarchy.
static java.lang.String getBaseExceptionType()
          The full name of the fundamental exception type.
static java.lang.String getBaseInterface()
          Return the full name of the root of the sidl type hierarchy.
static java.lang.String getClassInfo()
          Return the full name of the ClassInfo interface.
static java.lang.String getClassInfoI()
          Return the full name of the class implementing ClassInfo interface.
 boolean getCommentLocalOnly()
          Return the value of the comment local methods only option.
 java.util.List getExcludedList()
          Return the list of RegexMatch objects that should be excluded from code generation.
 java.util.List getIncludedList()
          Return the list of RegexMatch objects that should be included from code generation.
static BabelConfiguration getInstance()
          Return the singleton instance of this class.
 java.lang.String getMakefileName()
          The full name of the file associated with generated makefile fragments.
 java.lang.String getMakePrefix()
           
static int getMaximumArray()
          Return the maximum array dimension.
 java.lang.String getOutputDirectory()
          Return the value of the output directory user option.
 java.lang.String getRepositoryPath()
          Return the value of the repository path.
 java.lang.String getTargetLanguage()
          Return the value of the target language user option.
 java.lang.String getVPathDirectory()
          Return the value of the vpath directory user option.
static boolean isSIDLBaseClass(SymbolID id)
          Return whether the specified symbol belongs to the sidl namespace.
 boolean makeGlueSubdirs()
          Return the value of the package and glue subdirs user option.
 boolean makeLanguageSubdir()
          Return the value of the language subdirectory user option.
 boolean makePackageSubdirs()
          Return the value of the make package subdirs user option.
 boolean parseCheckOnly()
          Return the value of the parser check user option.
 void setCommentLocalOnly(boolean localOnly)
          Set the value of the comment local methods only option.
 void setExcludeExternal(boolean val)
          Set the value of the exclude external symbol code generation user option.
 void setGenerateClient(boolean generate)
          Set the value of the client generation user option.
 void setGenerateRemote(boolean generate)
          Set the value of the remote generation user option.
 void setGenerateServer(boolean generate)
          Set the value of the server generation user option.
 void setGenerateStdlib(boolean generate)
          Set the value of the sidl stdlib generation user option.
 void setGenerateText(boolean generate)
          Set the value of the text generation user option.
 void setMakeGlueSubdirs(boolean make_glue_subdirs)
          Set the value of the package and glue subdirs user option.
 void setMakeLanguageSubdir(boolean make_language_subdir)
          Specify whether files for each language should be generated in a separate subdirectory.
 void setMakePackageSubdirs(boolean make_subdirs)
          Set the value of the make package subdirs user option.
 void setMakePrefix(java.lang.String prefix)
           
 void setOutputDirectory(java.lang.String dir)
          Set the value of the output directory user option.
 void setParseCheckOnly(boolean parse)
          Set the value of the parser check user option.
 void setSuppressTimestamps(boolean suppress)
          Set the value of the timestamp suppression user option.
 void setTargetLanguage(java.lang.String lang)
          Set the value of the target language user option.
 void setVPathDirectory(java.lang.String dir)
          Set the value of the vpath directory user option.
 boolean suppressTimestamps()
          Return the value of the timestamp suppression user option.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BabelConfiguration

protected BabelConfiguration()
Since this is a singleton class, its constructor is protected.

Method Detail

getInstance

public static BabelConfiguration getInstance()
Return the singleton instance of this class.


getBaseInterface

public static java.lang.String getBaseInterface()
Return the full name of the root of the sidl type hierarchy.


getBaseClass

public static java.lang.String getBaseClass()
Return the full name of the root of the class type hierarchy. This is the one class that does not have a parent class.


getClassInfo

public static java.lang.String getClassInfo()
Return the full name of the ClassInfo interface.


getClassInfoI

public static java.lang.String getClassInfoI()
Return the full name of the class implementing ClassInfo interface.


getBaseExceptionInterface

public static java.lang.String getBaseExceptionInterface()
The full name of the base of the exception type hierarchy. All exceptions must extend this type.


getBaseExceptionClass

public static java.lang.String getBaseExceptionClass()
Return the full name of the base exception class.


getBaseExceptionType

public static java.lang.String getBaseExceptionType()
The full name of the fundamental exception type.


getMakefileName

public java.lang.String getMakefileName()
The full name of the file associated with generated makefile fragments.


getMaximumArray

public static int getMaximumArray()
Return the maximum array dimension.


isSIDLBaseClass

public static boolean isSIDLBaseClass(SymbolID id)
Return whether the specified symbol belongs to the sidl namespace.


setGenerateServer

public void setGenerateServer(boolean generate)
Set the value of the server generation user option.


generateServer

public boolean generateServer()
Return the value of the server generation user option.


setGenerateRemote

public void setGenerateRemote(boolean generate)
Set the value of the remote generation user option.


generateRemote

public boolean generateRemote()
Return the value of the remote generation user option.


setGenerateClient

public void setGenerateClient(boolean generate)
Set the value of the client generation user option.


generateClient

public boolean generateClient()
Return the value of the client generation user option.


setGenerateText

public void setGenerateText(boolean generate)
Set the value of the text generation user option.


generateText

public boolean generateText()
Return the value of the text generation user option.


setGenerateStdlib

public void setGenerateStdlib(boolean generate)
Set the value of the sidl stdlib generation user option.


generateStdlib

public boolean generateStdlib()
Return the value of the sidl stdlib generation user option.


setParseCheckOnly

public void setParseCheckOnly(boolean parse)
Set the value of the parser check user option.


parseCheckOnly

public boolean parseCheckOnly()
Return the value of the parser check user option.


setCommentLocalOnly

public void setCommentLocalOnly(boolean localOnly)
Set the value of the comment local methods only option.


getCommentLocalOnly

public boolean getCommentLocalOnly()
Return the value of the comment local methods only option.


setSuppressTimestamps

public void setSuppressTimestamps(boolean suppress)
Set the value of the timestamp suppression user option.


suppressTimestamps

public boolean suppressTimestamps()
Return the value of the timestamp suppression user option.


setMakePackageSubdirs

public void setMakePackageSubdirs(boolean make_subdirs)
Set the value of the make package subdirs user option.


makePackageSubdirs

public boolean makePackageSubdirs()
Return the value of the make package subdirs user option.


setMakeGlueSubdirs

public void setMakeGlueSubdirs(boolean make_glue_subdirs)
Set the value of the package and glue subdirs user option.


makeGlueSubdirs

public boolean makeGlueSubdirs()
Return the value of the package and glue subdirs user option.


setMakeLanguageSubdir

public void setMakeLanguageSubdir(boolean make_language_subdir)
Specify whether files for each language should be generated in a separate subdirectory. When the argument is true, all code is placed in a subdirectory whose name corresponds to the language, e.g. c++, f90, etc.


makeLanguageSubdir

public boolean makeLanguageSubdir()
Return the value of the language subdirectory user option.


setOutputDirectory

public void setOutputDirectory(java.lang.String dir)
Set the value of the output directory user option.


getOutputDirectory

public java.lang.String getOutputDirectory()
Return the value of the output directory user option.


setVPathDirectory

public void setVPathDirectory(java.lang.String dir)
Set the value of the vpath directory user option.


getVPathDirectory

public java.lang.String getVPathDirectory()
Return the value of the vpath directory user option.


setTargetLanguage

public void setTargetLanguage(java.lang.String lang)
Set the value of the target language user option.


getTargetLanguage

public java.lang.String getTargetLanguage()
Return the value of the target language user option.


addToRepositoryPath

public void addToRepositoryPath(java.lang.String new_path)
Adds a new entry to the repository path.


getRepositoryPath

public java.lang.String getRepositoryPath()
Return the value of the repository path.


addExcluded

public void addExcluded(RegexMatch rm)
Add another regular expression to the list of excluded regular expressions.


getExcludedList

public java.util.List getExcludedList()
Return the list of RegexMatch objects that should be excluded from code generation.


addIncluded

public void addIncluded(java.lang.String str)
Add another regular expression to the list of included regular expressions.


getIncludedList

public java.util.List getIncludedList()
Return the list of RegexMatch objects that should be included from code generation.


setExcludeExternal

public void setExcludeExternal(boolean val)
Set the value of the exclude external symbol code generation user option.


excludeExternal

public boolean excludeExternal()
Return the value of the exclude external symbol code generation user option.


getMakePrefix

public java.lang.String getMakePrefix()

setMakePrefix

public void setMakePrefix(java.lang.String prefix)