org.apache.flex.compiler.internal.parsing.as

Class ASToken

java.lang.Object

antlr.Token

org.apache.flex.compiler.internal.parsing.TokenBase

org.apache.flex.compiler.internal.parsing.as.ASToken

All Implemented Interfaces:

Cloneable, ISourceLocation, ASTokenTypes, IASToken, ICMToken

Direct Known Subclasses:

MetaDataPayloadToken, MXMLToken

public class ASToken
extends TokenBase
implements IASToken, ASTokenTypes

ActionScript token (output unit of ASTokenizer/ASTokenFixer, input unit of ASTreeAssembler).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.parsing.IASToken

IASToken.ASTokenKind

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_OPEN_BLOCK_TOKEN_TYPE Unknown open block token type.

Fields inherited from class antlr.Token

badToken, EOF_TYPE, INVALID_TYPE, MIN_USER_TYPE, NULL_TREE_LOOKAHEAD, SKIP, type

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Fields inherited from interface org.apache.flex.compiler.internal.parsing.as.ASTokenTypes

EOF, HIDDEN_TOKEN_BUILTIN_NS, HIDDEN_TOKEN_COMMENT, HIDDEN_TOKEN_E4X, HIDDEN_TOKEN_MULTI_LINE_COMMENT, HIDDEN_TOKEN_SINGLE_LINE_COMMENT, HIDDEN_TOKEN_STAR_ASSIGNMENT, NULL_TREE_LOOKAHEAD, TOKEN_ASDOC_COMMENT, TOKEN_ASDOC_TAG, TOKEN_ASDOC_TEXT, TOKEN_ATTRIBUTE, TOKEN_BLOCK_CLOSE, TOKEN_BLOCK_OPEN, TOKEN_COLON, TOKEN_COMMA, TOKEN_DIRECTIVE_DEFAULT_XML, TOKEN_E4X_BINDING_CLOSE, TOKEN_E4X_BINDING_OPEN, TOKEN_E4X_CDATA, TOKEN_E4X_CLOSE_TAG_START, TOKEN_E4X_COMMENT, TOKEN_E4X_DECIMAL_ENTITY, TOKEN_E4X_DOTTED_NAME_PART, TOKEN_E4X_EMPTY_TAG_END, TOKEN_E4X_ENTITY, TOKEN_E4X_EQUALS, TOKEN_E4X_HEX_ENTITY, TOKEN_E4X_NAME, TOKEN_E4X_NAME_DOT, TOKEN_E4X_OPEN_TAG_START, TOKEN_E4X_PROCESSING_INSTRUCTION, TOKEN_E4X_STRING, TOKEN_E4X_TAG_END, TOKEN_E4X_TEXT, TOKEN_E4X_WHITESPACE, TOKEN_E4X_XMLLIST_CLOSE, TOKEN_E4X_XMLNS, TOKEN_ELLIPSIS, TOKEN_IDENTIFIER, TOKEN_KEYWORD_AS, TOKEN_KEYWORD_BREAK, TOKEN_KEYWORD_CASE, TOKEN_KEYWORD_CATCH, TOKEN_KEYWORD_CLASS, TOKEN_KEYWORD_CONST, TOKEN_KEYWORD_CONTINUE, TOKEN_KEYWORD_DEFAULT, TOKEN_KEYWORD_DELETE, TOKEN_KEYWORD_DO, TOKEN_KEYWORD_ELSE, TOKEN_KEYWORD_FALSE, TOKEN_KEYWORD_FINALLY, TOKEN_KEYWORD_FOR, TOKEN_KEYWORD_FUNCTION, TOKEN_KEYWORD_IF, TOKEN_KEYWORD_IMPORT, TOKEN_KEYWORD_IN, TOKEN_KEYWORD_INCLUDE, TOKEN_KEYWORD_INSTANCEOF, TOKEN_KEYWORD_INTERFACE, TOKEN_KEYWORD_IS, TOKEN_KEYWORD_NEW, TOKEN_KEYWORD_NULL, TOKEN_KEYWORD_PACKAGE, TOKEN_KEYWORD_RETURN, TOKEN_KEYWORD_SUPER, TOKEN_KEYWORD_SWITCH, TOKEN_KEYWORD_THIS, TOKEN_KEYWORD_THROW, TOKEN_KEYWORD_TRUE, TOKEN_KEYWORD_TRY, TOKEN_KEYWORD_TYPEOF, TOKEN_KEYWORD_USE, TOKEN_KEYWORD_VAR, TOKEN_KEYWORD_VOID, TOKEN_KEYWORD_WHILE, TOKEN_KEYWORD_WITH, TOKEN_LITERAL_HEX_NUMBER, TOKEN_LITERAL_NUMBER, TOKEN_LITERAL_REGEXP, TOKEN_LITERAL_STRING, TOKEN_LITERAL_XMLLIST, TOKEN_MODIFIER_DYNAMIC, TOKEN_MODIFIER_FINAL, TOKEN_MODIFIER_NATIVE, TOKEN_MODIFIER_OVERRIDE, TOKEN_MODIFIER_STATIC, TOKEN_MODIFIER_VIRTUAL, TOKEN_NAMESPACE_ANNOTATION, TOKEN_NAMESPACE_NAME, TOKEN_OPERATOR_ASSIGNMENT, TOKEN_OPERATOR_ATSIGN, TOKEN_OPERATOR_BITWISE_AND, TOKEN_OPERATOR_BITWISE_AND_ASSIGNMENT, TOKEN_OPERATOR_BITWISE_LEFT_SHIFT, TOKEN_OPERATOR_BITWISE_LEFT_SHIFT_ASSIGNMENT, TOKEN_OPERATOR_BITWISE_NOT, TOKEN_OPERATOR_BITWISE_OR, TOKEN_OPERATOR_BITWISE_OR_ASSIGNMENT, TOKEN_OPERATOR_BITWISE_RIGHT_SHIFT, TOKEN_OPERATOR_BITWISE_RIGHT_SHIFT_ASSIGNMENT, TOKEN_OPERATOR_BITWISE_UNSIGNED_RIGHT_SHIFT, TOKEN_OPERATOR_BITWISE_UNSIGNED_RIGHT_SHIFT_ASSIGNMENT, TOKEN_OPERATOR_BITWISE_XOR, TOKEN_OPERATOR_BITWISE_XOR_ASSIGNMENT, TOKEN_OPERATOR_DECREMENT, TOKEN_OPERATOR_DESCENDANT_ACCESS, TOKEN_OPERATOR_DIVISION, TOKEN_OPERATOR_DIVISION_ASSIGNMENT, TOKEN_OPERATOR_EQUAL, TOKEN_OPERATOR_GREATER_THAN, TOKEN_OPERATOR_GREATER_THAN_EQUALS, TOKEN_OPERATOR_INCREMENT, TOKEN_OPERATOR_LESS_THAN, TOKEN_OPERATOR_LESS_THAN_EQUALS, TOKEN_OPERATOR_LOGICAL_AND, TOKEN_OPERATOR_LOGICAL_AND_ASSIGNMENT, TOKEN_OPERATOR_LOGICAL_NOT, TOKEN_OPERATOR_LOGICAL_OR, TOKEN_OPERATOR_LOGICAL_OR_ASSIGNMENT, TOKEN_OPERATOR_MEMBER_ACCESS, TOKEN_OPERATOR_MINUS, TOKEN_OPERATOR_MINUS_ASSIGNMENT, TOKEN_OPERATOR_MODULO, TOKEN_OPERATOR_MODULO_ASSIGNMENT, TOKEN_OPERATOR_MULTIPLICATION_ASSIGNMENT, TOKEN_OPERATOR_NOT_EQUAL, TOKEN_OPERATOR_NS_QUALIFIER, TOKEN_OPERATOR_PLUS, TOKEN_OPERATOR_PLUS_ASSIGNMENT, TOKEN_OPERATOR_STAR, TOKEN_OPERATOR_STRICT_EQUAL, TOKEN_OPERATOR_STRICT_NOT_EQUAL, TOKEN_OPERATOR_TERNARY, TOKEN_PAREN_CLOSE, TOKEN_PAREN_OPEN, TOKEN_RESERVED_WORD_CONFIG, TOKEN_RESERVED_WORD_EACH, TOKEN_RESERVED_WORD_EXTENDS, TOKEN_RESERVED_WORD_GET, TOKEN_RESERVED_WORD_GOTO, TOKEN_RESERVED_WORD_IMPLEMENTS, TOKEN_RESERVED_WORD_NAMESPACE, TOKEN_RESERVED_WORD_SET, TOKEN_SEMICOLON, TOKEN_SQUARE_CLOSE, TOKEN_SQUARE_OPEN, TOKEN_TYPED_COLLECTION_CLOSE, TOKEN_TYPED_COLLECTION_OPEN, TOKEN_TYPED_LITERAL_CLOSE, TOKEN_TYPED_LITERAL_OPEN, TOKEN_VOID_0

Constructor Summary

Constructors

Constructor and Description
ASToken(ASToken other) Copy constructor
ASToken(int tokenType, int start, int end, int line, int column, CharSequence tokenText) Builds a new ASToken

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCauseContainmentProblems() Determine whether or not this token is capable of causing a containment problem.
boolean	canExistInMetadata()
static boolean	canExistInMetadata(int tokenType)
boolean	canFollowMetadata()
static boolean	canFollowMetadata(int tokenType)
boolean	canFollowUserNamespace()
static boolean	canFollowUserNamespaceAnnotation(int tokenType)
boolean	canPreceedAnonymousFunction()
boolean	canPreceedE4X()
static boolean	canPreceedE4X(int tokenType)
static boolean	canPreceedRegex(int tokenType) Check if regular-expression literal can follow a token of given type.
boolean	canPreceedSignedOperator() Returns true if the token can come before the operators + or -
static boolean	canPreceedSignedOperator(int tokenType) Returns true if the token type can come before the operators + or -
ICMToken	changeType(int type) Changes the type of the token, and returns a new copy with the desired type.
ASToken	clone()
int	getBalancingToken() If this is an open token, get the matching close token.
static int	getBalancingToken(int tokenType) If this is an open token, get the matching close token.
int	getOpenBlockTokenType()
static int	getOpenBlockTokenType(int tokenType)
IASToken.ASTokenKind	getTokenKind() Returns the kind of token that we represent.
protected String	getTypeString() Get the display string for the token type
boolean	isCloseBlockToken() Is this a close block token
static boolean	isCloseBlockToken(int tokenType) Is this a close token
boolean	isCloseToken() Is this a close token (e.g. ")", "}", "]")
static boolean	isCloseToken(int tokenType) Is this a close token (e.g. ")", "}", "]")
boolean	isContextualReservedWord() Check if the token is a contextual reserved word.
static boolean	isDefinitionKeyword(int type)
boolean	isE4X()
static boolean	isE4X(int type)
boolean	isKeyword() Returns whether this token represents an ActionScript keyword.
boolean	isKeywordOrContextualReservedWord() Check if the token is either a "keyword" or a "contextual reserved word".
boolean	isLiteral()
boolean	isModifier()
static boolean	isModifier(int type)
boolean	isMultiLineComment()
boolean	isOpenBlockToken() Is this an open block token
static boolean	isOpenBlockToken(int tokenType)
boolean	isOpenToken() Is this an open token (e.g. "(", "{", "[")
static boolean	isOpenToken(int tokenType) Is this an open token (e.g. "(", "{", "[")
boolean	isOperator()
boolean	isStatementKeyword()
static boolean	isStatementKeyword(int type)
static IASToken.ASTokenKind	typeToKind(int type) Get IASToken.ASTokenKind from a given token type.

Methods inherited from class org.apache.flex.compiler.internal.parsing.TokenBase

adjustLocation, adjustOffsets, getAbsoluteEnd, getAbsoluteStart, getCharSequence, getColumn, getEnd, getEndColumn, getEndLine, getLine, getLocalEnd, getLocalStart, getSourcePath, getStart, getText, isImplicit, isLocked, lock, matchesLine, reuse, setColumn, setEnd, setEndColumn, setEndLine, setLine, setLocation, setSourcePath, setStart, setText, setText, storeLocalOffset, toDumpString, toString, truncate, verify

Methods inherited from class antlr.Token

getFilename, getType, setFilename, setType

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flex.compiler.parsing.ICMToken

getColumn, getEnd, getLine, getSourcePath, getStart, getText, getType, isImplicit

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Field Detail

UNKNOWN_OPEN_BLOCK_TOKEN_TYPE

public static final int UNKNOWN_OPEN_BLOCK_TOKEN_TYPE

Unknown open block token type.

See Also:

getOpenBlockTokenType(), Constant Field Values

Constructor Detail

ASToken

public ASToken(int tokenType,
       int start,
       int end,
       int line,
       int column,
       CharSequence tokenText)

Builds a new ASToken

Parameters:

tokenType - type of token

start - start of token

end - end of token

line - line of token

tokenText - token type from ASTokenTypes

ASToken

public ASToken(ASToken other)

Copy constructor

Parameters:

other - the ASToken to copy

Method Detail

clone

public ASToken clone()

Overrides:

clone in class Object

changeType

public ICMToken changeType(int type)

Description copied from interface: ICMToken

Changes the type of the token, and returns a new copy with the desired type. This is non-destructive

Specified by:

changeType in interface ICMToken

Parameters:

type - the type of token to create

Returns:

a new ICMToken that is a copy of the original, with a different type

isOpenToken

public static final boolean isOpenToken(int tokenType)

Is this an open token (e.g. "(", "{", "[")

Parameters:

tokenType - type of the token

Returns:

true iff this is an open token

getOpenBlockTokenType

public static final int getOpenBlockTokenType(int tokenType)

getOpenBlockTokenType

public final int getOpenBlockTokenType()

isOpenBlockToken

public final boolean isOpenBlockToken()

Is this an open block token

Returns:

true if this is an open block token

isOpenBlockToken

public static final boolean isOpenBlockToken(int tokenType)

isOpenToken

public final boolean isOpenToken()

Is this an open token (e.g. "(", "{", "[")

Returns:

true iff this is an open token

isCloseToken

public static final boolean isCloseToken(int tokenType)

Is this a close token (e.g. ")", "}", "]")

Parameters:

tokenType - type of the token

Returns:

true if this is an close token

isCloseBlockToken

public final boolean isCloseBlockToken()

Is this a close block token

Returns:

true if this is a close block token

isCloseBlockToken

public static final boolean isCloseBlockToken(int tokenType)

Is this a close token

Parameters:

tokenType - type of the token

Returns:

true if this is an close token

isCloseToken

public final boolean isCloseToken()

Is this a close token (e.g. ")", "}", "]")

Returns:

true iff this is an close token

getBalancingToken

public static final int getBalancingToken(int tokenType)

If this is an open token, get the matching close token. If this is a close token, get the matching open token

Parameters:

tokenType - type of the token

Returns:

balancing token (or 0 if this isn't an open/close token)

getBalancingToken

public final int getBalancingToken()

If this is an open token, get the matching close token. If this is a close token, get the matching open token

Returns:

balancing token (or 0 if this isn't an open/close token)

canCauseContainmentProblems

public final boolean canCauseContainmentProblems()

Determine whether or not this token is capable of causing a containment problem. If a token can cause canContain to return false when it's passed in as containedType, then it must return true. This is used to improve the performance of ASTokenFixer.locateBottommostContainerProblem.

Returns:

true iff the token can cause canContain to return false.

isOperator

public final boolean isOperator()

isE4X

public final boolean isE4X()

isE4X

public static final boolean isE4X(int type)

isLiteral

public final boolean isLiteral()

isDefinitionKeyword

public static final boolean isDefinitionKeyword(int type)

isModifier

public static boolean isModifier(int type)

isModifier

public final boolean isModifier()

isStatementKeyword

public static final boolean isStatementKeyword(int type)

isStatementKeyword

public final boolean isStatementKeyword()

isContextualReservedWord

public final boolean isContextualReservedWord()

Check if the token is a contextual reserved word.

Returns:

True if the token is a contextual reserved word.

isKeyword

public final boolean isKeyword()

Returns whether this token represents an ActionScript keyword.

For missing "private", "protected", "public", "internal", see https://bugs.adobe.com/jira/browse/ASLSPEC-8

Returns:

True if the token is a reserved keyword.

isKeywordOrContextualReservedWord

public final boolean isKeywordOrContextualReservedWord()

Check if the token is either a "keyword" or a "contextual reserved word".

Returns:

True if the token is either a "keyword" or a "contextual reserved word".

canExistInMetadata

public static final boolean canExistInMetadata(int tokenType)

canExistInMetadata

public final boolean canExistInMetadata()

canFollowMetadata

public static final boolean canFollowMetadata(int tokenType)

canFollowMetadata

public final boolean canFollowMetadata()

canFollowUserNamespaceAnnotation

public static final boolean canFollowUserNamespaceAnnotation(int tokenType)

canFollowUserNamespace

public final boolean canFollowUserNamespace()

canPreceedAnonymousFunction

public final boolean canPreceedAnonymousFunction()

Returns:

True if a "function" keyword after this token should be considered an anonymous function (closure).

canPreceedSignedOperator

public static final boolean canPreceedSignedOperator(int tokenType)

Returns true if the token type can come before the operators + or -

Parameters:

tokenType - the token type to check

Returns:

true if able to come before

canPreceedSignedOperator

public final boolean canPreceedSignedOperator()

Returns true if the token can come before the operators + or -

Returns:

true if able to come before

canPreceedE4X

public final boolean canPreceedE4X()

canPreceedE4X

public static final boolean canPreceedE4X(int tokenType)

canPreceedRegex

public static final boolean canPreceedRegex(int tokenType)

Check if regular-expression literal can follow a token of given type.

Parameters:

tokenType - Token type

Returns:

True if ASTokenTypes.TOKEN_LITERAL_REGEXP can follow the given token type.

getTypeString

protected String getTypeString()

Get the display string for the token type

Specified by:

getTypeString in class TokenBase

Returns:

display string for the token type

getTokenKind

public IASToken.ASTokenKind getTokenKind()

Description copied from interface: IASToken

Returns the kind of token that we represent.

Specified by:

getTokenKind in interface IASToken

Returns:

a token kind, seen in TokenKind

typeToKind

public static IASToken.ASTokenKind typeToKind(int type)

Get IASToken.ASTokenKind from a given token type.

Parameters:

type - AS token type.

Returns:

Token kind.

isMultiLineComment

public final boolean isMultiLineComment()

Specified by:

isMultiLineComment in interface IASToken

Returns:

True if this token is a multi-line comment such as ASTokenTypes.TOKEN_ASDOC_COMMENT and ASTokenTypes.HIDDEN_TOKEN_MULTI_LINE_COMMENT.