1d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner//===--- Token.h - Token interface ------------------------------*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 10d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner// This file defines the Token interface. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner#ifndef LLVM_CLANG_TOKEN_H 15d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner#define LLVM_CLANG_TOKEN_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor#include "clang/Basic/TemplateKinds.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/TokenKinds.h" 195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 20014e88d94ff83e3aad4e33b16413a2d1817ec208Douglas Gregor#include "clang/Basic/OperatorKinds.h" 21ac1afdc58e6ad5c969f45fd2ff6d140d3b4dd862Douglas Gregor#include <cstdlib> 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 256cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Huntclass IdentifierInfo; 266cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt 27d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner/// Token - This structure provides full information about a lexed token. 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// It is not intended to be space efficient, it is intended to return as much 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// information as possible about each returned token. This is expected to be 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// compressed into a smaller form if memory footprint is important. 313604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// 323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// The parser can create a special "annotation token" representing a stream of 333604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// tokens that were parsed and semantically resolved, e.g.: "foo::MyClass<int>" 343604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// can be represented by a single typename annotation token that carries 353604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// information about the SourceRange of the tokens and the type object. 36d217773f106856a11879ec79dc468efefaf2ee75Chris Lattnerclass Token { 373604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// The location of the token. 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation Loc; 393604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 4047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // Conceptually these next two fields could be in a union. However, this 4147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // causes gcc 4.2 to pessimize LexTokenInternal, a very performance critical 4247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // routine. Keeping as separate members with casts until a more beautiful fix 4347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // presents itself. 44b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar 45b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar /// UintData - This holds either the length of the token text, when 46b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar /// a normal token, or the end of the SourceRange when an annotation 47b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar /// token. 48b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar unsigned UintData; 49b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar 506cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt /// PtrData - This is a union of four different pointer types, which depends 5147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// on what type of token this is: 5247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Identifiers, keywords, etc: 5347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is an IdentifierInfo*, which contains the uniqued identifier 5447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// spelling. 5547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Literals: isLiteral() returns true. 5647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is a pointer to the start of the token in a text buffer, which 5747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// may be dirty (have trigraphs / escaped newlines). 5847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Annotations (resolved type names, C++ scopes, etc): isAnnotation(). 5947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is a pointer to sema-specific data for the annotation token. 6047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Other: 6147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is null. 62b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar void *PtrData; 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Kind - The actual flavor of token this is. 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 664c4cbe5794897442e7cd5a57932f6aa91b6dff55Douglas Gregor unsigned short Kind; 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Flags - Bits we track about this token, members of the TokenFlags enum. 69082fb9ae304a25aa6be1f74d9b9720c52a96231eDaniel Dunbar unsigned char Flags; 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 726cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt // Various flags set per token: 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum TokenFlags { 746cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt StartOfLine = 0x01, // At start of line or only after whitespace. 756cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt LeadingSpace = 0x02, // Whitespace exists before this token. 766cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt DisableExpand = 0x04, // This identifier may never be macro expanded. 7744aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis NeedsCleaning = 0x08, // Contained an escaped newline or trigraph. 7899831e4677a7e2e051af636221694d60ba31fcdbRichard Smith LeadingEmptyMacro = 0x10, // Empty macro exists before this token. 79181cd5bdebf0b88e8194c3f58da60f7f5b918b33Joao Matos HasUDSuffix = 0x20, // This string or character literal has a ud-suffix. 80181cd5bdebf0b88e8194c3f58da60f7f5b918b33Joao Matos IgnoredComma = 0x40 // Flags ignored commas from nested macro expansions. 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 838e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek tok::TokenKind getKind() const { return (tok::TokenKind)Kind; } 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setKind(tok::TokenKind K) { Kind = K; } 851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 86000732226610650837478cba97843d19b75f648eChris Lattner /// is/isNot - Predicates to check if this token is a specific kind, as in 87000732226610650837478cba97843d19b75f648eChris Lattner /// "if (Tok.is(tok::l_brace)) {...}". 888e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool is(tok::TokenKind K) const { return Kind == (unsigned) K; } 898e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool isNot(tok::TokenKind K) const { return Kind != (unsigned) K; } 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 91a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return true if this is a raw identifier (when lexing 92c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// in raw mode) or a non-keyword identifier (when lexing in non-raw mode). 93c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara bool isAnyIdentifier() const { 94c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara return is(tok::identifier) || is(tok::raw_identifier); 95c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara } 96c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara 9747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// isLiteral - Return true if this is a "literal", like a numeric 9847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// constant, string, etc. 9947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner bool isLiteral() const { 10047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner return is(tok::numeric_constant) || is(tok::char_constant) || 1015cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor is(tok::wide_char_constant) || is(tok::utf16_char_constant) || 1025cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor is(tok::utf32_char_constant) || is(tok::string_literal) || 1035cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor is(tok::wide_string_literal) || is(tok::utf8_string_literal) || 1045cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor is(tok::utf16_string_literal) || is(tok::utf32_string_literal) || 10547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner is(tok::angle_string_literal); 10647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 10747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool isAnnotation() const { 1096c948378154dc37e772e50f95033530d506fa912Peter Collingbourne#define ANNOTATION(NAME) \ 1106c948378154dc37e772e50f95033530d506fa912Peter Collingbourne if (is(tok::annot_##NAME)) \ 1116c948378154dc37e772e50f95033530d506fa912Peter Collingbourne return true; 1126c948378154dc37e772e50f95033530d506fa912Peter Collingbourne#include "clang/Basic/TokenKinds.def" 1136c948378154dc37e772e50f95033530d506fa912Peter Collingbourne return false; 1143604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 116a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return a source location identifier for the specified 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// offset in the current file. 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation getLocation() const { return Loc; } 1193604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis unsigned getLength() const { 12047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Annotation tokens have no length field"); 121b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return UintData; 1223604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setLocation(SourceLocation L) { Loc = L; } 12579ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner void setLength(unsigned Len) { 12647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Annotation tokens have no length field"); 12779ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner UintData = Len; 12879ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner } 1293604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 1303604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis SourceLocation getAnnotationEndLoc() const { 13147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 132b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return SourceLocation::getFromRawEncoding(UintData); 1333604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1343604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationEndLoc(SourceLocation L) { 13547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 136b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar UintData = L.getRawEncoding(); 1373604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1383604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 13939d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl SourceLocation getLastLoc() const { 14039d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl return isAnnotation() ? getAnnotationEndLoc() : getLocation(); 14139d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl } 14239d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl 143a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief SourceRange of the group of tokens that this annotation token 144a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// represents. 1453604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis SourceRange getAnnotationRange() const { 1463604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis return SourceRange(getLocation(), getAnnotationEndLoc()); 1473604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1483604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationRange(SourceRange R) { 1493604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis setLocation(R.getBegin()); 1503604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis setAnnotationEndLoc(R.getEnd()); 1513604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1538e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek const char *getName() const { 1548e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek return tok::getTokenName( (tok::TokenKind) Kind); 1558e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek } 1561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 157a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Reset all flags to cleared. 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void startToken() { 15979ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner Kind = tok::unknown; 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags = 0; 161b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = 0; 162c54539cd173e20d8b179b9488fabfc5eb4cf5ee6Chris Lattner UintData = 0; 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Loc = SourceLocation(); 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1663604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis IdentifierInfo *getIdentifierInfo() const { 167c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara assert(isNot(tok::raw_identifier) && 168c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara "getIdentifierInfo() on a tok::raw_identifier token!"); 169c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara assert(!isAnnotation() && 170c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara "getIdentifierInfo() on an annotation token!"); 1716cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt if (isLiteral()) return 0; 1726cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt return (IdentifierInfo*) PtrData; 1733604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setIdentifierInfo(IdentifierInfo *II) { 1756cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt PtrData = (void*) II; 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 178c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// getRawIdentifierData - For a raw identifier token (i.e., an identifier 179c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// lexed in raw mode), returns a pointer to the start of it in the text 180c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara /// buffer if known, null otherwise. 181c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara const char *getRawIdentifierData() const { 182c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara assert(is(tok::raw_identifier)); 183c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara return reinterpret_cast<const char*>(PtrData); 184c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara } 185c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara void setRawIdentifierData(const char *Ptr) { 186c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara assert(is(tok::raw_identifier)); 187c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara PtrData = const_cast<char*>(Ptr); 188c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara } 189c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara 19047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// getLiteralData - For a literal token (numeric constant, string, etc), this 19147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// returns a pointer to the start of it in the text buffer if known, null 19247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// otherwise. 19347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner const char *getLiteralData() const { 19447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isLiteral() && "Cannot get literal data of non-literal"); 1956cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt return reinterpret_cast<const char*>(PtrData); 19647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 19747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void setLiteralData(const char *Ptr) { 19847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isLiteral() && "Cannot set literal data of non-literal"); 1996cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt PtrData = const_cast<char*>(Ptr); 20047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 2011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2023604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void *getAnnotationValue() const { 20347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 204b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return PtrData; 2053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 2063604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationValue(void *val) { 20747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 208b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = val; 2093604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 2101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 211a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Set the specified flag. 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlag(TokenFlags Flag) { 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags |= Flag; 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 216a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Unset the specified flag. 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void clearFlag(TokenFlags Flag) { 2185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags &= ~Flag; 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 221a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return the internal represtation of the flags. 222a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// 223a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// This is only intended for low-level operations such as writing tokens to 224a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// disk. 225ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek unsigned getFlags() const { 226ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek return Flags; 227ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek } 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 229a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Set a flag to either true or false. 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlagValue(TokenFlags Flag, bool Val) { 2311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (Val) 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer setFlag(Flag); 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer clearFlag(Flag); 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isAtStartOfLine - Return true if this token is at the start of a line. 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 239b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool isAtStartOfLine() const { return (Flags & StartOfLine) ? true : false; } 2401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 241a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return true if this token has whitespace before it. 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 243b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool hasLeadingSpace() const { return (Flags & LeadingSpace) ? true : false; } 2441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 245a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return true if this identifier token should never 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded in the future, due to C99 6.10.3.4p2. 2478e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool isExpandDisabled() const { 2488e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek return (Flags & DisableExpand) ? true : false; 2498e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek } 2501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 251a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return true if we have an ObjC keyword identifier. 252861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const; 2531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 254a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return the ObjC keyword kind. 255861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff tok::ObjCKeywordKind getObjCKeywordID() const; 2561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 257a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Return true if this token has trigraphs or escaped newlines in it. 2586cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt bool needsCleaning() const { return (Flags & NeedsCleaning) ? true : false; } 25944aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis 26044aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis /// \brief Return true if this token has an empty macro before it. 26144aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis /// 26244aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis bool hasLeadingEmptyMacro() const { 26344aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis return (Flags & LeadingEmptyMacro) ? true : false; 26444aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis } 26544aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis 26699831e4677a7e2e051af636221694d60ba31fcdbRichard Smith /// \brief Return true if this token is a string or character literal which 26799831e4677a7e2e051af636221694d60ba31fcdbRichard Smith /// has a ud-suffix. 26899831e4677a7e2e051af636221694d60ba31fcdbRichard Smith bool hasUDSuffix() const { return (Flags & HasUDSuffix) ? true : false; } 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 271a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett/// \brief Information about the conditional stack (\#if directives) 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// currently active. 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerstruct PPConditionalInfo { 274a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief Location where the conditional started. 2755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation IfLoc; 2761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 277a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief True if this was contained in a skipping directive, e.g., 278a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// in a "\#if 0" block. 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WasSkipping; 2801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 281a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief True if we have emitted tokens already, and now we're in 282a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// an \#else block or something. Only useful in Skipping blocks. 2835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkip; 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 285a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \brief True if we've seen a \#else in this block. If so, 286a1e92ace653fb15742dc6d35198a9da433d90e15James Dennett /// \#elif/\#else directives are not allowed. 2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundElse; 2885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 2915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2921c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramernamespace llvm { 2931c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer template <> 2941c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer struct isPodLike<clang::Token> { static const bool value = true; }; 2951c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer} // end namespace llvm 2961c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 298