ASTConsumers.h revision ffaab3e2bb13991bb3357e80f14bcae3745b2347 
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// PCH generator: generates a precompiled header file; this file can be used
61// later with the PCHReader (clang -cc1 option -include-pch) to speed up compile
62// times.
63ASTConsumer *CreatePCHGenerator(const Preprocessor &PP,
64                                llvm::raw_ostream *OS,
65                                bool Chaining,
66                                const char *isysroot = 0);
67
68// Inheritance viewer: for C++ code, creates a graph of the inheritance
69// tree for the given class and displays it with "dotty".
70ASTConsumer *CreateInheritanceViewer(const std::string& clsname);
71
72} // end clang namespace
73
74#endif
75