Token.h revision 000732226610650837478cba97843d19b75f648e
1d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner//===--- Token.h - Token interface ------------------------------*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 55f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file was developed by Chris Lattner and is distributed under 65f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// the University of Illinois Open Source 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 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/TokenKinds.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierInfo; 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 24d217773f106856a11879ec79dc468efefaf2ee75Chris Lattner/// Token - This structure provides full information about a lexed token. 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// It is not intended to be space efficient, it is intended to return as much 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// information as possible about each returned token. This is expected to be 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// compressed into a smaller form if memory footprint is important. 28d217773f106856a11879ec79dc468efefaf2ee75Chris Lattnerclass Token { 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// The location and length of the token text itself. 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation Loc; 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned Length; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IdentifierInfo - If this was an identifier, this points to the uniqued 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// information about this identifier. 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *IdentInfo; 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Kind - The actual flavor of token this is. 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer tok::TokenKind Kind : 8; 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Flags - Bits we track about this token, members of the TokenFlags enum. 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned Flags : 8; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Various flags set per token: 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum TokenFlags { 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer StartOfLine = 0x01, // At start of line or only after whitespace. 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer LeadingSpace = 0x02, // Whitespace exists before this token. 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer DisableExpand = 0x04, // This identifier may never be macro expanded. 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer NeedsCleaning = 0x08 // Contained an escaped newline or trigraph. 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer tok::TokenKind getKind() const { return Kind; } 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setKind(tok::TokenKind K) { Kind = K; } 55000732226610650837478cba97843d19b75f648eChris Lattner 56000732226610650837478cba97843d19b75f648eChris Lattner /// is/isNot - Predicates to check if this token is a specific kind, as in 57000732226610650837478cba97843d19b75f648eChris Lattner /// "if (Tok.is(tok::l_brace)) {...}". 58000732226610650837478cba97843d19b75f648eChris Lattner bool is(tok::TokenKind K) const { return Kind == K; } 59000732226610650837478cba97843d19b75f648eChris Lattner bool isNot(tok::TokenKind K) const { return Kind != K; } 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getLocation - Return a source location identifier for the specified 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// offset in the current file. 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation getLocation() const { return Loc; } 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getLength() const { return Length; } 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setLocation(SourceLocation L) { Loc = L; } 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setLength(unsigned Len) { Length = Len; } 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 694d33275624e53bf0c16e188d9b1f6a08b2068fccChris Lattner const char *getName() const { return tok::getTokenName(Kind); } 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// startToken - Reset all flags to cleared. 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void startToken() { 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags = 0; 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentInfo = 0; 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Loc = SourceLocation(); 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo *getIdentifierInfo() const { return IdentInfo; } 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setIdentifierInfo(IdentifierInfo *II) { 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentInfo = II; 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setFlag - Set the specified flag. 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlag(TokenFlags Flag) { 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags |= Flag; 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// clearFlag - Unset the specified flag. 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void clearFlag(TokenFlags Flag) { 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Flags &= ~Flag; 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setFlagValue - Set a flag to either true or false. 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFlagValue(TokenFlags Flag, bool Val) { 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (Val) 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer setFlag(Flag); 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer else 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer clearFlag(Flag); 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isAtStartOfLine - Return true if this token is at the start of a line. 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 104b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool isAtStartOfLine() const { return (Flags & StartOfLine) ? true : false; } 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// hasLeadingSpace - Return true if this token has whitespace before it. 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 108b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool hasLeadingSpace() const { return (Flags & LeadingSpace) ? true : false; } 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isExpandDisabled - Return true if this identifier token should never 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// be expanded in the future, due to C99 6.10.3.4p2. 112b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool isExpandDisabled() const { return (Flags & DisableExpand) ? true : false; } 113861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff 114861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff /// isObjCAtKeyword - Return true if we have an ObjC keyword identifier. 115861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff bool isObjCAtKeyword(tok::ObjCKeywordKind objcKey) const; 116861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff 117861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff /// getObjCKeywordID - Return the ObjC keyword kind. 118861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff tok::ObjCKeywordKind getObjCKeywordID() const; 119861cf3effdc0fbc97d401539bc3050da76b2476fSteve Naroff 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// needsCleaning - Return true if this token has trigraphs or escaped 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// newlines in it. 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 123b8128140956c6f8f0ab143818775a81f4b4aa477Chris Lattner bool needsCleaning() const { return (Flags & NeedsCleaning) ? true : false; } 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// PPConditionalInfo - Information about the conditional stack (#if directives) 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// currently active. 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerstruct PPConditionalInfo { 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IfLoc - Location where the conditional started. 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation IfLoc; 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// WasSkipping - True if this was contained in a skipping directive, e.g. 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// in a "#if 0" block. 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WasSkipping; 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundNonSkip - True if we have emitted tokens already, and now we're in 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an #else block or something. Only useful in Skipping blocks. 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundNonSkip; 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FoundElse - True if we've seen a #else in this block. If so, 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// #elif/#else directives are not allowed. 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool FoundElse; 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 149