xref: /external/clang/include/clang/AST/ASTContext.h

//===--- ASTContext.h - Context to hold long-lived AST nodes ----*- 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 ASTContext interface.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_AST_ASTCONTEXT_H
#define LLVM_CLANG_AST_ASTCONTEXT_H

#include "clang/AST/Builtins.h"
#include "clang/AST/Expr.h"
#include "clang/AST/RecordLayout.h"
#include "clang/AST/Type.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/FoldingSet.h"
#include "llvm/Bitcode/SerializationFwd.h"
#include <vector>

namespace clang {
  class TargetInfo;
  class IdentifierTable;

/// ASTContext - This class holds long-lived AST nodes (such as types and
/// decls) that can be referred to throughout the semantic analysis of a file.
class ASTContext {
  std::vector<Type*> Types;
  llvm::FoldingSet<ComplexType> ComplexTypes;
  llvm::FoldingSet<PointerType> PointerTypes;
  llvm::FoldingSet<ReferenceType> ReferenceTypes;
  llvm::FoldingSet<ConstantArrayType> ConstantArrayTypes;
  llvm::FoldingSet<VariableArrayType> IncompleteVariableArrayTypes;
  std::vector<VariableArrayType*> CompleteVariableArrayTypes;
  llvm::FoldingSet<VectorType> VectorTypes;
  llvm::FoldingSet<FunctionTypeNoProto> FunctionTypeNoProtos;
  llvm::FoldingSet<FunctionTypeProto> FunctionTypeProtos;
  llvm::FoldingSet<ObjcQualifiedInterfaceType> ObjcQualifiedInterfaceTypes;
  llvm::FoldingSet<ObjcQualifiedIdType> ObjcQualifiedIdTypes;
  /// ASTRecordLayouts - A cache mapping from RecordDecls to ASTRecordLayouts.
  ///  This is lazily created.  This is intentionally not serialized.
  llvm::DenseMap<const RecordDecl*, const ASTRecordLayout*> ASTRecordLayouts;

  /// BuiltinVaListType - built-in va list type.
  /// This is initially null and set by Sema::LazilyCreateBuiltin when
  /// a builtin that takes a valist is encountered.
  QualType BuiltinVaListType;

  /// ObjcIdType - a psuedo built-in typedef type (set by Sema).
  QualType ObjcIdType;
  const RecordType *IdStructType;

  /// ObjcSelType - another psuedo built-in typedef type (set by Sema).
  QualType ObjcSelType;
  const RecordType *SelStructType;

  /// ObjcProtoType - another psuedo built-in typedef type (set by Sema).
  QualType ObjcProtoType;
  const RecordType *ProtoStructType;

  /// ObjcClassType - another psuedo built-in typedef type (set by Sema).
  QualType ObjcClassType;
  const RecordType *ClassStructType;

  QualType ObjcConstantStringType;
  RecordDecl *CFConstantStringTypeDecl;

  SourceManager &SourceMgr;
public:
  TargetInfo &Target;
  IdentifierTable &Idents;
  SelectorTable &Selectors;

  SourceManager& getSourceManager() { return SourceMgr; }

  FullSourceLoc getFullLoc(SourceLocation Loc) const {
    return FullSourceLoc(Loc,SourceMgr);
  }

  /// This is intentionally not serialized.  It is populated by the
  /// ASTContext ctor, and there are no external pointers/references to
  /// internal variables of BuiltinInfo.
  Builtin::Context BuiltinInfo;

  // Builtin Types.
  QualType VoidTy;
  QualType BoolTy;
  QualType CharTy;
  QualType SignedCharTy, ShortTy, IntTy, LongTy, LongLongTy;
  QualType UnsignedCharTy, UnsignedShortTy, UnsignedIntTy, UnsignedLongTy;
  QualType UnsignedLongLongTy;
  QualType FloatTy, DoubleTy, LongDoubleTy;
  QualType FloatComplexTy, DoubleComplexTy, LongDoubleComplexTy;
  QualType VoidPtrTy;

  ASTContext(SourceManager &SM, TargetInfo &t, IdentifierTable &idents,
             SelectorTable &sels, unsigned size_reserve=0 ) :
    CFConstantStringTypeDecl(0), SourceMgr(SM), Target(t),
    Idents(idents), Selectors(sels) {

    if (size_reserve > 0) Types.reserve(size_reserve);
    InitBuiltinTypes();
    BuiltinInfo.InitializeBuiltins(idents, Target);
  }

  ~ASTContext();

  void PrintStats() const;
  const std::vector<Type*>& getTypes() const { return Types; }

  //===--------------------------------------------------------------------===//
  //                           Type Constructors
  //===--------------------------------------------------------------------===//

  /// getComplexType - Return the uniqued reference to the type for a complex
  /// number with the specified element type.
  QualType getComplexType(QualType T);

  /// getPointerType - Return the uniqued reference to the type for a pointer to
  /// the specified type.
  QualType getPointerType(QualType T);

  /// getReferenceType - Return the uniqued reference to the type for a
  /// reference to the specified type.
  QualType getReferenceType(QualType T);

  /// getVariableArrayType - Returns a non-unique reference to the type for a
  /// variable array of the specified element type.
  QualType getVariableArrayType(QualType EltTy, Expr *NumElts,
                                ArrayType::ArraySizeModifier ASM,
                                unsigned EltTypeQuals);

  /// getConstantArrayType - Return the unique reference to the type for a
  /// constant array of the specified element type.
  QualType getConstantArrayType(QualType EltTy, const llvm::APInt &ArySize,
                                ArrayType::ArraySizeModifier ASM,
                                unsigned EltTypeQuals);

  /// getVectorType - Return the unique reference to a vector type of
  /// the specified element type and size. VectorType must be a built-in type.
  QualType getVectorType(QualType VectorType, unsigned NumElts);

  /// getOCUVectorType - Return the unique reference to an OCU vector type of
  /// the specified element type and size. VectorType must be a built-in type.
  QualType getOCUVectorType(QualType VectorType, unsigned NumElts);

  /// getFunctionTypeNoProto - Return a K&R style C function type like 'int()'.
  ///
  QualType getFunctionTypeNoProto(QualType ResultTy);

  /// getFunctionType - Return a normal function type with a typed argument
  /// list.  isVariadic indicates whether the argument list includes '...'.
  QualType getFunctionType(QualType ResultTy, QualType *ArgArray,
                           unsigned NumArgs, bool isVariadic);

  /// getTypedefType - Return the unique reference to the type for the
  /// specified typename decl.
  QualType getTypedefType(TypedefDecl *Decl);
  QualType getObjcInterfaceType(ObjcInterfaceDecl *Decl);

  /// getObjcQualifiedInterfaceType - Return a
  /// ObjcQualifiedInterfaceType type for the given interface decl and
  /// the conforming protocol list.
  QualType getObjcQualifiedInterfaceType(ObjcInterfaceDecl *Decl,
             ObjcProtocolDecl **ProtocolList, unsigned NumProtocols);

  /// getObjcQualifiedIdType - Return an ObjcQualifiedIdType for a
  /// given 'id' and conforming protocol list.
  QualType getObjcQualifiedIdType(TypedefDecl *Decl,
                                  ObjcProtocolDecl **ProtocolList,
                                  unsigned NumProtocols);


  /// getTypeOfType - GCC extension.
  QualType getTypeOfExpr(Expr *e);
  QualType getTypeOfType(QualType t);

  /// getTagDeclType - Return the unique reference to the type for the
  /// specified TagDecl (struct/union/class/enum) decl.
  QualType getTagDeclType(TagDecl *Decl);

  /// getSizeType - Return the unique type for "size_t" (C99 7.17), defined
  /// in <stddef.h>. The sizeof operator requires this (C99 6.5.3.4p4).
  QualType getSizeType() const;

  /// getPointerDiffType - Return the unique type for "ptrdiff_t" (ref?)
  /// defined in <stddef.h>. Pointer - pointer requires this (C99 6.5.6p9).
  QualType getPointerDiffType() const;

  // getCFConstantStringType - Return the C structure type used to represent
  // constant CFStrings.
  QualType getCFConstantStringType();

  // This setter/getter represents the ObjC type for an NSConstantString.
  void setObjcConstantStringInterface(ObjcInterfaceDecl *Decl);
  QualType getObjcConstantStringInterface() const {
    return ObjcConstantStringType;
  }

  // Return the ObjC type encoding for a given type.
  void getObjcEncodingForType(QualType t, std::string &S) const;

  // Put the string version of type qualifiers into S.
  void getObjcEncodingForTypeQualifier(Decl::ObjcDeclQualifier QT,
                                       std::string &S) const;

  /// getObjcEncodingForMethodDecl - Return the encoded type for this method
  /// declaration.
  void getObjcEncodingForMethodDecl(ObjcMethodDecl *Decl, std::string &S);

  /// getObjcEncodingTypeSize returns size of type for objective-c encoding
  /// purpose.
  int getObjcEncodingTypeSize(QualType t);

  // This setter/getter repreents the ObjC 'id' type. It is setup lazily, by
  // Sema.
  void setObjcIdType(TypedefDecl *Decl);
  QualType getObjcIdType() const { return ObjcIdType; }

  void setObjcSelType(TypedefDecl *Decl);
  QualType getObjcSelType() const { return ObjcSelType; }

  void setObjcProtoType(QualType QT);
  QualType getObjcProtoType() const { return ObjcProtoType; }

  void setObjcClassType(TypedefDecl *Decl);
  QualType getObjcClassType() const { return ObjcClassType; }

  void setBuiltinVaListType(QualType T);
  QualType getBuiltinVaListType() const { return BuiltinVaListType; }

  //===--------------------------------------------------------------------===//
  //                         Type Sizing and Analysis
  //===--------------------------------------------------------------------===//

  /// getTypeInfo - Get the size and alignment of the specified complete type in
  /// bits.
  std::pair<uint64_t, unsigned> getTypeInfo(QualType T, SourceLocation L);

  /// getTypeSize - Return the size of the specified type, in bits.  This method
  /// does not work on incomplete types.
  uint64_t getTypeSize(QualType T, SourceLocation L) {
    return getTypeInfo(T, L).first;
  }

  /// getTypeAlign - Return the alignment of the specified type, in bits.  This
  /// method does not work on incomplete types.
  unsigned getTypeAlign(QualType T, SourceLocation L) {
    return getTypeInfo(T, L).second;
  }

  /// getASTRecordLayout - Get or compute information about the layout of the
  /// specified record (struct/union/class), which indicates its size and field
  /// position information.
  const ASTRecordLayout &getASTRecordLayout(const RecordDecl *D, SourceLocation L);

  //===--------------------------------------------------------------------===//
  //                            Type Operators
  //===--------------------------------------------------------------------===//

  /// maxIntegerType - Returns the highest ranked integer type. Handles 3
  /// different type combos: unsigned/unsigned, signed/signed, signed/unsigned.
  static QualType maxIntegerType(QualType lhs, QualType rhs);

  /// compareFloatingType - Handles 3 different combos:
  /// float/float, float/complex, complex/complex.
  /// If lt > rt, return 1. If lt == rt, return 0. If lt < rt, return -1.
  static int compareFloatingType(QualType lt, QualType rt);

  /// getFloatingTypeOfSizeWithinDomain - Returns a real floating
  /// point or a complex type (based on typeDomain/typeSize).
  /// 'typeDomain' is a real floating point or complex type.
  /// 'typeSize' is a real floating point or complex type.
  QualType getFloatingTypeOfSizeWithinDomain(QualType typeSize,
                                             QualType typeDomain) const;

  //===--------------------------------------------------------------------===//
  //                    Type Compatibility Predicates
  //===--------------------------------------------------------------------===//

  /// Compatibility predicates used to check assignment expressions.
  bool typesAreCompatible(QualType, QualType); // C99 6.2.7p1
  bool tagTypesAreCompatible(QualType, QualType); // C99 6.2.7p1
  bool pointerTypesAreCompatible(QualType, QualType);  // C99 6.7.5.1p2
  bool referenceTypesAreCompatible(QualType, QualType); // C++ 5.17p6
  bool functionTypesAreCompatible(QualType, QualType); // C99 6.7.5.3p15
  bool arrayTypesAreCompatible(QualType, QualType); // C99 6.7.5.2p6
  bool builtinTypesAreCompatible(QualType, QualType);
  bool vectorTypesAreCompatible(QualType, QualType);

  /// Objective-C specific type checking.
  bool interfaceTypesAreCompatible(QualType, QualType);
  bool QualifiedInterfaceTypesAreCompatible(QualType, QualType);
  bool objcTypesAreCompatible(QualType, QualType);
  bool isObjcIdType(QualType T) const {
    if (!IdStructType) // ObjC isn't enabled
      return false;
    return T->getAsStructureType() == IdStructType;
  }
  bool isObjcClassType(QualType T) const {
    if (!ClassStructType) // ObjC isn't enabled
      return false;
    return T->getAsStructureType() == ClassStructType;
  }
  bool isObjcSelType(QualType T) const {
    assert(SelStructType && "isObjcSelType used before 'SEL' type is built");
    return T->getAsStructureType() == SelStructType;
  }

private:
  ASTContext(const ASTContext&); // DO NOT IMPLEMENT
  void operator=(const ASTContext&); // DO NOT IMPLEMENT

  void InitBuiltinTypes();
  void InitBuiltinType(QualType &R, BuiltinType::Kind K);

  //===--------------------------------------------------------------------===//
  //                    Serialization
  //===--------------------------------------------------------------------===//

public:
  void Emit(llvm::Serializer& S) const;
  static ASTContext* Create(llvm::Deserializer& D);
};

}  // end namespace clang

#endif