@fraczak/k 6.10.6 → 7.0.1

package/codecs/BINARY_FORMAT.md

@@ -6,7 +6,7 @@ The active format is the self-hosted pattern-plus-prefix-tree stream described
 in [`POLYMORPHIC_BINARY_FORMAT.md`](./POLYMORPHIC_BINARY_FORMAT.md):
 
 ```text
-encode($pattern_value : $pattern) encode(value : decoded_pattern)
+encode(pattern_value : pattern) encode(value : decoded_pattern)
 ```
 
 ## Purpose of This File
@@ -18,7 +18,7 @@ The design sequence is:
 
 1. define the abstract pattern graph,
 2. define prefix-free value-tree encoding relative to that graph,
-3. encode the pattern itself as a k `$pattern` value,
+3. encode the pattern itself as a k `pattern` value,
 4. optionally add higher-level indexes or compression as separate layers.
 
 ## Expected Container Shape
@@ -26,12 +26,12 @@ The design sequence is:
 The canonical stream contains:
 
 ```text
-encoded-$pattern + value-bitstream
+encoded-pattern + value-bitstream
 ```
 
 where:
 
-- `encoded-$pattern` is the k value representation defined in `core.k`,
+- `encoded-pattern` is the k value representation defined in `core.k`,
 - the value bitstream is exactly the same prefix-free payload described by the
   semantic codec.
 

package/codecs/POLYMORPHIC_BINARY_FORMAT.md

@@ -61,7 +61,7 @@ Unions emit a choice code, then the payload of the selected branch.
 
 ### 4. One canonical stream
 
-The pattern graph is embedded as an ordinary k `$pattern` value. The canonical
+The pattern graph is embedded as an ordinary k `pattern` value. The canonical
 stream is that encoded pattern followed by the value payload interpreted under
 the decoded pattern.
 
@@ -277,11 +277,11 @@ This keeps the codec uniform: recursion is handled by the pattern graph itself.
 The transport format is:
 
 ```text
-encode($pattern_value : $pattern) encode(value : decoded_pattern)
+encode(pattern_value : pattern) encode(value : decoded_pattern)
 ```
 
-The first segment is a normal k value of type `$pattern`, encoded under the
-fixed singleton pattern for `$pattern` defined by `core.k`. The decoded pattern
+The first segment is a normal k value of type `pattern`, encoded under the
+fixed singleton pattern for `pattern` defined by `core.k`. The decoded pattern
 is then used as the structural authority for the second segment.
 
 Decoding the stream yields `Value(pattern, tree)`. Encoding a runtime `Value`

package/codecs/README.md

@@ -6,13 +6,13 @@ This directory is centered on the codec design:
 abstract pattern graph + prefix-free tree encoding
 ```
 
-The default concrete format is now the binary encoding of a `$pattern`
-value, using the `$pattern` type from [`../core.k`](../core.k),
+The default concrete format is now the binary encoding of a `pattern`
+value, using the `pattern` relation from [`../core.k`](../core.k),
 immediately followed by the binary encoding of the value under that
 decoded pattern.
 
 `core.k` is not loaded automatically as a library when user programs
-run. The codec only depends on the canonical `$pattern` definition from
+run. The codec only depends on the canonical `pattern` definition from
 that file as the schema for the leading pattern value.
 
 There is no separate JSON container format.
@@ -63,10 +63,10 @@ primitive value format.
 The default transport format is:
 
 ```text
-encode($pattern_value : $pattern) encode(value : decoded_pattern)
+encode(pattern_value : pattern) encode(value : decoded_pattern)
 ```
 
-`$pattern_value` is a normal k value whose shape is defined in `core.k`.
+`pattern_value` is a normal k value whose shape is defined in `core.k`.
 After that value is decoded, it becomes the pattern used to decode the
 remaining value payload.
 
@@ -151,7 +151,7 @@ Canonical rules:
 - `"any"` must have no outgoing edges.
 
 This JSON-like graph is only a readable notation. The wire
-representation is the ordinary k `$pattern` value from `core.k`.
+representation is the ordinary k `pattern` value from `core.k`.
 
 For pattern export, see [`../DOCS/PATTERNS.md`](../DOCS/PATTERNS.md) and
 the repository helper `patterns/from-k.mjs`.

package/codecs/ieee.mjs

@@ -9,17 +9,21 @@ Parses decimal floats, Infinity, -Infinity, NaN to 64-bit IEEE products.
 `;
 
 const FLOAT64_PATTERN = patternFromFilter(`
-$bit  = < {} 0, {} 1 >;
-$sign = < {} "+", {} "-" >;
-$exp11  = {bit 0, bit 1, bit 2, bit 3, bit 4, bit 5, bit 6, bit 7, bit 8, bit 9, bit 10};
-$frac52 = {bit 0, bit 1, bit 2, bit 3, bit 4, bit 5, bit 6, bit 7, bit 8, bit 9,
-           bit 10, bit 11, bit 12, bit 13, bit 14, bit 15, bit 16, bit 17, bit 18, bit 19,
-           bit 20, bit 21, bit 22, bit 23, bit 24, bit 25, bit 26, bit 27, bit 28, bit 29,
-           bit 30, bit 31, bit 32, bit 33, bit 34, bit 35, bit 36, bit 37, bit 38, bit 39,
-           bit 40, bit 41, bit 42, bit 43, bit 44, bit 45, bit 46, bit 47, bit 48, bit 49,
-           bit 50, bit 51};
-$float64 = {sign sign, exp11 exponent, frac52 fraction};
-?$float64
+? {
+  < {} "+", {} "-" > sign,
+  {
+    < {} 0, {} 1 >=Bit 0,
+    Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7, Bit 8, Bit 9, Bit 10
+  } exponent,
+  {
+    Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7, Bit 8, Bit 9,
+    Bit 10, Bit 11, Bit 12, Bit 13, Bit 14, Bit 15, Bit 16, Bit 17, Bit 18, Bit 19,
+    Bit 20, Bit 21, Bit 22, Bit 23, Bit 24, Bit 25, Bit 26, Bit 27, Bit 28, Bit 29,
+    Bit 30, Bit 31, Bit 32, Bit 33, Bit 34, Bit 35, Bit 36, Bit 37, Bit 38, Bit 39,
+    Bit 40, Bit 41, Bit 42, Bit 43, Bit 44, Bit 45, Bit 46, Bit 47, Bit 48, Bit 49,
+    Bit 50, Bit 51
+  } fraction
+}
 `);
 
 const UNIT = Value.product({});

package/codecs/int.mjs

@@ -21,11 +21,15 @@ Syntax:
 // with $ bits = < {} _, bits 0, bits 1 >
 const INT_PATTERN = patternFromFilter('?< <bits 0, bits 1, {} _>=bits "+", bits "-">');
 
-// Closed pattern for list of int:
-// list = < {} nil, {int car, list cdr} cons >
-const INT_LIST_PATTERN = patternFromFilter(
-  '$ bits = < bits 0, bits 1, {} _ >; $ int = < bits "+", bits "-" >; ?< {} nil, { $int car, list cdr } cons > = list'
-);
+const INT_LIST_PATTERN = patternFromFilter(`
+  ?<
+    {} nil,
+    {
+      < <bits 0, bits 1, {} _>=bits "+", bits "-" > car,
+      list cdr
+    } cons
+  > = list
+`);
 
 // Build bits Value (MSB outermost) from a non-negative BigInt.
 function buildBits(n) {

package/codecs/string-codec.mjs

@@ -2,53 +2,52 @@ import { patternFromFilter } from "./runtime/codec-sdk.mjs";
 import { textToStringValue, stringValueToText } from "./runtime/unicode-string.mjs";
 
 const STRING_PATTERN_PROPERTY_LIST = patternFromFilter(`
-$bit = < {} 0, {} 1 >;
-$bits1 = { bit 0 };
-$bits2 = { bit 0, bit 1 };
-$bits3 = { bit 0, bit 1, bit 2 };
-$bits4 = { bit 0, bit 1, bit 2, bit 3 };
-$bits7 = { bit 0, bit 1, bit 2, bit 3, bit 4, bit 5, bit 6 };
-$bits8 = { bit 0, bit 1, bit 2, bit 3, bit 4, bit 5, bit 6, bit 7 };
-$bits11 = { bit 0, bit 1, bit 2, bit 3, bit 4, bit 5, bit 6, bit 7, bit 8, bit 9, bit 10 };
-
-$bmp_common_hi = <
-  bits3 h08_0F,
-  bits7 h10_7F,
-  bits7 h80_CF,
-  bits3 hD0_D7,
-  {} hF9,
-  bits1 hFA_FB,
-  bits1 hFC_FD,
-  bits1 hFE_FF
->;
-$bmp_common = { bmp_common_hi hi, bits8 lo };
-
-$bmp_private_hi = <
-  bits4 hE0_EF,
-  bits3 hF0_F7,
-  {} hF8
->;
-$bmp_private_use = { bmp_private_hi hi, bits8 lo };
-
-$plane2_16 = <
-  bits1 p02_03,
-  bits2 p04_07,
-  bits3 p08_0F,
-  {} p10
->;
-$supplementary_planes2_16 = { plane2_16 plane, bits8 mid, bits8 lo };
-$supplementary_plane1 = { bits8 mid, bits8 lo };
-
-$unicode_scalar = <
-  bits7 ascii,
-  bits11 plane0,
-  bmp_common bmp_common,
-  bmp_private_use bmp_private_use,
-  supplementary_plane1 supplementary_plane1,
-  supplementary_planes2_16 supplementary_planes2_16
->;
-
-?< {} nil, { $unicode_scalar car, str cdr } cons > = str
+? <
+  {} nil,
+  {
+    <
+      {
+        < {} 0, {} 1 >=Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6
+      }=Bits7 ascii,
+      {
+        <
+          { Bit 0, Bit 1, Bit 2 }=Bits3 h08_0F,
+          Bits7 h10_7F,
+          Bits7 h80_CF,
+          Bits3 hD0_D7,
+          {} hF9,
+          { Bit 0 }=Bits1 hFA_FB,
+          Bits1 hFC_FD,
+          Bits1 hFE_FF
+        > hi,
+        { Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7 }=Bits8 lo
+      } bmp_common,
+      {
+        <
+          { Bit 0, Bit 1, Bit 2, Bit 3 } hE0_EF,
+          Bits3 hF0_F7,
+          {} hF8
+        > hi,
+        Bits8 lo
+      } bmp_private_use,
+      {
+        Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7, Bit 8, Bit 9, Bit 10
+      } plane0,
+      { Bits8 mid, Bits8 lo } supplementary_plane1,
+      {
+        <
+          Bits1 p02_03,
+          { Bit 0, Bit 1 } p04_07,
+          Bits3 p08_0F,
+          {} p10
+        > plane,
+        Bits8 mid,
+        Bits8 lo
+      } supplementary_planes2_16
+    > car,
+    Str cdr
+  } cons
+> = Str
 `);
 
 export { STRING_PATTERN_PROPERTY_LIST, textToStringValue, stringValueToText };

package/core.k

@@ -1,17 +1,17 @@
 -- core.k — the k standard core library
 --
 -- Defines:
---   1. $bits — the canonical binary number / bit-path type
---   2. $string — unicode strings (used for labels)
---   3. $pattern — the type of pattern graphs
+--   1. bits — canonical binary number / bit-path relation
+--   2. string — unicode strings relation (used for labels)
+--   3. pattern — pattern graph relation
 
 ---------------------------------------------------------------
 -- §1. Bits
 ---------------------------------------------------------------
 
-$ bit = < {} 0, {} 1 >;
+bit = ?< {} 0, {} 1 >;
 
-$ bits = < {} _, bits 0, bits 1 >;
+bits = ?< {} _, bits 0, bits 1 > = bits;
 
 _ = {}|_;
 
@@ -22,104 +22,132 @@ _ = {}|_;
 -- §2. Unicode and String
 ---------------------------------------------------------------
 
--- 8-bit octet used as a building block for UTF-8 payload pieces.
-$ byte = {
-  bit 0, bit 1, bit 2, bit 3,
-  bit 4, bit 5, bit 6, bit 7
-};
-
--- 7-bit ASCII code point payload (U+0000..U+007F).
-$ ascii = { bit 6, bit 5, bit 4, bit 3, bit 2, bit 1, bit 0 };
-
--- 11-bit payload used for Plane 0 code points U+0080..U+07FF.
--- Plane 0 is the Basic Multilingual Plane (BMP): U+0000..U+FFFF.
-$ u0080_07FF = { bit 10, bit 9, bit 8, bit 7, bit 6, bit 5, bit 4, bit 3, bit 2, bit 1, bit 0 };
-
--- High-byte classes for common BMP ranges, excluding surrogate and
--- private-use partitions.
--- BMP (Basic Multilingual Plane) is Plane 0: first 65,536 code points.
-$ bmp_hi_common = <
-  { bit 2, bit 1, bit 0 } h08_0F,
-  { bit 6, bit 5, bit 4, bit 3, bit 2, bit 1, bit 0 } h10_7F,
-  { bit 6, bit 5, bit 4, bit 3, bit 2, bit 1, bit 0 } h80_CF,
-  { bit 2, bit 1, bit 0 } hD0_D7,
-  {} hF9,
-  { bit 0 } hFA_FB,
-  { bit 0 } hFC_FD,
-  { bit 0 } hFE_FF
->;
-
--- High-byte classes for BMP private-use/high-reserved slices.
--- These partitions keep Plane 0 subsets explicit in the type encoding.
-$ bmp_hi_private_use = <
-  { bit 3, bit 2, bit 1, bit 0 } hE0_EF,
-  { bit 2, bit 1, bit 0 } hF0_F7,
-  {} hF8
->;
-
--- Plane selector for supplementary code points in Planes 2..16.
--- Supplementary planes are all planes above BMP (Plane 0).
-$ plane_02_10 = <
-  { bit 0 } p02_03,
-  { bit 1, bit 0 } p04_07,
-  { bit 2, bit 1, bit 0 } p08_0F,
-  {} p10
->;
-
--- Canonical Unicode scalar-value partition used by string encoding.
--- Branch meaning:
--- - ascii: U+0000..U+007F (subset of BMP / Plane 0)
--- - plane0: U+0080..U+07FF (still Plane 0)
--- - bmp_common, bmp_private_use: U+0800..U+FFFF partitions (Plane 0)
--- - supplementary_plane1: U+10000..U+1FFFF (Plane 1)
--- - supplementary_planes2_16: U+20000..U+10FFFF (Planes 2..16)
-$ unicode = <
-  ascii ascii,
-  u0080_07FF plane0,
-  { bmp_hi_common hi, byte lo } bmp_common,
-  { bmp_hi_private_use hi, byte lo } bmp_private_use,
-  { byte mid, byte lo } supplementary_plane1,
-  { plane_02_10 plane, byte mid, byte lo } supplementary_planes2_16
->;
-
--- Linked-list string: nil or (unicode car, string cdr).
-$ string = < {} nil, { unicode car, string cdr } cons >;
+string = ? <
+  {} nil,
+  {
+    <
+      {
+        < {} 0, {} 1 >=Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6
+      }=Bits7 ascii,
+      {
+        <
+          { Bit 0, Bit 1, Bit 2 }=Bits3 h08_0F,
+          Bits7 h10_7F,
+          Bits7 h80_CF,
+          Bits3 hD0_D7,
+          {} hF9,
+          { Bit 0 }=Bits1 hFA_FB,
+          Bits1 hFC_FD,
+          Bits1 hFE_FF
+        > hi,
+        { Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7 }=Bits8 lo
+      } bmp_common,
+      {
+        <
+          { Bit 0, Bit 1, Bit 2, Bit 3 } hE0_EF,
+          Bits3 hF0_F7,
+          {} hF8
+        > hi,
+        Bits8 lo
+      } bmp_private_use,
+      {
+        Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7, Bit 8, Bit 9, Bit 10
+      } plane0,
+      { Bits8 mid, Bits8 lo } supplementary_plane1,
+      {
+        <
+          Bits1 p02_03,
+          { Bit 0, Bit 1 } p04_07,
+          Bits3 p08_0F,
+          {} p10
+        > plane,
+        Bits8 mid,
+        Bits8 lo
+      } supplementary_planes2_16
+    > car,
+    String cdr
+  } cons
+> = String;
 
 ---------------------------------------------------------------
 -- §3. Pattern
 ---------------------------------------------------------------
 
--- Edge: a labeled edge in a pattern graph.
--- 'label' is the field name or tag name.
--- 'target' is index (as $bits) of the target node in the pattern list.
-
-$ edge = { string label, bits target };
-
--- Edge list: the edges of a pattern node, sorted by label.
-
-$ edges = < {} nil, { edge car, edges cdr } cons >;
-
--- Pattern node: one of five kinds.
--- "any" is the unconstrained position (...), carrying no edges.
--- The four others carry their edge list directly.
-
-$ pattern-node = <
-  {} any,
-  edges open-product,
-  edges open-union,
-  edges closed-product,
-  edges closed-union
->;
-
 -- Pattern: a cons-list of pattern nodes.
 -- Node 0 (first element) is the root.
--- Edges reference nodes by their index in this list, encoded as $bits.
+-- Edges reference nodes by their index in this list, encoded as bits.
 --
--- The singleton pattern of $pattern itself is a fixed constant.
+-- The singleton pattern of pattern itself is a fixed constant.
 -- That constant is the implicit framing for all k wire formats:
--- to decode any value, first decode a $pattern under that constant,
+-- to decode any value, first decode a pattern under that constant,
 -- then decode the value under the pattern just obtained.
 
-$ pattern = < {} nil, { pattern-node car, pattern cdr } cons >;
-
-$pattern
+pattern = ? <
+  {} nil,
+  {
+    <
+      {} any,
+      <
+        {} nil,
+        {
+          {
+            <
+              {} nil,
+              {
+                <
+                  {
+                    < {} 0, {} 1 >=Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6
+                  }=Bits7 ascii,
+                  {
+                    <
+                      { Bit 0, Bit 1, Bit 2 }=Bits3 h08_0F,
+                      Bits7 h10_7F,
+                      Bits7 h80_CF,
+                      Bits3 hD0_D7,
+                      {} hF9,
+                      { Bit 0 }=Bits1 hFA_FB,
+                      Bits1 hFC_FD,
+                      Bits1 hFE_FF
+                    > hi,
+                    { Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7 }=Bits8 lo
+                  } bmp_common,
+                  {
+                    <
+                      { Bit 0, Bit 1, Bit 2, Bit 3 } hE0_EF,
+                      Bits3 hF0_F7,
+                      {} hF8
+                    > hi,
+                    Bits8 lo
+                  } bmp_private_use,
+                  {
+                    Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7, Bit 8, Bit 9, Bit 10
+                  } plane0,
+                  { Bits8 mid, Bits8 lo } supplementary_plane1,
+                  {
+                    <
+                      Bits1 p02_03,
+                      { Bit 0, Bit 1 } p04_07,
+                      Bits3 p08_0F,
+                      {} p10
+                    > plane,
+                    Bits8 mid,
+                    Bits8 lo
+                  } supplementary_planes2_16
+                > car,
+                String cdr
+              } cons
+            > = String label,
+            < Bits 0, Bits 1, {} _ > = Bits target
+          } car,
+          Edges cdr
+        } cons
+      > = Edges open-product,
+      Edges open-union,
+      Edges closed-product,
+      Edges closed-union
+    > car,
+    Pattern cdr
+  } cons
+> = Pattern;
+
+pattern