llvm-6502/include/llvm/Function.h
Chris Lattner 19b0411c95 Transform uses of Method into uses of Function.
Rename MethodArgument to FunctionArgument
Fix some _really_ out of date comments


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@1986 91177308-0d34-0410-b5e6-96231b3b80d8
2002-03-26 17:48:08 +00:00

105 lines
4.5 KiB
C++

//===-- llvm/Function.h - Class to represent a single VM function -*- C++ -*-=//
//
// This file contains the declaration of the Function class, which represents a
// single function/procedure in the VM.
//
// Note that basic blocks in the method are value's, because they are referenced
// by instructions like calls and can go into virtual function tables and stuff.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_FUNCTION_H
#define LLVM_FUNCTION_H
#include "llvm/SymTabValue.h"
#include "llvm/GlobalValue.h"
#include "llvm/ValueHolder.h"
class MethodType;
class Function : public GlobalValue, public SymTabValue {
public:
typedef ValueHolder<FunctionArgument, Function, Function> ArgumentListType;
typedef ValueHolder<BasicBlock , Function, Function> BasicBlocksType;
// BasicBlock iterators...
typedef BasicBlocksType::iterator iterator;
typedef BasicBlocksType::const_iterator const_iterator;
typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
typedef std::reverse_iterator<iterator> reverse_iterator;
private:
// Important things that make up a method!
BasicBlocksType BasicBlocks; // The basic blocks
ArgumentListType ArgumentList; // The formal arguments
friend class ValueHolder<Function, Module, Module>;
void setParent(Module *parent);
public:
Function(const MethodType *Ty, bool isInternal, const std::string &Name = "");
~Function();
// Specialize setName to handle symbol table majik...
virtual void setName(const std::string &name, SymbolTable *ST = 0);
const Type *getReturnType() const; // Return the return type of method
const MethodType *getMethodType() const; // Return the MethodType for me
// Is the body of this method unknown? (the basic block list is empty if so)
// this is true for external methods, defined as forward "declare"ations
bool isExternal() const { return BasicBlocks.empty(); }
// Get the underlying elements of the Function... both the argument list and
// basic block list are empty for external methods.
//
inline const ArgumentListType &getArgumentList() const{ return ArgumentList; }
inline ArgumentListType &getArgumentList() { return ArgumentList; }
inline const BasicBlocksType &getBasicBlocks() const { return BasicBlocks; }
inline BasicBlocksType &getBasicBlocks() { return BasicBlocks; }
inline const BasicBlock *getEntryNode() const { return front(); }
inline BasicBlock *getEntryNode() { return front(); }
//===--------------------------------------------------------------------===//
// BasicBlock iterator forwarding functions
//
inline iterator begin() { return BasicBlocks.begin(); }
inline const_iterator begin() const { return BasicBlocks.begin(); }
inline iterator end () { return BasicBlocks.end(); }
inline const_iterator end () const { return BasicBlocks.end(); }
inline reverse_iterator rbegin() { return BasicBlocks.rbegin(); }
inline const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
inline reverse_iterator rend () { return BasicBlocks.rend(); }
inline const_reverse_iterator rend () const { return BasicBlocks.rend(); }
inline unsigned size() const { return BasicBlocks.size(); }
inline bool empty() const { return BasicBlocks.empty(); }
inline const BasicBlock *front() const { return BasicBlocks.front(); }
inline BasicBlock *front() { return BasicBlocks.front(); }
inline const BasicBlock *back() const { return BasicBlocks.back(); }
inline BasicBlock *back() { return BasicBlocks.back(); }
// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const Function *) { return true; }
static inline bool classof(const Value *V) {
return V->getValueType() == Value::FunctionVal;
}
// dropAllReferences() - This function causes all the subinstructions to "let
// go" of all references that they are maintaining. 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
// delete.
//
void dropAllReferences();
};
#endif