Using Soot? Let us know about it!
We are regularly applying for funding to help us maintain Soot. You can help us immensely by letting us know about projects that use Soot, both commercially or in the form of research tools.
Soot supports Java 9 modules now!
Try and get involved in Soot's Java 9 bleeding edge developement. Check out the Soot-j9 branch.
What is Soot?
Soot is a Java optimization framework. It provides four intermediate representations for analyzing and transforming Java bytecode:
- Baf: a streamlined representation of bytecode which is simple to manipulate.
- Jimple: a typed 3-address intermediate representation suitable for optimization.
- Shimple: an SSA variation of Jimple.
- Grimp: an aggregated version of Jimple suitable for decompilation and code inspection.
See http://www.sable.mcgill.ca/soot/ for details.
How do I get started with Soot?
Including Soot in your Project
A Soot release is currently built for each commit to the
master branch. You can include Soot as a dependency via Maven, Gradle, SBT, etc using the following coordinates:
<dependencies> <dependency> <groupId>ca.mcgill.sable</groupId> <artifactId>soot</artifactId> <version>3.3.0</version> </dependency> </dependencies>
You can also obtain older builds of the
master branch. A complete listing of builds can be found on Maven Central.
How do I obtain Soot without Maven?
All of our Soot builds for the
master branch are also stored up to one month in our Nexus repository and can be obtained from there. The latest realease build of Soot can also be obtained directly. The "sootclasses-trunk-jar-with-dependencies.jar" file is an all-in-one file that also contains all the required libraries. The "sootclasses-trunk.jar" file contains only Soot, allowing you to manually pick dependencies as you need them. If you do not want to bother with dependencies, we recommend using the former.
Building Soot yourself
If you cannot work with the prebuild versions and need to build Soot on your own, please consider the wiki for further steps.
About Soot's source code
Soot follows the git-flow convention. Releases and hotfixes are maintained in the master branch. Development happens in the develop branch. To catch the bleeding edge of Soot, check out the latter. In case of any questions, please consult the Soot mailing list at: http://www.sable.mcgill.ca/mailman/listinfo/soot-list/
How do I contribute to Soot?
We are happy to accept arbitrary improvements to Soot in form of GitHub pull requests. Please read our contribution guidelines before setting up a pull request.
Please help us improve Soot!
You are using Soot and would like to help us support it in the future? Then please support us by filling out this little web form.
That way you can help us in two ways:
- By letting us know how we can improve Soot you can directly help us prioritize newly planned features.
- By stating your name and affiliation you help us showcasing Soot’s large user base. Thanks!