include/llvm/Value.h

   1 //===-- llvm/Value.h - Definition of the Value class ------------*- C++ -*-===//
   2 //
   3 // This file defines the very important Value class.  This is subclassed by a
   4 // bunch of other important classes, like Instruction, Function, Type, etc...
   5 //
   6 // This file also defines the Use<> template for users of value.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_VALUE_H
  11 #define LLVM_VALUE_H
  12
  13 #include "llvm/AbstractTypeUser.h"
  14 #include "Support/Annotation.h"
  15 #include "Support/Casting.h"
  16 #include <iostream>
  17 #include <vector>
  18
  19 class User;
  20 class Type;
  21 class Constant;
  22 class Argument;
  23 class Instruction;
  24 class BasicBlock;
  25 class GlobalValue;
  26 class Function;
  27 class GlobalVariable;
  28 class SymbolTable;
  29
  30 //===----------------------------------------------------------------------===//
  31 //                                 Value Class
  32 //===----------------------------------------------------------------------===//
  33
  34 /// Value - The base class of all values computed by a program that may be used
  35 /// as operands to other values.
  36 ///
  37 struct Value : public Annotable {         // Values are annotable
  38   enum ValueTy {
  39     TypeVal,                // This is an instance of Type
  40     ConstantVal,            // This is an instance of Constant
  41     ArgumentVal,            // This is an instance of Argument
  42     InstructionVal,         // This is an instance of Instruction
  43     BasicBlockVal,          // This is an instance of BasicBlock
  44     FunctionVal,            // This is an instance of Function
  45     GlobalVariableVal,      // This is an instance of GlobalVariable
  46   };
  47
  48 private:
  49   std::vector<User *> Uses;
  50   std::string Name;
  51   PATypeHolder Ty;
  52   ValueTy VTy;
  53
  54   void operator=(const Value &);     // Do not implement
  55   Value(const Value &);              // Do not implement
  56 public:
  57   Value(const Type *Ty, ValueTy vty, const std::string &name = "");
  58   virtual ~Value();
  59
  60   /// dump - Support for debugging, callable in GDB: V->dump()
  61   //
  62   virtual void dump() const;
  63
  64   /// print - Implement operator<< on Value...
  65   ///
  66   virtual void print(std::ostream &O) const = 0;
  67
  68   /// All values are typed, get the type of this value.
  69   ///
  70   inline const Type *getType() const { return Ty; }
  71
  72   // All values can potentially be named...
  73   inline bool               hasName() const { return Name != ""; }
  74   inline const std::string &getName() const { return Name; }
  75
  76   virtual void setName(const std::string &name, SymbolTable * = 0) {
  77     Name = name;
  78   }
  79
  80   /// getValueType - Return the immediate subclass of this Value.
  81   ///
  82   inline ValueTy getValueType() const { return VTy; }
  83
  84   /// replaceAllUsesWith - Go through the uses list for this definition and make
  85   /// each use point to "V" instead of "this".  After this completes, 'this's
  86   /// use list is guaranteed to be empty.
  87   ///
  88   void replaceAllUsesWith(Value *V);
  89
  90   // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
  91   // Only use when in type resolution situations!
  92   void uncheckedReplaceAllUsesWith(Value *V);
  93
  94   //----------------------------------------------------------------------
  95   // Methods for handling the vector of uses of this Value.
  96   //
  97   typedef std::vector<User*>::iterator       use_iterator;
  98   typedef std::vector<User*>::const_iterator use_const_iterator;
  99
 100   unsigned           use_size()  const { return Uses.size();  }
 101   bool               use_empty() const { return Uses.empty(); }
 102   use_iterator       use_begin()       { return Uses.begin(); }
 103   use_const_iterator use_begin() const { return Uses.begin(); }
 104   use_iterator       use_end()         { return Uses.end();   }
 105   use_const_iterator use_end()   const { return Uses.end();   }
 106   User              *use_back()        { return Uses.back();  }
 107   const User        *use_back()  const { return Uses.back();  }
 108
 109   /// hasOneUse - Return true if there is exactly one user of this value.
 110   ///
 111   bool hasOneUse() const { return use_size() == 1; }
 112
 113   /// addUse/killUse - These two methods should only be used by the Use class
 114   /// below.
 115   void addUse(User *I)      { Uses.push_back(I); }
 116   void killUse(User *I);
 117 };
 118
 119 inline std::ostream &operator<<(std::ostream &OS, const Value *V) {
 120   if (V == 0)
 121     OS << "<null> value!\n";
 122   else
 123     V->print(OS);
 124   return OS;
 125 }
 126
 127 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
 128   V.print(OS);
 129   return OS;
 130 }
 131
 132
 133 //===----------------------------------------------------------------------===//
 134 //                                  Use Class
 135 //===----------------------------------------------------------------------===//
 136
 137 // Use is here to make keeping the "use" list of a Value up-to-date really easy.
 138 //
 139 class Use {
 140   Value *Val;
 141   User *U;
 142 public:
 143   inline Use(Value *v, User *user) {
 144     Val = v; U = user;
 145     if (Val) Val->addUse(U);
 146   }
 147
 148   inline Use(const Use &user) {
 149     Val = 0;
 150     U = user.U;
 151     operator=(user.Val);
 152   }
 153   inline ~Use() { if (Val) Val->killUse(U); }
 154   inline operator Value*() const { return Val; }
 155
 156   inline Value *operator=(Value *V) {
 157     if (Val) Val->killUse(U);
 158     Val = V;
 159     if (V) V->addUse(U);
 160     return V;
 161   }
 162
 163   inline       Value *operator->()       { return Val; }
 164   inline const Value *operator->() const { return Val; }
 165
 166   inline       Value *get()       { return Val; }
 167   inline const Value *get() const { return Val; }
 168
 169   inline const Use &operator=(const Use &user) {
 170     if (Val) Val->killUse(U);
 171     Val = user.Val;
 172     Val->addUse(U);
 173     return *this;
 174   }
 175 };
 176
 177 template<> struct simplify_type<Use> {
 178   typedef Value* SimpleType;
 179
 180   static SimpleType getSimplifiedValue(const Use &Val) {
 181     return (SimpleType)Val.get();
 182   }
 183 };
 184 template<> struct simplify_type<const Use> {
 185   typedef Value* SimpleType;
 186
 187   static SimpleType getSimplifiedValue(const Use &Val) {
 188     return (SimpleType)Val.get();
 189   }
 190 };
 191
 192 // isa - Provide some specializations of isa so that we don't have to include
 193 // the subtype header files to test to see if the value is a subclass...
 194 //
 195 template <> inline bool isa_impl<Type, Value>(const Value &Val) {
 196   return Val.getValueType() == Value::TypeVal;
 197 }
 198 template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
 199   return Val.getValueType() == Value::ConstantVal;
 200 }
 201 template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
 202   return Val.getValueType() == Value::ArgumentVal;
 203 }
 204 template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
 205   return Val.getValueType() == Value::InstructionVal;
 206 }
 207 template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
 208   return Val.getValueType() == Value::BasicBlockVal;
 209 }
 210 template <> inline bool isa_impl<Function, Value>(const Value &Val) {
 211   return Val.getValueType() == Value::FunctionVal;
 212 }
 213 template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
 214   return Val.getValueType() == Value::GlobalVariableVal;
 215 }
 216 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
 217   return isa<GlobalVariable>(Val) || isa<Function>(Val);
 218 }
 219
 220 #endif