edu.isi.stella
Class CmdLineOption

java.lang.Object
  extended by edu.isi.stella.Stella_Object
      extended by edu.isi.stella.StandardObject
          extended by edu.isi.stella.CmdLineOption

public class CmdLineOption
extends StandardObject


Field Summary
 java.lang.String configurationProperty
           
 Stella_Object defaultValue
          The value to use for 0-arg options.
 java.lang.String documentation
           
 Keyword errorAction
          One of :ignore, :warn, :error.
 java.lang.reflect.Method handler
           
 Cons keys
           
 boolean multiValuedP
           
 int nArguments
          The number of args expected by this option.
 Surrogate valueType
           
 
Constructor Summary
CmdLineOption()
           
 
Method Summary
static Stella_Object accessCmdLineOptionSlotValue(CmdLineOption self, Symbol slotname, Stella_Object value, boolean setvalueP)
           
static void configFileOptionHandler(CmdLineOption option, Stella_Object value)
          Load the configuration file value.
static void defaultCmdLineOptionHandler(CmdLineOption option, Stella_Object value)
          Default handler that tries to set a system property based on option and value.
static void definePropertyOptionHandler(CmdLineOption option, Stella_Object value)
           
static void evalInModuleOptionHandler(CmdLineOption option, Stella_Object value)
          Interpret an --eval-in-module option.
static void evalOptionHandler(CmdLineOption option, Stella_Object value)
          Interpret an --eval option by evaluating value.
static void helpOptionHandler(CmdLineOption option, Stella_Object value)
          Print documentation about all currently registered option handlers.
static void loadFileOptionHandler(CmdLineOption option, Stella_Object value)
          Load the file value using the STELLA loadFile command.
static void loadPathOptionHandler(CmdLineOption option, Stella_Object value)
          Modify the current file load path according to option and value.
static CmdLineOption newCmdLineOption()
           
 Surrogate primaryType()
          Returns the primary type of self.
 
Methods inherited from class edu.isi.stella.StandardObject
arrayTypeSpecifierP, baseTypeToTypeSpec, cantOverwriteActiveCollectionSlot, compatibleParameterTypesP, computeAnchoredTypeSpec, computeRelativeTypeSpec, conformingTypeSpecP, copyWrappedLiteral, cppNonPointerTypeP, cppReferenceTypeP, cppReferencizeType, cppTranslateAndPointerizeTypeSpec, cppTranslateAndReferencizeTypeSpec, cppTranslateTypeSpec, cppTypeWithoutInteriorPointersP, dropSlotValue, extractParameterType, extractRequiredArgumentValues, getSlot, hashCode_, idlTranslateTypeSpec, inverseSlotDemon, javaLiteralP, javaNativeLiteralWrapperNames, javaSpecialSetterName, javaTranslateArrayOfTypeSpec, javaTranslateTypeSpec, javaTranslateTypeSpecForFunction, javaTranslateTypeSpecHelper, javaYieldClassObjectArrayExpression, javaYieldClassObjectExpression, javaYieldFullyQualifiedTypeName, javaYieldTranslatedClassAndMethodNames, listifyTypeSpec, lookupClTypeFromStellaType, objectEqlP, putSlotValue, readSlotValue, runConstructorDemons, runDestructorDemons, runSlotDemons, runSlotGuardDemonsP, standardObjectP, subTypeSpecOfP, twoArgumentLeastCommonSupertype, typeSpecToBaseType, typeSpecToClass, typeToWalkedNullValueTree, validateTypeSpecifier, voidP, walkTypeSpecIsNativeTypeP, writeSlotValue, yieldTypeSpecTree
 
Methods inherited from class edu.isi.stella.Stella_Object
_, accessInContext, addPropertyValue, amPm, anchoredTypeSpecifierP, andOrNotTreeP, applyCoercionMethod, atomicExpressionP, bindToSurrogateP, booleanP, bootstrapIsaP, bquotify, cast, characterP, chooseSortPredicate, clConditionalizeTypeDeclarationTree, clTranslateAtomicTree, clTranslateATree, clTranslateBooleanTest, clTranslatePlainBooleanTest, clTranslateVerbatimBodySymbols, clYieldTypedExpressionTree, coerceATree, coerceEvaluatedTree, coerceMvTree, coerceOptionValue, coerceToBoolean, coerceToFloat, coerceToHashSet, coerceToModule, coerceToModuleName, coerceToString, coerceToSymbol, coerceToXmlElement, coerceValueToBoolean, coerceValueToFloat, coerceValueToString, coerceValueToType, coercibleP, collectFeatureList, collectKeyValueList, commonLispSymbolP, computeExpressionType, consify, consifyListsAndIterators, consP, consTreeMatchP, convertToLiteral, copyConsTree, cppArgumentIsStreamP, cppBinaryOperatorP, cppBlockP, cppMaybeOutputStatementWithParentheses, cppOperatorP, cppOutputAtomicExpression, cppOutputLiteral, cppOutputOneActualParameter, cppOutputStatement, cppOutputTypedEntity, cppPrognifyStatement, cppPrognP, cppStatementToList, cppStreamIsStandardOutputP, cpptrans, cppTranslateAtomicTree, cppTranslateATree, cppTranslatedArrayTypeP, csValueP, dateDivider, dateTimeDivider, day, dealWithAmPm, dealWithEra, dealWithNoonMidn, decrementReferenceCount, defaultOptionHandler, defineSystem, defmodule, deletedP, describe, describeObject, describeTersely, destructureMethodNameTree, deUglifyParseTree, either, eqlP, eqlToBooleanP, eqlToCharacterP, eqlToFloatP, eqlToIntegerP, eqlToLongIntegerP, eqlToStringP, equalConsTreesP, equalHashCode, equalP, era, estimatedEvaluationCost, evaluate, evaluateArgumentTree, evaluateAtomicTree, evaluateCommand, expandBquoteTree, filterModuleP, floatP, free, get, getObject, getProperty, hashlist, hashMemoizedArguments, helpBquotify, helpClTranslateATree, helpCoerceATree, helpLptrans, helpPrintOutline, helpTransformBooleanProceduralExpression, helpWalkATree, homeModule, hour, idlOutputAtomicExpression, idlOutputLiteral, idlOutputStatement, idlTranslateAtomicTree, idlTranslateATree, illegalTreeP, implodePathname, incrementallyTranslate, incrementReferenceCount, inlineUnwrapBoolean, inlineWrapBoolean, inModule, integerP, isaP, javaBinaryOperatorP, javaBlockP, javaEndOfLineTokenP, javaHelpOutputPrintStream, javaMaybeOutputStatementWithParentheses, javaOperatorP, javaOutputLiteral, javaOutputStatement, javaPrognP, javaStreamIsStandardOutputP, javaSymbolCaseP, javaTranslateAtomicTree, javaTranslateATree, javaTranslateWithNativeWrapper, jptrans, keywordP, legalTokenizerFromStateP, legalTokenizerStateP, legalTokenizerToStateP, literalEqlP, logLevelLE, longIntegerP, lptrans, makeEvaluatableBquoteTree, makeFileNameFromRelativePath, makeMemoizedValueEntry, makeMemoizedValueEntryn, matchConsTree, methodSlotP, minute, month, nameToString, nilP, noonMidn, numberWrapperToFloat, objectEqualP, objectHashCode, one, oneI, onlyIf, parametricTypeSpecifierP, parseArrayDimensionsSpec, parseOptions, parseTokenizerCharacterSpec, parseTokenizerStateModifiers, permanentCopy, permanentify, permanentifyForm, po, prettyPrintLiteral, primaryClass, printObject, printOutline, printStellaCode, printStellaDefinition, printUndefinedSuperClasses, proceduralExpressionP, ptrans, publicSlots, registerRecycledItem, runOptionHandlerP, safeEqualHashCode, safeHashCode, safePrimaryType, safeYieldTypeSpecifier, searchConsTreeP, searchConsTreeWithFilterP, searchForObject, secondp, setProperty, sideEffectFreeExpressionP, simplifyBquoteTree, specialp, stella_Increment, stellaClassP, stellaCollectionP, stellaNeedToCompileP, stellaNeedToTranslateP, stellaObjectP, stellify, storageSlotP, stringifyInModule, stringP, substituteConsTree, substituteOnce, surrogateP, surrogatify, sweep, symbolCaseP, symbolP, sysTree, targetLanguageType, taxonomyIsaP, timeDivider, timeMultiply, tokenizerIncludeSpecP, tokenizerToStateAlias, tokenizerToStateName, toString, traceIf, traceKeywordP, transientifyForm, transientObjectP, transientSymbolP, translateWalkedTree, treeSize, treeToTrees, trueOptionP, tryToEvaluate, typeP, typify, unmake, unregisterRecycledItem, updateInContext, valuesTreeP, variableExpressionP, verbatimStringP, verbatimTreeP, vetOptions, vrletExpressionP, walkAtomicTree, walkATree, walkCollectionTree, walkDontCallMeTree, walkedExpressionExpression, walkedExpressionType, walkExpressionTree, walkMvExpressionTree, walkMvTree, walkStatement, walkTopLevelExpression, walkWithoutTypeTree, warnAboutUnknownSourceType, weekday, withinContext, withinModule, withinWorld, withStellaTokenizer, withSystemDefinition, withTokenizer, wrapperP, wrapWhereTest, xmlAttributeP, xmlBaseAttributeP, xmlCdataFormP, xmlCdataP, xmlDeclarationFormP, xmlDeclarationP, xmlDoctypeFormP, xmlElementFormP, xmlElementP, xmlGlobalAttributeP, xmlLocalAttributeP, xmlnsAttributeP, xmlProcessingInstructionFormP, xmlProcessingInstructionP, xmlTagCase, year, yieldCondTest, yieldCondTestOrTests, yieldHardcodedCaseSymbolIdOrIds, yieldInCursorClausesForArgumentList, yieldInCursorClausesForGeneralCollection, yieldInCursorClausesForVector, yieldTypeSpecifier, zone, zoneMinute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

documentation

public java.lang.String documentation

keys

public Cons keys

valueType

public Surrogate valueType

multiValuedP

public boolean multiValuedP

nArguments

public int nArguments
The number of args expected by this option. Common values are 0 or 1, but certain options might take more than one argument.


defaultValue

public Stella_Object defaultValue
The value to use for 0-arg options. Defaults to TRUE for 0-arg options with boolean value type.


configurationProperty

public java.lang.String configurationProperty

handler

public java.lang.reflect.Method handler

errorAction

public Keyword errorAction
One of :ignore, :warn, :error.

Constructor Detail

CmdLineOption

public CmdLineOption()
Method Detail

newCmdLineOption

public static CmdLineOption newCmdLineOption()

helpOptionHandler

public static void helpOptionHandler(CmdLineOption option,
                                     Stella_Object value)
Print documentation about all currently registered option handlers.

Parameters:
option -
value -

definePropertyOptionHandler

public static void definePropertyOptionHandler(CmdLineOption option,
                                               Stella_Object value)

loadFileOptionHandler

public static void loadFileOptionHandler(CmdLineOption option,
                                         Stella_Object value)
Load the file value using the STELLA loadFile command.

Parameters:
option -
value -

configFileOptionHandler

public static void configFileOptionHandler(CmdLineOption option,
                                           Stella_Object value)
Load the configuration file value. This will modify currently set system properties defined in value with new values but leave all other currently set properties as they are.

Parameters:
option -
value -

loadPathOptionHandler

public static void loadPathOptionHandler(CmdLineOption option,
                                         Stella_Object value)
Modify the current file load path according to option and value.

Parameters:
option -
value -

evalInModuleOptionHandler

public static void evalInModuleOptionHandler(CmdLineOption option,
                                             Stella_Object value)
Interpret an --eval-in-module option. value is expected to be of the form _LmoduleNameGLsExpressionG_.

Parameters:
option -
value -

evalOptionHandler

public static void evalOptionHandler(CmdLineOption option,
                                     Stella_Object value)
Interpret an --eval option by evaluating value.

Parameters:
option -
value -

defaultCmdLineOptionHandler

public static void defaultCmdLineOptionHandler(CmdLineOption option,
                                               Stella_Object value)
Default handler that tries to set a system property based on option and value.

Parameters:
option -
value -

accessCmdLineOptionSlotValue

public static Stella_Object accessCmdLineOptionSlotValue(CmdLineOption self,
                                                         Symbol slotname,
                                                         Stella_Object value,
                                                         boolean setvalueP)

primaryType

public Surrogate primaryType()
Description copied from class: Stella_Object
Returns the primary type of self. Gets defined automatically for every non-abstract subclass of OBJECT.

Overrides:
primaryType in class Stella_Object
Returns:
Surrogate