1 //===--- Token.h - Token interface ------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the Token interface.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_TOKEN_H
15 #define LLVM_CLANG_TOKEN_H
17 #include "clang/Basic/OperatorKinds.h"
18 #include "clang/Basic/SourceLocation.h"
19 #include "clang/Basic/TemplateKinds.h"
20 #include "clang/Basic/TokenKinds.h"
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.
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.
37 /// The location of the token.
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
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
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
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.
64 /// Kind - The actual flavor of token this is.
68 /// Flags - Bits we track about this token, members of the TokenFlags enum.
72 // Various flags set per token:
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 HasUCN = 0x40 // This identifier contains a UCN.
83 tok::TokenKind getKind() const { return (tok::TokenKind)Kind; }
84 void setKind(tok::TokenKind K) { Kind = K; }
86 /// is/isNot - Predicates to check if this token is a specific kind, as in
87 /// "if (Tok.is(tok::l_brace)) {...}".
88 bool is(tok::TokenKind K) const { return Kind == (unsigned) K; }
89 bool isNot(tok::TokenKind K) const { return Kind != (unsigned) K; }
91 /// \brief Return true if this is a raw identifier (when lexing
92 /// in raw mode) or a non-keyword identifier (when lexing in non-raw mode).
93 bool isAnyIdentifier() const {
94 return tok::isAnyIdentifier(getKind());
97 /// \brief Return true if this is a "literal", like a numeric
98 /// constant, string, etc.
99 bool isLiteral() const {
100 return tok::isLiteral(getKind());
103 /// \brief Return true if this is any of tok::annot_* kind tokens.
104 bool isAnnotation() const {
105 return tok::isAnnotation(getKind());
108 /// \brief Return a source location identifier for the specified
109 /// offset in the current file.
110 SourceLocation getLocation() const { return Loc; }
111 unsigned getLength() const {
112 assert(!isAnnotation() && "Annotation tokens have no length field");
116 void setLocation(SourceLocation L) { Loc = L; }
117 void setLength(unsigned Len) {
118 assert(!isAnnotation() && "Annotation tokens have no length field");
122 SourceLocation getAnnotationEndLoc() const {
123 assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token");
124 return SourceLocation::getFromRawEncoding(UintData);
126 void setAnnotationEndLoc(SourceLocation L) {
127 assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token");
128 UintData = L.getRawEncoding();
131 SourceLocation getLastLoc() const {
132 return isAnnotation() ? getAnnotationEndLoc() : getLocation();
135 /// \brief SourceRange of the group of tokens that this annotation token
137 SourceRange getAnnotationRange() const {
138 return SourceRange(getLocation(), getAnnotationEndLoc());
140 void setAnnotationRange(SourceRange R) {
141 setLocation(R.getBegin());
142 setAnnotationEndLoc(R.getEnd());
145 const char *getName() const {
146 return tok::getTokenName( (tok::TokenKind) Kind);
149 /// \brief Reset all flags to cleared.
155 Loc = SourceLocation();
158 IdentifierInfo *getIdentifierInfo() const {
159 assert(isNot(tok::raw_identifier) &&
160 "getIdentifierInfo() on a tok::raw_identifier token!");
161 assert(!isAnnotation() &&
162 "getIdentifierInfo() on an annotation token!");
163 if (isLiteral()) return 0;
164 return (IdentifierInfo*) PtrData;
166 void setIdentifierInfo(IdentifierInfo *II) {
167 PtrData = (void*) II;
170 /// getRawIdentifierData - For a raw identifier token (i.e., an identifier
171 /// lexed in raw mode), returns a pointer to the start of it in the text
172 /// buffer if known, null otherwise.
173 const char *getRawIdentifierData() const {
174 assert(is(tok::raw_identifier));
175 return reinterpret_cast<const char*>(PtrData);
177 void setRawIdentifierData(const char *Ptr) {
178 assert(is(tok::raw_identifier));
179 PtrData = const_cast<char*>(Ptr);
182 /// getLiteralData - For a literal token (numeric constant, string, etc), this
183 /// returns a pointer to the start of it in the text buffer if known, null
185 const char *getLiteralData() const {
186 assert(isLiteral() && "Cannot get literal data of non-literal");
187 return reinterpret_cast<const char*>(PtrData);
189 void setLiteralData(const char *Ptr) {
190 assert(isLiteral() && "Cannot set literal data of non-literal");
191 PtrData = const_cast<char*>(Ptr);
194 void *getAnnotationValue() const {
195 assert(isAnnotation() && "Used AnnotVal on non-annotation token");
198 void setAnnotationValue(void *val) {
199 assert(isAnnotation() && "Used AnnotVal on non-annotation token");
203 /// \brief Set the specified flag.
204 void setFlag(TokenFlags Flag) {
208 /// \brief Unset the specified flag.
209 void clearFlag(TokenFlags Flag) {
213 /// \brief Return the internal represtation of the flags.
215 /// This is only intended for low-level operations such as writing tokens to
217 unsigned getFlags() const {
221 /// \brief Set a flag to either true or false.
222 void setFlagValue(TokenFlags Flag, bool Val) {
229 /// isAtStartOfLine - Return true if this token is at the start of a line.
231 bool isAtStartOfLine() const { return (Flags & StartOfLine) ? true : false; }
233 /// \brief Return true if this token has whitespace before it.
235 bool hasLeadingSpace() const { return (Flags & LeadingSpace) ? true : false; }
237 /// \brief Return true if this identifier token should never
238 /// be expanded in the future, due to C99 6.10.3.4p2.
239 bool isExpandDisabled() const {
240 return (Flags & DisableExpand) ? true : false;
243 /// \brief Return true if we have an ObjC keyword identifier.
244 bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const;
246 /// \brief Return the ObjC keyword kind.
247 tok::ObjCKeywordKind getObjCKeywordID() const;
249 /// \brief Return true if this token has trigraphs or escaped newlines in it.
250 bool needsCleaning() const { return (Flags & NeedsCleaning) ? true : false; }
252 /// \brief Return true if this token has an empty macro before it.
254 bool hasLeadingEmptyMacro() const {
255 return (Flags & LeadingEmptyMacro) ? true : false;
258 /// \brief Return true if this token is a string or character literal which
260 bool hasUDSuffix() const { return (Flags & HasUDSuffix) ? true : false; }
262 /// Returns true if this token contains a universal character name.
263 bool hasUCN() const { return (Flags & HasUCN) ? true : false; }
266 /// \brief Information about the conditional stack (\#if directives)
267 /// currently active.
268 struct PPConditionalInfo {
269 /// \brief Location where the conditional started.
270 SourceLocation IfLoc;
272 /// \brief True if this was contained in a skipping directive, e.g.,
273 /// in a "\#if 0" block.
276 /// \brief True if we have emitted tokens already, and now we're in
277 /// an \#else block or something. Only useful in Skipping blocks.
280 /// \brief True if we've seen a \#else in this block. If so,
281 /// \#elif/\#else directives are not allowed.
285 } // end namespace clang
289 struct isPodLike<clang::Token> { static const bool value = true; };
290 } // end namespace llvm