1 //===--- ASTConsumers.h - ASTConsumer implementations -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 //===----------------------------------------------------------------------===//
14 #ifndef DRIVER_ASTCONSUMERS_H
15 #define DRIVER_ASTCONSUMERS_H
17 #include "clang/Basic/LLVM.h"
20 namespace sys { class Path; }
26 class DiagnosticsEngine;
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.
36 ASTConsumer *CreateASTPrinter(raw_ostream *OS, StringRef FilterString);
38 // AST dumper: dumps the raw AST in human-readable form to stderr; this is
39 // intended for debugging.
40 ASTConsumer *CreateASTDumper(StringRef FilterString);
42 // AST Decl node lister: prints qualified names of all filterable AST Decl
44 ASTConsumer *CreateASTDeclNodeLister();
46 // AST XML-dumper: dumps out the AST to stderr in a very detailed XML
47 // format; this is intended for particularly intense debugging.
48 ASTConsumer *CreateASTDumperXML(raw_ostream &OS);
50 // Graphical AST viewer: for each function definition, creates a graph of
51 // the AST and displays it with the graph viewer "dotty". Also outputs
52 // function declarations to stderr.
53 ASTConsumer *CreateASTViewer();
55 // DeclContext printer: prints out the DeclContext tree in human-readable form
56 // to stderr; this is intended for debugging.
57 ASTConsumer *CreateDeclContextPrinter();
59 } // end clang namespace