This repository contains the artifact of the following two papers:
*Paper I: IntraJ: an On-demand Framework For Intraprocedural Java Code Analysis, Idriss Riouak 🔗, Görel Hedin 🔗, Niklas Fors 🔗, and Christoph Reichenbach 🔗,. Submitted to the Journal of System and Software.
*Paper II: A Precise Framework for Source-Level Control-Flow Analysis, Idriss Riouak 🔗, Christoph Reichenbach 🔗, Görel Hedin 🔗 and Niklas Fors 🔗. Published at the 21st IEEE International Working Conference on Source Code Analysis & Manipulation, 2021 (SCAM 2021 🔗).
The repository contains:
-
IntraJ-LSP: an LSP-based plugin for the VSCode editor, which allows you to run IntraJ on Java source code.
-
IntraJ: a static analyser for Java source code and all its submodules:
We provide two different ways of getting and running IntraJ-LSP:
- Install IntraJ-LSP as a VSCode extension from the VSCode Marketplace. (Recommended)
- Build IntraJ-LSP from the artifact source code.
To install IntraJ as a VSCode extension, follow these steps:
- Install the VSCode editor.
- Install the extension from the VSCode Marketplace.
- Alternatively, search for
IntraJin the VSCode Extensions Marketplace.
See instruction video on YouTube
To build IntraJ-LSP the following tools are required:
- Java SDK version 8. (tested with SDK 1.8.0_275. See sdkman).
- VSCode Editor. (tested with 1.79.2. See VSCode).
To clone the IntraJ code, run, in your working directory:
git clone https://github.com/IdrissRio/IntraJ-LSP.git
Move to the IntraJ-LSP directory:
cd IntraJ-LSP
Recusively clone all the submodule
git submodule update --init --recursive
Build the extension using the following command:
./gradlew vsce
See instruction video on YouTube
The directory is structured as follow:
IntraJ-LSP
├── build # Compiled files
├── IntraJ # IntraJ source code
├── src/java # IntraJ source code
| ├── magpiebridge # MagpieBridge source code
| └── java
| └── IntraJPlugin.java # Entry point for the plugin (Paper I §3)
├── tools # IntraJ source code
| └── magpiebridge.jar # Custom version of Jastadd (Paper I §3)
├── vscode # VSCode extension source code (Paper I §3)
| ├── intraj.jar # IntraJ jar file
| └── package.json # VSCode extension manifest
├── LICENSE
└── README.md
The directory is structured as follow:
.
├── build # Compiled files
├── extendj # ExtendJ source code
├── resources # Scripts and logo
├── src # IntraJ source code
| ├── jastadd
| | ├── CFG # CFG spec in Jastadd
| | ├── StaticAnalysis # Folder containing code-smells and data-flow analyses
| | └── utils # Helpers for IntraJ
| └── java
| ├── utils # General helpers for visualisation
| └── test # JUnit test spec
├── tools # IntraJ source code
| └── jastadd-2.3.6-custom # Custom version of Jastadd
├── testfiles # Automated test files
| ├── DataFlow
| └── CFG
├── eval.sh # Evaluation entry point
├── LICENSE
└── README.md
.
└── jastadd
├── CFG
| ├── IntraCFG
| | ├── CFG.ast # Lang-independent nodes
| | └── IntraCFG.jrag # IntraCFG spec in Jastadd
| ├── java4 # (Paper II §3)
| | ├── Cache.jrag # Cache settings
| | ├── Exception.jrag # Exception spec (Paper II §3.c)
| | ├── Initializer.jrag # Initializers spec (Paper II §3.b)
| | ├── Java4.jrag # Java4 spec
| | └── ImplictNodes.ast # Reified nodes
| ├── java5 # (Paper II §3)
| | └── Java5.jrag # Java5 spec
| └── java7 # (Paper II §3)
| | └── Java7.jrag # Java7 spec
| └── java8 #
| └── Java8.jrag # Java8 spec
└── StaticAnalysis # Data flow analyses spec (Paper II §4)
├── CodeSmells # CodeSmells
└── DataFlow # Dataflow Analyses
├── DeadAssignment.jrag # (Paper II §4.c)
├── ImplicitDeadAssignment.jrag # (Paper II §4.c)
├── LiveVariableAnalysis.jrag # (Paper II §4.c)
├── NullAnalysis.jrag # (Paper II §4.c)
└── ReachingDefintion.jrag # (Paper II §4.c)
To use IntraJ as a standalone tool, visit the IntraJ repository and follow the instructions in the README.md.
Alternatively, from the root of the repository (i.e., IntraJ-LSP), run the following command:
cd IntraJ
and follow the instructions in the README.md.
To use IntraJ in CodeProber, visit the following webpage and follow the following instructions:
- Download the file named
artifact.zipand unzip it. - Follow the instruction in the README.pdf.
Figure 6in the README.pdf shows how to use show visualise the CFGs generated by IntraJ in CodeProber.
- 🗄 IntraJ: main repository for IntraJ (control-flow analysis for Java)
- 🗄 IntraCFG: main repository for IntraCFG (language-independent framework for control-flow analysis)
- 🔗 JastAdd: meta-compilation system that supports Reference Attribute Grammars. We used a custom JastAdd version which better supports interfaces.
- 🔗 ExtendJ: extensible Java compiler built using JastAdd. We built IntraJ as an Static Analysis Extension of ExtendJ. More can be found here.
IntraJ was awarded with the Research Object Badge (ROR) and the Open Research Badge
and the Open Research Badge (ORO) at ROSE Track of ICSME 2021.
| Repository |  |
|---|---|
| Docker image |  |
| Reserarch Object Badge |  |
| Open Research Badge |  |