Add functionality for appending unique IDs to sequence statements

thdiaman · thdiaman · commit d571066f4824 · 2017-05-09T17:39:45.000+03:00
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ There are also certain options when extracting the snippets provided as paramete
 - <code>keepBranches</code>: denotes if all branch paths should be kept, or only the first path of each branch.
 - <code>outputTree</code>: denotes if the output should be a tree, or a sequence.
 - <code>flattenOutput</code>: denotes if the output should be flattened, i.e. all paths to be merged in a single sequence, or different paths should be retained.
+- <code>addUniqueIDs</code>: denotes if statements should have unique IDs, default is false.
 
 
 Using in Python
diff --git a/src/outputhelpers/FlattenedSequencePrinter.java b/src/outputhelpers/FlattenedSequencePrinter.java
@@ -18,10 +18,12 @@ public class FlattenedSequencePrinter implements SnippetPrinter {
 	 * functions, this function would return [A, B, C, D, E].
 	 * 
 	 * @param snippet the snippet to be parsed.
+	 * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).
 	 * @return a flattened tree representation for the snippet.
 	 */
 	@Override
-	public String snippetToString(Snippet snippet) {
+	public String snippetToString(Snippet snippet, boolean addUniqueIDs) {
+		int id = 0;
 		String seq = "[";
 		for (LevelOrderPair orderAndLevel : snippet.blocks.keySet()) {
 			for (Block block : snippet.blocks.get(orderAndLevel)) {
@@ -39,7 +41,8 @@ public String snippetToString(Snippet snippet) {
 								|| statement.toString().equals("END_CONDITION")
 								|| statement.toString().equals("END_CASE") || statement.toString().equals("END_TRY")
 								|| statement.toString().equals("END_LOOP")))
-							seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString();
+							seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString()
+									+ (addUniqueIDs ? "#" + (++id) : "");
 					}
 				}
 			}
diff --git a/src/outputhelpers/FlattenedTreePrinter.java b/src/outputhelpers/FlattenedTreePrinter.java
@@ -15,10 +15,11 @@ public class FlattenedTreePrinter implements SnippetPrinter {
 	 * [[A, B, D], [A, B, E], [A, C, D], [A, C, E]].
 	 * 
 	 * @param snippet the snippet to be parsed.
+	 * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).
 	 * @return a flattened tree representation for the snippet.
 	 */
 	@Override
-	public String snippetToString(Snippet snippet) {
+	public String snippetToString(Snippet snippet, boolean addUniqueIDs) {
 		throw new UnsupportedOperationException("Not implemented yet");
 	}
 
diff --git a/src/outputhelpers/SequencePrinter.java b/src/outputhelpers/SequencePrinter.java
@@ -17,10 +17,12 @@ public class SequencePrinter implements SnippetPrinter {
 	 * An example of a sequence would be [[A, B, C], [D, E]], where [A, B, C] and [D, E] are sequences of two functions.
 	 * 
 	 * @param snippet the snippet to be parsed.
+	 * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).
 	 * @return a tree representation for the snippet.
 	 */
 	@Override
-	public String snippetToString(Snippet snippet) {
+	public String snippetToString(Snippet snippet, boolean addUniqueIDs) {
+		int id = 0;
 		String seq = "[";
 		for (LevelOrderPair orderAndLevel : snippet.blocks.keySet()) {
 			for (Block block : snippet.blocks.get(orderAndLevel)) {
@@ -43,7 +45,8 @@ else if (!(statement.toString().equals("START_METHOD")
 								|| statement.toString().equals("END_CONDITION")
 								|| statement.toString().equals("END_CASE") || statement.toString().equals("END_TRY")
 								|| statement.toString().equals("END_LOOP")))
-							seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString();
+							seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString()
+									+ (addUniqueIDs ? "#" + (++id) : "");
 					}
 				}
 			}
diff --git a/src/outputhelpers/SnippetPrinter.java b/src/outputhelpers/SnippetPrinter.java
@@ -13,8 +13,9 @@ public interface SnippetPrinter {
 	 * Receives a snippet and returns a string representation.
 	 * 
 	 * @param snippet the snippet to be parsed.
+	 * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).
 	 * @return a string representation for the snippet.
 	 */
-	public String snippetToString(Snippet snippet);
+	public String snippetToString(Snippet snippet, boolean addUniqueIDs);
 
 }
diff --git a/src/outputhelpers/TreePrinter.java b/src/outputhelpers/TreePrinter.java
@@ -17,10 +17,12 @@ public class TreePrinter implements SnippetPrinter {
 	 * An example of the snippet tree would be [[A, [B, C], [D, E]]].
 	 * 
 	 * @param snippet the snippet to be parsed.
+	 * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).
 	 * @return a tree representation for the snippet.
 	 */
 	@Override
-	public String snippetToString(Snippet snippet) {
+	public String snippetToString(Snippet snippet, boolean addUniqueIDs) {
+		int id = 0;
 		String treeseq = "[";
 		for (LevelOrderPair orderAndLevel : snippet.blocks.keySet()) {
 			for (Block block : snippet.blocks.get(orderAndLevel)) {
@@ -49,7 +51,8 @@ else if (statement.toString().equals("END_CONDITION") || statement.toString().eq
 						else if (statement.toString().equals("END_TRY"))
 							treeseq += "";
 						else
-							treeseq += (treeseq.charAt(treeseq.length() - 1) == '[' ? "" : ", ") + statement.toString();
+							treeseq += (treeseq.charAt(treeseq.length() - 1) == '[' ? "" : ", ") + statement.toString()
+									+ (addUniqueIDs ? "#" + (++id) : "");
 					}
 				}
 			}
diff --git a/src/sequenceextractor/PythonBinder.java b/src/sequenceextractor/PythonBinder.java
@@ -26,6 +26,7 @@ public static void main(String[] args) {
 		boolean keepBranches = args.length > 2 ? Boolean.parseBoolean(args[2]) : true;
 		boolean outputTree = args.length > 3 ? Boolean.parseBoolean(args[3]) : false;
 		boolean flattenOutput = args.length > 4 ? Boolean.parseBoolean(args[4]) : true;
+		boolean addUniqueIDs = args.length > 5 ? Boolean.parseBoolean(args[5]) : false;
 		Scanner scanner = new Scanner(System.in);
 		while (scanner.hasNextLine()) {
 			// Receive message and decode it
@@ -50,7 +51,7 @@ public static void main(String[] args) {
 				break;
 			} else {
 				messageresult = SequenceExtractor.extractSequence(message, keepFunctionCallTypes, keepLiterals,
-						keepBranches, outputTree, flattenOutput).toString();
+						keepBranches, outputTree, flattenOutput, addUniqueIDs).toString();
 				String b64messageresult = DatatypeConverter
 						.printBase64Binary(messageresult.getBytes(Charset.forName("US-ASCII")));
 				System.out.println(b64messageresult);
diff --git a/src/sequenceextractor/SequenceExtractor.java b/src/sequenceextractor/SequenceExtractor.java
@@ -452,7 +452,7 @@ protected static String getASTofSnippet(String snippet) {
 	 * @return the snippet as a list of statements.
 	 */
 	public static String extractSequence(String snippet) {
-		return extractSequence(snippet, false, false, true, false, true);
+		return extractSequence(snippet, false, false, true, false, true, false);
 	}
 
 	/**
@@ -467,7 +467,7 @@ public static String extractSequence(String snippet) {
 	 * @return the snippet as a list of statements.
 	 */
 	public static String extractSequence(String snippet, boolean keepFunctionCallTypes, boolean keepLiterals,
-			boolean keepBranches, boolean outputTree, boolean flattenOutput) {
+			boolean keepBranches, boolean outputTree, boolean flattenOutput, boolean addUniqueIDs) {
 		String ast = getASTofSnippet(snippet);
 		Snippet seq = createSequence(ast, keepFunctionCallTypes, keepLiterals, keepBranches);
 		SnippetPrinter printer;
@@ -482,7 +482,7 @@ public static String extractSequence(String snippet, boolean keepFunctionCallTyp
 			else
 				printer = new FlattenedSequencePrinter();
 		}
-		return printer.snippetToString(seq);
+		return printer.snippetToString(seq, addUniqueIDs);
 	}
 
 }
diff --git a/srcpy/sequenceextractor.py b/srcpy/sequenceextractor.py
@@ -8,7 +8,7 @@ class _SequenceExtractor(object):
 	and opening pipes to the standard input and standard output so that messages can be sent and received.
 	Instead of using this class, it is highly recommended to use the abstracted SequenceExtractor class.
 	"""
-	def __init__(self, path_to_SequenceExtractor_jar, keep_function_call_types=False, keep_literals=False, keep_branches=True, output_tree=False, flatten_output=True):
+	def __init__(self, path_to_SequenceExtractor_jar, keep_function_call_types=False, keep_literals=False, keep_branches=True, output_tree=False, flatten_output=True, add_unique_ids=False):
 		"""
 		Initializes this inner extractor.
 		
@@ -17,11 +17,13 @@ def __init__(self, path_to_SequenceExtractor_jar, keep_function_call_types=False
 		:param keep_literals: boolean denoting whether literals (primitives) should be retained.
 		:param keep_branches: boolean denoting whether all branches should be kept.
 		:param output_tree: boolean denoting whether the output should be a tree or a sequence.
-		:param flatten_output: boolean denoting whether the output should be flattened-.
+		:param flatten_output: boolean denoting whether the output should be flattened.
+		:param add_unique_ids: boolean denoting whether statements should have IDs.
 		"""
-		self.cmd = ['java', '-cp', path_to_SequenceExtractor_jar, 'sequenceextractor.PythonBinder', 'true' if keep_function_call_types else 'false',
-					'true' if keep_literals else 'false', 'true' if keep_branches else 'false',
-					'true' if output_tree else 'false', 'true' if flatten_output else 'false']
+		self.cmd = ['java', '-cp', path_to_SequenceExtractor_jar, 'sequenceextractor.PythonBinder',
+					'true' if keep_function_call_types else 'false', 'true' if keep_literals else 'false',
+					'true' if keep_branches else 'false', 'true' if output_tree else 'false',
+					'true' if flatten_output else 'false', 'true' if add_unique_ids else 'false']
 		self.proc = subprocess.Popen(self.cmd, stdin=PIPE, stdout=PIPE, stderr=STDOUT)
 		self.nummessages = 0
 		line = self.send_message("START_OF_TRANSMISSION")
@@ -80,7 +82,7 @@ class SequenceExtractor(_SequenceExtractor):
 	"""
 	Class used as a python binding to the SequenceExtractor library. It contains functions for parsing java snippets to sequences.
 	"""
-	def __init__(self, path_to_SequenceExtractor_jar, keep_function_call_types=False, keep_literals=False, keep_branches=True, output_tree=False, flatten_output=True):
+	def __init__(self, path_to_SequenceExtractor_jar, keep_function_call_types=False, keep_literals=False, keep_branches=True, output_tree=False, flatten_output=True, add_unique_ids=False):
 		"""
 		Initializes this Sequence Extractor.
 		
@@ -89,9 +91,10 @@ def __init__(self, path_to_SequenceExtractor_jar, keep_function_call_types=False
 		:param keep_literals: boolean denoting whether literals (primitives) should be retained.
 		:param keep_branches: boolean denoting whether all branches should be kept.
 		:param output_tree: boolean denoting whether the output should be a tree or a sequence.
-		:param flatten_output: boolean denoting whether the output should be flattened-.
+		:param flatten_output: boolean denoting whether the output should be flattened.
+		:param add_unique_ids: boolean denoting whether statements should have IDs.
 		"""
-		super(SequenceExtractor, self).__init__(path_to_SequenceExtractor_jar, keep_function_call_types, keep_literals, keep_branches, output_tree, flatten_output)
+		super(SequenceExtractor, self).__init__(path_to_SequenceExtractor_jar, keep_function_call_types, keep_literals, keep_branches, output_tree, flatten_output, add_unique_ids)
 
 	def parse_snippet(self, snippet_contents):
 		"""

Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,12 @@ public class FlattenedSequencePrinter implements SnippetPrinter {`
`18`	`18`	`* functions, this function would return [A, B, C, D, E].`
`19`	`19`	`*`
`20`	`20`	`* @param snippet the snippet to be parsed.`
	`21`	`+ * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).`
`21`	`22`	`* @return a flattened tree representation for the snippet.`
`22`	`23`	`*/`
`23`	`24`	`@Override`
`24`		`- public String snippetToString(Snippet snippet) {`
	`25`	`+ public String snippetToString(Snippet snippet, boolean addUniqueIDs) {`
	`26`	`+ int id = 0;`
`25`	`27`	`String seq = "[";`
`26`	`28`	`for (LevelOrderPair orderAndLevel : snippet.blocks.keySet()) {`
`27`	`29`	`for (Block block : snippet.blocks.get(orderAndLevel)) {`
`@@ -39,7 +41,8 @@ public String snippetToString(Snippet snippet) {`
`39`	`41`	`\|\| statement.toString().equals("END_CONDITION")`
`40`	`42`	`\|\| statement.toString().equals("END_CASE") \|\| statement.toString().equals("END_TRY")`
`41`	`43`	`\|\| statement.toString().equals("END_LOOP")))`
`42`		`- seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString();`
	`44`	`+ seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString()`
	`45`	`+ + (addUniqueIDs ? "#" + (++id) : "");`
`43`	`46`	`}`
`44`	`47`	`}`
`45`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,11 @@ public class FlattenedTreePrinter implements SnippetPrinter {`
`15`	`15`	`* [[A, B, D], [A, B, E], [A, C, D], [A, C, E]].`
`16`	`16`	`*`
`17`	`17`	`* @param snippet the snippet to be parsed.`
	`18`	`+ * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).`
`18`	`19`	`* @return a flattened tree representation for the snippet.`
`19`	`20`	`*/`
`20`	`21`	`@Override`
`21`		`- public String snippetToString(Snippet snippet) {`
	`22`	`+ public String snippetToString(Snippet snippet, boolean addUniqueIDs) {`
`22`	`23`	`throw new UnsupportedOperationException("Not implemented yet");`
`23`	`24`	`}`
`24`	`25`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,12 @@ public class SequencePrinter implements SnippetPrinter {`
`17`	`17`	`* An example of a sequence would be [[A, B, C], [D, E]], where [A, B, C] and [D, E] are sequences of two functions.`
`18`	`18`	`*`
`19`	`19`	`* @param snippet the snippet to be parsed.`
	`20`	`+ * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).`
`20`	`21`	`* @return a tree representation for the snippet.`
`21`	`22`	`*/`
`22`	`23`	`@Override`
`23`		`- public String snippetToString(Snippet snippet) {`
	`24`	`+ public String snippetToString(Snippet snippet, boolean addUniqueIDs) {`
	`25`	`+ int id = 0;`
`24`	`26`	`String seq = "[";`
`25`	`27`	`for (LevelOrderPair orderAndLevel : snippet.blocks.keySet()) {`
`26`	`28`	`for (Block block : snippet.blocks.get(orderAndLevel)) {`
`@@ -43,7 +45,8 @@ else if (!(statement.toString().equals("START_METHOD")`
`43`	`45`	`\|\| statement.toString().equals("END_CONDITION")`
`44`	`46`	`\|\| statement.toString().equals("END_CASE") \|\| statement.toString().equals("END_TRY")`
`45`	`47`	`\|\| statement.toString().equals("END_LOOP")))`
`46`		`- seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString();`
	`48`	`+ seq += (seq.charAt(seq.length() - 1) == '[' ? "" : ", ") + statement.toString()`
	`49`	`+ + (addUniqueIDs ? "#" + (++id) : "");`
`47`	`50`	`}`
`48`	`51`	`}`
`49`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,9 @@ public interface SnippetPrinter {`
`13`	`13`	`* Receives a snippet and returns a string representation.`
`14`	`14`	`*`
`15`	`15`	`* @param snippet the snippet to be parsed.`
	`16`	`+ * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).`
`16`	`17`	`* @return a string representation for the snippet.`
`17`	`18`	`*/`
`18`		`- public String snippetToString(Snippet snippet);`
	`19`	`+ public String snippetToString(Snippet snippet, boolean addUniqueIDs);`
`19`	`20`
`20`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,12 @@ public class TreePrinter implements SnippetPrinter {`
`17`	`17`	`* An example of the snippet tree would be [[A, [B, C], [D, E]]].`
`18`	`18`	`*`
`19`	`19`	`* @param snippet the snippet to be parsed.`
	`20`	`+ * @param addUniqueIDs boolean denoting whether statements should have IDs ({@code true}) or not ({@code false}).`
`20`	`21`	`* @return a tree representation for the snippet.`
`21`	`22`	`*/`
`22`	`23`	`@Override`
`23`		`- public String snippetToString(Snippet snippet) {`
	`24`	`+ public String snippetToString(Snippet snippet, boolean addUniqueIDs) {`
	`25`	`+ int id = 0;`
`24`	`26`	`String treeseq = "[";`
`25`	`27`	`for (LevelOrderPair orderAndLevel : snippet.blocks.keySet()) {`
`26`	`28`	`for (Block block : snippet.blocks.get(orderAndLevel)) {`
`@@ -49,7 +51,8 @@ else if (statement.toString().equals("END_CONDITION") \|\| statement.toString().eq`
`49`	`51`	`else if (statement.toString().equals("END_TRY"))`
`50`	`52`	`treeseq += "";`
`51`	`53`	`else`
`52`		`- treeseq += (treeseq.charAt(treeseq.length() - 1) == '[' ? "" : ", ") + statement.toString();`
	`54`	`+ treeseq += (treeseq.charAt(treeseq.length() - 1) == '[' ? "" : ", ") + statement.toString()`
	`55`	`+ + (addUniqueIDs ? "#" + (++id) : "");`
`53`	`56`	`}`
`54`	`57`	`}`
`55`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -452,7 +452,7 @@ protected static String getASTofSnippet(String snippet) {`
`452`	`452`	`* @return the snippet as a list of statements.`
`453`	`453`	`*/`
`454`	`454`	`public static String extractSequence(String snippet) {`
`455`		`- return extractSequence(snippet, false, false, true, false, true);`
	`455`	`+ return extractSequence(snippet, false, false, true, false, true, false);`
`456`	`456`	`}`
`457`	`457`
`458`	`458`	`/**`
`@@ -467,7 +467,7 @@ public static String extractSequence(String snippet) {`
`467`	`467`	`* @return the snippet as a list of statements.`
`468`	`468`	`*/`
`469`	`469`	`public static String extractSequence(String snippet, boolean keepFunctionCallTypes, boolean keepLiterals,`
`470`		`- boolean keepBranches, boolean outputTree, boolean flattenOutput) {`
	`470`	`+ boolean keepBranches, boolean outputTree, boolean flattenOutput, boolean addUniqueIDs) {`
`471`	`471`	`String ast = getASTofSnippet(snippet);`
`472`	`472`	`Snippet seq = createSequence(ast, keepFunctionCallTypes, keepLiterals, keepBranches);`
`473`	`473`	`SnippetPrinter printer;`
`@@ -482,7 +482,7 @@ public static String extractSequence(String snippet, boolean keepFunctionCallTyp`
`482`	`482`	`else`
`483`	`483`	`printer = new FlattenedSequencePrinter();`
`484`	`484`	`}`
`485`		`- return printer.snippetToString(seq);`
	`485`	`+ return printer.snippetToString(seq, addUniqueIDs);`
`486`	`486`	`}`
`487`	`487`
`488`	`488`	`}`