Changes between Version 13 and Version 14 of ErlangShellInterface

Timestamp:

Apr 24, 2012, 12:08:25 PM (13 years ago)

Author:

daniel_h

Comment:

dependency analysis via ri

ErlangShellInterface

@@ -298 +298 @@
 
 There is a [[SemanticQuery|semantic queries]] page, where you can learn more about this topic.
+
+== Dependency analysis ==
+
+The two interface functions are:
+
+1. For drawing:
+{{{#!erlang
+ri:draw_dep/1
+}}}
+2. For printing the result to stdout:
+{{{#!erlang
+ri:print_dep/1
+}}}
+
+=== Options ===
+
+The parameter of the interface functions is a proplist setting the options of the analysis. The available options are:
+
+ * {{{level (mod | func)}}}
+    The level of the dependency query (module or function).
+ * {{{type (all | cycles)}}}
+    Whether the investigation should be done on the whole graph, or just on the cyclic part (if exists). When printing out the cycles, type {{{all}}} returns graph nodes, while {{{cycles}}} returns names.
+ * {{{otp (true | false)}}}
+    Whether Erlang/OTP standard modules should be included in the analysis or not.
+ * {{{gnode}}}
+    Entity or entities that should be the starting point of the analysis.
+ * exception
+    List of entities excluded from the analysis.
+ * leaves
+    List of those entities which should be included in the analysis, but their children should not (and consequently the children become exceptions).
+ * {{{dot}}}
+    The file path of the generated {{{.dot}}} graph description. Unless it is a non-existing absolute path, the graph will be placed into the {{{./dep_files}}} directory. This option is only available when using {{{draw_dep}}}.
+
+You can specify entities either with graph nodes (such as {{{{'$gn', func, 123}}}}) or with their identifier. Modules can be specified with their names as atoms (e.g. 'mnesia'), while functions are specified by their MFA descriptor as a string (e.g. "io:format/2")
+
+=== Examples for listing results ===
+
+* Checking for cycles in module level.
+{{{#!erlang
+ri:print_dep([{level, mod}, {type, all}]).
+}}}
+  
+
+* Checking for cycles in function level, and printing out names of the functions (Module:Function/Arity).
+{{{#!erlang
+ri:print_dep([{level, func}, {type, cycles}]).
+}}}
+{{{#!erlang
+  [['foo:fv4/1','foo:fv4/1'],
+  ['test3:p/1','test:fv6/1','test3:p/1'],
+  ['cycle4:f4/1','cycle3:f3/1','cycle4:f4/1'],
+  ['cycle2:fv2/1','cycle1:fv1/0','cycle2:fv2/1'],
+  ['test:fv5/1','test:fv4/2','test:fv5/1'],
+  ['cycle4:f5/1','cycle3:f6/1','cycle4:f5/1']]
+}}}
+
+
+* Checking for cycles in function level, and printing out the graph nodes of the functions.
+{{{#!erlang
+ri:print_dep([{level, func}, {type, all}]).
+}}}
+{{{#!erlang
+  {"6 cycle(s)",
+  {[[{'$gn',func,28},{'$gn',func,28}], 
+  [{'$gn',func,29},{'$gn',func,37},{'$gn',func,29}],
+  [{'$gn',func,7},{'$gn',func,9},{'$gn',func,7}],
+  [{'$gn',func,2},{'$gn',func,1},{'$gn',func,2}],
+  [{'$gn',func,36},{'$gn',func,35},{'$gn',func,36}],
+  [{'$gn',func,8},{'$gn',func,6},{'$gn',func,8}]]}
+}}}
+
+* Checking for cycles in module level from a given node
+{{{#!erlang
+ri:print_dep([{level, mod}, {gnode, {'$gn', module, 24}}]). 
+}}}
+{{{#!erlang
+  {true,[[{'$gn',module,24},
+          {'$gn',module,25},
+          {'$gn',module,24}]]}
+}}}
+
+* Checking for cycles in function level from a node given with its identifier
+{{{#!erlang
+ri:print_dep([{level, func}, {gnode, "cycle4:f5/1"}]).
+}}}
 
 == Server management command list ==