include/llvm/DerivedTypes.h

   1 //===-- llvm/DerivedTypes.h - Classes for handling data types ----*- C++ -*--=//
   2 //
   3 // This file contains the declarations of classes that represent "derived
   4 // types".  These are things like "arrays of x" or "structure of x, y, z" or
   5 // "method returning x taking (y,z) as parameters", etc...
   6 //
   7 // The implementations of these classes live in the Type.cpp file.
   8 //
   9 //===----------------------------------------------------------------------===//
  10
  11 #ifndef LLVM_DERIVED_TYPES_H
  12 #define LLVM_DERIVED_TYPES_H
  13
  14 #include "llvm/Type.h"
  15
  16 class DerivedType : public Type {
  17   // AbstractTypeUsers - Implement a list of the users that need to be notified
  18   // if I am a type, and I get resolved into a more concrete type.
  19   //
  20   ///// FIXME: kill mutable nonsense when Type's are not const
  21   mutable std::vector<AbstractTypeUser *> AbstractTypeUsers;
  22
  23   char isRefining;                                   // Used for recursive types
  24
  25 protected:
  26   inline DerivedType(PrimitiveID id) : Type("", id) {
  27     isRefining = false;
  28   }
  29
  30   // typeIsRefined - Notify AbstractTypeUsers of this type that the current type
  31   // has been refined a bit.  The pointer is still valid and still should be
  32   // used, but the subtypes have changed.
  33   //
  34   void typeIsRefined();
  35
  36   // setDerivedTypeProperties - Based on the subtypes, set the name of this
  37   // type so that it is printed nicely by the type printer.  Also calculate
  38   // whether this type is abstract or not.  Used by the constructor and when
  39   // the type is refined.
  40   //
  41   void setDerivedTypeProperties();
  42
  43 public:
  44
  45   //===--------------------------------------------------------------------===//
  46   // Abstract Type handling methods - These types have special lifetimes, which
  47   // are managed by (add|remove)AbstractTypeUser. See comments in
  48   // AbstractTypeUser.h for more information.
  49
  50   // addAbstractTypeUser - Notify an abstract type that there is a new user of
  51   // it.  This function is called primarily by the PATypeHandle class.
  52   //
  53   void addAbstractTypeUser(AbstractTypeUser *U) const {
  54     assert(isAbstract() && "addAbstractTypeUser: Current type not abstract!");
  55 #if 0
  56     cerr << "  addAbstractTypeUser[" << (void*)this << ", " << getDescription()
  57          << "][" << AbstractTypeUsers.size() << "] User = " << U << endl;
  58 #endif
  59     AbstractTypeUsers.push_back(U);
  60   }
  61
  62   // removeAbstractTypeUser - Notify an abstract type that a user of the class
  63   // no longer has a handle to the type.  This function is called primarily by
  64   // the PATypeHandle class.  When there are no users of the abstract type, it
  65   // is anihilated, because there is no way to get a reference to it ever again.
  66   //
  67   void removeAbstractTypeUser(AbstractTypeUser *U) const;
  68
  69   // getNumAbstractTypeUsers - Return the number of users registered to the type
  70   inline unsigned getNumAbstractTypeUsers() const {
  71     assert(isAbstract() && "getNumAbstractTypeUsers: Type not abstract!");
  72     return AbstractTypeUsers.size();
  73   }
  74
  75   // refineAbstractTypeTo - This function is used to when it is discovered that
  76   // the 'this' abstract type is actually equivalent to the NewType specified.
  77   // This causes all users of 'this' to switch to reference the more concrete
  78   // type NewType and for 'this' to be deleted.
  79   //
  80   void refineAbstractTypeTo(const Type *NewType);
  81
  82   // Methods for support type inquiry through isa, cast, and dyn_cast:
  83   static inline bool classof(const DerivedType *T) { return true; }
  84   static inline bool classof(const Type *T) {
  85     return T->isDerivedType();
  86   }
  87   static inline bool classof(const Value *V) {
  88     return isa<Type>(V) && classof(cast<const Type>(V));
  89   }
  90 };
  91
  92
  93
  94
  95 class FunctionType : public DerivedType {
  96 public:
  97   typedef std::vector<PATypeHandle<Type> > ParamTypes;
  98 private:
  99   PATypeHandle<Type> ResultType;
 100   ParamTypes ParamTys;
 101   bool isVarArgs;
 102
 103   FunctionType(const FunctionType &);                   // Do not implement
 104   const FunctionType &operator=(const FunctionType &);  // Do not implement
 105 protected:
 106   // This should really be private, but it squelches a bogus warning
 107   // from GCC to make them protected:  warning: `class FunctionType' only
 108   // defines private constructors and has no friends
 109
 110   // Private ctor - Only can be created by a static member...
 111   FunctionType(const Type *Result, const std::vector<const Type*> &Params,
 112                bool IsVarArgs);
 113
 114 public:
 115
 116   inline bool isVarArg() const { return isVarArgs; }
 117   inline const Type *getReturnType() const { return ResultType; }
 118   inline const ParamTypes &getParamTypes() const { return ParamTys; }
 119
 120   // Parameter type accessors...
 121   const Type *getParamType(unsigned i) const { return ParamTys[i]; }
 122
 123   // getNumParams - Return the number of fixed parameters this function type
 124   // requires.  This does not consider varargs.
 125   //
 126   unsigned getNumParams() const { return ParamTys.size(); }
 127
 128
 129   virtual const Type *getContainedType(unsigned i) const {
 130     return i == 0 ? ResultType :
 131                     (i <= ParamTys.size() ? ParamTys[i-1].get() : 0);
 132   }
 133   virtual unsigned getNumContainedTypes() const { return ParamTys.size()+1; }
 134
 135   // refineAbstractType - Called when a contained type is found to be more
 136   // concrete - this could potentially change us from an abstract type to a
 137   // concrete type.
 138   //
 139   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 140
 141   static FunctionType *get(const Type *Result,
 142                            const std::vector<const Type*> &Params,
 143                            bool isVarArg);
 144
 145
 146   // Methods for support type inquiry through isa, cast, and dyn_cast:
 147   static inline bool classof(const FunctionType *T) { return true; }
 148   static inline bool classof(const Type *T) {
 149     return T->getPrimitiveID() == FunctionTyID;
 150   }
 151   static inline bool classof(const Value *V) {
 152     return isa<Type>(V) && classof(cast<const Type>(V));
 153   }
 154 };
 155
 156
 157 // CompositeType - Common super class of ArrayType, StructType, and PointerType
 158 //
 159 class CompositeType : public DerivedType {
 160 protected:
 161   inline CompositeType(PrimitiveID id) : DerivedType(id) { }
 162
 163 public:
 164
 165   // getTypeAtIndex - Given an index value into the type, return the type of the
 166   // element.
 167   //
 168   virtual const Type *getTypeAtIndex(const Value *V) const = 0;
 169   virtual bool indexValid(const Value *V) const = 0;
 170
 171   // getIndexType - Return the type required of indices for this composite.
 172   // For structures, this is ubyte, for arrays, this is uint
 173   //
 174   virtual const Type *getIndexType() const = 0;
 175
 176
 177   // Methods for support type inquiry through isa, cast, and dyn_cast:
 178   static inline bool classof(const CompositeType *T) { return true; }
 179   static inline bool classof(const Type *T) {
 180     return T->getPrimitiveID() == ArrayTyID ||
 181            T->getPrimitiveID() == StructTyID ||
 182            T->getPrimitiveID() == PointerTyID;
 183   }
 184   static inline bool classof(const Value *V) {
 185     return isa<Type>(V) && classof(cast<const Type>(V));
 186   }
 187 };
 188
 189
 190 class StructType : public CompositeType {
 191 public:
 192   typedef std::vector<PATypeHandle<Type> > ElementTypes;
 193
 194 private:
 195   ElementTypes ETypes;                              // Element types of struct
 196
 197   StructType(const StructType &);                   // Do not implement
 198   const StructType &operator=(const StructType &);  // Do not implement
 199
 200 protected:
 201   // This should really be private, but it squelches a bogus warning
 202   // from GCC to make them protected:  warning: `class StructType' only
 203   // defines private constructors and has no friends
 204
 205   // Private ctor - Only can be created by a static member...
 206   StructType(const std::vector<const Type*> &Types);
 207
 208 public:
 209   inline const ElementTypes &getElementTypes() const { return ETypes; }
 210
 211   virtual const Type *getContainedType(unsigned i) const {
 212     return i < ETypes.size() ? ETypes[i].get() : 0;
 213   }
 214   virtual unsigned getNumContainedTypes() const { return ETypes.size(); }
 215
 216   // getTypeAtIndex - Given an index value into the type, return the type of the
 217   // element.  For a structure type, this must be a constant value...
 218   //
 219   virtual const Type *getTypeAtIndex(const Value *V) const ;
 220   virtual bool indexValid(const Value *V) const;
 221
 222   // getIndexType - Return the type required of indices for this composite.
 223   // For structures, this is ubyte, for arrays, this is uint
 224   //
 225   virtual const Type *getIndexType() const { return Type::UByteTy; }
 226
 227   // refineAbstractType - Called when a contained type is found to be more
 228   // concrete - this could potentially change us from an abstract type to a
 229   // concrete type.
 230   //
 231   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 232
 233   static StructType *get(const std::vector<const Type*> &Params);
 234
 235   // Methods for support type inquiry through isa, cast, and dyn_cast:
 236   static inline bool classof(const StructType *T) { return true; }
 237   static inline bool classof(const Type *T) {
 238     return T->getPrimitiveID() == StructTyID;
 239   }
 240   static inline bool classof(const Value *V) {
 241     return isa<Type>(V) && classof(cast<const Type>(V));
 242   }
 243 };
 244
 245
 246 // SequentialType - This is the superclass of the array and pointer type
 247 // classes.  Both of these represent "arrays" in memory.  The array type
 248 // represents a specifically sized array, pointer types are unsized/unknown size
 249 // arrays.  SequentialType holds the common features of both, which stem from
 250 // the fact that both lay their components out in memory identically.
 251 //
 252 class SequentialType : public CompositeType {
 253   SequentialType(const SequentialType &);                  // Do not implement!
 254   const SequentialType &operator=(const SequentialType &); // Do not implement!
 255 protected:
 256   PATypeHandle<Type> ElementType;
 257
 258   SequentialType(PrimitiveID TID, const Type *ElType)
 259     : CompositeType(TID), ElementType(PATypeHandle<Type>(ElType, this)) {
 260   }
 261 public:
 262
 263   inline const Type *getElementType() const { return ElementType; }
 264
 265   virtual const Type *getContainedType(unsigned i) const {
 266     return i == 0 ? ElementType.get() : 0;
 267   }
 268   virtual unsigned getNumContainedTypes() const { return 1; }
 269
 270   // getTypeAtIndex - Given an index value into the type, return the type of the
 271   // element.  For sequential types, there is only one subtype...
 272   //
 273   virtual const Type *getTypeAtIndex(const Value *V) const {
 274     return ElementType.get();
 275   }
 276   virtual bool indexValid(const Value *V) const {
 277     return V->getType() == Type::UIntTy;   // Must be an unsigned int index
 278   }
 279
 280   // getIndexType() - Return the type required of indices for this composite.
 281   // For structures, this is ubyte, for arrays, this is uint
 282   //
 283   virtual const Type *getIndexType() const { return Type::UIntTy; }
 284
 285   // Methods for support type inquiry through isa, cast, and dyn_cast:
 286   static inline bool classof(const SequentialType *T) { return true; }
 287   static inline bool classof(const Type *T) {
 288     return T->getPrimitiveID() == ArrayTyID ||
 289            T->getPrimitiveID() == PointerTyID;
 290   }
 291   static inline bool classof(const Value *V) {
 292     return isa<Type>(V) && classof(cast<const Type>(V));
 293   }
 294 };
 295
 296
 297 class ArrayType : public SequentialType {
 298   unsigned NumElements;
 299
 300   ArrayType(const ArrayType &);                   // Do not implement
 301   const ArrayType &operator=(const ArrayType &);  // Do not implement
 302 protected:
 303   // This should really be private, but it squelches a bogus warning
 304   // from GCC to make them protected:  warning: `class ArrayType' only
 305   // defines private constructors and has no friends
 306
 307
 308   // Private ctor - Only can be created by a static member...
 309   ArrayType(const Type *ElType, unsigned NumEl);
 310 public:
 311   inline unsigned    getNumElements() const { return NumElements; }
 312
 313   // refineAbstractType - Called when a contained type is found to be more
 314   // concrete - this could potentially change us from an abstract type to a
 315   // concrete type.
 316   //
 317   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 318
 319   static ArrayType *get(const Type *ElementType, unsigned NumElements);
 320
 321   // Methods for support type inquiry through isa, cast, and dyn_cast:
 322   static inline bool classof(const ArrayType *T) { return true; }
 323   static inline bool classof(const Type *T) {
 324     return T->getPrimitiveID() == ArrayTyID;
 325   }
 326   static inline bool classof(const Value *V) {
 327     return isa<Type>(V) && classof(cast<const Type>(V));
 328   }
 329 };
 330
 331
 332
 333 class PointerType : public SequentialType {
 334   PointerType(const PointerType &);                   // Do not implement
 335   const PointerType &operator=(const PointerType &);  // Do not implement
 336 protected:
 337   // This should really be private, but it squelches a bogus warning
 338   // from GCC to make them protected:  warning: `class PointerType' only
 339   // defines private constructors and has no friends
 340
 341
 342   // Private ctor - Only can be created by a static member...
 343   PointerType(const Type *ElType);
 344 public:
 345   // PointerType::get - Named constructor for pointer types...
 346   static PointerType *get(const Type *ElementType);
 347
 348   // refineAbstractType - Called when a contained type is found to be more
 349   // concrete - this could potentially change us from an abstract type to a
 350   // concrete type.
 351   //
 352   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 353
 354   // Methods for support type inquiry through isa, cast, and dyn_cast:
 355   static inline bool classof(const PointerType *T) { return true; }
 356   static inline bool classof(const Type *T) {
 357     return T->getPrimitiveID() == PointerTyID;
 358   }
 359   static inline bool classof(const Value *V) {
 360     return isa<Type>(V) && classof(cast<const Type>(V));
 361   }
 362 };
 363
 364
 365 class OpaqueType : public DerivedType {
 366 private:
 367   OpaqueType(const OpaqueType &);                   // Do not implement
 368   const OpaqueType &operator=(const OpaqueType &);  // Do not implement
 369 protected:
 370   // This should really be private, but it squelches a bogus warning
 371   // from GCC to make them protected:  warning: `class OpaqueType' only
 372   // defines private constructors and has no friends
 373
 374   // Private ctor - Only can be created by a static member...
 375   OpaqueType();
 376
 377 public:
 378
 379   // get - Static factory method for the OpaqueType class...
 380   static OpaqueType *get() {
 381     return new OpaqueType();           // All opaque types are distinct
 382   }
 383
 384   // Methods for support type inquiry through isa, cast, and dyn_cast:
 385   static inline bool classof(const OpaqueType *T) { return true; }
 386   static inline bool classof(const Type *T) {
 387     return T->getPrimitiveID() == OpaqueTyID;
 388   }
 389   static inline bool classof(const Value *V) {
 390     return isa<Type>(V) && classof(cast<const Type>(V));
 391   }
 392 };
 393
 394
 395 // Define some inline methods for the AbstractTypeUser.h:PATypeHandle class.
 396 // These are defined here because they MUST be inlined, yet are dependant on
 397 // the definition of the Type class.  Of course Type derives from Value, which
 398 // contains an AbstractTypeUser instance, so there is no good way to factor out
 399 // the code.  Hence this bit of uglyness.
 400 //
 401 template <class TypeSubClass> void PATypeHandle<TypeSubClass>::addUser() {
 402   assert(Ty && "Type Handle has a null type!");
 403   if (Ty->isAbstract())
 404     cast<DerivedType>(Ty)->addAbstractTypeUser(User);
 405 }
 406 template <class TypeSubClass> void PATypeHandle<TypeSubClass>::removeUser() {
 407   if (Ty->isAbstract())
 408     cast<DerivedType>(Ty)->removeAbstractTypeUser(User);
 409 }
 410
 411 template <class TypeSubClass>
 412 void PATypeHandle<TypeSubClass>::removeUserFromConcrete() {
 413   if (!Ty->isAbstract())
 414     cast<DerivedType>(Ty)->removeAbstractTypeUser(User);
 415 }
 416
 417 #endif