Fix a typo in the head-of-file comment.

Rewrite the comments about the different versions of BuildMI, to
better emphasize their differences.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@13642 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Brian Gaeke 2004-05-23 05:04:00 +00:00
parent 939290f808
commit 91ad59d75e

View File

@ -10,7 +10,7 @@
// This file exposes a function named BuildMI, which is useful for dramatically // This file exposes a function named BuildMI, which is useful for dramatically
// simplifying how MachineInstr's are created. Instead of using code like this: // simplifying how MachineInstr's are created. Instead of using code like this:
// //
// M = new MachineInstr(X86::ADDrr32); // M = new MachineInstr(X86::ADDrr8);
// M->SetMachineOperandVal(0, MachineOperand::MO_VirtualRegister, argVal1); // M->SetMachineOperandVal(0, MachineOperand::MO_VirtualRegister, argVal1);
// M->SetMachineOperandVal(1, MachineOperand::MO_VirtualRegister, argVal2); // M->SetMachineOperandVal(1, MachineOperand::MO_VirtualRegister, argVal2);
// //
@ -144,9 +144,9 @@ inline MachineInstrBuilder BuildMI(int Opcode, unsigned NumOperands) {
return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true)); return MachineInstrBuilder(new MachineInstr(Opcode, NumOperands, true, true));
} }
/// BuildMI - This version of the builder also sets up the first "operand" as a /// BuildMI - This version of the builder sets up the first operand as a
/// destination virtual register. NumOperands is the number of additional add* /// destination virtual register. NumOperands is the number of additional add*
/// calls that are expected, it does not include the destination register. /// calls that are expected, not including the destination register.
/// ///
inline MachineInstrBuilder BuildMI( inline MachineInstrBuilder BuildMI(
int Opcode, unsigned NumOperands, int Opcode, unsigned NumOperands,
@ -156,9 +156,12 @@ inline MachineInstrBuilder BuildMI(
true, true)).addReg(DestReg, useType); true, true)).addReg(DestReg, useType);
} }
/// BuildMI - This version of the builder inserts the newly-built
/// BuildMI - Insert the instruction before a specified location in the basic /// instruction before the given position in the given MachineBasicBlock, and
/// block. /// sets up the first operand as a destination virtual register.
/// NumOperands is the number of additional add* calls that are expected,
/// not including the destination register.
///
inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB, inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
MachineBasicBlock::iterator I, MachineBasicBlock::iterator I,
int Opcode, unsigned NumOperands, int Opcode, unsigned NumOperands,
@ -168,8 +171,10 @@ inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
return MachineInstrBuilder(MI).addReg(DestReg, MachineOperand::Def); return MachineInstrBuilder(MI).addReg(DestReg, MachineOperand::Def);
} }
/// BMI - A special BuildMI variant that takes an iterator to insert the /// BuildMI - This version of the builder inserts the newly-built
/// instruction at as well as a basic block. /// instruction before the given position in the given MachineBasicBlock, and
/// does NOT take a destination register.
///
inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB, inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
MachineBasicBlock::iterator I, MachineBasicBlock::iterator I,
int Opcode, unsigned NumOperands) { int Opcode, unsigned NumOperands) {
@ -178,18 +183,20 @@ inline MachineInstrBuilder BuildMI(MachineBasicBlock &BB,
return MachineInstrBuilder(MI); return MachineInstrBuilder(MI);
} }
/// BuildMI - This version of the builder inserts the built MachineInstr into /// BuildMI - This version of the builder inserts the newly-built
/// the specified MachineBasicBlock. /// instruction at the end of the given MachineBasicBlock, and does NOT take a
/// destination register.
/// ///
inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode,
unsigned NumOperands) { unsigned NumOperands) {
return BuildMI(*BB, BB->end(), Opcode, NumOperands); return BuildMI(*BB, BB->end(), Opcode, NumOperands);
} }
/// BuildMI - This version of the builder inserts the built MachineInstr into /// BuildMI - This version of the builder inserts the newly-built
/// the specified MachineBasicBlock, and also sets up the first "operand" as a /// instruction at the end of the given MachineBasicBlock, and sets up the first
/// destination virtual register. NumOperands is the number of additional add* /// operand as a destination virtual register. NumOperands is the number of
/// calls that are expected, it does not include the destination register. /// additional add* calls that are expected, not including the destination
/// register.
/// ///
inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode, inline MachineInstrBuilder BuildMI(MachineBasicBlock *BB, int Opcode,
unsigned NumOperands, unsigned DestReg) { unsigned NumOperands, unsigned DestReg) {