#ifndef LLVM_IR_USER_H
#define LLVM_IR_USER_H
+#include "llvm/ADT/iterator.h"
#include "llvm/ADT/iterator_range.h"
#include "llvm/IR/Value.h"
#include "llvm/Support/ErrorHandling.h"
namespace llvm {
-/// OperandTraits - Compile-time customization of
-/// operand-related allocators and accessors
-/// for use of the User class
+/// \brief Compile-time customization of User operands.
+///
+/// Customizes operand-related allocators and accessors.
template <class>
struct OperandTraits;
class User : public Value {
- User(const User &) LLVM_DELETED_FUNCTION;
- void *operator new(size_t) LLVM_DELETED_FUNCTION;
+ User(const User &) = delete;
+ void *operator new(size_t) = delete;
template <unsigned>
friend struct HungoffOperandTraits;
virtual void anchor();
protected:
- /// OperandList - This is a pointer to the array of Uses for this User.
+ /// \brief This is a pointer to the array of Uses for this User.
+ ///
/// For nodes of fixed arity (e.g. a binary operator) this array will live
/// prefixed to some derived class instance. For nodes of resizable variable
/// arity (e.g. PHINodes, SwitchInst etc.), this memory will be dynamically
/// allocated and should be destroyed by the classes' virtual dtor.
Use *OperandList;
- /// NumOperands - The number of values used by this User.
- ///
- unsigned NumOperands;
-
void *operator new(size_t s, unsigned Us);
User(Type *ty, unsigned vty, Use *OpList, unsigned NumOps)
- : Value(ty, vty), OperandList(OpList), NumOperands(NumOps) {}
+ : Value(ty, vty), OperandList(OpList) {
+ NumOperands = NumOps;
+ }
Use *allocHungoffUses(unsigned) const;
void dropHungoffUses() {
Use::zap(OperandList, OperandList + NumOperands, true);
NumOperands = 0;
}
public:
- ~User() {
- Use::zap(OperandList, OperandList + NumOperands);
- }
- /// operator delete - free memory allocated for User and Use objects
+ ~User() override { Use::zap(OperandList, OperandList + NumOperands); }
+ /// \brief Free memory allocated for User and Use objects.
void operator delete(void *Usr);
- /// placement delete - required by std, but never called.
+ /// \brief Placement delete - required by std, but never called.
void operator delete(void*, unsigned) {
llvm_unreachable("Constructor throws?");
}
- /// placement delete - required by std, but never called.
+ /// \brief Placement delete - required by std, but never called.
void operator delete(void*, unsigned, bool) {
llvm_unreachable("Constructor throws?");
}
return const_op_range(op_begin(), op_end());
}
- /// Convenience iterator for directly iterating over the Values in the
- /// OperandList
- class value_op_iterator
- : public std::iterator<std::random_access_iterator_tag, Value *,
- ptrdiff_t, Value *, Value *> {
- op_iterator OI;
- public:
- explicit value_op_iterator(Use *U = nullptr) : OI(U) {}
-
- bool operator==(const value_op_iterator &x) const {
- return OI == x.OI;
- }
- bool operator!=(const value_op_iterator &x) const {
- return !operator==(x);
- }
-
- value_op_iterator &operator+=(ptrdiff_t n) {
- OI += n;
- return *this;
- }
- value_op_iterator &operator-=(ptrdiff_t n) {
- OI -= n;
- return *this;
- }
- value_op_iterator operator+(ptrdiff_t n) const {
- return value_op_iterator(OI + n);
- }
- friend value_op_iterator operator+(ptrdiff_t n,
- const value_op_iterator &i) {
- return i + n;
- }
- value_op_iterator operator-(ptrdiff_t n) const {
- return value_op_iterator(OI - n);
- }
- ptrdiff_t operator-(const value_op_iterator &RHS) const {
- return OI - RHS.OI;
- }
- bool operator<(const value_op_iterator &RHS) const { return OI < RHS.OI; }
- bool operator>(const value_op_iterator &RHS) const { return OI > RHS.OI; }
- bool operator<=(const value_op_iterator &RHS) const { return OI <= RHS.OI; }
- bool operator>=(const value_op_iterator &RHS) const { return OI >= RHS.OI; }
- value_op_iterator &operator++() { return *this += 1; }
- value_op_iterator &operator--() { return *this -= 1; }
- value_op_iterator operator++(int) {
- value_op_iterator tmp = *this;
- ++*this;
- return tmp;
- }
- value_op_iterator operator--(int) {
- value_op_iterator tmp = *this;
- --*this;
- return tmp;
- }
-
- Value *operator*() const { return *OI; }
+ /// \brief Iterator for directly iterating over the operand Values.
+ struct value_op_iterator
+ : iterator_adaptor_base<value_op_iterator, op_iterator,
+ std::random_access_iterator_tag, Value *,
+ ptrdiff_t, Value *, Value *> {
+ explicit value_op_iterator(Use *U = nullptr) : iterator_adaptor_base(U) {}
+
+ Value *operator*() const { return *I; }
Value *operator->() const { return operator*(); }
- Value *operator[](ptrdiff_t n) const { return *(*this + n); }
};
inline value_op_iterator value_op_begin() {
return iterator_range<value_op_iterator>(value_op_begin(), value_op_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 deleted for real. Note that no operations are
- // valid on an object that has "dropped all references", except operator
- // delete.
- //
+ /// \brief Drop all references to operands.
+ ///
+ /// 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 deleted for
+ /// real. Note that no operations are valid on an object that has "dropped
+ /// all references", except operator delete.
void dropAllReferences() {
for (Use &U : operands())
U.set(nullptr);
}
- /// replaceUsesOfWith - Replaces all references to the "From" definition with
- /// references to the "To" definition.
+ /// \brief Replace uses of one Value with another.
///
+ /// Replaces all references to the "From" definition with references to the
+ /// "To" definition.
void replaceUsesOfWith(Value *From, Value *To);
// Methods for support type inquiry through isa, cast, and dyn_cast:
projects / oota-llvm.git / blobdiff