Token.h revision 44aa1f397855f130e88e62ffc1029f7f83bb5d2e
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 /// 66082fb9ae304a25aa6be1f74d9b9720c52a96231eDaniel Dunbar unsigned char Kind; // DON'T make Kind a 'tok::TokenKind'; 678e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek // MSVC will treat it as a signed char and 688e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek // TokenKinds > 127 won't be handled correctly. 691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Flags - Bits we track about this token, members of the TokenFlags enum. 71082fb9ae304a25aa6be1f74d9b9720c52a96231eDaniel Dunbar unsigned char Flags; 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 746cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt // Various flags set per token: 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum TokenFlags { 766cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt StartOfLine = 0x01, // At start of line or only after whitespace. 776cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt LeadingSpace = 0x02, // Whitespace exists before this token. 786cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt DisableExpand = 0x04, // This identifier may never be macro expanded. 7944aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis NeedsCleaning = 0x08, // Contained an escaped newline or trigraph. 8044aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis LeadingEmptyMacro = 0x10 // Empty macro exists before this token. 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 9147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// isLiteral - Return true if this is a "literal", like a numeric 9247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// constant, string, etc. 9347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner bool isLiteral() const { 9447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner return is(tok::numeric_constant) || is(tok::char_constant) || 9547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner is(tok::string_literal) || is(tok::wide_string_literal) || 9647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner is(tok::angle_string_literal); 9747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 9847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner 991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool isAnnotation() const { 1001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return is(tok::annot_typename) || 101d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor is(tok::annot_cxxscope) || 102d6fb7ef028d9aa0b3e8943b7bc049c524437b407Douglas Gregor is(tok::annot_template_id); 1033604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getLocation - Return a source location identifier for the specified 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// offset in the current file. 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation getLocation() const { return Loc; } 1083604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis unsigned getLength() const { 10947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Annotation tokens have no length field"); 110b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return UintData; 1113604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setLocation(SourceLocation L) { Loc = L; } 11479ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner void setLength(unsigned Len) { 11547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Annotation tokens have no length field"); 11679ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner UintData = Len; 11779ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner } 1183604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 1193604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis SourceLocation getAnnotationEndLoc() const { 12047246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 121b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return SourceLocation::getFromRawEncoding(UintData); 1223604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1233604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationEndLoc(SourceLocation L) { 12447246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotEndLocID on non-annotation token"); 125b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar UintData = L.getRawEncoding(); 1263604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1273604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis 12839d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl SourceLocation getLastLoc() const { 12939d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl return isAnnotation() ? getAnnotationEndLoc() : getLocation(); 13039d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl } 13139d67117f896c6e2faa727671ef64b3c04b0e3feSebastian Redl 1323604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// getAnnotationRange - SourceRange of the group of tokens that this 1333604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis /// annotation token represents. 1343604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis SourceRange getAnnotationRange() const { 1353604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis return SourceRange(getLocation(), getAnnotationEndLoc()); 1363604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1373604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationRange(SourceRange R) { 1383604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis setLocation(R.getBegin()); 1393604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis setAnnotationEndLoc(R.getEnd()); 1403604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1428e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek const char *getName() const { 1438e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek return tok::getTokenName( (tok::TokenKind) Kind); 1448e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek } 1451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// startToken - Reset all flags to cleared. 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void startToken() { 14979ed16e2e605d67a12cccdcf9ad1b231175da1a6Chris Lattner Kind = tok::unknown; 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags = 0; 151b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = 0; 152c54539cd173e20d8b179b9488fabfc5eb4cf5ee6Chris Lattner UintData = 0; 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Loc = SourceLocation(); 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1563604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis IdentifierInfo *getIdentifierInfo() const { 15747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(!isAnnotation() && "Used IdentInfo on annotation token!"); 1586cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt if (isLiteral()) return 0; 1596cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt return (IdentifierInfo*) PtrData; 1603604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setIdentifierInfo(IdentifierInfo *II) { 1626cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt PtrData = (void*) II; 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 16547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// getLiteralData - For a literal token (numeric constant, string, etc), this 16647246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// returns a pointer to the start of it in the text buffer if known, null 16747246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner /// otherwise. 16847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner const char *getLiteralData() const { 16947246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isLiteral() && "Cannot get literal data of non-literal"); 1706cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt return reinterpret_cast<const char*>(PtrData); 17147246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 17247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner void setLiteralData(const char *Ptr) { 17347246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isLiteral() && "Cannot set literal data of non-literal"); 1746cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt PtrData = const_cast<char*>(Ptr); 17547246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner } 1761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1773604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void *getAnnotationValue() const { 17847246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 179b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar return PtrData; 1803604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1813604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis void setAnnotationValue(void *val) { 18247246be8ac5b0ddde6c402b8fc6946b6135487b5Chris Lattner assert(isAnnotation() && "Used AnnotVal on non-annotation token"); 183b28d6de75e0cb27ce3106ce6052f87ad0ab276d7Daniel Dunbar PtrData = val; 1843604e3895ecd850291b518e5a82246c888ce9d0fArgyrios Kyrtzidis } 1851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setFlag - Set the specified flag. 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlag(TokenFlags Flag) { 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags |= Flag; 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// clearFlag - Unset the specified flag. 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void clearFlag(TokenFlags Flag) { 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags &= ~Flag; 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 196ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek /// getFlags - Return the internal represtation of the flags. 197ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek /// Only intended for low-level operations such as writing tokens to 198ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek // disk. 199ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek unsigned getFlags() const { 200ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek return Flags; 201ef3b215c946d4813408b5fe872fe2baa3b246b00Ted Kremenek } 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setFlagValue - Set a flag to either true or false. 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlagValue(TokenFlags Flag, bool Val) { 2051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (Val) 2065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer setFlag(Flag); 2075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 2085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer clearFlag(Flag); 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isAtStartOfLine - Return true if this token is at the start of a line. 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 213b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool isAtStartOfLine() const { return (Flags & StartOfLine) ? true : false; } 2141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// hasLeadingSpace - Return true if this token has whitespace before it. 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 217b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool hasLeadingSpace() const { return (Flags & LeadingSpace) ? true : false; } 2181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isExpandDisabled - Return true if this identifier token should never 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded in the future, due to C99 6.10.3.4p2. 2218e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek bool isExpandDisabled() const { 2228e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek return (Flags & DisableExpand) ? true : false; 2238e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek } 2241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// isObjCAtKeyword - Return true if we have an ObjC keyword identifier. 226861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const; 2271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 228861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff /// getObjCKeywordID - Return the ObjC keyword kind. 229861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff tok::ObjCKeywordKind getObjCKeywordID() const; 2301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// needsCleaning - Return true if this token has trigraphs or escaped 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// newlines in it. 2336cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt /// 2346cf750298d3621d8a10a6dd07fcee8e274b9d94dSean Hunt bool needsCleaning() const { return (Flags & NeedsCleaning) ? true : false; } 23544aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis 23644aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis /// \brief Return true if this token has an empty macro before it. 23744aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis /// 23844aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis bool hasLeadingEmptyMacro() const { 23944aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis return (Flags & LeadingEmptyMacro) ? true : false; 24044aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis } 24144aa1f397855f130e88e62ffc1029f7f83bb5d2eArgyrios Kyrtzidis 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// PPConditionalInfo - Information about the conditional stack (#if directives) 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// currently active. 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerstruct PPConditionalInfo { 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IfLoc - Location where the conditional started. 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 2495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation IfLoc; 2501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// WasSkipping - True if this was contained in a skipping directive, e.g. 2525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// in a "#if 0" block. 2535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WasSkipping; 2541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkip - True if we have emitted tokens already, and now we're in 2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an #else block or something. Only useful in Skipping blocks. 2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkip; 2581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse - True if we've seen a #else in this block. If so, 2605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #elif/#else directives are not allowed. 2615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundElse; 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2661c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramernamespace llvm { 2671c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer template <> 2681c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer struct isPodLike<clang::Token> { static const bool value = true; }; 2691c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer} // end namespace llvm 2701c573cb0e06bac4e557123703069da7dd45d3dc0Benjamin Kramer 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 272