ASTConsumers.h revision 226633
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 "clang/Basic/LLVM.h"
18
19namespace llvm {
20  namespace sys { class Path; }
21}
22namespace clang {
23
24class ASTConsumer;
25class CodeGenOptions;
26class DiagnosticsEngine;
27class FileManager;
28class LangOptions;
29class Preprocessor;
30class TargetOptions;
31
32// AST pretty-printer: prints out the AST in a format that is close to the
33// original C code.  The output is intended to be in a format such that
34// clang could re-parse the output back into the same AST, but the
35// implementation is still incomplete.
36ASTConsumer *CreateASTPrinter(raw_ostream *OS);
37
38// AST dumper: dumps the raw AST in human-readable form to stderr; this is
39// intended for debugging.
40ASTConsumer *CreateASTDumper();
41
42// AST XML-dumper: dumps out the AST to stderr in a very detailed XML
43// format; this is intended for particularly intense debugging.
44ASTConsumer *CreateASTDumperXML(raw_ostream &OS);
45
46// Graphical AST viewer: for each function definition, creates a graph of
47// the AST and displays it with the graph viewer "dotty".  Also outputs
48// function declarations to stderr.
49ASTConsumer *CreateASTViewer();
50
51// DeclContext printer: prints out the DeclContext tree in human-readable form
52// to stderr; this is intended for debugging.
53ASTConsumer *CreateDeclContextPrinter();
54
55} // end clang namespace
56
57#endif
58