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 - org.opalj.bi) that can be used to create arbitrary representations.
a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler - org.opalj.da).
a library to convert this representation to Java class files (Bytecode Creator - org.opalj.bc).
a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
a library to create a stackless, three-address code representation of Java bytecode that facilitates writing complex static analyses (Three Address Code - org.opalj.tac).
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 (Dependencies Extraction - org.opalj.de) and to facilitate checking architecture definitions (Architecture Validation - org.opalj.av).
a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler - org.opalj.ba).
a library for parsing Android packages (APK - org.opalj.apk).
libraries for writing static analyses using the interprocedural finite distributive subset (IFDS - org.opalj.ifds) and interprocedural distributive environment (IDE - org.opal.ide) algorithms.

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 fpcf

Definition Classes: tac

package analyses

Definition Classes: fpcf

package alias

Definition Classes: analyses

package cg

Definition Classes: analyses

package escape

Definition Classes: analyses

package fieldaccess

Definition Classes: analyses

package fieldassignability

Definition Classes: analyses

package ide

Definition Classes: analyses

package ifds

Definition Classes: analyses

package pointsto

Definition Classes: analyses

package purity

Definition Classes: analyses

package string

Definition Classes: analyses

package systemproperties

Definition Classes: analyses

APIBasedAnalysis

AllocationSiteDescription

ArrayDescription

ConfiguredMethodData

ConfiguredMethods

DefinitionSiteWithoutPutField

DefinitionSitesWithoutPutField

EagerFieldImmutabilityAnalysis

EagerFieldLocalityAnalysis

EagerL0TACAIAnalysis

EagerL1ThrownExceptionsAnalysis

EagerTACAIProvider

EntityAssignment

EntityDescription

FieldImmutabilityAnalysis

FieldImmutabilityAnalysisScheduler

FieldLocalityAnalysis

FieldLocalityAnalysisScheduler

FieldLocalityState

L0TACAIAnalysis

L0TACAIAnalysisScheduler

LazyFieldImmutabilityAnalysis

LazyFieldLocalityAnalysis

StaticFieldDescription

TACAIAnalysis

TACAIBasedAPIBasedAnalysis

TACAIBasedAnalysisState

TACAIInitializer

TACAIProvider

TACAIProviderScheduler

TACAITransformer

org.opalj.tac.fpcf.analyses

APIBasedAnalysis

trait APIBasedAnalysis extends FPCFAnalysis with ContextualAnalysis

A trait for analyses that model the result of the invocation of a specific apiMethod.

Each time a new caller of the apiMethod* is found in the Callers property, handleNewCaller* gets called.

Source: APIBasedAnalysis.scala
Note: When handleNewCaller gets invoked, there is no guarantee that the caller's three-address code (org.opalj.tac.fpcf.properties.TACAI) is present in the property store, nor that it is final. If this is required, use the TACAIBasedAPIBasedAnalysis sub-trait.

Linear Supertypes

ContextualAnalysis, FPCFAnalysis, ProjectBasedAnalysis, FPCFAnalysis, ProjectBasedAnalysis, AnyRef, Any

Known Subclasses

TACAIBasedAPIBasedAnalysis, DoPrivilegedMethodAnalysis, OISReadObjectAnalysis, OOSWriteObjectAnalysis, ThreadStartAnalysis, UncaughtExceptionHandlerAnalysis, ClassForNameAnalysis, ClassNewInstanceAnalysis, ConstructorNewInstanceAnalysis, MethodHandleInvokeAnalysis, MethodInvokeAnalysis, ReflectionAnalysis, TamiFlexMethodInvokeAnalysis, FieldGetAnalysis, FieldInstanceBasedReflectiveFieldAccessAnalysis, FieldSetAnalysis, MethodHandleInvokeAnalysis, ReflectionAnalysis, ArraycopyPointsToAnalysis, NewInstanceMethodAnalysis, ReflectionMethodAllocationsAnalysis, SerializationAllocationsAnalysis, TamiFlexPointsToArrayGetAnalysis, TamiFlexPointsToArraySetAnalysis, TamiFlexPointsToClassGetMemberAnalysis, TamiFlexPointsToClassGetMembersAnalysis, TamiFlexPointsToFieldGetAnalysis, TamiFlexPointsToFieldSetAnalysis, TamiFlexPointsToNewInstanceAnalysis, UnsafeGetPointsToAnalysis, UnsafePutPointsToAnalysis

Ordering

Alphabetic
By Inheritance

Inherited

APIBasedAnalysis
ContextualAnalysis
FPCFAnalysis
ProjectBasedAnalysis
FPCFAnalysis
ProjectBasedAnalysis
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

abstract type ContextType <: Context
Definition Classes
ContextualAnalysis

Abstract Value Members

abstract val apiMethod: DeclaredMethod
implicit abstract val contextProvider: ContextProvider
abstract def handleNewCaller(calleeContext: ContextType, callerContext: ContextType, pc: Int, isDirect: Boolean): ProperPropertyComputationResult
abstract val project: SomeProject
Definition Classes
ProjectBasedAnalysis → ProjectBasedAnalysis

Concrete 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
final def ch: ClassHierarchy
Definition Classes
ProjectBasedAnalysis
implicit final def classHierarchy: ClassHierarchy
Definition Classes
ProjectBasedAnalysis
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
implicit val declaredMethods: DeclaredMethods
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
implicit final def logContext: LogContext
Definition Classes
ProjectBasedAnalysis
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()
implicit def p: SomeProject
Definition Classes
ProjectBasedAnalysis → ProjectBasedAnalysis
implicit final val propertyStore: PropertyStore
Definition Classes
FPCFAnalysis
final def ps: PropertyStore
Definition Classes
FPCFAnalysis
final def registerAPIMethod(): ProperPropertyComputationResult
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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
Deprecated

Packages

General Design Decisions

Thread Safety

No `null` Values

No Typecasts for Collections

Assertions

APIBasedAnalysis

trait APIBasedAnalysis extends FPCFAnalysis with ContextualAnalysis

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ContextualAnalysis

Inherited from FPCFAnalysis

Inherited from ProjectBasedAnalysis

Inherited from FPCFAnalysis

Inherited from ProjectBasedAnalysis

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

General Design Decisions

Thread Safety

No null Values

No Typecasts for Collections

Assertions

APIBasedAnalysis

trait APIBasedAnalysis extends FPCFAnalysis with ContextualAnalysis

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ContextualAnalysis

Inherited from FPCFAnalysis

Inherited from ProjectBasedAnalysis

Inherited from FPCFAnalysis

Inherited from ProjectBasedAnalysis

Inherited from AnyRef

Inherited from Any

Ungrouped

No `null` Values

APIBasedAnalysis