include/llvm/User.h

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