-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUsingOPAL.html
More file actions
190 lines (168 loc) · 12.4 KB
/
UsingOPAL.html
File metadata and controls
190 lines (168 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<!DOCTYPE HTML>
<html>
<head>
<title>Using OPAL</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<script src="/js/jquery.min.js"></script>
<script src="/js/skel.min.js"></script>
<script src="/js/skel-layers.min.js"></script>
<script src="/js/init.js"></script>
<script src="/js/highlight.pack.js"></script>
<link rel="stylesheet" href="/css/highlight/github.css" />
<noscript>
<link rel="stylesheet" href="/css/skel.css" />
<link rel="stylesheet" href="/css/style.css" />
<link rel="stylesheet" href="/css/style-xlarge.css" />
</noscript>
</head>
<body id="top">
<header id="header" class="skel-layers-fixed">
<h2><a href="/"><img src="/OPALLogo.png" width="25" height="25"> OPAL Project</a></h2>
<nav id="nav">
<ul>
<li><a href="/Publications.html">Publications</a></li>
<li><a href="/library/api/SNAPSHOT/org/opalj/index.html">ScalaDoc</a></li>
<li><a href="https://github.com/opalj/OPAL">Repository</a></li>
<li><a href="https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.opal-project%22">Maven Central</a></li>
</ul>
</nav>
</header>
<section id="one" class="wrapper style1">
<div class="container">
<div class="row">
<div class="3u">
<nav>
<a href="/UsingOPAL.html">Using OPAL</a><br>
<br><b>Getting Started</b><br>
<a href="/tutorial/FixedPointAnalyses.html">Writing Fixed-Point Analyses</a><br>
<a href="/tutorial/CollaborativeAnalyses.html">Collaborative Analyses</a><br>
<a href="/tutorial/Lattices.html">Lattices</a><br>
<a href="/tutorial/Results.html">Results</a><br>
<a href="/tutorial/Schedulers.html">Schedulers</a><br>
<br><b>Further Tutorials</b><br>
<a href="/examples/ReadingClassFiles.html">Reading Class Files</a><br>
<a href="/examples/Projects.html">Loading Java Projects</a><br>
<a href="/examples/ClassHierarchy.html">Using the Class Hierarchy</a><br>
<a href="/examples/BytecodeEngineering.html">Engineering Java Bytecode</a><br>
<a href="/examples/TAC.html">3-Address Code/SSA Code</a><br>
<a href="/examples/WritingAnalyses.html">Writing Analyses</a><br>
<br><b>Tools</b><br>
<a href="/DeveloperTools.html">Developers Tools</a><br>
<a href="/Hermes.html">Hermes</a><br>
<a href="/Opium.html">OPIUM</a><br>
<br><b>Showcases</b><br>
<a href="/UselessBoxing.html">Detecting Useless Boxings</a><br>
<a href="/JDK8Dependencies.html">Package Dependencies in JDK8</a><br>
<a href="/JDK8Complexity.html">Complexity of the JDK8</a><br>
<br><b>Artifacts</b><br>
<a href="/Artifacts.html">Research Artifacts</a><br>
</nav>
<hr/>
<div class="hide-at-medium">
Please, report issues or problems in the documentation using <a href="https://github.com/opalj/OPAL/issues">OPAL's issue tracker</a>, by going to the <a href="https://gitter.im/OPAL-Project/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link">OPAL gitter chat room</a> or by writing an email to <a href="mailto:opal_at_st.informatik.tu-darmstadt.de">opal(at)st.informatik.tu-darmstadt.de</a>.
</div>
</div>
<div class="9u">
<h2 id="using-the-latest-release">Using The Latest Release</h2>
<p>The latest release is always found on <a href="https://search.maven.org/#search%7Cga%7C1%7Cde.opal-project">Maven Central</a> and can therefore be added to your project as standard library dependency.</p>
<h2 id="using-the-latest-development-snapshot">Using The Latest Development Snapshot</h2>
<p>If you want to use the snapshot version do not forget to add the respective resolver:</p>
<pre><code>resolvers += "Sonatype Central Snapshots" at "https://central.sonatype.com/repository/maven-snapshots/"
</code></pre>
<h2 id="using-opal-to-develop-analyses">Using OPAL to Develop Analyses</h2>
<p>If you want to use OPAL for the development of static analyses, you can either use the latest release found on Maven Central or just checkout and build the current development snapshot of OPAL found on GitHub. In general, using the development snapshot; i.e., the <code>develop</code> branch of OPAL is very safe and gives you access to the latest features, improvements and bug fixes.</p>
<p>Go to <a href="https://github.com/opalj/OPAL">GitHub</a> to checkout OPAL and to read how to compile and deploy it.</p>
<h2 id="exemplary-uses">Exemplary Uses</h2>
<p>OPAL comes with a large number of code <a href="https://bitbucket.org/snippets/delors/">snippets</a> and <a href="https://github.com/opalj/OPAL/tree/develop/DEVELOPING_OPAL/demos/src/main/scala/org/opalj">small (i.e., one-class) analyses</a> to demonstrate various features.</p>
<h2 id="sub-projects">Sub Projects</h2>
<p>OPAL consists of multiple sub projects and tools which are described in the following.</p>
<h3 id="framework">Framework</h3>
<p>Combines all of OPAL's subproject for ease of use.</p>
<pre><code>libraryDependencies += "de.opal-project" % "framework_2.13" % "6.0.0"
</code></pre>
<h3 id="common">Common</h3>
<p>Contains general data structures and algorithms particular useful in the context of static analysis. E.g., graph algorithms, such as
an implementation of Tarjan's algorithm for finding strongly connected components. The implementations are designed with scalability in mind and should be able to process millions of nodes.</p>
<pre><code>libraryDependencies += "de.opal-project" % "common_2.13" % "6.0.0"
</code></pre>
<h3 id="static-analysis-framework">Static Analysis Framework</h3>
<p>The static analysis framework is a generally useful framework for developing static analyses. The framework has wide ranging support for very different types of static analyses and automatically parallels their execution. The framework only depends on <code>Common</code> and can be flexibly combined with other static analyses frameworks (e.g., BCEL, SOOT, Wala, ASM,... )</p>
<pre><code>libraryDependencies += "de.opal-project" % "static-analysis-infrastructure_2.13" % "6.0.0"
</code></pre>
<h3 id="bytecode-representation">Bytecode Representation</h3>
<p>The bytecode toolkit implements a generic infrastructure for parsing Java class files. Additionally,
it provides a default representation for Java bytecode that can be used to analyze class files. That
representation provides extensive support for pattern matching on Java bytecode to facilitate writing
basic analyses.</p>
<pre><code>libraryDependencies += "de.opal-project" % "bytecode-representation_2.13" % "6.0.0"
</code></pre>
<h3 id="bytecode-assembler">Bytecode Assembler</h3>
<p>The Bytecode Assembler provides an embedded DSL for assembling Java class files. It handles tasks like
stack map table generation, exception table generation, and bytecode generation.</p>
<pre><code>libraryDependencies += "de.opal-project" % "bytecode-assembler_2.13" % "6.0.0"
</code></pre>
<h3 id="abstract-interpretation-framework">Abstract Interpretation Framework</h3>
<p>The abstract interpretation framework is a highly-customizable framework for the lightweight abstract interpretation of the Java bytecode. The framework was designed with ease of use and customizability in mind.</p>
<pre><code>libraryDependencies += "de.opal-project" % "abstract-interpretation-framework_2.13" % "6.0.0"
</code></pre>
<h3 id="three-address-code">Three-Address Code</h3>
<p>The three-address-code toolkit provides a more human readable representation of the bytecode that includes additional information derived by the abstract interpretation framework.</p>
<pre><code>libraryDependencies += "de.opal-project" % "three-address-code_2.13" % "6.0.0"
</code></pre>
<h3 id="architecture-validation-framework">Architecture Validation Framework</h3>
<p>The architecture validation framework facilitates the development of tools for specifying and validating software architectures.</p>
<pre><code>libraryDependencies += "de.opal-project" % "architecture-validation_2.13" % "6.0.0"
</code></pre>
<h3 id="apk">APK</h3>
<p>Provides support for the analyis of APKs, with automatic conversion from dalvik to java byte code.</p>
<pre><code>libraryDependencies += "de.opal-project" % "apk_2.13" % "6.0.0"
</code></pre>
</div>
</div>
</div>
</section>
<footer id="footer">
<div class="container">
<div class="row double">
<div class="6u">
<h3>Stay connected and get help!</h3>
<ul class="icons">
<li><a href="https://twitter.com/intent/follow?original_referer=http%3A%2F%2Fwww.opal-project.de%2F&ref_src=twsrc%5Etfw®ion=follow_link&screen_name=TheOpalProject&tw_p=followbutton" class="icon fa-twitter"><span class="label">Twitter</span></a></li>
<li><a href="https://gitter.im/OPAL-Project/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link" class="icon fa-users"><span class="label">Gitter</span></a></li>
<li><a href="https://trello.com/theopalproject" class="icon fa-trello"><span class="label">Trello</span></a></li>
<li><a href="https://stackoverflow.com/questions/tagged/opal-framework" class="icon fa-stack-overflow"><span class="label">Stackoverflow</span></a></li>
<li><a href="https://hub.docker.com/r/opalj/sbt_scala_opal" class="icon fa-cloud"><span class="label">Docker</span></a></li>
</ul>
<h3>Related</h3>
<ul class="alt">
<li><a href="https://www.openhub.net/p/OPAL-Project">OPAL on OpenHub</a></li>
</ul>
</div>
<div class="6u">
<h3>Supported By</h3>
<ul class="alt">
<li><a href="https://www.yourkit.com/"><img src="/images/yklogo.png" width="139", height="33"></a><br>
YourKit supports open source projects with its full-featured Java Profiler.
YourKit, LLC is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>
an innovative and intelligent tool for profiling Java applications.
</li>
</ul>
</div>
</div>
<ul class="copyright">
<li>© The OPAL Project. All rights reserved.</li>
<li><a href="https://raw.githubusercontent.com/opalj/opal/master/LICENSE">License (BSD 2 Clause)</a></li>
<li><img src="/Athene.png" height="27" style="vertical-align:middle"></li>
<li>Design: <a href="https://templated.co">TEMPLATED</a></li>
</ul>
</div>
</footer>
</body>
<script>
hljs.configure({
tabReplace: ' ', // 4 spaces
languages: ["scala","java"]
})
hljs.highlightAll()
</script>
</html>