Added iterators to ImmutableSet.
[oota-llvm.git] / include / llvm / User.h
index 310d356a53e6fdd462447e183e913b35f9055094..1ea5e189ba8263351d4e1ce99fd468b2855657ce 100644 (file)
@@ -1,10 +1,10 @@
 //===-- 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.
 #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;
+  /// OperandList - This is a pointer to the array of Users for this operand.
+  /// For nodes of fixed arity (e.g. a binary operator) this array will live
+  /// embedded into the derived class.  For nodes of variable arity
+  /// (e.g. ConstantArrays, CallInst, PHINodes, 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;
+
 public:
-  User(const Type *Ty, unsigned vty, const std::string &name = "")
-    : Value(Ty, vty, name) {}
+  User(const Type *Ty, unsigned vty, Use *OpList, unsigned NumOps)
+    : Value(Ty, vty), OperandList(OpList), NumOperands(NumOps) {}
 
-  inline Value *getOperand(unsigned i) { 
-    assert(i < Operands.size() && "getOperand() out of range!");
-    return Operands[i];
+  Value *getOperand(unsigned i) const {
+    assert(i < NumOperands && "getOperand() out of range!");
+    return OperandList[i];
   }
-  inline const Value *getOperand(unsigned i) const {
-    assert(i < Operands.size() && "getOperand() const out of range!");
-    return Operands[i];
+  void setOperand(unsigned i, Value *Val) {
+    assert(i < NumOperands && "setOperand() out of range!");
+    OperandList[i] = Val;
   }
-  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(); }
+  unsigned getNumOperands() const { return NumOperands; }
 
   // ---------------------------------------------------------------------------
   // Operand Iterator interface...
   //
-  typedef std::vector<Use>::iterator       op_iterator;
-  typedef std::vector<Use>::const_iterator const_op_iterator;
-
-  void op_reserve(unsigned NumElements) { Operands.reserve(NumElements); }
+  typedef Use*       op_iterator;
+  typedef const Use* const_op_iterator;
 
-  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);
-  }
+  inline op_iterator       op_begin()       { return OperandList; }
+  inline const_op_iterator op_begin() const { return OperandList; }
+  inline op_iterator       op_end()         { return OperandList+NumOperands; }
+  inline const_op_iterator op_end()   const { return OperandList+NumOperands; }
 
   // 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 
+  // valid on an object that has "dropped all references", except operator
   // delete.
   //
-  inline void dropAllReferences() {
-    Operands.clear();
+  void dropAllReferences() {
+    Use *OL = OperandList;
+    for (unsigned i = 0, e = NumOperands; i != e; ++i)
+      OL[i].set(0);
   }
 
   /// replaceUsesOfWith - Replaces all references to the "From" definition with
@@ -87,31 +84,39 @@ public:
   // 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<GlobalVariable>(V) ||
-           isa<Constant>(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> {};
 
+
+// value_use_iterator::getOperandNo - Requires the definition of the User class.
+template<typename UserTy>
+unsigned value_use_iterator<UserTy>::getOperandNo() const {
+  return U - U->getUser()->op_begin();
+}
+
 } // End llvm namespace
 
 #endif