[cfe-commits] r161861 - /cfe/trunk/docs/HowToSetupToolingForLLVM.html

[Alexander Kornienko]

Author: alexfh
Date: Tue Aug 14 03:31:51 2012
New Revision: 161861

URL: http://llvm.org/viewvc/llvm-project?rev=161861&view=rev
Log:
Added description of clang-check -ast-dump* options.

Modified:
    cfe/trunk/docs/HowToSetupToolingForLLVM.html

Modified: cfe/trunk/docs/HowToSetupToolingForLLVM.html
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/HowToSetupToolingForLLVM.html?rev=161861&r1=161860&r2=161861&view=diff
==============================================================================
--- cfe/trunk/docs/HowToSetupToolingForLLVM.html (original)
+++ cfe/trunk/docs/HowToSetupToolingForLLVM.html Tue Aug 14 03:31:51 2012
@@ -84,6 +84,42 @@
 <p>When editing C++ code, hit F5 to reparse the current buffer. The output will
 go into the error window, which you can enable with <code>:cope</code>.</p>
 
+<p>Other <code>clang-check</code> options that can be useful when working with
+clang AST:</p>
+<ul>
+  <li><code>-ast-print</code> - Build ASTs and then pretty-print them.</li>
+  <li><code>-ast-dump</code> - Build ASTs and then debug dump them.</li>
+  <li><code>-ast-dump-filter=<string></code> - Use with
+    <code>-ast-dump</code> or <code>-ast-print</code> to dump/print
+    only AST declaration nodes having a certain substring in a qualified name.
+    Use <code>-ast-list</code> to list all filterable declaration node
+    names.</li>
+  <li><code>-ast-list</code> - Build ASTs and print the list of declaration
+    node qualified names.</li>
+</ul>
+<p>Examples:</p>
+<pre>
+<b>$ clang-check tools/clang/tools/clang-check/ClangCheck.cpp -ast-dump -ast-dump-filter ActionFactory::newASTConsumer</b>
+Processing: tools/clang/tools/clang-check/ClangCheck.cpp.
+Dumping <anonymous namespace>::ActionFactory::newASTConsumer:
+clang::ASTConsumer *newASTConsumer() (CompoundStmt 0x44da290 </home/alexfh/local/llvm/tools/clang/tools/clang-check/ClangCheck.cpp:64:40, line:72:3>
+  (IfStmt 0x44d97c8 <line:65:5, line:66:45>
+    <<<NULL>>>
+      (ImplicitCastExpr 0x44d96d0 <line:65:9> '_Bool':'_Bool' <UserDefinedConversion>
+...
+<b>$ clang-check tools/clang/tools/clang-check/ClangCheck.cpp -ast-print -ast-dump-filter ActionFactory::newASTConsumer</b>
+Processing: tools/clang/tools/clang-check/ClangCheck.cpp.
+Printing <anonymous namespace>::ActionFactory::newASTConsumer:
+clang::ASTConsumer *newASTConsumer() {
+    if (this->ASTList.operator _Bool())
+        return clang::CreateASTDeclNodeLister();
+    if (this->ASTDump.operator _Bool())
+        return clang::CreateASTDumper(this->ASTDumpFilter);
+    if (this->ASTPrint.operator _Bool())
+        return clang::CreateASTPrinter(&llvm::outs(), this->ASTDumpFilter);
+    return new clang::ASTConsumer();
+}
+</pre>
 
 <!-- ======================================================================= -->
 <h2><a name="using-ninja">(Experimental) Using Ninja Build System</a></h2>