add an assertion

[oota-llvm.git] / include / llvm / User.h

diff --git a/include/llvm/User.h b/include/llvm/User.h
index 58e0dec22bb9f50f0752932846392cf06dcbaa28..47f300cd534aafe9888cc43ff8feec4903f5a8f7 100644 (file)
--- a/include/llvm/User.h
+++ b/include/llvm/User.h
@@ -1,4 +1,11 @@
-//===-- llvm/User.h - User class definition ----------------------*- C++ -*--=//
+//===-- llvm/User.h - User class definition ---------------------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // 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
@@ -13,35 +20,97 @@
 #define LLVM_USER_H
 
 #include "llvm/Value.h"
+#include <vector>
+
+namespace llvm {
 
 class User : public Value {
   User(const User &);             // Do not implement
+protected:
+  std::vector<Use> Operands;
 public:
-  User(const Type *Ty, ValueTy vty, const string &name = "");
-  virtual ~User() {}
+  User(const Type *Ty, unsigned vty, const std::string &name = "")
+    : Value(Ty, vty, name) {}
+
+  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 (unsigned)Operands.size(); }
 
-  // if i > the number of operands, then getOperand() returns 0, and setOperand
-  // returns false.  setOperand() may also return false if the operand is of
-  // the wrong type.
+  // ---------------------------------------------------------------------------
+  // Operand Iterator interface...
   //
-  virtual Value *getOperand(unsigned i) = 0;
-  virtual const Value *getOperand(unsigned i) const = 0;
-  virtual bool setOperand(unsigned i, Value *Val) = 0;
+  typedef std::vector<Use>::iterator       op_iterator;
+  typedef std::vector<Use>::const_iterator const_op_iterator;
+
+  void op_reserve(unsigned NumElements) { Operands.reserve(NumElements); }
+
+  inline op_iterator       op_begin()       { return Operands.begin(); }
+  inline const_op_iterator op_begin() const { return Operands.begin(); }
+  inline op_iterator       op_end()         { return Operands.end(); }
+  inline const_op_iterator op_end()   const { return Operands.end(); }
+
+  /// op_erase - This method is used to remove one of the arguments from the
+  /// operands list.  Only use this if you know what you are doing.
+  ///
+  op_iterator op_erase(op_iterator I) { return Operands.erase(I); }
+  op_iterator op_erase(op_iterator I, op_iterator E) {
+    return Operands.erase(I, E);
+  }
 
-  // dropAllReferences() - This virtual function should be overridden to "let
-  // go" of all references that this user is maintaining.  This allows one to 
+  // 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.
   //
-  virtual void dropAllReferences() = 0;
+  inline void dropAllReferences() {
+    Operands.clear();
+  }
 
-  // replaceUsesOfWith - Replaces all references to the "From" definition with
-  // references to the "To" definition.  (defined in Value.cpp)
-  //
+  /// replaceUsesOfWith - 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:
+  static inline bool classof(const User *) { return true; }
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) || isa<Constant>(V);
+  }
+};
+
+template<> struct simplify_type<User::op_iterator> {
+  typedef Value* SimpleType;
+  
+  static SimpleType getSimplifiedValue(const User::op_iterator &Val) {
+    return static_cast<SimpleType>(Val->get());
+  }
 };
+template<> struct simplify_type<const User::op_iterator>
+  : public simplify_type<User::op_iterator> {};
+
+template<> struct simplify_type<User::const_op_iterator> {
+  typedef Value* SimpleType;
+  
+  static SimpleType getSimplifiedValue(const User::const_op_iterator &Val) {
+    return static_cast<SimpleType>(Val->get());
+  }
+};
+template<> struct simplify_type<const User::const_op_iterator>
+  : public simplify_type<User::const_op_iterator> {};
+
+} // End llvm namespace
 
 #endif