#include "llvm/GlobalValue.h"
#include "llvm/BasicBlock.h"
#include "llvm/Argument.h"
+#include "llvm/Support/Annotation.h"
+
+namespace llvm {
class FunctionType;
static iplist<Argument> &getList(Function *F);
};
-class Function : public GlobalValue {
+class Function : public GlobalValue, public Annotable {
public:
typedef iplist<Argument> ArgumentListType;
typedef iplist<BasicBlock> BasicBlockListType;
typedef std::reverse_iterator<aiterator> reverse_aiterator;
private:
-
// Important things that make up a function!
BasicBlockListType BasicBlocks; // The basic blocks
ArgumentListType ArgumentList; // The formal arguments
const Type *getReturnType() const; // Return the type of the ret val
const FunctionType *getFunctionType() const; // Return the FunctionType for me
- /// isExternal - Is the body of this function unknown? (the basic block list
- /// is empty if so) this is true for external functions, defined as forward
+ /// isExternal - Is the body of this function unknown? (The basic block list
+ /// is empty if so.) This is true for external functions, defined as forward
/// "declare"ations
///
virtual bool isExternal() const { return BasicBlocks.empty(); }
/// getIntrinsicID - This method returns the ID number of the specified
- /// function, or LLVMIntrinsic::not_intrinsic if the function is not an
+ /// function, or Intrinsic::not_intrinsic if the function is not an
/// instrinsic, or if the pointer is null. This value is always defined to be
/// zero to allow easy checking for whether a function is intrinsic or not.
/// The particular intrinsic functions which correspond to this value are
unsigned getIntrinsicID() const;
bool isIntrinsic() const { return getIntrinsicID() != 0; }
+ /// renameLocalSymbols - This method goes through the Function's symbol table
+ /// and renames any symbols that conflict with symbols at global scope. This
+ /// is required before printing out to a textual form, to ensure that there is
+ /// no ambiguity when parsing.
+ void renameLocalSymbols();
+
+
/// deleteBody - This method deletes the body of the function, and converts
/// the linkage to external.
+ ///
void deleteBody() {
dropAllReferences();
setLinkage(ExternalLinkage);
}
+ /// removeFromParent - This method unlinks 'this' from the containing module,
+ /// but does not delete it.
+ ///
+ void removeFromParent();
+
+ /// eraseFromParent - This method unlinks 'this' from the containing module
+ /// and deletes it.
+ ///
+ void eraseFromParent();
+
+
// getNext/Prev - Return the next or previous function in the list. These
// methods should never be used directly, and are only used to implement the
// function list as part of the module.
reverse_iterator rend () { return BasicBlocks.rend(); }
const_reverse_iterator rend () const { return BasicBlocks.rend(); }
- unsigned size() const { return BasicBlocks.size(); }
+ size_t size() const { return BasicBlocks.size(); }
bool empty() const { return BasicBlocks.empty(); }
const BasicBlock &front() const { return BasicBlocks.front(); }
BasicBlock &front() { return BasicBlocks.front(); }
- const BasicBlock &back() const { return BasicBlocks.back(); }
- BasicBlock &back() { return BasicBlocks.back(); }
+ const BasicBlock &back() const { return BasicBlocks.back(); }
+ BasicBlock &back() { return BasicBlocks.back(); }
//===--------------------------------------------------------------------===//
// Argument iterator forwarding functions
reverse_aiterator arend () { return ArgumentList.rend(); }
const_reverse_aiterator arend () const { return ArgumentList.rend(); }
- unsigned asize() const { return ArgumentList.size(); }
+ size_t asize() const { return ArgumentList.size(); }
bool aempty() const { return ArgumentList.empty(); }
const Argument &afront() const { return ArgumentList.front(); }
Argument &afront() { return ArgumentList.front(); }
- const Argument &aback() const { return ArgumentList.back(); }
- Argument &aback() { return ArgumentList.back(); }
+ const Argument &aback() const { return ArgumentList.back(); }
+ Argument &aback() { return ArgumentList.back(); }
- virtual void print(std::ostream &OS) const;
+ virtual void print(std::ostream &OS) const { print(OS, 0); }
+ void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
+
+ /// viewCFG - This function is meant for use from the debugger. You can just
+ /// say 'call F->viewCFG()' and a ghostview window should pop up from the
+ /// program, displaying the CFG of the current function with the code for each
+ /// basic block inside. This depends on there being a 'dot' and 'gv' program
+ /// in your path.
+ ///
+ void viewCFG() const;
+
+ /// viewCFGOnly - This function is meant for use from the debugger. It works
+ /// just like viewCFG, but it does not include the contents of basic blocks
+ /// into the nodes, just the label. If you are only interested in the CFG
+ /// this can make the graph smaller.
+ ///
+ void viewCFGOnly() const;
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const Function *) { return true; }
/// go" of all references that they are maintaining. This allows one to
/// 'delete' a whole module 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
+ /// zero. Then everything is deleted for real. Note that no operations are
/// valid on an object that has "dropped all references", except operator
/// delete.
///
void dropAllReferences();
};
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff