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 class Function;
  22 class BasicBlock;
  23 class Instruction;
  24
  25 struct AssemblyAnnotationWriter {
  26
  27   // emitFunctionAnnot - This may be implemented to emit a string right before
  28   // the start of a function.
  29   virtual void emitFunctionAnnot(const Function *F, std::ostream &OS) {}
  30
  31   // emitBasicBlockAnnot - This may be implemented to emit a string right after
  32   // the basic block label, but before the first instruction in the block.
  33   virtual void emitBasicBlockAnnot(const BasicBlock *BB, std::ostream &OS) {}
  34
  35   // emitInstructionAnnot - This may be implemented to emit a string right
  36   // before an instruction is emitted.
  37   virtual void emitInstructionAnnot(const Instruction *I, std::ostream &OS) {}
  38 };
  39
  40 #endif