//===-- 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.
//
-// This file also defines the isa<X>(), cast<X>(), and dyn_cast<X>() templates.
-//
//===----------------------------------------------------------------------===//
#ifndef LLVM_VALUE_H
#define LLVM_VALUE_H
-#include <vector>
#include "llvm/Annotation.h"
#include "llvm/AbstractTypeUser.h"
+#include "Support/Casting.h"
+#include <iostream>
+#include <vector>
class User;
class Type;
class Constant;
-class MethodArgument;
+class Argument;
class Instruction;
class BasicBlock;
class GlobalValue;
-class Method;
+class Function;
class GlobalVariable;
-class Module;
class SymbolTable;
-template<class ValueSubclass, class ItemParentType, class SymTabType>
- class ValueHolder;
//===----------------------------------------------------------------------===//
// Value Class
//===----------------------------------------------------------------------===//
+/// Value - The base class of all values computed by a program that may be used
+/// as operands to other values.
+///
class Value : public Annotable, // Values are annotable
public AbstractTypeUser { // Values use potentially abstract types
public:
enum ValueTy {
TypeVal, // This is an instance of Type
ConstantVal, // This is an instance of Constant
- MethodArgumentVal, // This is an instance of MethodArgument
+ 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
+ FunctionVal, // This is an instance of Function
GlobalVariableVal, // This is an instance of GlobalVariable
- ModuleVal, // This is an instance of Module
};
private:
PATypeHandle<Type> 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 std::string &name = "");
virtual ~Value();
- // Support for debugging
+ /// dump - Support for debugging, callable in GDB: V->dump()
+ //
void dump() const;
+
+ /// print - Implement operator<< on Value...
+ ///
+ virtual void print(std::ostream &O) const = 0;
- // All values can potentially be typed
+ /// All values are typed, get the type of this value.
+ ///
inline const Type *getType() const { return Ty; }
// All values can potentially be named...
Name = name;
}
- // Methods for determining the subtype of this Value. The getValueType()
- // method returns the type of the value directly. The cast*() methods are
- // equivalent to using dynamic_cast<>... if the cast is successful, this is
- // returned, otherwise you get a null pointer.
- //
- // 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.
- //
+ /// 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 "D" instead of "this". After this completes, 'this's
- // use list should be empty.
- //
- void replaceAllUsesWith(Value *D);
-
- // 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.
- //
+ /// 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);
//----------------------------------------------------------------------
void killUse(User *I);
};
+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;
+}
+
//===----------------------------------------------------------------------===//
// UseTy Class
typedef UseTy<Value> Use; // Provide Use as a common UseTy type
-// real_type - Provide a macro to get the real type of a value that might be
-// a use. This provides a typedef 'Type' that is the argument type for all
-// non UseTy types, and is the contained pointer type of the use if it is a
-// UseTy.
-//
-template <class X> class real_type { typedef X Type; };
-template <class X> class real_type <class UseTy<X> > { typedef X *Type; };
-
-//===----------------------------------------------------------------------===//
-// Type Checking Templates
-//===----------------------------------------------------------------------===//
-
-// isa<X> - Return true if the parameter to the template is an instance of the
-// template type argument. Used like this:
-//
-// if (isa<Type>(myVal)) { ... }
-//
-template <class X, class Y>
-inline bool isa(Y Val) {
- assert(Val && "isa<Ty>(NULL) invoked!");
- return X::classof(Val);
-}
-
-
-// cast<X> - Return the argument parameter cast to the specified type. This
-// casting operator asserts that the type is correct, so it does not return null
-// on failure. But it will correctly return NULL when the input is NULL.
-// Used Like this:
-//
-// cast< Instruction>(myVal)->getParent()
-// cast<const Instruction>(myVal)->getParent()
-//
-template <class X, class Y>
-inline X *cast(Y Val) {
- assert(isa<X>(Val) && "cast<Ty>() argument of uncompatible type!");
- return (X*)(real_type<Y>::Type)Val;
-}
-
-// cast_or_null<X> - Functionally identical to cast, except that a null value is
-// accepted.
-//
-template <class X, class Y>
-inline X *cast_or_null(Y Val) {
- assert((Val == 0 || isa<X>(Val)) &&
- "cast_or_null<Ty>() argument of uncompatible type!");
- return (X*)(real_type<Y>::Type)Val;
-}
-
-
-// dyn_cast<X> - Return the argument parameter cast to the specified type. This
-// casting operator returns null if the argument is of the wrong type, so it can
-// be used to test for a type as well as cast if successful. This should be
-// used in the context of an if statement like this:
-//
-// if (const Instruction *I = dyn_cast<const Instruction>(myVal)) { ... }
-//
-
-template <class X, class Y>
-inline X *dyn_cast(Y Val) {
- return isa<X>(Val) ? cast<X>(Val) : 0;
-}
-
-// dyn_cast_or_null<X> - Functionally identical to dyn_cast, except that a null
-// value is accepted.
-//
-template <class X, class Y>
-inline X *dyn_cast_or_null(Y Val) {
- return (Val && isa<X>(Val)) ? cast<X>(Val) : 0;
-}
-
+template<typename From> struct simplify_type<UseTy<From> > {
+ typedef typename simplify_type<From*>::SimpleType SimpleType;
+
+ static SimpleType getSimplifiedValue(const UseTy<From> &Val) {
+ return (SimpleType)Val.get();
+ }
+};
+template<typename From> struct simplify_type<const UseTy<From> > {
+ typedef typename simplify_type<From*>::SimpleType SimpleType;
+
+ static SimpleType getSimplifiedValue(const UseTy<From> &Val) {
+ return (SimpleType)Val.get();
+ }
+};
-// isa - Provide some specializations of isa so that we have to include the
-// subtype header files to test to see if the value is a subclass...
+// 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<Type, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::TypeVal;
-}
-template <> inline bool isa<Type, Value*>(Value *Val) {
- return Val->getValueType() == Value::TypeVal;
-}
-template <> inline bool isa<Constant, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::ConstantVal;
-}
-template <> inline bool isa<Constant, Value*>(Value *Val) {
- return Val->getValueType() == Value::ConstantVal;
-}
-template <> inline bool isa<MethodArgument, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::MethodArgumentVal;
-}
-template <> inline bool isa<MethodArgument, Value*>(Value *Val) {
- return Val->getValueType() == Value::MethodArgumentVal;
-}
-template <> inline bool isa<Instruction, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::InstructionVal;
-}
-template <> inline bool isa<Instruction, Value*>(Value *Val) {
- return Val->getValueType() == Value::InstructionVal;
-}
-template <> inline bool isa<BasicBlock, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::BasicBlockVal;
-}
-template <> inline bool isa<BasicBlock, Value*>(Value *Val) {
- return Val->getValueType() == Value::BasicBlockVal;
-}
-template <> inline bool isa<Method, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::MethodVal;
+template <> inline bool isa_impl<Type, Value>(const Value &Val) {
+ return Val.getValueType() == Value::TypeVal;
}
-template <> inline bool isa<Method, Value*>(Value *Val) {
- return Val->getValueType() == Value::MethodVal;
+template <> inline bool isa_impl<Constant, Value>(const Value &Val) {
+ return Val.getValueType() == Value::ConstantVal;
}
-template <> inline bool isa<GlobalVariable, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::GlobalVariableVal;
+template <> inline bool isa_impl<Argument, Value>(const Value &Val) {
+ return Val.getValueType() == Value::ArgumentVal;
}
-template <> inline bool isa<GlobalVariable, Value*>(Value *Val) {
- return Val->getValueType() == Value::GlobalVariableVal;
+template <> inline bool isa_impl<Instruction, Value>(const Value &Val) {
+ return Val.getValueType() == Value::InstructionVal;
}
-template <> inline bool isa<GlobalValue, const Value*>(const Value *Val) {
- return isa<GlobalVariable>(Val) || isa<Method>(Val);
+template <> inline bool isa_impl<BasicBlock, Value>(const Value &Val) {
+ return Val.getValueType() == Value::BasicBlockVal;
}
-template <> inline bool isa<GlobalValue, Value*>(Value *Val) {
- return isa<GlobalVariable>(Val) || isa<Method>(Val);
+template <> inline bool isa_impl<Function, Value>(const Value &Val) {
+ return Val.getValueType() == Value::FunctionVal;
}
-template <> inline bool isa<Module, const Value*>(const Value *Val) {
- return Val->getValueType() == Value::ModuleVal;
+template <> inline bool isa_impl<GlobalVariable, Value>(const Value &Val) {
+ return Val.getValueType() == Value::GlobalVariableVal;
}
-template <> inline bool isa<Module, Value*>(Value *Val) {
- return Val->getValueType() == Value::ModuleVal;
+template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
+ return isa<GlobalVariable>(Val) || isa<Function>(Val);
}
#endif