-//===-- llvm/Value.h - Definition of the Value class -------------*- C++ -*--=//
+//===-- llvm/Value.h - Definition of the Value class ------------*- C++ -*-===//
//
// This file defines the very important Value class. This is subclassed by a
-// bunch of other important classes, like Def, Method, Module, Type, etc...
+// bunch of other important classes, like Instruction, Function, Type, etc...
+//
+// This file also defines the Use<> template for users of value.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_VALUE_H
#define LLVM_VALUE_H
-#include <list>
-#include "llvm/Annotation.h"
#include "llvm/AbstractTypeUser.h"
+#include "Support/Annotation.h"
+#include "Support/Casting.h"
+#include <iostream>
+#include <vector>
class User;
class Type;
-class ConstPoolVal;
-class MethodArgument;
+class Constant;
+class Argument;
class Instruction;
class BasicBlock;
-class Method;
-class Module;
+class GlobalValue;
+class Function;
+class GlobalVariable;
class SymbolTable;
-template<class ValueSubclass, class ItemParentType, class SymTabType>
- class ValueHolder;
//===----------------------------------------------------------------------===//
// Value Class
//===----------------------------------------------------------------------===//
-class Value : public Annotable, // Values are annotable
- public AbstractTypeUser { // Values use potentially abstract types
-public:
+/// Value - The base class of all values computed by a program that may be used
+/// as operands to other values.
+///
+struct Value : public Annotable { // Values are annotable
enum ValueTy {
TypeVal, // This is an instance of Type
- ConstantVal, // This is an instance of ConstPoolVal
- MethodArgumentVal, // This is an instance of MethodArgument
+ ConstantVal, // This is an instance of Constant
+ ArgumentVal, // This is an instance of Argument
InstructionVal, // This is an instance of Instruction
-
BasicBlockVal, // This is an instance of BasicBlock
- MethodVal, // This is an instance of Method
- ModuleVal, // This is an instance of Module
+ FunctionVal, // This is an instance of Function
+ GlobalVariableVal, // This is an instance of GlobalVariable
};
private:
- list<User *> Uses;
- string Name;
- PATypeHandle<Type> Ty;
+ std::vector<User *> Uses;
+ std::string Name;
+ PATypeHolder Ty;
ValueTy VTy;
+ void operator=(const Value &); // Do not implement
Value(const Value &); // Do not implement
-protected:
- inline void setType(const Type *ty) { Ty = ty; }
public:
- Value(const Type *Ty, ValueTy vty, const string &name = "");
+ Value(const Type *Ty, ValueTy vty, const std::string &name = "");
virtual ~Value();
-
+
+ /// dump - Support for debugging, callable in GDB: V->dump()
+ //
+ virtual void dump() const;
+
+ /// 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 != ""; }
- inline const string &getName() const { return Name; }
- virtual void setName(const string &name, SymbolTable * = 0) { Name = name; }
-
- // Methods for determining the subtype of this Value. The getValueType()
- // method returns the type of the value directly. The cast*() methods are
- // equilivent to using dynamic_cast<>... if the cast is successful, this is
- // returned, otherwise you get a null pointer, allowing expressions like this:
- //
- // if (Instruction *I = Val->castInstruction()) { ... }
- //
- // This section also defines a family of isType, isConstant, isMethodArgument,
- // etc functions...
- //
- // The family of functions Val->cast<type>Asserting() is used in the same
- // way as the Val->cast<type>() instructions, but they assert the expected
- // type instead of checking it at runtime.
- //
- inline ValueTy getValueType() const { return VTy; }
+ inline bool hasName() const { return Name != ""; }
+ inline const std::string &getName() const { return Name; }
- // Use a macro to define the functions, otherwise these definitions are just
- // really long and ugly.
-#define CAST_FN(NAME, CLASS) \
- inline bool is##NAME() const { return VTy == NAME##Val; } \
- inline const CLASS *cast##NAME() const { /*const version */ \
- return is##NAME() ? (const CLASS*)this : 0; \
- } \
- inline CLASS *cast##NAME() { /* nonconst version */ \
- return is##NAME() ? (CLASS*)this : 0; \
- } \
- inline const CLASS *cast##NAME##Asserting() const { /*const version */ \
- assert(is##NAME() && "Expected Value Type: " #NAME); \
- return (const CLASS*)this; \
- } \
- inline CLASS *cast##NAME##Asserting() { /* nonconst version */ \
- assert(is##NAME() && "Expected Value Type: " #NAME); \
- return (CLASS*)this; \
- } \
-
- CAST_FN(Constant , ConstPoolVal )
- CAST_FN(MethodArgument, MethodArgument)
- CAST_FN(Instruction , Instruction )
- CAST_FN(BasicBlock , BasicBlock )
- CAST_FN(Method , Method )
- CAST_FN(Module , Module )
-#undef CAST_FN
-
- // Type value is special, because there is no nonconst version of functions!
- inline bool isType() const { return VTy == TypeVal; }
- inline const Type *castType() const {
- return (VTy == TypeVal) ? (const Type*)this : 0;
+ virtual void setName(const std::string &name, SymbolTable * = 0) {
+ Name = name;
}
- inline const Type *castTypeAsserting() const {
- assert(isType() && "Expected Value Type: Type");
- return (const Type*)this;
- }
-
- // replaceAllUsesWith - Go through the uses list for this definition and make
- // each use point to "D" instead of "this". After this completes, 'this's
- // use list should be empty.
- //
- void replaceAllUsesWith(Value *D);
+
+ /// getValueType - Return the immediate subclass of this Value.
+ ///
+ inline ValueTy getValueType() const { return VTy; }
+
+ /// replaceAllUsesWith - Go through the uses list for this definition and make
+ /// each use point to "V" instead of "this". After this completes, 'this's
+ /// use list is guaranteed to be empty.
+ ///
+ void replaceAllUsesWith(Value *V);
- // refineAbstractType - This function is implemented because we use
- // potentially abstract types, and these types may be resolved to more
- // concrete types after we are constructed.
- //
- virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+ // uncheckedReplaceAllUsesWith - Just like replaceAllUsesWith but dangerous.
+ // Only use when in type resolution situations!
+ void uncheckedReplaceAllUsesWith(Value *V);
//----------------------------------------------------------------------
- // Methods for handling the list of uses of this DEF.
+ // Methods for handling the vector of uses of this Value.
//
- typedef list<User*>::iterator use_iterator;
- typedef list<User*>::const_iterator use_const_iterator;
+ typedef std::vector<User*>::iterator use_iterator;
+ typedef std::vector<User*>::const_iterator use_const_iterator;
inline unsigned use_size() const { return Uses.size(); }
inline bool use_empty() const { return Uses.empty(); }
inline use_const_iterator use_begin() const { return Uses.begin(); }
inline use_iterator use_end() { return Uses.end(); }
inline use_const_iterator use_end() const { return Uses.end(); }
+ inline User *use_back() { return Uses.back(); }
+ inline const User *use_back() const { return Uses.back(); }
- inline void use_push_back(User *I) { Uses.push_back(I); }
- User *use_remove(use_iterator &I);
-
+ /// addUse/killUse - These two methods should only be used by the Use class
+ /// below.
inline void addUse(User *I) { Uses.push_back(I); }
void killUse(User *I);
};
-// UseTy and it's friendly typedefs (Use) are here to make keeping the "use"
-// list of a definition node up-to-date really easy.
+inline std::ostream &operator<<(std::ostream &OS, const Value *V) {
+ if (V == 0)
+ OS << "<null> value!\n";
+ else
+ V->print(OS);
+ return OS;
+}
+
+inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
+ V.print(OS);
+ return OS;
+}
+
+
+//===----------------------------------------------------------------------===//
+// Use Class
+//===----------------------------------------------------------------------===//
+
+// Use is here to make keeping the "use" list of a Value up-to-date really easy.
//
-template<class ValueSubclass>
-class UseTy {
- ValueSubclass *Val;
+class Use {
+ Value *Val;
User *U;
public:
- inline UseTy<ValueSubclass>(ValueSubclass *v, User *user) {
+ inline Use(Value *v, User *user) {
Val = v; U = user;
if (Val) Val->addUse(U);
}
- inline ~UseTy<ValueSubclass>() { if (Val) Val->killUse(U); }
-
- inline operator ValueSubclass *() const { return Val; }
-
- inline UseTy<ValueSubclass>(const UseTy<ValueSubclass> &user) {
+ inline Use(const Use &user) {
Val = 0;
U = user.U;
operator=(user.Val);
}
- inline ValueSubclass *operator=(ValueSubclass *V) {
+ inline ~Use() { if (Val) Val->killUse(U); }
+ inline operator Value*() const { return Val; }
+
+ inline Value *operator=(Value *V) {
if (Val) Val->killUse(U);
Val = V;
if (V) V->addUse(U);
return V;
}
- inline ValueSubclass *operator->() { return Val; }
- inline const ValueSubclass *operator->() const { return Val; }
+ inline Value *operator->() { return Val; }
+ inline const Value *operator->() const { return Val; }
+
+ inline Value *get() { return Val; }
+ inline const Value *get() const { return Val; }
- inline UseTy<ValueSubclass> &operator=(const UseTy<ValueSubclass> &user) {
+ inline const Use &operator=(const Use &user) {
if (Val) Val->killUse(U);
Val = user.Val;
Val->addUse(U);
}
};
-typedef UseTy<Value> Use;
+template<> struct simplify_type<Use> {
+ typedef Value* SimpleType;
+
+ static SimpleType getSimplifiedValue(const Use &Val) {
+ return (SimpleType)Val.get();
+ }
+};
+template<> struct simplify_type<const Use> {
+ typedef Value* SimpleType;
+
+ static SimpleType getSimplifiedValue(const Use &Val) {
+ return (SimpleType)Val.get();
+ }
+};
+
+// 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<Type, Value>(const Value &Val) {
+ return Val.getValueType() == Value::TypeVal;
+}
+template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
+ return Val.getValueType() == Value::ConstantVal;
+}
+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) {
+ return Val.getValueType() == Value::InstructionVal;
+}
+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) {
+ return Val.getValueType() == Value::FunctionVal;
+}
+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) {
+ return isa<GlobalVariable>(Val) || isa<Function>(Val);
+}
#endif
projects / oota-llvm.git / blobdiff