added natural language

Author: german-vidal

README.md

@@ -50,10 +50,47 @@ ancestor(celine,fanny)
 
 true.
 ```
+If the example file contains a specification to "read" the atoms, then the trace above is formatted accordingly. For instance, given the following 
+specifications
+
+```
+%!read mother(A,B) as: A is the mother of B
+%!read father(A,B) as: A is the father of B
+%!read parent(A,B) as: A is the parent of B
+%!read ancestor(A,B) as: A is the ancestor of B
+```
+in file ``ancestor.pl``, we get the following
+output instead:
+
+```
+anna is the ancestor of fanny
+   anna is the parent of fanny
+      anna is the mother of fanny
+;
+daniel is the ancestor of fanny
+   daniel is the parent of fanny
+      daniel is the mother of fanny
+;
+tim is the ancestor of fanny
+   tim is the parent of anna
+      tim is the mother of anna
+   anna is the ancestor of fanny
+      anna is the parent of fanny
+         anna is the mother of fanny
+;
+celine is the ancestor of fanny
+   celine is the parent of daniel
+      celine is the father of daniel
+   daniel is the ancestor of fanny
+      daniel is the parent of fanny
+         daniel is the mother of fanny
+
+```
+
 By default, the output is also saved in file ```temp.txt``` as follows:
 
 ```
-[[call(0,ancestor(anna,fanny)),call(1,parent(anna,fanny)),call(2,mother(anna,fanny))],[call(0,ancestor(daniel,fanny)),call(1,parent(daniel,fanny)),call(2,mother(daniel,fanny))],[call(0,ancestor(tim,fanny)),call(1,parent(tim,anna)),call(2,mother(tim,anna)),call(1,ancestor(anna,fanny)),call(2,parent(anna,fanny)),call(3,mother(anna,fanny))],[call(0,ancestor(celine,fanny)),call(1,parent(celine,daniel)),call(2,father(celine,daniel)),call(1,ancestor(daniel,fanny)),call(2,parent(daniel,fanny)),call(3,mother(daniel,fanny))]]
+[[[call(0,ancestor(anna,fanny),"anna is the ancestor of fanny"),call(1,parent(anna,fanny),"anna is the parent of fanny"),call(2,mother(anna,fanny),"anna is the mother of fanny")],[call(0,ancestor(daniel,fanny),"daniel is the ancestor of fanny"),call(1,parent(daniel,fanny),"daniel is the parent of fanny"),call(2,mother(daniel,fanny),"daniel is the mother of fanny")],[call(0,ancestor(tim,fanny),"tim is the ancestor of fanny"),call(1,parent(tim,anna),"tim is the parent of anna"),call(2,mother(tim,anna),"tim is the mother of anna"),call(1,ancestor(anna,fanny),"anna is the ancestor of fanny"),call(2,parent(anna,fanny),"anna is the parent of fanny"),call(3,mother(anna,fanny),"anna is the mother of fanny")],[call(0,ancestor(celine,fanny),"celine is the ancestor of fanny"),call(1,parent(celine,daniel),"celine is the parent of daniel"),call(2,father(celine,daniel),"celine is the father of daniel"),call(1,ancestor(daniel,fanny),"daniel is the ancestor of fanny"),call(2,parent(daniel,fanny),"daniel is the parent of fanny"),call(3,mother(daniel,fanny),"daniel is the mother of fanny")]]
 ```
 The tracer can also be used as a shell command:
 

examples/ancestor.pl

@@ -1,3 +1,8 @@
+%!read mother(A,B) as: A is the mother of B
+%!read father(A,B) as: A is the father of B
+%!read parent(A,B) as: A is the parent of B
+%!read ancestor(A,B) as: A is the ancestor of B
+
 mother(tim, anna).
 mother(anna, fanny).
 mother(daniel, fanny).

parser.pl

@@ -16,6 +16,17 @@
   clauses(T).
 clauses([]) --> [].
 
+clause(reading(Atom,String,ListVars)) -->
+  [punct("%")],
+  [punct("!")],
+  [word("read")],
+  atom_ast(Atom),
+  [word("as")],
+  [punct(":")],
+  comment_ast(C),
+  [cntrl("\n")],
+  {process_text(Atom,C,StringList,ListVars),atomics_to_string(StringList," ",String)}.
+
 clause(visible([(Pred,N)|R])) -->
   [punct("%")],
   [word("visible")],
@@ -149,3 +160,18 @@
   [word(N2)],
   {string_concat(N1,".",Temp),string_concat(Temp,N2,N),term_string(Prob,N)},
   [cntrl("\n")].
+
+process_text(Atom,C,String,ListVars) :-
+  vars_atom(Atom,Vars),
+  pt(Vars,C,String,ListVars).
+
+pt(_Vars,[],[],[]).
+pt(Vars,[V|R],["~p"|String],[var(V)|ListVars]) :-
+  member(var(V),Vars),!,
+  pt(Vars,R,String,ListVars).
+pt(Vars,[W|R],[W|String],ListVars) :-
+  pt(Vars,R,String,ListVars).
+
+
+vars_atom(Atom,Vars) :-
+  Atom =.. [_|Vars].

temp.txt

@@ -1,21 +1 @@
-ancestor(anna,fanny)
-   parent(anna,fanny)
-      mother(anna,fanny)
-;
-ancestor(daniel,fanny)
-   parent(daniel,fanny)
-      mother(daniel,fanny)
-;
-ancestor(tim,fanny)
-   parent(tim,anna)
-      mother(tim,anna)
-   ancestor(anna,fanny)
-      parent(anna,fanny)
-         mother(anna,fanny)
-;
-ancestor(celine,fanny)
-   parent(celine,daniel)
-      father(celine,daniel)
-   ancestor(daniel,fanny)
-      parent(daniel,fanny)
-         mother(daniel,fanny)
+[[call(0,ancestor(anna,fanny),"anna is the ancestor of fanny"),call(1,parent(anna,fanny),"anna is the parent of fanny"),call(2,mother(anna,fanny),"anna is the mother of fanny")],[call(0,ancestor(daniel,fanny),"daniel is the ancestor of fanny"),call(1,parent(daniel,fanny),"daniel is the parent of fanny"),call(2,mother(daniel,fanny),"daniel is the mother of fanny")],[call(0,ancestor(tim,fanny),"tim is the ancestor of fanny"),call(1,parent(tim,anna),"tim is the parent of anna"),call(2,mother(tim,anna),"tim is the mother of anna"),call(1,ancestor(anna,fanny),"anna is the ancestor of fanny"),call(2,parent(anna,fanny),"anna is the parent of fanny"),call(3,mother(anna,fanny),"anna is the mother of fanny")],[call(0,ancestor(celine,fanny),"celine is the ancestor of fanny"),call(1,parent(celine,daniel),"celine is the parent of daniel"),call(2,father(celine,daniel),"celine is the father of daniel"),call(1,ancestor(daniel,fanny),"daniel is the ancestor of fanny"),call(2,parent(daniel,fanny),"daniel is the parent of fanny"),call(3,mother(daniel,fanny),"daniel is the mother of fanny")]]

tracer.pl

@@ -48,6 +48,7 @@
 */
 
 :- dynamic cl/3.
+:- dynamic reading/3.
 :- dynamic comment/1.
 :- dynamic visible/1.
 :- dynamic unsafe/1.
@@ -86,6 +87,7 @@
 
 load(File) :-
   retractall(cl(_,_,_)),
+  retractall(reading(_,_,_)),
   retractall(visible(_)),
   retractall(unsafe(_)),
   retractall(comment(_)),
@@ -94,19 +96,34 @@
   retractall(explanations(_)),
   retractall(counter(_)),assertz(counter(0)),
   read_problog_program(File,Program),
+  %print(Program).
   file_base_name(File,FileNameExt),
   string_concat(FileName,'.pl',FileNameExt),
   assertz(filename(FileName)),
   %nl,print(read_problog_program(File,Program)),nl,
   replace_vars(Program,ProgramVars),
   %nl,print(replace_vars(Program,ProgramVars)),nl,
-  assert_clauses(ProgramVars),!.
+  assert_clauses(ProgramVars).
   %query(Atom),
 
+process_traces([],[]).
+process_traces([T|R],[TT|RR]) :-
+  process_trace(T,TT),
+  process_traces(R,RR).
+ 
+process_trace([],[]).
+process_trace([call(N,A)|R],[call(N,A,S)|RT]) :-
+  (reading(A,String,Vars) -> format(string(S),String,Vars)
+    ; term_string(A,S)),
+  process_trace(R,RT).
+
 run(Q) :-
   findall(Trace,eval(0,Q,Trace),Traces),
-  print_traces(Traces),
-  write_traces(Traces).
+  %print(Traces),nl,
+  process_traces(Traces,Traces2),  
+  %print(Traces2),nl,
+  print_traces(Traces2),
+  write_traces(Traces2). 
 
 write_traces(Trace) :-
   open('temp.txt',write,Stream),
@@ -122,9 +139,11 @@
   print_trace(Trace),
   print(';'),nl,
   print_traces(R).
+
 print_trace([]).
-print_trace([call(N,A)|R]) :-
-  tab(N*3),format("~p~n",[A]),
+print_trace([call(N,_A,S)|R]) :-
+%  tab(N*3),format("~p~n",[A]),
+  tab(N*3),format(S),nl,
   print_trace(R).
 
 eval(_,[],[]).
@@ -196,7 +215,7 @@
 assert_clauses([unsafe(Preds)|R]) :-
   !,assert_unsafe_preds(Preds),
   assert_clauses(R).
-assert_clauses([Cl|R]) :-
+assert_clauses([Cl|R]) :- 
   assertz(Cl),
   assert_clauses(R).
 
@@ -217,6 +236,12 @@
   replace_vars(R,RT).
 replace_vars([unsafe(L)|R],[unsafe(L)|RT]) :- 
   replace_vars(R,RT).
+replace_vars([reading(Q,String,Vars)|R],[reading(Q3,String,V4)|RT]) :- 
+  V =.. [foo|Vars],
+  rvars([Q,V],[Q2,V2],[],-1),
+  varnumbers([Q2,V2],[Q3,V3]),
+  V3 =.. [_|V4],
+  replace_vars(R,RT).
 replace_vars([comment(C)|R],[comment(C)|RT]) :- 
   replace_vars(R,RT).
 replace_vars([query(Q)|R],[query(Q3)|RT]) :- 

tracer_shell.pl

@@ -57,6 +57,7 @@
 recognised_option(['-g',F],goal(F)).
 
 :- dynamic cl/3.
+:- dynamic reading/3.
 :- dynamic comment/1.
 :- dynamic visible/1.
 :- dynamic unsafe/1.
@@ -95,6 +96,7 @@
 
 load(File) :-
   retractall(cl(_,_,_)),
+  retractall(reading(_,_,_)),
   retractall(visible(_)),
   retractall(unsafe(_)),
   retractall(comment(_)),
@@ -103,24 +105,40 @@
   retractall(explanations(_)),
   retractall(counter(_)),assertz(counter(0)),
   read_problog_program(File,Program),
+  %print(Program).
   file_base_name(File,FileNameExt),
   string_concat(FileName,'.pl',FileNameExt),
   assertz(filename(FileName)),
   %nl,print(read_problog_program(File,Program)),nl,
   replace_vars(Program,ProgramVars),
   %nl,print(replace_vars(Program,ProgramVars)),nl,
-  assert_clauses(ProgramVars),!.
+  assert_clauses(ProgramVars).
   %query(Atom),
 
+process_traces([],[]).
+process_traces([T|R],[TT|RR]) :-
+  process_trace(T,TT),
+  process_traces(R,RR).
+ 
+process_trace([],[]).
+process_trace([call(N,A)|R],[call(N,A,S)|RT]) :-
+  (reading(A,String,Vars) -> format(string(S),String,Vars)
+    ; term_string(A,S)),
+  process_trace(R,RT).
+
 run(Q) :-
   findall(Trace,eval(0,Q,Trace),Traces),
-  print_traces(Traces),
-  write_traces(Traces).
+  %print(Traces),nl,
+  process_traces(Traces,Traces2),  
+  %print(Traces2),nl,
+  print_traces(Traces2),
+  write_traces(Traces2). 
 
 write_traces(Trace) :-
   open('temp.txt',write,Stream),
   set_prolog_IO(user_input,Stream,user_error),
-  (cli_output(raw) -> print(Trace); print_traces(Trace)),
+  print(Trace),
+  %print_traces(Trace),
   close(Stream).
 
 print_traces([]).
@@ -130,9 +148,11 @@
   print_trace(Trace),
   print(';'),nl,
   print_traces(R).
+
 print_trace([]).
-print_trace([call(N,A)|R]) :-
-  tab(N*3),format("~p~n",[A]),
+print_trace([call(N,_A,S)|R]) :-
+%  tab(N*3),format("~p~n",[A]),
+  tab(N*3),format(S),nl,
   print_trace(R).
 
 eval(_,[],[]).
@@ -204,7 +224,7 @@
 assert_clauses([unsafe(Preds)|R]) :-
   !,assert_unsafe_preds(Preds),
   assert_clauses(R).
-assert_clauses([Cl|R]) :-
+assert_clauses([Cl|R]) :- 
   assertz(Cl),
   assert_clauses(R).
 
@@ -225,6 +245,12 @@
   replace_vars(R,RT).
 replace_vars([unsafe(L)|R],[unsafe(L)|RT]) :- 
   replace_vars(R,RT).
+replace_vars([reading(Q,String,Vars)|R],[reading(Q3,String,V4)|RT]) :- 
+  V =.. [foo|Vars],
+  rvars([Q,V],[Q2,V2],[],-1),
+  varnumbers([Q2,V2],[Q3,V3]),
+  V3 =.. [_|V4],
+  replace_vars(R,RT).
 replace_vars([comment(C)|R],[comment(C)|RT]) :- 
   replace_vars(R,RT).
 replace_vars([query(Q)|R],[query(Q3)|RT]) :- 
@@ -254,4 +280,3 @@
   rvars_args(R,VarList,N,RR,NVarList,NN).
 
 
-