llvm-6502/include/llvm/User.h
Chris Lattner fb3f24fd57 Fix stupid typo
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168 91177308-0d34-0410-b5e6-96231b3b80d8
2001-07-09 16:54:29 +00:00

80 lines
2.9 KiB
C++

//===-- llvm/User.h - User class definition ----------------------*- C++ -*--=//
//
// This class defines the interface that one who 'use's a Value must implement.
// Each instance of the Value class keeps track of what User's have handles
// to it.
//
// * Instructions are the largest class of User's.
// * Constants may be users of other constants (think arrays and stuff)
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_USER_H
#define LLVM_USER_H
#include "llvm/Value.h"
#include <vector>
class User : public Value {
User(const User &); // Do not implement
protected:
vector<Use> Operands;
public:
User(const Type *Ty, ValueTy vty, const string &name = "");
virtual ~User() { dropAllReferences(); }
inline Value *getOperand(unsigned i) {
assert(i < Operands.size() && "getOperand() out of range!");
return Operands[i];
}
inline const Value *getOperand(unsigned i) const {
assert(i < Operands.size() && "getOperand() const out of range!");
return Operands[i];
}
inline void setOperand(unsigned i, Value *Val) {
assert(i < Operands.size() && "setOperand() out of range!");
Operands[i] = Val;
}
inline unsigned getNumOperands() const { return Operands.size(); }
// ---------------------------------------------------------------------------
// Operand Iterator interface...
//
typedef vector<Use>::iterator op_iterator;
typedef vector<Use>::const_iterator op_const_iterator;
inline op_iterator op_begin() { return Operands.begin(); }
inline op_const_iterator op_begin() const { return Operands.begin(); }
inline op_iterator op_end() { return Operands.end(); }
inline op_const_iterator op_end() const { return Operands.end(); }
// dropAllReferences() - This function is in charge of "letting go" of all
// objects that this User refers to. This allows one to
// 'delete' a whole class at a time, even though there may be circular
// references... first all references are dropped, and all use counts go to
// zero. Then everything is delete'd for real. Note that no operations are
// valid on an object that has "dropped all references", except operator
// delete.
//
inline void dropAllReferences() {
Operands.clear();
}
// replaceUsesOfWith - Replaces all references to the "From" definition with
// references to the "To" definition. (defined in Value.cpp)
//
void replaceUsesOfWith(Value *From, Value *To);
// addOperand - This is a special purpose API that should not be used in most
// cases. It adds an empty (null) operand to the instruction specified. This
// is currently used by the back end as part of the "lowering" process... most
// optimizations will not handle instructions that are not in their normal
// form, so this method should be used with care.
//
void addOperand() {
Operands.push_back(Use(0, this));
}
};
#endif