Various refactorings

Author: silverbullettt

docs/coding-conventions.md

@@ -1,8 +1,6 @@
-## License Header
+## Style
+TODO: apply style tool
 
-## Naming
-
-## Style (TODO: use style tool)
 ### Import
 - Wildcard imports (`import x.y.*`) should not be used.
 - Imports should be sorted (use `Ctrl+Alt+o` in IntelliJ IDEA)
@@ -26,17 +24,17 @@ class Graph {
 }
 ```
 
-### Output (use Logger)
-
+### Output via Logger
+Always use logger to output messages.
 
 ### Annotation (@Override, @Nullable, @Nonnull, ...)
 Always add `@Override` annotation for overridden methods.
 
-For the methods that may return `null`, add `@Nullable` annotation to their return values. For example, `public @Nullable X getX()`.
+For the methods that may return `null`, annotate them with `@Nullable`.
 
 For the methods that require non-`null` arguments, add `@Nonnull` annotation to the specific parameters, For example, `void setX(@Nonnull x)`.
 
-### Use Tai-e Library
+### Use Tai-e Util
 - Use `Sets`/`Maps` to create Sets/Maps.
 When creating Set/Map, use proper `Sets.newSet`/`Maps.newMap()` factory methods instead of `new HashSet/Map<>()`.
 

docs/development-guide.md

@@ -118,7 +118,7 @@ public Set<String> analyze() {
     }
 
     private void setOutput() {
-        String output = getOptions().getString("file");
+        String output = getOptions().getString("action-file");
         if (output != null) {
             try {
                 out = new PrintStream(output);
@@ -131,7 +131,7 @@ private void setOutput() {
     }
 
     private void readInputs() {
-        String input = getOptions().getString("file");
+        String input = getOptions().getString("action-file");
         Path path = Path.of(input);
         try {
             inputs = Maps.newMultiMap();

src/main/java/pascal/taie/analysis/ResultProcessor.java

@@ -34,7 +34,8 @@
  * @param <CallSite> type of call sites
  * @param <Method>   type of methods
  */
-public interface CallGraph<CallSite, Method> extends Graph<Method>, StmtResult<Set<Method>> {
+public interface CallGraph<CallSite, Method>
+        extends Graph<Method>, StmtResult<Set<Method>> {
 
     /**
      * @return the call sites that invoke the given method.

src/main/java/pascal/taie/analysis/graph/callgraph/CallGraph.java

@@ -31,8 +31,6 @@
 import pascal.taie.ir.stmt.Invoke;
 import pascal.taie.language.classes.JMethod;
 
-import java.util.List;
-
 public class CallGraphBuilder extends ProgramAnalysis<CallGraph<Invoke, JMethod>> {
 
     public static final String ID = "cg";
@@ -68,10 +66,9 @@ private static void logStatistics(CallGraph<Invoke, JMethod> callGraph) {
 
     private static void processOptions(CallGraph<Invoke, JMethod> callGraph,
                                        AnalysisOptions options) {
-        String action = options.getString("action");
-        if ("dump".equals(action)) {
-            String file = options.getString("file");
-            CallGraphs.dumpCallGraph(callGraph, file);
+        String dumpFile = options.getString("dump");
+        if (dumpFile != null) {
+            CallGraphs.dumpCallGraph(callGraph, dumpFile);
         }
         String methodsFile = options.getString("dump-methods");
         if (methodsFile != null) {

src/main/java/pascal/taie/analysis/graph/callgraph/CallGraphBuilder.java

@@ -30,7 +30,7 @@
 
 /**
  * Builds call graph based on pointer analysis results.
- * This builder assumes that pointer analysis have been done,
+ * This builder assumes that pointer analysis has finished,
  * and it merely returns the (context-insensitive) call graph
  * obtained from pointer analysis result.
  */

src/main/java/pascal/taie/analysis/graph/callgraph/PTABasedBuilder.java

@@ -70,22 +70,23 @@ public PointerAnalysisResult analyze() {
         AnalysisOptions options = getOptions();
         HeapModel heapModel = new AllocationSiteBasedModel(options);
         ContextSelector selector = null;
-        String pre = options.getString("pre");
+        String advanced = options.getString("advanced");
         String cs = options.getString("cs");
-        if (pre != null) {
+        if (advanced != null) {
             // run context-insensitive analysis as pre-analysis
             PointerAnalysisResult preResult = runAnalysis(heapModel,
                     ContextSelectorFactory.makeCISelector());
-            if (pre.startsWith("scaler")) {
+            if (advanced.startsWith("scaler")) {
                 selector = Timer.runAndCount(() -> ContextSelectorFactory
-                                .makeGuidedSelector(Scaler.run(preResult, pre)),
+                                .makeGuidedSelector(Scaler.run(preResult, advanced)),
                         "Scaler", Level.INFO);
-            } else if (pre.startsWith("zipper")) {
+            } else if (advanced.startsWith("zipper")) {
                 selector = Timer.runAndCount(() -> ContextSelectorFactory
-                                .makeSelectiveSelector(cs, Zipper.run(preResult, pre)),
+                                .makeSelectiveSelector(cs, Zipper.run(preResult, advanced)),
                         "Zipper", Level.INFO);
             } else {
-                throw new IllegalArgumentException("Illegal pre-analysis argument: " + pre);
+                throw new IllegalArgumentException(
+                        "Illegal advanced analysis argument: " + advanced);
             }
         }
         if (selector == null) {

src/main/java/pascal/taie/analysis/pta/PointerAnalysis.java

@@ -91,7 +91,7 @@ public static void process(AnalysisOptions options,
         if (action == null) {
             return;
         }
-        String file = options.getString("file");
+        String file = options.getString("action-file");
         boolean taintEnabled = options.getString("taint-config") != null;
         switch (action) {
             case "dump":

src/main/java/pascal/taie/analysis/pta/plugin/ResultProcessor.java

@@ -348,7 +348,7 @@ interface Action<R> {
      * Creates a new set.
      */
     static BitSet newBitSet(boolean isSparse) {
-        return isSparse ? new SparseBitSet() : new SimpleBitSet();
+        return isSparse ? new SparseBitSet() : new RegularBitSet();
     }
 
     /**

src/main/java/pascal/taie/util/collection/BitSet.java

@@ -25,11 +25,11 @@
 import java.util.Arrays;
 
 /**
- * Simple bit set implementation.
+ * Regular bit set implementation.
  * This implementation is very similar to {@link java.util.Set} which uses
  * a {@code long[]} to store all the set bits.
  */
-public class SimpleBitSet extends AbstractBitSet {
+public class RegularBitSet extends AbstractBitSet {
 
     /* Used to shift left or right for a partial word mask */
     private static final long WORD_MASK = 0xffffffffffffffffL;
@@ -47,7 +47,7 @@ public class SimpleBitSet extends AbstractBitSet {
     /**
      * Creates a new bit set. All bits are initially {@code false}.
      */
-    public SimpleBitSet() {
+    public RegularBitSet() {
         initWords(BITS_PER_WORD);
     }
 
@@ -60,7 +60,7 @@ public SimpleBitSet() {
      * @throws NegativeArraySizeException if the specified initial size
      *                                    is negative
      */
-    public SimpleBitSet(int nbits) {
+    public RegularBitSet(int nbits) {
         // nbits can't be negative; size 0 is OK
         if (nbits < 0)
             throw new NegativeArraySizeException("nbits < 0: " + nbits);
@@ -290,7 +290,7 @@ public boolean intersects(BitSet set) {
         if (this == set) {
             return true;
         }
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             return super.intersects(set);
         }
         for (int i = Math.min(wordsInUse, other.wordsInUse) - 1; i >= 0; i--)
@@ -305,7 +305,7 @@ public boolean contains(BitSet set) {
             return true;
         }
 
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             return super.contains(set);
         }
 
@@ -329,7 +329,7 @@ public boolean and(BitSet set) {
         if (this == set) {
             return false;
         }
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             throw new UnsupportedOperationException(
                     String.format("%s does not support AND with %s",
                             this.getClass(), set.getClass()));
@@ -370,7 +370,7 @@ public boolean andNot(BitSet set) {
             clear();
             return changed;
         }
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             return super.andNot(set);
         }
 
@@ -399,7 +399,7 @@ public boolean or(BitSet set) {
         if (this == set) {
             return false;
         }
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             return super.or(set);
         }
 
@@ -440,11 +440,11 @@ public boolean or(BitSet set) {
 
     @Override
     public BitSet orDiff(BitSet set) {
-        SimpleBitSet diff = new SimpleBitSet();
+        RegularBitSet diff = new RegularBitSet();
         if (this == set) {
             return diff;
         }
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             return super.orDiff(set);
         }
         if (wordsInUse < other.wordsInUse) {
@@ -478,7 +478,7 @@ public boolean xor(BitSet set) {
             clear();
             return changed;
         }
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             return super.xor(set);
         }
 
@@ -522,7 +522,7 @@ public void setTo(BitSet set) {
             return;
         }
 
-        if (!(set instanceof SimpleBitSet other)) {
+        if (!(set instanceof RegularBitSet other)) {
             super.setTo(set);
             return;
         }
@@ -614,7 +614,7 @@ public int hashCode() {
      */
     @Override
     public boolean equals(Object obj) {
-        if (!(obj instanceof SimpleBitSet set))
+        if (!(obj instanceof RegularBitSet set))
             return false;
         if (this == obj)
             return true;
@@ -634,8 +634,8 @@ public boolean equals(Object obj) {
     }
 
     @Override
-    public SimpleBitSet copy() {
-        SimpleBitSet copy = new SimpleBitSet();
+    public RegularBitSet copy() {
+        RegularBitSet copy = new RegularBitSet();
         copy.wordsInUse = wordsInUse;
         copy.words = Arrays.copyOf(words, wordsInUse);
         return copy;