1 //===-- AssemblyAnnotationWriter.h - Annotation .ll files -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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
27 class formatted_raw_ostream;
29 class AssemblyAnnotationWriter {
32 virtual ~AssemblyAnnotationWriter();
34 /// emitFunctionAnnot - This may be implemented to emit a string right before
35 /// the start of a function.
36 virtual void emitFunctionAnnot(const Function *,
37 formatted_raw_ostream &) {}
39 /// emitBasicBlockStartAnnot - This may be implemented to emit a string right
40 /// after the basic block label, but before the first instruction in the
42 virtual void emitBasicBlockStartAnnot(const BasicBlock *,
43 formatted_raw_ostream &) {
46 /// emitBasicBlockEndAnnot - This may be implemented to emit a string right
47 /// after the basic block.
48 virtual void emitBasicBlockEndAnnot(const BasicBlock *,
49 formatted_raw_ostream &) {
52 /// emitInstructionAnnot - This may be implemented to emit a string right
53 /// before an instruction is emitted.
54 virtual void emitInstructionAnnot(const Instruction *,
55 formatted_raw_ostream &) {}
57 /// printInfoComment - This may be implemented to emit a comment to the
58 /// right of an instruction or global value.
59 virtual void printInfoComment(const Value &, formatted_raw_ostream &) {}
62 } // End llvm namespace