include/llvm/Assembly/AsmAnnotationWriter.h

   1 //===-- AsmAnnotationWriter.h - Itf for annotation .ll files - --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Clients of the assembly writer can use this interface to add their own
  11 // special-purpose annotations to LLVM assembly language printouts.  Note that
  12 // the assembly parser won't be able to parse these, in general, so
  13 // implementations are advised to print stuff as LLVM comments.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_ASSEMBLY_ASMANNOTATIONWRITER_H
  18 #define LLVM_ASSEMBLY_ASMANNOTATIONWRITER_H
  19
  20 #include <iosfwd>
  21
  22 namespace llvm {
  23
  24 class Function;
  25 class BasicBlock;
  26 class Instruction;
  27
  28 struct AssemblyAnnotationWriter {
  29
  30   // emitFunctionAnnot - This may be implemented to emit a string right before
  31   // the start of a function.
  32   virtual void emitFunctionAnnot(const Function *F, std::ostream &OS) {}
  33
  34   // emitBasicBlockStartAnnot - This may be implemented to emit a string right
  35   // after the basic block label, but before the first instruction in the block.
  36   virtual void emitBasicBlockStartAnnot(const BasicBlock *BB, std::ostream &OS){
  37   }
  38
  39   // emitBasicBlockEndAnnot - This may be implemented to emit a string right
  40   // after the basic block.
  41   virtual void emitBasicBlockEndAnnot(const BasicBlock *BB, std::ostream &OS){
  42   }
  43
  44   // emitInstructionAnnot - This may be implemented to emit a string right
  45   // before an instruction is emitted.
  46   virtual void emitInstructionAnnot(const Instruction *I, std::ostream &OS) {}
  47 };
  48
  49 } // End llvm namespace
  50
  51 #endif