Add a new BasicBlockPass::doInitialization/Finalization(Function &) pair of

[oota-llvm.git] / include / llvm / InstrTypes.h

diff --git a/include/llvm/InstrTypes.h b/include/llvm/InstrTypes.h
index ccce21a83986b8b32828a3ee120b317dfca9df6c..fc1917b10be2b14f8a20c887af88b5b7687797ae 100644 (file)
--- a/include/llvm/InstrTypes.h
+++ b/include/llvm/InstrTypes.h
@@ -15,27 +15,29 @@
 //                            TerminatorInst Class
 //===----------------------------------------------------------------------===//
 
-// TerminatorInst - Subclasses of this class are all able to terminate a basic 
-// block.  Thus, these are all the flow control type of operations.
-//
+/// TerminatorInst - Subclasses of this class are all able to terminate a basic 
+/// block.  Thus, these are all the flow control type of operations.
+///
 class TerminatorInst : public Instruction {
 protected:
-  TerminatorInst(Instruction::TermOps iType);
+  TerminatorInst(Instruction::TermOps iType, Instruction *InsertBefore = 0);
   TerminatorInst(const Type *Ty, Instruction::TermOps iType,
-                 const std::string &Name = "");
+                 const std::string &Name = "", Instruction *InsertBefore = 0)
+    : Instruction(Ty, iType, Name, InsertBefore) {
+  }
 public:
 
-  // Terminators must implement the methods required by Instruction...
+  /// Terminators must implement the methods required by Instruction...
   virtual Instruction *clone() const = 0;
 
-  // Additionally, they must provide a method to get at the successors of this
-  // terminator instruction.  'idx' may not be >= the number of successors
-  // returned by getNumSuccessors()!
-  //
+  /// Additionally, they must provide a method to get at the successors of this
+  /// terminator instruction.  'idx' may not be >= the number of successors
+  /// returned by getNumSuccessors()!
+  ///
   virtual const BasicBlock *getSuccessor(unsigned idx) const = 0;
   virtual unsigned getNumSuccessors() const = 0;
   
-  // Set a successor at a given index
+  /// Set a successor at a given index
   virtual void setSuccessor(unsigned idx, BasicBlock *B) = 0;
 
   inline BasicBlock *getSuccessor(unsigned idx) {
@@ -59,41 +61,40 @@ public:
 
 class BinaryOperator : public Instruction {
 protected:
-  BinaryOperator(BinaryOps iType, Value *S1, Value *S2, 
-                 const std::string &Name = "") 
-    : Instruction(S1->getType(), iType, Name) {
-    Operands.reserve(2);
-    Operands.push_back(Use(S1, this));
-    Operands.push_back(Use(S2, this));
-    assert(Operands[0] && Operands[1] && 
-          Operands[0]->getType() == Operands[1]->getType());
-  }
+  BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
+                 const std::string &Name, Instruction *InsertBefore);
 
 public:
 
-  // create() - Construct a binary instruction, given the opcode
-  // and the two operands.
-  //
+  /// create() - Construct a binary instruction, given the opcode and the two
+  /// operands.  Optionally (if InstBefore is specified) insert the instruction
+  /// into a BasicBlock right before the specified instruction.  The specified
+  /// Instruction is allowed to be a dereferenced end iterator.
+  ///
   static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
-                               const std::string &Name = "");
-
-  // Helper functions to construct and inspect unary operations (NEG and NOT)
-  // via binary operators SUB and XOR:
-  // 
-  // createNeg, createNot - Create the NEG and NOT
-  //     instructions out of SUB and XOR instructions.
-  //
-  // isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
-  //
-  // getNegArgument, getNotArgument - Helper functions to extract the
-  //     unary argument of a NEG or NOT operation implemented via Sub or Xor.
-  // 
-  static BinaryOperator *createNeg(Value *Op, const std::string &Name = "");
-  static BinaryOperator *createNot(Value *Op, const std::string &Name = "");
-
+                               const std::string &Name = "",
+                                Instruction *InsertBefore = 0);
+                               
+
+  /// Helper functions to construct and inspect unary operations (NEG and NOT)
+  /// via binary operators SUB and XOR:
+  /// 
+  /// createNeg, createNot - Create the NEG and NOT
+  ///     instructions out of SUB and XOR instructions.
+  ///
+  static BinaryOperator *createNeg(Value *Op, const std::string &Name = "",
+                                   Instruction *InsertBefore = 0);
+  static BinaryOperator *createNot(Value *Op, const std::string &Name = "",
+                                   Instruction *InsertBefore = 0);
+
+  /// isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
+  ///
   static bool            isNeg(const Value *V);
   static bool            isNot(const Value *V);
 
+  /// getNegArgument, getNotArgument - Helper functions to extract the
+  ///     unary argument of a NEG or NOT operation implemented via Sub or Xor.
+  /// 
   static const Value*    getNegArgument(const BinaryOperator* Bop);
   static       Value*    getNegArgument(      BinaryOperator* Bop);
   static const Value*    getNotArgument(const BinaryOperator* Bop);
@@ -107,13 +108,13 @@ public:
     return create(getOpcode(), Operands[0], Operands[1]);
   }
 
-  // swapOperands - Exchange the two operands to this instruction.
-  // This instruction is safe to use on any binary instruction and
-  // does not modify the semantics of the instruction.  If the
-  // instruction is order dependant (SetLT f.e.) the opcode is
-  // changed.  If the instruction cannot be reversed (ie, it's a Div),
-  // then return true.
-  //
+  /// swapOperands - Exchange the two operands to this instruction.
+  /// This instruction is safe to use on any binary instruction and
+  /// does not modify the semantics of the instruction.  If the
+  /// instruction is order dependant (SetLT f.e.) the opcode is
+  /// changed.  If the instruction cannot be reversed (ie, it's a Div),
+  /// then return true.
+  ///
   bool swapOperands();
 
   // Methods for support type inquiry through isa, cast, and dyn_cast: