phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
pmd/pmd_devdocs_experimental_ast_dump.html

1773 lines
58 KiB
HTML
Raw Blame 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="devdocsexperimental, ">
<title>Creating XML dump of the AST | PMD Source Code Analyzer</title>
<link rel="stylesheet" href="css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="css/modern-business.css">
<link rel="stylesheet" href="css/lavish-bootstrap.css">
<link rel="stylesheet" href="css/customstyles.css">
<link rel="stylesheet" href="css/theme-blue.css">
<link rel="stylesheet" href="css/pmd-customstyles.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="js/jquery.navgoco.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="js/toc.js"></script>
<script src="js/customscripts.js"></script>
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
<link rel="icon" href="images/favicon.ico" type="image/x-icon">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="" href="https://pmd.github.io/pmd/feed.xml">
<script>
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
</script>
<script>
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
</script>
<script>
$(document).ready(function() {
$("#tg-sb-link").click(function() {
$("#tg-sb-sidebar").toggle();
$("#tg-sb-content").toggleClass('col-md-9');
$("#tg-sb-content").toggleClass('col-md-12');
$("#tg-sb-icon").toggleClass('fa-toggle-on');
$("#tg-sb-icon").toggleClass('fa-toggle-off');
});
});
</script>
</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-inverse navbar-fixed-top">
<div class="container topnavlinks">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<!-- toggle sidebar button -->
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
<!-- entries without drop-downs appear here -->
<li><a href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
<li><a 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.-->
<!--comment out this block if you want to hide search-->
<li>
<!--start search-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="search...">
<ul id="results-container"></ul>
</div>
<script src="js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '<li><a href="{url}" title="Creating XML dump of the AST">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
</script>
<!--end search-->
</li>
</ul>
</div>
</div>
<!-- /.container -->
</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 6.54.0</li>
<div class="sidebarTitleDate">Release date: 28-January-2023</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_next_major_development.html">PMD 7.0.0 development</a></li>
<li><a href="pmd_about_help.html">Getting help</a></li>
</ul>
</li>
<li>
<a href="#">User Documentation</a>
<ul>
<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_metrics_howto.html">Using and defining code metrics</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>
</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_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="#">Ecmascript 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>
</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="#">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_vf.html">Index</a></li>
<li><a href="pmd_rules_vf_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="#">VM Rules</a>
<ul>
<li><a href="pmd_rules_vm.html">Index</a></li>
<li><a href="pmd_rules_vm_bestpractices.html">Best Practices</a></li>
<li><a href="pmd_rules_vm_design.html">Design</a></li>
<li><a href="pmd_rules_vm_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_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_jsp.html">JSP Support</a></li>
<li class="subfolders">
<a href="#">Java Support</a>
<ul>
<li><a href="pmd_languages_java.html">Java Versions</a></li>
<li><a href="pmd_java_metrics_index.html">Java Code Metrics</a></li>
</ul>
</li>
<li><a href="pmd_apex_metrics_index.html">Apex code metrics</a></li>
<li><a href="pmd_languages_plsql.html">PLSQL</a></li>
<li><a href="pmd_languages_visualforce.html">Visualforce</a></li>
<li><a href="pmd_languages_xml.html">XML and XML dialects</a></li>
<li><a href="pmd_languages_html.html">HTML</a></li>
<li><a href="pmd_languages_gherkin.html">Gherkin</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/master/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.html">Adding a new language</a></li>
<li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
<li><a href="pmd_devdocs_major_adding_new_metrics_framework.html">Adding metrics support to a language</a></li>
</ul>
</li>
<li class="subfolders">
<a href="#">Experimental features</a>
<ul>
<li class="active"><a href="pmd_devdocs_experimental_ast_dump.html">Creating (XML) dump of the AST</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_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>
<!-- if you aren't using the accordion, uncomment this block:
<p class="external">
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
</p>
-->
</ul>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
</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/master/docs/pages/pmd/devdocs/experimental/ast_dump.md"
class="pull-right"
role="button"
><i class="fa 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/master/docs/pages/pmd/devdocs/experimental/ast_dump.md">
<div class="summary">Creating a XML representation of the AST allows to analyze the AST with other tools.</div>
<div id="inline-toc"><!-- empty, move TOC here when screen size too small --></div>
<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>run.sh ast-dump <span class="nt">--help</span>
Usage: ast-dump <span class="o">[</span>options]
Options:
<span class="nt">--encoding</span>, <span class="nt">-e</span>
Encoding of the <span class="nb">source </span>file.
Default: UTF-8
<span class="nt">--file</span>
The file to dump
<span class="nt">--format</span>, <span class="nt">-f</span>
The output format.
Default: xml
<span class="nt">--help</span>, <span class="nt">-h</span>
Display usage.
<span class="nt">--language</span>, <span class="nt">-l</span>
Specify the language to use.
Default: java
<span class="nt">--read-stdin</span>, <span class="nt">-i</span>
Read <span class="nb">source </span>from standard input
Default: <span class="nb">false</span>
<span class="nt">-P</span>
Properties <span class="k">for </span>the renderer.
Syntax: <span class="nt">-Pkey</span><span class="o">=</span>value
Default: <span class="o">{}</span>
Available languages: apex ecmascript java jsp modelica plsql pom scala text vf vm wsdl xml xsl
Available formats: xml XML format with the same structure as the one used <span class="k">in </span>XPath
+ Properties
+ singleQuoteAttributes Use single quotes to delimit attribute values <span class="o">(</span>default <span class="nb">true</span><span class="o">)</span>
+ lineSeparator Line separator to use. The default is platform-specific. <span class="o">(</span>default <span class="se">\n</span><span class="o">)</span>
+ renderProlog True to output a prolog <span class="o">(</span>default <span class="nb">true</span><span class="o">)</span>
+ renderCommonAttributes True to render attributes like BeginLine, EndLine, etc. <span class="o">(</span>default <span class="nb">false</span><span class="o">)</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>run.sh 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="nt">-------------------------------------------------------------------------------</span>
This <span class="nb">command </span>line utility is experimental. It might change at any <span class="nb">time </span>without
prior notice.
<span class="nt">-------------------------------------------------------------------------------</span>
<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="nv">declarationsAreInDefaultPackage</span><span class="o">=</span><span class="s1">'true'</span><span class="o">&gt;</span>
&lt;TypeDeclaration <span class="nv">Image</span><span class="o">=</span><span class="s1">''</span><span class="o">&gt;</span>
&lt;ClassOrInterfaceDeclaration <span class="nv">Abstract</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">Default</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">Modifiers</span><span class="o">=</span><span class="s1">'1'</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">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">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">Transient</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">TypeKind</span><span class="o">=</span><span class="s1">'CLASS'</span> <span class="nv">Volatile</span><span class="o">=</span><span class="s1">'false'</span><span class="o">&gt;</span>
&lt;ClassOrInterfaceBody <span class="nv">AnonymousInnerClass</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">EnumChild</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="o">&gt;</span>
&lt;ClassOrInterfaceBodyDeclaration <span class="nv">AnonymousInnerClass</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">EnumChild</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">'FIELD'</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">AnnotationMember</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Array</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ArrayDepth</span><span class="o">=</span><span class="s1">'0'</span> <span class="nv">Default</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">''</span> <span class="nv">InterfaceMember</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Modifiers</span><span class="o">=</span><span class="s1">'0'</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">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">Volatile</span><span class="o">=</span><span class="s1">'false'</span><span class="o">&gt;</span>
&lt;Type <span class="nv">Array</span><span class="o">=</span><span class="s1">'false'</span> <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">Image</span><span class="o">=</span><span class="s1">''</span> <span class="nv">TypeImage</span><span class="o">=</span><span class="s1">'int'</span><span class="o">&gt;</span>
&lt;PrimitiveType <span class="nv">Array</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ArrayDepth</span><span class="o">=</span><span class="s1">'0'</span> <span class="nv">Boolean</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">Image</span><span class="o">=</span><span class="s1">'int'</span> /&gt;
&lt;/Type&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;VariableDeclaratorId <span class="nv">Array</span><span class="o">=</span><span class="s1">'false'</span> <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">ExceptionBlockParameter</span><span class="o">=</span><span class="s1">'false'</span> <span class="nv">ExplicitReceiverParameter</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">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">ResourceDeclaration</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> /&gt;
&lt;/VariableDeclarator&gt;
&lt;/FieldDeclaration&gt;
&lt;/ClassOrInterfaceBodyDeclaration&gt;
&lt;/ClassOrInterfaceBody&gt;
&lt;/ClassOrInterfaceDeclaration&gt;
&lt;/TypeDeclaration&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">"//VariableDeclaratorId[@VariableName='a']"</span> Foo.xml
&lt;VariableDeclaratorId <span class="nv">Array</span><span class="o">=</span><span class="s2">"false"</span> <span class="nv">ArrayDepth</span><span class="o">=</span><span class="s2">"0"</span> <span class="nv">ArrayType</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">ExplicitReceiverParameter</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">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">ResourceDeclaration</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>/&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">java.io.StringReader</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.LanguageVersionHandler</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.Parser</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.pmd.lang.ast.Node</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">TreeExport</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">LanguageVersionHandler</span> <span class="n">java</span> <span class="o">=</span> <span class="nc">LanguageRegistry</span><span class="o">.</span><span class="na">getLanguage</span><span class="o">(</span><span class="s">"Java"</span><span class="o">).</span><span class="na">getDefaultVersion</span><span class="o">().</span><span class="na">getLanguageVersionHandler</span><span class="o">();</span>
<span class="nc">Parser</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">java</span><span class="o">.</span><span class="na">getParser</span><span class="o">(</span><span class="n">java</span><span class="o">.</span><span class="na">getDefaultParserOptions</span><span class="o">());</span>
<span class="nc">Node</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="s">"foo"</span><span class="o">,</span> <span class="k">new</span> <span class="nc">StringReader</span><span class="o">(</span><span class="s">"class Foo {}"</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>
</code></pre></div></div>
<div class="tags">
<b>Tags: </b>
<a href="tag_devdocs.html" class="btn btn-default navbar-btn cursorNorm" role="button">devdocs</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/master/docs/pages/pmd/devdocs/experimental/ast_dump.md"
role="button"
><i class="fa fa-github fa-lg"></i> Edit on GitHub</a
>
</div>
<hr />
<div class="row">
<div class="col-lg-12 footer">
&copy;2023 PMD Open Source Project. All rights
reserved. <br />
<span>Page last updated:</span>
January 17, 2020 (6.21.0)<br /> Site last generated: Jan 28, 2023 <br />
<p>
<img src="images/pmd-logo-small.png" alt="Company
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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink