ASTContext.h revision fb22d96692c5240fb8d611290dbf7eeed3759c73
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- ASTContext.h - Context to hold long-lived AST nodes ----*- 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// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the ASTContext interface. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_AST_ASTCONTEXT_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_AST_ASTCONTEXT_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/AST/Builtins.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/AST/Expr.h" 19464175bba1318bef7905122e9fda20cff926df78Chris Lattner#include "clang/AST/RecordLayout.h" 20464175bba1318bef7905122e9fda20cff926df78Chris Lattner#include "clang/AST/Type.h" 21464175bba1318bef7905122e9fda20cff926df78Chris Lattner#include "llvm/ADT/DenseMap.h" 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <vector> 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer class TargetInfo; 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// ASTContext - This class holds long-lived AST nodes (such as types and 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// decls) that can be referred to throughout the semantic analysis of a file. 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ASTContext { 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<Type*> Types; 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer llvm::FoldingSet<ComplexType> ComplexTypes; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer llvm::FoldingSet<PointerType> PointerTypes; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer llvm::FoldingSet<ReferenceType> ReferenceTypes; 34fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff llvm::FoldingSet<ConstantArrayType> ArrayTypes; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer llvm::FoldingSet<VectorType> VectorTypes; 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer llvm::FoldingSet<FunctionTypeNoProto> FunctionTypeNoProtos; 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer llvm::FoldingSet<FunctionTypeProto> FunctionTypeProtos; 38464175bba1318bef7905122e9fda20cff926df78Chris Lattner llvm::DenseMap<const RecordDecl*, const RecordLayout*> RecordLayoutInfo; 3971993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson RecordDecl *CFConstantStringTypeDecl; 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer TargetInfo &Target; 4271993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson IdentifierTable &Idents; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Builtin::Context BuiltinInfo; 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Builtin Types. 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType VoidTy; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType BoolTy; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType CharTy; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType SignedCharTy, ShortTy, IntTy, LongTy, LongLongTy; 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType UnsignedCharTy, UnsignedShortTy, UnsignedIntTy, UnsignedLongTy; 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType UnsignedLongLongTy; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType FloatTy, DoubleTy, LongDoubleTy; 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType FloatComplexTy, DoubleComplexTy, LongDoubleComplexTy; 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5571993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson ASTContext(TargetInfo &t, IdentifierTable &idents) : 5671993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson CFConstantStringTypeDecl(0), Target(t), Idents(idents) { 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer InitBuiltinTypes(); 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer BuiltinInfo.InitializeBuiltins(idents, Target); 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ~ASTContext(); 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats() const; 63d2d2a11a91d7ddf468bfb70f66362d24806ed601Chris Lattner 64464175bba1318bef7905122e9fda20cff926df78Chris Lattner //===--------------------------------------------------------------------===// 65464175bba1318bef7905122e9fda20cff926df78Chris Lattner // Type Constructors 66464175bba1318bef7905122e9fda20cff926df78Chris Lattner //===--------------------------------------------------------------------===// 67d2d2a11a91d7ddf468bfb70f66362d24806ed601Chris Lattner 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getComplexType - Return the uniqued reference to the type for a complex 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// number with the specified element type. 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getComplexType(QualType T); 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getPointerType - Return the uniqued reference to the type for a pointer to 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the specified type. 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getPointerType(QualType T); 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getReferenceType - Return the uniqued reference to the type for a 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// reference to the specified type. 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getReferenceType(QualType T); 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 80fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff /// getArrayType - If NumElts is a constant expression, we return a unique 81fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff /// reference to an AST node of type ConstantArrayType. If NumElts is not 82fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff /// a constant expression, we return an instance of VaribleLengthArrayType. 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getArrayType(QualType EltTy, ArrayType::ArraySizeModifier ASM, 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned EltTypeQuals, Expr *NumElts); 85fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff 86fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff /// getConstantArrayType - Return the unique reference to the type for an 87fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff /// array of the specified element type. 88fb22d96692c5240fb8d611290dbf7eeed3759c73Steve Naroff QualType getConstantArrayType(QualType EltTy, const llvm::APInt &Sz); 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9073322924127c873c13101b705dd823f5539ffa5fSteve Naroff /// getVectorType - Return the unique reference to a vector type of 9173322924127c873c13101b705dd823f5539ffa5fSteve Naroff /// the specified element type and size. VectorType must be a built-in type. 9273322924127c873c13101b705dd823f5539ffa5fSteve Naroff QualType getVectorType(QualType VectorType, unsigned NumElts); 9373322924127c873c13101b705dd823f5539ffa5fSteve Naroff 9473322924127c873c13101b705dd823f5539ffa5fSteve Naroff /// getOCUVectorType - Return the unique reference to an OCU vector type of 9573322924127c873c13101b705dd823f5539ffa5fSteve Naroff /// the specified element type and size. VectorType must be a built-in type. 9673322924127c873c13101b705dd823f5539ffa5fSteve Naroff QualType getOCUVectorType(QualType VectorType, unsigned NumElts); 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFunctionTypeNoProto - Return a K&R style C function type like 'int()'. 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getFunctionTypeNoProto(QualType ResultTy); 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFunctionType - Return a normal function type with a typed argument 1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// list. isVariadic indicates whether the argument list includes '...'. 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getFunctionType(QualType ResultTy, QualType *ArgArray, 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumArgs, bool isVariadic); 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getTypedefType - Return the unique reference to the type for the 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// specified typename decl. 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getTypedefType(TypedefDecl *Decl); 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 111d1861fd633d5096a00777c918eb8575ea7162fe7Steve Naroff /// getTypeOfType - GCC extension. 1128d1a3b8ca1e5fcc4567b5a6f51d82be2e460de1cSteve Naroff QualType getTypeOfExpr(Expr *e); 113d1861fd633d5096a00777c918eb8575ea7162fe7Steve Naroff QualType getTypeOfType(QualType t); 114d1861fd633d5096a00777c918eb8575ea7162fe7Steve Naroff 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getTagDeclType - Return the unique reference to the type for the 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// specified TagDecl (struct/union/class/enum) decl. 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getTagDeclType(TagDecl *Decl); 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSizeType - Return the unique type for "size_t" (C99 7.17), defined 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// in <stddef.h>. The sizeof operator requires this (C99 6.5.3.4p4). 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer QualType getSizeType() const; 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1238b9023ba35a86838789e2c9034a6128728c547aaChris Lattner /// getPointerDiffType - Return the unique type for "ptrdiff_t" (ref?) 1248b9023ba35a86838789e2c9034a6128728c547aaChris Lattner /// defined in <stddef.h>. Pointer - pointer requires this (C99 6.5.6p9). 1258b9023ba35a86838789e2c9034a6128728c547aaChris Lattner QualType getPointerDiffType() const; 1268b9023ba35a86838789e2c9034a6128728c547aaChris Lattner 12771993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson // getCFConstantStringType - Return the type used for constant CFStrings. 12871993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson QualType getCFConstantStringType(); 12971993dd85eed9cc42c6b2fa61ee5c53026b74817Anders Carlsson 130464175bba1318bef7905122e9fda20cff926df78Chris Lattner //===--------------------------------------------------------------------===// 131464175bba1318bef7905122e9fda20cff926df78Chris Lattner // Type Sizing and Analysis 132464175bba1318bef7905122e9fda20cff926df78Chris Lattner //===--------------------------------------------------------------------===// 133464175bba1318bef7905122e9fda20cff926df78Chris Lattner 134464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// getTypeInfo - Get the size and alignment of the specified complete type in 135464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// bits. 136464175bba1318bef7905122e9fda20cff926df78Chris Lattner std::pair<uint64_t, unsigned> getTypeInfo(QualType T, SourceLocation L); 137464175bba1318bef7905122e9fda20cff926df78Chris Lattner 138464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// getTypeSize - Return the size of the specified type, in bits. This method 139464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// does not work on incomplete types. 140464175bba1318bef7905122e9fda20cff926df78Chris Lattner uint64_t getTypeSize(QualType T, SourceLocation L) { 141464175bba1318bef7905122e9fda20cff926df78Chris Lattner return getTypeInfo(T, L).first; 142464175bba1318bef7905122e9fda20cff926df78Chris Lattner } 143464175bba1318bef7905122e9fda20cff926df78Chris Lattner 144464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// getTypeAlign - Return the alignment of the specified type, in bits. This 145464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// method does not work on incomplete types. 146464175bba1318bef7905122e9fda20cff926df78Chris Lattner unsigned getTypeAlign(QualType T, SourceLocation L) { 147464175bba1318bef7905122e9fda20cff926df78Chris Lattner return getTypeInfo(T, L).second; 148464175bba1318bef7905122e9fda20cff926df78Chris Lattner } 149464175bba1318bef7905122e9fda20cff926df78Chris Lattner 150464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// getRecordLayout - Get or compute information about the layout of the 151464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// specified record (struct/union/class), which indicates its size and field 152464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// position information. 153464175bba1318bef7905122e9fda20cff926df78Chris Lattner const RecordLayout &getRecordLayout(const RecordDecl *D, SourceLocation L); 154464175bba1318bef7905122e9fda20cff926df78Chris Lattner 155464175bba1318bef7905122e9fda20cff926df78Chris Lattner //===--------------------------------------------------------------------===// 156464175bba1318bef7905122e9fda20cff926df78Chris Lattner // Type Operators 157464175bba1318bef7905122e9fda20cff926df78Chris Lattner //===--------------------------------------------------------------------===// 158464175bba1318bef7905122e9fda20cff926df78Chris Lattner 159464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// maxIntegerType - Returns the highest ranked integer type. Handles 3 160464175bba1318bef7905122e9fda20cff926df78Chris Lattner /// different type combos: unsigned/unsigned, signed/signed, signed/unsigned. 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static QualType maxIntegerType(QualType lhs, QualType rhs); 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 163fb0d49669aa370b4c0993c5cee60275ef9fd6518Steve Naroff /// compareFloatingType - Handles 3 different combos: 164fb0d49669aa370b4c0993c5cee60275ef9fd6518Steve Naroff /// float/float, float/complex, complex/complex. 165fb0d49669aa370b4c0993c5cee60275ef9fd6518Steve Naroff /// If lt > rt, return 1. If lt == rt, return 0. If lt < rt, return -1. 166fb0d49669aa370b4c0993c5cee60275ef9fd6518Steve Naroff static int compareFloatingType(QualType lt, QualType rt); 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 168716c7304ff5d27a95e1e7823acd1d09d5ec3e37fSteve Naroff /// getFloatingTypeOfSizeWithinDomain - Returns a real floating 169716c7304ff5d27a95e1e7823acd1d09d5ec3e37fSteve Naroff /// point or a complex type (based on typeDomain/typeSize). 170716c7304ff5d27a95e1e7823acd1d09d5ec3e37fSteve Naroff /// 'typeDomain' is a real floating point or complex type. 171716c7304ff5d27a95e1e7823acd1d09d5ec3e37fSteve Naroff /// 'typeSize' is a real floating point or complex type. 172f1448a0e4a1e868ff873a8530a61a09cb68666ccSteve Naroff QualType getFloatingTypeOfSizeWithinDomain(QualType typeSize, 173f1448a0e4a1e868ff873a8530a61a09cb68666ccSteve Naroff QualType typeDomain) const; 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer ASTContext(const ASTContext&); // DO NOT IMPLEMENT 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void operator=(const ASTContext&); // DO NOT IMPLEMENT 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void InitBuiltinTypes(); 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void InitBuiltinType(QualType &R, BuiltinType::Kind K); 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 185