diff options
author | Reid Spencer <rspencer@reidspencer.com> | 2007-07-11 17:01:13 +0000 |
---|---|---|
committer | Reid Spencer <rspencer@reidspencer.com> | 2007-07-11 17:01:13 +0000 |
commit | 5f016e2cb5d11daeb237544de1c5d59f20fe1a6e (patch) | |
tree | 8b6bfcb8783d16827f896d5facbd4549300e8a1e /include/clang/Lex/IdentifierTable.h | |
parent | a5f182095bf2065ca94f1c86957ee91f9068964b (diff) | |
download | clang-5f016e2cb5d11daeb237544de1c5d59f20fe1a6e.tar.gz |
Stage two of getting CFE top correct.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@39734 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/clang/Lex/IdentifierTable.h')
-rw-r--r-- | include/clang/Lex/IdentifierTable.h | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/include/clang/Lex/IdentifierTable.h b/include/clang/Lex/IdentifierTable.h new file mode 100644 index 0000000000..4edba60094 --- /dev/null +++ b/include/clang/Lex/IdentifierTable.h @@ -0,0 +1,171 @@ +//===--- IdentifierTable.h - Hash table for identifier lookup ---*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file was developed by Chris Lattner and is distributed under +// the University of Illinois Open Source License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// This file defines the IdentifierInfo and IdentifierTable interfaces. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_LEX_IDENTIFIERTABLE_H +#define LLVM_CLANG_LEX_IDENTIFIERTABLE_H + +#include "clang/Basic/TokenKinds.h" +#include "llvm/ADT/StringMap.h" +#include <string> + +namespace clang { + class MacroInfo; + class LangOptions; + +/// IdentifierInfo - One of these records is kept for each identifier that +/// is lexed. This contains information about whether the token was #define'd, +/// is a language keyword, or if it is a front-end token of some sort (e.g. a +/// variable or function name). The preprocessor keeps this information in a +/// set, and all tok::identifier tokens have a pointer to one of these. +class IdentifierInfo { + MacroInfo *Macro; // Set if this identifier is #define'd. + tok::TokenKind TokenID : 8; // Front-end token ID or tok::identifier. + tok::PPKeywordKind PPID : 5; // ID for preprocessor command like #'ifdef'. + tok::ObjCKeywordKind ObjCID : 5; // ID for objc @ keyword like @'protocol'. + unsigned BuiltinID :12; // ID if this is a builtin (__builtin_inf). + bool IsExtension : 1; // True if identifier is a lang extension. + bool IsPoisoned : 1; // True if identifier is poisoned. + bool IsOtherTargetMacro : 1; // True if ident is macro on another target. + bool IsCPPOperatorKeyword : 1; // True if ident is a C++ operator keyword. + bool IsNonPortableBuiltin : 1; // True if builtin varies across targets. + void *FETokenInfo; // Managed by the language front-end. + IdentifierInfo(const IdentifierInfo&); // NONCOPYABLE. +public: + IdentifierInfo(); + ~IdentifierInfo(); + + /// getName - Return the actual string for this identifier. The length of + /// this string is stored in NameLen, and the returned string is properly null + /// terminated. + /// + const char *getName() const { + // String data is stored immediately after the IdentifierInfo object. + return (const char*)(this+1); + } + + /// getMacroInfo - Return macro information about this identifier, or null if + /// it is not a macro. + MacroInfo *getMacroInfo() const { return Macro; } + void setMacroInfo(MacroInfo *I) { Macro = I; } + + /// get/setTokenID - If this is a source-language token (e.g. 'for'), this API + /// can be used to cause the lexer to map identifiers to source-language + /// tokens. + tok::TokenKind getTokenID() const { return TokenID; } + void setTokenID(tok::TokenKind ID) { TokenID = ID; } + + /// getPPKeywordID - Return the preprocessor keyword ID for this identifier. + /// For example, define will return tok::pp_define. + tok::PPKeywordKind getPPKeywordID() const { return PPID; } + void setPPKeywordID(tok::PPKeywordKind ID) { PPID = ID; } + + /// getObjCKeywordID - Return the Objective-C keyword ID for the this + /// identifier. For example, 'class' will return tok::objc_class if ObjC is + /// enabled. + tok::ObjCKeywordKind getObjCKeywordID() const { return ObjCID; } + void setObjCKeywordID(tok::ObjCKeywordKind ID) { ObjCID = ID; } + + /// getBuiltinID - Return a value indicating whether this is a builtin + /// function. 0 is not-built-in. 1 is builtin-for-some-nonprimary-target. + /// 2+ are specific builtin functions. + unsigned getBuiltinID() const { return BuiltinID; } + void setBuiltinID(unsigned ID) { + assert(ID < (1 << 12) && "ID too large for field!"); + BuiltinID = ID; + } + + /// isNonPortableBuiltin - Return true if this identifier corresponds to a + /// builtin on some other target, but isn't one on this target, or if it is on + /// the target but not on another, or if it is on both but it differs somehow + /// in behavior. + bool isNonPortableBuiltin() const { return IsNonPortableBuiltin; } + void setNonPortableBuiltin(bool Val) { IsNonPortableBuiltin = Val; } + + /// get/setExtension - Initialize information about whether or not this + /// language token is an extension. This controls extension warnings, and is + /// only valid if a custom token ID is set. + bool isExtensionToken() const { return IsExtension; } + void setIsExtensionToken(bool Val) { IsExtension = Val; } + + /// setIsPoisoned - Mark this identifier as poisoned. After poisoning, the + /// Preprocessor will emit an error every time this token is used. + void setIsPoisoned(bool Value = true) { IsPoisoned = Value; } + + /// isPoisoned - Return true if this token has been poisoned. + bool isPoisoned() const { return IsPoisoned; } + + /// setIsOtherTargetMacro/isOtherTargetMacro control whether this identifier + /// is seen as being a macro on some other target. + void setIsOtherTargetMacro(bool Val = true) { IsOtherTargetMacro = Val; } + bool isOtherTargetMacro() const { return IsOtherTargetMacro; } + + /// isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether + /// this identifier is a C++ alternate representation of an operator. + void setIsCPlusplusOperatorKeyword(bool Val = true) + { IsCPPOperatorKeyword = Val; } + bool isCPlusPlusOperatorKeyword() const { return IsCPPOperatorKeyword; } + + /// getFETokenInfo/setFETokenInfo - The language front-end is allowed to + /// associate arbitrary metadata with this token. + template<typename T> + T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); } + void setFETokenInfo(void *T) { FETokenInfo = T; } +}; + + + +/// IdentifierTable - This table implements an efficient mapping from strings to +/// IdentifierInfo nodes. It has no other purpose, but this is an +/// extremely performance-critical piece of the code, as each occurrance of +/// every identifier goes through here when lexed. +class IdentifierTable { + // Shark shows that using MallocAllocator is *much* slower than using this + // BumpPtrAllocator! + typedef llvm::StringMap<IdentifierInfo, llvm::BumpPtrAllocator> HashTableTy; + HashTableTy HashTable; +public: + /// IdentifierTable ctor - Create the identifier table, populating it with + /// info about the language keywords for the language specified by LangOpts. + IdentifierTable(const LangOptions &LangOpts); + + /// get - Return the identifier token info for the specified named identifier. + /// + IdentifierInfo &get(const char *NameStart, const char *NameEnd) { + return HashTable.GetOrCreateValue(NameStart, NameEnd).getValue(); + } + + IdentifierInfo &get(const char *Name) { + return get(Name, Name+strlen(Name)); + } + IdentifierInfo &get(const std::string &Name) { + // Don't use c_str() here: no need to be null terminated. + const char *NameBytes = &Name[0]; + return get(NameBytes, NameBytes+Name.size()); + } + + typedef HashTableTy::const_iterator iterator; + typedef HashTableTy::const_iterator const_iterator; + + iterator begin() const { return HashTable.begin(); } + iterator end() const { return HashTable.end(); } + + /// PrintStats - Print some statistics to stderr that indicate how well the + /// hashing is doing. + void PrintStats() const; +private: + void AddKeywords(const LangOptions &LangOpts); +}; + +} // end namespace clang + +#endif |