diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index 5cfd0ea56c7..8c678a30c06 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -808,7 +808,22 @@ into an existing sequence of instructions that form a BasicBlock:

BasicBlock, and a newly-created instruction we wish to insert before *pi, we do the following:

- 
  BasicBlock *pb = ...;
  Instruction *pi = ...;
  Instruction *newInst = new Instruction(...);
  pb->getInstList().insert(pi, newInst); // inserts newInst before pi in pb
+ 
  BasicBlock *pb = ...;
  Instruction *pi = ...;
  Instruction *newInst = new Instruction(...);
  pb->getInstList().insert(pi, newInst); // inserts newInst before pi in pb
+ +

Appending to the end of a BasicBlock is so common that + the Instruction class and Instruction-derived + classes provide constructors which take a pointer to a + BasicBlock to be appended to. For example code that + looked like:

+ + 
  BasicBlock *pb = ...;
  Instruction *newInst = new Instruction(...);
  pb->getInstList().push_back(newInst); // appends newInst to pb
+ +

becomes:

+ + 
  BasicBlock *pb = ...;
  Instruction *newInst = new Instruction(..., pb);
+ +

which is much cleaner, especially if you are creating + long instruction streams.

  • Insertion into an implicit instruction list