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 tac

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

Definition Classes: opalj

package cg

Definition Classes: tac

package common

Definition Classes: tac

package fpcf

Definition Classes: tac

EagerDetachedTACAIKey

InvokedynamicFunctionCall

InvokedynamicMethodCall

JSR

New

NonVirtualFunctionCall

NonVirtualFunctionCallStatement

Nop

PrimitiveTypecastExpr

Ret

StaticFunctionCallStatement

TAC

TACOptimizationResult

Var

VirtualFunctionCallStatement

VirtualMethodCall

org.opalj.tac

ComputeTACAIKey

object ComputeTACAIKey extends TACAIKey[(Method) => Domain with RecordDefUse]

Key to compute the 3-address based code of a method computed using the configured domain/data-flow analysis. The result is not cached and the 3-address code is still linked to the results of the underlying data-flow analysis. In general, this key is only appropriate if you want to transform every method at most once.

Source: ComputeTACAIKey.scala

Linear Supertypes

TACAIKey[(Method) => Domain with RecordDefUse], ProjectInformationKey[(Method) => AITACode[TACMethodParameter, ValueInformation], (Method) => Domain with RecordDefUse], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ComputeTACAIKey
TACAIKey
ProjectInformationKey
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
def compute(project: SomeProject): (Method) => AITACode[TACMethodParameter, ValueInformation]
Returns an factory which computes the 3-address code of a method anew when called.
Returns an factory which computes the 3-address code of a method anew when called.
All methods belonging to a project are converted using the same domainFactory. Hence, the domainFactory needs to be set (using setProjectInformationKeyInitializationData) before compute is called/this key is passed to a specific project.
Definition Classes
ComputeTACAIKey → ProjectInformationKey
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
def requirements(project: SomeProject): Seq[ProjectInformationKey[Nothing, Nothing]]
TACAI code has no special prerequisites.
TACAI code has no special prerequisites.
Definition Classes
ComputeTACAIKey → ProjectInformationKey
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final val uniqueId: Int
The unique id of this key.
The unique id of this key. The key is used to enable efficient access and is automatically assigned by OPAL and will not change after that.
Definition Classes
ProjectInformationKey
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

ComputeTACAIKey

object ComputeTACAIKey extends TACAIKey[(Method) => Domain with RecordDefUse]

Value Members

Deprecated Value Members

Inherited from TACAIKey[(Method) => Domain with RecordDefUse]

Inherited from ProjectInformationKey[(Method) => AITACode[TACMethodParameter, ValueInformation], (Method) => Domain with RecordDefUse]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

ComputeTACAIKey

object ComputeTACAIKey extends TACAIKey[(Method) => Domain with RecordDefUse]

Value Members

Deprecated Value Members

Inherited from TACAIKey[(Method) => Domain with RecordDefUse]

Inherited from ProjectInformationKey[(Method) => AITACode[TACMethodParameter, ValueInformation], (Method) => Domain with RecordDefUse]

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

ComputeTACAIKey