summaryrefslogtreecommitdiff
path: root/include/llvm/Assembly
diff options
context:
space:
mode:
Diffstat (limited to 'include/llvm/Assembly')
-rw-r--r--include/llvm/Assembly/AsmAnnotationWriter.h53
-rw-r--r--include/llvm/Assembly/Parser.h101
-rw-r--r--include/llvm/Assembly/PrintModulePass.h40
-rw-r--r--include/llvm/Assembly/Writer.h81
4 files changed, 275 insertions, 0 deletions
diff --git a/include/llvm/Assembly/AsmAnnotationWriter.h b/include/llvm/Assembly/AsmAnnotationWriter.h
new file mode 100644
index 0000000000000..6c3ddaf7d0ab3
--- /dev/null
+++ b/include/llvm/Assembly/AsmAnnotationWriter.h
@@ -0,0 +1,53 @@
+//===-- AsmAnnotationWriter.h - Itf for annotation .ll files - --*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// 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
+
+namespace llvm {
+
+class Function;
+class BasicBlock;
+class Instruction;
+class 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 *F, raw_ostream &OS) {}
+
+ // 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 *BB, raw_ostream &OS){
+ }
+
+ // emitBasicBlockEndAnnot - This may be implemented to emit a string right
+ // after the basic block.
+ virtual void emitBasicBlockEndAnnot(const BasicBlock *BB, raw_ostream &OS){
+ }
+
+ // emitInstructionAnnot - This may be implemented to emit a string right
+ // before an instruction is emitted.
+ virtual void emitInstructionAnnot(const Instruction *I, raw_ostream &OS) {}
+};
+
+} // End llvm namespace
+
+#endif
diff --git a/include/llvm/Assembly/Parser.h b/include/llvm/Assembly/Parser.h
new file mode 100644
index 0000000000000..e4a38e41b67ae
--- /dev/null
+++ b/include/llvm/Assembly/Parser.h
@@ -0,0 +1,101 @@
+//===-- llvm/Assembly/Parser.h - Parser for VM assembly files ---*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// These classes are implemented by the lib/AsmParser library.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ASSEMBLY_PARSER_H
+#define LLVM_ASSEMBLY_PARSER_H
+
+#include <string>
+
+namespace llvm {
+
+class Module;
+class ParseError;
+class raw_ostream;
+
+/// This function is the main interface to the LLVM Assembly Parser. It parses
+/// an ASCII file that (presumably) contains LLVM Assembly code. It returns a
+/// Module (intermediate representation) with the corresponding features. Note
+/// that this does not verify that the generated Module is valid, so you should
+/// run the verifier after parsing the file to check that it is okay.
+/// @brief Parse LLVM Assembly from a file
+Module *ParseAssemblyFile(
+ const std::string &Filename, ///< The name of the file to parse
+ ParseError &Error ///< If not null, an object to return errors in.
+);
+
+/// The function is a secondary interface to the LLVM Assembly Parser. It parses
+/// an ASCII string that (presumably) contains LLVM Assembly code. It returns a
+/// Module (intermediate representation) with the corresponding features. Note
+/// that this does not verify that the generated Module is valid, so you should
+/// run the verifier after parsing the file to check that it is okay.
+/// @brief Parse LLVM Assembly from a string
+Module *ParseAssemblyString(
+ const char *AsmString, ///< The string containing assembly
+ Module *M, ///< A module to add the assembly too.
+ ParseError &Error ///< If not null, an object to return errors in.
+);
+
+//===------------------------------------------------------------------------===
+// Helper Classes
+//===------------------------------------------------------------------------===
+
+/// An instance of this class can be passed to ParseAssemblyFile or
+/// ParseAssemblyString functions in order to capture error information from
+/// the parser. It provides a standard way to print out the error message
+/// including the file name and line number where the error occurred.
+/// @brief An LLVM Assembly Parsing Error Object
+class ParseError {
+public:
+ ParseError() : Filename("unknown"), Message("none"), LineNo(0), ColumnNo(0) {}
+ ParseError(const ParseError &E);
+
+ void setFilename(const std::string &F) { Filename = F; }
+
+ inline const std::string &getRawMessage() const { // Just the raw message.
+ return Message;
+ }
+
+ inline const std::string &getFilename() const {
+ return Filename;
+ }
+
+ void setError(const std::string &message, int lineNo = -1, int ColNo = -1,
+ const std::string &FileContents = "") {
+ Message = message;
+ LineNo = lineNo; ColumnNo = ColNo;
+ LineContents = FileContents;
+ }
+
+ // getErrorLocation - Return the line and column number of the error in the
+ // input source file. The source filename can be derived from the
+ // ParserOptions in effect. If positional information is not applicable,
+ // these will return a value of -1.
+ //
+ inline void getErrorLocation(int &Line, int &Column) const {
+ Line = LineNo; Column = ColumnNo;
+ }
+
+ void PrintError(const char *ProgName, raw_ostream &S);
+
+private :
+ std::string Filename;
+ std::string Message;
+ int LineNo, ColumnNo; // -1 if not relevant
+ std::string LineContents;
+
+ void operator=(const ParseError &E); // DO NOT IMPLEMENT
+};
+
+} // End llvm namespace
+
+#endif
diff --git a/include/llvm/Assembly/PrintModulePass.h b/include/llvm/Assembly/PrintModulePass.h
new file mode 100644
index 0000000000000..fb4f6a7e13eab
--- /dev/null
+++ b/include/llvm/Assembly/PrintModulePass.h
@@ -0,0 +1,40 @@
+//===- llvm/Assembly/PrintModulePass.h - Printing Pass ----------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines two passes to print out a module. The PrintModulePass pass
+// simply prints out the entire module when it is executed. The
+// PrintFunctionPass class is designed to be pipelined with other
+// FunctionPass's, and prints out the functions of the module as they are
+// processed.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ASSEMBLY_PRINTMODULEPASS_H
+#define LLVM_ASSEMBLY_PRINTMODULEPASS_H
+
+#include <string>
+
+namespace llvm {
+ class FunctionPass;
+ class ModulePass;
+ class raw_ostream;
+
+ /// createPrintModulePass - Create and return a pass that writes the
+ /// module to the specified raw_ostream.
+ ModulePass *createPrintModulePass(raw_ostream *OS, bool DeleteStream=false);
+
+ /// createPrintFunctionPass - Create and return a pass that prints
+ /// functions to the specified raw_ostream as they are processed.
+ FunctionPass *createPrintFunctionPass(const std::string &Banner,
+ raw_ostream *OS,
+ bool DeleteStream=false);
+
+} // End llvm namespace
+
+#endif
diff --git a/include/llvm/Assembly/Writer.h b/include/llvm/Assembly/Writer.h
new file mode 100644
index 0000000000000..5e5fe1560585d
--- /dev/null
+++ b/include/llvm/Assembly/Writer.h
@@ -0,0 +1,81 @@
+//===-- llvm/Assembly/Writer.h - Printer for LLVM assembly files --*- C++ -*-=//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This functionality is implemented by lib/VMCore/AsmWriter.cpp.
+// This library is used to print LLVM assembly language files to an iostream. It
+// can print LLVM code at a variety of granularities, including Modules,
+// BasicBlocks, and Instructions. This makes it useful for debugging.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_ASSEMBLY_WRITER_H
+#define LLVM_ASSEMBLY_WRITER_H
+
+#include <iosfwd>
+#include <string>
+
+namespace llvm {
+
+class Type;
+class Module;
+class Value;
+class raw_ostream;
+template <typename T> class SmallVectorImpl;
+
+/// TypePrinting - Type printing machinery.
+class TypePrinting {
+ void *TypeNames; // A map to remember type names.
+ TypePrinting(const TypePrinting &); // DO NOT IMPLEMENT
+ void operator=(const TypePrinting&); // DO NOT IMPLEMENT
+public:
+ TypePrinting();
+ ~TypePrinting();
+
+ void clear();
+
+ void print(const Type *Ty, raw_ostream &OS, bool IgnoreTopLevelName = false);
+
+ void printAtLeastOneLevel(const Type *Ty, raw_ostream &OS) {
+ print(Ty, OS, true);
+ }
+
+ /// hasTypeName - Return true if the type has a name in TypeNames, false
+ /// otherwise.
+ bool hasTypeName(const Type *Ty) const;
+
+ /// addTypeName - Add a name for the specified type if it doesn't already have
+ /// one. This name will be printed instead of the structural version of the
+ /// type in order to make the output more concise.
+ void addTypeName(const Type *Ty, const std::string &N);
+
+private:
+ void CalcTypeName(const Type *Ty, SmallVectorImpl<const Type *> &TypeStack,
+ raw_ostream &OS, bool IgnoreTopLevelName = false);
+};
+
+// WriteTypeSymbolic - This attempts to write the specified type as a symbolic
+// type, if there is an entry in the Module's symbol table for the specified
+// type or one of its component types.
+//
+void WriteTypeSymbolic(raw_ostream &, const Type *, const Module *M);
+
+// WriteAsOperand - Write the name of the specified value out to the specified
+// ostream. This can be useful when you just want to print int %reg126, not the
+// whole instruction that generated it. If you specify a Module for context,
+// then even constants get pretty-printed; for example, the type of a null
+// pointer is printed symbolically.
+//
+void WriteAsOperand(std::ostream &, const Value *, bool PrintTy = true,
+ const Module *Context = 0);
+void WriteAsOperand(raw_ostream &, const Value *, bool PrintTy = true,
+ const Module *Context = 0);
+
+} // End llvm namespace
+
+#endif