aontu 0.30.1 → 0.31.0

package/src/val/RefVal.ts

@@ -0,0 +1,436 @@
+/* Copyright (c) 2021-2025 Richard Rodger, MIT License */
+
+
+import Util from 'node:util'
+
+import {
+  walk,
+  explainOpen,
+  ec,
+  explainClose,
+} from '../utility'
+
+
+import type {
+  Val,
+  ValSpec,
+} from '../type'
+
+import {
+  DONE,
+} from '../type'
+
+import { AontuContext } from '../ctx'
+
+import { makeNilErr } from '../err'
+import { unite } from '../unify'
+
+
+import {
+  top
+} from './top'
+
+
+import { StringVal } from './StringVal'
+import { IntegerVal } from './IntegerVal'
+import { NumberVal } from './NumberVal'
+import { ConjunctVal } from './ConjunctVal'
+import { VarVal } from './VarVal'
+import { FeatureVal } from './FeatureVal'
+
+
+
+class RefVal extends FeatureVal {
+  isRef = true
+
+  absolute: boolean = false
+  prefix: boolean = false
+
+  constructor(
+    spec: {
+      peg: any[],
+      absolute?: boolean,
+      prefix?: boolean
+    },
+    ctx?: AontuContext
+  ) {
+    super(spec, ctx)
+    this.peg = []
+
+    this.absolute = true === this.absolute ? true : // absolute sticks
+      true === spec.absolute ? true : false
+
+    this.prefix = true === spec.prefix
+
+    for (let pI = 0; pI < spec.peg.length; pI++) {
+      this.append(spec.peg[pI])
+    }
+
+    //console.log('RefVal', this.id, this.peg)
+  }
+
+
+  append(part: any) {
+    let partval
+
+    // console.log('APPEND', part)
+
+    if ('string' === typeof part) {
+      partval = part
+      this.peg.push(partval)
+    }
+
+    else if (part instanceof StringVal) {
+      partval = part.peg
+      this.peg.push(partval)
+    }
+
+    else if (part instanceof IntegerVal) {
+      // partval = '' + part.peg
+      partval = part.src
+      this.peg.push(partval)
+    }
+
+    // TODO: this is a bit of a hack, review
+    // Seems like a fundamental ambiguity?
+    // Resolved by path function
+    else if (part instanceof NumberVal) {
+      // let partvals: string[] = part.peg.toFixed(11).replace(/(\.0)?0+$/, '$1').split('.')
+      let partvals: string[] = part.src.split('.')
+      this.peg.push(...partvals)
+    }
+
+    else if (part instanceof VarVal) {
+      partval = part
+      this.peg.push(partval)
+    }
+
+    else if (part instanceof RefVal) {
+      if (part.absolute) {
+        this.absolute = true
+      }
+
+      if (this.prefix) {
+        if (part.prefix) {
+          this.peg.push('.')
+        }
+      }
+      else {
+        if (part.prefix) {
+          if (0 === this.peg.length) {
+            this.prefix = true
+          }
+
+          else if (0 < this.peg.length) {
+            this.peg.push('.')
+          }
+        }
+      }
+
+      this.peg.push(...part.peg)
+    }
+  }
+
+
+  unify(peer: Val, ctx: AontuContext): Val {
+    peer = peer ?? top()
+
+    const te = ctx.explain && explainOpen(ctx, ctx.explain, 'Ref', this, peer)
+    let out: Val = this
+    let why = 'id'
+
+    if (this.id !== peer.id) {
+
+      // TODO: not resolved when all Vals in path are done is an error
+      // as path cannot be found
+      // let resolved: Val | undefined = null == ctx ? this : ctx.find(this)
+      let found: Val | undefined = null == ctx ? this : this.find(ctx)
+
+      const resolved = found ?? this
+
+      if (null == resolved && this.canon === peer.canon) {
+        out = this
+      }
+      else if (resolved instanceof RefVal) {
+        if (peer.isTop) {
+          out = this
+          why = 'pt'
+        }
+        else if (peer.isNil) {
+          out = makeNilErr(ctx, 'ref[' + this.peg + ']', this, peer)
+          why = 'pn'
+        }
+
+        // same path
+        else if (this.canon === peer.canon) {
+          out = this
+          why = 'pp'
+        }
+
+        else {
+          // Ensure RefVal done is incremented
+          this.dc = DONE === this.dc ? DONE : this.dc + 1
+          out = new ConjunctVal({ peg: [this, peer] }, ctx)
+          why = 'cj'
+        }
+      }
+      else {
+        out = unite(ctx.clone({ explain: ec(te, 'RES') }), resolved, peer, 'ref')
+        why = 'u'
+      }
+
+      out.dc = DONE === out.dc ? DONE : this.dc + 1
+    }
+
+    // console.log('REFVAL-UNIFY-OUT', ctx.cc, this.id, this.canon, this.done, 'P=', peer.id, peer.canon, peer.done, '->', out.id, out.canon, out.done)
+
+    explainClose(te, out)
+    return out
+  }
+
+
+  find(ctx: AontuContext) {
+    let out: Val | undefined = undefined
+
+    const selfpath = this.path.join('.')
+    const pegpath = this.peg.join('.')
+    const isprefixpath = selfpath.startsWith(pegpath)
+
+    let refpath: string[] = []
+    let pI = 0
+    // let descent = ''
+
+    if (isprefixpath) {
+      out = makeNilErr(ctx, 'path_cycle', this)
+    }
+    else {
+
+      let parts: string[] = []
+
+      let modes: string[] = []
+
+      for (let pI = 0; pI < this.peg.length; pI++) {
+        let part = this.peg[pI]
+        if (part instanceof VarVal) {
+          let strval = (part as VarVal).peg
+          let name = strval ? '' + strval.peg : ''
+
+          if ('KEY' === name) {
+            if (pI === this.peg.length - 1) {
+              modes.push(name)
+            }
+            else {
+              // TODO: return a Nil explaining error
+              return
+            }
+          }
+
+          if ('SELF' === name) {
+            if (pI === 0) {
+              modes.push(name)
+            }
+            else {
+              // TODO: return a Nil explaining error
+              return
+            }
+          }
+          else if ('PARENT' === name) {
+            if (pI === 0) {
+              modes.push(name)
+            }
+            else {
+              // TODO: return a Nil explaining error
+              return
+            }
+          }
+          else if (0 === modes.length) {
+            part = (part as VarVal).unify(top(), ctx)
+            if (part.isNil) {
+              // TODO: var not found, so can't find path
+              return
+            }
+            else {
+              part = '' + part.peg
+            }
+          }
+        }
+        else {
+          parts.push(part)
+        }
+      }
+
+      if (this.absolute) {
+        refpath = parts
+      }
+      else {
+        // TODO: deprecate $KEY, etc
+        refpath = this.path.slice(
+          0,
+          (
+            modes.includes('SELF') ? 0 :
+              modes.includes('PARENT') ? -1 :
+                -1 // siblings
+          )
+        ).concat(parts)
+      }
+
+      let sep = '.'
+      refpath = refpath
+        .reduce(((a: string[], p: string) =>
+          (p === sep ? a.length = a.length - 1 : a.push(p), a)), [])
+
+      if (modes.includes('KEY')) {
+        let key = this.path[this.path.length - 2]
+        let sv = new StringVal({ peg: null == key ? '' : key }, ctx)
+
+        // TODO: other props?
+        sv.dc = DONE
+        sv.path = this.path
+
+        return sv
+      }
+
+      let node = ctx.root as Val
+
+      let nopath = false
+
+      if (null != node) {
+        for (; pI < refpath.length; pI++) {
+          let part = refpath[pI]
+          // console.log('PART', pI, part, node)
+
+          // descent += (' | ' + pI + '=' + node.canon) // Util.inspect(node))
+
+          if (node.isMap) {
+            node = node.peg[part]
+          }
+          else if (node.isList) {
+            node = node.peg[part]
+          }
+          else if (node.done) {
+            nopath = true
+            break;
+          }
+          else {
+            break;
+          }
+
+          if (null == node) {
+            nopath = true
+            break
+          }
+
+        }
+      }
+
+      // console.log('REFPATH', ctx.cc, pI, refpath, nopath, ctx.root, node)
+
+
+      if (nopath) {
+        out = makeNilErr(ctx, 'no_path', this)
+      }
+      else if (pI === refpath.length) {
+        out = node
+
+        // Types and hidden values are cloned and made concrete
+        if (null != out) { //  && (out.mark.type || out.mark.hide)) {
+
+          // console.log('FOUND-A', out)
+
+          if (this.mark.type || this.mark.hide) {
+            out.mark.type = this.mark.type
+            out.mark.hide = this.mark.hide
+
+            // walk(out, (_key: string | number | undefined, val: Val) => {
+            //   val.mark.type = this.mark.type
+            //   val.mark.hide = this.mark.hide
+            //   return val
+            // })
+          }
+
+          if (this.mark._hide_found) {
+            out.mark.hide = true
+          }
+
+          // console.log('FOUND-B', out)
+
+          out = out.clone(ctx)
+
+          // if (this.mark.type || this.mark.hide) {
+          walk(out, (_key: string | number | undefined, val: Val) => {
+            val.mark.type = false
+            val.mark.hide = false
+            return val
+          })
+          //}
+
+          // onsole.log('FOUND-C', out)
+        }
+      }
+    }
+
+    // console.log('REF-FIND', ctx.cc, this.id, selfpath, 'PEG=', pegpath, 'RP', pI, refpath.join('.'), descent, 'O=', out?.id, out?.canon, out?.done)
+
+    return out
+  }
+
+
+  same(peer: Val): boolean {
+    return null == peer ? false : this.peg === peer.peg
+  }
+
+
+  clone(ctx: AontuContext, spec?: ValSpec): Val {
+    let out = (super.clone(ctx, {
+      peg: this.peg,
+      absolute: this.absolute,
+      ...(spec || {})
+    }) as RefVal)
+    return out
+  }
+
+
+  get canon() {
+    let str =
+      (this.absolute ? '$' : '') +
+      (0 < this.peg.length ? '.' : '') +
+      // this.peg.join(this.sep)
+      this.peg.map((p: any) => '.' === p ? '' :
+        (p.isVal ? p.canon : '' + p))
+        .join('.')
+    return str
+  }
+
+
+  gen(ctx: AontuContext) {
+    // Unresolved ref cannot be generated, so always an error.
+    let nil = makeNilErr(
+      ctx,
+      'ref',
+      this, // (formatPath(this.peg, this.absolute) as any),
+      undefined,
+    )
+
+    // TODO: refactor to use Site pointer
+    nil.path = this.path
+    nil.site.url = this.site.url
+    nil.site.row = this.site.row
+    nil.site.col = this.site.col
+
+    return undefined
+  }
+
+
+  inspection() {
+    return [
+      this.absolute ? 'absolute' : '',
+      this.prefix ? 'prefix' : '',
+    ].filter(p => '' != p).join(',')
+  }
+
+}
+
+
+export {
+  RefVal,
+}

package/src/val/ScalarKindVal.ts

@@ -0,0 +1,125 @@
+/* Copyright (c) 2021-2025 Richard Rodger, MIT License */
+
+import type {
+  Val,
+  ValSpec,
+} from '../type'
+
+import {
+  DONE,
+} from '../type'
+
+import {
+  AontuContext,
+} from '../ctx'
+
+import {
+  explainOpen,
+  explainClose,
+} from '../utility'
+
+import { makeNilErr, AontuError } from '../err'
+
+// import { BaseVal } from './BaseVal'
+import { FeatureVal } from './FeatureVal'
+
+
+// A ScalarKind for integers. Number includes floats.
+class Integer { }
+
+// A ScalarKind for null.
+class Null { }
+
+
+type ScalarConstructor =
+  StringConstructor |
+  NumberConstructor |
+  BooleanConstructor |
+  (typeof Integer.constructor)
+
+
+// class ScalarKindVal extends BaseVal {
+class ScalarKindVal extends FeatureVal {
+  isScalarKind = true
+
+  constructor(
+    spec: ValSpec,
+    ctx?: AontuContext
+  ) {
+    super(spec, ctx)
+
+    if (null == this.peg) {
+      throw new AontuError('ScalarKindVal spec.peg undefined')
+    }
+
+    this.dc = DONE
+  }
+
+
+  unify(peer: Val, ctx: AontuContext): Val {
+    const te = ctx.explain && explainOpen(ctx, ctx.explain, 'ScalarKind', this, peer)
+
+    const peerIsScalarVal = peer.isScalar
+    const peerIsScalarKind = (peer as ScalarKindVal).isScalarKind
+
+    let out: Val = this
+
+    if (peerIsScalarVal) {
+      let peerKind = (peer as any).kind
+
+      if (peerKind === this.peg) {
+        out = peer
+      }
+      else if (Number === this.peg && Integer === peerKind) {
+        out = peer
+      }
+      else {
+        out = makeNilErr(ctx, 'no-scalar-unify', this, peer)
+      }
+    }
+    else if (peerIsScalarKind) {
+      if (Number === this.peg && Integer === peer.peg) {
+        out = peer
+      }
+      else if (Number === peer.peg && Integer === this.peg) {
+        out = this
+      }
+      else if (this.peg === peer.peg) {
+        out = this
+      }
+      else {
+        out = makeNilErr(ctx, 'scalar-type', this, peer)
+      }
+    }
+    else {
+      out = makeNilErr(ctx, 'not-scalar-type', this, peer)
+    }
+
+    ctx.explain && explainClose(te, out)
+
+    // console.log('SCALARKINDVAL', this.canon.peer.canon, '->', out.canon)
+    return out
+  }
+
+
+  get canon() {
+    let ctor = (this.peg as any)
+    return ctor.name.toLowerCase()
+  }
+
+
+  same(peer: any): boolean {
+    let out = peer?.isScalarKind ? this.peg === peer?.peg : super.same(peer)
+    return out
+  }
+
+
+}
+
+
+export {
+  Integer,
+  Null,
+  ScalarConstructor,
+  ScalarKindVal,
+}

package/src/val/ScalarVal.ts

@@ -0,0 +1,107 @@
+/* Copyright (c) 2021-2025 Richard Rodger, MIT License */
+
+import type {
+  ValSpec,
+} from '../type'
+
+import {
+  DONE,
+} from '../type'
+
+import {
+  AontuContext,
+} from '../ctx'
+
+import {
+  explainOpen,
+  explainClose,
+} from '../utility'
+
+import { makeNilErr } from '../err'
+
+import { Val } from './Val'
+import { ScalarKindVal } from './ScalarKindVal'
+
+
+
+class ScalarVal extends Val {
+  kind: any
+  isScalar = true
+  src: string
+
+  constructor(
+    spec: ValSpec,
+    ctx?: AontuContext
+  ) {
+    super(spec, ctx)
+    this.kind = spec.kind
+    this.src = spec.src ?? ''
+    this.dc = DONE
+  }
+
+
+  clone(ctx: AontuContext, spec?: ValSpec): Val {
+    let out = super.clone(ctx, {
+      peg: this.peg,
+      kind: this.kind,
+      ...(spec || {})
+    })
+
+    return out
+  }
+
+
+  unify(peer: Val, ctx: AontuContext): Val {
+    const te = ctx.explain && explainOpen(ctx, ctx.explain, 'Scalar', this, peer)
+
+    let out: Val
+
+    // Exactly equal scalars are handled in unify.unite
+    if (peer.isScalarKind) {
+      out = peer.unify(this, ctx)
+    }
+    else if (peer.isTop) {
+      out = this
+    }
+    else {
+      out = makeNilErr(ctx, 'scalar_' +
+        ((peer as any).kind === this.kind ? 'value' : 'kind'), this, peer)
+    }
+
+    // console.log('SCALAR', this.canon, peer.canon, '->', out.canon)
+
+    explainClose(te, out)
+
+    return out
+  }
+
+
+  get canon() {
+    return null === this.peg ? 'null' :
+      undefined === this.peg ? 'undefined' :
+        (this.peg as any).toString()
+  }
+
+
+  same(peer: any): boolean {
+    return peer?.isScalar ? peer.peg === this.peg : super.same(peer)
+  }
+
+
+  gen(_ctx?: AontuContext) {
+    return this.peg
+  }
+
+
+  superior() {
+    return this.place(new ScalarKindVal({
+      peg: this.kind
+    }))
+  }
+
+}
+
+
+export {
+  ScalarVal,
+}

package/src/val/StringVal.ts

@@ -0,0 +1,37 @@
+/* Copyright (c) 2021-2025 Richard Rodger, MIT License */
+
+import type {
+  Val,
+  ValSpec,
+} from '../type'
+
+import {
+  AontuContext,
+} from '../ctx'
+
+import { ScalarVal } from './ScalarVal'
+
+
+class StringVal extends ScalarVal {
+  isString = true
+
+  constructor(
+    spec: ValSpec,
+    ctx?: AontuContext
+  ) {
+    super({ peg: spec.peg, kind: String }, ctx)
+  }
+
+  unify(peer: Val, ctx: AontuContext): Val {
+    return super.unify(peer, ctx)
+  }
+
+  get canon() {
+    return JSON.stringify(this.peg)
+  }
+
+}
+
+export {
+  StringVal,
+}