library

Prolog files

aggregate.pl  -- Aggregation operators on backtrackable predicates
ansi_term.pl  -- Print decorated text to ANSI consoles
ansi_format/3	Format text with ANSI attributes.
ansi_get_color/2	Obtain the RGB color for an ANSI color parameter.
ansi_hyperlink/2	Create a hyperlink for a terminal emulator.
ansi_hyperlink/3	Create a hyperlink for a terminal emulator.
tty_url_hook/2	Hook for location_url/2.
console_color/2	Hook that allows for mapping abstract terms to concrete ANSI attributes.
message_line_element/2	Hook implementation that deals with ansi(+Attr, +Fmt, +Args) in message specifications.
apply.pl  -- Apply predicates on a list
apply_macros.pl  -- Goal expansion rules to avoid meta-calling
apply_macros_sentinel/0	Used to detect that library(apply_macros) is loaded into the current context explicitly.
expand_phrase/2	Provide goal-expansion for PhraseGoal.
expand_phrase/4	Provide goal-expansion for PhraseGoal.
arithmetic.pl  -- Extensible arithmetic
assoc.pl  -- Binary associations
atom.pl
identifier_parts/2	Parts is a list of atoms that make up Identifier.
join_identifier_parts/3	Join parts of an identifier according to Style.
restyle_identifier/3	Restyle an identifier by extracting the alnum substrings and joining them together according to Style.
backcomp.pl
$apropos_match/2	True if Needle is a sub atom of Haystack.
$arch/2
$argv/1
$declare_module/3	Used in triple20 particle library.
$home/1
$module/2
$set_prompt/1	Set the prompt for the toplevel.
$sig_atomic/1	Execute Goal without processing signals.
$strip_module/3	This used to be an internal predicate.
$version/1
C/3	Used to be generated by DCG.
at_initialization/1	Register goal only to be run if a saved state is restored.
call_cleanup/3	Call Cleanup with an indication of the reason unified to Catcher.
checklist/2
concat/3
concat_atom/2	Concatenate a list of atomic values to an atom.
concat_atom/3	Concatenate a list of atomic values to an atom, inserting Separator between each consecutive elements.
convert_time/2	Convert a time-stamp as obtained though get_time/1 into a textual representation using the C-library function ctime().
convert_time/8	Convert a time stamp, provided by get_time/1, time_file/2, etc.
current_module/2	True if Module is a module loaded from File.
current_mutex/3
current_thread/2
displayq/1	Write term ignoring operators and quote atoms.
displayq/2	Write term ignoring operators and quote atoms.
eval_license/0
export_list/2	Module exports the predicates of List.
feature/2	Control Prolog flags.
flush/0
free_variables/2	Return a list of unbound variables in Term.
hash/1	Demands PredInd to be indexed using a hash-table.
hash_term/2	If Term is ground, Hash is unified to an integer representing a hash for Term.
index/1	Prepare the predicate indicated by Head for multi-argument indexing.
lock_predicate/2
merge/3	Merge the ordered sets List1 and List2 into a new ordered list.
merge_set/3	Merge the ordered sets Set1 and Set2 into a new ordered set without duplicates.
message_queue_size/2	True if Queue holds Size terms.
proper_list/1	Old SWI-Prolog predicate to check for a list that really ends in a [].
read_clause/1
read_clause/2
read_history/6
read_pending_input/3
read_variables/2
read_variables/3
set_base_module/1	Set the default module from which we inherit.
set_feature/2	Control Prolog flags.
setup_and_call_cleanup/3	Call Cleanup once after Goal is finished.
setup_and_call_cleanup/4	Call Cleanup once after Goal is finished, with Catcher unified to the reason.
sformat/2
sformat/3
string_to_atom/2	Bi-directional conversion between string and atom.
string_to_list/2	Bi-directional conversion between a string and a list of character codes.
sublist/3	Succeeds if List2 unifies with a list holding those terms for which call(Goal, Elem) succeeds.
substring/4	Predecessor of sub_string using 1-based Offset.
sumlist/2	True when Sum is the list of all numbers in List.
thread_at_exit/1	Register Goal to be called when the calling thread exits.
trie_insert_new/3
unlock_predicate/2
write_ln/1
base32.pl  -- Base32 encoding and decoding
base64.pl  -- Base64 encoding and decoding
broadcast.pl
broadcast/1	Broadcast given event.
broadcast_request/1	Broadcast given event till accepted.
listen/2	Open a channel for listening for events of the given `Templ'.
listen/3	Open a channel for listening for events of the given `Templ'.
listening/3	returns currently open channels.
unlisten/1	Destroy a channel.
unlisten/2	Destroy a channel.
unlisten/3	Destroy a channel.
charsio.pl  -- I/O on Lists of Character Codes
check.pl
check/0	Run all consistency checks defined by checker/2.
checker/2	Register code validation routines.
list_autoload/0	Report predicates that may be auto-loaded.
list_cross_module_calls/0	List calls from one module to another using Module:Goal where the callee is not defined exported, public or multifile, i.e., where the callee should be considered private.
list_format_errors/0	List argument errors for format/2,3.
list_format_errors/1	List argument errors for format/2,3.
list_rationals/0	List rational numbers that appear in clauses.
list_rationals/1	List rational numbers that appear in clauses.
list_redefined/0	Lists predicates that are defined in the global module user as well as in a normal module; that is, predicates for which the local definition overrules the global default definition.
list_strings/0	List strings that appear in clauses.
list_strings/1	List strings that appear in clauses.
list_trivial_fails/0	List goals that trivially fail because there is no matching clause.
list_trivial_fails/1	List goals that trivially fail because there is no matching clause.
list_undefined/0	Report undefined predicates.
list_undefined/1	Report undefined predicates.
list_void_declarations/0	List predicates that have declared attributes, but no clauses.
string_predicate/1	Multifile hook to disable list_strings/0 on the given predicate.
trivial_fail_goal/1	Multifile hook that tells list_trivial_fails/0 to accept Goal as valid.
valid_string_goal/1	Multifile hook that qualifies Goal as valid for list_strings/0.
codesio.pl  -- I/O on Lists of Character Codes
coinduction.pl
coinductive/1	The declaration :- coinductive name/arity, ... defines predicates as coinductive.
csv.pl  -- Process CSV (Comma-Separated Values) data
ctypes.pl  -- Character code classification
is_digit/3	Succeeds if `C' is a digit using `Base' as base and `Weight' represents its value.
is_paren/2	True if Open is the open-parenthesis of Close.
to_lower/2	Downcase a character code.
to_upper/2	Upcase a character code.
upper_lower/2	True when U is the character code of an uppercase character and L is the character code of the corresponding lowercase character.
date.pl  -- Process dates and times
debug.pl
assertion_failed/2	This hook is called if the Goal of assertion/1 fails.
debug_print_hook/3	Hook called by debug/3.
assertion/1	Acts similar to C assert() macro.
debug/1	Add/remove a topic from being printed.
debug/3	Format a message if debug topic is enabled.
debug_message_context/1	Specify additional context for debug messages.
debugging/1	Examine debug topics.
debugging/2	Examine debug topics.
list_debug_topics/0	List currently known topics for debug/3 and their setting.
list_debug_topics/1	List currently known topics for debug/3 and their setting.
nodebug/1	Add/remove a topic from being printed.
dialect.pl  -- Support multiple Prolog dialects
dicts.pl  -- Dict utilities
dif.pl  -- The dif/2 constraint
edinburgh.pl  -- Some traditional Edinburgh predicates
edit.pl  -- Editor interface
error.pl
current_encoding/1	True if Name is the name of a supported encoding.
current_type/3	True when Type is a currently defined type and Var satisfies Type of the body term Body succeeds.
domain_error/2	The argument is of the proper type, but has a value that is outside the supported values.
existence_error/2	Culprit is of the correct type and correct domain, but there is no existing (external) resource of type ObjectType that is represented by it.
existence_error/3	Culprit is of the correct type and correct domain, but there is no existing (external) resource of type ObjectType that is represented by it in the provided set.
has_type/2	True if Term satisfies Type.
instantiation_error/1	An argument is under-instantiated.
is_of_type/2	True if Term satisfies Type.
must_be/2	True if Term satisfies the type constraints for Type.
permission_error/3	It is not allowed to perform Operation on (whatever is represented by) Culprit that is of the given PermissionType (in fact, the ISO Standard is confusing and vague about these terms' meaning).
representation_error/1	A representation error indicates a limitation of the implementation.
resource_error/1	A goal cannot be completed due to lack of resources.
syntax_error/1	A text has invalid syntax.
type_error/2	Tell the user that Culprit is not of the expected ValidType.
uninstantiation_error/1	An argument is over-instantiated.
exceptions.pl  -- Exception classification
explain.pl
explain/1	Give an explanation on Term.
explain/2	True when Explanation is an explanation of Term.
fastrw.pl  -- Fast reading and writing of terms
files.pl
gensym.pl
gensym/2	Generate <Base>1, <Base>2, etc atoms on each subsequent call.
reset_gensym/0	Reset gensym for all registered keys.
reset_gensym/1	Restart generation of identifiers from Base at <Base>1.
git.pl  -- Run GIT commands
hashtable.pl
ht_del/3	Delete Key-Value from HT.
ht_gen/3	True when Key-Value is in HT.
ht_get/3	True when Key is in HT and associated with Value.
ht_is_hashtable/1	True when HT is a hash table.
ht_keys/2	True when Keys is an ordered set of all keys in HT.
ht_new/1	Create a new hash table.
ht_pairs/2	True when Pairs and HT represent the same association.
ht_put/3	Add a Key-Value to HT.
ht_put/5	Add Key-Value to HT.
ht_put_new/3	As ht_put/3, but fails if Key is already in HT instead of updating the associated value.
ht_size/2	True when Size is the number of key-value pairs in HT.
ht_update/4	True when HT holds Key-Old before and Key-New after this call.
heaps.pl
add_to_heap/4	Adds Key with priority Priority to Heap0, constructing a new heap in Heap.
delete_from_heap/4	Deletes Key from Heap0, leaving its priority in Priority and the resulting data structure in Heap.
empty_heap/1	True if Heap is an empty heap.
get_from_heap/4	Retrieves the minimum-priority pair Priority-Key from Heap0.
heap_size/2	Determines the number of elements in Heap.
heap_to_list/2	Constructs a list List of Priority-Element terms, ordered by (ascending) priority.
is_heap/1	Returns true if X is a heap.
list_to_heap/2	If List is a list of Priority-Element terms, constructs a heap out of List.
merge_heaps/3	Merge the two heaps Heap0 and Heap1 in Heap.
min_of_heap/3	Unifies Key with the minimum-priority element of Heap and Priority with its priority value.
min_of_heap/5	Gets the two minimum-priority elements from Heap.
singleton_heap/3	True if Heap is a heap with the single element Priority-Key.
help.pl  -- Text based manual
increval.pl  -- Incremental dynamic predicate modification
intercept.pl
intercept/3	Run Goal as call/1.
intercept/4	Similar to intercept/3, but the copy of Handler is called as call(Copy,Arg), which allows passing large context arguments or arguments subject to unification or destructive assignment.
intercept_all/4	True when List contains all instances of Template that have been sent using send_signal/1 where the argument unifies with Ball.
nb_intercept_all/4	As intercept_all/4, but backtracing inside Goal does not reset List.
send_signal/1	If this predicate is called from a sub-goal of intercept/3, execute the associated Handler of the intercept/3 environment.
send_silent_signal/1	As send_signal/1, but succeed silently if there is no matching intercept environment.
iostream.pl  -- Utilities to deal with streams
lazy_lists.pl  -- Lazy list handling
listing.pl  -- List programs and pretty print clauses
lists.pl  -- List Manipulation
macros.pl  -- Macro expansion
main.pl  -- Provide entry point for scripts
make.pl
make/0	Reload all source files that have been changed since they were loaded.
make_reload_file/1	Reload file into the proper module.
modules.pl  -- Module utility predicates
nb_set.pl  -- Non-backtrackable sets
occurs.pl
contains_term/2	Succeeds if Sub is contained in Term (=, deterministically).
contains_var/2	Succeeds if Sub is contained in Term (==, deterministically).
free_of_term/2	Succeeds of Sub does not unify to any subterm of Term.
free_of_var/2	Succeeds of Sub is not equal (==) to any subterm of Term.
occurrences_of_term/3	Count the number of SubTerms in Term that unify with SubTerm.
occurrences_of_var/3	Count the number of SubTerms in Term that are equal to SubTerm.
sub_term/2	Generates (on backtracking) all subterms of Term.
sub_term_shared_variables/3	If Sub is a sub term of Term, Vars is bound to the list of variables in Sub that also appear outside Sub in Term.
sub_var/2	Generates (on backtracking) all subterms (==) of Term.
operators.pl  -- Manage operators
option.pl
dict_options/2	Convert between an option list and a dictionary.
merge_options/3	Merge two option sets.
meta_options/3	Perform meta-expansion on options that are module-sensitive.
option/2	Get an Option from Options.
option/3	Get an Option from Options.
select_option/3	Get and remove Option from Options.
select_option/4	Get and remove Option with default value.
optparse.pl  -- command line parsing
ordsets.pl  -- Ordered set manipulation
pairs.pl  -- Operations on key-value lists
persistency.pl  -- Provide persistent dynamic predicates
pio.pl  -- Pure I/O
portray_text.pl
portray_text/1	Switch portraying on or off.
set_portray_text/2	Set options for portraying.
set_portray_text/3	Set options for portraying.
pprint.pl  -- Pretty Print Prolog terms
predicate_options.pl  -- Access and analyse predicate options
prolog_autoload.pl
autoload_all/0	Force all necessary autoloading to be done now.
autoload_all/1	Force all necessary autoloading to be done now.
prolog_breakpoints.pl  -- Manage Prolog break-points
prolog_clause.pl
prolog_code.pl  -- Utilities for reasoning about code
prolog_codewalk.pl  -- Prolog code walker
prolog_colour.pl  -- Prolog syntax colouring support.
prolog_config.pl  -- Provide configuration information
prolog_coverage.pl  -- Coverage analysis tool
prolog_debug.pl  -- User level debugging tools
prolog_format.pl  -- Analyse format specifications
prolog_history.pl  -- Per-directory persistent commandline history
prolog_jiti.pl
jiti_list/0	List the JITI (Just In Time Indexes) of selected predicates.
jiti_list/1	List the JITI (Just In Time Indexes) of selected predicates.
jiti_suggest_modes/0	Propose modes for the predicates referenced by Spec.
jiti_suggest_modes/1	Propose modes for the predicates referenced by Spec.
prolog_metainference.pl
infer_meta_predicate/2	True when MetaSpec is a meta-predicate specifier for the predicate Head.
inferred_meta_predicate/2	True when MetaSpec is an inferred meta-predicate specification for Head.
prolog_pack.pl  -- A package manager for Prolog
prolog_profile.pl  -- Execution profiler
prolog_source.pl  -- Examine Prolog source-files
prolog_stack.pl  -- Examine the Prolog stack
prolog_trace.pl  -- Print access to predicates
prolog_versions.pl  -- Demand specific (Prolog) versions
prolog_wrap.pl
current_predicate_wrapper/4	True if Head is wrapped with Body.
unwrap_predicate/2	Remove the outermost wrapper whose name unifies with Name.
wrap_predicate/4	Wrap the predicate referenced by Head using Body.
prolog_xref.pl  -- Prolog cross-referencer data collection
pure_input.pl  -- Pure Input from files and streams
qsave.pl
arch_shlib/3	This is a user defined hook called by qsave_program/2.
qsave_program/1	Make a saved state in file `File'.
qsave_program/2	Make a saved state in file `File'.
qsave_toplevel/0	Called to handle `-c file` compilaton.
quasi_quotations.pl
phrase_from_quasi_quotation/2	Process the quasi quotation using the DCG Grammar.
quasi_quotation_syntax/1	Declare the predicate SyntaxName/4 to implement the the quasi quote syntax SyntaxName.
quasi_quotation_syntax_error/1	Report syntax_error(Error) using the current location in the quasi quoted input parser.
with_quasi_quotation_input/3	Process the quasi-quoted Content using Stream parsed by Goal.
quintus.pl  -- Quintus compatibility
random.pl  -- Random numbers
rbtrees.pl  -- Red black trees
readln.pl
readutil.pl  -- Read utilities
record.pl  -- Access compound arguments by name
sandbox.pl
sandbox_allowed_directive/1	Throws an exception if G is not considered a safe directive.
sandbox_allowed_expansion/1	Throws an exception if G is not considered a safe expansion goal.
sandbox_allowed_goal/1	Throw an exception if it is not safe to call G.
format_calls/3	Find ~@ calls from Format and Args.
safe_call/1	Call Goal if it complies with the sandboxing rules.
safe_directive/1	Hook to declare additional directives as safe.
safe_global_variable/1	Declare the given global variable safe to write to.
safe_goal/1	True if calling Goal provides no security risc.
safe_meta/2	Hook.
safe_primitive/1	True if Goal is safe to call (i.e., cannot access dangerous system-resources and cannot upset other parts of the Prolog process).
safe_prolog_flag/2	True if it is safe to set the flag Flag to Value.
settings.pl
convert_setting_text/3	Converts from textual form to Prolog Value.
current_setting/1	True if Setting is a currently defined setting.
env/2	Evaluate environment variables on behalf of arithmetic expressions.
env/3	Evaluate environment variables on behalf of arithmetic expressions.
list_settings/0	List settings to current_output.
list_settings/1	List settings to current_output.
load_settings/1	Load local settings from File.
load_settings/2	Load local settings from File.
restore_setting/1	Restore the value of setting Name to its default.
save_settings/0	Save modified settings to File.
save_settings/1	Save modified settings to File.
set_setting/2	Change a setting.
set_setting_default/2	Change the default for a setting.
setting/2	True when Name is a currently defined setting with Value.
setting/4	Define a setting.
setting_property/2	Query currently defined settings.
shell.pl
cd/0	Change working directory.
cd/1	Change working directory.
dirs/0	Manage the directory stack:.
file_style/2	True when File should be listed as a terminal hyperlink.
ls/0	Listing similar to Unix =ls -F=, flagging directories with =/=.
ls/1	Listing similar to Unix =ls -F=, flagging directories with =/=.
mv/2	Move (Rename) a file.
popd/0	Manage the directory stack:.
pushd/0	Manage the directory stack:.
pushd/1	Manage the directory stack:.
pwd/0	Print current working directory.
rm/1	Remove (unlink) a file.
shell/0	Execute an interactive shell.
shlib.pl  -- Utility library for loading foreign objects (DLLs, shared objects)
solution_sequences.pl  -- Modify solution sequences
sort.pl
statistics.pl  -- Get information about resource usage
streams.pl
with_output_to/3	Run Goal and once/1 while capturing all output to all streams (current_output, user_output and user_error) in the string Output.
strings.pl
dedent_lines/3	Remove shared indentation for all lines in a string.
indent_lines/3	Add Prefix to the beginning of lines in In.
indent_lines/4	Similar to indent_lines/3, but only adds Prefix to lines for which call(Filter, Line) succeeds.
interpolate_string/4	Establish a string from a template by replacing patterns.
string/4	Implements the quasi quotation syntax string.
string_lines/2	True when String represents Lines.
system.pl  -- System utilities
tables.pl
abolish_table_call/1	Same as abolish_table_subgoals/1.
abolish_table_call/2	Same as abolish_table_subgoals/1.
abolish_table_pred/1	Invalidates all tabled subgoals for the predicate denoted by the predicate or term indicator Pred.
abolish_table_subgoals/2	Behaves as abolish_table_subgoals/1, but allows the default table_gc_action to be over-ridden with a flag, which can be either abolish_tables_transitively or abolish_tables_singly.
get_call/3	True when Trie is an answer trie for a variant of CallTerm.
get_calls/3	True when Trie is an answer trie for a variant that unifies with CallTerm and Skeleton is the answer skeleton.
get_residual/2	True if CallTerm appears in a table and has DelayList.
get_returns/2	True when Return is an answer template for the AnswerTrie.
get_returns/3	True when Return is an answer template for the AnswerTrie and the answer is represented by the trie node NodeID.
get_returns_and_dls/3	True when Return appears in AnswerTrie with the given DelayLists.
get_returns_and_tvs/3	Identical to get_returns/2, but also obtains the truth value of a given answer, setting TruthValue to t if the answer is unconditional and to u if it is conditional.
get_returns_for_call/2	True if AnswerTerm appears in the tables for the variant CallTerm.
set_pil_off/0	Dummy predicates for XSB compatibility.
set_pil_on/0	Dummy predicates for XSB compatibility.
t not/1	Tabled negation.
tfindall/3	This predicate emerged in XSB in an attempt to provide a safer alternative to findall/3.
terms.pl
foldsubterms/4	The predicate foldsubterms/5 calls call(Goal4, SubTerm1, SubTerm2, StateIn, StateOut) for each subterm, including variables, in Term1.
foldsubterms/5	The predicate foldsubterms/5 calls call(Goal4, SubTerm1, SubTerm2, StateIn, StateOut) for each subterm, including variables, in Term1.
mapargs/3	Term1 and Term2 have the same functor (name/arity) and for each matching pair of arguments call(Goal, A1, A2) is true.
mapsubterms/3	Recursively map sub terms of Term1 into subterms of Term2 for every pair for which call(Goal, ST1, ST2) succeeds.
mapsubterms_var/3	Recursively map sub terms of Term1 into subterms of Term2 for every pair for which call(Goal, ST1, ST2) succeeds.
same_functor/2	True when Term1 and Term2 are terms that have the same functor (Name/Arity).
same_functor/3	True when Term1 and Term2 are terms that have the same functor (Name/Arity).
same_functor/4	True when Term1 and Term2 are terms that have the same functor (Name/Arity).
subsumes/2	True if Generic is unified to Specific without changing Specific.
subsumes_chk/2	True if Generic can be made equivalent to Specific without changing Specific.
term_factorized/3	Is true when Skeleton is Term where all subterms that appear multiple times are replaced by a variable and Substitution is a list of Var=Value that provides the subterm at the location Var.
term_size/2	True if Size is the size in cells occupied by Term on the global (term) stack.
term_subsumer/3	General is the most specific term that is a generalisation of Special1 and Special2.
variant/2	Same as SWI-Prolog Term1 =@= Term2.
thread.pl  -- High level thread primitives
thread_pool.pl
create_pool/1	Hook to create a thread pool lazily.
current_thread_pool/1	True if Name refers to a defined thread pool.
thread_create_in_pool/4	Create a thread in Pool.
thread_pool_create/3	Create a pool of threads.
thread_pool_destroy/1	Destroy the thread pool named Name.
thread_pool_property/2	True if Property is a property of thread pool Name.
worker_exitted/3	It is possible that '__thread_pool_manager' no longer exists while closing down the process because the manager was killed before the worker.
threadutil.pl  -- Interactive thread utilities
tty.pl
menu/3	Show a menu.
tty_clear/0	Clear the display.
tty_flash/0	Give visual signal if possible, otherwise beep.
ugraphs.pl  -- Graph manipulation library
url.pl  -- Analysing and constructing URL
utf8.pl  -- UTF-8 encoding/decoding on lists of character codes.
varnumbers.pl
max_var_number/3	True when Max is the max of Start and the highest numbered $VAR(N) term.
numbervars/1	Number variables in Term using $VAR(N).
varnumbers/2	Inverse of numbervars/1.
varnumbers/3	Inverse of numbervars/3.
varnumbers_names/3	If Term is a term with numbered and named variables using the reserved term '$VAR'(X), Copy is a copy of Term where each '$VAR'(X) is consistently replaced by a fresh variable and Bindings is a list X = Var, relating the X terms with the variable it is mapped to.
wfs.pl
answer_residual/2	True when Goal resolves to a tabled predicate and Residual is the residual goal associated with an answer for Goal.
call_delays/2	True when Goal is true with Delays.
call_residual_program/2	Call Goal and return the full residual program as a list of Clauses.
delays_residual_program/2	Given a delay as returned by call_delays/2, produce a set of clauses the represents the complete residual program responsible for these delays, The program contains at least one loop through tnot/1 and is either inconsistent or has multiple models according to the stable model semantics.
when.pl  -- Conditional coroutining
writef.pl
swritef/2	Use writef/1 or writef/2 and write the result to a string.
swritef/3	Use writef/1 or writef/2 and write the result to a string.
writef/1	Formatted write to the current_output.
writef/2	Formatted write to the current_output.
www_browser.pl  -- Open a URL in the users browser
yall.pl  -- Lambda expressions
zip.pl  -- Access resource ZIP archives