Packages

Definition Classes: root

Definition Classes: root

OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.

OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.

Its main components are:

a library (Common) which provides generally useful data-structures and algorithms for static analyses.
a framework for implementing lattice based static analyses (Static Analysis Infrastructure)
a framework for parsing Java bytecode (Bytecode Infrastructure) that can be used to create arbitrary representations.
a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler).
a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
a library to extract dependencies between code elements and to facilitate checking architecture definitions.
a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler).

General Design Decisions

Thread Safety

Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)

No `null` Values

Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.

No Typecasts for Collections

For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety.

Assertions

OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.

Definition Classes: org

package ai

Implementation of an abstract interpretation (ai) framework – also referred to as OPAL.

Please note that OPAL/the abstract interpreter just refers to the classes and traits defined in this package (ai). The classes and traits defined in the sub-packages (in particular in domain) are not considered to be part of the core of OPAL/the abstract interpreter.

Definition Classes: opalj
Note: This framework assumes that the analyzed bytecode is valid; i.e., the JVM's bytecode verifier would be able to verify the code. Furthermore, load-time errors (e.g., LinkageErrors) are – by default – completely ignored to facilitate the analysis of parts of a project. In general, if the presented bytecode is not valid, the result is undefined (i.e., OPAL may report meaningless results, crash or run indefinitely).
See also: org.opalj.ai.AI - Implements the abstract interpreter that processes a methods code and uses an analysis-specific domain to perform the abstract computations.
org.opalj.ai.Domain - The core interface between the abstract interpretation framework and the abstract domain that is responsible for performing the abstract computations.

package av

Definition Classes: opalj

package ba

Implementation of an eDSL for creating Java bytecode.

Implementation of an eDSL for creating Java bytecode. The eDSL is designed to facilitate the creation of correct class files; i.e., whenever possible it tries to fill wholes. For example, when an interface is specified the library automatically ensures that the super class type is (initially) set to java.lang.Object as required by the JVM specification.

This package in particular provides functionality to convert org.opalj.br classes to org.opalj.da classes.

Definition Classes: opalj

package bc

Definition Classes: opalj

package bi

Implementation of a library for parsing Java bytecode and creating arbitrary representations.

OPAL's primary representation of Java byte code is the org.opalj.br representation which is defined in the respective package. A second representation that represents bytecode one-by-one is found in the org.opalj.da package.

This Package

Common constants and type definitions used across OPAL.

Definition Classes: opalj

package br

In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries.

In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries. This facilitates developing analyses and fosters comprehension.

Based on the fact that indirect references to constant pool entries are resolved and replaced by direct references this representation is called the resolved representation.

This representation of Java bytecode is considered as OPAL's standard representation for writing Scala based analyses. This representation is engineered such that it facilitates writing analyses that use pattern matching.

Definition Classes: opalj

package bytecode

Defines functionality commonly useful when processing Java bytecode.

Definition Classes: opalj

package collection

OPAL's collection library is primarily designed with high performance in mind.

Design Goals

OPAL's collection library is primarily designed with high performance in mind. I.e., all methods provided by the collection library are reasonably optimized. However, providing a very large number of methods is a non-goal. Overall, OPAL's collection library provides:

collection classes that are manually specialized for primitive data-types.
collection classes that are optimized for particularly small collections of values.
collection classes that target special use cases such as using a collection as a workset/worklist.
collection classes that offer special methods that minimize the number of steps when compared to general purpose methods.

Integration With Scala's Collection Library

Hence, OPAL's collection library complements Scala's default collection library and is not intended to replace it. Integration with Scala's collection library is primarily provided by means of iterators (OPAL's Iterators inherit from Scala's Iterators). Furthermore the companion object of each of OPAL's collection classes generally provides factory methods that facilitate the conversion from Scala collection classes to OPAL collection classes.

Status

The collection library is growing. Nevertheless, the existing classes are production ready.

Definition Classes: opalj

package eval

package immutable

package mutable

IntCollectionWithStableOrdering

IntIterator

IntSet

LongCollectionWithStableOrdering

UID

package concurrent

Common constants, factory methods and objects used throughout OPAL when performing concurrent computations.

Definition Classes: opalj

package constraints

Defines helper values and methods related to modeling constraints.

Definition Classes: opalj

package control

Defines common control abstractions.

Definition Classes: opalj

package da

Defines convenience methods related to representing certain class file elements.

Definition Classes: opalj

package de

Functionality to extract dependencies between class files.

Definition Classes: opalj

package fpcf

The fixpoint computations framework (fpcf) is a general framework to perform fixpoint computations of properties ordered by a lattice.

The fixpoint computations framework (fpcf) is a general framework to perform fixpoint computations of properties ordered by a lattice. The framework in particular supports the development of static analyses.

In this case, the fixpoint computations/static analyses are generally operating on the code and need to be executed until the computations have reached their (implicit) fixpoint. The fixpoint framework explicitly supports resolving cyclic dependencies/computations. A prime use case of the fixpoint framework are all those analyses that may interact with the results of other analyses.

For example, an analysis that analyzes all field write accesses to determine if we can refine a field's type (for the purpose of the analysis) can (reuse) the information about the return types of methods, which however may depend on the refined field types.

The framework is generic enough to facilitate the implementation of anytime algorithms.

Definition Classes: opalj
Note: This framework assumes that all data-structures (e.g., dependee lists and properties) that are passed to the framework are effectively immutable! (Effectively immutable means that a data structure is never updated after it was passed to the framework.)
,
The dependency relation is as follows: “A depends on B” === “A is the depender, B is the dependee”. === “B is depended on by A”
,
The very core of the framework is described in: Lattice Based Modularization of Static Analyses

package graphs

This package defines graph algorithms as well as factory methods to describe and compute graphs and trees.

This package supports the following types of graphs:

graphs based on explicitly connected nodes (org.opalj.graphs.Node),
graphs where the relationship between the nodes are encoded externally (org.opalj.graphs.Graph).

Definition Classes: opalj

package io

Various io-related helper methods and classes.

Definition Classes: opalj
Note: The implementations of the methods rely on Java NIO(2).

package issues

Defines implicit conversions to wrap some types of analyses such that they generate results of type org.opalj.br.analyses.ReportableAnalysisResult.

Definition Classes: opalj

package log

Definition Classes: opalj

package tac

Common definitions related to the definition and processing of three address code.

Definition Classes: opalj

package util

Utility methods.

Definition Classes: opalj

package value

Provides a general query interface for querying a value's properties.

Definition Classes: opalj

org.opalj

collection

package collection

Design Goals

collection classes that are manually specialized for primitive data-types.
collection classes that are optimized for particularly small collections of values.
collection classes that target special use cases such as using a collection as a workset/worklist.
collection classes that offer special methods that minimize the number of steps when compared to general purpose methods.

Integration With Scala's Collection Library

Status

The collection library is growing. Nevertheless, the existing classes are production ready.

Source: package.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

collection
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Package Members

package eval
package immutable
package mutable

Type Members

trait BitSet extends AnyRef
Common interface of all BitSet based collections provided by OPAL.
case class CompleteCollection[+S](s: S) extends QualifiedCollection[S] with Product with Serializable
abstract class ForeachRefIterator[+T] extends AnyRef
Specialized variant of an internal iterator.
Specialized variant of an internal iterator. The only way to iterate over a foreach iterator is to use foreach. Compared to a classical iterator, iteration can be repeated and more efficient implementation strategies are easily possible.
Note
The type bound T <: AnyRef is expected to be ex-/implicitly enforced by subclasses.
case class IncompleteCollection[+S](s: S) extends QualifiedCollection[S] with Product with Serializable
trait IntCollectionWithStableOrdering[T <: IntSet[T]] extends AnyRef
Can be mixed in if the iteration order is always that same independent of the insertion order.
Can be mixed in if the iteration order is always that same independent of the insertion order. This is typically the case if the values are (pseudo-)sorted.
abstract class IntIterator extends AbstractIterator[Int]
Iterator over a collection of primitive int valuea; basically overrides all inherited methods to avoid (un)boxing.
Iterator over a collection of primitive int valuea; basically overrides all inherited methods to avoid (un)boxing.
Note
No guarantee is given what will happen if next is called after hasNext returns or would have returned false.
trait IntSet[T <: IntSet[T]] extends AnyRef
A set of integer values.
trait LongCollectionWithStableOrdering[T <: LongCollectionWithStableOrdering[T]] extends AnyRef
Can be mixed in if the iteration order is always that same independent of the insertion order.
Can be mixed in if the iteration order is always that same independent of the insertion order. This is typically the case if the values are (pseudo-)sorted.
abstract class LongIterator extends AbstractIterator[Long]
Iterator over a collection of longs; basically all methods are overridden to avoid (un)boxing operations.
trait LongSet extends AnyRef
A set of long values.
sealed trait QualifiedCollection[+S] extends AnyRef
Identifies a collection as being (guaranteed) complete or as being potentially incomplete.
Identifies a collection as being (guaranteed) complete or as being potentially incomplete.
This class is typically used by analyses that derive some results and which are also able to do so of in cases incomplete information. But in latter cases the analyses may not be able to determine whether the derived information is complete or not. For example, imagine you are analyzing some library (but not the JDK). In this case the class hierarchy will be incomplete and every analysis using it may compute incomplete information.
trait RefIndexedView[+T] extends AnyRef
Defines a view on some indexed data structure.
Defines a view on some indexed data structure.
Note
The type bound T <: AnyRef has to be ex-/implicitly enforced by subclasses.
sealed abstract class SetRelation extends AnyRef
Describes the relation between two sets.
type SomeIntSet = IntSet[_]
trait UID extends AnyRef
Identifies objects which have - in the scope where the objects are used - unique ids.
Identifies objects which have - in the scope where the objects are used - unique ids. I.e., this trait is implemented by objects that have – by construction - unique ids in a well-defined scope. The UIDSet is based on comparing uids.
trait UIDValue extends UID
Identifies objects which have a – potentially context dependent – unique id.
Identifies objects which have a – potentially context dependent – unique id. I.e., this trait is implemented by objects that have – by construction - unique ids in a well-defined scope.
Note
Two objects that are not equal may still have the same id, if both objects are guaranteed to never be compared against each other.

Value Members

def asScala[K, SubK, V](map: ConcurrentHashMap[K, ConcurrentHashMap[SubK, V]]): Map[K, Map[SubK, V]]
Converts a multi-map (a Map that contains Maps) based on java.util.concurrent.ConcurrentHashMaps into a corresponding multi-map based on scala.collection.immutable.HashMaps.
Converts a multi-map (a Map that contains Maps) based on java.util.concurrent.ConcurrentHashMaps into a corresponding multi-map based on scala.collection.immutable.HashMaps. E.g.,
```
val source : ConcurrentHashMap[SourceElement, CMap[ArrayType, Set[DType]]] =...
val target : Map[SourceElement, Map[ArrayType, Set[DType]]] = asScala(source)
```
def binarySearch[T, X >: T <: Comparable[X]](array: ArraySeq[T], key: X): Int
def commonPrefix[T](l1: List[T], l2: List[T]): List[T]
Returns the common prefix of the given lists.
Returns the common prefix of the given lists. If l1 is a prefix of l2, then l1 is returned. If l2 is a prefix of l1, l2 is returned, otherwise a new list that contains the prefix is returned. Hence, if l1===l2 then l1 is returned.
def insertedAt[T, X >: T <: AnyRef](array: ArraySeq[T], insertionPoint: Int, e: X): ArraySeq[X]
object EqualSets extends SetRelation
object ForeachRefIterator
object IntIterator
object LongIterator
object LongSet
Defines convenience functions and data-structures used by OPAL's data-structures.
object RefIndexedView
object SingletonSet
Facilitates the matching of a Scala collection Set that contains a single value.
object StrictSubset extends SetRelation
object StrictSuperset extends SetRelation
object UID
Helper methods related to data structures that have unique ids.
object UncomparableSets extends SetRelation

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

This Package

Design Goals

Integration With Scala's Collection Library

Status

collection

package collection

Design Goals

Integration With Scala's Collection Library

Status

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

This Package

Design Goals

Integration With Scala's Collection Library

Status

collection

package collection

Design Goals

Integration With Scala's Collection Library

Status

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

collection