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_IR_ASSEMBLYANNOTATIONWRITER_H
18 #define LLVM_IR_ASSEMBLYANNOTATIONWRITER_H
26 class formatted_raw_ostream;
28 class AssemblyAnnotationWriter {
31 virtual ~AssemblyAnnotationWriter();
33 /// emitFunctionAnnot - This may be implemented to emit a string right before
34 /// the start of a function.
35 virtual void emitFunctionAnnot(const Function *,
36 formatted_raw_ostream &) {}
38 /// emitBasicBlockStartAnnot - This may be implemented to emit a string right
39 /// after the basic block label, but before the first instruction in the
41 virtual void emitBasicBlockStartAnnot(const BasicBlock *,
42 formatted_raw_ostream &) {
45 /// emitBasicBlockEndAnnot - This may be implemented to emit a string right
46 /// after the basic block.
47 virtual void emitBasicBlockEndAnnot(const BasicBlock *,
48 formatted_raw_ostream &) {
51 /// emitInstructionAnnot - This may be implemented to emit a string right
52 /// before an instruction is emitted.
53 virtual void emitInstructionAnnot(const Instruction *,
54 formatted_raw_ostream &) {}
56 /// printInfoComment - This may be implemented to emit a comment to the
57 /// right of an instruction or global value.
58 virtual void printInfoComment(const Value &, formatted_raw_ostream &) {}
61 } // End llvm namespace