ProgressAst (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- antlr.BaseAST
- - antlr.CommonAST
  - - com.goldencode.ast.AnnotatedAst
    - - com.goldencode.p2j.uast.ProgressAst

All Implemented Interfaces:

antlr.collections.AST, Aast, java.io.Serializable
```
public class ProgressAst
extends AnnotatedAst
```
Provides symbolic token name lookups that are specific to the Progress AST, all other function is implemented in the super class.
This also provides static implementations of the 4GL built-in functions KEYWORD and KEYWORD-ALL,

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static KeywordDictionary`	`kwDict` Progress 4GL keyword forward lookup services.
`private static java.util.HashMap`	`reverse` Provide a reverse lookup of token types to keyword text.

Fields inherited from class antlr.BaseAST
down, right

Fields inherited from interface com.goldencode.ast.Aast
RUNTIME_ANNOTATION_COUNT, RUNTIME_CLASS, RUNTIME_CONSTRUCTOR, RUNTIME_METHOD, RUNTIME_VALUE

Constructor Summary

Constructors
Constructor and Description

ProgressAst()
Default constructor.

ProgressAst(antlr.Token token)
Constructor which accepts and wrappers token.

Constructors
Constructor and Description
`ProgressAst()` Default constructor.
`ProgressAst(antlr.Token token)` Constructor which accepts and wrappers token.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`_keyword(java.lang.String text)` Given a partial (abbreviated) or full keyword text, lookup its full text.
`java.lang.String`	`getDescriptiveTokenText()` Returns a descriptive string for the current node.
`java.lang.String`	`getSymbolicTokenType()` Returns the symbolic representation of this AST's token type.
`static character`	`keyword(character text)` Duplicates the Progress 4GL KEYWORD built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL keyword.
`static character`	`keyword(java.lang.String text)` Duplicates the Progress 4GL KEYWORD built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL keyword.
`static character`	`keywordAll(character text)` Duplicates the Progress 4GL KEYWORD-ALL built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL RESERVED keyword.
`static character`	`keywordAll(java.lang.String text)` Duplicates the Progress 4GL KEYWORD-ALL built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL RESERVED keyword.
`java.lang.String`	`keywordText(int type)` Returns the "canonical" keyword text that is associated with a given token type if that type represents a known Progress 4GL language keyword.
`static int`	`lookupKeywordToken(java.lang.String text)` Given a partial (abbreviated) or full keyword text, lookup its token type.
`java.lang.String`	`lookupTokenName(int type)` Translates an integer value of a token type into the associated human readable text representation.
`int`	`lookupTokenType(java.lang.String tokenName)` Translates a text representation of a token type into the actual integer value.
`private static Keyword`	`lookupWorker(java.lang.String text)` Lookup a keyword given partial (abbreviated) or full keyword text.
`protected AnnotatedAst`	`newInstance()` Create a new instance of this AST implementation.

Methods inherited from class com.goldencode.ast.AnnotatedAst
absolutePath, absolutePath, addChild, ancestor, ancestor, ancestor, annotationCount, annotationKeys, annotationSize, brainwash, brainwash, clearAnnotations, clearIds, compareWith, compareWith, descendant, descendant, descendant, descendant, descendant, downPath, downPath, downPath, downPath, downPath, downPath, dumpSimpleTree, dumpTree, dumpTree, duplicate, duplicate, duplicateFresh, duplicateFresh, fixupParent, fixups, fixups, getAncestor, getAncestor, getAncestor, getAncestor, getAnnotation, getAnnotation, getAnnotationList, getChildAt, getColumn, getDepth, getFilename, getId, getImmediateChild, getImmediateChild, getImmediateChildren, getIndexPos, getLastImmediateChild, getLeftAdjacent, getLeftmost, getLeftmostShadow, getLeftShadow, getLeftShadowNode, getLine, getLocal, getNumChildren, getNumImmediateChildren, getNumImmediateChildren, getNumLeftSiblings, getNumRightSiblings, getParent, getPath, getPrevSibling, getRightAdjacent, getRightmost, getRightmostShadow, getRightShadow, getRightShadowNode, getRuntimeAnnotation, getShadowNodeList, graft, graftAt, graftCopyTo, graftCopyTo, initialize, initialize, intern, isAncestorOf, isAnnotation, isArtificial, isHidden, isLeaf, isRoot, isRuntimeAnnotation, iterator, iterator, iterator, matchAnnotation, move, nearestEnclosing, putAnnotation, putAnnotation, putAnnotation, putAnnotation, putAnnotation, putAnnotation, putAnnotation, putAnnotation, putAnnotation, putAnnotationObject, relativePath, relativePath, relativePath, relativePath, relativePath, relativePath, remove, removeAnnotation, removeAnnotation, removeChildren, setColumn, setFirstChild, setHidden, setId, setLine, setLocal, setNextSibling, setParent, setRuntimeAnnotation, sibling, toString, toStringVerbose, upPath, upPath, upPath, upPath, upPath, upPath

Methods inherited from class antlr.CommonAST
getText, getType, initialize, setText, setType

Methods inherited from class antlr.BaseAST
decode, encode, equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getFirstChild, getNextSibling, getNumberOfChildren, getTokenNames, setVerboseStringConversion, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen

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

Methods inherited from interface com.goldencode.ast.Aast
getImmediateChild

Methods inherited from interface antlr.collections.AST
equals, equalsList, equalsListPartial, equalsTree, equalsTreePartial, findAll, findAllPartial, getFirstChild, getNextSibling, getNumberOfChildren, getText, getType, initialize, setText, setType, toStringList, toStringTree

- Field Detail
  - reverse
```
private static java.util.HashMap reverse
```
    Provide a reverse lookup of token types to keyword text.
  - kwDict
```
private static KeywordDictionary kwDict
```
    Progress 4GL keyword forward lookup services.
- Constructor Detail
  - ProgressAst
```
public ProgressAst()
```
    Default constructor.
  - ProgressAst
```
public ProgressAst(antlr.Token token)
```
    Constructor which accepts and wrappers token.
    
    Parameters:
    
    token - Token upon which this node is based.
- Method Detail
  - lookupKeywordToken
```
public static int lookupKeywordToken(java.lang.String text)
```
    Given a partial (abbreviated) or full keyword text, lookup its token type.
    
    Parameters:
    
    text - The keyword text.
    
    Returns:
    
    Its token type or -1 if not found.
  - keyword
```
public static character keyword(character text)
```
    Duplicates the Progress 4GL KEYWORD built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL keyword.
    
    Parameters:
    
    text - The text to lookup.
    
    Returns:
    
    The full text of the matching keyword if it is found or unknown if there is no match.
  - keyword
```
public static character keyword(java.lang.String text)
```
    Duplicates the Progress 4GL KEYWORD built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL keyword.
    
    Parameters:
    
    text - The text to lookup.
    
    Returns:
    
    The full text of the matching keyword if it is found or unknown if there is no match.
  - _keyword
```
public static java.lang.String _keyword(java.lang.String text)
```
    Given a partial (abbreviated) or full keyword text, lookup its full text.
    
    Parameters:
    
    text - The keyword text.
    
    Returns:
    
    Its token type or null if not found.
  - keywordAll
```
public static character keywordAll(character text)
```
    Duplicates the Progress 4GL KEYWORD-ALL built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL RESERVED keyword.
    
    Parameters:
    
    text - The text to lookup.
    
    Returns:
    
    The full text of the matching RESERVED keyword if it is found or unknown if there is no match.
  - keywordAll
```
public static character keywordAll(java.lang.String text)
```
    Duplicates the Progress 4GL KEYWORD-ALL built-in function, which allows code to lookup if given text is a case-insensitive match (abbreviated or not) for any valid 4GL RESERVED keyword.
    
    Parameters:
    
    text - The text to lookup.
    
    Returns:
    
    The full text of the matching RESERVED keyword if it is found or unknown if there is no match.
  - keywordText
```
public java.lang.String keywordText(int type)
```
    Returns the "canonical" keyword text that is associated with a given token type if that type represents a known Progress 4GL language keyword.
    
    Parameters:
    
    type - The token type for which to reverse lookup the text.
    
    Returns:
    
    The keyword text or null if this type is not associated with a language keyword.
  - lookupTokenType
```
public int lookupTokenType(java.lang.String tokenName)
```
    Translates a text representation of a token type into the actual integer value.
    
    Specified by:
    
    lookupTokenType in interface Aast
    
    Specified by:
    
    lookupTokenType in class AnnotatedAst
    
    Parameters:
    
    tokenName - The text representation of the token type.
    
    Returns:
    
    A valid integer token type value or -1 if no match was found.
  - lookupTokenName
```
public java.lang.String lookupTokenName(int type)
```
    Translates an integer value of a token type into the associated human readable text representation.
    
    Specified by:
    
    lookupTokenName in interface Aast
    
    Specified by:
    
    lookupTokenName in class AnnotatedAst
    
    Parameters:
    
    type - The integer token type.
    
    Returns:
    
    A valid symbolic token type name or null if no match was found.
  - getSymbolicTokenType
```
public java.lang.String getSymbolicTokenType()
```
    Returns the symbolic representation of this AST's token type.
    
    Specified by:
    
    getSymbolicTokenType in interface Aast
    
    Specified by:
    
    getSymbolicTokenType in class AnnotatedAst
    
    Returns:
    
    Symbolic token name for this AST's token type.
  - getDescriptiveTokenText
```
public java.lang.String getDescriptiveTokenText()
```
    Returns a descriptive string for the current node. This string will normally contain both the text and the symbolic representation of this AST's token type. If the token type is not associated with a Progress 4GL language keyword then this will result in the same text as the getSymbolicTokenType(). Otherwise this will result in the keyword text followed by the symbolic token type in quare brackets.
    
    Specified by:
    
    getDescriptiveTokenText in interface Aast
    
    Overrides:
    
    getDescriptiveTokenText in class AnnotatedAst
    
    Returns:
    
    A descriptive string for the token type of this node.
  - newInstance
```
protected AnnotatedAst newInstance()
```
    Create a new instance of this AST implementation.
    
    Specified by:
    
    newInstance in class AnnotatedAst
    
    Returns:
    
    A new ProgressAst instance.
  - lookupWorker
```
private static Keyword lookupWorker(java.lang.String text)
```
    Lookup a keyword given partial (abbreviated) or full keyword text.
    
    Parameters:
    
    text - The keyword text to lookup.
    
    Returns:
    
    The keyword object found or null if no match is found.

Class ProgressAst

Field Summary

Fields inherited from class antlr.BaseAST

Fields inherited from interface com.goldencode.ast.Aast

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.ast.AnnotatedAst

Methods inherited from class antlr.CommonAST

Methods inherited from class antlr.BaseAST

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.ast.Aast

Methods inherited from interface antlr.collections.AST

Field Detail

reverse

kwDict

Constructor Detail

ProgressAst

ProgressAst

Method Detail

lookupKeywordToken

keyword

keyword

_keyword

keywordAll

keywordAll

keywordText

lookupTokenType

lookupTokenName

getSymbolicTokenType

getDescriptiveTokenText

newInstance

lookupWorker