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 //===----------------------------------------------------------------------===//
17 #include "llvm/Value.h"
19 class User : public Value {
20 User(const User &); // Do not implement
22 std::vector<Use> Operands;
24 User(const Type *Ty, ValueTy vty, const std::string &name = "");
25 virtual ~User() { dropAllReferences(); }
27 inline Value *getOperand(unsigned i) {
28 assert(i < Operands.size() && "getOperand() out of range!");
31 inline const Value *getOperand(unsigned i) const {
32 assert(i < Operands.size() && "getOperand() const out of range!");
35 inline void setOperand(unsigned i, Value *Val) {
36 assert(i < Operands.size() && "setOperand() out of range!");
39 inline unsigned getNumOperands() const { return Operands.size(); }
41 // ---------------------------------------------------------------------------
42 // Operand Iterator interface...
44 typedef std::vector<Use>::iterator op_iterator;
45 typedef std::vector<Use>::const_iterator const_op_iterator;
47 inline op_iterator op_begin() { return Operands.begin(); }
48 inline const_op_iterator op_begin() const { return Operands.begin(); }
49 inline op_iterator op_end() { return Operands.end(); }
50 inline const_op_iterator op_end() const { return Operands.end(); }
52 // dropAllReferences() - This function is in charge of "letting go" of all
53 // objects that this User refers to. This allows one to
54 // 'delete' a whole class at a time, even though there may be circular
55 // references... first all references are dropped, and all use counts go to
56 // zero. Then everything is delete'd for real. Note that no operations are
57 // valid on an object that has "dropped all references", except operator
60 inline void dropAllReferences() {
64 /// replaceUsesOfWith - Replaces all references to the "From" definition with
65 /// references to the "To" definition.
67 void replaceUsesOfWith(Value *From, Value *To);
69 // Methods for support type inquiry through isa, cast, and dyn_cast:
70 static inline bool classof(const User *) { return true; }
71 static inline bool classof(const Value *V) {
72 return V->getValueType() == Value::GlobalVariableVal ||
73 V->getValueType() == Value::ConstantVal ||
74 V->getValueType() == Value::InstructionVal;
78 template<> struct simplify_type<User::op_iterator> {
79 typedef Value* SimpleType;
81 static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
82 return (SimpleType)Val->get();
85 template<> struct simplify_type<const User::op_iterator>
86 : public simplify_type<User::op_iterator> {};
88 template<> struct simplify_type<User::const_op_iterator> {
89 typedef Value* SimpleType;
91 static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
92 return (SimpleType)Val->get();
95 template<> struct simplify_type<const User::const_op_iterator>
96 : public simplify_type<User::const_op_iterator> {};