remove a dead enum value, making a comment above correct again
[oota-llvm.git] / include / llvm / Value.h
index 884b265dc1615604da1057d1257ebce0fcdc6b6f..91c8cbc0689b55434b1b81b98978e4cf46ff6f81 100644 (file)
@@ -1,10 +1,10 @@
 //===-- llvm/Value.h - Definition of the Value class ------------*- 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 file defines the very important Value class.  This is subclassed by a
@@ -27,7 +27,7 @@ namespace llvm {
 class Constant;
 class Argument;
 class Instruction;
-struct BasicBlock;
+class BasicBlock;
 class GlobalValue;
 class Function;
 class GlobalVariable;
@@ -41,10 +41,17 @@ class SymbolTable;
 /// as operands to other values.
 ///
 class Value {
+  unsigned short SubclassID;         // Subclass identifier (for isa/dyn_cast)
+protected:
+  /// SubclassData - This member is defined by this class, but is not used for
+  /// anything.  Subclasses can use it to hold whatever state they find useful.
+  /// This field is initialized to zero by the ctor.
+  unsigned short SubclassData;
 private:
-  unsigned SubclassID;               // Subclass identifier (for isa/dyn_cast)
   PATypeHolder Ty;
-  iplist<Use> Uses;
+  Use *UseList;
+
+  friend class SymbolTable;    // Allow SymbolTable to directly poke Name.
   std::string Name;
 
   void operator=(const Value &);     // Do not implement
@@ -53,7 +60,7 @@ private:
 public:
   Value(const Type *Ty, unsigned scid, const std::string &name = "");
   virtual ~Value();
-  
+
   /// dump - Support for debugging, callable in GDB: V->dump()
   //
   virtual void dump() const;
@@ -61,21 +68,19 @@ public:
   /// print - Implement operator<< on Value...
   ///
   virtual void print(std::ostream &O) const = 0;
-  
+
   /// All values are typed, get the type of this value.
   ///
   inline const Type *getType() const { return Ty; }
-  
+
   // All values can potentially be named...
   inline bool               hasName() const { return !Name.empty(); }
   inline const std::string &getName() const { return Name; }
 
-  virtual void setName(const std::string &name, SymbolTable * = 0) {
-    Name = name;
-  }
-  
+  void setName(const std::string &name);
+
   /// replaceAllUsesWith - Go through the uses list for this definition and make
-  /// each use point to "V" instead of "this".  After this completes, 'this's 
+  /// each use point to "V" instead of "this".  After this completes, 'this's
   /// use list is guaranteed to be empty.
   ///
   void replaceAllUsesWith(Value *V);
@@ -87,32 +92,44 @@ public:
   //----------------------------------------------------------------------
   // Methods for handling the vector of uses of this Value.
   //
-  typedef UseListIteratorWrapper      use_iterator;
-  typedef UseListConstIteratorWrapper use_const_iterator;
-
-  unsigned           use_size()  const { return Uses.size();  }
-  bool               use_empty() const { return Uses.empty(); }
-  use_iterator       use_begin()       { return Uses.begin(); }
-  use_const_iterator use_begin() const { return Uses.begin(); }
-  use_iterator       use_end()         { return Uses.end();   }
-  use_const_iterator use_end()   const { return Uses.end();   }
-  User             *use_back()         { return Uses.back().getUser(); }
-  const User       *use_back()  const  { return Uses.back().getUser(); }
+  typedef value_use_iterator<User>       use_iterator;
+  typedef value_use_iterator<const User> use_const_iterator;
+
+  bool               use_empty() const { return UseList == 0; }
+  use_iterator       use_begin()       { return use_iterator(UseList); }
+  use_const_iterator use_begin() const { return use_const_iterator(UseList); }
+  use_iterator       use_end()         { return use_iterator(0);   }
+  use_const_iterator use_end()   const { return use_const_iterator(0);   }
+  User              *use_back()        { return *use_begin(); }
+  const User        *use_back() const  { return *use_begin(); }
 
   /// hasOneUse - Return true if there is exactly one user of this value.  This
   /// is specialized because it is a common request and does not require
   /// traversing the whole use list.
   ///
   bool hasOneUse() const {
-    iplist<Use>::const_iterator I = Uses.begin(), E = Uses.end();
+    use_const_iterator I = use_begin(), E = use_end();
     if (I == E) return false;
     return ++I == E;
   }
 
+  /// hasNUses - Return true if this Value has exactly N users.
+  ///
+  bool hasNUses(unsigned N) const;
+
+  /// hasNUsesOrMore - Return true if this value has N users or more.  This is
+  /// logically equivalent to getNumUses() >= N.
+  ///
+  bool hasNUsesOrMore(unsigned N) const;
+
+  /// getNumUses - This method computes the number of uses of this Value.  This
+  /// is a linear time operation.  Use hasOneUse, hasNUses, or hasMoreThanNUses
+  /// to check for specific values.
+  unsigned getNumUses() const;
+
   /// addUse/killUse - These two methods should only be used by the Use class.
   ///
-  void addUse(Use &U)  { Uses.push_back(&U); }
-  void killUse(Use &U) { Uses.remove(&U); }
+  void addUse(Use &U) { U.addToList(&UseList); }
 
   /// getValueType - Return an ID for the concrete type of this object.  This is
   /// used to implement the classof checks.  This should not be used for any
@@ -131,7 +148,6 @@ public:
     ConstantAggregateZeroVal, // This is an instance of ConstantAggregateNull
     SimpleConstantVal,        // This is some other type of Constant
     InstructionVal,           // This is an instance of Instruction
-    ValueListVal              // This is for bcreader, a special ValTy
   };
   unsigned getValueType() const {
     return SubclassID;
@@ -157,30 +173,18 @@ inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
   return OS;
 }
 
-
-inline User *UseListIteratorWrapper::operator*() const {
-  return Super::operator*().getUser();
-}
-
-inline const User *UseListConstIteratorWrapper::operator*() const {
-  return Super::operator*().getUser();
-}
-
-
-Use::Use(Value *v, User *user) : Val(v), U(user) {
-  if (Val) Val->addUse(*this);
-}
-
-Use::Use(const Use &u) : Val(u.Val), U(u.U) {
+void Use::init(Value *v, User *user) {
+  Val = v;
+  U = user;
   if (Val) Val->addUse(*this);
 }
 
 Use::~Use() {
-  if (Val) Val->killUse(*this);
+  if (Val) removeFromList();
 }
 
-void Use::set(Value *V) { 
-  if (Val) Val->killUse(*this);
+void Use::set(Value *V) {
+  if (Val) removeFromList();
   Val = V;
   if (V) V->addUse(*this);
 }
@@ -189,30 +193,30 @@ void Use::set(Value *V) {
 // isa - Provide some specializations of isa so that we don't have to include
 // the subtype header files to test to see if the value is a subclass...
 //
-template <> inline bool isa_impl<Constant, Value>(const Value &Val) { 
+template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
   return Val.getValueType() == Value::SimpleConstantVal ||
          Val.getValueType() == Value::FunctionVal ||
-        Val.getValueType() == Value::GlobalVariableVal ||
+         Val.getValueType() == Value::GlobalVariableVal ||
          Val.getValueType() == Value::ConstantExprVal ||
          Val.getValueType() == Value::ConstantAggregateZeroVal ||
          Val.getValueType() == Value::UndefValueVal;
 }
-template <> inline bool isa_impl<Argument, Value>(const Value &Val) { 
+template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
   return Val.getValueType() == Value::ArgumentVal;
 }
-template <> inline bool isa_impl<Instruction, Value>(const Value &Val) { 
+template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
   return Val.getValueType() >= Value::InstructionVal;
 }
-template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) { 
+template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
   return Val.getValueType() == Value::BasicBlockVal;
 }
-template <> inline bool isa_impl<Function, Value>(const Value &Val) { 
+template <> inline bool isa_impl<Function, Value>(const Value &Val) {
   return Val.getValueType() == Value::FunctionVal;
 }
-template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) { 
+template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
   return Val.getValueType() == Value::GlobalVariableVal;
 }
-template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) { 
+template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
   return isa<GlobalVariable>(Val) || isa<Function>(Val);
 }