Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package opalj

    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 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 analyses

    Defines commonly useful type aliases.

    Defines commonly useful type aliases.

    Definition Classes
    br
  • package cfg
    Definition Classes
    br
  • BasicBlock
  • CFG
  • CFGFactory
  • CFGNode
  • CatchNode
  • ExitNode
  • package collection
    Definition Classes
    br
  • package cp

    Implementation of classes to represent/recreate a class file's constant pool.

    Implementation of classes to represent/recreate a class file's constant pool.

    Definition Classes
    br
  • package fpcf
    Definition Classes
    br
  • package instructions

    Common instruction sequences.

    Common instruction sequences.

    Definition Classes
    br
  • package reader

    Defines convenience methods related to reading in class files.

    Defines convenience methods related to reading in class files.

    Definition Classes
    br

package cfg

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final class BasicBlock extends CFGNode

    Represents a basic block of a method's control flow graph (CFG).

    Represents a basic block of a method's control flow graph (CFG). The basic block is identified by referring to the first and last instruction belonging to the basic block.

  2. case class CFG[I <: AnyRef, C <: CodeSequence[I]](code: C, normalReturnNode: ExitNode, abnormalReturnNode: ExitNode, catchNodes: Seq[CatchNode], basicBlocks: Array[BasicBlock]) extends Product with Serializable

    Represents the control flow graph of a method.

    Represents the control flow graph of a method.

    To compute a CFG use the CFGFactory.

    Thread-Safety

    This class is thread-safe; all data is effectively immutable after construction time.

    code

    The code for which the CFG was build.

    normalReturnNode

    The unique exit node of the control flow graph if the method returns normally. If the method always throws an exception, this node will not have any predecessors.

    abnormalReturnNode

    The unique exit node of the control flow graph if the method returns abnormally (throws an exception). If the method is guaranteed to never throw an exception, this node will not have any predecessors.

    catchNodes

    List of all catch nodes. (Usually, we have one CatchNode per org.opalj.br.ExceptionHandler, but if an exception handler does not catch anything, no CatchNode is created.)

    basicBlocks

    An implicit map between a program counter and its associated BasicBlock; it may be a sparse array!

  3. trait CFGNode extends Node

    The common super trait of all nodes belonging to a method's control flow graph.

  4. final class CatchNode extends CFGNode

    This node represents an exception handler.

    This node represents an exception handler.

    Note

    CatchNodes are made explicit to handle/identify situations where the same exception handlers is responsible for handling multiple different exceptions. This situation generally arises in case of Javas multi-catch expressions.

  5. final class ExitNode extends CFGNode

    Represents the artificial exit node of a control flow graph.

    Represents the artificial exit node of a control flow graph. The graph contains an explicit exit node to make it trivial to navigate to all instructions that may cause a(n ab)normal return from the method.

Value Members

  1. object CFG extends Serializable
  2. object CFGFactory

    A factory for computing control flow graphs for methods.

  3. object ExitNode

Ungrouped