Changes between Version 5 and Version 6 of SuffixTreeBasedDuplicateCodeAnalysis

Timestamp:

May 27, 2012, 10:12:30 PM (13 years ago)

Author:

manualwiki

Comment:

--

SuffixTreeBasedDuplicateCodeAnalysis

@@ -15 +15 @@
 
 ||=Property=||=Description=||=Type=||=Default value=||=Example=||
-||files||files in which the search is carried out||[Module::atom() [[BR]] |Filepath::string() [[BR]] |RegExp::string() [[BR]] |File::string()]||all files from the database||{files,["/usr/local/lib/erlang/lib/mnesia-4.5/src/mnesia_log.erl", module]}||
+||files||specify files to search||[Module::atom() [[BR]] |Filepath::string() [[BR]] |RegExp::string() [[BR]] |File::string()]||all files from the database||{files,["/usr/local/lib/erlang/lib/mnesia-4.5/src/mnesia_log.erl", module]}||
 ||minlen||minimal length of a clone(length is in tokens)||integer()||10||{minlen,50}||
 ||minnum||minimal number of clones in one clone group||integer()||2||{minnum,5}||
 ||overlap||maximum length that duplicates can overlap each other (length is in tokens)||integer()||0||{overlap,1}||
-||output||name of the file in which to save the result of the analysis||string()||-||{output,"result.txt"}||
-||name||name of the result in the table||atom()||the string "temp" concatenated with the timestamp||{name,referl}||
+||output||name of the file in which the results are saved||string()||-||{output,"result.txt"}||
+||name||name of the result in the table||atom()||the atom 'temp' concatenated with the timestamp||{name,referl}||
 
 == Interfaces ==
@@ -29 +29 @@
 === Console interface ===
 
-We currently have two interface functions in the ri module: search_duplicates/0 
-and search_duplicates/1. The first uses the default values of the parameters. 
-The second takes a proplist as parameter described above. Both interface 
-function provide information about the progress of the process. The result is 
-the list of clone groups. Every clones are defined by the path of the file and 
-information about the start and end positions (line and column number).
-An example can be found at the bottom of the page.
+==== Analyser functions ====
+
+* search_duplicates/0: uses the default values of the properties.
+* search_duplicates/1: takes a proplist as parameter described above.
+
+Both interface function provide information about the progress of the process. 
+The result is the list of clone groups. Every clones are defined by the path of 
+the file and information about the start and end positions (line and column number).
+Results are saved. An example can be found at the bottom of the page.
+
+==== Result query functions ====
+
+||Function||Parameters||Description||Example||
+||stored_dupcode_results/0||-||queries all saved results (name and information about the parameters of the analysis)||{{{ri:stored_dupcode_results()}}}||
+||save_dupcode_result/2||Name::atom() - name associated with the result,[[BR]]Filename::string() - name of the file||saves the given result in the file||{{{ri:save_dupcode_result(temp20120527205412,"result.txt")}}}||
+||show_dupcode/1||Name::atom() - name associated with the result||lists the result's all clone groupes||{{{ri:show_dupcode(temp20120527205412)}}}||
+||show_dupcode_group/2||Name::atom() - name associated with the result,[[BR]]GroupNumber::integer() - the required clone group's number||lists the given clone group of the result||{{{ri:show_dupcode_group(temp20120527205412, 2)}}}||
 
 == Examples ==
+
+=== Analysis functions ===
+
+Calling and allowed parameterizations:
 
 {{{#!erlang
@@ -45 +59 @@
 {{{#!erlang
 ri:search_duplicates([
-        {files, ["/home/user/dups/dup1.erl",
+        {files, [dup2,
+                 "/home/user/dups/dup1.erl",
                  "/home/[0-9a-zA-Z/_.\-]+/src"]},
         {minlen, 50},
@@ -54 +69 @@
 }}}
 
-Small example of the return value and the progress report:
+Return value and the progress report (only if the analysis was not run yet):
 
 {{{#!erlang
-ri:search_duplicates([{files,[dup1, dup2]}]).
+(refactorerl@localhost)3> ri:search_duplicates([{files,[dup1,dup2]}]).
 
 Initial clone detection started.
@@ -66 +81 @@
 Calculating positions started.
 Calculating positions finished.
-[[[{filepath,"/home/user/dups/dup1.erl"},
-   {startpos,{15,1}},
-   {endpos,{17,24}}],
-  [{filepath,"/home/user/dups/dup2.erl"},
-   {startpos,{5,1}},
-   {endpos,{7,24}}]],
- [[{filepath,"/home/user/dups/dup1.erl"},
-   {startpos,{8,1}},
-   {endpos,{14,11}}],
-  [{filepath,"/home/user/dups/dup2.erl"},
-   {startpos,{12,1}},
-   {endpos,{18,11}}]]]
+2 clone groups found.
+Result saved to temp20120527234307...
+run ri:show_dupcode(temp20120527234307) to see the result.
+ok
+
+(refactorerl@localhost)4> ri:search_duplicates([{files,[dup1,dup2]}]).
+2 clone groups found.
+Result saved to temp20120527234307...
+run ri:show_dupcode(temp20120527234307) to see the result.
+ok
 }}}
+
+=== Result query functions ===
+
+{{{#!erlang
+(refactorerl@localhost)5> ri:stored_dupcode_results().
+[[temp20120527234307,
+  [{files,[{"/home/user/dups/dup1.erl",
+            112018930},
+           {"/home/user/dups/dup2.erl",
+            96559118}]},
+   {minlen,10},
+   {minnum,2},
+   {overlap,0}]],
+ [temp20120527235556,
+  [{files,[{"/usr/local/lib/erlang/lib/mnesia-4.5/src/mnesia_schema.erl",
+            101394176}]},
+   {minlen,20},
+   {minnum,3},
+   {overlap,0}]]]
+}}}
+
+{{{#!erlang
+(refactorerl@localhost)17> ri:show_dupcode(temp20120527234307).        
+[{1,
+  [[{filepath,"/home/user/dups/dup1.erl"},
+    {startpos,{8,1}},
+    {endpos,{18,11}}],
+   [{filepath,"/home/user/dups/dup2.erl"},
+    {startpos,{5,1}},
+    {endpos,{15,11}}]]},
+ {2,
+  [[{filepath,"/home/user/dups/dup1.erl"},
+    {startpos,{6,5}},
+    {endpos,{6,62}}],
+   [{filepath,"/home/user/dups/dup2.erl"},
+    {startpos,{18,5}},
+    {endpos,{18,58}}]]}]
+Contains 2 clone groups...
+run ri:show_dupcode_group(temp20120527234307, GroupNumber::integer()) to see one of the clone groups.
+ok
+}}}
+
+{{{#!erlang
+(refactorerl@localhost)16> ri:show_dupcode_group(temp20120527234307,2).
+[[{filepath,"/home/user/dups/dup1.erl"},
+  {startpos,{6,5}},
+  {endpos,{6,62}}],
+ [{filepath,"/home/user/dups/dup2.erl"},
+  {startpos,{18,5}},
+  {endpos,{18,58}}]]
+Contains 2 members.
+ok
+}}}