chore: help readingness and add some documentation (SpoonLabs#95)

Author: surli

.gitignore

@@ -35,6 +35,8 @@ log
 
 # Nopol
 z3
+nopol/src-gen
+nopol/target-gen
 
 # Nopol-Server
 nopol-server/out

doc/jpf.md

@@ -2,12 +2,28 @@
 
 ## Installation
 
-1. clone jpf-core and jpf-symbc into a jpf folder
-2. clone z3 for java (```git clone https://github.com/Z3Prover/z3```)
-3. build z3 (```python scripts/mk_make.py --java;cd build;make```)
-4. define a `DYLD_LIBRARY_PATH` (for mac) `LD_LIBRARY_PATH` (for linux) with this value: `${project_path}/lib:$DYLD_LIBRARY_PATH:<path_to_z3_build_folder>`
-5. create ```~/.jpf/site.properties```
-6. put in ```~/.jpf/site.properties```
+### Requirements
+
+- JDK 8
+- Ant
+
+### Install JPF Core
+1. clone jpf-core from https://github.com/grzesuav/jpf-core 
+2. Go to the directory and type: `ant`
+
+### Install JPF Symb
+1. clone jpf-symbc from https://github.com/grzesuav/jpf-symbc
+2. go to the cloned directory and type `ant`
+
+### Install Z3
+1. clone z3 for java (```git clone https://github.com/Z3Prover/z3```)
+2. build z3 (```python scripts/mk_make.py --java;cd build;make```)
+
+### Create properties
+
+1. define a `DYLD_LIBRARY_PATH` (for mac) `LD_LIBRARY_PATH` (for linux) with this value: `${project_path}/lib:$DYLD_LIBRARY_PATH:<path_to_z3_build_folder>`
+2. create ```~/.jpf/site.properties```
+3. put in ```~/.jpf/site.properties```
 
 ```property
 # JPF site configuration

nopol/src/main/java/fr/inria/lille/commons/spoon/SpoonedFile.java

@@ -37,26 +37,37 @@
 
 public abstract class SpoonedFile {
 
-    protected final Config config;
+    private File[] sourceFiles;
+    private URL[] projectClasspath;
+    private URL[] compilationClasspath;
+    private Factory factory;
+    private ProcessingManager manager;
+    private DynamicClassCompiler compiler;
+    private Map<String, byte[]> compiledClasses;
+    private DefaultJavaPrettyPrinter prettyPrinter;
 
-    protected abstract Collection<? extends CtType<?>> modelledClasses();
+    protected final Config config;
 
     public SpoonedFile(File[] sourceFiles, URL[] projectClasspath, Config config) {
-        //logDebug(logger(), format("[Building Spoon model from %s]", sourceFiles));
         this.config = config;
         this.sourceFiles = sourceFiles;
         this.projectClasspath = projectClasspath;
+
         factory = SpoonModelLibrary.newFactory();
         factory.getEnvironment().setComplianceLevel(config.getComplianceLevel());
         factory.getEnvironment().setCommentEnabled(false);
         factory.getEnvironment().setLevel(Level.OFF.toString());
+
         factory = SpoonModelLibrary.modelFor(factory, sourceFiles, projectClasspath());
+
         compiler = new DynamicClassCompiler(compilationClasspath(), config);
-        manager = new RuntimeProcessingManager(spoonFactory());
+        manager = new RuntimeProcessingManager(factory);
         compiledClasses = MetaMap.newHashMap();
         prettyPrinter = new DefaultJavaPrettyPrinter(spoonEnvironment());
     }
 
+    protected abstract Collection<? extends CtType<?>> modelledClasses();
+
     public void generateOutputFile(File destinationFolder) {
         Processor<?> writer = new JavaOutputProcessor(destinationFolder, new DefaultJavaPrettyPrinter(new StandardEnvironment()));
         process(writer);
@@ -237,13 +248,4 @@ public String toString() {
     private Logger logger() {
         return loggerFor(this);
     }
-
-    private File[] sourceFiles;
-    private URL[] projectClasspath;
-    private URL[] compilationClasspath;
-    private Factory factory;
-    private ProcessingManager manager;
-    private DynamicClassCompiler compiler;
-    private Map<String, byte[]> compiledClasses;
-    private DefaultJavaPrettyPrinter prettyPrinter;
 }

nopol/src/main/java/fr/inria/lille/commons/spoon/util/SpoonModelLibrary.java

@@ -217,18 +217,6 @@ public static void setLoopingCondition(CtWhile loop, CtExpression<Boolean> loopi
         loop.setLoopingExpression(loopingCondition);
     }
 
-    public static CoreFactory coreFactoryOf(CtElement element) {
-        return element.getFactory().Core();
-    }
-
-    public static CodeFactory codeFactoryOf(CtElement element) {
-        return element.getFactory().Code();
-    }
-
-    public static Environment newEnvironment() {
-        return newFactory().getEnvironment();
-    }
-
     public static Factory newFactory() {
         return launcher().createFactory();
     }