-//===-- llvm/BasicBlock.h - Represent a basic block in the VM ----*- C++ -*--=//
-///
-/// \class BasicBlock
-///
-/// This file contains the declaration of the BasicBlock class, which represents
-/// a single basic block in the VM.
-///
-/// Note that basic blocks themselves are Value's, because they are referenced
-/// by instructions like branches and can go in switch tables and stuff...
-///
+//===-- llvm/BasicBlock.h - Represent a basic block in the VM ---*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+//
+// This file contains the declaration of the BasicBlock class, which represents
+// a single basic block in the VM.
+//
+// Note that basic blocks themselves are Value's, because they are referenced
+// by instructions like branches and can go in switch tables and stuff...
+//
///===---------------------------------------------------------------------===//
-///
-/// Note that well formed basic blocks are formed of a list of instructions
-/// followed by a single TerminatorInst instruction. TerminatorInst's may not
-/// occur in the middle of basic blocks, and must terminate the blocks.
-///
-/// This code allows malformed basic blocks to occur, because it may be useful
-/// in the intermediate stage modification to a program.
-///
+//
+// Note that well formed basic blocks are formed of a list of instructions
+// followed by a single TerminatorInst instruction. TerminatorInst's may not
+// occur in the middle of basic blocks, and must terminate the blocks.
+//
+// This code allows malformed basic blocks to occur, because it may be useful
+// in the intermediate stage modification to a program.
+//
//===----------------------------------------------------------------------===//
#ifndef LLVM_BASICBLOCK_H
#include "llvm/Instruction.h"
#include "llvm/SymbolTableListTraits.h"
-#include "Support/ilist"
+#include "llvm/ADT/ilist"
+
+namespace llvm {
class TerminatorInst;
-template <class _Term, class _BB> class SuccIterator; // Successor Iterator
-template <class _Ptr, class _USE_iterator> class PredIterator;
+template <class Term, class BB> class SuccIterator; // Successor Iterator
+template <class Ptr, class USE_iterator> class PredIterator;
template<> struct ilist_traits<Instruction>
: public SymbolTableListTraits<Instruction, BasicBlock, Function> {
- // createNode is used to create a node that marks the end of the list...
- static Instruction *createNode();
+ // createSentinel is used to create a node that marks the end of the list...
+ static Instruction *createSentinel();
+ static void destroySentinel(Instruction *I) { delete I; }
static iplist<Instruction> &getList(BasicBlock *BB);
};
public:
/// Instruction iterators...
- typedef InstListType::iterator iterator;
- typedef InstListType::const_iterator const_iterator;
+ typedef InstListType::iterator iterator;
+ typedef InstListType::const_iterator const_iterator;
typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
typedef std::reverse_iterator<iterator> reverse_iterator;
/// BasicBlock ctor - If the function parameter is specified, the basic block
- /// is automatically inserted at the end of the function.
+ /// is automatically inserted at either the end of the function (if
+ /// InsertBefore is null), or before the specified basic block.
///
- BasicBlock(const std::string &Name = "", Function *Parent = 0);
-
- /// BasicBlock ctor - If the InsertBefore parameter is specified, the basic
- /// block is automatically inserted right before the specified block.
- BasicBlock(const std::string &Name, BasicBlock *InsertBefore);
+ BasicBlock(const std::string &Name = "", Function *Parent = 0,
+ BasicBlock *InsertBefore = 0);
~BasicBlock();
// Specialize setName to take care of symbol table majik
TerminatorInst *getTerminator();
const TerminatorInst *const getTerminator() const;
- // Provide a scoped predecessor and successor iterator
- typedef PredIterator<BasicBlock, Value::use_iterator> pred_iterator;
- typedef PredIterator<const BasicBlock,
- Value::use_const_iterator> pred_const_iterator;
-
- typedef SuccIterator<TerminatorInst*, BasicBlock> succ_iterator;
- typedef SuccIterator<const TerminatorInst*,
- const BasicBlock> succ_const_iterator;
-
-
+ /// removeFromParent - This method unlinks 'this' from the containing
+ /// function, but does not delete it.
+ ///
+ void removeFromParent();
+
+ /// eraseFromParent - This method unlinks 'this' from the containing function
+ /// and deletes it.
+ ///
+ void eraseFromParent();
+
+
+
//===--------------------------------------------------------------------===//
/// Instruction iterator methods
///
inline reverse_iterator rend () { return InstList.rend(); }
inline const_reverse_iterator rend () const { return InstList.rend(); }
- inline unsigned size() const { return InstList.size(); }
+ inline size_t size() const { return InstList.size(); }
inline bool empty() const { return InstList.empty(); }
inline const Instruction &front() const { return InstList.front(); }
inline Instruction &front() { return InstList.front(); }
- inline const Instruction &back() const { return InstList.back(); }
- inline Instruction &back() { return InstList.back(); }
+ inline const Instruction &back() const { return InstList.back(); }
+ inline Instruction &back() { return InstList.back(); }
/// getInstList() - Return the underlying instruction list container. You
/// need to access it directly if you want to modify it currently.
const InstListType &getInstList() const { return InstList; }
InstListType &getInstList() { return InstList; }
- 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;
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const BasicBlock *BB) { return true; }
return V->getValueType() == Value::BasicBlockVal;
}
- /// hasConstantReferences() - This predicate is true if there is a
- /// reference to this basic block in the constant pool for this method. For
- /// example, if a block is reached through a switch table, that table resides
- /// in the constant pool, and the basic block is reference from it.
- ///
- bool hasConstantReferences() const;
-
/// 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
/// cause a degenerate basic block to be formed, having a terminator inside of
/// the basic block).
///
- BasicBlock *splitBasicBlock(iterator I);
+ BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = "");
};
+} // End llvm namespace
+
#endif
projects / oota-llvm.git / blobdiff