View source with raw comments or as raw

    1/*  Part of SWI-Prolog
    2
    3    Author:        Jan Wielemaker
    4    E-mail:        J.Wielemaker@vu.nl
    5    WWW:           http://www.swi-prolog.org
    6    Copyright (c)  1985-2021, University of Amsterdam
    7                              VU University Amsterdam
    8                              SWI-Prolog Solutions b.v.
    9    All rights reserved.
   10
   11    Redistribution and use in source and binary forms, with or without
   12    modification, are permitted provided that the following conditions
   13    are met:
   14
   15    1. Redistributions of source code must retain the above copyright
   16       notice, this list of conditions and the following disclaimer.
   17
   18    2. Redistributions in binary form must reproduce the above copyright
   19       notice, this list of conditions and the following disclaimer in
   20       the documentation and/or other materials provided with the
   21       distribution.
   22
   23    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   24    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   25    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
   26    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   27    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
   28    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
   29    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   30    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   31    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   32    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
   33    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   34    POSSIBILITY OF SUCH DAMAGE.
   35*/
   36
   37:- module(backward_compatibility,
   38          [ '$arch'/2,
   39            '$version'/1,
   40            '$home'/1,
   41            '$argv'/1,
   42            '$set_prompt'/1,
   43            '$strip_module'/3,
   44            '$declare_module'/3,
   45            '$module'/2,
   46            at_initialization/1,        % :Goal
   47            displayq/1,
   48            displayq/2,
   49            sformat/2,                  % -String, +Fmt
   50            sformat/3,                  % -String, +Fmt, +Args
   51            concat/3,
   52            concat_atom/2,              % +List, -Atom
   53            concat_atom/3,              % +List, +Sep, -Atom
   54            '$apropos_match'/2,         % +Needle, +Hashstack
   55            read_clause/1,              % -Term
   56            read_clause/2,              % +Stream, -Term
   57            read_variables/2,           % -Term, -VariableNames
   58            read_variables/3,           % +Stream, -Term, -VariableNames
   59            read_pending_input/3,       % +Stream, -List, ?Tail
   60            feature/2,
   61            set_feature/2,
   62            substring/4,
   63            string_to_list/2,           % ?String, ?Codes
   64            string_to_atom/2,           % ?String, ?Atom
   65            flush/0,
   66            write_ln/1,                 % +Term
   67            proper_list/1,              % @Term
   68            free_variables/2,           % +Term, -Variables
   69            hash_term/2,                % +Term, -Hash
   70            checklist/2,                % :Goal, +List
   71            sublist/3,                  % :Goal, +List, -Sublist
   72            sumlist/2,                  % +List, -Sum
   73            convert_time/2,             % +Stamp, -String
   74            convert_time/8,             % +String, -YMDmhs.ms
   75            'C'/3,                      % +List, -Head, -Tail
   76            current_thread/2,           % ?Thread, ?Status
   77            current_mutex/3,            % ?Mutex, ?Owner, ?Count
   78            message_queue_size/2,       % +Queue, -TermsWaiting
   79            lock_predicate/2,           % +Name, +Arity
   80            unlock_predicate/2,         % +Name, +Arity
   81            current_module/2,           % ?Module, ?File
   82            export_list/2,              % +Module, -Exports
   83            setup_and_call_cleanup/3,   % :Setup, :Goal, :Cleanup
   84            setup_and_call_cleanup/4,   % :Setup, :Goal, ?Catcher, :Cleanup
   85            merge/3,                    % +List1, +List2, -Union
   86            merge_set/3,                % +Set1, +Set2, -Union
   87            (index)/1,                  % :Head
   88            hash/1,                     % :PI
   89            set_base_module/1,          % :Base
   90            eval_license/0,
   91            trie_insert_new/3,		% +Trie, +Term, -Node
   92            thread_at_exit/1,           % :Goal
   93            read_history/6,             % +Show, +Help, +Special, +Prompt,
   94                                        % -Term, -Bindings
   95            '$sig_atomic'/1             % :Goal
   96          ]).   97:- autoload(library(apply),[maplist/3,maplist/2]).   98:- autoload(library(lists),[sum_list/2]).   99:- autoload(library(system),[lock_predicate/1,unlock_predicate/1]).  100
  101
  102:- meta_predicate
  103    at_initialization(0),
  104    setup_and_call_cleanup(0,0,0),
  105    setup_and_call_cleanup(0,0,?,0),
  106    checklist(1, +),
  107    sublist(1, +, ?),
  108    index(:),
  109    hash(:),
  110    set_base_module(:),
  111    thread_at_exit(0),
  112    '$sig_atomic'(0).

Backward compatibility

This library defines predicates that used to exist in older version of SWI-Prolog, but are considered obsolete as there functionality is neatly covered by new features. Most often, these constructs are superseded by ISO-standard compliant predicates.

Please also note the existence of quintus.pl and edinburgh.pl for more compatibility predicates.

See also: - gxref/0 can be used to find files that import from library(backcomp) and thus reply on deprecated features. */

$arch(-Architecture, -Version) is det

deprecated: - use current_prolog_flag(arch, Architecture)

  132'$arch'(Arch, unknown) :-
  133    current_prolog_flag(arch, Arch).

$version(Version:integer) is det

deprecated: - use current_prolog_flag(version, Version)

  139'$version'(Version) :-
  140    current_prolog_flag(version, Version).

$home(-SWIPrologDir) is det

See also: - file_search_path/2, absolute_file_name/3, The Prolog home directory is available through the alias swi.
deprecated: - use current_prolog_flag(home, SWIPrologDir)

  148'$home'(Home) :-
  149    current_prolog_flag(home, Home).

$argv(-Argv:list) is det

deprecated: - use current_prolog_flag(os_argv, Argv) or current_prolog_flag(argv, Argv)

  156'$argv'(Argv) :-
  157    current_prolog_flag(os_argv, Argv).

$set_prompt(+Prompt) is det

Set the prompt for the toplevel

deprecated: - use set_prolog_flag(toplevel_prompt, Prompt).

  165'$set_prompt'(Prompt) :-
  166    (   is_list(Prompt)
  167    ->  Prompt0 = Prompt
  168    ;   atom_codes(Prompt, Prompt0)
  169    ),
  170    maplist(percent_to_tilde, Prompt0, Prompt1),
  171    atom_codes(Atom, Prompt1),
  172    set_prolog_flag(toplevel_prompt, Atom).
  173
  174percent_to_tilde(0'%, 0'~) :- !.
  175percent_to_tilde(X, X).

displayq(@Term) is det

displayq(+Stream, @Term) is det

Write term ignoring operators and quote atoms.

deprecated: - Use write_term/3 or write_canonical/2.

  185displayq(Term) :-
  186    write_term(Term, [ignore_ops(true),quoted(true)]).
  187displayq(Stream, Term) :-
  188    write_term(Stream, Term, [ignore_ops(true),quoted(true)]).

sformat(-String, +Format, +Args) is det

sformat(-String, +Format) is det

deprecated: - Use format/3 as format(string(String), ...)

  196:- module_transparent sformat/2, sformat/3.  197
  198sformat(String, Format) :-
  199    format(string(String), Format, []).
  200sformat(String, Format, Arguments) :-
  201    format(string(String), Format, Arguments).

concat(+Atom1, +Atom2, -Atom) is det

deprecated: - Use ISO atom_concat/3

  207concat(A, B, C) :-
  208    atom_concat(A, B, C).

concat_atom(+List, -Atom) is det

Concatenate a list of atomic values to an atom.

deprecated: - Use atomic_list_concat/2 as proposed by the prolog commons initiative.

  217concat_atom([A, B], C) :-
  218    !,
  219    atom_concat(A, B, C).
  220concat_atom(L, Atom) :-
  221    atomic_list_concat(L, Atom).

concat_atom(+List, +Separator, -Atom) is det

Concatenate a list of atomic values to an atom, inserting Separator between each consecutive elements.

deprecated: - Use atomic_list_concat/3 as proposed by the prolog commons initiative.

  232concat_atom(L, Sep, Atom) :-
  233    atomic_list_concat(L, Sep, Atom).

$apropos_match(+Needle, +Haystack) is semidet: True if Needle is a sub atom of Haystack. Ignores the case of Haystack.

  240'$apropos_match'(Needle, Haystack) :-
  241    sub_atom_icasechk(Haystack, _, Needle).

read_clause(-Term) is det

deprecated: - Use read_clause/3 or read_term/3.

  247read_clause(Term) :-
  248    read_clause(current_input, Term).

read_clause(+Stream, -Term) is det

deprecated: - Use read_clause/3 or read_term/3.

  254read_clause(Stream, Term) :-
  255    read_clause(Stream, Term, [process_comment(false)]).

read_variables(-Term, -Bindings) is det

read_variables(+In:stream, -Term, -Bindings) is det

deprecated: - Use ISO read_term/2 or read_term/3.

  262read_variables(Term, Vars) :-
  263    read_term(Term, [variable_names(Vars)]).
  264
  265read_variables(Stream, Term, Vars) :-
  266    read_term(Stream, Term, [variable_names(Vars)]).

read_pending_input(+Stream, -Codes, ?Tail) is det

deprecated: - Use read_pending_codes/3.

  272read_pending_input(Stream, Codes, Tail) :-
  273    read_pending_codes(Stream, Codes, Tail).

feature(?Key, ?Value) is nondet

set_feature(+Key, @Term) is det

Control Prolog flags.

deprecated: - Use ISO current_prolog_flag/2 and set_prolog_flag/2.

  282feature(Key, Value) :-
  283    current_prolog_flag(Key, Value).
  284
  285set_feature(Key, Value) :-
  286    set_prolog_flag(Key, Value).

substring(+String, +Offset, +Length, -Sub)

Predecessor of sub_string using 1-based Offset.

deprecated: - Use sub_string/5.

  294substring(String, Offset, Length, Sub) :-
  295    Offset0 is Offset - 1,
  296    sub_string(String, Offset0, Length, _After, Sub).

string_to_list(?String, ?Codes) is det

Bi-directional conversion between a string and a list of character codes.

deprecated: - Use string_codes/2.

  305string_to_list(String, Codes) :-
  306    string_codes(String, Codes).

string_to_atom(?String, ?Atom) is det

Bi-directional conversion between string and atom.

deprecated: - Use atom_string/2. Note that the order of the arguments is reversed.

  315string_to_atom(Atom, String) :-
  316    atom_string(String, Atom).

flush is det

deprecated: - use ISO flush_output/0.

  322flush :-
  323    flush_output.

write_ln(X) is det

deprecated: - Use writeln(X).

  329write_ln(X) :-
  330    writeln(X).

proper_list(+List)

Old SWI-Prolog predicate to check for a list that really ends in a []. There is not much use for the quick is_list, as in most cases you want to process the list element-by-element anyway.

deprecated: - Use ISO is_list/1.

  340proper_list(List) :-
  341    is_list(List).

free_variables(+Term, -Variables)

Return a list of unbound variables in Term. The name term_variables/2 is more widely used.

deprecated: - Use term_variables/2.

  350free_variables(Term, Variables) :-
  351    term_variables(Term, Variables).

hash_term(+Term, -Hash) is det

If Term is ground, Hash is unified to an integer representing a hash for Term. Otherwise Hash is left unbound.

deprecated: - Use term_hash/2.

  360hash_term(Term, Hash) :-
  361    term_hash(Term, Hash).

checklist(:Goal, +List)

deprecated: - Use maplist/2

  368checklist(Goal, List) :-
  369    maplist(Goal, List).

sublist(:Goal, +List1, ?List2)

Succeeds if List2 unifies with a list holding those terms for which call(Goal, Elem) succeeds.

deprecated: - Use include/3 from library(apply)
Compatibility: - DEC10 library

  379sublist(_, [], []) :- !.
  380sublist(Goal, [H|T], Sub) :-
  381    call(Goal, H),
  382    !,
  383    Sub = [H|R],
  384    sublist(Goal, T, R).
  385sublist(Goal, [_|T], R) :-
  386    sublist(Goal, T, R).

sumlist(+List, -Sum) is det

True when Sum is the list of all numbers in List.

deprecated: - Use sum_list/2

  394sumlist(List, Sum) :-
  395    sum_list(List, Sum).

$strip_module(+Term, -Module, -Plain)

This used to be an internal predicate. It was added to the XPCE compatibility library without $ and since then used at many places. From 5.4.1 onwards strip_module/3 is built-in and the $ variation is added here for compatibility.

deprecated: - Use strip_module/3.

  406:- module_transparent
  407    '$strip_module'/3.  408
  409'$strip_module'(Term, Module, Plain) :-
  410    strip_module(Term, Module, Plain).

$module(-OldTypeIn, +NewTypeIn)

  414'$module'(OldTypeIn, NewTypeIn) :-
  415    '$current_typein_module'(OldTypeIn),
  416    '$set_typein_module'(NewTypeIn).

$declare_module(Module, File, Line): Used in triple20 particle library. Should use a public interface

  422'$declare_module'(Module, File, Line) :-
  423    '$declare_module'(Module, user, user, File, Line, false).

at_initialization(:Goal) is det

deprecated: - Use initialization(Goal, restore)

  432at_initialization(Goal) :-
  433    initialization(Goal, restore).

convert_time(+Stamp, -String)

Convert a time-stamp as obtained though get_time/1 into a textual representation using the C-library function ctime(). The value is returned as a SWI-Prolog string object (see section 4.23). See also convert_time/8.

deprecated: - Use format_time/3.

  445convert_time(Stamp, String) :-
  446    format_time(string(String), '%+', Stamp).

convert_time(+Stamp, -Y, -Mon, -Day, -Hour, -Min, -Sec, -MilliSec)

Convert a time stamp, provided by get_time/1, time_file/2, etc. Year is unified with the year, Month with the month number (January is 1), Day with the day of the month (starting with 1), Hour with the hour of the day (0--23), Minute with the minute (0--59). Second with the second (0--59) and MilliSecond with the milliseconds (0--999). Note that the latter might not be accurate or might always be 0, depending on the timing capabilities of the system. See also convert_time/2.

deprecated: - Use stamp_date_time/3.

  461convert_time(Stamp, Y, Mon, Day, Hour, Min, Sec, MilliSec) :-
  462    stamp_date_time(Stamp,
  463                    date(Y, Mon, Day,
  464                         Hour, Min, FSec,
  465                         _, _, _),
  466                    local),
  467    Sec is integer(float_integer_part(FSec)),
  468    MilliSec is integer(float_fractional_part(FSec)*1000).

C(?List, ?Head, ?Tail) is det

Used to be generated by DCG. Some people appear to be using in in normal code too.

deprecated: - Do not use in normal code; DCG no longer generates it.

  477'C'([H|T], H, T).

current_thread(?Thread, ?Status) is nondet

deprecated: - Replaced by thread_property/2

  484current_thread(Thread, Status) :-
  485    nonvar(Thread),
  486    !,
  487    catch(thread_property(Thread, status(Status)),
  488          error(existence_error(thread, _), _),
  489          fail).
  490current_thread(Thread, Status) :-
  491    thread_property(Thread, status(Status)).

current_mutex(?Mutex, ?Owner, ?Count) is nondet

deprecated: - Replaced by mutex_property/2

  497current_mutex(Mutex, Owner, Count) :-
  498    nonvar(Mutex),
  499    !,
  500    catch(mutex_property(Mutex, status(Status)),
  501          error(existence_error(mutex, _), _),
  502          fail),
  503    map_mutex_status(Status, Owner, Count).
  504current_mutex(Mutex, Owner, Count) :-
  505    mutex_property(Mutex, status(Status)),
  506    map_mutex_status(Status, Owner, Count).
  507
  508map_mutex_status(unlocked, [], 0).
  509map_mutex_status(locked(Owner, Count), Owner, Count).

message_queue_size(+Queue, -Size) is det

True if Queue holds Size terms.

deprecated: - Please use message_queue_property(Queue, Size)

  518message_queue_size(Queue, Size) :-
  519    message_queue_property(Queue, size(Size)).

lock_predicate(+Name, +Arity) is det

unlock_predicate(+Name, +Arity) is det

deprecated: - see lock_predicate/1 and unlock_predicate/1.

  526:- module_transparent
  527    lock_predicate/2,
  528    unlock_predicate/2.  529
  530lock_predicate(Name, Arity) :-
  531    lock_predicate(Name/Arity).
  532
  533unlock_predicate(Name, Arity) :-
  534    unlock_predicate(Name/Arity).

current_module(?Module, ?File) is nondet

True if Module is a module loaded from File.

deprecated: - Use module_property(Module, file(File))

  542current_module(Module, File) :-
  543    module_property(Module, file(File)).

export_list(+Module, -List) is det

Module exports the predicates of List.

deprecated: - Use module_property(Module, exports(List))

  551export_list(Module, List) :-
  552    module_property(Module, exports(List)).

setup_and_call_cleanup(:Setup, :Goal, :Cleanup)

Call Cleanup once after Goal is finished.

deprecated: - Use setup_call_cleanup/3.

  560setup_and_call_cleanup(Setup, Goal, Cleanup) :-
  561    setup_call_cleanup(Setup, Goal, Cleanup).

setup_and_call_cleanup(:Setup, :Goal, Catcher, :Cleanup)

Call Cleanup once after Goal is finished, with Catcher unified to the reason

deprecated: - Use setup_call_cleanup/3.

  570setup_and_call_cleanup(Setup, Goal, Catcher, Cleanup) :-
  571    setup_call_catcher_cleanup(Setup, Goal, Catcher,Cleanup).

merge_set(+Set1, +Set2, -Set3)

Merge the ordered sets Set1 and Set2 into a new ordered set without duplicates.

deprecated: - New code should use ord_union/3 from library(ordsets)

  581merge_set([], L, L) :- !.
  582merge_set(L, [], L) :- !.
  583merge_set([H1|T1], [H2|T2], [H1|R]) :- H1 @< H2, !, merge_set(T1, [H2|T2], R).
  584merge_set([H1|T1], [H2|T2], [H2|R]) :- H1 @> H2, !, merge_set([H1|T1], T2, R).
  585merge_set([H1|T1], [H2|T2], [H1|R]) :- H1 == H2,    merge_set(T1, T2, R).

merge(+List1, +List2, -List3)

Merge the ordered sets List1 and List2 into a new ordered list. Duplicates are not removed and their order is maintained.

deprecated: - The name of this predicate is far too general for a rather specific function.

  596merge([], L, L) :- !.
  597merge(L, [], L) :- !.
  598merge([H1|T1], [H2|T2], [H|R]) :-
  599    (   H1 @=< H2
  600    ->  H = H1,
  601        merge(T1, [H2|T2], R)
  602    ;   H = H2,
  603        merge([H1|T1], T2, R)
  604    ).

index(:Head) is det

Prepare the predicate indicated by Head for multi-argument indexing.

deprecated: - As of version 5.11.29, SWI-Prolog performs just-in-time indexing on all arguments.

  614index(Head) :-
  615    print_message(warning, decl_no_effect(index(Head))).

hash(:PredInd) is det: Demands PredInd to be indexed using a hash-table. This is handled dynamically.

  622hash(PI) :-
  623    print_message(warning, decl_no_effect(hash(PI))).

set_base_module(:Base) is det

Set the default module from which we inherit.

deprecated: - Equivalent to set_module(base(Base)).

  631set_base_module(M:Base) :-
  632    set_module(M:base(Base)).

eval_license is det

deprecated: - Equivalent to license/0

  638eval_license :-
  639    license.

trie_insert_new(+Trie, +Term, -Handle) is semidet

deprecated: - use trie_insert/4.

  645trie_insert_new(Trie, Term, Handle) :-
  646    trie_insert(Trie, Term, [], Handle).

thread_at_exit(:Goal) is det: Register Goal to be called when the calling thread exits. @deprecated use prolog_listen(this_thread_exit, Goal)

  653thread_at_exit(Goal) :-
  654    prolog_listen(this_thread_exit, Goal).

read_history(+Show, +Help, +Special, +Prompt, -Term, -Bindings)

deprecated: - use read_term_with_history/2.

  660read_history(Show, Help, Special, Prompt, Term, Bindings) :-
  661    read_term_with_history(
  662        Term,
  663        [ show(Show),
  664          help(Help),
  665          no_save(Special),
  666          prompt(Prompt),
  667          variable_names(Bindings)
  668        ]).

$sig_atomic(:Goal)

Execute Goal without processing signals.

deprecated: - use sig_atomic/1.

  676'$sig_atomic'(Goal) :-
  677    sig_atomic(Goal)