eyeprolog 1.1.19 → 1.1.21

package/conformance-report.md

@@ -11,7 +11,7 @@ This report summarizes the file-based conformance corpus under `test/conformance
 | builtins | 11 | 0 | 0 | 0 | 11 |
 | context | 11 | 0 | 0 | 0 | 11 |
 | control | 15 | 0 | 0 | 0 | 15 |
-| iso | 164 | 209 | 0 | 0 | 373 |
+| iso | 165 | 209 | 0 | 0 | 374 |
 | lists | 52 | 3 | 0 | 0 | 55 |
 | modules | 2 | 0 | 0 | 0 | 2 |
 | negation | 8 | 0 | 19 | 0 | 27 |
@@ -23,4 +23,4 @@ This report summarizes the file-based conformance corpus under `test/conformance
 | terms | 26 | 3 | 0 | 0 | 29 |
 | unification | 18 | 0 | 0 | 0 | 18 |
 | variables | 16 | 9 | 0 | 0 | 25 |
-| **Total** | **479** | **260** | **19** | **21** | **779** |
+| **Total** | **480** | **260** | **19** | **21** | **780** |

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "EyeProlog turns facts and rules into answers and proofs.",
   "type": "module",
   "main": "./index.js",

package/src/iso.js

@@ -48,7 +48,7 @@ export const isoBuiltins = {
     registry.add('!', 0, succeed, { deterministic: true });
 
     registry.add('=', 2, unification, { deterministic: true });
-    registry.add('unify_with_occurs_check', 2, unification, { deterministic: true });
+    registry.add('unify_with_occurs_check', 2, unificationWithOccursCheck, { deterministic: true });
     registry.add('\\=', 2, nonUnification, { deterministic: true });
     registry.add('subsumes_term', 2, subsumesTermBuiltin, { deterministic: true });
     registry.add('==', 2, identity, { deterministic: true });
@@ -178,6 +178,14 @@ function* unification({ goal, env }) {
   const next = env.clone();
   if (unify(goal.args[0], goal.args[1], next)) yield next;
 }
+function* unificationWithOccursCheck({ goal, env }) {
+  const next = env.clone();
+  // ISO unify_with_occurs_check/2 always performs finite-tree unification.
+  // The implementation-specific occurs_check=error mode applies to normal
+  // unification, but must not turn this ISO predicate's ordinary failure into
+  // an exception.
+  if (unify(goal.args[0], goal.args[1], next, { occursCheck: 'fail' })) yield next;
+}
 function* nonUnification({ goal, env }) {
   if (!unify(goal.args[0], goal.args[1], env.clone())) yield env;
 }
@@ -1776,6 +1784,7 @@ function* phraseBuiltin({ solver, goal, env }) {
   }
 }
 function formalErrorTerm(error) {
+  if (error.formalTerm != null) return compound('error', [error.formalTerm, atom('eyeprolog')]);
   const parse = (text) => {
     const open = text.indexOf('(');
     if (open === -1) return atom(text);
@@ -1814,7 +1823,7 @@ function* catchBuiltin({ solver, goal, env }) {
     const ball = error instanceof ThrownTerm
       ? error.term
       : error instanceof PrologError
-        ? formalErrorTerm(error)
+        ? freshCopy(formalErrorTerm(error), new Env())
         : null;
     if (ball == null) throw error;
     const recovered = env.clone();
@@ -1827,7 +1836,9 @@ function* catchBuiltin({ solver, goal, env }) {
 function* throwBuiltin({ goal, env }) {
   const ball = deref(goal.args[0], env);
   if (ball.type === VAR) throw new PrologError('instantiation_error');
-  throw new ThrownTerm(copyResolved(ball, env));
+  // ISO throw/1 copies the thrown term before control unwinds. Freshen
+  // variables so the catcher cannot retain aliases to the protected goal.
+  throw new ThrownTerm(freshCopy(ball, env));
 }
 function* onceBuiltin({ solver, goal, env }) {
   const child = solver.cloneForInnerGoal(1);

package/src/repl.js

@@ -57,7 +57,7 @@ export async function runRepl(engine, options = {}) {
           exitCode = error.code;
           break;
         }
-        output.write(`   ${formatError(error)}\n`);
+        output.write(`   ${formatError(engine, state, error)}\n`);
       }
     }
   } catch (error) {
@@ -368,13 +368,15 @@ function queryVariables(goal) {
 
 function formatAnswer(engine, state, variables, env) {
   const bindings = [];
+  const queryVariableNames = new Set(variables.map((variable) => variable.name));
   const names = new Map(variables.map((variable) => [variable.name, variable.name]));
   let generated = 0;
 
   for (const variable of variables) collectUnboundVariables(engine, variable, env, names, () => `_${letterName(generated++)}`);
   for (const variable of variables) {
     const value = engine.deref(variable, env);
-    if (value.type === 'var' && value.name === variable.name) continue;
+    if (value.type === 'var' &&
+        (value.name === variable.name || !queryVariableNames.has(value.name))) continue;
     bindings.push(`${variable.name} = ${engine.formatTermForWrite(value, env, {
       quoted: true,
       operators: [...state.program.operators.values()],
@@ -406,7 +408,30 @@ function letterName(index) {
   return suffix === 0 ? letter : `${letter}${suffix}`;
 }
 
-function formatError(error) {
+function formatError(engine, state, error) {
+  if (error?.name === 'PrologError') {
+    const env = new engine.Env();
+    const variableNames = new Map();
+    let generated = 0;
+    if (error.formalTerm != null) {
+      collectUnboundVariables(engine, error.formalTerm, env, variableNames, () => `_${letterName(generated++)}`);
+      const formal = engine.formatTermForWrite(error.formalTerm, env, {
+        quoted: true,
+        operators: [...state.program.operators.values()],
+        variableNames,
+      });
+      return `error(${formal}).`;
+    }
+    if (error.culprit != null) {
+      collectUnboundVariables(engine, error.culprit, env, variableNames, () => `_${letterName(generated++)}`);
+    }
+    const culprit = error.culprit == null ? '' : `, ${engine.formatTermForWrite(error.culprit, env, {
+      quoted: true,
+      operators: [...state.program.operators.values()],
+      variableNames,
+    })}`;
+    return `error(${error.formal}${culprit}).`;
+  }
   const message = error?.message ?? String(error);
   return message.endsWith('.') ? message : `${message}.`;
 }

package/src/solver.js

@@ -23,6 +23,12 @@ export function nextFreshId() {
   return ++freshCounter;
 }
 
+function raiseOccursCheckError(left, right, env) {
+  const error = new PrologError('occurs_check');
+  error.formalTerm = copyResolved(compound('occurs_check', [left, right]), env);
+  throw error;
+}
+
 export class Solver {
   constructor(program, options = {}) {
     this.registry = options.registry ?? getEyePrologRegistry();
@@ -37,6 +43,11 @@ export class Solver {
     this.solutionLimit = options.solutionLimit ?? 10000000;
     this.solutionsSeen = 0;
     this.prologFlags = options.prologFlags ?? defaultPrologFlags(this.registry?.eyePrologLibrary ? 'fail' : 'error');
+    this.occursCheckHandler = (left, right, env) => {
+      if (this.prologFlags.get('occurs_check')?.value?.name === 'error') {
+        raiseOccursCheckError(left, right, env);
+      }
+    };
     this.charConversions = options.charConversions ?? new Map();
     if (!options.prologFlags) {
       if (['chars', 'codes', 'atom'].includes(program.doubleQuotes)) {
@@ -140,6 +151,7 @@ export class Solver {
 
   *solve(goals, env = new Env(), depth = 0) {
     if (!Array.isArray(goals)) goals = [goals];
+    env.setOccursCheckHandler(this.occursCheckHandler);
 
     const savedActive = this.active;
     let registeredStack = null;
@@ -194,6 +206,7 @@ export class Solver {
 
       goals = frame.goals;
       env = frame.env;
+      env.setOccursCheckHandler(this.occursCheckHandler);
       depth = frame.depth;
       let active = frame.active;
 
@@ -474,6 +487,7 @@ function defaultPrologFlags(unknown = 'error') {
     ['max_arity', { value: compound('unbounded', []), allowed: ['unbounded'], changeable: false }],
     ['unknown', { value: compound(unknown, []), allowed: ['error', 'fail', 'warning'], changeable: true }],
     ['double_quotes', { value: compound('chars', []), allowed: ['chars', 'codes', 'atom'], changeable: true }],
+    ['occurs_check', { value: compound('true', []), allowed: ['true', 'error'], changeable: true }],
   ]);
 }
 

package/src/term.js

@@ -47,6 +47,7 @@ export class Env {
     };
     this._delays = null;
     this._clpz = null;
+    this._occursCheckHandler = null;
   }
   clone() {
     // Most speculative environments are either rejected without a binding or
@@ -58,8 +59,13 @@ export class Env {
     clone._state = this._state;
     clone._delays = this._delays;
     clone._clpz = this._clpz;
+    clone._occursCheckHandler = this._occursCheckHandler;
     return clone;
   }
+  setOccursCheckHandler(handler) {
+    this._occursCheckHandler = typeof handler === 'function' ? handler : null;
+    return this;
+  }
   has(name) {
     return this.get(name) !== undefined;
   }
@@ -207,11 +213,12 @@ function occurs(variableName, term, env) {
   return false;
 }
 
-export function unify(left, right, env) {
+export function unify(left, right, env, options = {}) {
   // Iterative unification avoids deep JavaScript recursion on long lists or
   // deeply nested compounds. The occurs check gives EyeProlog finite-tree
   // unification: a variable cannot be bound to a term containing itself.
   // Bindings are written into the supplied Env.
+  const occursCheckHandler = options.occursCheck === 'fail' ? null : env?._occursCheckHandler;
   const stack = [[left, right]];
   while (stack.length) {
     let [a, b] = stack.pop();
@@ -226,12 +233,18 @@ export function unify(left, right, env) {
       continue;
     }
     if (a.type === VAR) {
-      if (occurs(a.name, b, env)) return false;
+      if (occurs(a.name, b, env)) {
+        occursCheckHandler?.(a, b, env);
+        return false;
+      }
       env.bind(a.name, b);
       continue;
     }
     if (b.type === VAR) {
-      if (occurs(b.name, a, env)) return false;
+      if (occurs(b.name, a, env)) {
+        occursCheckHandler?.(b, a, env);
+        return false;
+      }
       env.bind(b.name, a);
       continue;
     }

package/test/conformance/ISO-MATRIX.md

@@ -9,7 +9,7 @@ case totals.
 | --- | --- | --- |
 | Clause 6 lexical and term syntax | tokenizer, operator parser, lists, curly terms, quotes, numeric syntax, comments | `scryer_lexical_terms`, `lexical_and_curly_terms`, `double_quoted_lists`, `corrigendum1_double_quote_operator`, syntax error cases |
 | Clause 7 term order and unification | finite-tree unification, identity, standard order, errors | `unification_control_information`, `swipl_occurs_check`, `term_modes_and_ordering`, `logtalk_compare_standard_order` |
-| Clause 7 control and exceptions | call, cut, conjunction, disjunction, if-then-else, catch and throw | `cut_control`, `control_and_terms`, `exceptions_and_flags`, `corrigenda_catch_callability` |
+| Clause 7 control and exceptions | call, cut, conjunction, disjunction, if-then-else, catch and throw | `cut_control`, `control_and_terms`, `exceptions_and_flags`, `corrigenda_catch_callability`, `throw_copies_ball` |
 | 8.2-8.5 term predicates | unification, Corrigendum 2 tests, comparison, sorting, creation and decomposition | `corrigenda_term_predicates`, `corrigenda_sort_keysort`, `logtalk_arg_unification`, `logtalk_univ`, associated error cases |
 | 8.6-8.7 arithmetic predicates | `is/2` and all six arithmetic comparisons | `arithmetic`, comparison cases, isolated evaluation errors |
 | 8.8-8.10 database and solutions | logical update view, dynamic mutation, all-solutions grouping | `dynamic_database`, `trealla_logical_update_view`, `corrigenda_retractall`, `grouped_solutions_and_clauses` |

package/test/conformance/README.md

@@ -94,7 +94,7 @@ Selected cases are adapted from the ISO and standard-core suites of Logtalk,
 Scryer Prolog, Trealla Prolog, and SWI-Prolog. Their upstream identifiers and licenses
 are recorded in [THIRD_PARTY.md](THIRD_PARTY.md).
 
-The corpus has 373 cases in `iso/` and 779 file-based conformance cases in
+The corpus has 374 cases in `iso/` and 780 file-based conformance cases in
 total. The generated `conformance-report.md` is the authoritative source for
 current category totals. Together with regression, documentation-sync, API,
 example, and book-example checks, `npm test` is the release gate.

package/test/conformance/cases/iso/throw_copies_ball.pl

@@ -0,0 +1,17 @@
+% ISO 7.12.1: throw/1 copies the ball before searching for a catcher.
+%% goal: user_throw_copy
+%% goal: error_throw_copy
+
+user_throw_copy :-
+    catch(throw(g(X)), g(V), true),
+    X = protected,
+    V = caught.
+
+error_throw_copy :-
+    catch(
+        number_chars(_, [1, [], X|2]),
+        error(type_error(list, Culprit), _),
+        true
+    ),
+    X = protected,
+    Culprit = [1, [], caught|2].

package/test/conformance/expected/iso/exceptions_and_flags.pl

@@ -1,3 +1,3 @@
 answer(7, red, caught(eyeprolog), first, caught(eyeprolog)).
 answer(7, red, caught(eyeprolog), second, caught(eyeprolog)).
-flags(off, on, [pair(bounded, false), pair(integer_rounding_function, toward_zero), pair(char_conversion, on), pair(debug, off), pair(max_integer, unbounded), pair(min_integer, unbounded), pair(max_arity, unbounded), pair(unknown, fail), pair(double_quotes, chars)]).
+flags(off, on, [pair(bounded, false), pair(integer_rounding_function, toward_zero), pair(char_conversion, on), pair(debug, off), pair(max_integer, unbounded), pair(min_integer, unbounded), pair(max_arity, unbounded), pair(unknown, fail), pair(double_quotes, chars), pair(occurs_check, true)]).

package/test/conformance/expected/iso/throw_copies_ball.pl

@@ -0,0 +1,2 @@
+user_throw_copy.
+error_throw_copy.

package/test/run-regression.mjs

@@ -496,6 +496,66 @@ c4 ?- call((!;1)).
         assertEqual(result.stderr, '', 'stderr');
       },
     },
+    {
+      name: 'REPL hides aliases to fresh throw variables while preserving query aliases',
+      run: () => {
+        const result = runCli([], {
+          input: 'catch(throw(g(X)),g(V),true).\nX = Y.\nhalt.\n',
+        });
+        assertEqual(result.status, 0, 'exit status');
+        assertEqual(result.stdout, '?-    true.\n?-    X = Y.\n?- ', 'stdout');
+        assertEqual(result.stderr, '', 'stderr');
+      },
+    },
+    {
+      name: 'REPL freshens variables displayed in uncaught ISO errors',
+      run: () => {
+        const result = runCli([], {
+          input: 'number_chars(V,[1,[],X|2]).\nnumber_chars(V,[1,[],Xx|2]).\nhalt.\n',
+        });
+        assertEqual(result.status, 0, 'exit status');
+        assertEqual(result.stdout,
+          '?-    error(type_error(list), [1, [], _A | 2]).\n' +
+          '?-    error(type_error(list), [1, [], _A | 2]).\n' +
+          '?- ',
+          'stdout');
+        assertEqual(result.stderr, '', 'stderr');
+      },
+    },
+    {
+      name: 'occurs_check error mode detects STO while ISO occurs-check unification still fails',
+      run: () => {
+        const filename = path.join(tmp, `occurs-check-${++tmpCounter}.pl`);
+        fs.writeFileSync(filename, ':- set_prolog_flag(occurs_check, error).\nsame(X, X).\n');
+        const result = runCli([], {
+          input:
+            'current_prolog_flag(occurs_check, Mode).\n' +
+            'set_prolog_flag(occurs_check, error).\n' +
+            'X = f(X).\n' +
+            'catch((Y = g(Y)), E, true).\n' +
+            'unify_with_occurs_check(Z, h(Z)).\n' +
+            `[${sourceAtom(filename)}].\n` +
+            'same(W, k(W)).\n' +
+            'set_prolog_flag(occurs_check, true).\n' +
+            'Q = q(Q).\n' +
+            'halt.\n',
+        });
+        assertEqual(result.status, 0, 'exit status');
+        assertEqual(result.stdout,
+          '?-    Mode = true.\n' +
+          '?-    true.\n' +
+          '?-    error(occurs_check(_A, f(_A))).\n' +
+          '?-    E = error(occurs_check(_A, g(_A)), eyeprolog).\n' +
+          '?-    false.\n' +
+          '?-    true.\n' +
+          '?-    error(occurs_check(_A, k(_A))).\n' +
+          '?-    true.\n' +
+          '?-    false.\n' +
+          '?- ',
+          'stdout');
+        assertEqual(result.stderr, '', 'stderr');
+      },
+    },
     {
       name: 'REPL enumerates and stops answers like the Scryer top level',
       run: () => {

package/the-art-of-eyeprolog.md

@@ -780,6 +780,27 @@ fails rather than constructing a cyclic term:
 (X = wrapper(X)).
 ```
 
+ISO classifies unifications whose outcome depends on an occurs check as
+subject-to-occurs-check (STO). EyeProlog's default remains the sound finite-tree
+behavior above. For diagnosis, EyeProlog additionally provides the
+implementation-specific flag `occurs_check`; setting it to `error` turns a
+normal unification that would otherwise fail because of the occurs check into
+an exception:
+
+```eyeprolog
+:- set_prolog_flag(occurs_check, error).
+
+sto_example :- X = wrapper(X).
+% error(occurs_check(_A, wrapper(_A)))
+```
+
+The supported values are `true` (the default finite-tree behavior) and `error`
+(STO detection). EyeProlog deliberately does not provide `occurs_check=false`,
+because its term model does not construct cyclic terms. The ISO predicate
+`unify_with_occurs_check/2` is independent of the diagnostic flag: it continues
+to perform finite-tree unification and fails on `unify_with_occurs_check(X,
+wrapper(X))` even when `occurs_check` is `error`.
+
 ### Meaning is not the search strategy
 
 EyeProlog's evaluator is goal-directed. It resolves selected goals against facts,
@@ -5610,11 +5631,14 @@ silently changing a static program.
 | `max_arity` | `unbounded` | `unbounded` | no |
 | `unknown` | `fail` | `error`, `fail`, `warning` | yes |
 | `double_quotes` | `chars` | `chars`, `codes`, `atom` | yes |
+| `occurs_check` | `true` | `true`, `error` | yes |
 
 The isolated ISO-only registry defaults `unknown` to `error`; the normal
-EyeProlog environment defaults it to `fail`. Operator and flag
-directives are processed per program rather than changing global JavaScript
-state. The `double_quotes` setting affects subsequent source text, included
+EyeProlog environment defaults it to `fail`. The `occurs_check` flag is an
+EyeProlog diagnostic extension rather than an ISO-defined core flag; its
+`true` default preserves the engine's finite-tree unification, while `error`
+reports STO attempts. Operator and flag directives are processed per program
+rather than changing global JavaScript state. The `double_quotes` setting affects subsequent source text, included
 files, command-line and API goal text, and terms read by `read_term/*`:
 
 ```text
@@ -5749,8 +5773,14 @@ instances whose message contains the corresponding Prolog error term.
 | *syntax_error(number)*, *syntax_error(read_term)* | Lexical number conversion or streamed term parsing failed. |
 
 `catch/3` converts a `PrologError` into a catchable
-`error(Formal,eyeprolog)` term. A user ball from `throw/1` is delivered as-is.
-An unmatched ball or error continues outward.
+`error(Formal,eyeprolog)` term. `throw/1` copies its ball before unwinding: bound
+parts are preserved, repeated variables remain shared within the copied ball,
+and unbound variables are fresh with respect to the protected goal and catcher.
+Catchable error terms follow the same variable-freshening rule. At the interactive
+top level, variables that occur in an uncaught ISO error are rendered with fresh
+answer names such as `_A` rather than reusing query-variable spellings such as
+`X` or `Xx`; this keeps the displayed error consistent with the copied exception
+term. An unmatched ball or error continues outward.
 
 Streams belong to one solver run and are shared by nested calls, exceptions,
 and solution collectors. `user_input` and `user_output` are always present.
@@ -6815,7 +6845,7 @@ node test/run-conformance-report.mjs
 ```
 
 The complete suite must pass before release. The file-based conformance corpus
-contains 779 cases, including 373 focused ISO
+contains 780 cases, including 374 focused ISO
 cases derived from the success, failure, mode, and error behavior in
 ISO/IEC 13211-1 clauses 7 and 8, Part 2 modules, and Part 3 grammar rules.
 Separate exact-output suites check 189 normal