This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/pl/history.pl
Vítor Santos Costa a8c77d2609 fix string_concat/2
2014-04-09 12:39:29 +01:00

288 lines
8.4 KiB
Prolog

/* $Id$
Part of SWI-Prolog
Author: Jan Wielemaker
E-mail: wielemak@science.uva.nl
WWW: http://www.swi-prolog.org
Copyright (C): 1985-2005, University of Amsterdam
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
As a special exception, if you link this library with other files,
compiled with a Free Software compiler, to produce an executable, this
library does not by itself cause the resulting executable to be covered
by the GNU General Public License. This exception does not however
invalidate any other reasons why the executable file might be covered by
the GNU General Public License.
*/
:- module('$history',
[ read_history/6,
'$clean_history'/0,
'$save_history'/1
]).
%% read_history(+History, +Help, +DontStore, +Prompt, -Term, -Bindings)
%
% Give a prompt using Prompt. The sequence '%w' is substituted with the
% current event number. Then read a term from the input stream and perform
% the history expansion. Return the expanded term and the bindings of the
% variables as with read/2.
% entering the term History makes read_history/5 print the history.
% Help specifies the help command.
% DontStore is a list of events that need not be stored.
% When read_history reads a term of the form $silent(Goal), it will
% call Goal and pretend it has not seen anything. This hook is used
% by the GNU-Emacs interface to for communication between GNU-EMACS
% and SWI-Prolog.
prolog:read_history(History, Help, DontStore, Prompt, Term, Bindings) :-
repeat,
prompt_history(Prompt),
catch('$raw_read'(user_input, Raw), E,
(print_message(error, E),
( E = error(syntax_error(_), _)
-> fail
; throw(E)
))),
read_history_(History, Help, DontStore, Raw, Term, Bindings), !.
read_history_(History, _, _, History, _, _) :-
list_history, !,
fail.
read_history_(Show, Help, _, Help, _, _) :-
print_message(help, history(help(Show, Help))), !,
fail.
read_history_(History, Help, DontStore, Raw, Term, Bindings) :-
expand_history(Raw, Expanded, Changed),
save_history_line(Expanded),
catch(atom_to_term(Expanded, Term0, Bindings0),
E,
( print_message(error, E),
fail
)),
( var(Term0)
-> Term = Term0,
Bindings = Bindings0
; Term0 = '$silent'(Goal)
-> user:ignore(Goal),
read_history(History, Help, DontStore, '', Term, Bindings)
; save_event(DontStore, Expanded),
( Changed == true
-> print_message(query, history(expanded(Expanded)))
; true
),
Term = Term0,
Bindings = Bindings0
).
% list_history
% Write history events to the current output stream.
list_history :-
( '$history'(Last, _)
-> true
; Last = 0
),
history_depth_(Depth),
plus(First, Depth, Last),
findall(Nr/Event,
( between(First, Last, Nr),
'$history'(Nr, Event)
),
Events),
print_message(query, history(history(Events))).
'$clean_history' :-
retractall('$history'(_,_)).
% prompt_history(+Prompt)
% Give prompt, substituting '%!' by the event number.
prompt_history('') :- !,
ttyflush.
prompt_history(Prompt) :-
( '$history'(Last, _)
-> This is Last + 1
; This = 1
),
atom_codes(Prompt, SP),
number_codes(This, ST),
( substitute("%!", ST, SP, String)
-> prompt1(String)
; prompt1(Prompt)
),
ttyflush.
% substitute(+Old, +New, +String, -Substituted)
% substitute first occurence of Old in String by New
substitute(Old, New, String, Substituted) :-
'$append'(Head, OldAndTail, String),
'$append'(Old, Tail, OldAndTail), !,
'$append'(Head, New, HeadAndNew),
'$append'(HeadAndNew, Tail, Substituted), !.
% save_event(+Event)
% Save Event in the history system. Remove possibly outdated events.
save_history_line(end_of_file) :- !.
save_history_line(Line) :-
current_prolog_flag(readline, true),
format(atom(CompleteLine), '~W~W',
[ Line, [partial(true)],
'.', [partial(true)]
]),
catch(system:rl_add_history(CompleteLine), _, fail), !.
save_history_line(_).
save_event(Dont, Event) :-
lists:memberchk(Event, Dont), !.
save_event(_, Event) :-
'$save_history'(Event).
:- thread_local
'$history'/2.
'$save_history'(Event) :-
( '$history'(Old, _)
-> New is Old + 1
; New is 1
),
asserta('$history'(New, Event)),
history_depth_(Depth),
remove_history(New, Depth).
remove_history(New, Depth) :-
New - Depth =< 0, !.
remove_history(New, Depth) :-
Remove is New - Depth,
retract('$history'(Remove, _)), !.
remove_history(_, _).
% history_depth_(-Depth)
% Define the depth to which to keep the history.
history_depth_(N) :-
current_prolog_flag(history, N),
integer(N),
N > 0, !.
history_depth_(25).
% expand_history(+Raw, -Expanded)
% Expand Raw using the available history list. Expandations performed
% are:
%
% !match % Last event starting <match>
% !n % Event nr. <n>
% !! % last event
%
% Note: the first character after a '!' should be a letter or number to
% avoid problems with the cut.
expand_history(Raw, Expanded, Changed) :-
atom_chars(Raw, RawString),
expand_history2(RawString, ExpandedString, Changed),
atom_chars(Expanded, ExpandedString), !.
expand_history2([!], [!], false) :- !.
expand_history2([!, C|Rest], [!|Expanded], Changed) :-
not_event_char(C), !,
expand_history2([C|Rest], Expanded, Changed).
expand_history2([!|Rest], Expanded, true) :- !,
match_event(Rest, Event, NewRest),
'$append'(Event, RestExpanded, Expanded), !,
expand_history2(NewRest, RestExpanded, _).
expand_history2(['\''|In], ['\''|Out], Changed) :- !,
skip_quoted(In, '\'', Out, Tin, Tout),
expand_history2(Tin, Tout, Changed).
expand_history2(['"'|In], ['"'|Out], Changed) :- !,
skip_quoted(In, '"', Out, Tin, Tout),
expand_history2(Tin, Tout, Changed).
expand_history2([H|T], [H|R], Changed) :- !,
expand_history2(T, R, Changed).
expand_history2([], [], false).
skip_quoted([Q|T],Q,[Q|R], T, R) :- !.
skip_quoted([\,Q|T0],Q,[\,Q|T], In, Out) :- !,
skip_quoted(T0, Q, T, In, Out).
skip_quoted([Q,Q|T0],Q,[Q,Q|T], In, Out) :- !,
skip_quoted(T0, Q, T, In, Out).
skip_quoted([C|T0],Q,[C|T], In, Out) :- !,
skip_quoted(T0, Q, T, In, Out).
skip_quoted([], _, [], [], []).
% get_last_event(-String)
% return last event typed as a string
get_last_event(Event) :-
'$history'(_, Atom),
atom_chars(Atom, Event), !.
get_last_event(_) :-
print_message(query, history(no_event)),
fail.
% match_event(+Spec, -Event, -Rest)
% Use Spec as a specification of and event and return the event as Event
% and what is left of Spec as Rest.
match_event(Spec, Event, Rest) :-
find_event(Spec, Event, Rest), !.
match_event(_, _, _) :-
print_message(query, history(no_event)),
fail.
not_event_char(C) :- code_type(C, csym), !, fail.
not_event_char(!) :- !, fail.
not_event_char(_).
find_event([!|Left], Event, Left) :- !,
get_last_event(Event).
find_event([N|Rest], Event, Left) :-
code_type(N, digit), !,
take_number([N|Rest], String, Left),
number_codes(Number, String),
'$history'(Number, Atom),
atom_chars(Atom, Event).
find_event(Spec, Event, Left) :-
take_string(Spec, String, Left),
matching_event(String, Event).
take_string([C|Rest], [C|String], Left) :-
code_type(C, csym), !,
take_string(Rest, String, Left).
take_string([C|Rest], [], [C|Rest]) :- !.
take_string([], [], []).
take_number([C|Rest], [C|String], Left) :-
code_type(C, digit), !,
take_string(Rest, String, Left).
take_number([C|Rest], [], [C|Rest]) :- !.
take_number([], [], []).
% matching_event(+String, -Event)
%
% Return first event with prefix String as a Prolog string.
matching_event(String, Event) :-
'$history'(_, AtomEvent),
atom_chars(AtomEvent, Event),
'$append'(String, _, Event), !.
'$append'(Head, OldAndTail, String) :-
lists:append(Head, OldAndTail, String).