Token.h revision 93dec51750411678bb9c5bc1b27b259f5f5a23bd
1//===--- Token.h - Token interface ------------------------------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines the Token interface. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_CLANG_TOKEN_H 15#define LLVM_CLANG_TOKEN_H 16 17#include "clang/Basic/TemplateKinds.h" 18#include "clang/Basic/TokenKinds.h" 19#include "clang/Basic/SourceLocation.h" 20#include "clang/Basic/OperatorKinds.h" 21#include <cstdlib> 22 23namespace clang { 24 25class IdentifierInfo; 26 27/// Token - This structure provides full information about a lexed token. 28/// It is not intended to be space efficient, it is intended to return as much 29/// information as possible about each returned token. This is expected to be 30/// compressed into a smaller form if memory footprint is important. 31/// 32/// The parser can create a special "annotation token" representing a stream of 33/// tokens that were parsed and semantically resolved, e.g.: "foo::MyClass<int>" 34/// can be represented by a single typename annotation token that carries 35/// information about the SourceRange of the tokens and the type object. 36class Token { 37 /// The location of the token. 38 SourceLocation Loc; 39 40 // Conceptually these next two fields could be in a union. However, this 41 // causes gcc 4.2 to pessimize LexTokenInternal, a very performance critical 42 // routine. Keeping as separate members with casts until a more beautiful fix 43 // presents itself. 44 45 /// UintData - This holds either the length of the token text, when 46 /// a normal token, or the end of the SourceRange when an annotation 47 /// token. 48 unsigned UintData; 49 50 /// PtrData - This is a union of four different pointer types, which depends 51 /// on what type of token this is: 52 /// Identifiers, keywords, etc: 53 /// This is an IdentifierInfo*, which contains the uniqued identifier 54 /// spelling. 55 /// Literals: isLiteral() returns true. 56 /// This is a pointer to the start of the token in a text buffer, which 57 /// may be dirty (have trigraphs / escaped newlines). 58 /// Annotations (resolved type names, C++ scopes, etc): isAnnotation(). 59 /// This is a pointer to sema-specific data for the annotation token. 60 /// Other: 61 /// This is null. 62 void *PtrData; 63 64 /// Kind - The actual flavor of token this is. 65 /// 66 unsigned short Kind; 67 68 /// Flags - Bits we track about this token, members of the TokenFlags enum. 69 unsigned char Flags; 70public: 71 72 // Various flags set per token: 73 enum TokenFlags { 74 StartOfLine = 0x01, // At start of line or only after whitespace. 75 LeadingSpace = 0x02, // Whitespace exists before this token. 76 DisableExpand = 0x04, // This identifier may never be macro expanded. 77 NeedsCleaning = 0x08, // Contained an escaped newline or trigraph. 78 LeadingEmptyMacro = 0x10, // Empty macro exists before this token. 79 HasUDSuffix = 0x20 // This string or character literal has a ud-suffix. 80 }; 81 82 tok::TokenKind getKind() const { return (tok::TokenKind)Kind; } 83 void setKind(tok::TokenKind K) { Kind = K; } 84 85 /// is/isNot - Predicates to check if this token is a specific kind, as in 86 /// "if (Tok.is(tok::l_brace)) {...}". 87 bool is(tok::TokenKind K) const { return Kind == (unsigned) K; } 88 bool isNot(tok::TokenKind K) const { return Kind != (unsigned) K; } 89 90 /// \brief Return true if this is a raw identifier (when lexing 91 /// in raw mode) or a non-keyword identifier (when lexing in non-raw mode). 92 bool isAnyIdentifier() const { 93 return is(tok::identifier) || is(tok::raw_identifier); 94 } 95 96 /// isLiteral - Return true if this is a "literal", like a numeric 97 /// constant, string, etc. 98 bool isLiteral() const { 99 return is(tok::numeric_constant) || is(tok::char_constant) || 100 is(tok::wide_char_constant) || is(tok::utf16_char_constant) || 101 is(tok::utf32_char_constant) || is(tok::string_literal) || 102 is(tok::wide_string_literal) || is(tok::utf8_string_literal) || 103 is(tok::utf16_string_literal) || is(tok::utf32_string_literal) || 104 is(tok::angle_string_literal); 105 } 106 107 bool isAnnotation() const { 108#define ANNOTATION(NAME) \ 109 if (is(tok::annot_##NAME)) \ 110 return true; 111#include "clang/Basic/TokenKinds.def" 112 return false; 113 } 114 115 /// \brief Return a source location identifier for the specified 116 /// offset in the current file. 117 SourceLocation getLocation() const { return Loc; } 118 unsigned getLength() const { 119 assert(!isAnnotation() && "Annotation tokens have no length field"); 120 return UintData; 121 } 122 123 void setLocation(SourceLocation L) { Loc = L; } 124 void setLength(unsigned Len) { 125 assert(!isAnnotation() && "Annotation tokens have no length field"); 126 UintData = Len; 127 } 128 129 SourceLocation getAnnotationEndLoc() const { 130 assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 131 return SourceLocation::getFromRawEncoding(UintData); 132 } 133 void setAnnotationEndLoc(SourceLocation L) { 134 assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 135 UintData = L.getRawEncoding(); 136 } 137 138 SourceLocation getLastLoc() const { 139 return isAnnotation() ? getAnnotationEndLoc() : getLocation(); 140 } 141 142 /// \brief SourceRange of the group of tokens that this annotation token 143 /// represents. 144 SourceRange getAnnotationRange() const { 145 return SourceRange(getLocation(), getAnnotationEndLoc()); 146 } 147 void setAnnotationRange(SourceRange R) { 148 setLocation(R.getBegin()); 149 setAnnotationEndLoc(R.getEnd()); 150 } 151 152 const char *getName() const { 153 return tok::getTokenName( (tok::TokenKind) Kind); 154 } 155 156 /// \brief Reset all flags to cleared. 157 void startToken() { 158 Kind = tok::unknown; 159 Flags = 0; 160 PtrData = 0; 161 UintData = 0; 162 Loc = SourceLocation(); 163 } 164 165 IdentifierInfo *getIdentifierInfo() const { 166 assert(isNot(tok::raw_identifier) && 167 "getIdentifierInfo() on a tok::raw_identifier token!"); 168 assert(!isAnnotation() && 169 "getIdentifierInfo() on an annotation token!"); 170 if (isLiteral()) return 0; 171 return (IdentifierInfo*) PtrData; 172 } 173 void setIdentifierInfo(IdentifierInfo *II) { 174 PtrData = (void*) II; 175 } 176 177 /// getRawIdentifierData - For a raw identifier token (i.e., an identifier 178 /// lexed in raw mode), returns a pointer to the start of it in the text 179 /// buffer if known, null otherwise. 180 const char *getRawIdentifierData() const { 181 assert(is(tok::raw_identifier)); 182 return reinterpret_cast<const char*>(PtrData); 183 } 184 void setRawIdentifierData(const char *Ptr) { 185 assert(is(tok::raw_identifier)); 186 PtrData = const_cast<char*>(Ptr); 187 } 188 189 /// getLiteralData - For a literal token (numeric constant, string, etc), this 190 /// returns a pointer to the start of it in the text buffer if known, null 191 /// otherwise. 192 const char *getLiteralData() const { 193 assert(isLiteral() && "Cannot get literal data of non-literal"); 194 return reinterpret_cast<const char*>(PtrData); 195 } 196 void setLiteralData(const char *Ptr) { 197 assert(isLiteral() && "Cannot set literal data of non-literal"); 198 PtrData = const_cast<char*>(Ptr); 199 } 200 201 void *getAnnotationValue() const { 202 assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 203 return PtrData; 204 } 205 void setAnnotationValue(void *val) { 206 assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 207 PtrData = val; 208 } 209 210 /// \brief Set the specified flag. 211 void setFlag(TokenFlags Flag) { 212 Flags |= Flag; 213 } 214 215 /// \brief Unset the specified flag. 216 void clearFlag(TokenFlags Flag) { 217 Flags &= ~Flag; 218 } 219 220 /// \brief Return the internal represtation of the flags. 221 /// 222 /// This is only intended for low-level operations such as writing tokens to 223 /// disk. 224 unsigned getFlags() const { 225 return Flags; 226 } 227 228 /// \brief Set a flag to either true or false. 229 void setFlagValue(TokenFlags Flag, bool Val) { 230 if (Val) 231 setFlag(Flag); 232 else 233 clearFlag(Flag); 234 } 235 236 /// isAtStartOfLine - Return true if this token is at the start of a line. 237 /// 238 bool isAtStartOfLine() const { return (Flags & StartOfLine) ? true : false; } 239 240 /// \brief Return true if this token has whitespace before it. 241 /// 242 bool hasLeadingSpace() const { return (Flags & LeadingSpace) ? true : false; } 243 244 /// \brief Return true if this identifier token should never 245 /// be expanded in the future, due to C99 6.10.3.4p2. 246 bool isExpandDisabled() const { 247 return (Flags & DisableExpand) ? true : false; 248 } 249 250 /// \brief Return true if we have an ObjC keyword identifier. 251 bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const; 252 253 /// \brief Return the ObjC keyword kind. 254 tok::ObjCKeywordKind getObjCKeywordID() const; 255 256 /// \brief Return true if this token has trigraphs or escaped newlines in it. 257 bool needsCleaning() const { return (Flags & NeedsCleaning) ? true : false; } 258 259 /// \brief Return true if this token has an empty macro before it. 260 /// 261 bool hasLeadingEmptyMacro() const { 262 return (Flags & LeadingEmptyMacro) ? true : false; 263 } 264 265 /// \brief Return true if this token is a string or character literal which 266 /// has a ud-suffix. 267 bool hasUDSuffix() const { return (Flags & HasUDSuffix) ? true : false; } 268}; 269 270/// \brief Information about the conditional stack (\#if directives) 271/// currently active. 272struct PPConditionalInfo { 273 /// \brief Location where the conditional started. 274 SourceLocation IfLoc; 275 276 /// \brief True if this was contained in a skipping directive, e.g., 277 /// in a "\#if 0" block. 278 bool WasSkipping; 279 280 /// \brief True if we have emitted tokens already, and now we're in 281 /// an \#else block or something. Only useful in Skipping blocks. 282 bool FoundNonSkip; 283 284 /// \brief True if we've seen a \#else in this block. If so, 285 /// \#elif/\#else directives are not allowed. 286 bool FoundElse; 287}; 288 289} // end namespace clang 290 291namespace llvm { 292 template <> 293 struct isPodLike<clang::Token> { static const bool value = true; }; 294} // end namespace llvm 295 296#endif 297