Module builtins

True if X and Y can be unified. This is the most basic operation of Prolog. Unification also happens when doing head matching in a rule.

Always true.

Always false.

Execute the Goal. Typically used when the Goal is not known at compile time.

Execute the Goal with ExtraArg1 appended to the argument list. For example:

?- call(format("_sn"), ["Alain Colmerauer"]). Alain Colmerauer true.

Which is equivalent to: format("~s~n", ["Alain Colmerauer"]).

Execute Goal with ExtraArg1 and ExtraArg2 appended to the argument list.

Execute Goal with ExtraArg1, ExtraArg2 and ExtraArg3 appended to the argument list.

Execute Goal with ExtraArg1, ExtraArg2, ExtraArg3 and ExtraArg4 appended to the argument list.

Execute Goal with ExtraArg1, ExtraArg2, ExtraArg3, ExtraArg4 and ExtraArg5 appended to the argument list.

Execute Goal with ExtraArg1, ExtraArg2, ExtraArg3, ExtraArg4, ExtraArg5 and ExtraArg6 appended to the argument list.

Execute Goal with ExtraArg1, ExtraArg2, ExtraArg3, ExtraArg4, ExtraArg5, ExtraArg6 and ExtraArg7 appended to the argument list.

Execute Goal with ExtraArg1, ExtraArg2, ExtraArg3, ExtraArg4, ExtraArg5, ExtraArg6, ExtraArg7 and ExtraArg8, appended to the argument list.

True iff Flag is a flag supported by the processor, and Value is the value currently associated with it. A flag is a setting which value affects internal operation of the Prolog system. Some flags are read-only, while others can be set with set_prolog_flag/2.

The flags that Scryer Prolog support are:

• max_arity: The max arity a predicate can have in Prolog. On Scryer is set to 1023. Read only.
• bounded: true if integer arithmethic is bounded between some min/max values. On Scryer is always set to false since it supports unbounded integer arithmethic. Read only.
• integer_rounding_function: Describes the rounding donde by // and rem functions. On Scryer is always set to toward_zero. Read only
• double_quotes: Determines how double quoted strings are read by Prolog. Scryer uses chars by default which is a list of one-character atoms. Other values are codes (list of integers representing characters), and atom which creates a whole atom for the string value. Read and write.
• max_integer: Maximum integer supported by the system. As Scryer Prolog has unbounded integer arithmethic, checking the value of this flag fails. Read only.
• min_integer: Minimum integer supported by the system. As Scryer Prolog has unbounded integer arithmethic, checking the value of this flag fails. Read only.
• occurs_check: Returns if the occurs check is enabled. The occurs check prevents the creation cyclic terms. Historically the Prolog unification algorithm didn't do that check so changing the value modifies how Prolog operates in the low-level. Possible values are false (default), true (unification has this check enabled) and error which throws an exception when a cylic term is created. Read and write.
• unknown: How undefined predicates are handled when called. Possible values are error (the default, an error is thrown), fail (the call silently fails) and warn (the call fails and a warning about the undefined predicate is printed).
• answer_write_options: Additional write options used by the top level for writing answers.

Sets the internal value of the flag. To see the list of flags supported by Scryer Prolog, check current_prolog_flag/2. The flags that are read only will fail if you try to change their values

A predicate that always fails. The more declarative false/0 should be used instead.

True iff Goal fails

True iff X and Y can't be unified

Execute Goal (like call/1) but exactly once, ignoring any kind of alternative solutions the original predicate could have generated.

This predicate succeeds arbitrarily often, generating choice points with that.

If-then and if-then-else constructs

Disjunction (or)

Cut operator. Discards the choicepoints created since entering the prediacate in which the operator appears. Using cut is not recommended as it introduces a non-declarative flow of programming and makes it more difficult to reason about the programs. Also restricts the ability to run the program with alternative execution strategies

Conjuction (and)

Univ operator. True iff Term is a term whose functor is the head of the List, and the rest of arguments of Term are in tail of the List. Example:

?- f(a, X) =.. List. List = [f,a,X].

Write Term to the current output stream according to some output syntax options. Options are specified in detail in write_term/3.

Write Term to the stream Stream according to some output syntax options. The options available are:

• ignore_ops(+Boolean) if true, the generic term representation is used everywhere. In false (default), operators do not use that generic term representation.
• max_depth(+N) if the term is nested deeper than N, print the reminder as ellipses. If N = 0 (default), there's no limit.
• numbervars(+Boolean) if true, replaces $VAR(N) variables with letters, in order. Default is false.
• quoted(+Boolean) if true, strings and atoms that need quotes to be valid Prolog syntax, are quoted. Default is false.
• variable_names(+List) assign names to variables in term. List should be a list of terms of format Name=Var.
• double_quotes(+Boolean) if true, strings are printed in double quotes rather than with list notation. Default is false.

Write Term to the current output stream using a syntax similar to Prolog

Write Term to the stream Stream using a syntax similar to Prolog

Write Term to the current output stream using canonical Prolog syntax. Can be read back as Prolog terms.

Write Term to the stream Stream using canonical Prolog syntax. Can be read back as Prolog terms.

Write Term to the current output stream using a syntax similar to write/1 but quoting the atoms that need to be quoted according to Prolog syntax.

Write Term to the stream Stream using a syntax similar to write/1 but quoting the atoms that need to be quoted according to Prolog syntax.

Read Term from the stream Stream. It supports several options: * variables(-Vars) unifies Vars with a list of variables in the term. Similar to do term_variables/2 with the new term. * variable_names(-Vars) unifies Vars with a list Name=Var with Name describing the variable name and Var the variable itself that appears in Term. * singletons similar to variable_names but only reports variables occurring only once in Term.

Read Term from the current input stream. It supports several options described in more detail in read_term/3.

Read Term from the current input stream with default options. *NOTE* This is not a general predicate to read input from a file or the user. Use other predicates like phrase_from_file/2 for that.

Same as read_term/3 with all default options.

True iff given a Term, Vars is a list of all the unique variables that appear in Term. The variables are sorted depth-first and left-to-right.

?- term_variables(f(X, Y, X, g(Z)), Vars). Vars = [X, Y, Z].

Calls Goal, but if it throws an exception that unifies with Catcher, Recover will be called instead and the program will be resumed. Example:

?- catch(number_chars(X, "not_a_number"), error(syntax_error(_), _), X = 0).
   X = 0.

Raise the exception Exception. The system looks for the innermost catch/3 for which Exception unifies with Catcher. Example:

?- throw(custom_error(42)).
   throw(custom_error(42)).
?- catch(throw(custom_error(42)), custom_error(_), true).
   true.

Unify Solutions with a list of all values that variables in Template can take in Goal. findall/3 is equivalent to bagof/3 with all free variables scoped to the Goal (^ operator) except that bagof/3 fails when no solutions are found and findall/3 unifies with an empty list. Example:

f(1,2).
f(1,3).
f(1,4).
?- findall(X-Y, f(X, Y), Solutions).
   Solutions = [1-2,1-3,1-4].

Similar to findall/3 but returns the solutions as the difference list Solutions0-Solutions1.

Unify Solution with a list of alternatives of the variables in Template coming from calling Goal. If Goal has no solutions, the predicate fails. If free variables that are not in Template appear in Goal, the predicate will backtrack over the alternatives of those free variables. However, you can use the syntax Var^Goal to not bind Var in Goal and prevent that.

Example:

f(1, 3).
f(2, 4).
?- bagof(X, f(X, Y), Bag).
   Y = 3, Bag = [1],
;  Y = 4, Bag = [2].
?- bagof(X, Y^f(X, Y), Bag).
   Bag = [1,2].

Similar to bagof/3 but Solution is sorted and duplicates are removed. Example:

f(1, 2).
f(1, 3).
f(2, 4).
?- setof(X, Y^f(X, Y), Set).
   Set = [1, 2].

True iff Head can be unified with a clause head and Body with its corresponding clause body.

Asserts (inserts) a new clause (rule or fact) into the current module. The clause will be inserted at the beginning of the module.

Asserts (inserts) a new clause (rule or fact) into the current module. The clase will be inserted at the end of the module.

Retracts (deletes) a clause present in the current module. It only affects dynamic predicates.

Retracts (deletes) all clauses that unify which head unifies with Head It only affects dynamic predicates.

Pred should satisfy: Pred = Name/Arity. Deletes all clauses of a predicate with name Name and arity Arity. It only affects dynamic predicates

Pred must satisfy: Pred = Name/Arity. True iff there's a predicate Pred that is currently loaded at the moment. It can be used to check for existence of a predicate or to enumerate all loaded predicates

True iff there's an operator defined with name Op, with spec Spec and priority Priority. Can be used to find all operators currently defined.

Declares an operated named Op, with priority Priority and a spec Spec. The priority is an integer between 0 (null) and 1200. Spec can be: xf, yf, xfx, xfy, yfx, fy and fx where f indicates the position of the operator and x and y the arguments.

Exits the Prolog system with exit code 0

Exits the Prolog system with exit code N

True iff Atom is an atom of Length characters. Example:

?- atom_length(marseille, N).
   N = 9.

Relates an atom with a string in chars representation. It can be used to convert between atoms and strings. Examples:

?- atom_chars(marseille, X).
   X = "marseille".
?- atom_chars(X, "marseille").
   X = marseille.

Relates an atom with a string in codes representation. It can be used to convert between atoms and strings. However, codes is not the default representation of double quoutes strings in Scryer Prolog. Examples:

?- atom_codes(marseille, X).
   X = [109,97,114,115,101,105,108,108,101].
?- atom_codes(X, [109,97,114,115,101,105,108,108,101]).
   X = marseille.

Similar to append/3 but operating on atom characters. If you find yourself using this predicate, consider using strings instead. Example:

?- atom_concat(a, X, ab).
   X = b.

Relates an atom to a subatom inside with some key properties:

• SubAtom starts at Before characters (0-based) from Atom

• SubAtom has Length characters

• After SubAtom there are After characters in Atom

If you find yourself using this predicate, consider using strings. Example:

?- sub_atom(abcdefg, 2, 3, X, SubAtom).
   X = 2, SubAtom = cde.

Relates a Char to its Code (an integer). Example:

?- char_code(a, X).
   X = 97.

From the current input stream, unify Char with the next character. When there are no more characters to read, Char unifies with end_of_file.

From the stream Stream, unify Char with the next character. When there are no more characters to read, Char unifies with end_of_file.

Relates a number and its representation as list of chars (string). Throws an error if Chars is not the representation of a number. Examples:

?- number_chars(42, X).
   X = "42".
?- number_chars(X, "42").
   X = 42.
?- number_chars(X, "not_a_number").
   error(syntax_error(cannot_parse_big_int),number_chars/2:0).

Relates a number and its representation as list of codes. Throws an error if Codes is not the representation of a number. Examples:

?- number_codes(42, X).
   X = [52,50].
?- number_codes(X, [52,50]).
   X = 42.
?- number_codes(X, [65]).
   error(syntax_error(cannot_parse_big_int),number_codes/2:0).

True iff General can be made equivalent to Specific by only binding variables in Generic. The implementation unifies with occurs check always and ensures that the variables of Specific did not change. Some examples:

?- subsumes_term(f(A, A), f(2, 2)).
   true.
?- subsumes_term(f(A, 2), f(2, A)).
   false.

True iff X and Y unify with occurs check. The occurs check prevents the creation cyclic terms but is computationally more expensive. The (=)/2 operator can also do occurs check if enabled via set_prolog_flag/2. Example:

?- A = f(A).
   A = f(A).
?- unify_with_occurs_check(A, f(A)).
   false.

Unifies with the current input stream.

Unifies with the current output stream.

Sets the current input stream to Stream.

Sets the current output stream to Stream.

Equivalent to open(File, Mode, Stream, []).

Opens a file named File with a Mode and StreamOptions, and returns a Stream that can be used by other predicates to read and write (depending on Mode).

Mode can be: read, write or append. read creates a Stream that is read-only, write is write-only and append is write-only but at the end of the file.

The following options are available:

• alias(+Alias): Set an alias to the stream

• eof_action(+Action): Defined what happens if the end of the stream is reached. Values: error, eof_code and reset.

• reposition(+Boolean): Specifies whether repositioning is required for the stream. false is the default.

• type(+Type): Type can be text or binary. Defines the type of the stream, if it's optimized for plain text or just binary

Example:

?- open("README.md", read, S, []), get_n_chars(S, 20, C).
   S = '$stream'(0x55dece980218), C = "\n# Scryer Prolog\n\nS ..."

Closes a stream. It takes a CloseOptions list. The only option available is force which takes a true or false.

Closes a stream. Equivalent to close(Stream, [])..

Flushes the output of the stream Stream

Flushes the output of the current output stream

From the stream Stream, unify Byte with the next byte (an integer between 0 and 255) When there are no more bytes to read, Byte unifies with -1.

From the current input stream, unify Byte with the next byte (an integer between 0 and 255) When there are no more bytes to read, Byte unifies with -1.

Writes to the current output stream the character Char.

Writes to the stream Stream the character Char.

Writes to the current output stream the byte Byte (should be an integer between 0 and 255).

Writes to the stream Stream the byte Byte (should be an integer between 0 and 255).

Writes to the current output stream the character represented by code Code

Writes to the stream Stream the character represented by code Code

From the current input stream, unify Code with the character code of the next character. When there are no more characters to read, Code unifies with -1.

From the stream Stream, unify Code with the character code of the next character. When there are no more characters to read, Code unifies with -1.

From the stream Stream, unify Byte with the next byte. However, it doesn't move the stream position, allowing it to be read again.

From the current input stream, unify Byte with the next byte. However, it doesn't move the stream position, allowing it to be read again.

From the current input stream, unify Code with the character code of the next character. However, it doesn't move the stream position, allowing it to be read again.

From the stream Stream, unify Code with the character code of the next character. However, it doesn't move the stream position, allowing it to be read again.

From the current input stream, unify Char with the next character. However, it doesn't move the stream position, allowing it to be read again.

From the stream Stream, unify Char with the next character. However, it doesn't move the stream position, allowing it to be read again.

For stream Stream, StreamProperty is a property that applies to that stream. StreamProperty can be one of the following:

• input if stream is an input stream.
• output if stream is an output stream.
• input_output if stream is both an input and an output stream.
• alias(-Alias) if the stream has an associated alias.
• file_name(-FileName) if Stream is associated to a file, unifies with the name of the file
• mode(-Mode): Mode unifies with the mode of the stream: read, write or append.
• position(position_and_lines_read(P, L)) current position of the stream.
• end_of_stream(-X) where X can be not, at or past depending if the stream has ended or not.
• eof_action(-X) where X can be error, eof_code or reset depending on the action that will happen on the end of the file.
• reposition(-Boolean) specifies if reposition has been enabled for this stream.
• type(-Type) where Type can be text or binary.

True iff the stream Stream has ended

True iff the current input stream has ended

Sets the current position of the stream Stream to Position.

True iff X is bound to an atom or a compound term.

Writes a new line character to the current output stream.

Writes a new line character to the stream Stream.

Throws an exception of the following structure: error(ErrorTerm, ImpDef).