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 /// op_erase - This method is used to remove one of the arguments from the
51 /// operands list. Only use this if you know what you are doing.
53 op_iterator op_erase(op_iterator I) { return Operands.erase(I); }
55 // dropAllReferences() - This function is in charge of "letting go" of all
56 // objects that this User refers to. This allows one to
57 // 'delete' a whole class at a time, even though there may be circular
58 // references... first all references are dropped, and all use counts go to
59 // zero. Then everything is delete'd for real. Note that no operations are
60 // valid on an object that has "dropped all references", except operator
63 inline void dropAllReferences() {
67 /// replaceUsesOfWith - Replaces all references to the "From" definition with
68 /// references to the "To" definition.
70 void replaceUsesOfWith(Value *From, Value *To);
72 // Methods for support type inquiry through isa, cast, and dyn_cast:
73 static inline bool classof(const User *) { return true; }
74 static inline bool classof(const Value *V) {
75 return V->getValueType() == Value::GlobalVariableVal ||
76 V->getValueType() == Value::ConstantVal ||
77 V->getValueType() == Value::InstructionVal;
81 template<> struct simplify_type<User::op_iterator> {
82 typedef Value* SimpleType;
84 static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
85 return (SimpleType)Val->get();
88 template<> struct simplify_type<const User::op_iterator>
89 : public simplify_type<User::op_iterator> {};
91 template<> struct simplify_type<User::const_op_iterator> {
92 typedef Value* SimpleType;
94 static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
95 return (SimpleType)Val->get();
98 template<> struct simplify_type<const User::const_op_iterator>
99 : public simplify_type<User::const_op_iterator> {};