1 //===-- AsmAnnotationWriter.h - Itf for annotation .ll files - --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_ASSEMBLY_ASMANNOTATIONWRITER_H
18 #define LLVM_ASSEMBLY_ASMANNOTATIONWRITER_H
28 struct AssemblyAnnotationWriter {
30 virtual ~AssemblyAnnotationWriter();
32 // emitFunctionAnnot - This may be implemented to emit a string right before
33 // the start of a function.
34 virtual void emitFunctionAnnot(const Function *F, std::ostream &OS) {}
36 // emitBasicBlockStartAnnot - This may be implemented to emit a string right
37 // after the basic block label, but before the first instruction in the block.
38 virtual void emitBasicBlockStartAnnot(const BasicBlock *BB, std::ostream &OS){
41 // emitBasicBlockEndAnnot - This may be implemented to emit a string right
42 // after the basic block.
43 virtual void emitBasicBlockEndAnnot(const BasicBlock *BB, std::ostream &OS){
46 // emitInstructionAnnot - This may be implemented to emit a string right
47 // before an instruction is emitted.
48 virtual void emitInstructionAnnot(const Instruction *I, std::ostream &OS) {}
51 } // End llvm namespace