clang  15.0.0git
Token.h
Go to the documentation of this file.
1 //===--- Token.h - Token interface ------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the Token interface.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_CLANG_LEX_TOKEN_H
14 #define LLVM_CLANG_LEX_TOKEN_H
15 
17 #include "clang/Basic/TokenKinds.h"
18 #include "llvm/ADT/StringRef.h"
19 #include <cassert>
20 
21 namespace clang {
22 
23 class IdentifierInfo;
24 
25 /// Token - This structure provides full information about a lexed token.
26 /// It is not intended to be space efficient, it is intended to return as much
27 /// information as possible about each returned token. This is expected to be
28 /// compressed into a smaller form if memory footprint is important.
29 ///
30 /// The parser can create a special "annotation token" representing a stream of
31 /// tokens that were parsed and semantically resolved, e.g.: "foo::MyClass<int>"
32 /// can be represented by a single typename annotation token that carries
33 /// information about the SourceRange of the tokens and the type object.
34 class Token {
35  /// The location of the token. This is actually a SourceLocation.
37 
38  // Conceptually these next two fields could be in a union. However, this
39  // causes gcc 4.2 to pessimize LexTokenInternal, a very performance critical
40  // routine. Keeping as separate members with casts until a more beautiful fix
41  // presents itself.
42 
43  /// UintData - This holds either the length of the token text, when
44  /// a normal token, or the end of the SourceRange when an annotation
45  /// token.
46  SourceLocation::UIntTy UintData;
47 
48  /// PtrData - This is a union of four different pointer types, which depends
49  /// on what type of token this is:
50  /// Identifiers, keywords, etc:
51  /// This is an IdentifierInfo*, which contains the uniqued identifier
52  /// spelling.
53  /// Literals: isLiteral() returns true.
54  /// This is a pointer to the start of the token in a text buffer, which
55  /// may be dirty (have trigraphs / escaped newlines).
56  /// Annotations (resolved type names, C++ scopes, etc): isAnnotation().
57  /// This is a pointer to sema-specific data for the annotation token.
58  /// Eof:
59  // This is a pointer to a Decl.
60  /// Other:
61  /// This is null.
62  void *PtrData;
63 
64  /// Kind - The actual flavor of token this is.
65  tok::TokenKind Kind;
66 
67  /// Flags - Bits we track about this token, members of the TokenFlags enum.
68  unsigned short Flags;
69 
70 public:
71  // Various flags set per token:
72  enum TokenFlags {
73  StartOfLine = 0x01, // At start of line or only after whitespace
74  // (considering the line after macro expansion).
75  LeadingSpace = 0x02, // Whitespace exists before this token (considering
76  // whitespace after macro expansion).
77  DisableExpand = 0x04, // This identifier may never be macro expanded.
78  NeedsCleaning = 0x08, // Contained an escaped newline or trigraph.
79  LeadingEmptyMacro = 0x10, // Empty macro exists before this token.
80  HasUDSuffix = 0x20, // This string or character literal has a ud-suffix.
81  HasUCN = 0x40, // This identifier contains a UCN.
82  IgnoredComma = 0x80, // This comma is not a macro argument separator (MS).
83  StringifiedInMacro = 0x100, // This string or character literal is formed by
84  // macro stringizing or charizing operator.
85  CommaAfterElided = 0x200, // The comma following this token was elided (MS).
86  IsEditorPlaceholder = 0x400, // This identifier is a placeholder.
87  IsReinjected = 0x800, // A phase 4 token that was produced before and
88  // re-added, e.g. via EnterTokenStream. Annotation
89  // tokens are *not* reinjected.
90  };
91 
92  tok::TokenKind getKind() const { return Kind; }
93  void setKind(tok::TokenKind K) { Kind = K; }
94 
95  /// is/isNot - Predicates to check if this token is a specific kind, as in
96  /// "if (Tok.is(tok::l_brace)) {...}".
97  bool is(tok::TokenKind K) const { return Kind == K; }
98  bool isNot(tok::TokenKind K) const { return Kind != K; }
99  bool isOneOf(tok::TokenKind K1, tok::TokenKind K2) const {
100  return is(K1) || is(K2);
101  }
102  template <typename... Ts> bool isOneOf(tok::TokenKind K1, Ts... Ks) const {
103  return is(K1) || isOneOf(Ks...);
104  }
105 
106  /// Return true if this is a raw identifier (when lexing
107  /// in raw mode) or a non-keyword identifier (when lexing in non-raw mode).
108  bool isAnyIdentifier() const {
109  return tok::isAnyIdentifier(getKind());
110  }
111 
112  /// Return true if this is a "literal", like a numeric
113  /// constant, string, etc.
114  bool isLiteral() const {
115  return tok::isLiteral(getKind());
116  }
117 
118  /// Return true if this is any of tok::annot_* kind tokens.
119  bool isAnnotation() const {
120  return tok::isAnnotation(getKind());
121  }
122 
123  /// Return a source location identifier for the specified
124  /// offset in the current file.
127  }
128  unsigned getLength() const {
129  assert(!isAnnotation() && "Annotation tokens have no length field");
130  return UintData;
131  }
132 
134  void setLength(unsigned Len) {
135  assert(!isAnnotation() && "Annotation tokens have no length field");
136  UintData = Len;
137  }
138 
140  assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token");
141  return SourceLocation::getFromRawEncoding(UintData ? UintData : Loc);
142  }
144  assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token");
145  UintData = L.getRawEncoding();
146  }
147 
150  }
151 
153  return isAnnotation() ? getAnnotationEndLoc()
155  }
156 
157  /// SourceRange of the group of tokens that this annotation token
158  /// represents.
161  }
163  setLocation(R.getBegin());
165  }
166 
167  const char *getName() const { return tok::getTokenName(Kind); }
168 
169  /// Reset all flags to cleared.
170  void startToken() {
171  Kind = tok::unknown;
172  Flags = 0;
173  PtrData = nullptr;
174  UintData = 0;
175  Loc = SourceLocation().getRawEncoding();
176  }
177 
179  assert(isNot(tok::raw_identifier) &&
180  "getIdentifierInfo() on a tok::raw_identifier token!");
181  assert(!isAnnotation() &&
182  "getIdentifierInfo() on an annotation token!");
183  if (isLiteral()) return nullptr;
184  if (is(tok::eof)) return nullptr;
185  return (IdentifierInfo*) PtrData;
186  }
188  PtrData = (void*) II;
189  }
190 
191  const void *getEofData() const {
192  assert(is(tok::eof));
193  return reinterpret_cast<const void *>(PtrData);
194  }
195  void setEofData(const void *D) {
196  assert(is(tok::eof));
197  assert(!PtrData);
198  PtrData = const_cast<void *>(D);
199  }
200 
201  /// getRawIdentifier - For a raw identifier token (i.e., an identifier
202  /// lexed in raw mode), returns a reference to the text substring in the
203  /// buffer if known.
204  StringRef getRawIdentifier() const {
205  assert(is(tok::raw_identifier));
206  return StringRef(reinterpret_cast<const char *>(PtrData), getLength());
207  }
208  void setRawIdentifierData(const char *Ptr) {
209  assert(is(tok::raw_identifier));
210  PtrData = const_cast<char*>(Ptr);
211  }
212 
213  /// getLiteralData - For a literal token (numeric constant, string, etc), this
214  /// returns a pointer to the start of it in the text buffer if known, null
215  /// otherwise.
216  const char *getLiteralData() const {
217  assert(isLiteral() && "Cannot get literal data of non-literal");
218  return reinterpret_cast<const char*>(PtrData);
219  }
220  void setLiteralData(const char *Ptr) {
221  assert(isLiteral() && "Cannot set literal data of non-literal");
222  PtrData = const_cast<char*>(Ptr);
223  }
224 
225  void *getAnnotationValue() const {
226  assert(isAnnotation() && "Used AnnotVal on non-annotation token");
227  return PtrData;
228  }
229  void setAnnotationValue(void *val) {
230  assert(isAnnotation() && "Used AnnotVal on non-annotation token");
231  PtrData = val;
232  }
233 
234  /// Set the specified flag.
235  void setFlag(TokenFlags Flag) {
236  Flags |= Flag;
237  }
238 
239  /// Get the specified flag.
240  bool getFlag(TokenFlags Flag) const {
241  return (Flags & Flag) != 0;
242  }
243 
244  /// Unset the specified flag.
245  void clearFlag(TokenFlags Flag) {
246  Flags &= ~Flag;
247  }
248 
249  /// Return the internal represtation of the flags.
250  ///
251  /// This is only intended for low-level operations such as writing tokens to
252  /// disk.
253  unsigned getFlags() const {
254  return Flags;
255  }
256 
257  /// Set a flag to either true or false.
258  void setFlagValue(TokenFlags Flag, bool Val) {
259  if (Val)
260  setFlag(Flag);
261  else
262  clearFlag(Flag);
263  }
264 
265  /// isAtStartOfLine - Return true if this token is at the start of a line.
266  ///
267  bool isAtStartOfLine() const { return getFlag(StartOfLine); }
268 
269  /// Return true if this token has whitespace before it.
270  ///
271  bool hasLeadingSpace() const { return getFlag(LeadingSpace); }
272 
273  /// Return true if this identifier token should never
274  /// be expanded in the future, due to C99 6.10.3.4p2.
275  bool isExpandDisabled() const { return getFlag(DisableExpand); }
276 
277  /// Return true if we have an ObjC keyword identifier.
278  bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const;
279 
280  /// Return the ObjC keyword kind.
282 
283  /// Return true if this token has trigraphs or escaped newlines in it.
284  bool needsCleaning() const { return getFlag(NeedsCleaning); }
285 
286  /// Return true if this token has an empty macro before it.
287  ///
289 
290  /// Return true if this token is a string or character literal which
291  /// has a ud-suffix.
292  bool hasUDSuffix() const { return getFlag(HasUDSuffix); }
293 
294  /// Returns true if this token contains a universal character name.
295  bool hasUCN() const { return getFlag(HasUCN); }
296 
297  /// Returns true if this token is formed by macro by stringizing or charizing
298  /// operator.
300 
301  /// Returns true if the comma after this token was elided.
302  bool commaAfterElided() const { return getFlag(CommaAfterElided); }
303 
304  /// Returns true if this token is an editor placeholder.
305  ///
306  /// Editor placeholders are produced by the code-completion engine and are
307  /// represented as characters between '<#' and '#>' in the source code. The
308  /// lexer uses identifier tokens to represent placeholders.
310 };
311 
312 /// Information about the conditional stack (\#if directives)
313 /// currently active.
315  /// Location where the conditional started.
317 
318  /// True if this was contained in a skipping directive, e.g.,
319  /// in a "\#if 0" block.
321 
322  /// True if we have emitted tokens already, and now we're in
323  /// an \#else block or something. Only useful in Skipping blocks.
325 
326  /// True if we've seen a \#else in this block. If so,
327  /// \#elif/\#else directives are not allowed.
328  bool FoundElse;
329 };
330 
331 } // end namespace clang
332 
333 #endif // LLVM_CLANG_LEX_TOKEN_H
clang::Token::startToken
void startToken()
Reset all flags to cleared.
Definition: Token.h:170
clang::Token::getAnnotationRange
SourceRange getAnnotationRange() const
SourceRange of the group of tokens that this annotation token represents.
Definition: Token.h:159
clang::Token::IgnoredComma
@ IgnoredComma
Definition: Token.h:82
clang::Token::IsReinjected
@ IsReinjected
Definition: Token.h:87
clang::Token::hasUCN
bool hasUCN() const
Returns true if this token contains a universal character name.
Definition: Token.h:295
clang::Token::hasLeadingSpace
bool hasLeadingSpace() const
Return true if this token has whitespace before it.
Definition: Token.h:271
clang::Token::setEofData
void setEofData(const void *D)
Definition: Token.h:195
clang::Token::isObjCAtKeyword
bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const
Return true if we have an ObjC keyword identifier.
Definition: Lexer.cpp:58
clang::SourceRange
A trivial tuple used to represent a source range.
Definition: SourceLocation.h:210
clang::Token::getEofData
const void * getEofData() const
Definition: Token.h:191
clang::Token::getLiteralData
const char * getLiteralData() const
getLiteralData - For a literal token (numeric constant, string, etc), this returns a pointer to the s...
Definition: Token.h:216
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:86
clang::SourceLocation::getLocWithOffset
SourceLocation getLocWithOffset(IntTy Offset) const
Return a source location with the specified offset from this SourceLocation.
Definition: SourceLocation.h:134
clang::SourceRange::getBegin
SourceLocation getBegin() const
Definition: SourceLocation.h:219
clang::Token::isExpandDisabled
bool isExpandDisabled() const
Return true if this identifier token should never be expanded in the future, due to C99 6....
Definition: Token.h:275
clang::Token::getEndLoc
SourceLocation getEndLoc() const
Definition: Token.h:152
clang::Token::getIdentifierInfo
IdentifierInfo * getIdentifierInfo() const
Definition: Token.h:178
clang::Token::setAnnotationEndLoc
void setAnnotationEndLoc(SourceLocation L)
Definition: Token.h:143
clang::Token::isAtStartOfLine
bool isAtStartOfLine() const
isAtStartOfLine - Return true if this token is at the start of a line.
Definition: Token.h:267
clang::Token::setIdentifierInfo
void setIdentifierInfo(IdentifierInfo *II)
Definition: Token.h:187
clang::Token::IsEditorPlaceholder
@ IsEditorPlaceholder
Definition: Token.h:86
clang::Token::setAnnotationRange
void setAnnotationRange(SourceRange R)
Definition: Token.h:162
clang::Token
Token - This structure provides full information about a lexed token.
Definition: Token.h:34
clang::PPConditionalInfo::FoundElse
bool FoundElse
True if we've seen a #else in this block.
Definition: Token.h:328
clang::Token::commaAfterElided
bool commaAfterElided() const
Returns true if the comma after this token was elided.
Definition: Token.h:302
clang::Token::StringifiedInMacro
@ StringifiedInMacro
Definition: Token.h:83
TokenKinds.h
clang::Token::setRawIdentifierData
void setRawIdentifierData(const char *Ptr)
Definition: Token.h:208
clang::SourceRange::getEnd
SourceLocation getEnd() const
Definition: SourceLocation.h:220
clang::Token::setFlagValue
void setFlagValue(TokenFlags Flag, bool Val)
Set a flag to either true or false.
Definition: Token.h:258
clang::Token::getKind
tok::TokenKind getKind() const
Definition: Token.h:92
clang::Token::getAnnotationValue
void * getAnnotationValue() const
Definition: Token.h:225
clang::Token::is
bool is(tok::TokenKind K) const
is/isNot - Predicates to check if this token is a specific kind, as in "if (Tok.is(tok::l_brace)) {....
Definition: Token.h:97
clang::Token::DisableExpand
@ DisableExpand
Definition: Token.h:77
clang::Token::TokenFlags
TokenFlags
Definition: Token.h:72
clang::Token::setAnnotationValue
void setAnnotationValue(void *val)
Definition: Token.h:229
clang::tok::getTokenName
const char * getTokenName(TokenKind Kind) LLVM_READNONE
Determines the name of a token as used within the front end.
Definition: TokenKinds.cpp:24
clang::PPConditionalInfo
Information about the conditional stack (#if directives) currently active.
Definition: Token.h:314
clang::Token::needsCleaning
bool needsCleaning() const
Return true if this token has trigraphs or escaped newlines in it.
Definition: Token.h:284
clang::Token::LeadingEmptyMacro
@ LeadingEmptyMacro
Definition: Token.h:79
clang::Token::getAnnotationEndLoc
SourceLocation getAnnotationEndLoc() const
Definition: Token.h:139
clang::tok::ObjCKeywordKind
ObjCKeywordKind
Provides a namespace for Objective-C keywords which start with an '@'.
Definition: TokenKinds.h:41
clang::Token::isAnyIdentifier
bool isAnyIdentifier() const
Return true if this is a raw identifier (when lexing in raw mode) or a non-keyword identifier (when l...
Definition: Token.h:108
clang::Token::isNot
bool isNot(tok::TokenKind K) const
Definition: Token.h:98
clang::Token::isOneOf
bool isOneOf(tok::TokenKind K1, Ts... Ks) const
Definition: Token.h:102
clang::Token::getRawIdentifier
StringRef getRawIdentifier() const
getRawIdentifier - For a raw identifier token (i.e., an identifier lexed in raw mode),...
Definition: Token.h:204
clang::Token::isLiteral
bool isLiteral() const
Return true if this is a "literal", like a numeric constant, string, etc.
Definition: Token.h:114
clang::Token::getLength
unsigned getLength() const
Definition: Token.h:128
clang::Token::LeadingSpace
@ LeadingSpace
Definition: Token.h:75
SourceLocation.h
clang::tok::TokenKind
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:25
clang::Token::HasUDSuffix
@ HasUDSuffix
Definition: Token.h:80
clang::Token::setLiteralData
void setLiteralData(const char *Ptr)
Definition: Token.h:220
clang::Token::getFlags
unsigned getFlags() const
Return the internal represtation of the flags.
Definition: Token.h:253
clang::Token::getName
const char * getName() const
Definition: Token.h:167
clang::Token::StartOfLine
@ StartOfLine
Definition: Token.h:73
clang::PPConditionalInfo::WasSkipping
bool WasSkipping
True if this was contained in a skipping directive, e.g., in a "\#if 0" block.
Definition: Token.h:320
clang::IdentifierInfo
One of these records is kept for each identifier that is lexed.
Definition: IdentifierTable.h:84
clang::Token::clearFlag
void clearFlag(TokenFlags Flag)
Unset the specified flag.
Definition: Token.h:245
clang::Token::getLocation
SourceLocation getLocation() const
Return a source location identifier for the specified offset in the current file.
Definition: Token.h:125
clang::Token::isEditorPlaceholder
bool isEditorPlaceholder() const
Returns true if this token is an editor placeholder.
Definition: Token.h:309
clang::SourceLocation::getFromRawEncoding
static SourceLocation getFromRawEncoding(UIntTy Encoding)
Turn a raw encoding of a SourceLocation object into a real SourceLocation.
Definition: SourceLocation.h:152
clang::Token::isAnnotation
bool isAnnotation() const
Return true if this is any of tok::annot_* kind tokens.
Definition: Token.h:119
clang::Token::setLocation
void setLocation(SourceLocation L)
Definition: Token.h:133
clang
Definition: CalledOnceCheck.h:17
clang::PPConditionalInfo::IfLoc
SourceLocation IfLoc
Location where the conditional started.
Definition: Token.h:316
clang::Token::CommaAfterElided
@ CommaAfterElided
Definition: Token.h:85
clang::Token::stringifiedInMacro
bool stringifiedInMacro() const
Returns true if this token is formed by macro by stringizing or charizing operator.
Definition: Token.h:299
clang::tok::isAnnotation
bool isAnnotation(TokenKind K)
Return true if this is any of tok::annot_* kinds.
Definition: TokenKinds.cpp:58
clang::tok::isLiteral
bool isLiteral(TokenKind K)
Return true if this is a "literal" kind, like a numeric constant, string, etc.
Definition: TokenKinds.h:89
clang::Token::setLength
void setLength(unsigned Len)
Definition: Token.h:134
clang::PPConditionalInfo::FoundNonSkip
bool FoundNonSkip
True if we have emitted tokens already, and now we're in an #else block or something.
Definition: Token.h:324
clang::Token::setKind
void setKind(tok::TokenKind K)
Definition: Token.h:93
clang::Token::NeedsCleaning
@ NeedsCleaning
Definition: Token.h:78
clang::Token::isOneOf
bool isOneOf(tok::TokenKind K1, tok::TokenKind K2) const
Definition: Token.h:99
clang::Token::getLastLoc
SourceLocation getLastLoc() const
Definition: Token.h:148
clang::Token::setFlag
void setFlag(TokenFlags Flag)
Set the specified flag.
Definition: Token.h:235
clang::comments::tok::eof
@ eof
Definition: CommentLexer.h:33
clang::Token::HasUCN
@ HasUCN
Definition: Token.h:81
clang::Token::getObjCKeywordID
tok::ObjCKeywordKind getObjCKeywordID() const
Return the ObjC keyword kind.
Definition: Lexer.cpp:67
clang::tok::isAnyIdentifier
bool isAnyIdentifier(TokenKind K)
Return true if this is a raw identifier or an identifier kind.
Definition: TokenKinds.h:75
clang::Token::getFlag
bool getFlag(TokenFlags Flag) const
Get the specified flag.
Definition: Token.h:240
clang::SourceLocation::UIntTy
uint32_t UIntTy
Definition: SourceLocation.h:93
clang::Token::hasUDSuffix
bool hasUDSuffix() const
Return true if this token is a string or character literal which has a ud-suffix.
Definition: Token.h:292
clang::SourceLocation::getRawEncoding
UIntTy getRawEncoding() const
When a SourceLocation itself cannot be used, this returns an (opaque) 32-bit integer encoding for it.
Definition: SourceLocation.h:146
clang::Token::hasLeadingEmptyMacro
bool hasLeadingEmptyMacro() const
Return true if this token has an empty macro before it.
Definition: Token.h:288