Remove unneeded #include
[oota-llvm.git] / include / llvm / BasicBlock.h
index 1a996bcf265ee597fed78f06f9b672eafdf10401..0e12cab223a9b9df6b6eb377f4deaa575a171e91 100644 (file)
@@ -6,24 +6,23 @@
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
 // 
 //===----------------------------------------------------------------------===//
-///
-/// \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...
-///
+//
+//
+// 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
@@ -33,6 +32,8 @@
 #include "llvm/SymbolTableListTraits.h"
 #include "Support/ilist"
 
+namespace llvm {
+
 class TerminatorInst;
 template <class _Term, class _BB> class SuccIterator;  // Successor Iterator
 template <class _Ptr, class _USE_iterator> class PredIterator;
@@ -66,13 +67,14 @@ public:
   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
@@ -131,13 +133,6 @@ public:
     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
@@ -171,4 +166,6 @@ public:
   BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = "");
 };
 
+} // End llvm namespace
+
 #endif