1//===-- AssemblyAnnotationWriter.h - Annotation .ll files -------*- C++ -*-===//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//===----------------------------------------------------------------------===//
9// Clients of the assembly writer can use this interface to add their own
10// special-purpose annotations to LLVM assembly language printouts. Note that
11// the assembly parser won't be able to parse these, in general, so
12// implementations are advised to print stuff as LLVM comments.
14//===----------------------------------------------------------------------===//
16#ifndef LLVM_IR_ASSEMBLYANNOTATIONWRITER_H
17#define LLVM_IR_ASSEMBLYANNOTATIONWRITER_H
33 /// emitFunctionAnnot - This may be implemented to emit a string right before
34 /// the start of a function.
38 /// emitBasicBlockStartAnnot - This may be implemented to emit a string right
39 /// after the basic block label, but before the first instruction in the
45 /// emitBasicBlockEndAnnot - This may be implemented to emit a string right
46 /// after the basic block.
51 /// emitInstructionAnnot - This may be implemented to emit a string right
52 /// before an instruction is emitted.
56 /// printInfoComment - This may be implemented to emit a comment to the
57 /// right of an instruction or global value.
61}
// End llvm namespace
virtual void emitBasicBlockStartAnnot(const BasicBlock *, formatted_raw_ostream &)
emitBasicBlockStartAnnot - This may be implemented to emit a string right after the basic block label...
virtual void emitBasicBlockEndAnnot(const BasicBlock *, formatted_raw_ostream &)
emitBasicBlockEndAnnot - This may be implemented to emit a string right after the basic block.
virtual void emitFunctionAnnot(const Function *, formatted_raw_ostream &)
emitFunctionAnnot - This may be implemented to emit a string right before the start of a function.
virtual void emitInstructionAnnot(const Instruction *, formatted_raw_ostream &)
emitInstructionAnnot - This may be implemented to emit a string right before an instruction is emitte...
virtual void printInfoComment(const Value &, formatted_raw_ostream &)
printInfoComment - This may be implemented to emit a comment to the right of an instruction or global...
virtual ~AssemblyAnnotationWriter()
LLVM Basic Block Representation.
LLVM Value Representation.
This is an optimization pass for GlobalISel generic memory operations.