2010-09-02 23:09:42 +00:00
|
|
|
//===-- AssemblyAnnotationWriter.h - Annotation .ll files -------*- C++ -*-===//
|
2005-04-21 20:19:05 +00:00
|
|
|
//
|
2003-10-30 23:39:52 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 19:59:42 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-21 20:19:05 +00:00
|
|
|
//
|
2003-10-30 23:39:52 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// 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_ASSEMBLY_ASMANNOTATIONWRITER_H
|
|
|
|
#define LLVM_ASSEMBLY_ASMANNOTATIONWRITER_H
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
namespace llvm {
|
|
|
|
|
2003-10-30 23:39:52 +00:00
|
|
|
class Function;
|
|
|
|
class BasicBlock;
|
|
|
|
class Instruction;
|
2011-11-14 17:45:03 +00:00
|
|
|
class Value;
|
2010-02-10 20:41:46 +00:00
|
|
|
class formatted_raw_ostream;
|
2003-10-30 23:39:52 +00:00
|
|
|
|
2008-08-24 18:38:56 +00:00
|
|
|
class AssemblyAnnotationWriter {
|
|
|
|
public:
|
2005-04-21 20:19:05 +00:00
|
|
|
|
2005-05-15 16:13:11 +00:00
|
|
|
virtual ~AssemblyAnnotationWriter();
|
|
|
|
|
2010-02-10 20:23:33 +00:00
|
|
|
/// emitFunctionAnnot - This may be implemented to emit a string right before
|
|
|
|
/// the start of a function.
|
2011-11-04 18:11:56 +00:00
|
|
|
virtual void emitFunctionAnnot(const Function *,
|
|
|
|
formatted_raw_ostream &) {}
|
2003-10-30 23:39:52 +00:00
|
|
|
|
2010-02-10 20:23:33 +00:00
|
|
|
/// emitBasicBlockStartAnnot - This may be implemented to emit a string right
|
2010-09-02 23:07:12 +00:00
|
|
|
/// after the basic block label, but before the first instruction in the
|
|
|
|
/// block.
|
2011-11-04 18:11:56 +00:00
|
|
|
virtual void emitBasicBlockStartAnnot(const BasicBlock *,
|
|
|
|
formatted_raw_ostream &) {
|
2004-03-08 18:51:05 +00:00
|
|
|
}
|
|
|
|
|
2010-02-10 20:23:33 +00:00
|
|
|
/// emitBasicBlockEndAnnot - This may be implemented to emit a string right
|
|
|
|
/// after the basic block.
|
2011-11-04 18:11:56 +00:00
|
|
|
virtual void emitBasicBlockEndAnnot(const BasicBlock *,
|
|
|
|
formatted_raw_ostream &) {
|
2004-03-08 18:51:05 +00:00
|
|
|
}
|
2003-10-30 23:39:52 +00:00
|
|
|
|
2010-02-10 20:23:33 +00:00
|
|
|
/// emitInstructionAnnot - This may be implemented to emit a string right
|
|
|
|
/// before an instruction is emitted.
|
2011-11-04 18:11:56 +00:00
|
|
|
virtual void emitInstructionAnnot(const Instruction *,
|
|
|
|
formatted_raw_ostream &) {}
|
2010-02-10 20:41:46 +00:00
|
|
|
|
|
|
|
/// printInfoComment - This may be implemented to emit a comment to the
|
|
|
|
/// right of an instruction or global value.
|
2011-11-04 18:11:56 +00:00
|
|
|
virtual void printInfoComment(const Value &, formatted_raw_ostream &) {}
|
2003-10-30 23:39:52 +00:00
|
|
|
};
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2003-10-30 23:39:52 +00:00
|
|
|
#endif
|