include/llvm/User.h

   1 //===-- llvm/User.h - User class definition ---------------------*- C++ -*-===//
   2 //
   3 // This class defines the interface that one who 'use's a Value must implement.
   4 // Each instance of the Value class keeps track of what User's have handles
   5 // to it.
   6 //
   7 //  * Instructions are the largest class of User's.
   8 //  * Constants may be users of other constants (think arrays and stuff)
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #ifndef LLVM_USER_H
  13 #define LLVM_USER_H
  14
  15 #include "llvm/Value.h"
  16
  17 class User : public Value {
  18   User(const User &);             // Do not implement
  19 protected:
  20   std::vector<Use> Operands;
  21 public:
  22   User(const Type *Ty, ValueTy vty, const std::string &name = "");
  23
  24   inline Value *getOperand(unsigned i) {
  25     assert(i < Operands.size() && "getOperand() out of range!");
  26     return Operands[i];
  27   }
  28   inline const Value *getOperand(unsigned i) const {
  29     assert(i < Operands.size() && "getOperand() const out of range!");
  30     return Operands[i];
  31   }
  32   inline void setOperand(unsigned i, Value *Val) {
  33     assert(i < Operands.size() && "setOperand() out of range!");
  34     Operands[i] = Val;
  35   }
  36   inline unsigned getNumOperands() const { return Operands.size(); }
  37
  38   // ---------------------------------------------------------------------------
  39   // Operand Iterator interface...
  40   //
  41   typedef std::vector<Use>::iterator       op_iterator;
  42   typedef std::vector<Use>::const_iterator const_op_iterator;
  43
  44   void op_reserve(unsigned NumElements) { Operands.reserve(NumElements); }
  45
  46   inline op_iterator       op_begin()       { return Operands.begin(); }
  47   inline const_op_iterator op_begin() const { return Operands.begin(); }
  48   inline op_iterator       op_end()         { return Operands.end(); }
  49   inline const_op_iterator op_end()   const { return Operands.end(); }
  50
  51   /// op_erase - This method is used to remove one of the arguments from the
  52   /// operands list.  Only use this if you know what you are doing.
  53   ///
  54   op_iterator op_erase(op_iterator I) { return Operands.erase(I); }
  55
  56   // dropAllReferences() - This function is in charge of "letting go" of all
  57   // objects that this User refers to.  This allows one to
  58   // 'delete' a whole class at a time, even though there may be circular
  59   // references... first all references are dropped, and all use counts go to
  60   // zero.  Then everything is delete'd for real.  Note that no operations are
  61   // valid on an object that has "dropped all references", except operator
  62   // delete.
  63   //
  64   inline void dropAllReferences() {
  65     Operands.clear();
  66   }
  67
  68   /// replaceUsesOfWith - Replaces all references to the "From" definition with
  69   /// references to the "To" definition.
  70   ///
  71   void replaceUsesOfWith(Value *From, Value *To);
  72
  73   // Methods for support type inquiry through isa, cast, and dyn_cast:
  74   static inline bool classof(const User *) { return true; }
  75   static inline bool classof(const Value *V) {
  76     return V->getValueType() == Value::GlobalVariableVal ||
  77            V->getValueType() == Value::ConstantVal ||
  78            V->getValueType() == Value::InstructionVal;
  79   }
  80 };
  81
  82 template<> struct simplify_type<User::op_iterator> {
  83   typedef Value* SimpleType;
  84
  85   static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
  86     return (SimpleType)Val->get();
  87   }
  88 };
  89 template<> struct simplify_type<const User::op_iterator>
  90   : public simplify_type<User::op_iterator> {};
  91
  92 template<> struct simplify_type<User::const_op_iterator> {
  93   typedef Value* SimpleType;
  94
  95   static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
  96     return (SimpleType)Val->get();
  97   }
  98 };
  99 template<> struct simplify_type<const User::const_op_iterator>
 100   : public simplify_type<User::const_op_iterator> {};
 101
 102 #endif