1 //===-- llvm/User.h - User class definition ----------------------*- C++ -*--=//
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
7 // * Instructions are the largest class of User's.
8 // * Constants may be users of other constants (think arrays and stuff)
10 //===----------------------------------------------------------------------===//
15 #include "llvm/Value.h"
17 class User : public Value {
18 User(const User &); // Do not implement
20 std::vector<Use> Operands;
22 User(const Type *Ty, ValueTy vty, const std::string &name = "");
23 virtual ~User() { dropAllReferences(); }
25 inline Value *getOperand(unsigned i) {
26 assert(i < Operands.size() && "getOperand() out of range!");
29 inline const Value *getOperand(unsigned i) const {
30 assert(i < Operands.size() && "getOperand() const out of range!");
33 inline void setOperand(unsigned i, Value *Val) {
34 assert(i < Operands.size() && "setOperand() out of range!");
37 inline unsigned getNumOperands() const { return Operands.size(); }
39 // ---------------------------------------------------------------------------
40 // Operand Iterator interface...
42 typedef std::vector<Use>::iterator op_iterator;
43 typedef std::vector<Use>::const_iterator const_op_iterator;
45 inline op_iterator op_begin() { return Operands.begin(); }
46 inline const_op_iterator op_begin() const { return Operands.begin(); }
47 inline op_iterator op_end() { return Operands.end(); }
48 inline const_op_iterator op_end() const { return Operands.end(); }
50 // dropAllReferences() - This function is in charge of "letting go" of all
51 // objects that this User refers to. This allows one to
52 // 'delete' a whole class at a time, even though there may be circular
53 // references... first all references are dropped, and all use counts go to
54 // zero. Then everything is delete'd for real. Note that no operations are
55 // valid on an object that has "dropped all references", except operator
58 inline void dropAllReferences() {
62 /// replaceUsesOfWith - Replaces all references to the "From" definition with
63 /// references to the "To" definition.
65 void replaceUsesOfWith(Value *From, Value *To);
67 // Methods for support type inquiry through isa, cast, and dyn_cast:
68 static inline bool classof(const User *) { return true; }
69 static inline bool classof(const Value *V) {
70 return V->getValueType() == Value::GlobalVariableVal ||
71 V->getValueType() == Value::ConstantVal ||
72 V->getValueType() == Value::InstructionVal;
76 template<> struct simplify_type<User::op_iterator> {
77 typedef Value* SimpleType;
79 static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
80 return (SimpleType)Val->get();
83 template<> struct simplify_type<const User::op_iterator>
84 : public simplify_type<User::op_iterator> {};
86 template<> struct simplify_type<User::const_op_iterator> {
87 typedef Value* SimpleType;
89 static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
90 return (SimpleType)Val->get();
93 template<> struct simplify_type<const User::const_op_iterator>
94 : public simplify_type<User::const_op_iterator> {};