+++ /dev/null
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-<head>
-<!-- 2022-07-13 Wed 04:26 -->
-<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
-<meta name="viewport" content="width=device-width, initial-scale=1" />
-<title>JavaInspect - Utility to visualize java software</title>
-<meta name="author" content="Svjatoslav Agejenko" />
-<meta name="generator" content="Org Mode" />
-<style>
- #content { max-width: 60em; margin: auto; }
- .title { text-align: center;
- margin-bottom: .2em; }
- .subtitle { text-align: center;
- font-size: medium;
- font-weight: bold;
- margin-top:0; }
- .todo { font-family: monospace; color: red; }
- .done { font-family: monospace; color: green; }
- .priority { font-family: monospace; color: orange; }
- .tag { background-color: #eee; font-family: monospace;
- padding: 2px; font-size: 80%; font-weight: normal; }
- .timestamp { color: #bebebe; }
- .timestamp-kwd { color: #5f9ea0; }
- .org-right { margin-left: auto; margin-right: 0px; text-align: right; }
- .org-left { margin-left: 0px; margin-right: auto; text-align: left; }
- .org-center { margin-left: auto; margin-right: auto; text-align: center; }
- .underline { text-decoration: underline; }
- #postamble p, #preamble p { font-size: 90%; margin: .2em; }
- p.verse { margin-left: 3%; }
- pre {
- border: 1px solid #e6e6e6;
- border-radius: 3px;
- background-color: #f2f2f2;
- padding: 8pt;
- font-family: monospace;
- overflow: auto;
- margin: 1.2em;
- }
- pre.src {
- position: relative;
- overflow: auto;
- }
- pre.src:before {
- display: none;
- position: absolute;
- top: -8px;
- right: 12px;
- padding: 3px;
- color: #555;
- background-color: #f2f2f299;
- }
- pre.src:hover:before { display: inline; margin-top: 14px;}
- /* Languages per Org manual */
- pre.src-asymptote:before { content: 'Asymptote'; }
- pre.src-awk:before { content: 'Awk'; }
- pre.src-authinfo::before { content: 'Authinfo'; }
- pre.src-C:before { content: 'C'; }
- /* pre.src-C++ doesn't work in CSS */
- pre.src-clojure:before { content: 'Clojure'; }
- pre.src-css:before { content: 'CSS'; }
- pre.src-D:before { content: 'D'; }
- pre.src-ditaa:before { content: 'ditaa'; }
- pre.src-dot:before { content: 'Graphviz'; }
- pre.src-calc:before { content: 'Emacs Calc'; }
- pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
- pre.src-fortran:before { content: 'Fortran'; }
- pre.src-gnuplot:before { content: 'gnuplot'; }
- pre.src-haskell:before { content: 'Haskell'; }
- pre.src-hledger:before { content: 'hledger'; }
- pre.src-java:before { content: 'Java'; }
- pre.src-js:before { content: 'Javascript'; }
- pre.src-latex:before { content: 'LaTeX'; }
- pre.src-ledger:before { content: 'Ledger'; }
- pre.src-lisp:before { content: 'Lisp'; }
- pre.src-lilypond:before { content: 'Lilypond'; }
- pre.src-lua:before { content: 'Lua'; }
- pre.src-matlab:before { content: 'MATLAB'; }
- pre.src-mscgen:before { content: 'Mscgen'; }
- pre.src-ocaml:before { content: 'Objective Caml'; }
- pre.src-octave:before { content: 'Octave'; }
- pre.src-org:before { content: 'Org mode'; }
- pre.src-oz:before { content: 'OZ'; }
- pre.src-plantuml:before { content: 'Plantuml'; }
- pre.src-processing:before { content: 'Processing.js'; }
- pre.src-python:before { content: 'Python'; }
- pre.src-R:before { content: 'R'; }
- pre.src-ruby:before { content: 'Ruby'; }
- pre.src-sass:before { content: 'Sass'; }
- pre.src-scheme:before { content: 'Scheme'; }
- pre.src-screen:before { content: 'Gnu Screen'; }
- pre.src-sed:before { content: 'Sed'; }
- pre.src-sh:before { content: 'shell'; }
- pre.src-sql:before { content: 'SQL'; }
- pre.src-sqlite:before { content: 'SQLite'; }
- /* additional languages in org.el's org-babel-load-languages alist */
- pre.src-forth:before { content: 'Forth'; }
- pre.src-io:before { content: 'IO'; }
- pre.src-J:before { content: 'J'; }
- pre.src-makefile:before { content: 'Makefile'; }
- pre.src-maxima:before { content: 'Maxima'; }
- pre.src-perl:before { content: 'Perl'; }
- pre.src-picolisp:before { content: 'Pico Lisp'; }
- pre.src-scala:before { content: 'Scala'; }
- pre.src-shell:before { content: 'Shell Script'; }
- pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
- /* additional language identifiers per "defun org-babel-execute"
- in ob-*.el */
- pre.src-cpp:before { content: 'C++'; }
- pre.src-abc:before { content: 'ABC'; }
- pre.src-coq:before { content: 'Coq'; }
- pre.src-groovy:before { content: 'Groovy'; }
- /* additional language identifiers from org-babel-shell-names in
- ob-shell.el: ob-shell is the only babel language using a lambda to put
- the execution function name together. */
- pre.src-bash:before { content: 'bash'; }
- pre.src-csh:before { content: 'csh'; }
- pre.src-ash:before { content: 'ash'; }
- pre.src-dash:before { content: 'dash'; }
- pre.src-ksh:before { content: 'ksh'; }
- pre.src-mksh:before { content: 'mksh'; }
- pre.src-posh:before { content: 'posh'; }
- /* Additional Emacs modes also supported by the LaTeX listings package */
- pre.src-ada:before { content: 'Ada'; }
- pre.src-asm:before { content: 'Assembler'; }
- pre.src-caml:before { content: 'Caml'; }
- pre.src-delphi:before { content: 'Delphi'; }
- pre.src-html:before { content: 'HTML'; }
- pre.src-idl:before { content: 'IDL'; }
- pre.src-mercury:before { content: 'Mercury'; }
- pre.src-metapost:before { content: 'MetaPost'; }
- pre.src-modula-2:before { content: 'Modula-2'; }
- pre.src-pascal:before { content: 'Pascal'; }
- pre.src-ps:before { content: 'PostScript'; }
- pre.src-prolog:before { content: 'Prolog'; }
- pre.src-simula:before { content: 'Simula'; }
- pre.src-tcl:before { content: 'tcl'; }
- pre.src-tex:before { content: 'TeX'; }
- pre.src-plain-tex:before { content: 'Plain TeX'; }
- pre.src-verilog:before { content: 'Verilog'; }
- pre.src-vhdl:before { content: 'VHDL'; }
- pre.src-xml:before { content: 'XML'; }
- pre.src-nxml:before { content: 'XML'; }
- /* add a generic configuration mode; LaTeX export needs an additional
- (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
- pre.src-conf:before { content: 'Configuration File'; }
-
- table { border-collapse:collapse; }
- caption.t-above { caption-side: top; }
- caption.t-bottom { caption-side: bottom; }
- td, th { vertical-align:top; }
- th.org-right { text-align: center; }
- th.org-left { text-align: center; }
- th.org-center { text-align: center; }
- td.org-right { text-align: right; }
- td.org-left { text-align: left; }
- td.org-center { text-align: center; }
- dt { font-weight: bold; }
- .footpara { display: inline; }
- .footdef { margin-bottom: 1em; }
- .figure { padding: 1em; }
- .figure p { text-align: center; }
- .equation-container {
- display: table;
- text-align: center;
- width: 100%;
- }
- .equation {
- vertical-align: middle;
- }
- .equation-label {
- display: table-cell;
- text-align: right;
- vertical-align: middle;
- }
- .inlinetask {
- padding: 10px;
- border: 2px solid gray;
- margin: 10px;
- background: #ffffcc;
- }
- #org-div-home-and-up
- { text-align: right; font-size: 70%; white-space: nowrap; }
- textarea { overflow-x: auto; }
- .linenr { font-size: smaller }
- .code-highlighted { background-color: #ffff00; }
- .org-info-js_info-navigation { border-style: none; }
- #org-info-js_console-label
- { font-size: 10px; font-weight: bold; white-space: nowrap; }
- .org-info-js_search-highlight
- { background-color: #ffff00; color: #000000; font-weight: bold; }
- .org-svg { }
-</style>
-<link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
-<style type="text/css">
-footer {background-color: #111 !important;}
-pre {background-color: #111; color: #ccc;}
-</style>
-<link rel="stylesheet" type="text/css" href="https://thomasf.github.io/solarized-css/solarized-dark.min.css" />
-</head>
-<body>
-<div id="content" class="content">
-<h1 class="title">JavaInspect - Utility to visualize java software</h1>
-<div id="table-of-contents" role="doc-toc">
-<h2>Table of Contents</h2>
-<div id="text-table-of-contents" role="doc-toc">
-<ul>
-<li><a href="#org6c08335">1. General</a>
-<ul>
-<li><a href="#org1f40be1">1.1. Source code</a></li>
-</ul>
-</li>
-<li><a href="#org05e5b28">2. Goal and operating principle</a></li>
-<li><a href="#org3ca1849">3. Example graphs</a></li>
-<li><a href="#orga20e9d8">4. Installation</a></li>
-<li><a href="#orgf9f5b99">5. Usage</a>
-<ul>
-<li><a href="#org952985c">5.1. Usage as commandline utility</a>
-<ul>
-<li><a href="#org78673fb">5.1.1. Available commandline arguments</a></li>
-<li><a href="#orgbf7fb2b">5.1.2. Specifying classes to render</a></li>
-</ul>
-</li>
-<li><a href="#orgc792989">5.2. Usage via Java API</a>
-<ul>
-<li><a href="#org68fe457">5.2.1. Example 1: individually picked objects</a></li>
-<li><a href="#orge4c6237">5.2.2. Example 2: GraphViz embedded in another project</a></li>
-<li><a href="#org851b3a6">5.2.3. Embedding JavaInspect in your Maven project</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li><a href="#orgdb7d308">6. TO DO</a></li>
-<li><a href="#org30b046f">7. See also</a></li>
-</ul>
-</div>
-</div>
-
-<div id="outline-container-org6c08335" class="outline-2">
-<h2 id="org6c08335"><span class="section-number-2">1.</span> General</h2>
-<div class="outline-text-2" id="text-1">
-<ul class="org-ul">
-<li>This program is free software: you can redistribute it and/or modify
-it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
-published by the Free Software Foundation, either version 3 of the
-License, or (at your option) any later version.</li>
-
-<li>Program authors:
-<ul class="org-ul">
-<li>Svjatoslav Agejenko
-<ul class="org-ul">
-<li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a></li>
-<li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a></li>
-<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a></li>
-</ul></li>
-
-<li>Tony Bargnesi
-<ul class="org-ul">
-<li>GitHub fork for the project:
-<a href="https://github.com/abargnesi/javainspect">https://github.com/abargnesi/javainspect</a></li>
-</ul></li>
-</ul></li>
-</ul>
-</div>
-
-<div id="outline-container-org1f40be1" class="outline-3">
-<h3 id="org1f40be1"><span class="section-number-3">1.1.</span> Source code</h3>
-<div class="outline-text-3" id="text-1-1">
-<ul class="org-ul">
-<li><a href="https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
-
-<li><a href="https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=summary">Browse Git repository online</a></li>
-
-<li><p>
-Clone Git repository using command:
-</p>
-<pre class="example">
-git clone https://www2.svjatoslav.eu/git/javainspect.git
-</pre></li>
-</ul>
-</div>
-</div>
-</div>
-
-<div id="outline-container-org05e5b28" class="outline-2">
-<h2 id="org05e5b28"><span class="section-number-2">2.</span> Goal and operating principle</h2>
-<div class="outline-text-2" id="text-2">
-<p>
-Goal: simplify/speed up understanding the computer program code by
-automatically visualizing its structure.
-</p>
-
-<p>
-<a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
-</p>
-
-<p>
-JavaInspect can be used as a <a href="#org952985c">standalone commandline utility</a> as well as
-<a href="#orgc792989">java library</a>. JavaInspect uses primarily Java built-in reflection to
-discover and visualize any part of Java program.
-</p>
-
-<p>
-JavaInspect currently has no graphical user interface, configuration
-files, embedded scripting support, direct Maven, Gradle or Ant
-integration. See <a href="#orgf9f5b99">usage</a> to learn how to instuct Javainspect what to do.
-</p>
-
-<p>
-After discovering application structure and optionally filtering out
-unimportant parts, JavaInspect produces GraphViz dot file that
-describes data to be visualized. Then launches <a href="https://graphviz.org/">GraphViz</a> to generate
-bitmap graph in PNG or SVG format.
-</p>
-
-<p>
-Notes:
-</p>
-<ul class="org-ul">
-<li>JavaInspect is developed and tested so far only on GNU/Linux.</li>
-</ul>
-</div>
-</div>
-
-<div id="outline-container-org3ca1849" class="outline-2">
-<h2 id="org3ca1849"><span class="section-number-2">3.</span> Example graphs</h2>
-<div class="outline-text-2" id="text-3">
-<ul class="org-ul">
-<li><p>
-A very simple example:
-</p>
-
-
-<div id="orgb13f634" class="figure">
-<p><a href="example.png"><img src="example-thumbnail.png" alt="example-thumbnail.png" /></a>
-</p>
-</div>
-
-<p>
-Graph legend:
-</p>
-
-
-<div id="orgdad6849" class="figure">
-<p><img src="legend.png" alt="legend.png" />
-</p>
-</div></li>
-</ul>
-
-
-<ul class="org-ul">
-<li><a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.</li>
-</ul>
-</div>
-</div>
-
-<div id="outline-container-orga20e9d8" class="outline-2">
-<h2 id="orga20e9d8"><span class="section-number-2">4.</span> Installation</h2>
-<div class="outline-text-2" id="text-4">
-<p>
-<a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on the computer.
-</p>
-
-<p>
-On Ubuntu/Debian GraphViz can be installed using:
-</p>
-<div class="org-src-container">
-<pre class="src src-sh">sudo apt-get install graphviz
-</pre>
-</div>
-
-<p>
-To use JavaInspect via Java API, no further installation is
-needed. JavaInspect will be embedded into your project as dependency.
-This is described in <a href="#orgc792989">usage via Java API</a>. It will expect GraphViz to be
-available in the system.
-</p>
-
-<p>
-To use JavaInspect as a commandline tool, JavaInspect source
-repository has to be cloned locally: See <a href="#org1f40be1">Source code</a>.
-</p>
-
-<p>
-Then study and execute installation script:
-</p>
-<pre class="example">
-commandline launcher/install
-</pre>
-
-
-<p>
-After installation, new commandline tool should be available
-</p>
-<pre class="example">
-javainspect
-</pre>
-
-
-<p>
-Quick commandline usage help can be viewed by issuing
-</p>
-<pre class="example">
-javainspect --help
-</pre>
-</div>
-</div>
-
-<div id="outline-container-orgf9f5b99" class="outline-2">
-<h2 id="orgf9f5b99"><span class="section-number-2">5.</span> Usage</h2>
-<div class="outline-text-2" id="text-5">
-<p>
-JavaInspect can be controlled in 2 different ways:
-</p>
-<ul class="org-ul">
-<li><a href="#org952985c">as standalone commandline utility</a></li>
-<li><a href="#orgc792989">as embedded Java library via Java API</a></li>
-</ul>
-</div>
-
-<div id="outline-container-org952985c" class="outline-3">
-<h3 id="org952985c"><span class="section-number-3">5.1.</span> Usage as commandline utility</h3>
-<div class="outline-text-3" id="text-5-1">
-</div>
-<div id="outline-container-org78673fb" class="outline-4">
-<h4 id="org78673fb"><span class="section-number-4">5.1.1.</span> Available commandline arguments</h4>
-<div class="outline-text-4" id="text-5-1-1">
-<p class="verse">
--j (existing files)…<br />
-    JAR file(s) to render.<br />
-<br />
--c (existing directories)…<br />
-    Classpath directories<br />
-<br />
--n (string)<br />
-    Graph name. (default: "graph")<br />
-<br />
-–debug<br />
-    Show debug info.<br />
-<br />
--h, –help<br />
-    Show commandline usage help.<br />
-<br />
--k<br />
-    Keep dot file.<br />
-<br />
--ho<br />
-    Hide orphaned classes.<br />
-<br />
--w (one to many strings)…<br />
-    Whitelist glob(s).<br />
-<br />
--b (one to many strings)…<br />
-    Blacklist glob(s).<br />
-<br />
--r (one to many strings)…<br />
-    root class(es).<br />
-<br />
--d (existing directory)<br />
-    Target directory. Default is current directory.<br />
-<br />
--t (options: png, svg)<br />
-    Target image type. Default is: svg.<br />
-</p>
-</div>
-</div>
-<div id="outline-container-orgbf7fb2b" class="outline-4">
-<h4 id="orgbf7fb2b"><span class="section-number-4">5.1.2.</span> Specifying classes to render</h4>
-<div class="outline-text-4" id="text-5-1-2">
-<p>
-Normal Java application has immense complexity. In addition to code
-that was directly written by particular project developers, lots of
-functionality is typically added as frameworks or libraries to the
-project. In addition there is significant Java standard library.
-</p>
-
-<p>
-Because JavaInspect uses reflection, it does not easily distinguish
-between those. In normal situation you would rather want to visualize
-only code that was developed specifically for your project and leave
-frameworks like Spring etc. out. If you visualize all classes that are
-possibly reachable from you project, you will easily get huge and
-incomprehensible graph.
-</p>
-
-<p>
-JavaInspect can digest compiled Java classes in 2 modes:
-</p>
-<ol class="org-ol">
-<li>Provide list of Jar files. Use <b>-j</b> option.</li>
-<li>Provide list of filesystem directories that can be used as
-classpath root. Use <b>-c</b> option.</li>
-</ol>
-
-<p>
-Currently JavaInspect uses following algorithm to add classes to
-rendered graph:
-</p>
-
-<ul class="org-ul">
-<li>All classes that were found in Jar files are added to graph by default.</li>
-<li>None of the classes that were found in filesystem directories are
-added to the graph by default (unless explicitly referenced). (TODO:
-for consistency it would be better to add them too by default)</li>
-<li>If whitelist is specified (<b>-w</b> option) everything that is not
-matched by whitelist pattern(s) will be removed from the graph.</li>
-<li>If blacklist is specified (<b>-b</b> option) everything that is matched
-by blacklist pattern(s) will be removed from the graph.</li>
-<li>Root classes can be specified using <b>-r</b> option. Root classes will
-be added to the graph. JavaInspect will then try to recursively
-discover all classes that were referenced by root class and add
-those also to the graph.</li>
-</ul>
-</div>
-</div>
-</div>
-
-<div id="outline-container-orgc792989" class="outline-3">
-<h3 id="orgc792989"><span class="section-number-3">5.2.</span> Usage via Java API</h3>
-<div class="outline-text-3" id="text-5-2">
-<p>
-Requires that classes to be visualised are available in the classpath.
-</p>
-
-<p>
-To get JavaInspect into same classpath with your projecs I so far came
-up with 2 solutions:
-</p>
-
-<ol class="org-ol">
-<li>Add JavaInspect library in your project as a dependency.</li>
-
-<li>Create new Java project for the purpose visualizing your other
-projects and include JavaInspect and your projecs binary artifacts
-(Jar's) into new project classpath. Built binary Jar's (with no
-source code) are sufficient because JavaInspect operates via
-reflection.</li>
-</ol>
-
-<p>
-Simple Java based control/configuration code needs to be written for
-each project. I usually put such code into directories devoted for
-JUnit tests. Because it needs not to be compiled/embedded into final
-product or project artifact I'm just willing to visualize.
-</p>
-
-<p>
-Control code in general does the following:
-</p>
-<ol class="org-ol">
-<li>Create graph object.</li>
-<li>Java reflection/classloaders does not provide mechanism for
-discovering all classes under given package. Therefore you need to
-declare at least some classes to be added to the graph by manually
-adding individual classes to the graph. For every class added to
-the graph, GraphViz will recursively inspect it and add all
-referecned classes to the graph as well.</li>
-<li>Graphs easilly get very big and complex so optionally we filter
-important code using classname <a href="https://en.wikipedia.org/wiki/Glob_(programming)">glob</a> patterns based blacklist and/or
-whitelist.</li>
-<li>Optionally we can tune some rendering parameters like:
-<ul class="org-ul">
-<li>Possibility to remove orphaned classes (classes with no
-references) from the graph.</li>
-<li>Specify target directory for generated visualization
-files. (Default is current directory)</li>
-<li>Keep intermediate GraphViz dot file for later inspection.</li>
-</ul></li>
-<li>Render graph.</li>
-</ol>
-</div>
-
-
-<div id="outline-container-org68fe457" class="outline-4">
-<h4 id="org68fe457"><span class="section-number-4">5.2.1.</span> Example 1: individually picked objects</h4>
-<div class="outline-text-4" id="text-5-2-1">
-<p>
-This example demonstrates generating of class graph from hand picked
-classes and visualizing GraphViz itself.
-</p>
-
-<div class="org-src-container">
-<pre class="src src-java">
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Create graph</span>
-<span style="color: #F92672;">final</span> <span style="color: #66D9EF;">ClassGraph</span> <span style="color: #FD971F;">graph</span> = <span style="color: #F92672;">new</span> <span style="color: #66D9EF;">ClassGraph</span>();
-
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Add some random object to the graph. GraphViz will detect Class from</span>
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">the object.</span>
-graph.add(graph);
-
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Also add some random class to the graph.</span>
-graph.add(Utils.<span style="color: #F92672;">class</span>);
-
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Keep intermediary GraphViz DOT file for reference.</span>
-graph.setKeepDotFile(<span style="color: #FF80F4;">true</span>);
-
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">Produce bitmap image titled "JavaInspect.png" to the user Desktop</span>
-<span style="color: #8C8C8C;">// </span><span style="color: #8C8C8C;">directory</span>
-graph.generateGraph(<span style="color: #EEDC82;">"JavaInspect"</span>);
-
-</pre>
-</div>
-
-<p>
-Note: if desired, more compact version of the above:
-</p>
-<div class="org-src-container">
-<pre class="src src-java"><span style="color: #F92672;">new</span> <span style="color: #66D9EF;">ClassGraph</span>().add(randomObject, RandomClass.<span style="color: #F92672;">class</span>)
- .setKeepDotFile(<span style="color: #FF80F4;">true</span>).generateGraph(<span style="color: #EEDC82;">"JavaInspect"</span>);
-</pre>
-</div>
-
-
-<p>
-Result:
-</p>
-<ul class="org-ul">
-<li>Generated DOT file: <a href="JavaInspect.dot">JavaInspect.dot</a></li>
-<li>Generated PNG image: <a href="JavaInspect.png">JavaInspect.png</a></li>
-</ul>
-</div>
-</div>
-
-<div id="outline-container-orge4c6237" class="outline-4">
-<h4 id="orge4c6237"><span class="section-number-4">5.2.2.</span> Example 2: GraphViz embedded in another project</h4>
-<div class="outline-text-4" id="text-5-2-2">
-<ol class="org-ol">
-<li>Download project Sixth <a href="https://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz">code snapshot</a>.</li>
-<li>Inspect and run <b>DataGraph.java</b>.</li>
-</ol>
-</div>
-</div>
-
-<div id="outline-container-org851b3a6" class="outline-4">
-<h4 id="org851b3a6"><span class="section-number-4">5.2.3.</span> Embedding JavaInspect in your Maven project</h4>
-<div class="outline-text-4" id="text-5-2-3">
-<p>
-Declare JavaInspect as dependency:
-</p>
-<div class="org-src-container">
-<pre class="src src-xml"><<span style="color: #A6E22E;">dependencies</span>>
- ...
- <<span style="color: #A6E22E;">dependency</span>>
- <<span style="color: #A6E22E;">groupId</span>>eu.svjatoslav</<span style="color: #A6E22E;">groupId</span>>
- <<span style="color: #A6E22E;">artifactId</span>>javainspect</<span style="color: #A6E22E;">artifactId</span>>
- <<span style="color: #A6E22E;">version</span>>1.7</<span style="color: #A6E22E;">version</span>>
- </<span style="color: #A6E22E;">dependency</span>>
- ...
-</<span style="color: #A6E22E;">dependencies</span>>
-</pre>
-</div>
-
-
-<p>
-Add Maven repository to retrieve artifact from:
-</p>
-<div class="org-src-container">
-<pre class="src src-xml"><<span style="color: #A6E22E;">repositories</span>>
- ...
- <<span style="color: #A6E22E;">repository</span>>
- <<span style="color: #A6E22E;">id</span>>svjatoslav.eu</<span style="color: #A6E22E;">id</span>>
- <<span style="color: #A6E22E;">name</span>>Svjatoslav repository</<span style="color: #A6E22E;">name</span>>
- <<span style="color: #A6E22E;">url</span>>http://www3.svjatoslav.eu/maven/</<span style="color: #A6E22E;">url</span>>
- </<span style="color: #A6E22E;">repository</span>>
- ...
-</<span style="color: #A6E22E;">repositories</span>>
-</pre>
-</div>
-</div>
-</div>
-</div>
-</div>
-
-<div id="outline-container-orgdb7d308" class="outline-2">
-<h2 id="orgdb7d308"><span class="section-number-2">6.</span> TO DO</h2>
-<div class="outline-text-2" id="text-6">
-<p>
-Note: Because this is side project (and I have many of them) I can
-only contribute few hours per year at average. Any help is welcome. A
-LOT of cool ideas could be implemented. For intstance:
-</p>
-
-<ul class="org-ul">
-<li>BUG: Should not hide references if there are too many of them to
-classes if referring classes are not visible anyway because of
-blacklist/whitelist rules. Basically reference counting should
-exclude not visible classes.</li>
-
-<li>BUG: Orphaned class removal does not work always. There are many
-bugs and corner cases to find and fix still.</li>
-
-<li>BUG: Code is not very readable. Document and refactor for better
-maintainability.</li>
-
-<li>FEATURE: Create installable DEB package.
-<ul class="org-ul">
-<li>Submit it to some Debian developer for integration or become
-Debian package maintainer.</li>
-</ul></li>
-
-<li>FEATURE: Make it modular. That is: central part, an application
-model could be standalone and serializable.
-
-<ul class="org-ul">
-<li>There could be multiple ways to acquire model:
-<ul class="org-ul">
-<li>By introspecting application via Java reflections (current mode
-of operation).</li>
-<li>By parsing java source. (unfinished)</li>
-</ul></li>
-
-<li>There could be ways to manipulate model:
-<ul class="org-ul">
-<li>Store/load/compare.</li>
-<li>Trim uninteresting parts.</li>
-<li>Highlight important parts.</li>
-</ul></li>
-
-<li>There could be multiple ways to render model:
-<ul class="org-ul">
-<li>PNG/SVG (currently implemented)</li>
-<li>PlantUML (TODO)</li>
-<li>Interactive 3D visualization (TODO)</li>
-</ul></li>
-</ul></li>
-
-<li>FEATURE: Implement (or integrate existing java parser
-<a href="https://javaparser.org/">https://javaparser.org/</a>) to be able to produce code visualizations
-based on source code (in addition to current reflection based
-approach).</li>
-
-<li>FEATURE: Integarte with <a href="http://plantuml.com/class-diagram">PlantUML</a>.</li>
-
-<li>FEATURE: Add dark theme for generated graphs.</li>
-
-<li>FEATURE: Sort Class fields by alphabet.</li>
-
-<li>FEATURE: Visualize also concrete field values so it could be used as
-ultra cool runtime logging/debugging framework.</li>
-
-<li>FEATURE: Possibility to visualize structure and data from JVM
-snapshot.</li>
-
-<li>FEATURE: Possibility to attach to remote process to visualize
-data/structure using JVM debug port and mechanism.</li>
-
-<li>FEATURE: Possibility to attach to JVM using JVM agent.</li>
-
-<li>FEATURE: Possibility to inspect graphs in 3D using <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D engine</a>.</li>
-
-<li>FEATURE: Possibility to select classes/fields/values to be
-visualized in some graph query language. For greater flexibility in
-comparison to currently supported glob syntax.</li>
-
-<li>FEATURE: Add option to control JavaInspect via JSON or XML config
-file. For example different graphs for given project could be
-defined once in plain text config, possibly with the aid of some
-interactive utility. Then defined graphs could be updated as part of
-project build or release process.</li>
-
-<li>FEATURE: Configurable maven plugin to generate graphs as part of the
-project build/release process.</li>
-</ul>
-</div>
-</div>
-<div id="outline-container-org30b046f" class="outline-2">
-<h2 id="org30b046f"><span class="section-number-2">7.</span> See also</h2>
-<div class="outline-text-2" id="text-7">
-<p>
-Similar or alternative solutions:
-</p>
-<ul class="org-ul">
-<li><a href="http://www.class-visualizer.net/">http://www.class-visualizer.net/</a></li>
-<li><a href="https://github.com/pahen/madge">Madge - similar tool for JavaScript</a></li>
-</ul>
-</div>
-</div>
-</div>
-<div id="postamble" class="status">
-<p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2022-07-13 Wed 04:26</p>
-<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
-</div>
-</body>
-</html>
projects / javainspect.git / commitdiff