Token.h revision 39a8de10c18365bde7062d8959b7ed525449c561
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" 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierInfo; 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 25d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner/// Token - This structure provides full information about a lexed token. 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// It is not intended to be space efficient, it is intended to return as much 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// information as possible about each returned token. This is expected to be 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// compressed into a smaller form if memory footprint is important. 293604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// 303604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// The parser can create a special "annotation token" representing a stream of 313604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// tokens that were parsed and semantically resolved, e.g.: "foo::MyClass<int>" 323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// can be represented by a single typename annotation token that carries 333604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis/// information about the SourceRange of the tokens and the type object. 34d217773f106856a11879ec79dc468efefaf2ee75Chris Lattnerclass Token { 353604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// The location of the token. 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation Loc; 373604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 3847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // Conceptually these next two fields could be in a union. However, this 3947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // causes gcc 4.2 to pessimize LexTokenInternal, a very performance critical 4047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // routine. Keeping as separate members with casts until a more beautiful fix 4147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner // presents itself. 42b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar 43b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar /// UintData - This holds either the length of the token text, when 44b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar /// a normal token, or the end of the SourceRange when an annotation 45b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar /// token. 46b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar unsigned UintData; 47b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar 4847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// PtrData - This is a union of four different pointer types, which depends 4947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// on what type of token this is: 5047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Identifiers, keywords, etc: 5147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is an IdentifierInfo*, which contains the uniqued identifier 5247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// spelling. 5347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Literals: isLiteral() returns true. 5447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is a pointer to the start of the token in a text buffer, which 5547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// may be dirty (have trigraphs / escaped newlines). 5647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Annotations (resolved type names, C++ scopes, etc): isAnnotation(). 5747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is a pointer to sema-specific data for the annotation token. 5847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// Other: 5947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// This is null. 60b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar void *PtrData; 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Kind - The actual flavor of token this is. 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 648e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek unsigned Kind : 8; // DON'T make Kind a 'tok::TokenKind'; 658e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek // MSVC will treat it as a signed char and 668e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek // TokenKinds > 127 won't be handled correctly. 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Flags - Bits we track about this token, members of the TokenFlags enum. 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned Flags : 8; 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various flags set per token: 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum TokenFlags { 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer StartOfLine = 0x01, // At start of line or only after whitespace. 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer LeadingSpace = 0x02, // Whitespace exists before this token. 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableExpand = 0x04, // This identifier may never be macro expanded. 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer NeedsCleaning = 0x08 // Contained an escaped newline or trigraph. 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 808e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek tok::TokenKind getKind() const { return (tok::TokenKind)Kind; } 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setKind(tok::TokenKind K) { Kind = K; } 82000732226610650837478cba97843d19b75f648eChris Lattner 83000732226610650837478cba97843d19b75f648eChris Lattner /// is/isNot - Predicates to check if this token is a specific kind, as in 84000732226610650837478cba97843d19b75f648eChris Lattner /// "if (Tok.is(tok::l_brace)) {...}". 858e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool is(tok::TokenKind K) const { return Kind == (unsigned) K; } 868e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool isNot(tok::TokenKind K) const { return Kind != (unsigned) K; } 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// isLiteral - Return true if this is a "literal", like a numeric 8947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// constant, string, etc. 9047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner bool isLiteral() const { 9147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner return is(tok::numeric_constant) || is(tok::char_constant) || 9247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner is(tok::string_literal) || is(tok::wide_string_literal) || 9347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner is(tok::angle_string_literal); 9447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 9547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner 9647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner bool isAnnotation() const { 97b31757b68afe06ba442a05775d08fe7aa0f6f889Chris Lattner return is(tok::annot_typename) || 98d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor is(tok::annot_cxxscope) || 99d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor is(tok::annot_template_id); 1003604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 10147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getLocation - Return a source location identifier for the specified 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// offset in the current file. 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation getLocation() const { return Loc; } 1053604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis unsigned getLength() const { 10647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Annotation tokens have no length field"); 107b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return UintData; 1083604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setLocation(SourceLocation L) { Loc = L; } 11179ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner void setLength(unsigned Len) { 11247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Annotation tokens have no length field"); 11379ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner UintData = Len; 11479ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner } 1153604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 1163604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis SourceLocation getAnnotationEndLoc() const { 11747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 118b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return SourceLocation::getFromRawEncoding(UintData); 1193604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1203604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationEndLoc(SourceLocation L) { 12147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 122b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar UintData = L.getRawEncoding(); 1233604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1243604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 1253604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// getAnnotationRange - SourceRange of the group of tokens that this 1263604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// annotation token represents. 1273604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis SourceRange getAnnotationRange() const { 1283604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis return SourceRange(getLocation(), getAnnotationEndLoc()); 1293604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1303604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationRange(SourceRange R) { 1313604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis setLocation(R.getBegin()); 1323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis setAnnotationEndLoc(R.getEnd()); 1333604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1358e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek const char *getName() const { 1368e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek return tok::getTokenName( (tok::TokenKind) Kind); 1378e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek } 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// startToken - Reset all flags to cleared. 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void startToken() { 14279ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner Kind = tok::unknown; 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags = 0; 144b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = 0; 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Loc = SourceLocation(); 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1483604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis IdentifierInfo *getIdentifierInfo() const { 14947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Used IdentInfo on annotation token!"); 15047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner if (isLiteral()) return 0; 151b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return (IdentifierInfo*) PtrData; 1523604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setIdentifierInfo(IdentifierInfo *II) { 154b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = (void*) II; 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 15647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner 15747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// getLiteralData - For a literal token (numeric constant, string, etc), this 15847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// returns a pointer to the start of it in the text buffer if known, null 15947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// otherwise. 16047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner const char *getLiteralData() const { 16147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isLiteral() && "Cannot get literal data of non-literal"); 16247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner return reinterpret_cast<const char*>(PtrData); 16347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 16447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void setLiteralData(const char *Ptr) { 16547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isLiteral() && "Cannot set literal data of non-literal"); 16647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner PtrData = (void*)Ptr; 16747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 16847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner 1693604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void *getAnnotationValue() const { 17047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 171b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return PtrData; 1723604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1733604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationValue(void *val) { 17447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 175b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = val; 1763604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 17753702cd401b8fdca985aede7732c2f6a82ad9b1cChris Lattner 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setFlag - Set the specified flag. 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlag(TokenFlags Flag) { 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags |= Flag; 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// clearFlag - Unset the specified flag. 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void clearFlag(TokenFlags Flag) { 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags &= ~Flag; 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 187ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek 188ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek /// getFlags - Return the internal represtation of the flags. 189ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek /// Only intended for low-level operations such as writing tokens to 190ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek // disk. 191ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek unsigned getFlags() const { 192ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek return Flags; 193ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek } 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setFlagValue - Set a flag to either true or false. 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlagValue(TokenFlags Flag, bool Val) { 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (Val) 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer setFlag(Flag); 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer clearFlag(Flag); 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isAtStartOfLine - Return true if this token is at the start of a line. 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 205b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool isAtStartOfLine() const { return (Flags & StartOfLine) ? true : false; } 2065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// hasLeadingSpace - Return true if this token has whitespace before it. 2085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 209b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool hasLeadingSpace() const { return (Flags & LeadingSpace) ? true : false; } 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isExpandDisabled - Return true if this identifier token should never 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded in the future, due to C99 6.10.3.4p2. 2138e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool isExpandDisabled() const { 2148e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek return (Flags & DisableExpand) ? true : false; 2158e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek } 216861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff 217861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff /// isObjCAtKeyword - Return true if we have an ObjC keyword identifier. 218861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const; 219861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff 220861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff /// getObjCKeywordID - Return the ObjC keyword kind. 221861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff tok::ObjCKeywordKind getObjCKeywordID() const; 222861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff 2235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// needsCleaning - Return true if this token has trigraphs or escaped 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// newlines in it. 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 226b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool needsCleaning() const { return (Flags & NeedsCleaning) ? true : false; } 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// PPConditionalInfo - Information about the conditional stack (#if directives) 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// currently active. 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerstruct PPConditionalInfo { 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IfLoc - Location where the conditional started. 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation IfLoc; 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// WasSkipping - True if this was contained in a skipping directive, e.g. 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// in a "#if 0" block. 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WasSkipping; 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkip - True if we have emitted tokens already, and now we're in 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an #else block or something. Only useful in Skipping blocks. 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkip; 2435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse - True if we've seen a #else in this block. If so, 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #elif/#else directives are not allowed. 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundElse; 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 249d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor/// TemplateIdAnnotation - Information about a template-id annotation 250d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor/// token, which contains the template declaration, template 25139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor/// arguments, whether those template arguments were types or 25239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor/// expressions, and the source locations for important tokens. All of 25339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor/// the information about template arguments is allocated directly 25439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor/// after this structure. 255d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregorstruct TemplateIdAnnotation { 256d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor /// TemplateNameLoc - The location of the template name within the 257d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor /// source. 258d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor SourceLocation TemplateNameLoc; 259d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor 26039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// FIXME: Temporarily stores the name of a specialization 26139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor IdentifierInfo *Name; 26239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 26339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// The declaration of the template corresponding to the 264d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor /// template-name. This is an Action::DeclTy*. 265d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor void *Template; 266d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor 26739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// The kind of template that Template refers to. 26839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor TemplateNameKind Kind; 26939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 27039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// The location of the '<' before the template argument 271d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor /// list. 272d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor SourceLocation LAngleLoc; 273d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor 27439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// The location of the '>' after the template argument 27539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// list. 27639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor SourceLocation RAngleLoc; 27739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 27839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// NumArgs - The number of template arguments. 279d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor unsigned NumArgs; 28039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 28139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// \brief Retrieves a pointer to the template arguments 28239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void **getTemplateArgs() { return (void **)(this + 1); } 28339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 28439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// \brief Retrieves a pointer to the array of template argument 28539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// locations. 28639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor SourceLocation *getTemplateArgLocations() { 28739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor return (SourceLocation *)(getTemplateArgs() + NumArgs); 28839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 28939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 29039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// \brief Retrieves a pointer to the array of flags that states 29139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor /// whether the template arguments are types. 29239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor bool *getTemplateArgIsType() { 29339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor return (bool *)(getTemplateArgLocations() + NumArgs); 29439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 29539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 29639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor static TemplateIdAnnotation* Allocate(unsigned NumArgs) { 29739a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor TemplateIdAnnotation *TemplateId 29839a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor = (TemplateIdAnnotation *)malloc(sizeof(TemplateIdAnnotation) + 29939a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor sizeof(void*) * NumArgs + 30039a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor sizeof(SourceLocation) * NumArgs + 30139a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor sizeof(bool) * NumArgs); 30239a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor TemplateId->NumArgs = NumArgs; 30339a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor return TemplateId; 30439a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor } 30539a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor 30639a8de10c18365bde7062d8959b7ed525449c561Douglas Gregor void Destroy() { free(this); } 307d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor}; 308d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor 3095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 3105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 312