TEST: Updated examples and tests to use the latest notation.

Author: wouterbeek

example/README.md

@@ -2,7 +2,7 @@
 
 ```sh
 $ swipl -s hello.pl -g view -t halt
-$ swipl -s loves.pl -g view -t halt
+$ swipl -s arc.pl -g view -t halt
 $ swipl -s parse_tree.pl -g view -t halt
 $ swipl -s proof_tree.pl -g view -t halt
 ```

example/arc.pl

@@ -0,0 +1,34 @@
+/** <application> Example of a simple arc
+
+~~~sh
+$ swipl -s arc.pl -g export -t halt
+$ swipl -s arc.pl -g view -t halt
+~~~
+
+*/
+
+:- use_module(library(yall)).
+
+:- use_module(library(gv)).
+
+
+
+%! export is det.
+
+export :-
+  example_(String),
+  gv_export('loves.svg', {String}/[Out]>>format(Out, String, [])).
+
+
+
+%! view is det.
+
+view :-
+  example_(String),
+  gv_view({String}/[Out]>>format(Out, String, [])).
+
+
+
+% GENERICS %
+
+example_("John -- Mary [label=loves];\n").

example/loves.svg example/arc.svgexample/loves.svg renamed to example/arc.svg

@@ -1,19 +1,34 @@
-:- module(hello, [export/0, view/0]).
+/** <application> “Hello, world!” GraphViz example
 
-/** <module> Hello, world! for GraphViz
+~~~sh
+$ swipl -s hello.pl -g export -t halt
+$ swipl -s hello.pl -g view -t halt
+~~~
 
 */
 
 :- use_module(library(yall)).
 
 :- use_module(library(gv)).
 
-dot("x [label=<Hello,<BR/>world!>,shape=diamond];\n").
+
+
+%! export is det.
 
 export :-
-  dot(String),
+  example_(String),
   gv_export('hello.svg', {String}/[Out]>>format(Out, String, [])).
 
+
+
+%! view is det.
+
 view :-
-  dot(String),
+  example_(String),
   gv_view({String}/[Out]>>format(Out, String, [])).
+
+
+
+% GENERICS %
+
+example_("x [label=<Hello,<BR/>world!>,shape=diamond];\n").

example/hello.pl

@@ -1,6 +1,9 @@
-:- module(parse_tree, [export/0, export/1, view/0, view/1]).
+/** <application> Parse tree example
 
-/** <module> Parse tree example
+~~~sh
+$ swipl -s parse_tree.pl -g export -t halt
+$ swipl -s parse_tree.pl -g view -t halt
+~~~
 
 */
 
@@ -10,25 +13,41 @@
 :- use_module(library(gv)).
 :- use_module(library(term_ext)).
 
+
+
+%! export is det.
+%! export(+Tree:tree) is det.
+
 export :-
-  tree(Tree),
+  example_(Tree),
   export(Tree).
 
+
 export(Tree) :-
   gv_export('parse_tree.svg', {Tree}/[Out]>>export_tree_(Out, Tree, _)).
 
-tree(s(np(det(the),n(cat)),vp(v(loves),np(det(the),n(dog))))).
+
+
+%! view is det.
+%! view(+Tree:tree) is det.
 
 view :-
-  tree(Tree),
+  example_(Tree),
   view(Tree).
 
+
 view(Tree) :-
   gv_view({Tree}/[Out]>>export_tree_(Out, Tree, _)).
 
+
+
+% GENERICS %
+
+example_(s(np(det(the),n(cat)),vp(v(loves),np(det(the),n(dog))))).
+
 export_tree_(Out, Tree, Id) :-
   Tree =.. [Op|Trees],
   ascii_id(Id),
-  dot_node_id(Out, Id, [label(Op)]),
+  dot_node_id(Out, Id, options{label: Op}),
   maplist(export_tree_(Out), Trees, Ids),
   maplist(dot_edge_id(Out, Id), Ids).

example/loves.pl

@@ -1,6 +1,9 @@
-:- module(proof_tree, [export/0, export/1, view/0, view/1]).
+/** <application> Proof tree example
 
-/** <module> Proof tree example
+~~~sh
+$ swipl -s proof_tree.pl -g export -t halt
+$ swipl -s proof_tree.pl -g view -t halt
+~~~
 
 */
 
@@ -9,32 +12,57 @@
 
 :- use_module(library(gv)).
 
+
+
+%! export is det.
+%! export(+Proof:tree) is det.
+
 export :-
-  proof(Proof),
+  example_(Proof),
   export(Proof).
 
+
 export(Proof) :-
-  gv_export('proof_tree.svg', {Proof}/[Out]>>export_proof_(Out, Proof), [directed(true)]).
+  gv_export(
+    'proof_tree.svg',
+    {Proof}/[Out]>>export_proof_(Out, Proof),
+    options{directed: true}
+  ).
+
+
 
-proof(t(rdfs(3), ∈(class,class), [t(axiom(rdfs), range(range,class), []),
-                                  t(axiom(rdfs), range(⊆,class), [])])).
+%! view is det.
+%! view(+Proof:tree) is det.
 
 view :-
-  proof(Proof),
+  example_(Proof),
   view(Proof).
 
+
 view(Proof) :-
-  gv_view({Proof}/[Out]>>export_proof_(Out, Proof), [directed(true)]).
+  gv_view(
+    {Proof}/[Out]>>export_proof_(Out, Proof),
+    options{directed: true}
+  ).
+
+
+
+% GENERICS %
 
 export_proof_(Out, Proof) :-
-  Proof = t(Rule,Concl,SubProofs),
+  Proof = tree(Rule,Concl,SubProofs),
   dot_node(Out, Concl),
   dot_node(Out, Proof, [label(Rule)]),
   dot_arc(Out, Concl, Proof),
   maplist(export_subproof_(Out, Proof), SubProofs).
 
 export_subproof_(Out, Proof, SubProof) :-
-  SubProof = t(_,Prem,_),
+  SubProof = tree(_,Prem,_),
   dot_node(Out, Prem),
   dot_arc(Out, Proof, Prem),
   export_proof_(Out, SubProof).
+
+example_(tree(rdfs(3),
+              ∈(class,class),
+              [tree(axiom(rdfs), range(range,class), []),
+               tree(axiom(rdfs), range(⊆,class), [])])).

example/parse_tree.pl

@@ -92,7 +92,7 @@
   write_to_file(
     File,
     gv_export_stream_(Goal_1, Format, Type, Method, Options),
-    [type(Type)]
+    options{type: Type}
   ).
 
 gv_export_default_format_(File, DefaultFormat) :-

example/proof_tree.pl

@@ -1,17 +1,22 @@
+/** <test> Tests for the GraphViz library
+
+*/
+
 :- use_module(library(apply)).
 :- use_module(library(plunit)).
 :- use_module(library(process)).
 :- use_module(library(yall)).
 
 :- use_module(library(gv)).
 :- use_module(library(os_ext)).
+:- use_module(library(term_ext)).
+
+:- begin_tests(gv).
 
 :- meta_predicate
     test_gv_export(+, 1),
     test_gv_export(+, 1, +).
 
-:- begin_tests(gv).
-
 test(hello, [cleanup(delete_file(File))]) :-
   File = 'hello.pdf',
   test_gv_export(
@@ -25,50 +30,50 @@
   File = 'hello2.pdf',
   test_gv_export(
     File,
-    [Out]>>dot_node(Out, hello, [label(["Hello,","world!"]),shape(diamond)])
+    [Out]>>dot_node(Out, hello, options{label: ["Hello,","world!"], shape: diamond})
   ).
 
 
 
-test(loves, [cleanup(delete_file(File))]) :-
-  File = 'loves.svg',
-  test_gv_export(File, [Out]>>format(Out, "John -- Mary [label=loves]", [])).
+test(arc, [cleanup(delete_file(File))]) :-
+  File = 'arc.svg',
+  test_gv_export(File, [Out]>>format(Out, "John -- Mary [label=arc]", [])).
 
 
 
 test(parse_tree, [cleanup(delete_file(File))]) :-
   File = 'parse_tree.svg',
-  Tree = s(np(det(the),n(cat)),vp(v(loves),np(det(the),n(dog)))),
+  Tree = s(np(det(the),n(cat)),vp(v(knows),np(det(the),n(dog)))),
   test_gv_export(File, {Tree}/[Out]>>export_tree_(Out, Tree, _)).
 
 export_tree_(Out, Tree, Id) :-
   Tree =.. [Op|Trees],
   ascii_id(Id),
-  dot_node_id(Out, Id, [label(Op)]),
+  dot_node_id(Out, Id, options{label: Op}),
   maplist(export_tree_(Out), Trees, Ids),
   maplist(dot_edge_id(Out, Id), Ids).
 
 
 
 test(proof_tree, [cleanup(delete_file(File))]) :-
   File = 'proof_tree.svg',
-  Proof = t(rdfs(3),≡(class,class),[t(axiom(rdfs),range(range,class),[]),
-                                    t(axiom(rdfs),range(⊆,class),[])]),
+  Proof = tree(rdfs(3),≡(class,class),[tree(axiom(rdfs),range(range,class),[]),
+                                        tree(axiom(rdfs),range(⊆,class),[])]),
   test_gv_export(
     File,
     {Proof}/[Out]>>export_proof_(Out, Proof),
-    [directed(true)]
+    options{directed: true}
   ).
 
 export_proof_(Out, Tree) :-
-  Tree = t(Rule,Concl,SubTrees),
+  Tree = tree(Rule,Concl,SubTrees),
   dot_node(Out, Concl),
-  dot_node(Out, Tree, [color(green),label(Rule)]),
+  dot_node(Out, Tree, options{color: green, label: Rule}),
   dot_arc(Out, Concl, Tree),
   maplist(export_subproof_(Out, Tree), SubTrees).
 
 export_subproof_(Out, Tree, SubTree) :-
-  SubTree = t(_,Prem,_),
+  SubTree = tree(_,Prem,_),
   dot_node(Out, Prem),
   dot_arc(Out, Tree, Prem),
   export_proof_(Out, SubTree).
@@ -83,7 +88,7 @@
 %! test_gv_export(+File:atom, :Goal_1, +Options:list(compound)) is det.
 
 test_gv_export(File, Goal_1) :-
-  test_gv_export(File, Goal_1, []).
+  test_gv_export(File, Goal_1, options{}).
 
 
 test_gv_export(File, Goal_1, Options) :-