mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-22 18:54:02 +01:00
ae65e281f3
to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. llvm-svn: 351636
62 lines
2.2 KiB
C++
62 lines
2.2 KiB
C++
//===-- AssemblyAnnotationWriter.h - Annotation .ll files -------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Clients of the assembly writer can use this interface to add their own
|
|
// special-purpose annotations to LLVM assembly language printouts. Note that
|
|
// the assembly parser won't be able to parse these, in general, so
|
|
// implementations are advised to print stuff as LLVM comments.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_IR_ASSEMBLYANNOTATIONWRITER_H
|
|
#define LLVM_IR_ASSEMBLYANNOTATIONWRITER_H
|
|
|
|
namespace llvm {
|
|
|
|
class Function;
|
|
class BasicBlock;
|
|
class Instruction;
|
|
class Value;
|
|
class formatted_raw_ostream;
|
|
|
|
class AssemblyAnnotationWriter {
|
|
public:
|
|
virtual ~AssemblyAnnotationWriter();
|
|
|
|
/// emitFunctionAnnot - This may be implemented to emit a string right before
|
|
/// the start of a function.
|
|
virtual void emitFunctionAnnot(const Function *,
|
|
formatted_raw_ostream &) {}
|
|
|
|
/// emitBasicBlockStartAnnot - This may be implemented to emit a string right
|
|
/// after the basic block label, but before the first instruction in the
|
|
/// block.
|
|
virtual void emitBasicBlockStartAnnot(const BasicBlock *,
|
|
formatted_raw_ostream &) {
|
|
}
|
|
|
|
/// emitBasicBlockEndAnnot - This may be implemented to emit a string right
|
|
/// after the basic block.
|
|
virtual void emitBasicBlockEndAnnot(const BasicBlock *,
|
|
formatted_raw_ostream &) {
|
|
}
|
|
|
|
/// emitInstructionAnnot - This may be implemented to emit a string right
|
|
/// before an instruction is emitted.
|
|
virtual void emitInstructionAnnot(const Instruction *,
|
|
formatted_raw_ostream &) {}
|
|
|
|
/// printInfoComment - This may be implemented to emit a comment to the
|
|
/// right of an instruction or global value.
|
|
virtual void printInfoComment(const Value &, formatted_raw_ostream &) {}
|
|
};
|
|
|
|
} // End llvm namespace
|
|
|
|
#endif
|