soot-oss · kadirayk · Sep 27, 2021 · Aug 25, 2021 · Aug 25, 2021 · Aug 30, 2021
diff --git a/docs/BodyInterceptor.md b/docs/BodyInterceptor.md
@@ -0,0 +1,28 @@
+#### LocalSplitter
+
+LocalSplitter is a <code>BodyInterceptor</code> that attempts to identify and separate uses of a local variable (as definition) that are independent of each other by renaming local variable.
-LocalSplitter is a <code>BodyInterceptor</code> that attempts to identify and separate uses of a local variable (as definition) that are independent of each other by renaming local variable.
+LocalSplitter is a <code>BodyInterceptor</code> that attempts to identify and separate uses of a local variable (as definition) that are independent of each other by renaming local variables.
-LocalSplitter is a <code>BodyInterceptor</code> that attempts to identify and separate uses of a local variable (as definition) that are independent of each other by renaming local variable.
+LocalSplitter is a <code>BodyInterceptor</code> that attempts to identify and separate uses of a local variable (as definition) that are independent of each other by renaming local variables.
+
+Example 1: 
+
+![LocalSplitter Example_1](./figures/LocalSplitter Example_1.png)
+
+As shown the example above, the local variable <code>l1</code> is defined twice. It can be split up into two new local variables: <code>l1#1</code> and <code>l1#2</code> because of the independency between its two definitions. 
-As shown the example above, the local variable <code>l1</code> is defined twice. It can be split up into two new local variables: <code>l1#1</code> and <code>l1#2</code> because of the independency between its two definitions. 
+As shown in the example above, the local variable <code>l1</code> is defined twice. It can be split up into two new local variables: <code>l1#1</code> and <code>l1#2</code> because the two definitions are independent of each other. 
-As shown the example above, the local variable <code>l1</code> is defined twice. It can be split up into two new local variables: <code>l1#1</code> and <code>l1#2</code> because of the independency between its two definitions. 
+As shown in the example above, the local variable <code>l1</code> is defined twice. It can be split up into two new local variables: <code>l1#1</code> and <code>l1#2</code> because the two definitions are independent of each other. 
+
+
+
+Example 2:
+
+![LocalSplitter Example_2](./figures/LocalSplitter Example_2.png)
+
+In the second example, the local variable <code>l2</code> is defined thrice. But it cannot be split up into three new local variables as in the first example. Because its definitions in the if-branches are not independent of each other. Therefore, it can be only split up into two local variables as shown in the figure.
-In the second example, the local variable <code>l2</code> is defined thrice. But it cannot be split up into three new local variables as in the first example. Because its definitions in the if-branches are not independent of each other. Therefore, it can be only split up into two local variables as shown in the figure.
+In the second example, the local variable <code>l2</code> is defined thrice. But it cannot be split up into three new local variables as in the first example, because its definitions in the if-branches are not independent of each other. Therefore, it can only be split up into two local variables as shown in the figure.
-In the second example, the local variable <code>l2</code> is defined thrice. But it cannot be split up into three new local variables as in the first example. Because its definitions in the if-branches are not independent of each other. Therefore, it can be only split up into two local variables as shown in the figure.
+In the second example, the local variable <code>l2</code> is defined thrice. But it cannot be split up into three new local variables as in the first example, because its definitions in the if-branches are not independent of each other. Therefore, it can only be split up into two local variables as shown in the figure.
+
+
+
+#### LocalPacker
+
+LocalPacker is a <code>BodyInterceptor</code> that attempts to minimize the number of local variables used in body by reusing them when possible. It corresponds to the inverse body transformation of LocalSplitter. Note: Every local variable's type should be assigned before running LocalPacker.
+
+Example:
+
+ ![LocalPacker Example](./figures/LocalPacker Example.png)
+
diff --git a/docs/Tools.md b/docs/Tools.md
@@ -0,0 +1,10 @@
+#### LocalLivenessAnalyser
+
+LocalLivenessAnalyser is used for querying for the list of live local variables before and after a given <code>Stmt</code>.
+
+Example:
+
+![LocalLiveness Example](./figures/LocalLiveness Example.png)
+
+The live local variables before and after each <code>Stmt</code> will be calculated after generating an instance of LocalLivenessAnalyser as shown the example above. They can be queried by using the methods <code>getLiveLocalsBeforeStmt</code> and <code>getLiveLocalsAfterStmt</code>.
+
diff --git a/docs/figures/LocalLiveness Example.png b/docs/figures/LocalLiveness Example.png
diff --git a/docs/figures/LocalPacker Example.png b/docs/figures/LocalPacker Example.png
diff --git a/docs/figures/LocalSplitter Example_1.png b/docs/figures/LocalSplitter Example_1.png
diff --git a/docs/figures/LocalSplitter Example_2.png b/docs/figures/LocalSplitter Example_2.png