Changes between Version 37 and Version 38 of ErlangShellInterface

Timestamp:

Sep 17, 2014, 3:58:20 PM (10 years ago)

Author:

manualwiki

Comment:

--

ErlangShellInterface

@@ -402 +402 @@
 
 === Duplicated code analysis ===
-In large program systems often occure duplicated code, which is a computer programming term for a sequence of source code that occurs more than once. There are two ways in which two code sequences can be duplicates of each other: syntactically and functionally. This new feature can detect the syntactically similar duplicates. You can learn more about this topic and about the usage, especially about the command-line usage,  on [[DuplicateCodeAnalysis| Duplicate code analysis]] page.
+In large program systems often occure duplicated code, which is a computer programming term for a sequence of source code that occurs more than once. There are two ways in which two code sequences can be duplicates of each other: syntactically and functionally. This new feature can detect the syntactically similar duplicates. You can learn more about this topic and about the usage on CloneIdentifiErl page, whilst the services provided by this interface are detailed below.
+==== Functions ====
+* clone_identifierl/0: uses the default values of properties
+* clone_identifierl/1: takes a proplist as described above
+
+Regardless of the chosen algorithm all output format, which are illustrated below, can be requested.
+* prettyprint: Returns the textual representation of the clones.
+Command: {{{ri:clone_identifierl([{algorithm,sw_metrics}, {files,[ucl_alg_dm]}, {format,prettyprint}]).}}}
+{{{
+-------------------------------------------------------------------------------- 
+Clone element: (found in ucl_alg_dm):
+q_gen(QueryETS) ->
+    fun(F, Ps) ->
+        [{F, Ps1}] = ets:lookup(QueryETS, F),
+        length(list_sort_intersect(Ps1, Ps))
+    end.
+
+-------------------------------------------------------------------------------- 
+-------------------------------------------------------------------------------- 
+Clone element: (found in ucl_alg_dm):
+u_gen(UseETS) ->
+    fun(P, Fs) ->
+        [{P, Fs1}] = ets:lookup(UseETS, P),
+        length(list_sort_intersect(Fs1, Fs))
+    end.
+-------------------------------------------------------------------------------- 
+}}}
+
+* file_and_loc: Returns file and position information related to the clones. When using this output format it is possible to set the position type.
+The {{{linecol}}} position type returns the row and column where the found clone starts and ends. The scalar position type returns the character position where the clone starts and ends.
+
+Command:[[BR]]
+{{{ri:clone_identifierl([{algorithm,sw_metrics}, {files,[ucl_alg_dm]}, {format,file_and_loc}, {postype,linecol]).}}}
+
+
+{{{
+[[[{filepath,"/home/laptop/refactorerl/src/ucl_alg_dm.erl"},
+   {startpos,{12,1}},
+   {endpos,{16,8}}],
+  [{filepath,"/home/laptop/refactorerl/src/ucl_alg_dm.erl"},
+   {startpos,{41,1}},
+   {endpos,{45,8}}]]]
+}}}
+
+Command: [[BR]]
+{{{ri:clone_identifierl([{algorithm,sw_metrics}, {files,[ucl_alg_dm]}, {format,file_and_loc}, {postype,scalar]).}}}
+
+{{{
+[[[{filepath,"/home/laptop/refactorerl/src/ucl_alg_dm.erl"},
+   {startpos,{47}},
+   {endpos,{121}}],
+  [{filepath,"/home/laptop/refactorerl/src/ucl_alg_dm.erl"},
+   {startpos,{520}},
+   {endpos,{576}}]]]
+}}}
+
+* nodes: Returns the internal identifiers of the found clone groups. It is a good choice if you wish to further process the result by scripting using the ris interface.
+Command: {{{ri:clone_identifierl([{algorithm,sw_metrics}, {files,[ucl_alg_dm]}, {format,nodes}]).}}}
+{{{
+[[[{'$gn',form,2}],[{'$gn',form,3}]]]
+}}}
+
+
+==== Result query functions ====
+||=Function=||=Parameters=||=Description=||=Example=||
+|| stored_dupcode_results/0 || - || Returns the list of all saved results (name and information about the parameters of the analysis) || ri:stored_dupcode_results() ||
+|| show_dupcode/1 || Name::atom() - Name associated with the result ||Displays the selected result using the default output format. || ri:show_dupcode(mydups) ||
+|| show_dupcode/2 || Name::atom() - name associated with the result, Format::atom() - requested output format || Displays the selected result using the requested format. || ri:show_dupcode(mysearch,file_and_loc) ||
+|| show_dupcode_group/2 || Name::atom() - name associated with the result, GroupNumber::integer() - the required ID of the clone group belonging to the requested result || Displays the given clone group of the result using the default output format. || ri:show_dupcode_group(mysearch,2) ||
+|| show_dupcode_group/3 || Name::atom() - name associated with the result, GroupNumber::integer() - the required ID of the clone group belonging to the requested result, Format::atom() - requested output format || Displays the given clone group of the result using the default output format using the requested format. || ri:show_dupcode_group(mysearch,2,file_and_loc) ||
+|| save_dupcode_result/2 || Name::atom() - name associated with the result, FilePath::string() - absolute file path || Saves the result to !FilePath using the default output format. || ri:save_dupcode_result(mysearch,"/home/laptop/Desktop/result.txt")
+|| save_dupcode_result/3 || Name::atom() - name associated with the result, FilePath::string() - absolute file path, Format::atom() - requested output format || Saves the result to !FilePath using the specified output format. || ri:save_dupcode_result(mysearch,"/home/laptop/Desktop/result.txt", file_and_loc) ||
+
+
+====  Exemplars  ==== 
+In this section, we show some illustrative examples to get familiar with this feature.
+* Simpliest case.
+{{{#!erlang
+ri:clone_identifierl().
+}}}
+* We are looking for all of the clones can be found in the database. We have much memory and a wide interest in any detectable clones, and we also allow a greater deviation of clones.
+{{{#!erlang
+ri:clone_identifierl([{algorithm, matrix}, {caching, true}, {max_invalid_seq_length, 3}, {diff_limit, 0.2}]).
+}}}
+
+* We want to find the duplicates of a specific, newly introduced library function (lib_module:new_fun/2).
+{{{#!erlang
+ri:clone_identifierl([{func_list, [{lib_module, new_fun, 2}]}]).
+}}}
+
+* We want to find either the whole function or even its subsequences as duplicates of a specific, newly introduced library function (lib_module:new_fun/2).
+{{{#!erlang
+ri:clone_identifierl([{algorithm, matrix}, {func_list, [{lib_module, new_fun, 2}]}]).
+}}}
+
+* We want to find the duplicates of every function located in a library module (lib_module).
+{{{#!erlang
+ri:clone_identifierl([{files, [lib_module]}]).
+}}}
+
+* We want to find either the whole function or even its subsequences as duplicates of every function located in a library module (lib_module).
+{{{#!erlang
+ri:clone_identifierl([{algorithm, matrix},{files, [lib_module]}]).
+}}}
+
+* We want to find fully syntactically similar clones only in the dups and lib_module module.
+{{{#!erlang
+ri:clone_identifierl([{algorithm, suffix_tree},{files, [dups,lib_module]}]).
+}}}
+
+* We want to find long, fully syntactically similar clones that are straightforward to be eliminated.
+{{{#!erlang
+ri:clone_identifierl([{algorithm, filtered_suffix_tree},{minlen,80}]).
+}}}
+
 
 === Clustering ===