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  -- Operations on atoms
backcomp.pl  -- Backward compatibility
base32.pl  -- Base32 encoding and decoding
base64.pl
base64/2	Equivalent to base64_encoded/3 using the options as(atom) and encoding(iso_latin_1).
base64/3	Encode/decode list of character codes using base64.
base64_encoded/3	General the base64 encoding and decoding.
base64_encoded/4
base64url/2	Translates between plaintext and base64url encoded atom or string.
base64url/3	Encode/decode list of character codes using Base64URL.
broadcast.pl  -- Event service
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
format_to_codes/3	Use format/2 to write to a list of character codes.
format_to_codes/4	Use format/2 to write to a difference list of character codes.
open_codes_stream/2	Open Codes as an input stream.
read_from_codes/2	Read Codes into Term.
read_term_from_codes/3	Read Codes into Term.
with_output_to_codes/2	Run Goal with as once/1.
with_output_to_codes/3	Run Goal with as once/1.
with_output_to_codes/4	As with_output_to_codes/3, but Stream is unified with the temporary stream.
write_term_to_codes/3	True when Codes is a string that matches the output of write_term/3 using Options.
write_term_to_codes/4	True when Codes\Tail is a difference list containing the character codes that matches the output of write_term/3 using Options.
write_to_codes/2	Codes is a list of character codes produced by write/1 on Term.
write_to_codes/3	Codes is a difference-list of character codes produced by write/1 on Term.
coinduction.pl  -- Co-Logic Programming
csv.pl
csv/3	Prolog DCG to `read/write' CSV data.
csv/4	Prolog DCG to `read/write' CSV data.
csv_options/2	Compiled is the compiled representation of the CSV processing options as they may be passed into csv//2, etc.
csv_read_file/2	Read a CSV file into a list of rows.
csv_read_file/3	Read a CSV file into a list of rows.
csv_read_file_row/3	True when Row is a row in File.
csv_read_row/3	Read the next CSV record from Stream and unify the result with Row.
csv_read_stream/3	Read CSV data from Stream.
csv_write_file/2	Write a list of Prolog terms to a CSV file.
csv_write_file/3	Write a list of Prolog terms to a CSV file.
csv_write_stream/3	Write the rows in Data to Stream.
ctypes.pl  -- Character code classification
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
edit/0	Edit associated or script file.
edit/1	Edit indicated object.
edit_command/2	This predicate should specify the shell-command called to invoke the user's editor.
locate/2	Locate object from the specified location.
locate/3
select_location/3
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
catch/4	As catch/3, only catching exceptions for which exception(ErrorType,Ball) is true.
error_term/2	Describe the formal part of error(Formal,ImplDefined) exceptions.
exception/2	If Ball is unbound, adds a delayed goal that tests the error belongs to Type when Ball is instantiated (by catch/3).
exception_term/2	Describe exceptions that are not error(Formal, _) terms.
exception_type/2	Declare all exceptions subsumed by Term to be an exception of Type.
explain.pl
explain/1	Give an explanation on Term.
explain/2	True when Explanation is an explanation of Term.
files.pl
can_open_file/2	Succeeds if the user has access to `File' in mode `Mode'.
chdir/1	Change Working Directory.
gensym.pl  -- Generate unique symbols
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  -- heaps/priority queues
help.pl
apropos/1	Print objects from the manual whose name or summary match with Query.
help/0	Show help for What.
help/1	Show help for What.
help_text/2	When Predicate is a term of the form Name/Arity for which documentation exists, HelpText is the documentation in textual format (parsed from the HTML help).
show_html_hook/1	Hook called to display the extracted HTML document.
increval.pl
incr_directly_depends/2	True if Goal1 depends on Goal2 in the IDG.
incr_invalid_subgoals/1	List is a sorted list (set) of the incremental subgoals that are currently invalid.
incr_invalidate_call/1	This is the XSB name, but the manual says incr_invalidate_calls/1 and the comment with the code suggests this is misnamed.
incr_invalidate_calls/1	Invalidate all tables for subgoals of Goal as well as tables that are affected by these.
incr_is_invalid/1	True when Subgoal's table is marked as invalid.
incr_propagate_calls/1	Activate the monotonic answer propagation similarly to when a new fact is asserted for a monotonic dynamic predicate.
incr_table_update/0	Updated all invalid tables.
incr_trans_depends/2	True for each pair in the transitive closure of incr_directly_depends(G1, G2).
is_incremental_subgoal/1	This predicate non-deterministically unifies Subgoal with incrementally tabled subgoals that are currently table entries.
intercept.pl  -- Intercept and signal interface
iostream.pl  -- Utilities to deal with streams
close_any/1	Execute the Close closure returned by open_any/5.
open_any/5	Establish a stream from Specification that should be closed using Close, which can either be called or passed to close_any/1.
lazy_lists.pl
lazy_engine_next/4	Lazy list iterator for engines.
lazy_findall/3	True when List is a lazy list containing the instantiations for Template for each answer of Goal.
lazy_findall/4	True when List is a lazy list containing the instantiations for Template for each answer of Goal.
lazy_get_codes/4	Lazy list iterator to get character codes from a stream.
lazy_list/2	Create a lazy list from a callback.
lazy_list/3	Create a lazy list where the next element is defined by.
lazy_list_iterator/4	Directive to create a lazy list iterator from a predicate that gets a single next value.
lazy_list_length/2	True if Len is the length of the materialized lazy list.
lazy_list_materialize/1	Materialize the lazy list.
lazy_message_queue/4	Lazy list iterator for message queues.
lazy_read_lines/4	Lazy list iterator to read lines from Stream.
lazy_read_terms/4	Turn a stream into a lazy list of Prolog terms.
listing.pl  -- List programs and pretty print clauses
lists.pl  -- List Manipulation
macros.pl
expand_macros/5	Perform macro expansion on TermIn with layout PosIn to produce TermOut with layout PosOut.
include_macros/3	Include macros from another module.
macro_position/1	True when Position is the position of the macro.
main.pl  -- Provide entry point for scripts
make.pl  -- Reload modified source files
modules.pl
current_temporary_module/1	True when we are executing in the given temporary module context.
in_temporary_module/3	Run Goal on temporary loaded sources and discard the module and loaded predicates after completion.
nb_set.pl
add_nb_set/2	Insert Key into the set.
add_nb_set/3	Insert Key into the set.
empty_nb_set/1	Create an empty non-backtrackable set.
gen_nb_set/2	Enumerate the members of a set in the standard order of terms.
nb_set_to_list/2	Get the elements of a an nb_set.
size_nb_set/2	Unify Size with the number of elements in the set.
occurs.pl  -- Finding and counting sub-terms
operators.pl  -- Manage operators
option.pl  -- Option list processing
optparse.pl  -- command line parsing
ordsets.pl  -- Ordered set manipulation
oset.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 dependencies
prolog_breakpoints.pl
breakpoint_property/2	True when Property is a property of the breakpoint Id.
delete_breakpoint/1	Delete breakpoint with given Id.
set_breakpoint/4	Put a breakpoint at the indicated source-location.
set_breakpoint/5	Put a breakpoint at the indicated source-location.
set_breakpoint_condition/2	Set a condition for of the breakpoint with given Id.
prolog_clause.pl
clause_info/4	Fetches source information for the given clause.
clause_info/5	Fetches source information for the given clause.
clause_name/2	Provide a suitable description of the indicated clause.
initialization_layout/4	Find term-layout of :- initialization directives.
make_varnames/5	Create a Term varnames(...) where each argument contains the name of the variable at that offset.
open_source/2	Hook into clause_info/5 that opens the stream holding the source for a specific clause.
predicate_name/2	Describe a predicate as [Module:]Name/Arity.
unify_goal/5	This hook is called to fix up source code manipulations that result from goal expansions.
unify_term/2	Unify the two terms, where T2 is created by writing the term and reading it back in, but be aware that rounding problems may cause floating point numbers not to unify.
prolog_code.pl  -- Utilities for reasoning about code
prolog_codewalk.pl  -- Prolog code walker
prolog_program_clause/2	True when ClauseRef is a reference for clause in the program.
prolog_walk_code/1	Walk over all loaded (user) Prolog code.
subterm_pos/5	True when SubTerm is a sub term of Term, compared using Cmp, TermPosition describes the term layout of Term and SubTermPos describes the term layout of SubTerm.
prolog_colour.pl
prolog_colourise_query/3	Colourise a query, to be executed in the context of SourceId.
prolog_colourise_stream/3	Determine colour fragments for the data on Stream.
prolog_colourise_stream/4	Determine colour fragments for the data on Stream.
prolog_colourise_term/4	Colourise the next term on Stream.
syntax_colour/2	True when a range classified Class must be coloured using Attributes.
vararg_goal_classification/3	Multifile hookable classification for vararg predicates.
prolog_config.pl  -- Provide configuration information
prolog_coverage.pl  -- Coverage analysis tool
prolog_debug.pl
debug_control_hook/1	Allow user-hooks in the Prolog debugger interaction.
debugging/0	Report current status of the debugger.
debugging_hook/1	Multifile hook that is called as forall(debugging_hook(DebugMode), true) and that may be used to extend the information printed from other debugging libraries.
exception_hook/5	Trap exceptions and consider whether or not to start the tracer.
nospy/1	Set/clear spy-points.
nospyall/0	Set/clear spy-points.
notrap/1	Install a trap on error(Formal, Context) exceptions that unify.
spy/1	Set/clear spy-points.
trap/1	Install a trap on error(Formal, Context) exceptions that unify.
trap_alias/2	Define short hands for commonly used exceptions.
prolog_format.pl  -- Analyse format specifications
prolog_history.pl
prolog_history/1	Execute Action on the history.
prolog_jiti.pl  -- Just In Time Indexing (JITI) utilities
prolog_metainference.pl  -- Infer meta-predicate properties
prolog_pack.pl  -- A package manager for Prolog
prolog_profile.pl  -- Execution profiler
prolog_source.pl
quasi_quotation_syntax/2	True when the quasi quotation syntax Syntax can be loaded from Library.
xref_close_source/2	Called by prolog_close_source/1 to close a source previously opened by the hook prolog:xref_open_source/2.
xref_open_source/2	Hook to open an xref SourceID.
directory_source_files/3	True when Files is a sorted list of Prolog source files in Dir.
file_alias_path/2	True if file Alias points to Dir.
file_name_on_path/2	True if OnPath a description of File based on the file search path.
load_quasi_quotation_syntax/2	Import quasi quotation syntax Syntax from Path into the module specified by the first argument.
path_segments_atom/2	Translate between a path represented as a/b/c and an atom representing the same path.
prolog_canonical_source/2	Given a user-specification of a source, generate a unique and indexable identifier for it.
prolog_close_source/1	Close a stream opened using prolog_open_source/2.
prolog_file_directives/3	True when Directives is a list of directives that appear in the source file File.
prolog_open_source/2	Open source with given canonical id (see prolog_canonical_source/2) and remove the #!
prolog_read_source_term/4	Read a term from a Prolog source-file.
read_source_term_at_location/3	Try to read a Prolog term form an arbitrary location inside a file.
requires_library/2	known expansion hooks.
valid_term_position/2	Check that a Term has an appropriate TermPos layout.
prolog_stack.pl
backtrace/1	Get and print a stacktrace to the user_error stream.
get_prolog_backtrace/2	Obtain a backtrace from the current location.
get_prolog_backtrace/3	Obtain a backtrace from the current location.
print_last_choicepoint/0	Print details on the last open choice point.
print_last_choicepoint/2
print_prolog_backtrace/2	Print a stacktrace in human readable form to Stream.
print_prolog_backtrace/3	Print a stacktrace in human readable form to Stream.
prolog_stack_frame_property/2	True when Property is a property of Frame.
stack_guard/1	Dynamic multifile hook that is normally not defined.
stack_guard/1	Dynamic multifile predicate.
prolog_trace.pl
list_tracing/0	List predicates we are currently tracing.
notraceall/0	Remove all trace points.
trace/1	Print passes through ports of specified predicates.
trace/2	Print passes through ports of specified predicates.
tracing/2	True if Spec is traced using Ports.
prolog_versions.pl  -- Demand specific (Prolog) versions
cmp_versions/3	Compare to versions.
require_prolog_version/2	Claim that the running Prolog version is at least version Required and provides the requested Features.
require_version/3	Require Component to have version CmpRequired, while Component is know to have version Available.
prolog_wrap.pl  -- Wrapping predicates
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  -- Define Quasi Quotation syntax
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
rwlocks.pl  -- Read/write locks
sandbox.pl
settings.pl  -- Setting management
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
call_time/2	Call Goal as call/1, unifying Time with a dict that provides information on the resource usage.
call_time/3	Call Goal as call/1, unifying Time with a dict that provides information on the resource usage.
statistics/0	Print information about resource usage using print_message/2.
statistics/1	Stats is a dict representing the same information as statistics/0.
thread_statistics/2	Obtain statistical information about a single thread.
time/1	Execute Goal, reporting statistics to the user.
streams.pl  -- Manage Prolog streams
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  -- Term manipulation
thread.pl  -- High level thread primitives
thread_pool.pl  -- Resource bounded thread management
threadutil.pl  -- Interactive thread utilities
attach_console/0	Create a new console and make the standard Prolog streams point to it.
attach_console/1	Create a new console and make the standard Prolog streams point to it.
join_threads/0	Join all terminated threads.
tbacktrace/1	Print a backtrace for Thread to the stream user_error of the calling thread.
tbacktrace/2	Print a backtrace for Thread to the stream user_error of the calling thread.
tdebug/0	Enable debug-mode, trapping the graphical debugger on reaching spy-points or errors.
tdebug/1	Enable debug-mode, trapping the graphical debugger on reaching spy-points or errors.
thread_has_console/0	True when the calling thread has an attached console.
threads/0	List currently known threads with their status.
tnodebug/0	Disable debug-mode in all threads or the specified Thread.
tnodebug/1	Disable debug-mode in all threads or the specified Thread.
tprofile/1	Profile the operation of Thread until the user hits a key.
tspy/1	Trap the graphical debugger on reaching Spec in the specified or any thread.
tspy/2	Trap the graphical debugger on reaching Spec in the specified or any thread.
with_stopped_threads/2	Stop all threads except the caller while running once(Goal).
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  -- Utilities for numbered terms
wfs.pl  -- Well Founded Semantics interface
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
with_zipper/2	Run Goal while holding ownership over Zipper.
zip_close/1	Close a zipper.
zip_close/2	Close a zipper.
zip_open/4	Create a Zipper, providing access to File.
zipper_file_info/3	Obtain information about the current zip entry.
zipper_goto/2	Seek Zipper to a specified entry.
zipper_members/2	True when Members is the list of file names in the Zipper.
zipper_open_current/3	Open the current entry as an input stream.