Skip to content

Commit 577d458

Browse files
authored
Fix Readme
1 parent 1f2574f commit 577d458

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Build Status](http://soot-build.cs.uni-paderborn.de/jenkins/buildStatus/icon?job=soot/soot-develop)](http://soot-build.cs.uni-paderborn.de/jenkins/job/soot/job/soot-develop/)
1+
[![Build Status](https://soot-build.cs.uni-paderborn.de/jenkins/job/soot/job/soot-pipeline/job/develop/badge/icon)](https://soot-build.cs.uni-paderborn.de/jenkins/job/soot/job/soot-pipeline/job/develop/)
22

33
# Using Soot? Let us know about it!
44
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**](https://github.com/Sable/soot/wiki/Users-of-Soot), both commercially or in the form of research tools.
@@ -30,7 +30,9 @@ See http://www.sable.mcgill.ca/soot/ for details.
3030

3131
# How do I get started with Soot?
3232

33-
We have some documentation on Soot in the [wiki](https://github.com/Sable/soot/wiki) and also a large range of [tutorials](http://www.sable.mcgill.ca/soot/tutorial/index.html) on Soot.
33+
We have some documentation on Soot in the [wiki](https://github.com/Sable/soot/wiki) and also a large range of [tutorials](http://www.sable.mcgill.ca/soot/tutorial/index.html) on Soot.
34+
35+
For detailed information please also consider the Soot's [JavaDoc and Options](https://github.com/Sable/soot/wiki/Options-and-JavaDoc) Documentations.
3436

3537
# Including Soot in your Project
3638

@@ -43,7 +45,7 @@ a dependency via Maven, Gradle, SBT, etc using the following coordinates:
4345
<dependency>
4446
<groupId>ca.mcgill.sable</groupId>
4547
<artifactId>soot</artifactId>
46-
<version>3.4.0-SNAPSHOT</version>
48+
<version>4.0.0-SNAPSHOT</version>
4749
</dependency>
4850
</dependencies>
4951
<repositories>
@@ -95,53 +97,50 @@ If you want to execute Soot with Java 8 but analyze Java >8 Projects or vice ver
9597

9698
## Use from Source Code
9799
To load modules in Soot's `ModuleScene` from java:
98-
```
100+
```.java
99101
// configure Soot's options
100102
Options.v().set_soot_modulepath(modulePath);
101103

102104

103105
// load classes from modules into Soot
104-
Map<String, List<String>> map = ModulePathSourceLocator.v().getClassUnderModulePath(modulePath);
105-
for (String module : map.keySet()) {
106-
for (String klass : map.get(module)) {
107-
logger.info("Loaded Class: " + klass + "\n");
108-
loadClass(klass, false, module);
106+
Map<String, List<String>> map = ModulePathSourceLocator.v().getClassUnderModulePath(modulePath);
107+
for (String module : map.keySet()) {
108+
for (String klass : map.get(module)) {
109+
logger.info("Loaded Class: " + klass + "\n");
110+
loadClass(klass, false, module);
109111

110-
}
111-
}
112+
}
113+
}
112114

113115

114-
//this must be called after all classes are loaded
115-
Scene.v().loadNecessaryClasses();
116+
//this must be called after all classes are loaded
117+
Scene.v().loadNecessaryClasses();
116118

117119

118-
public static SootClass loadClass(String name, boolean main, String module) {
119-
SootClass c = ModuleScene.v().loadClassAndSupport(name, Optional.of(module));
120-
c.setApplicationClass();
121-
if (main)
122-
Scene.v().setMainClass(c);
123-
return c;
124-
}
120+
public static SootClass loadClass(String name, boolean main, String module) {
121+
SootClass c = ModuleScene.v().loadClassAndSupport(name, Optional.of(module));
122+
c.setApplicationClass();
123+
if (main)
124+
Scene.v().setMainClass(c);
125+
return c;
126+
}
125127

126128
```
127129

128130

129131
### Example Configurations: Java 8, Java >= 9 Classpath, Java >= 9 Modulepath
130132

131-
```
133+
```.java
132134

133135
if(java < 9 ) {
134-
135136
Options.v().set_prepend_classpath(true);
136137
Options.v().set_process_dir(Arrays.asList(applicationClassPath().split(File.pathSeparator)));
137-
138138
Options.v().set_claspath(sootClassPath();
139139
}
140140

141141
if(java >= 9 && USE_CLASSPATH){
142142
Options.v().set_soot_classpath("VIRTUAL_FS_FOR_JDK" + File.pathSeparator + sootClassPath());
143143
Options.v().set_process_dir(Arrays.asList(applicationClassPath().split(File.pathSeparator)));
144-
145144
}
146145

147146

0 commit comments

Comments
 (0)