/*  Logicmoo Debug Tools
% ===================================================================
% File 'logicmoo_util_varnames.pl'
% Purpose: An Implementation in SWI-Prolog of certain debugging tools
% Maintainer: Douglas Miles
% Contact: $Author: dmiles $@users.sourceforge.net ;
% Version: 'logicmoo_util_varnames.pl' 1.0.0
% Revision: $Revision: 1.1 $
% Revised At:  $Date: 2002/07/11 21:57:28 $
% ===================================================================
*/
% NEW
:- module(attvar_serializer, [
          deserialize_attvars/2,
          deserialize_attvars/2,deserialize_attvars/3,
          serialize_attvars/2,
          serialize_attvars_now/2,
          put_dyn_attrs/2,
          ensure_named/3,
          verbatum_var/1,
          holds_attrs/1,
          system_expanded_attvars/4,
          is_term_expanding_in_file/2,
          system_expanded_attvars/2]).

:- set_module(class(library)).


:- module_transparent((deserialize_attvars/2,deserialize_attvars/3,
          serialize_attvars_now/2,
          put_dyn_attrs/2,
          ensure_named/3,
          system_expanded_attvars/4,
          system_expanded_attvars/2)).


:- multifile(lmcache:use_attvar_expander/1).
:- dynamic(lmcache:use_attvar_expander/1).

:- multifile(lmcache:never_use_attvar_expander/1).
:- dynamic(lmcache:never_use_attvar_expander/1).

lmcache:never_use_attvar_expander(attvar_serializer).

:- use_module(library(dictoo)).
:- reexport(library(hook_database)).
:- reexport(library(listing_vars)).

:- if( \+ prolog_load_context(reload, true)).
:- multifile(baseKB:mpred_is_impl_file/1).
:- dynamic(baseKB:mpred_is_impl_file/1).
:- prolog_load_context(file,F),call(assert,baseKB:mpred_is_impl_file(F)).
:- endif.

% use this module to avoid some later conflicts
:- if(exists_source(library(base32))).
:- use_module(library(base32)).
:- endif.


ensure_named(Vs,V,N):- atom(N),member(N=VV,Vs),VV==V,put_attr(V,vn,N).
ensure_named(Vs,V,N):- atom(N),member(N=VV,Vs),put_attr(V,vn,N),!,maybe_must(VV= V).
ensure_named(Vs,V,N):- atom(N),put_attr(V,vn,N),set_in_vd(Vs,N=V).
ensure_named(Vs,V,N):- get_attr(V,vn,N),!,set_in_vd(Vs,N=V).
ensure_named(Vs,V,N):- member(N=NV,Vs),V==NV,!,put_attr(V,vn,N).
ensure_named(Vs,V,N):- get_varname_list(VsE), member(N=NV,VsE),V==NV,!,put_attr(V,vn,N),set_in_vd(Vs,N=V).

set_in_vd(Vs,N=V):-member(NN=VV,Vs),NN==N,V==VV,!.
set_in_vd(Vs,N=V):-member(NN=VV,Vs),NN==N,!,maybe_must(V=VV).
set_in_vd(Vs,N=V):-member(NN=VV,Vs),VV==V,maybe_must(N==NN).
set_in_vd(Vs,N=V):-Vs = [_|VT], nb_setarg(2,Vs,[N=V|VT]).

maybe_must(V=VV):-V==VV,!.
maybe_must(_).


% deserialize_attvars(V,O):- get_varname_list(Vs),!,loop_check(deserialize_attvars(['$variable_names'|Vs], V,O)),!.

deserialize_attvars(V,O):-nonvar(O),!,deserialize_attvars(V,OO),ignore(O=OO).
deserialize_attvars(V,O):- \+compound(V),!,O=V.
deserialize_attvars(V,O):- loop_check(deserialize_attvars([localvs], V,O),V=O),!.

deserialize_attvars(_Vs, V,O):- cyclic_term(V),!,O=V.
deserialize_attvars(_Vs, V,O):- atomic(V),!,O=V.
deserialize_attvars(Vs, V,O):- nonvar(O),!,must(deserialize_attvars(Vs, V,M)),!,must(M=O).
deserialize_attvars(Vs, V,O):- var(V), get_attr(V,vn,N),set_in_vd(Vs,N=V),!,V=O.
deserialize_attvars(Vs, V,O):- var(V), member(N=VV,Vs),VV==V,put_attr(V,vn,N),!,V=O.
deserialize_attvars(_ ,IO,IO):- \+ compound(IO),!.

deserialize_attvars(_ ,(H:-BI),O):- fail,
  split_attrs(BI,AV,BO),AV\==true,AV\=bad:_,term_attvars((H:-BO),[]),
   must(call(AV)),!,(BO==true->(O=H);O=(H:-BO)).

deserialize_attvars(Vs,'$AVAR'(V,Atts),Var):- to_var(Vs,V,Var),!, put_dyn_attrs(Var,Atts),ensure_named(Vs,Var,_N).
deserialize_attvars(Vs,'$VAR'(V),Var):- to_var(Vs,'$VAR'(V),Var),!, (var(V)->ensure_named(Vs,Var,V);true),
deserialize_attvars(Vs,C,A):- compound_name_arguments(C,F,Args),maplist(deserialize_attvars(Vs),Args,OArgs),compound_name_arguments(A,F,OArgs).

:- meta_predicate put_dyn_attrs(*,?).
put_dyn_attrs(V,S):- var(S),!,trace_or_throw(bad_put_dyn_attrs(V,S)),!.
put_dyn_attrs(V,S):-S=att(_,_,_), !, put_attrs(V,S).
put_dyn_attrs(V,M:AV):- atom(M),!, M:put_dyn_attrs(V,AV).
put_dyn_attrs(V,M=AV):- atom(M),!, ensure_attr_setup(M),!, must(put_attr(V,M,AV)).
put_dyn_attrs(_V,[]):- !.
put_dyn_attrs(V,List):- is_list(List),!, maplist(put_dyn_attrs(V),List),!.
put_dyn_attrs(V,[H|T]):- !, put_dyn_attrs(V,H),put_dyn_attrs(V,T),!.
put_dyn_attrs(_V,MAV):- must(MAV),!.

ensure_attr_setup(M):- atom(M),current_predicate(attribute_goals,M:attribute_goals(_,_,_)),!.
ensure_attr_setup(M):- atom(M),assert_if_new((M:attribute_goals(V,[put_attr(V,M,A)|R],R):- get_attr(V, M,A))).

is_term_expanding_in_file(I,_):- var(I),!,fail.
is_term_expanding_in_file(I,Type):- source_file(_,_),nb_current('$term',CT),(CT==I->Type=term;((CT=(_:-B),B==I,Type=goal))).

system_expanded_attvars(M:goal,P,I,O):- var(P),
   \+ is_term_expanding_in_file(I,_),
   \+ lmcache:never_use_attvar_expander(M),
   prolog_load_context(module,LC),
   \+ lmcache:never_use_attvar_expander(LC),
   current_prolog_flag(read_attvars,true), 
   \+ current_prolog_flag(xref,true), 
   system_expanded_attvars(I,O),
   wdmsg(goal_xform(I --> O)).

system_expanded_attvars(M:term,P,I,CO):- nonvar(P),
   \+ lmcache:never_use_attvar_expander(M),
   current_prolog_flag(read_attvars,true), 
   \+ current_prolog_flag(xref,true), 
   is_term_expanding_in_file(I,term),
   prolog_load_context(module,LC),
   \+ lmcache:never_use_attvar_expander(LC),
   (prolog_load_context(source,LC1)-> (\+ lmcache:never_use_attvar_expander(LC1)) ; true),
   system_expanded_attvars(I,O),
   clausify_attributes(O,CO),
   wdmsg(term_xform(I --> CO)),
   % update what we just read 
   b_setval('$term',CO).


free_of_attvars(Term):- term_attvars(Term,Vs),!,Vs==[].

free_of_attrs(Term):- get_attrs(Term,Attrs),!,Attrs==[].
free_of_attrs(Term):- term_attvars(Term,Vs),maplist(free_of_attrs,Vs).


%% serialize_attvars( +AttvarTerm, -PrintableTerm) is semidet.
%
% serialize attributed variables (this is for printing and term_expansions currently)
%
serialize_attvars(I,O):- serialize_attvars_now(I,O),sanity(ignore(show_failure(free_of_attvars(O)))),sanity(show_failure(free_of_attrs(O))).

serialize_attvars_now(V,S):- var(V),must(serialize_1v(V,S)),!.
serialize_attvars_now(I,O):- \+ compound(I),!,O=I.
serialize_attvars_now(C,A):- compound_name_arguments(C,F,Args),maplist(serialize_attvars_now,Args,OArgs),compound_name_arguments(A,F,OArgs).


serialize_attvar_term(I,O):- copy_term(I,O), serialize_attvar_term_now(O),
   sanity(ignore(show_failure(free_of_attvars(O)))),
   sanity(show_failure(free_of_attrs(O))).

% ?- 
% rtrace(( X = hi(T),put_attr(T,sk,foo),serialize_attvar_term(X,SS), sanity(\+  has_skolem_attrvars(SS)))).


serialize_attvar_term_now(V):- attvar(V),trace_or_throw(serialize_attvar_term(V)).
serialize_attvar_term_now(I):- \+ compound(I),!.
serialize_attvar_term_now(C):- functor(C,_,A),serialize_attvar_term_now(A,C).

serialize_attvar_term_now(0,_):-!.
serialize_attvar_term_now(A,C):- arg(A,C,E),serialize_attvar_term_now(A,C,E),Am1 is A-1,serialize_attvar_term_now(Am1,C).

serialize_attvar_term_now(A,C,E):- attvar(E),!,get_put_attr_serial(E,New),setarg(A,C,New),!.
serialize_attvar_term_now(_,C,E):- compound(E)->serialize_attvar_term_now(C);true.

get_put_attr_serial(E,New):- get_attr(E,'$$sv$$',New),!.
get_put_attr_serial(E,Next):- serialize_3(E,Name,Atts),MyCopy =_, subst(Atts,E,MyCopy,NewAtts),Next='$AVAR'(Name,att('$linkval',MyCopy,NewAtts)),del_attrs(E),put_attr(E,'$$sv$$',Next),!.

serialize_1v(V,'$AVAR'(V,S)):- get_attrs(V, S),!,del_attrs(V).
serialize_1v(V,'$VAR'(N)):-  variable_name_or_ref(V,N).
serialize_1v(V,V).


serialize_3(V,N,Atts):- (get_var_name(V,N);variable_name_or_ref(V,N)),del_attr(V,vn),(get_attrs(V, Atts)->true;Atts=[]),!.


remove_attrs(Var,Attrs):-get_attrs(Var,Attrs),!,remove_all_attrs(Var).
remove_attrs(Var,Attrs):-copy_term(Var,Copy,Attrs),Copy=Var,remove_all_attrs(Var).

% ?- rtrace(( X = hi(T),put_attr(T,sk,foo),serialize_attvar_term(X,SS), \+  has_skolem_attrvars(SS))).
% ?- X = hi(T),put_attr(T,sk,foo),rtrace(serialize_attvars(X,SS)), \+  has_skolem_attrvars(SS).


% ?- X = hi(T),put_attr(T,sk,foo),remove_all_attrs(T).

remove_all_attrs(Var):- attvar(Var),del_attrs(Var), sanity( \+ attvar(Var)),!.
remove_all_attrs(Term):- term_attvars(Term,Vars),maplist(remove_all_attvrs,Vars).

%% verbatum_term(TermT) is semidet.
%
% System Goal Expansion Sd.
%
verbatum_term(I):- attvar(I),!,fail.
verbatum_term(I):- \+ compound(I),!. % this is intended to include the non-attrbuted variables
verbatum_term('$was_imported_kb_content$'(_,_)).
verbatum_term('varname_info'(_,_,_,_)).
verbatum_term(V):-verbatum_var(V).

holds_attrs(V):-var(V),!.
holds_attrs(V):-verbatum_var(V),!.


% move to logicmoo_utils_common.pl? 
verbatum_var(Var):-var(Var),!,fail.
verbatum_var('$VAR'(_)).
verbatum_var('$AVAR'(_,_)).





%% system_expanded_attvars( :TermT, :TermARG2) is semidet.
%
% System Goal Expansion Sd.
%
system_expanded_attvars(I,O):- (var(I);compound(I)),!,loop_check((deserialize_attvars(I,O))),O\=@=I,!.

:- fixup_exports.


end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.
end_of_file.

/*

% % :- '$set_source_module'( system).


:- public '$store_clause'/2.

'$store_clause'(A, C) :-
        '$clause_source'(A, B, D),
        '$store_clause'(B, _, C, D).

'$store_clause'((_, _), _, _, _) :- !,
        print_message(error, cannot_redefine_comma),
        fail.
'$store_clause'(A, _, B, C) :-
        '$valid_clause'(A), !,
        (   '$compilation_mode'(database)
        ->  '$record_clause'(A, B, C)
        ;   '$record_clause'(A, B, C, D),
            '$qlf_assert_clause'(D, development)
        ).

'$compile_term'(Clause, Layout, Id, SrcLoc) :-
	catch('$store_clause'(Clause, Layout, Id, SrcLoc), E,
	      '$print_message'(error, E)),
        catch((writeq(user_error,'$store_clause'(Clause,  Id)),nl(user_error)),_,true).

'$compile_aux_clauses'(Clauses, File) :-
	setup_call_cleanup(
	    '$start_aux'(File, Context),
	    '$store_aux_clauses'(Clauses, File),
	    '$end_aux'(File, Context)).

'$store_aux_clauses'(Clauses, File) :-
	is_list(Clauses), !,
	forall('$member'(C,Clauses),
	       '$compile_term'(C, _Layout, File)).
'$store_aux_clauses'(Clause, File) :-
	'$compile_term'(Clause, _Layout, File).
*/
/*
   compile_predicates(['$expand_goal'/2, '$expand_term'/4]),!.
:-   
   % '$set_predicate_attribute'('$expand_goal'(_,_), system, true),
   % '$set_predicate_attribute'('$expand_term'(_,_,_,_), system, true),
   '$set_predicate_attribute'('$expand_goal'(_,_), hide_childs, false),
   '$set_predicate_attribute'('$expand_term'(_,_,_,_), hide_childs, false).
   
*/