pmd/pmd_userdocs_extending_ast_dump.html

2097 lines
68 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Creating a XML representation of the AST allows to analyze the AST with other tools.">
<meta name="keywords" content="userdocs, ">
<title>Creating XML dump of the AST | PMD Source Code Analyzer</title>
<link rel="stylesheet" type="text/css" href="assets/fontawesome-free-5.15.4-web/css/all.min.css">
<link rel="stylesheet" type="text/css" href="assets/bootstrap-4.5.2-dist/css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/syntax.css">
<link rel="stylesheet" type="text/css" href="css/modern-business.css">
<link rel="stylesheet" type="text/css" href="css/customstyles.css">
<link rel="stylesheet" type="text/css" href="css/theme-green.css">
<link rel="stylesheet" type="text/css" href="css/pmd-customstyles.css">
<link rel="shortcut icon" href="images/logo/favicon.ico" type="image/x-icon">
<link rel="icon" href="images/logo/favicon.ico" type="image/x-icon">
<link rel="alternate" type="application/rss+xml" title="" href="feed.xml">
</head>
<body>
<!-- Content is offset by the height of the topnav bar. -->
<!-- There's already a padding-top rule in modern-business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
<div id="topbar-content-offset">
<!-- Navigation -->
<nav class="navbar navbar-expand-lg fixed-top navbar-dark">
<div class="container topnavlinks">
<a class="navbar-brand fas fa-home fa-lg" href="index.html">&nbsp;<span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav mr-auto mt-2 mt-lg-0"></ul>
<ul class="navbar-nav">
<!-- toggle sidebar button -->
<li class="nav-item"><a id="tg-sb-link" class="nav-link" href="#"><i id="tg-sb-icon" class="fas fa-toggle-on"></i> Nav</a></li>
<!-- entries without drop-downs appear here -->
<li class="nav-item"><a class="nav-link" href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
<li class="nav-item"><a class="nav-link" href="https://github.com/pmd/pmd" target="_blank">Fork us on github</a></li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
</ul>
<form class="form-inline my-2 my-lg-0">
<input class="form-control mr-sm-2" type="search" placeholder="search..." id="search-input">
<ul id="results-container"></ul>
</form>
</div>
</div>
</nav>
<!-- Page Content -->
<div class="container-toc-wrapper">
<div class="container">
<div class="col-lg-12">&nbsp;</div>
<!-- Content Row -->
<div class="row">
<!-- Sidebar Column -->
<div class="col-md-3" id="tg-sb-sidebar">
<ul id="mysidebar" class="nav">
<li class="sidebarTitle">PMD 7.8.0-SNAPSHOT</li>
<div class="sidebarTitleDate">Release date: 29-November-2024</div>
<li>
<a href="#">About</a>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="pmd_release_notes.html">Release notes</a></li>
<li><a href="pmd_release_notes_pmd7.html">Release notes (PMD 7)</a></li>
<li><a href="pmd_about_help.html">Getting help</a></li>
<li><a href="pmd_about_release_policies.html">Release policies</a></li>
<li><a href="pmd_about_support_lifecycle.html">Support lifecycle</a></li>
</ul>
</li>
<li>
<a href="#">User Documentation</a>
<ul>
<li><a href="pmd_userdocs_migrating_to_pmd7.html">Migration Guide for PMD 7</a></li>
<li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
<li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
<li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
<li><a href="pmd_userdocs_best_practices.html">Best practices</a></li>
<li><a href="pmd_userdocs_suppressing_warnings.html">Suppressing warnings</a></li>
<li><a href="pmd_userdocs_incremental_analysis.html">Incremental analysis</a></li>
<li><a href="pmd_userdocs_cli_reference.html">PMD CLI reference</a></li>
<li><a href="pmd_userdocs_report_formats.html">PMD Report formats</a></li>
<li><a href="pmd_userdocs_3rdpartyrulesets.html">3rd party rulesets</a></li>
<li class="subfolders">
<a href="#">CPD reference</a>
<ul>
<li><a href="pmd_userdocs_cpd.html">Copy-paste detection</a></li>
<li><a href="pmd_userdocs_cpd_report_formats.html">CPD Report formats</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Extending PMD</a>
<ul>
<li><a href="pmd_userdocs_extending_writing_rules_intro.html">Introduction to writing rules</a></li>
<li><a href="pmd_userdocs_extending_your_first_rule.html">Your first rule</a></li>
<li><a href="pmd_userdocs_extending_writing_xpath_rules.html">XPath rules</a></li>
<li><a href="pmd_userdocs_extending_writing_java_rules.html">Java rules</a></li>
<li><a href="pmd_userdocs_extending_designer_reference.html">Rule designer reference</a></li>
<li><a href="pmd_userdocs_extending_defining_properties.html">Defining rule properties</a></li>
<li><a href="pmd_userdocs_extending_rule_guidelines.html">Rule guidelines</a></li>
<li><a href="pmd_userdocs_extending_testing.html">Testing your rules</a></li>
<li class="active"><a href="pmd_userdocs_extending_ast_dump.html">Creating (XML) dump of the AST</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Tools / Integrations</a>
<ul>
<li><a href="pmd_userdocs_tools_maven.html">Maven PMD Plugin</a></li>
<li><a href="pmd_userdocs_tools_gradle.html">Gradle</a></li>
<li><a href="pmd_userdocs_tools_ant.html">Ant</a></li>
<li><a href="pmd_userdocs_tools_java_api.html">PMD Java API</a></li>
<li><a href="pmd_userdocs_tools_bld.html">bld PMD Extension</a></li>
<li><a href="pmd_userdocs_tools_ci.html">CI integrations</a></li>
<li><a href="pmd_userdocs_tools.html">Other Tools / Integrations</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#">Rule Reference</a>
<ul>
<li class="subfolders">
<a href="#">Apex Rules</a>
<ul>
<li><a href="pmd_rules_apex.html">Index</a></li>
<li><a href="pmd_rules_apex_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_apex_codestyle.html">Code Style</a></li>
<li><a href="pmd_rules_apex_design.html">Design</a></li>
<li><a href="pmd_rules_apex_documentation.html">Documentation</a></li>
<li><a href="pmd_rules_apex_errorprone.html">Error Prone</a></li>
<li><a href="pmd_rules_apex_performance.html">Performance</a></li>
<li><a href="pmd_rules_apex_security.html">Security</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">HTML Rules</a>
<ul>
<li><a href="pmd_rules_html.html">Index</a></li>
<li><a href="pmd_rules_html_bestpractices.html">Best Practices</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Java Rules</a>
<ul>
<li><a href="pmd_rules_java.html">Index</a></li>
<li><a href="pmd_rules_java_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_java_codestyle.html">Code Style</a></li>
<li><a href="pmd_rules_java_design.html">Design</a></li>
<li><a href="pmd_rules_java_documentation.html">Documentation</a></li>
<li><a href="pmd_rules_java_errorprone.html">Error Prone</a></li>
<li><a href="pmd_rules_java_multithreading.html">Multithreading</a></li>
<li><a href="pmd_rules_java_performance.html">Performance</a></li>
<li><a href="pmd_rules_java_security.html">Security</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Java Server Pages Rules</a>
<ul>
<li><a href="pmd_rules_jsp.html">Index</a></li>
<li><a href="pmd_rules_jsp_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_jsp_codestyle.html">Code Style</a></li>
<li><a href="pmd_rules_jsp_design.html">Design</a></li>
<li><a href="pmd_rules_jsp_errorprone.html">Error Prone</a></li>
<li><a href="pmd_rules_jsp_security.html">Security</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">JavaScript Rules</a>
<ul>
<li><a href="pmd_rules_ecmascript.html">Index</a></li>
<li><a href="pmd_rules_ecmascript_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_ecmascript_codestyle.html">Code Style</a></li>
<li><a href="pmd_rules_ecmascript_errorprone.html">Error Prone</a></li>
<li><a href="pmd_rules_ecmascript_performance.html">Performance</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Kotlin Rules</a>
<ul>
<li><a href="pmd_rules_kotlin.html">Index</a></li>
<li><a href="pmd_rules_kotlin_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_kotlin_errorprone.html">Error Prone</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Maven POM Rules</a>
<ul>
<li><a href="pmd_rules_pom.html">Index</a></li>
<li><a href="pmd_rules_pom_errorprone.html">Error Prone</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Modelica Rules</a>
<ul>
<li><a href="pmd_rules_modelica.html">Index</a></li>
<li><a href="pmd_rules_modelica_bestpractices.html">Best Practices</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">PLSQL Rules</a>
<ul>
<li><a href="pmd_rules_plsql.html">Index</a></li>
<li><a href="pmd_rules_plsql_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_plsql_codestyle.html">Code Style</a></li>
<li><a href="pmd_rules_plsql_design.html">Design</a></li>
<li><a href="pmd_rules_plsql_errorprone.html">Error Prone</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Salesforce Visualforce Rules</a>
<ul>
<li><a href="pmd_rules_visualforce.html">Index</a></li>
<li><a href="pmd_rules_visualforce_security.html">Security</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Scala Rules</a>
<ul>
<li><a href="pmd_rules_scala.html">Index</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Swift Rules</a>
<ul>
<li><a href="pmd_rules_swift.html">Index</a></li>
<li><a href="pmd_rules_swift_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_swift_errorprone.html">Error Prone</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Velocity Template Language (VTL) Rules</a>
<ul>
<li><a href="pmd_rules_velocity.html">Index</a></li>
<li><a href="pmd_rules_velocity_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_velocity_design.html">Design</a></li>
<li><a href="pmd_rules_velocity_errorprone.html">Error Prone</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">WSDL Rules</a>
<ul>
<li><a href="pmd_rules_wsdl.html">Index</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">XML Rules</a>
<ul>
<li><a href="pmd_rules_xml.html">Index</a></li>
<li><a href="pmd_rules_xml_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_xml_errorprone.html">Error Prone</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">XSL Rules</a>
<ul>
<li><a href="pmd_rules_xsl.html">Index</a></li>
<li><a href="pmd_rules_xsl_codestyle.html">Code Style</a></li>
<li><a href="pmd_rules_xsl_performance.html">Performance</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#">Language-Specific Documentation</a>
<ul>
<li><a href="pmd_languages_index.html">Overview</a></li>
<li><a href="pmd_languages_configuration.html">Language configuration</a></li>
<li><a href="pmd_languages_apex.html">Apex</a></li>
<li><a href="pmd_languages_cpp.html">C/C++</a></li>
<li><a href="pmd_languages_cs.html">C#</a></li>
<li><a href="pmd_languages_coco.html">Coco</a></li>
<li><a href="pmd_languages_dart.html">Dart</a></li>
<li><a href="pmd_languages_fortran.html">Fortran</a></li>
<li><a href="pmd_languages_gherkin.html">Gherkin</a></li>
<li><a href="pmd_languages_go.html">Go</a></li>
<li><a href="pmd_languages_html.html">HTML</a></li>
<li><a href="pmd_languages_java.html">Java</a></li>
<li><a href="pmd_languages_js_ts.html">JavaScript / TypeScript</a></li>
<li><a href="pmd_languages_jsp.html">JSP</a></li>
<li><a href="pmd_languages_julia.html">Julia</a></li>
<li><a href="pmd_languages_kotlin.html">Kotlin</a></li>
<li><a href="pmd_languages_lua.html">Lua</a></li>
<li><a href="pmd_languages_matlab.html">Matlab</a></li>
<li><a href="pmd_languages_modelica.html">Modelica</a></li>
<li><a href="pmd_languages_objectivec.html">Objective-C</a></li>
<li><a href="pmd_languages_perl.html">Perl</a></li>
<li><a href="pmd_languages_php.html">PHP</a></li>
<li><a href="pmd_languages_plsql.html">PLSQL</a></li>
<li><a href="pmd_languages_python.html">Python</a></li>
<li><a href="pmd_languages_ruby.html">Ruby</a></li>
<li><a href="pmd_languages_scala.html">Scala</a></li>
<li><a href="pmd_languages_swift.html">Swift</a></li>
<li><a href="pmd_languages_tsql.html">T-SQL</a></li>
<li><a href="pmd_languages_visualforce.html">Visualforce</a></li>
<li><a href="pmd_languages_velocity.html">Velocity Template Language (VTL)</a></li>
<li><a href="pmd_languages_xml.html">XML and XML dialects</a></li>
</ul>
</li>
<li>
<a href="#">Developer Documentation</a>
<ul>
<li><a href="pmd_devdocs_development.html">Developer resources</a></li>
<li><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
<li><a href="https://github.com/pmd/pmd/blob/main/CONTRIBUTING.md" target="_blank">Contributing</a></li>
<li><a href="pmd_devdocs_writing_documentation.html">Writing documentation</a></li>
<li><a href="pmd_devdocs_roadmap.html">Roadmap</a></li>
<li><a href="pmd_devdocs_how_pmd_works.html">How PMD works</a></li>
<li><a href="pmd_devdocs_pmdtester.html">Pmdtester</a></li>
<li><a href="pmd_devdocs_rule_deprecation_policy.html">Rule Deprecation Policy</a></li>
<li class="subfolders">
<a href="#">Major contributions</a>
<ul>
<li><a href="pmd_devdocs_major_rule_guidelines.html">Rule Guidelines</a></li>
<li><a href="pmd_devdocs_major_adding_new_language_javacc.html">Adding a new language (JavaCC)</a></li>
<li><a href="pmd_devdocs_major_adding_new_language_antlr.html">Adding a new language (ANTLR)</a></li>
<li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Experimental features</a>
<ul>
<li><a href="tag_experimental.html">List of experimental Features</a></li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#">Project documentation</a>
<ul>
<li class="subfolders">
<a href="#">Trivia about PMD</a>
<ul>
<li><a href="pmd_projectdocs_trivia_news.html">PMD in the press</a></li>
<li><a href="pmd_projectdocs_trivia_products.html">Products & books related to PMD</a></li>
<li><a href="pmd_projectdocs_trivia_similarprojects.html">Similar projects</a></li>
<li><a href="pmd_projectdocs_trivia_meaning.html">What does 'PMD' mean?</a></li>
</ul>
</li>
<li><a href="pmd_projectdocs_logo.html">Logo</a></li>
<li><a href="pmd_projectdocs_faq.html">FAQ</a></li>
<li><a href="license.html">License</a></li>
<li><a href="pmd_projectdocs_credits.html">Credits</a></li>
<li><a href="pmd_release_notes_old.html">Old release notes</a></li>
<li><a href="pmd_projectdocs_decisions.html">Decisions</a></li>
<li class="subfolders">
<a href="#">Project management</a>
<ul>
<li><a href="pmd_projectdocs_committers_infrastructure.html">Infrastructure</a></li>
<li><a href="pmd_projectdocs_committers_releasing.html">Release process</a></li>
<li><a href="pmd_projectdocs_committers_merging_pull_requests.html">Merging pull requests</a></li>
<li><a href="pmd_projectdocs_committers_main_landing_page.html">Main Landing page</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- Content Column -->
<div class="col-md-9" id="tg-sb-content">
<header>
<div class="row">
<div class="col-lg-12">
<a href="./" role="button"
><i class="fa fa-home fa-lg"></i
></a>
» Creating XML dump of the AST
<a
target="_blank"
href="https://github.com/pmd/pmd/blob/main/docs/pages/pmd/userdocs/extending/ast_dump.md"
class="float-right"
role="button"
><i class="fab fa-github fa-lg"></i> Edit on GitHub</a
>
</div>
</div>
<hr />
</header>
<div class="post-header">
<h1 class="post-title-main">Creating XML dump of the AST</h1>
</div>
<div class="post-content" data-github-edit-url="https://github.com/pmd/pmd/blob/main/docs/pages/pmd/userdocs/extending/ast_dump.md">
<div class="summary">Creating a XML representation of the AST allows to analyze the AST with other tools.</div>
<details id="inline-toc-details">
<summary>Table of Contents</summary>
<div id="inline-toc"><!-- empty, move TOC here when screen size too small --></div>
</details>
<h2 id="command-line-usage">Command line usage</h2>
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>pmd ast-dump <span class="nt">--help</span>
Usage: pmd ast-dump <span class="o">[</span><span class="nt">-Dhi</span><span class="o">]</span> <span class="o">[</span><span class="nt">-e</span><span class="o">=</span>&lt;encoding&gt;] <span class="o">[</span><span class="nt">-f</span><span class="o">=</span>&lt;format&gt;] <span class="o">[</span><span class="nt">--file</span><span class="o">=</span>&lt;file&gt;]
<span class="o">[</span><span class="nt">-l</span><span class="o">=</span>&lt;language&gt;] <span class="o">[</span><span class="nt">-P</span><span class="o">=</span>&lt;<span class="nv">String</span><span class="o">=</span>String&gt;]...
Dumps the AST of parsing <span class="nb">source </span>code
<span class="nt">-D</span>, <span class="nt">-v</span>, <span class="nt">--debug</span>, <span class="nt">--verbose</span>
Debug mode.
<span class="nt">-e</span>, <span class="nt">--encoding</span><span class="o">=</span>&lt;encoding&gt;
Specifies the character <span class="nb">set </span>encoding of the <span class="nb">source
</span>code files
<span class="nt">-f</span>, <span class="nt">--format</span><span class="o">=</span>&lt;format&gt; The output format.
Valid values: xml, text
<span class="nt">--file</span><span class="o">=</span>&lt;file&gt; The file to parse and dump.
<span class="nt">-h</span>, <span class="nt">--help</span> Show this <span class="nb">help </span>message and exit.
<span class="nt">-i</span>, <span class="nt">--read-stdin</span> Read <span class="nb">source </span>from standard input.
<span class="nt">-l</span>, <span class="nt">--language</span><span class="o">=</span>&lt;language&gt;
The <span class="nb">source </span>code language.
Valid values: apex, ecmascript, html, java, jsp,
kotlin, modelica, plsql, pom, scala, swift, vf, vm,
wsdl, xml, xsl
<span class="nt">-P</span><span class="o">=</span>&lt;<span class="nv">String</span><span class="o">=</span>String&gt; Key-value pair defining a property <span class="k">for </span>the report
format.
Supported values <span class="k">for </span>each report format:
xml:
singleQuoteAttributes - Use single quotes to
delimit attribute values
Default: <span class="nb">true
</span>lineSeparator - Line separator to use. The default
is platform-specific. The values <span class="s1">'CR'</span>, <span class="s1">'CRLF'</span>,
<span class="s1">'LF'</span>, <span class="s1">'\r'</span>, <span class="s1">'\r\n'</span> and <span class="s1">'\n'</span> can be used to
represent a carriage <span class="k">return</span>, line feed and their
combination more easily.
Default: <span class="se">\n</span>
renderProlog - True to output a prolog
Default: <span class="nb">true
</span>renderCommonAttributes - True to render attributes
like BeginLine, EndLine, etc.
Default: <span class="nb">false
</span>text:
onlyAsciiChars - Use only ASCII characters <span class="k">in </span>the
structure
Default: <span class="nb">false
</span>maxLevel - Max level on which to recurse. Negative
means unbounded
Default: <span class="nt">-1</span>
</code></pre></div></div>
<h2 id="example">Example</h2>
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span><span class="nb">cat </span>Foo.java
public class Foo <span class="o">{</span>
int a<span class="p">;</span>
<span class="o">}</span>
<span class="nv">$ </span>pmd ast-dump <span class="nt">--format</span> xml <span class="nt">--language</span> java <span class="nt">--file</span> Foo.java <span class="o">&gt;</span> Foo.xml
<span class="nv">$ </span><span class="nb">cat </span>Foo.xml
&lt;?xml <span class="nv">version</span><span class="o">=</span><span class="s1">'1.0'</span> <span class="nv">encoding</span><span class="o">=</span><span class="s1">'UTF-8'</span> ?&gt;
&lt;CompilationUnit <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> <span class="nv">PackageName</span><span class="o">=</span><span class="s1">''</span><span class="o">&gt;</span>
&lt;ClassDeclaration <span class="nv">Abstract</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Annotation</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Anonymous</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">BinaryName</span><span class="o">=</span><span class="s1">'Foo'</span> <span class="nv">CanonicalName</span><span class="o">=</span><span class="s1">'Foo'</span> <span class="nv">EffectiveVisibility</span><span class="o">=</span><span class="s1">'public'</span> <span class="nv">Enum</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Final</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Image</span><span class="o">=</span><span class="s1">'Foo'</span> <span class="nv">Interface</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Local</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Native</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Nested</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">PackageName</span><span class="o">=</span><span class="s1">''</span> <span class="nv">PackagePrivate</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Private</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Protected</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Public</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">Record</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">RegularClass</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">RegularInterface</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SimpleName</span><span class="o">=</span><span class="s1">'Foo'</span> <span class="nv">Static</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Strictfp</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Synchronized</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyAbstract</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyFinal</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyPublic</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">SyntacticallyStatic</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">TopLevel</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">Transient</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Visibility</span><span class="o">=</span><span class="s1">'public'</span> <span class="nv">Volatile</span><span class="o">=</span><span class="s1">'false'</span><span class="o">&gt;</span>
&lt;ModifierList <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> /&gt;
&lt;ClassBody <span class="nv">Empty</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> <span class="nv">Size</span><span class="o">=</span><span class="s1">'1'</span><span class="o">&gt;</span>
&lt;FieldDeclaration <span class="nv">Abstract</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">EffectiveVisibility</span><span class="o">=</span><span class="s1">'package'</span> <span class="nv">Final</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> <span class="nv">Native</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">PackagePrivate</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">Private</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Protected</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Public</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Static</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Strictfp</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Synchronized</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyAbstract</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyFinal</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyPublic</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyStatic</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Transient</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">VariableName</span><span class="o">=</span><span class="s1">'a'</span> <span class="nv">Visibility</span><span class="o">=</span><span class="s1">'package'</span> <span class="nv">Volatile</span><span class="o">=</span><span class="s1">'false'</span><span class="o">&gt;</span>
&lt;ModifierList <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> /&gt;
&lt;PrimitiveType <span class="nv">ArrayDepth</span><span class="o">=</span><span class="s1">'0'</span> <span class="nv">ArrayType</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ClassOrInterfaceType</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> <span class="nv">Kind</span><span class="o">=</span><span class="s1">'int'</span> <span class="nv">PrimitiveType</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">TypeImage</span><span class="o">=</span><span class="s1">'int'</span> /&gt;
&lt;VariableDeclarator <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span> <span class="nv">Initializer</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Name</span><span class="o">=</span><span class="s1">'a'</span><span class="o">&gt;</span>
&lt;VariableId <span class="nv">Abstract</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ArrayType</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">EffectiveVisibility</span><span class="o">=</span><span class="s1">'package'</span> <span class="nv">EnumConstant</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ExceptionBlockParameter</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Field</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">Final</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ForLoopVariable</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ForeachVariable</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">FormalParameter</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Image</span><span class="o">=</span><span class="s1">'a'</span> <span class="nv">LambdaParameter</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">LocalVariable</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Name</span><span class="o">=</span><span class="s1">'a'</span> <span class="nv">Native</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">PackagePrivate</span><span class="o">=</span><span class="s1">'true'</span> <span class="nv">PatternBinding</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Private</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Protected</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Public</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">RecordComponent</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ResourceDeclaration</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Static</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Strictfp</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Synchronized</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyAbstract</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyFinal</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyPublic</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">SyntacticallyStatic</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Transient</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">TypeInferred</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">VariableName</span><span class="o">=</span><span class="s1">'a'</span> <span class="nv">Visibility</span><span class="o">=</span><span class="s1">'package'</span> <span class="nv">Volatile</span><span class="o">=</span><span class="s1">'false'</span> /&gt;
&lt;/VariableDeclarator&gt;
&lt;/FieldDeclaration&gt;
&lt;/ClassBody&gt;
&lt;/ClassDeclaration&gt;
&lt;/CompilationUnit&gt;
<span class="nv">$ </span>xmlstarlet <span class="k">select</span> <span class="nt">-t</span> <span class="nt">-c</span> <span class="s2">"//VariableId[@VariableName='a']"</span> Foo.xml
&lt;VariableId <span class="nv">Abstract</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">ArrayType</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">EffectiveVisibility</span><span class="o">=</span><span class="s2">"package"</span> <span class="nv">EnumConstant</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">ExceptionBlockParameter</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Field</span><span class="o">=</span><span class="s2">"true"</span> <span class="nv">Final</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">ForLoopVariable</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">ForeachVariable</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">FormalParameter</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Image</span><span class="o">=</span><span class="s2">"a"</span> <span class="nv">LambdaParameter</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">LocalVariable</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Name</span><span class="o">=</span><span class="s2">"a"</span> <span class="nv">Native</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">PackagePrivate</span><span class="o">=</span><span class="s2">"true"</span> <span class="nv">PatternBinding</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Private</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Protected</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Public</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">RecordComponent</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">ResourceDeclaration</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Static</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Strictfp</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Synchronized</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">SyntacticallyAbstract</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">SyntacticallyFinal</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">SyntacticallyPublic</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">SyntacticallyStatic</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">Transient</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">TypeInferred</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">VariableName</span><span class="o">=</span><span class="s2">"a"</span> <span class="nv">Visibility</span><span class="o">=</span><span class="s2">"package"</span> <span class="nv">Volatile</span><span class="o">=</span><span class="s2">"false"</span>/&gt;
</code></pre></div></div>
<p>This example uses <a href="http://xmlstar.sourceforge.net/">xmlstarlet</a> to query the xml document for any variables/fields
with the name “a”.</p>
<h2 id="programmatic-usage">Programmatic usage</h2>
<p>Just parse your source code to get the AST and pass it on to the <code class="language-plaintext highlighter-rouge">XmlTreeRenderer</code>:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">java.io.IOException</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.LanguageProcessor</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.LanguageProcessorRegistry</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.LanguageRegistry</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.PmdCapableLanguage</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.ast.Parser</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.ast.RootNode</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.ast.SemanticErrorReporter</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.document.TextDocument</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.util.treeexport.XmlTreeRenderer</span><span class="o">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">TreeExportTest</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="nc">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="nc">IOException</span> <span class="o">{</span>
<span class="nc">PmdCapableLanguage</span> <span class="n">java</span> <span class="o">=</span> <span class="o">(</span><span class="nc">PmdCapableLanguage</span><span class="o">)</span> <span class="nc">LanguageRegistry</span><span class="o">.</span><span class="na">PMD</span><span class="o">.</span><span class="na">getLanguageById</span><span class="o">(</span><span class="s">"java"</span><span class="o">);</span>
<span class="nc">LanguageProcessor</span> <span class="n">processor</span> <span class="o">=</span> <span class="n">java</span><span class="o">.</span><span class="na">createProcessor</span><span class="o">(</span><span class="n">java</span><span class="o">.</span><span class="na">newPropertyBundle</span><span class="o">());</span>
<span class="nc">Parser</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">processor</span><span class="o">.</span><span class="na">services</span><span class="o">().</span><span class="na">getParser</span><span class="o">();</span>
<span class="k">try</span> <span class="o">(</span><span class="nc">TextDocument</span> <span class="n">textDocument</span> <span class="o">=</span> <span class="nc">TextDocument</span><span class="o">.</span><span class="na">readOnlyString</span><span class="o">(</span><span class="s">"class Foo { int a; }"</span><span class="o">,</span> <span class="n">java</span><span class="o">.</span><span class="na">getDefaultVersion</span><span class="o">());</span>
<span class="nc">LanguageProcessorRegistry</span> <span class="n">lpr</span> <span class="o">=</span> <span class="nc">LanguageProcessorRegistry</span><span class="o">.</span><span class="na">singleton</span><span class="o">(</span><span class="n">processor</span><span class="o">))</span> <span class="o">{</span>
<span class="nc">Parser</span><span class="o">.</span><span class="na">ParserTask</span> <span class="n">task</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Parser</span><span class="o">.</span><span class="na">ParserTask</span><span class="o">(</span><span class="n">textDocument</span><span class="o">,</span> <span class="nc">SemanticErrorReporter</span><span class="o">.</span><span class="na">noop</span><span class="o">(),</span> <span class="n">lpr</span><span class="o">);</span>
<span class="nc">RootNode</span> <span class="n">root</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="na">parse</span><span class="o">(</span><span class="n">task</span><span class="o">);</span>
<span class="k">new</span> <span class="nf">XmlTreeRenderer</span><span class="o">().</span><span class="na">renderSubtree</span><span class="o">(</span><span class="n">root</span><span class="o">,</span> <span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
<div class="tags">
<b>Tags: </b>
<a href="tag_userdocs.html" class="btn btn-outline-secondary navbar-btn cursorNorm" role="button">userdocs</a>
</div>
</div>
<footer>
<hr />
<div>
This documentation is written in markdown. <br />
If there is something missing or can be improved, edit this page on
github and create a PR:
<a
target="_blank"
href="https://github.com/pmd/pmd/blob/main/docs/pages/pmd/userdocs/extending/ast_dump.md"
role="button"
><i class="fab fa-github fa-lg"></i> Edit on GitHub</a
>
</div>
<hr />
<div class="row">
<div class="col-lg-12 footer">
&copy;2024 PMD Open Source Project. All rights
reserved. <br />
<span>Page last updated:</span>
January 2024 (7.0.0)<br /> Site last generated: Nov 21, 2024 <br />
<p>
<img src="images/logo/pmd-logo-70px.png" alt="PMD
logo"/>
</p>
</div>
</div>
</footer>
</div>
<!-- /.row -->
</div>
<!-- /.container -->
</div>
<!-- Sticky TOC column -->
<div class="toc-col">
<div id="toc"></div>
</div>
<!-- /.toc-container-wrapper -->
</div>
</div>
<script type="application/javascript" src="assets/jquery-3.5.1/jquery-3.5.1.min.js"></script>
<script type="application/javascript" src="assets/anchorjs-4.2.2/anchor.min.js"></script>
<script type="application/javascript" src="assets/navgoco-0.2.1/src/jquery.navgoco.min.js"></script>
<script type="application/javascript" src="assets/bootstrap-4.5.2-dist/js/bootstrap.bundle.min.js"></script>
<script type="application/javascript" src="assets/Simple-Jekyll-Search-1.0.8/dest/jekyll-search.js"></script>
<script type="application/javascript" src="assets/jekyll-table-of-contents/toc.js"></script>
<script type="application/javascript" src="js/tabstate.js"></script>
<script type="application/javascript" src="js/customscripts.js"></script>
</body>
</html>