@fraczak/k 7.2.0 → 8.0.0

package/README.md

@@ -45,18 +45,19 @@ k can define recursive data and transformations in the same file. Peano
 natural numbers are either `0` or one more than another natural number:
 
 ```k
+nat[] = < {} 0, N +1 > = N;
 0 = {} | 0;
 inc = | +1;
 dec = / +1;       # undefined for '0'
-add = ?{ < {} 0, N +1 > = N x, ... } <
-  { . x dec x, . y inc y } add,    # defined if 'x > 0'
-  . y                              # else, return 'y'
+add = ?{ nat[] = N x, ... } <
+  { .x dec x, .y inc y } add,    # defined if 'x > 0'
+  .y                             # else, return 'y'
 >;
 ```
 
 `add` takes a product `{ x, y }`. If `x` has a `+1`, it moves that
 successor from `x` to `y` and recurses. When that no longer applies, it
-returns `y`. The inductive filter `?{ < {} 0, N +1 > = N x, ... }`
+returns `y`. The inductive filter `?{ nat[] = N x, ... }`
 explicitly witnesses that recursive calls shrink `x`.
 
 In the REPL:
@@ -122,19 +123,41 @@ Every installed command supports `-h` and `--help`.
 
 ## What k Gives You
 
-**Algebraic data shapes**
+**Algebraic data shapes and named patterns**
 
-All data structures in k are built from products and tagged unions (variants).
-Relations and pattern filters describe their domains:
+All data structures in k are built from products and tagged unions
+(variants). Reusable named patterns describe structural type schemas
+using square brackets `name[...]`:
 
 ```k
-bit?  = ?< {} 0, {} 1 >;
-byte? = ?{ Bit 0, Bit 1, Bit 2, Bit 3, Bit 4, Bit 5, Bit 6, Bit 7 };
-bits? = ?< {} _, bits? 0, bits? 1 > = bits?;
+bit[]  = < {} 0, {} 1 >;
+bits[] = < {} _, B 0, B 1 > = B;
+byte[] = {
+  bit[] 0, bit[] 1, bit[] 2, bit[] 3,
+  bit[] 4, bit[] 5, bit[] 6, bit[] 7
+};
+
+-- Parameterized type templates:
+list[X] = < {} nil, { X car, Y cdr } cons > = Y;
+pair[A, B] = { A first, B second };
 ```
 
-There are no built-in primitive values. The empty product `{}` is the
-only leaf in a non-recursive definition.
+Callers instantiate patterns using `? name[...]` as standalone filters
+or inside relation parameter guards (`?{ nat[] = N x, ... }`). There are
+no built-in primitive values: the empty product `{}` is the only leaf
+in a non-recursive definition.
+
+**The four-bracket architecture**
+
+k uses an orthogonal four-bracket convention with non-overlapping
+semantic domains:
+
+| Brackets | Domain | Purpose & Concrete Example |
+| :--- | :--- | :--- |
+| `{ ... }` | Products | Record construction: `{ f a, g b }`, `{}` |
+| `< ... >` | Unions | Variant choice: `< f, g >`, `<>` |
+| `( ... )` | Relations | Composition & identity: `(f g)`, `()` |
+| `[ ... ]` | Patterns | Reusable templates: `list[X]`, `bit[]` |
 
 **Composable partial functions**
 
@@ -149,6 +172,7 @@ Core expressions are deliberately small:
 | `<f, g>` | try `f`, then `g` if `f` is undefined |
 | `{f a, g b}` | build a product from parallel transformations |
 | `?filter` | schema filter / inductive termination witness |
+| `name[...]` | instantiate named pattern template |
 | `()` | identity |
 | `<>` | always undefined |
 | `{}` | constant empty product |
@@ -223,10 +247,12 @@ For a detailed guide to all four formats, commands, and workflows, see
 
 | Command | Purpose |
 | --- | --- |
-| `k-json` | Convert JSON to/from the binary stream (schema-specializing) |
-| `k-djson` | Convert JSON to/from a universal dynamic JSON singleton pattern |
-| `k-int` | Convert decimal integers to/from the binary stream |
-| `k-ieee` | Convert float literals to/from the binary stream |
+| `k-json` | Convert JSON to/from binary stream (specializing) |
+| `k-djson` | Convert JSON to/from dynamic JSON (cons-list) |
+| `k-djson-btrie` | Convert JSON to/from binary bit-trie dynamic JSON |
+| `k-djson-ptrie` | Convert JSON to/from radix trie dynamic JSON |
+| `k-int` | Convert decimal integers to/from binary stream |
+| `k-ieee` | Convert float literals to/from binary stream |
 | `k-unit` | Produce or validate the unit value |
 | `k-utf8` / `k-utf16` | Convert text to/from k string streams |
 

package/browser/repl-browser.mjs

@@ -632,6 +632,12 @@ function renderCodecsModal() {
       targetDesc = "{}";
     } else if (entry.name === "json.mjs") {
       targetDesc = "Self-describing JSON";
+    } else if (entry.name === "djson.mjs") {
+      targetDesc = "$ json (cons-list)";
+    } else if (entry.name === "djson-btrie.mjs") {
+      targetDesc = "$ json (binary bit-trie)";
+    } else if (entry.name === "djson-ptrie.mjs") {
+      targetDesc = "$ json (radix/Patricia trie)";
     } else if (Array.isArray(entry.patterns) && entry.patterns.length > 0) {
       targetDesc = `Pattern Family (${entry.patterns.length})`;
     } else if (entry.pattern) {

package/browser/tree-view.mjs

@@ -455,7 +455,7 @@ export function createOutputEntryElement({
   modeGroup.appendChild(rawBtn);
   toolbar.appendChild(modeGroup);
 
-  // Tree Action buttons group (Expand / Collapse / Copy)
+  // Tree Action buttons group (Expand / Collapse)
   const actionGroup = document.createElement("div");
   actionGroup.className = "k-action-group";
 
@@ -471,23 +471,8 @@ export function createOutputEntryElement({
   collapseAllBtn.innerHTML = `⊟ Collapse`;
   collapseAllBtn.title = "Reset trees to top 3 levels";
 
-  const copyBtn = document.createElement("button");
-  copyBtn.type = "button";
-  copyBtn.className = "k-btn-action";
-  copyBtn.innerHTML = `📋 Copy`;
-  copyBtn.title = "Copy raw output to clipboard";
-  copyBtn.onclick = (e) => {
-    e.stopPropagation();
-    navigator.clipboard.writeText(rawText);
-    copyBtn.innerHTML = `✓ Copied`;
-    setTimeout(() => {
-      copyBtn.innerHTML = `📋 Copy`;
-    }, 1500);
-  };
-
   actionGroup.appendChild(expandAllBtn);
   actionGroup.appendChild(collapseAllBtn);
-  actionGroup.appendChild(copyBtn);
   toolbar.appendChild(actionGroup);
 
   container.appendChild(toolbar);
@@ -512,6 +497,23 @@ export function createOutputEntryElement({
     `<span class="k-tree-arrow">▶</span> ` +
     `<span class="k-section-title">🌲 Value</span> ` +
     `<span class="k-section-preview">${valEscaped}</span>`;
+
+  const copyValBtn = document.createElement("button");
+  copyValBtn.type = "button";
+  copyValBtn.className = "k-btn-action k-btn-copy k-btn-copy-value";
+  copyValBtn.innerHTML = `📋 Copy`;
+  copyValBtn.title = "Copy value definition to clipboard";
+  copyValBtn.onclick = (e) => {
+    e.preventDefault();
+    e.stopPropagation();
+    const valStr = valueToK(value);
+    navigator.clipboard.writeText(valStr);
+    copyValBtn.innerHTML = `✓ Copied`;
+    setTimeout(() => {
+      copyValBtn.innerHTML = `📋 Copy`;
+    }, 1500);
+  };
+  valSummary.appendChild(copyValBtn);
   valSection.appendChild(valSummary);
 
   const valBody = document.createElement("div");
@@ -538,6 +540,23 @@ export function createOutputEntryElement({
       `<span class="k-tree-arrow">▶</span> ` +
       `<span class="k-section-title">🌿 Pattern</span> ` +
       `<span class="k-section-preview">?${patEscaped}</span>`;
+
+    const copyPatBtn = document.createElement("button");
+    copyPatBtn.type = "button";
+    copyPatBtn.className = "k-btn-action k-btn-copy k-btn-copy-pattern";
+    copyPatBtn.innerHTML = `📋 Copy`;
+    copyPatBtn.title = "Copy pattern definition to clipboard";
+    copyPatBtn.onclick = (e) => {
+      e.preventDefault();
+      e.stopPropagation();
+      const patStr = `?${propertyListToFilter(value.pattern, "X")}`;
+      navigator.clipboard.writeText(patStr);
+      copyPatBtn.innerHTML = `✓ Copied`;
+      setTimeout(() => {
+        copyPatBtn.innerHTML = `📋 Copy`;
+      }, 1500);
+    };
+    patSummary.appendChild(copyPatBtn);
     patSection.appendChild(patSummary);
 
     patBody = document.createElement("div");