edu.isi.stella
Class Keyword

java.lang.Object
  extended by edu.isi.stella.Stella_Object
      extended by edu.isi.stella.StandardObject
          extended by edu.isi.stella.ContextSensitiveObject
              extended by edu.isi.stella.GeneralizedSymbol
                  extended by edu.isi.stella.Keyword

public class Keyword
extends GeneralizedSymbol


Field Summary
 
Fields inherited from class edu.isi.stella.GeneralizedSymbol
symbolId, symbolName
 
Fields inherited from class edu.isi.stella.ContextSensitiveObject
homeContext
 
Constructor Summary
Keyword()
           
 
Method Summary
static Stella_Object accessKeywordSlotValue(Keyword self, Symbol slotname, Stella_Object value, boolean setvalueP)
           
static void bumpMemoizationTimestamp(Keyword timestampname)
           
static void clearMemoizationTables(Keyword timestampname)
           
 Stella_Object clTranslateAtomicTree()
           
static java.lang.String computeCommonLispFileExtension(Keyword type)
           
static void cppOutputDeclarations(Keyword accesscontrolmode, Cons declarations)
           
static void cppOutputDefinitions(Keyword accesscontrolmode, Cons definitions)
           
 void cppOutputLiteral()
           
static void cppOutputSignatures(Keyword accesscontrolmode, Cons signatures)
           
 Cons cppTranslateAtomicTree()
           
static StringWrapper cppTranslateKeywordId(Keyword keyword)
           
static StringWrapper cppTranslateKeywordName(Keyword keyword)
           
static java.lang.String defaultCommonLispFileExtension(Keyword type)
           
static boolean disabledStellaFeatureP(Keyword feature)
          Return true if the STELLA feature is currently disabled.
static boolean enabledStellaFeatureP(Keyword feature)
          Return true if the STELLA feature is currently enabled.
static int encodeStartupTimePhase(Keyword phase)
           
static java.lang.String generateUuid(Keyword uuidType)
          Generates a UUID of the specified type.
static Keyword getKwd(int offset)
           
static Keyword getKwdFromOffset(int offset)
           
 void idlOutputLiteral()
           
static StringWrapper idlTranslateKeywordId(Keyword keyword)
           
static StringWrapper idlTranslateKeywordName(Keyword keyword)
           
static Stella_Object ifOutputLanguage(Keyword language, Stella_Object thenform, Stella_Object elseform)
          Expand to 'thenForm' if the current translator output language equals 'language'.
static Stella_Object ifStellaFeature(Keyword feature, Stella_Object thenform, Stella_Object elseform)
          Expand to 'thenForm' if 'feature' is a currently enabled STELLA environment feature.
 void javaOutputLiteral()
           
static StringWrapper javaTranslateKeywordId(Keyword keyword)
           
static StringWrapper javaTranslateKeywordName(Keyword keyword)
           
 Keyword keywordify()
           
static Keyword languageToFileType(Keyword language)
           
static Keyword lookupKeyword(java.lang.String name)
          Return the keyword with name if it exists.
static Keyword newKeyword(java.lang.String symbolName)
           
static Stella_Object phaseToInteger(Keyword startuptimephase)
          Expands into the integer representing 'startupTimePhase'.
 Surrogate primaryType()
          Returns the primary type of self.
static void printKeyword(Keyword self, java.io.PrintStream stream)
           
 void printObject(java.io.PrintStream stream)
           
static java.lang.String selectFileExtension(Keyword type)
           
static java.lang.String selectRootDirectory(Keyword type)
           
static java.lang.String selectSplitterPath(Keyword type)
           
static Keyword setTranslatorOutputLanguage(Keyword newLanguage)
          Set output language to newLanguage.
static void transferDataFiles(Keyword outputLanguage)
           
static void transferNativeSystemFiles(Keyword outputLanguage)
           
 Stella_Object walkAtomicTree(java.lang.Object[] MV_returnarray)
           
 
Methods inherited from class edu.isi.stella.GeneralizedSymbol
accessGeneralizedSymbolSlotValue, constructSymbolConstantName, cppChangeCase, cppQualifyNameP, cppTranslateClassName, cppTranslateClassTypename, cppTranslateSymbolConstantId, cppTranslateSymbolConstantName, cppYieldNamespacePrefix, createStartupSymbol, deletedP, explicitlyQualifiedNameP, generalizedSymbolLessThanP, getGeneralizedSymbolFromOffset, helpCppChangeCase, helpInternGeneralizedSymbol, idlChangeCase, idlTranslateClassName, idlTranslateSymbolConstantId, idlTranslateSymbolConstantName, internDerivedSurrogate, internRigidSymbolCaseSensitively, internRigidSymbolLocally, internRigidSymbolWrtModule, javaChangeCase, javaTranslateClassName, javaTranslateSymbolConstantId, javaTranslateSymbolConstantName, localPrintName, lookupGlobalVariable, lookupRigidSymbol, lookupRigidSymbolLocally, registerSymbol, relativeName, shadowedSymbolP, visibleName, yieldSymbolConstantName
 
Methods inherited from class edu.isi.stella.ContextSensitiveObject
homeModule
 
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, 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, cppOutputOneActualParameter, cppOutputStatement, cppOutputTypedEntity, cppPrognifyStatement, cppPrognP, cppStatementToList, cppStreamIsStandardOutputP, cpptrans, cppTranslateATree, cppTranslatedArrayTypeP, csValueP, dateDivider, dateTimeDivider, day, dealWithAmPm, dealWithEra, dealWithNoonMidn, decrementReferenceCount, defaultOptionHandler, defineSystem, defmodule, 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, hour, idlOutputAtomicExpression, idlOutputStatement, idlTranslateAtomicTree, idlTranslateATree, illegalTreeP, implodePathname, incrementallyTranslate, incrementReferenceCount, inlineUnwrapBoolean, inlineWrapBoolean, inModule, integerP, isaP, javaBinaryOperatorP, javaBlockP, javaEndOfLineTokenP, javaHelpOutputPrintStream, javaMaybeOutputStatementWithParentheses, javaOperatorP, 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, 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, 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
 

Constructor Detail

Keyword

public Keyword()
Method Detail

lookupKeyword

public static Keyword lookupKeyword(java.lang.String name)
Return the keyword with name if it exists.

Parameters:
name -
Returns:
Keyword

getKwdFromOffset

public static Keyword getKwdFromOffset(int offset)

getKwd

public static Keyword getKwd(int offset)

newKeyword

public static Keyword newKeyword(java.lang.String symbolName)

encodeStartupTimePhase

public static int encodeStartupTimePhase(Keyword phase)

idlOutputLiteral

public void idlOutputLiteral()
Overrides:
idlOutputLiteral in class Stella_Object

idlTranslateKeywordId

public static StringWrapper idlTranslateKeywordId(Keyword keyword)

idlTranslateKeywordName

public static StringWrapper idlTranslateKeywordName(Keyword keyword)

javaOutputLiteral

public void javaOutputLiteral()
Overrides:
javaOutputLiteral in class Stella_Object

javaTranslateKeywordId

public static StringWrapper javaTranslateKeywordId(Keyword keyword)

javaTranslateKeywordName

public static StringWrapper javaTranslateKeywordName(Keyword keyword)

cppOutputDefinitions

public static void cppOutputDefinitions(Keyword accesscontrolmode,
                                        Cons definitions)

cppOutputSignatures

public static void cppOutputSignatures(Keyword accesscontrolmode,
                                       Cons signatures)

cppOutputDeclarations

public static void cppOutputDeclarations(Keyword accesscontrolmode,
                                         Cons declarations)

cppOutputLiteral

public void cppOutputLiteral()
Overrides:
cppOutputLiteral in class Stella_Object

cppTranslateKeywordId

public static StringWrapper cppTranslateKeywordId(Keyword keyword)

cppTranslateKeywordName

public static StringWrapper cppTranslateKeywordName(Keyword keyword)

cppTranslateAtomicTree

public Cons cppTranslateAtomicTree()
Overrides:
cppTranslateAtomicTree in class Stella_Object

transferDataFiles

public static void transferDataFiles(Keyword outputLanguage)

transferNativeSystemFiles

public static void transferNativeSystemFiles(Keyword outputLanguage)

languageToFileType

public static Keyword languageToFileType(Keyword language)

selectSplitterPath

public static java.lang.String selectSplitterPath(Keyword type)

selectRootDirectory

public static java.lang.String selectRootDirectory(Keyword type)

selectFileExtension

public static java.lang.String selectFileExtension(Keyword type)

defaultCommonLispFileExtension

public static java.lang.String defaultCommonLispFileExtension(Keyword type)

computeCommonLispFileExtension

public static java.lang.String computeCommonLispFileExtension(Keyword type)

bumpMemoizationTimestamp

public static void bumpMemoizationTimestamp(Keyword timestampname)

clearMemoizationTables

public static void clearMemoizationTables(Keyword timestampname)

ifStellaFeature

public static Stella_Object ifStellaFeature(Keyword feature,
                                            Stella_Object thenform,
                                            Stella_Object elseform)
Expand to 'thenForm' if 'feature' is a currently enabled STELLA environment feature. Otherwise, expand to 'elseForm'. This can be used to conditionally translate Stella code.

Parameters:
feature -
thenform -
elseform -
Returns:
Stella_Object

ifOutputLanguage

public static Stella_Object ifOutputLanguage(Keyword language,
                                             Stella_Object thenform,
                                             Stella_Object elseform)
Expand to 'thenForm' if the current translator output language equals 'language'. Otherwise, expand to 'elseForm'. This can be used to conditionally translate Stella code.

Parameters:
language -
thenform -
elseform -
Returns:
Stella_Object

phaseToInteger

public static Stella_Object phaseToInteger(Keyword startuptimephase)
Expands into the integer representing 'startupTimePhase'.

Parameters:
startuptimephase -
Returns:
Stella_Object

clTranslateAtomicTree

public Stella_Object clTranslateAtomicTree()
Overrides:
clTranslateAtomicTree in class Stella_Object

walkAtomicTree

public Stella_Object walkAtomicTree(java.lang.Object[] MV_returnarray)
Overrides:
walkAtomicTree in class Stella_Object

setTranslatorOutputLanguage

public static Keyword setTranslatorOutputLanguage(Keyword newLanguage)
Set output language to newLanguage. Return previous language.

Parameters:
newLanguage -
Returns:
Keyword

disabledStellaFeatureP

public static boolean disabledStellaFeatureP(Keyword feature)
Return true if the STELLA feature is currently disabled.

Parameters:
feature -
Returns:
boolean

enabledStellaFeatureP

public static boolean enabledStellaFeatureP(Keyword feature)
Return true if the STELLA feature is currently enabled.

Parameters:
feature -
Returns:
boolean

printKeyword

public static void printKeyword(Keyword self,
                                java.io.PrintStream stream)

keywordify

public Keyword keywordify()
Overrides:
keywordify in class GeneralizedSymbol

generateUuid

public static java.lang.String generateUuid(Keyword uuidType)
Generates a UUID of the specified type. Legal types are a subset of the IETF RFC 4122 (see http://www.ietf.org/rfc/rfc4122.txt ) UUID types. Currently supported are: :TYPE-4 :RANDOM A type-4 (random) UUID. These are synonyms.

Parameters:
uuidType -
Returns:
String

printObject

public void printObject(java.io.PrintStream stream)
Overrides:
printObject in class Stella_Object

accessKeywordSlotValue

public static Stella_Object accessKeywordSlotValue(Keyword 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