ASTConsumers.h revision da1573f95902a42aa4d11e8f45ab98ec7e27bc28 
1//===--- ASTConsumers.h - ASTConsumer implementations -----------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// AST Consumers.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef DRIVER_ASTCONSUMERS_H
15#define DRIVER_ASTCONSUMERS_H
16
17#include <string>
18
19namespace llvm {
20  class raw_ostream;
21  class Module;
22  class LLVMContext;
23  namespace sys { class Path; }
24}
25namespace clang {
26
27class ASTConsumer;
28class CodeGenOptions;
29class Diagnostic;
30class FileManager;
31class LangOptions;
32class Preprocessor;
33class TargetOptions;
34
35// AST pretty-printer: prints out the AST in a format that is close to the
36// original C code.  The output is intended to be in a format such that
37// clang could re-parse the output back into the same AST, but the
38// implementation is still incomplete.
39ASTConsumer *CreateASTPrinter(llvm::raw_ostream *OS);
40
41// AST XML-printer: prints out the AST in a XML format
42// The output is intended to be in a format such that
43// clang or any other tool could re-parse the output back into the same AST,
44// but the implementation is still incomplete.
45ASTConsumer *CreateASTPrinterXML(llvm::raw_ostream *OS);
46
47// AST dumper: dumps the raw AST in human-readable form to stderr; this is
48// intended for debugging.
49ASTConsumer *CreateASTDumper();
50
51// Graphical AST viewer: for each function definition, creates a graph of
52// the AST and displays it with the graph viewer "dotty".  Also outputs
53// function declarations to stderr.
54ASTConsumer *CreateASTViewer();
55
56// DeclContext printer: prints out the DeclContext tree in human-readable form
57// to stderr; this is intended for debugging.
58ASTConsumer *CreateDeclContextPrinter();
59
60// RecordLayout dumper: prints out the record layout information for all records
61// in the translation unit; this is intended for debugging.
62ASTConsumer *CreateRecordLayoutDumper();
63
64// ObjC rewriter: attempts tp rewrite ObjC constructs into pure C code.
65// This is considered experimental, and only works with Apple's ObjC runtime.
66ASTConsumer *CreateObjCRewriter(const std::string &InFile,
67                                llvm::raw_ostream *OS,
68                                Diagnostic &Diags,
69                                const LangOptions &LOpts,
70                                bool SilenceRewriteMacroWarning);
71
72// LLVM code generator: uses the code generation backend to generate LLVM
73// assembly. This runs optimizations depending on the CodeGenOptions
74// parameter. The output depends on the Action parameter.
75enum BackendAction {
76  Backend_EmitAssembly,  // Emit native assembly files
77  Backend_EmitBC,        // Emit LLVM bitcode files
78  Backend_EmitLL,        // Emit human-readable LLVM assembly
79  Backend_EmitNothing,   // Don't emit anything (benchmarking mode)
80  Backend_EmitObj        // Emit native object files
81};
82ASTConsumer *CreateBackendConsumer(BackendAction Action,
83                                   Diagnostic &Diags,
84                                   const LangOptions &Features,
85                                   const CodeGenOptions &CodeGenOpts,
86                                   const TargetOptions &TargetOpts,
87                                   bool TimePasses,
88                                   const std::string &ModuleID,
89                                   llvm::raw_ostream *OS,
90                                   llvm::LLVMContext& C);
91
92/// CreateHTMLPrinter - Create an AST consumer which rewrites source code to
93/// HTML with syntax highlighting suitable for viewing in a web-browser.
94ASTConsumer *CreateHTMLPrinter(llvm::raw_ostream *OS, Preprocessor &PP,
95                               bool SyntaxHighlight = true,
96                               bool HighlightMacros = true);
97
98// PCH generator: generates a precompiled header file; this file can be used
99// later with the PCHReader (clang -cc1 option -include-pch) to speed up compile
100// times.
101ASTConsumer *CreatePCHGenerator(const Preprocessor &PP,
102                                llvm::raw_ostream *OS,
103                                const char *isysroot = 0);
104
105// Inheritance viewer: for C++ code, creates a graph of the inheritance
106// tree for the given class and displays it with "dotty".
107ASTConsumer *CreateInheritanceViewer(const std::string& clsname);
108
109} // end clang namespace
110
111#endif
112