gov.llnl.babel

Class BabelConfiguration

Implemented Interfaces:
Cloneable

public class BabelConfiguration
extends java.lang.Object
implements Cloneable

This class provides access to configuration information (including user options) required by the parsers and backend. This class originally envisaged as a singleton. However, it makes sense to have several of them when trying to do several runs in a single command line.

Field Summary

static String
ADVANCED_CHECKING
static String
FUND_EXCEPTION
static String
INV_EXCEPTION
static String
NO_CHECKING
static String
OPTIONAL_RMI
static String
POST_EXCEPTION
static String
PRE_EXCEPTION
static String
SUPPORT_CHECKING
static int
sidl_bool_array
These are the values returned by calling the _type function query on an array.
static int
sidl_char_array
static int
sidl_dcomplex_array
static int
sidl_double_array
static int
sidl_fcomplex_array
static int
sidl_float_array
static int
sidl_int_array
static int
sidl_interface_array
static int
sidl_long_array
static int
sidl_opaque_array
static int
sidl_string_array

Constructor Summary

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(String str)
Add another regular expression to the list of included regular expressions.
void
addToRepositoryPath(String new_path)
Adds a new entry to the repository path.
static String
arrayType(int type)
Object
clone()
Make a copy of the configuration.
boolean
excludeExternal()
Return the value of the exclude external symbol code generation user option.
boolean
generateAssertions()
Return whether or not user has indicated assertions should be generated.
boolean
generateClient()
Return the value of the client generation user option.
boolean
generateHooks()
Return the value of the pre/post method hooks 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 String
getArrayOrderName(int i)
String
getAssertionLevel()
Return the level of assertion checking.
static String
getBaseClass()
Return the full name of the root of the class type hierarchy.
static String
getBaseExceptionClass()
Return the full name of the base exception class.
static String
getBaseExceptionInterface()
The full name of the base of the exception type hierarchy.
static String
getBaseExceptionType()
The full name of the fundamental exception type.
static String
getBaseInterface()
Return the full name of the root of the SIDL type hierarchy.
boolean
getCCAMode()
static String
getClassInfo()
Return the full name of the ClassInfo interface.
static String
getClassInfoI()
Return the full name of the class implementing ClassInfo interface.
boolean
getCommentLocalOnly()
Return the value of the comment local methods only option.
List
getExcludedList()
Return the list of RegexMatch objects that should be excluded from code generation.
boolean
getHasBindC()
List
getIncludedList()
Return the list of RegexMatch objects that should be included from code generation.
static String
getLangSpecific()
String
getMakePrefix()
Return the make prefix option.
String
getMakefileName()
The full name of the file associated with generated makefile fragments.
static int
getMaximumArray()
Return the maximum array dimension.
static String
getMemoryAllocationException()
boolean
getMultiMode()
static String
getNotImplemented()
static String
getOptionalRmiMacro()
Return the full name of the base exception class.
String
getOutputDirectory()
Return the value of the output directory user option.
boolean
getProtectLastTimeModified()
static String
getRMITicket()
boolean
getRenameSplicers()
String
getRepositoryPath()
Return the value of the repository path.
static String
getRuntimeException()
The full name of the exception type implicit in all methods.
static String
getSerializableType()
boolean
getShortFileNames()
Return the value of the short file names option.
boolean
getSuppressIOR()
boolean
getSuppressStub()
String
getTargetLanguage()
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
isVerbose()
Return the value of the parser check user option.
boolean
makeCxxCheckNullIOR()
Return the value of the make package subdirs user option.
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
removeFromRepositoryPath(String path)
void
setAssertionLevel(String lvl)
Set the level of the assertion generation user option.
void
setCCAMode(boolean value)
Set the rename splicers flag to true or false.
void
setCommentLocalOnly(boolean localOnly)
Set the value of the comment local methods only option.
void
setCxxCheckNullIOR(boolean checkNullIOR)
Set the value of the Cxx NullIORException checking 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
setGenerateHooks(boolean generate)
Set the value of the pre/post method hooks 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
setHasBindC(boolean bindc)
Set if this Fortran compiler supports the iso_c_binding module
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(String prefix)
Set the make prefix and makefile name options.
void
setMultiMode(boolean multi_mode)
void
setOutputDirectory(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
setProtectLastTimeModified(boolean value)
void
setRenameSplicers(boolean value)
Set the rename splicers flag to true or false.
void
setShortFileNames(boolean shortFileNames)
Set the value of the short file names option.
void
setSuppressIOR(boolean value)
Set the IOR suppression to true or false.
void
setSuppressStub(boolean value)
Set the stub suppression to true or false.
void
setSuppressTimestamps(boolean suppress)
Set the value of the timestamp suppression user option.
void
setTargetLanguage(String lang)
Set the value of the target language user option.
void
setVPathDirectory(String dir)
Set the value of the vpath directory user option.
void
setVerbose(boolean verbose)
Set the value of the parser check user option.
boolean
suppressTimestamps()
Return the value of the timestamp suppression user option.

Field Details

ADVANCED_CHECKING

public static final String ADVANCED_CHECKING

FUND_EXCEPTION

public static final String FUND_EXCEPTION

INV_EXCEPTION

public static final String INV_EXCEPTION

NO_CHECKING

public static final String NO_CHECKING

OPTIONAL_RMI

public static final String OPTIONAL_RMI

POST_EXCEPTION

public static final String POST_EXCEPTION

PRE_EXCEPTION

public static final String PRE_EXCEPTION

SUPPORT_CHECKING

public static final String SUPPORT_CHECKING

sidl_bool_array

public static final int sidl_bool_array
These are the values returned by calling the _type function query on an array. THESE MUST BE THE SAME AS FOUND IN runtime/sidl/sidlArray.h (They are also used in F77 and F90)
Field Value:
1

sidl_char_array

public static final int sidl_char_array
Field Value:
2

sidl_dcomplex_array

public static final int sidl_dcomplex_array
Field Value:
3

sidl_double_array

public static final int sidl_double_array
Field Value:
4

sidl_fcomplex_array

public static final int sidl_fcomplex_array
Field Value:
5

sidl_float_array

public static final int sidl_float_array
Field Value:
6

sidl_int_array

public static final int sidl_int_array
Field Value:
7

sidl_interface_array

public static final int sidl_interface_array
Field Value:
11

sidl_long_array

public static final int sidl_long_array
Field Value:
8

sidl_opaque_array

public static final int sidl_opaque_array
Field Value:
9

sidl_string_array

public static final int sidl_string_array
Field Value:
10

Constructor Details

BabelConfiguration

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

Method Details

addExcluded

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

addIncluded

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

addToRepositoryPath

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

arrayType

public static String arrayType(int type)

clone

public Object clone()
Make a copy of the configuration.

excludeExternal

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

generateAssertions

public boolean generateAssertions()
Return whether or not user has indicated assertions should be generated.

generateClient

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

generateHooks

public boolean generateHooks()
Return the value of the pre/post method hooks generation user option.

generateServer

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

generateStdlib

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

generateText

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

getArrayOrderName

public static String getArrayOrderName(int i)

getAssertionLevel

public String getAssertionLevel()
Return the level of assertion checking.

getBaseClass

public static 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.

getBaseExceptionClass

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

getBaseExceptionInterface

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

getBaseExceptionType

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

getBaseInterface

public static String getBaseInterface()
Return the full name of the root of the SIDL type hierarchy.

getCCAMode

public boolean getCCAMode()

getClassInfo

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

getClassInfoI

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

getCommentLocalOnly

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

getExcludedList

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

getHasBindC

public boolean getHasBindC()

getIncludedList

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

getLangSpecific

public static String getLangSpecific()

getMakePrefix

public String getMakePrefix()
Return the make prefix option.

getMakefileName

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

getMaximumArray

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

getMemoryAllocationException

public static String getMemoryAllocationException()

getMultiMode

public boolean getMultiMode()

getNotImplemented

public static String getNotImplemented()

getOptionalRmiMacro

public static String getOptionalRmiMacro()
Return the full name of the base exception class.

getOutputDirectory

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

getProtectLastTimeModified

public boolean getProtectLastTimeModified()

getRMITicket

public static String getRMITicket()

getRenameSplicers

public boolean getRenameSplicers()

getRepositoryPath

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

getRuntimeException

public static String getRuntimeException()
The full name of the exception type implicit in all methods.

getSerializableType

public static String getSerializableType()

getShortFileNames

public boolean getShortFileNames()
Return the value of the short file names option.

getSuppressIOR

public boolean getSuppressIOR()

getSuppressStub

public boolean getSuppressStub()

getTargetLanguage

public String getTargetLanguage()

getVPathDirectory

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

isSIDLBaseClass

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

isVerbose

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

makeCxxCheckNullIOR

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

makeGlueSubdirs

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

makeLanguageSubdir

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

makePackageSubdirs

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

parseCheckOnly

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

removeFromRepositoryPath

public void removeFromRepositoryPath(String path)

setAssertionLevel

public void setAssertionLevel(String lvl)
Set the level of the assertion generation user option.

setCCAMode

public void setCCAMode(boolean value)
Set the rename splicers flag to true or false.

setCommentLocalOnly

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

setCxxCheckNullIOR

public void setCxxCheckNullIOR(boolean checkNullIOR)
Set the value of the Cxx NullIORException checking option.

setExcludeExternal

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

setGenerateClient

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

setGenerateHooks

public void setGenerateHooks(boolean generate)
Set the value of the pre/post method hooks generation user option.

setGenerateServer

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

setGenerateStdlib

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

setGenerateText

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

setHasBindC

public void setHasBindC(boolean bindc)
Set if this Fortran compiler supports the iso_c_binding module

setMakeGlueSubdirs

public void setMakeGlueSubdirs(boolean make_glue_subdirs)
Set 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.

setMakePackageSubdirs

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

setMakePrefix

public void setMakePrefix(String prefix)
Set the make prefix and makefile name options.

setMultiMode

public void setMultiMode(boolean multi_mode)

setOutputDirectory

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

setParseCheckOnly

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

setProtectLastTimeModified

public void setProtectLastTimeModified(boolean value)

setRenameSplicers

public void setRenameSplicers(boolean value)
Set the rename splicers flag to true or false.

setShortFileNames

public void setShortFileNames(boolean shortFileNames)
Set the value of the short file names option.

setSuppressIOR

public void setSuppressIOR(boolean value)
Set the IOR suppression to true or false.

setSuppressStub

public void setSuppressStub(boolean value)
Set the stub suppression to true or false.

setSuppressTimestamps

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

setTargetLanguage

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

setVPathDirectory

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

setVerbose

public void setVerbose(boolean verbose)
Set the value of the parser check user option.

suppressTimestamps

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