clang  3.7.0
Public Types | Public Member Functions | List of all members
clang::Token Class Reference

#include <Token.h>

Public Types

enum  TokenFlags {
  StartOfLine = 0x01, LeadingSpace = 0x02, DisableExpand = 0x04, NeedsCleaning = 0x08,
  LeadingEmptyMacro = 0x10, HasUDSuffix = 0x20, HasUCN = 0x40, IgnoredComma = 0x80,
  StringifiedInMacro = 0x100
}
 

Public Member Functions

tok::TokenKind getKind () const
 
void setKind (tok::TokenKind K)
 
bool is (tok::TokenKind K) const
 
bool isNot (tok::TokenKind K) const
 
bool isOneOf (tok::TokenKind K1, tok::TokenKind K2) const
 
template<typename... Ts>
bool isOneOf (tok::TokenKind K1, tok::TokenKind K2, Ts...Ks) const
 
bool isAnyIdentifier () const
 Return true if this is a raw identifier (when lexing in raw mode) or a non-keyword identifier (when lexing in non-raw mode). More...
 
bool isLiteral () const
 Return true if this is a "literal", like a numeric constant, string, etc. More...
 
bool isAnnotation () const
 Return true if this is any of tok::annot_* kind tokens. More...
 
SourceLocation getLocation () const
 Return a source location identifier for the specified offset in the current file. More...
 
unsigned getLength () const
 
void setLocation (SourceLocation L)
 
void setLength (unsigned Len)
 
SourceLocation getAnnotationEndLoc () const
 
void setAnnotationEndLoc (SourceLocation L)
 
SourceLocation getLastLoc () const
 
SourceLocation getEndLoc () const
 
SourceRange getAnnotationRange () const
 SourceRange of the group of tokens that this annotation token represents. More...
 
void setAnnotationRange (SourceRange R)
 
const char * getName () const
 
void startToken ()
 Reset all flags to cleared. More...
 
IdentifierInfogetIdentifierInfo () const
 
void setIdentifierInfo (IdentifierInfo *II)
 
const void * getEofData () const
 
void setEofData (const void *D)
 
StringRef getRawIdentifier () const
 
void setRawIdentifierData (const char *Ptr)
 
const char * getLiteralData () const
 
void setLiteralData (const char *Ptr)
 
void * getAnnotationValue () const
 
void setAnnotationValue (void *val)
 
void setFlag (TokenFlags Flag)
 Set the specified flag. More...
 
void clearFlag (TokenFlags Flag)
 Unset the specified flag. More...
 
unsigned getFlags () const
 Return the internal represtation of the flags. More...
 
void setFlagValue (TokenFlags Flag, bool Val)
 Set a flag to either true or false. More...
 
bool isAtStartOfLine () const
 
bool hasLeadingSpace () const
 Return true if this token has whitespace before it. More...
 
bool isExpandDisabled () const
 Return true if this identifier token should never be expanded in the future, due to C99 6.10.3.4p2. More...
 
bool isObjCAtKeyword (tok::ObjCKeywordKind objcKey) const
 Return true if we have an ObjC keyword identifier. More...
 
tok::ObjCKeywordKind getObjCKeywordID () const
 Return the ObjC keyword kind. More...
 
bool needsCleaning () const
 Return true if this token has trigraphs or escaped newlines in it. More...
 
bool hasLeadingEmptyMacro () const
 Return true if this token has an empty macro before it. More...
 
bool hasUDSuffix () const
 Return true if this token is a string or character literal which has a ud-suffix. More...
 
bool hasUCN () const
 Returns true if this token contains a universal character name. More...
 
bool stringifiedInMacro () const
 

Detailed Description

Token - This structure provides full information about a lexed token. It is not intended to be space efficient, it is intended to return as much information as possible about each returned token. This is expected to be compressed into a smaller form if memory footprint is important.

The parser can create a special "annotation token" representing a stream of tokens that were parsed and semantically resolved, e.g.: "foo::MyClass<int>" can be represented by a single typename annotation token that carries information about the SourceRange of the tokens and the type object.

Definition at line 37 of file Token.h.

Member Enumeration Documentation

Enumerator
StartOfLine 
LeadingSpace 
DisableExpand 
NeedsCleaning 
LeadingEmptyMacro 
HasUDSuffix 
HasUCN 
IgnoredComma 
StringifiedInMacro 

Definition at line 75 of file Token.h.

Member Function Documentation

void clang::Token::clearFlag ( TokenFlags  Flag)
inline

Unset the specified flag.

Definition at line 239 of file Token.h.

Referenced by setFlagValue().

SourceLocation clang::Token::getAnnotationEndLoc ( ) const
inline

Definition at line 138 of file Token.h.

References clang::SourceLocation::getFromRawEncoding(), and isAnnotation().

Referenced by getAnnotationRange(), getEndLoc(), and getLastLoc().

SourceRange clang::Token::getAnnotationRange ( ) const
inline

SourceRange of the group of tokens that this annotation token represents.

Definition at line 158 of file Token.h.

References getAnnotationEndLoc(), and getLocation().

Referenced by clang::Parser::TryAnnotateTypeOrScopeToken().

void* clang::Token::getAnnotationValue ( ) const
inline

Definition at line 224 of file Token.h.

References isAnnotation().

Referenced by clang::Parser::getTypeAnnotation(), and clang::Parser::ParseTopLevelDecl().

SourceLocation clang::Token::getEndLoc ( ) const
inline
const void* clang::Token::getEofData ( ) const
inline

Definition at line 190 of file Token.h.

References clang::comments::tok::eof, and is().

unsigned clang::Token::getFlags ( ) const
inline

Return the internal represtation of the flags.

This is only intended for low-level operations such as writing tokens to disk.

Definition at line 247 of file Token.h.

Referenced by clang::ASTWriter::AddToken().

IdentifierInfo* clang::Token::getIdentifierInfo ( ) const
inline
tok::TokenKind clang::Token::getKind ( ) const
inline
SourceLocation clang::Token::getLastLoc ( ) const
inline

Definition at line 147 of file Token.h.

References getAnnotationEndLoc(), getLocation(), and isAnnotation().

Referenced by clang::Parser::TryAnnotateTypeOrScopeToken().

unsigned clang::Token::getLength ( ) const
inline
const char* clang::Token::getLiteralData ( ) const
inline

getLiteralData - For a literal token (numeric constant, string, etc), this returns a pointer to the start of it in the text buffer if known, null otherwise.

Definition at line 215 of file Token.h.

References isLiteral().

Referenced by GetFirstChar(), clang::Lexer::getSpelling(), clang::Preprocessor::getSpellingOfSingleCharacterNumericConstant(), PrintPreprocessedTokens(), and UseNSOptionsMacro().

SourceLocation clang::Token::getLocation ( ) const
inline

Return a source location identifier for the specified offset in the current file.

Definition at line 124 of file Token.h.

References clang::SourceLocation::getFromRawEncoding().

Referenced by clang::Sema::ActOnCharacterConstant(), clang::Sema::ActOnNumericConstant(), clang::Sema::ActOnPragmaUnused(), clang::ASTWriter::AddToken(), clang::TokenConcatenation::AvoidConcat(), clang::Preprocessor::CheckEndOfDirective(), clang::Preprocessor::CheckMacroName(), clang::Sema::ClassifyName(), ComputeDATE_TIME(), clang::Lexer::ComputePreamble(), clang::Preprocessor::ConcatenateIncludeName(), clang::Parser::ConsumeToken(), clang::Parser::Diag(), clang::Preprocessor::Diag(), clang::DoPrintPreprocessedInput(), clang::Preprocessor::DumpToken(), EvaluateBuildingModule(), EvaluateDefined(), EvaluateDirectiveSubExpr(), EvaluateHasIncludeCommon(), EvaluateValue(), clang::Parser::ExitScope(), findDirectives(), FixDigraph(), getAnnotationRange(), getBeginningOfFileToken(), getEndLoc(), GetFirstChar(), getLastLoc(), GetLineValue(), clang::StringLiteralParser::getOffsetOfStringByte(), clang::Lexer::getSpelling(), clang::Preprocessor::getSpellingOfSingleCharacterNumericConstant(), clang::Preprocessor::HandleDirective(), clang::Preprocessor::HandleEndOfFile(), clang::Preprocessor::HandleIdentifier(), clang::Preprocessor::HandlePragmaDependency(), clang::Preprocessor::HandlePragmaIncludeAlias(), clang::Preprocessor::HandlePragmaPopMacro(), clang::Preprocessor::HandlePragmaSystemHeader(), clang::html::HighlightMacros(), clang::TokenLexer::Init(), clang::TokenLexer::Lex(), clang::Preprocessor::LexAfterModuleImport(), clang::PreprocessorLexer::LexIncludeFilename(), ParseAlignPragma(), ParseLoopHintValue(), clang::Parser::ParseMSAsmIdentifier(), clang::Preprocessor::ParsePragmaPushOrPopMacro(), clang::Preprocessor::parseSimpleIntegerLiteral(), clang::Parser::ParseTopLevelDecl(), clang::Parser::ParseUnqualifiedId(), PrintPreprocessedTokens(), ReadLineMarkerFlags(), clang::RewriteMacrosInInput(), clang::arcmt::trans::MigrationContext::rewritePropertyAttribute(), clang::html::SyntaxHighlight(), clang::Parser::TryAnnotateTypeOrScopeToken(), clang::Parser::TryAnnotateTypeOrScopeTokenAfterScopeSpec(), clang::Parser::TryConsumeToken(), and updateConsecutiveMacroArgTokens().

const char* clang::Token::getName ( ) const
inline

Definition at line 166 of file Token.h.

References clang::tok::getTokenName().

tok::ObjCKeywordKind Token::getObjCKeywordID ( ) const

Return the ObjC keyword kind.

getObjCKeywordID - Return the ObjC keyword kind.

Definition at line 43 of file Lexer.cpp.

References getIdentifierInfo(), and clang::IdentifierInfo::getObjCKeywordID().

StringRef clang::Token::getRawIdentifier ( ) const
inline

getRawIdentifier - For a raw identifier token (i.e., an identifier lexed in raw mode), returns a reference to the text substring in the buffer if known.

Definition at line 203 of file Token.h.

References getLength(), and is().

Referenced by clang::Lexer::ComputePreamble(), clang::Lexer::getSpelling(), and clang::Preprocessor::LookUpIdentifierInfo().

bool clang::Token::hasLeadingEmptyMacro ( ) const
inline

Return true if this token has an empty macro before it.

Definition at line 284 of file Token.h.

References LeadingEmptyMacro.

bool clang::Token::hasLeadingSpace ( ) const
inline
bool clang::Token::hasUCN ( ) const
inline

Returns true if this token contains a universal character name.

Definition at line 293 of file Token.h.

References HasUCN.

Referenced by clang::Lexer::getSpelling(), clang::Preprocessor::getSpelling(), and clang::Preprocessor::LookUpIdentifierInfo().

bool clang::Token::hasUDSuffix ( ) const
inline

Return true if this token is a string or character literal which has a ud-suffix.

Definition at line 290 of file Token.h.

References HasUDSuffix.

Referenced by clang::TokenConcatenation::AvoidConcat(), EvaluateValue(), clang::Preprocessor::FinishLexStringLiteral(), and clang::Preprocessor::ParsePragmaPushOrPopMacro().

bool clang::Token::is ( tok::TokenKind  K) const
inline

is/isNot - Predicates to check if this token is a specific kind, as in "if (Tok.is(tok::l_brace)) {...}".

Definition at line 95 of file Token.h.

Referenced by clang::TokenConcatenation::AvoidConcat(), buildMSAsmString(), clang::Preprocessor::CheckEndOfDirective(), clang::Preprocessor::CheckMacroName(), clang::Sema::ClassifyName(), clang::Preprocessor::ConcatenateIncludeName(), clang::BalancedDelimiterTracker::consumeClose(), clang::BalancedDelimiterTracker::consumeOpen(), clang::Preprocessor::CreateString(), clang::DoPrintPreprocessedInput(), EvaluateDefined(), EvaluateHasIncludeCommon(), EvaluateValue(), findDirectives(), clang::Preprocessor::FinishLexStringLiteral(), clang::PTHLexer::getEOF(), getEofData(), getIdentifierInfo(), getRawIdentifier(), clang::Lexer::getSpelling(), clang::Preprocessor::getSpellingOfSingleCharacterNumericConstant(), getSpellingSlow(), clang::MacroArgs::getUnexpArgument(), clang::Preprocessor::HandleDirective(), clang::Preprocessor::HandleMicrosoftCommentPaste(), clang::Preprocessor::HandlePragmaDependency(), clang::Preprocessor::HandlePragmaIncludeAlias(), clang::Preprocessor::HandlePragmaPoison(), clang::html::HighlightMacros(), clang::format::FormatToken::is(), IsCommonTypo(), clang::TokenLexer::isNextTokenLParen(), isOneOf(), clang::TokenLexer::isParsingPreprocessorDirective(), isResultTypeOrTemplate(), isWideStringLiteralFromMacro(), clang::TokenLexer::Lex(), clang::Preprocessor::Lex(), clang::PreprocessorLexer::LexIncludeFilename(), LexRawTokensFromMainFile(), clang::Parser::ParseAssignmentExpression(), ParseLoopHintValue(), clang::Parser::ParseMSAsmIdentifier(), clang::Preprocessor::parseSimpleIntegerLiteral(), clang::Parser::ParseTopLevelDecl(), clang::Parser::ParseUnqualifiedId(), PrintPreprocessedTokens(), ReadLineMarkerFlags(), clang::Lexer::ReadToEndOfLine(), clang::RewriteMacrosInInput(), clang::arcmt::trans::MigrationContext::rewritePropertyAttribute(), setEofData(), setRawIdentifierData(), clang::Parser::SkipMalformedDecl(), clang::Parser::SkipUntil(), clang::MacroArgs::StringifyArgument(), clang::Parser::TryAnnotateCXXScopeToken(), clang::Parser::TryAnnotateTypeOrScopeToken(), and clang::Parser::TryAnnotateTypeOrScopeTokenAfterScopeSpec().

bool clang::Token::isAnnotation ( ) const
inline
bool clang::Token::isAnyIdentifier ( ) const
inline

Return true if this is a raw identifier (when lexing in raw mode) or a non-keyword identifier (when lexing in non-raw mode).

Definition at line 107 of file Token.h.

References getKind(), and clang::tok::isAnyIdentifier().

bool clang::Token::isAtStartOfLine ( ) const
inline
bool clang::Token::isExpandDisabled ( ) const
inline

Return true if this identifier token should never be expanded in the future, due to C99 6.10.3.4p2.

Definition at line 269 of file Token.h.

References DisableExpand.

Referenced by clang::Preprocessor::DumpToken(), and clang::Preprocessor::HandleIdentifier().

bool clang::Token::isLiteral ( ) const
inline
bool clang::Token::isNot ( tok::TokenKind  K) const
inline

Definition at line 96 of file Token.h.

Referenced by clang::MacroArgs::ArgNeedsPreexpansion(), clang::TokenConcatenation::AvoidConcat(), clang::CacheTokens(), clang::Preprocessor::CheckEndOfDirective(), clang::Preprocessor::ConcatenateIncludeName(), clang::Preprocessor::DiscardUntilEndOfDirective(), DoPrintMacros(), EvaluateBuildingModule(), EvaluateDefined(), EvaluateDirectiveSubExpr(), EvaluateHasIncludeCommon(), EvaluateValue(), clang::DumpRawTokensAction::ExecuteAction(), clang::DumpTokensAction::ExecuteAction(), clang::PreprocessOnlyAction::ExecuteAction(), findDirectives(), clang::Preprocessor::FinishLexStringLiteral(), clang::MacroArgs::getArgLength(), getIdentifierInfo(), GetLineValue(), clang::Preprocessor::getSpelling(), clang::Preprocessor::HandleMicrosoftCommentPaste(), clang::Preprocessor::HandlePragmaDependency(), clang::Preprocessor::HandlePragmaIncludeAlias(), clang::Preprocessor::HandlePragmaPoison(), clang::html::HighlightMacros(), clang::Preprocessor::LexOnOffSwitch(), LexRawTokensFromMainFile(), ParseAlignPragma(), ParseLoopHintValue(), clang::Preprocessor::ParsePragmaPushOrPopMacro(), clang::Parser::ParseUnqualifiedId(), clang::RewriteIncludesInInput(), clang::RewriteMacrosInInput(), clang::arcmt::trans::MigrationContext::rewritePropertyAttribute(), clang::Parser::SkipUntil(), clang::MacroArgs::StringifyArgument(), clang::html::SyntaxHighlight(), clang::format::tokenCanStartNewLine(), clang::TokenRewriter::TokenRewriter(), and clang::Parser::TryConsumeToken().

bool Token::isObjCAtKeyword ( tok::ObjCKeywordKind  objcKey) const

Return true if we have an ObjC keyword identifier.

isObjCAtKeyword - Return true if we have an ObjC keyword identifier.

Definition at line 36 of file Lexer.cpp.

References getIdentifierInfo().

Referenced by clang::format::FormatToken::isObjCAtKeyword(), and clang::Parser::SkipMalformedDecl().

bool clang::Token::isOneOf ( tok::TokenKind  K1,
tok::TokenKind  K2 
) const
inline
template<typename... Ts>
bool clang::Token::isOneOf ( tok::TokenKind  K1,
tok::TokenKind  K2,
Ts...  Ks 
) const
inline

Definition at line 101 of file Token.h.

References is(), and isOneOf().

bool clang::Token::needsCleaning ( ) const
inline
void clang::Token::setAnnotationEndLoc ( SourceLocation  L)
inline
void clang::Token::setAnnotationRange ( SourceRange  R)
inline
void clang::Token::setAnnotationValue ( void *  val)
inline

Definition at line 228 of file Token.h.

References isAnnotation().

Referenced by EnterAnnotationToken(), clang::Preprocessor::HandleEndOfFile(), and ParseAlignPragma().

void clang::Token::setEofData ( const void *  D)
inline

Definition at line 194 of file Token.h.

References clang::comments::tok::eof, and is().

void clang::Token::setFlag ( TokenFlags  Flag)
inline
void clang::Token::setFlagValue ( TokenFlags  Flag,
bool  Val 
)
inline

Set a flag to either true or false.

Definition at line 252 of file Token.h.

References clearFlag(), and setFlag().

Referenced by clang::TokenLexer::Lex().

void clang::Token::setIdentifierInfo ( IdentifierInfo II)
inline
void clang::Token::setKind ( tok::TokenKind  K)
inline
void clang::Token::setLength ( unsigned  Len)
inline
void clang::Token::setLiteralData ( const char *  Ptr)
inline

Definition at line 219 of file Token.h.

References isLiteral().

Referenced by clang::Preprocessor::CreateString(), and clang::PTHLexer::Lex().

void clang::Token::setLocation ( SourceLocation  L)
inline
void clang::Token::setRawIdentifierData ( const char *  Ptr)
inline

Definition at line 207 of file Token.h.

References is().

Referenced by clang::Preprocessor::CreateString().

void clang::Token::startToken ( )
inline
bool clang::Token::stringifiedInMacro ( ) const
inline

Returns true if this token is formed by macro by stringizing or charizing operator.

Definition at line 297 of file Token.h.

References StringifiedInMacro.

Referenced by isWideStringLiteralFromMacro().


The documentation for this class was generated from the following files: