include/llvm/Assembly/AsmAnnotationWriter.h

   1 //===-- AsmAnnotationWriter.h - Itf for annotation .ll files - --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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 namespace llvm {
  21
  22 class Function;
  23 class BasicBlock;
  24 class Instruction;
  25 class raw_ostream;
  26 class formatted_raw_ostream;
  27
  28 class AssemblyAnnotationWriter {
  29 public:
  30
  31   virtual ~AssemblyAnnotationWriter();
  32
  33   /// emitFunctionAnnot - This may be implemented to emit a string right before
  34   /// the start of a function.
  35   virtual void emitFunctionAnnot(const Function *F, raw_ostream &OS) {}
  36
  37   /// emitBasicBlockStartAnnot - This may be implemented to emit a string right
  38   /// after the basic block label, but before the first instruction in the block.
  39   virtual void emitBasicBlockStartAnnot(const BasicBlock *BB, raw_ostream &OS){
  40   }
  41
  42   /// emitBasicBlockEndAnnot - This may be implemented to emit a string right
  43   /// after the basic block.
  44   virtual void emitBasicBlockEndAnnot(const BasicBlock *BB, raw_ostream &OS){
  45   }
  46
  47   /// emitInstructionAnnot - This may be implemented to emit a string right
  48   /// before an instruction is emitted.
  49   virtual void emitInstructionAnnot(const Instruction *I, raw_ostream &OS) {}
  50
  51   /// printInfoComment - This may be implemented to emit a comment to the
  52   /// right of an instruction or global value.
  53   virtual void printInfoComment(const Value &V, formatted_raw_ostream &OS) {}
  54 };
  55
  56 } // End llvm namespace
  57
  58 #endif