Standardize header file comments
[oota-llvm.git] / include / llvm / InstrTypes.h
index 23d60198660af5fe6c309bd3517c5ed9f444d596..4c6f1441e3f7fe42ea73121fda162a26ca5eac3e 100644 (file)
@@ -1,4 +1,4 @@
-//===-- llvm/InstrTypes.h - Important Instruction subclasses -----*- C++ -*--=//
+//===-- llvm/InstrTypes.h - Important Instruction subclasses ----*- C++ -*-===//
 //
 // This file defines various meta classes of instructions that exist in the VM
 // representation.  Specific concrete subclasses of these may be found in the 
 #define LLVM_INSTRUCTION_TYPES_H
 
 #include "llvm/Instruction.h"
-#include <list>
-#include <vector>
-
-class Method;
-class SymTabValue;
 
 //===----------------------------------------------------------------------===//
 //                            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, Instruction *InsertBefore = 0);
+  TerminatorInst(const Type *Ty, Instruction::TermOps iType,
+                 const std::string &Name = "", Instruction *InsertBefore = 0)
+    : Instruction(Ty, iType, Name, InsertBefore) {
+  }
 public:
-  TerminatorInst(unsigned iType);
-  inline ~TerminatorInst() {}
 
-  // Terminators must implement the methods required by Instruction...
+  /// Terminators must implement the methods required by Instruction...
   virtual Instruction *clone() const = 0;
-  virtual void dropAllReferences() = 0;
-  virtual string getOpcode() const = 0;
-
-  virtual bool setOperand(unsigned i, Value *Val) = 0;
-  virtual const Value *getOperand(unsigned i) const = 0;
-  inline Value *getOperand(unsigned i) {
-    return (Value*)((const Instruction *)this)->getOperand(i);
-  }
 
-  // Additionally, they must provide a method to get at the successors of this
-  // terminator instruction.  If 'idx' is out of range, a null pointer shall be
-  // returned.
-  //
+  /// 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
+  virtual void setSuccessor(unsigned idx, BasicBlock *B) = 0;
 
   inline BasicBlock *getSuccessor(unsigned idx) {
     return (BasicBlock*)((const TerminatorInst *)this)->getSuccessor(idx);
   }
-};
 
-
-//===----------------------------------------------------------------------===//
-//                            UnaryOperator Class
-//===----------------------------------------------------------------------===//
-
-class UnaryOperator : public Instruction {
-  Use Source;
-public:
-
-  // getUnaryOperator() - Construct a unary instruction, given the opcode
-  // and its operand.
-  //
-  static UnaryOperator *getUnaryOperator(unsigned Op, Value *Source);
-
-  UnaryOperator(Value *S, unsigned iType, const string &Name = "")
-      : Instruction(S->getType(), iType, Name), Source(S, this) {
+  // Methods for support type inquiry through isa, cast, and dyn_cast:
+  static inline bool classof(const TerminatorInst *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return I->getOpcode() >= TermOpsBegin && I->getOpcode() < TermOpsEnd;
   }
-  inline ~UnaryOperator() { dropAllReferences(); }
-
-  virtual Instruction *clone() const { 
-    return getUnaryOperator(getInstType(), Source);
-  }
-
-  virtual void dropAllReferences() {
-    Source = 0;
-  }
-
-  virtual string getOpcode() const = 0;
-
-  virtual unsigned getNumOperands() const { return 1; }
-  inline Value *getOperand(unsigned i) {
-    return (i == 0) ? Source : 0;
-  }
-  virtual const Value *getOperand(unsigned i) const {
-    return (i == 0) ? Source : 0;
-  }
-  virtual bool setOperand(unsigned i, Value *Val) {
-    // assert(Val && "operand must not be null!");
-    if (i) return false;
-    Source = Val;
-    return true;
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
   }
 };
 
 
-
 //===----------------------------------------------------------------------===//
 //                           BinaryOperator Class
 //===----------------------------------------------------------------------===//
 
 class BinaryOperator : public Instruction {
-  Use Source1, Source2;
-public:
+protected:
+  BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
+                 const std::string &Name, Instruction *InsertBefore);
 
-  // getBinaryOperator() - Construct a binary instruction, given the opcode
-  // and the two operands.
-  //
-  static BinaryOperator *getBinaryOperator(unsigned Op, Value *S1, Value *S2);
+public:
 
-  BinaryOperator(unsigned iType, Value *S1, Value *S2, 
-                 const string &Name = "") 
-    : Instruction(S1->getType(), iType, Name), Source1(S1, this), 
-      Source2(S2, this){
-    assert(S1 && S2 && S1->getType() == S2->getType());
+  /// 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 = "",
+                                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);
+  static       Value*    getNotArgument(      BinaryOperator* Bop);
+
+  BinaryOps getOpcode() const { 
+    return (BinaryOps)Instruction::getOpcode();
   }
-  inline ~BinaryOperator() { dropAllReferences(); }
 
-  virtual Instruction *clone() const { 
-    return getBinaryOperator(getInstType(), Source1, Source2);
+  virtual Instruction *clone() const {
+    return create(getOpcode(), Operands[0], Operands[1]);
   }
 
-  virtual void dropAllReferences() {
-    Source1 = Source2 = 0;
+  /// 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 dependent (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:
+  static inline bool classof(const BinaryOperator *) { return true; }
+  static inline bool classof(const Instruction *I) {
+    return I->getOpcode() >= BinaryOpsBegin && I->getOpcode() < BinaryOpsEnd; 
   }
-
-  virtual string getOpcode() const = 0;
-
-  virtual unsigned getNumOperands() const { return 2; }
-  virtual const Value *getOperand(unsigned i) const {
-    return (i == 0) ? Source1 : ((i == 1) ? Source2 : 0);
-  }
-  inline Value *getOperand(unsigned i) {
-    return (i == 0) ? Source1 : ((i == 1) ? Source2 : 0);
-  }
-
-  virtual bool setOperand(unsigned i, Value *Val) {
-    // assert(Val && "operand must not be null!");
-    if (i == 0) {
-      Source1 = Val; //assert(Val->getType() == Source2->getType());
-    } else if (i == 1) {
-      Source2 = Val; //assert(Val->getType() == Source1->getType());
-    } else {
-      return false;
-    }
-    return true;
+  static inline bool classof(const Value *V) {
+    return isa<Instruction>(V) && classof(cast<Instruction>(V));
   }
 };