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 cg
    Definition Classes
    analyses
  • Analysis
  • AnalysisApplication
  • AnalysisException
  • BasicMethodInfo
  • BasicReport
  • DeclaredMethods
  • DeclaredMethodsKey
  • FieldAccessInformation
  • FieldAccessInformationAnalysis
  • FieldAccessInformationKey
  • InconsistentProjectException
  • JavaProject
  • MethodAnalysisApplication
  • MethodDeclarationContext
  • MethodDeclarationContextOrdering
  • MethodInfo
  • ModuleDefinition
  • OneStepAnalysis
  • ProgressEvents
  • ProgressManagement
  • Project
  • ProjectAnalysisApplication
  • ProjectBasedAnalysis
  • ProjectIndex
  • ProjectIndexKey
  • ProjectInformationKey
  • ProjectLike
  • ReportableAnalysisResult
  • StringConstantsInformationKey
  • VirtualFormalParameter
  • VirtualFormalParameters
  • VirtualFormalParametersKey

trait Analysis[Source, +AnalysisResult] extends AnyRef

Common trait that analyses can inherit from when they want to use the general analysis framework AnalysisApplication.

Conceptual Idea

An analysis is basically a mapping of a Project's resources to some result.

Each analysis can produce (optionally) some result. E.g., a text describing a scenario that leads to a bug, a graph, a report that identifies a specific line or a combination thereof.

However, an analysis should never rely on the location of a resource. If an analysis needs access to further resources, it should use the Project class.

Source
Analysis.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Analysis
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def analyze(project: Project[Source], parameters: Seq[String] = Seq.empty, initProgressManagement: (Int) ⇒ ProgressManagement): AnalysisResult

    Analyzes the given project and reports the result(s).

    Analyzes the given project and reports the result(s).

    initProgressManagement

    Returns a org.opalj.br.analyses.ProgressManagement object. The function is called by the analysis for each major analysis with the number of steps (Int) that will be performed. The analysis will subsequently use the returned object to report status information (related to that part of the analysis) and to check the interrupted status. The number of steps is at least 1. The analysis may call this function multiple times. However, the last End event always has to be signaled using the first ProgressManagement object. In other words, logically nested calls are supported, but chaining is not. A legal call sequence could be:

    val pouter = initProgressManagement(2)
    pouter.progress(1,Start,Some("call graph analysis"))
        // ... construct call graph
    pouter.progress(1,End,None)
    pouter.progress(2,Start,Some("analyzing class files"))
        val p2 = initProgressManagement(500)
        // SEVERAL CLASS FILES ARE ANALYZED IN PARALLEL:
        p2.progress(1,Start,Some("java.lang.Object"))
        p2.progress(2,Start,Some("java.util.ArrayList"))
        p2.progress(3,Start,Some("java.lang.String"))
        p2.progress(2,End,Some("java.util.ArrayList"))
        p2.progress(4,Start,Some("java.util.Date"))
        ...
        p2.progress(500,End,None)
    pouter.progress(2,End,None)
    returns

    The analysis' result. If the analysis was aborted/killed, the analysis should return an appropriate result (which might be null) and this has to be specified/documented by the analysis.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. def copyright: String

    The copyright statement which contains less than 124 character and no line-breaks.

  7. def description: String

    A textual description of this analysis.

    A textual description of this analysis.

    The description should discuss:

    • the goal of the analysis
    • weaknesses of the analysis; i.e., whether the analysis may report false positives or may not report existing bugs (i.e., whether the analysis is subject to false negatives.)
    • if applicable, it should discuss what the developer could/should do in general to remedy the situation
    • if applicable it should discuss the severeness of the found results. I.e., whether immediate action is required because a bug was found that will show up at runtime or if it is a security bug.
    • if applicable it should give an example. I.e., what the expected result is given a project with certain resources.
  8. def documentationUrl: Option[String]

    A URL at which documentation about this analysis can be found.

    A URL at which documentation about this analysis can be found. This allows user interfaces to show a link for the user to click on, as a way to access further documentation about this analysis.

    For example, for a command line interface, outputting the entire description to the console may not be desirable, and it could show this URL instead.

    This is just a String, not a java.net.URL, because we do not intend to use it as an URL internally. It is just a text string that can be shown to the user.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def title: String

    A short descriptive title which should contain less than 64 characters and no line-breaks.

    A short descriptive title which should contain less than 64 characters and no line-breaks.

    The default is the simple name of the class implementing the analysis.

  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped