ASTContext.h revision 5f016e2cb5d11daeb237544de1c5d59f20fe1a6e
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/Type.h"
195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/AST/Expr.h"
205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <vector>
215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang {
235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  class TargetInfo;
245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// ASTContext - This class holds long-lived AST nodes (such as types and
265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// decls) that can be referred to throughout the semantic analysis of a file.
275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass ASTContext {
285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  std::vector<Type*> Types;
295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<ComplexType> ComplexTypes;
305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<PointerType> PointerTypes;
315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<ReferenceType> ReferenceTypes;
325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<ArrayType> ArrayTypes;
335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<VectorType> VectorTypes;
345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<FunctionTypeNoProto> FunctionTypeNoProtos;
355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  llvm::FoldingSet<FunctionTypeProto> FunctionTypeProtos;
365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic:
375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  TargetInfo &Target;
385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  Builtin::Context BuiltinInfo;
395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // Builtin Types.
415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType VoidTy;
425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType BoolTy;
435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType CharTy;
445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType SignedCharTy, ShortTy, IntTy, LongTy, LongLongTy;
455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType UnsignedCharTy, UnsignedShortTy, UnsignedIntTy, UnsignedLongTy;
465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType UnsignedLongLongTy;
475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType FloatTy, DoubleTy, LongDoubleTy;
485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType FloatComplexTy, DoubleComplexTy, LongDoubleComplexTy;
495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ASTContext(TargetInfo &t, IdentifierTable &idents) : Target(t) {
515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer    InitBuiltinTypes();
525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer    BuiltinInfo.InitializeBuiltins(idents, Target);
535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  }
545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ~ASTContext();
555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void PrintStats() const;
575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getComplexType - Return the uniqued reference to the type for a complex
595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// number with the specified element type.
605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getComplexType(QualType T);
615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getPointerType - Return the uniqued reference to the type for a pointer to
635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// the specified type.
645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getPointerType(QualType T);
655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getReferenceType - Return the uniqued reference to the type for a
675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// reference to the specified type.
685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getReferenceType(QualType T);
695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getArrayType - Return the unique reference to the type for an array of the
715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// specified element type.
725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getArrayType(QualType EltTy, ArrayType::ArraySizeModifier ASM,
735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer                        unsigned EltTypeQuals, Expr *NumElts);
745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// convertToVectorType - Return the unique reference to a vector type of
765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// the specified element type and size. VectorType can be a pointer, array,
775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// function, or built-in type (i.e. _Bool, integer, or float).
785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType convertToVectorType(QualType VectorType, unsigned NumElts);
795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getFunctionTypeNoProto - Return a K&R style C function type like 'int()'.
815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getFunctionTypeNoProto(QualType ResultTy);
835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getFunctionType - Return a normal function type with a typed argument
855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// list.  isVariadic indicates whether the argument list includes '...'.
865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getFunctionType(QualType ResultTy, QualType *ArgArray,
875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer                           unsigned NumArgs, bool isVariadic);
885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getTypedefType - Return the unique reference to the type for the
905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// specified typename decl.
915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getTypedefType(TypedefDecl *Decl);
925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getTagDeclType - Return the unique reference to the type for the
945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// specified TagDecl (struct/union/class/enum) decl.
955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getTagDeclType(TagDecl *Decl);
965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getSizeType - Return the unique type for "size_t" (C99 7.17), defined
985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// in <stddef.h>. The sizeof operator requires this (C99 6.5.3.4p4).
995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType getSizeType() const;
1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getIntegerBitwidth - Return the bitwidth of the specified integer type
1025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// according to the target.  'Loc' specifies the source location that
1035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// requires evaluation of this property.
1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  unsigned getIntegerBitwidth(QualType T, SourceLocation Loc);
1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // maxIntegerType - Returns the highest ranked integer type. Handles 3
1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // different type combos: unsigned/unsigned, signed/signed, signed/unsigned.
1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  static QualType maxIntegerType(QualType lhs, QualType rhs);
1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // maxFloatingType - Returns the highest ranked float type. Both input
1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // types are required to be floats.
1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  static QualType maxFloatingType(QualType lt, QualType rt);
1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // maxComplexType - Returns the highest ranked complex type. Handles 3
1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // different type combos: complex/complex, complex/float, float/complex.
1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  QualType maxComplexType(QualType lt, QualType rt) const;
1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate:
1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ASTContext(const ASTContext&); // DO NOT IMPLEMENT
1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void operator=(const ASTContext&); // DO NOT IMPLEMENT
1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void InitBuiltinTypes();
1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void InitBuiltinType(QualType &R, BuiltinType::Kind K);
1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}  // end namespace clang
1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif
129