@cardenelabs/dragon 0.15.0 → 0.17.0

package/src/v05/parser.ts

@@ -41,8 +41,9 @@
  * 出力は v0.4 と同じ DslDocument。 既存 compile.ts で CdlDiagram に変換できる。
  */
 
-import type { NodeKind, Tone, EdgeStyle } from "@cardenelabs/cdl";
-import { TONES, NODE_KINDS, parseFormula } from "@cardenelabs/cdl";
+import type { NodeKind, Tone, EdgeStyle, EdgeHead, EdgeHeadFill, ClassRelationType, SequenceMessageKind } from "@cardenelabs/cdl";
+import { TONES, NODE_KINDS, EDGE_HEADS, EDGE_HEAD_FILLS, EDGE_STYLES, EDGE_REVEALS, CLASS_RELATION_LOOK, SEQUENCE_MESSAGE_LOOK, parseFormula } from "@cardenelabs/cdl";
+import type { EdgeReveal } from "@cardenelabs/cdl";
 import { TONE_ALIAS, NODE_KIND_ALIAS } from "../keywords";
 import { parseRelativePos, orderByDependency } from "../relative-pos";
 import {
@@ -74,6 +75,7 @@ import type {
   DslError,
   PresetType,
   DslLane,
+  DslBand,
   DslGroup,
   DslViewport,
 } from "../types";
@@ -83,6 +85,26 @@ export type V05ParseResult = { ok: true; doc: DslDocument } | { ok: false; error
 /** 矢印を出す辺。 Text DSL / JSON validator / 公開 schema の 3 経路で同じ 4 値を使う。 */
 export const EDGE_SIDE_VALUES = ["top", "right", "bottom", "left"] as const;
 
+/**
+ * 矢印の先の形として書ける語 (#1462)。
+ *
+ * **描画側から導く**。 手で並べると、描画側が形を増やした時に書けないままになる。
+ */
+export const EDGE_HEAD_VALUES: readonly string[] = EDGE_HEADS;
+
+/** 端の印の塗り方 (#1466)。 描画側の一覧から導く = 描画側が増やせば書ける */
+export const EDGE_HEAD_FILL_VALUES: readonly string[] = EDGE_HEAD_FILLS;
+
+/**
+ * クラス図の関係の種類 (#1466)。 描画側の表 (`CLASS_RELATION_LOOK`) の key から導く。
+ *
+ * 手で並べると、描画側が種類を足した時にここだけ取り残されて書けないままになる。
+ */
+export const CLASS_RELATION_VALUES: readonly string[] = Object.keys(CLASS_RELATION_LOOK);
+
+/** 順序図の言づての種類 (#1466)。 描画側の表から導く */
+export const SEQ_MESSAGE_VALUES: readonly string[] = Object.keys(SEQUENCE_MESSAGE_LOOK);
+
 /**
  * 記法が受ける top-level の項目 (#1190)。
  *
@@ -115,6 +137,10 @@ export const TOP_LEVEL_KEYS = [
   "events",
   // 巻き上げに応じて進む値 (#1393)
   "scrolls",
+  // 動いている間の帯 (#1466)。 順序図だけが読む
+  "bands",
+  // 矢印をいつ出すか (#1470)
+  "reveal",
 ] as const;
 
 /**
@@ -249,6 +275,11 @@ export const PRESET_TYPES: ReadonlySet<PresetType> = new Set([
   "pie",
   "bar",
   "line",
+  "gauge",
+  "radial",
+  "stat",
+  "waffle",
+  "stacked",
   "funnel",
   "tree",
   "journey",
@@ -330,11 +361,14 @@ export const NODE_KIND_VALID: ReadonlySet<string> = new Set<string>([
 const TONE_VALID: ReadonlySet<string> = new Set<string>(TONES);
 
 /**
- * 受理する線種。 `EdgeStyle` は型だけで実体を持たないため、 実行時の一覧はここが唯一の出どころ。
+ * 受理する線種。 **描画側の一覧から導く** (#1466)。
+ *
+ * 以前は手で並べており、描画側が `dashed` を足した時にここだけ取り残されて「線種が
+ * 読めません」 で落ちた (実測)。 色名 (`TONE_VALID`) と同じく描画側を出どころにする。
  *
- * JSON 経路も同じ集合を読む (#1304)。 別に持つと、 線種が増えた時に片方だけ取り残される。
+ * JSON 経路も同じ集合を読む (#1304)。 別に持つと、線種が増えた時に片方だけ取り残される。
  */
-export const STYLE_VALID: ReadonlySet<string> = new Set<string>(["solid", "dotted-flow"]);
+export const STYLE_VALID: ReadonlySet<string> = new Set<string>(EDGE_STYLES);
 
 /**
  * 色の名前として書ける語の一覧 (#1304)。 知らせの `hint` に出す。
@@ -391,6 +425,7 @@ export function parseTextDslV05(src: string): V05ParseResult {
   let type: PresetType | null = null;
   let eyebrow: string | null = null;
   let eyebrowLine = 0;
+  let reveal: EdgeReveal | null = null;
   let axes: DslAxes | undefined = undefined;
   let axesLine = 0;
   let actors: DslActor[] = [];
@@ -399,6 +434,8 @@ export function parseTextDslV05(src: string): V05ParseResult {
   const values: DslValue[] = [];
   let viewport: DslViewport | undefined = undefined;
   let lanesMap: Record<string, DslLane> | undefined = undefined;
+  // 動いている間の帯 (#1466)。 順序図だけが読む
+  let bands: DslBand[] | undefined = undefined;
   let readoutsList: DslReadout[] | undefined = undefined;
   let inputsList: DslInput[] | undefined = undefined;
   let formulasList: DslFormula[] | undefined = undefined;
@@ -432,6 +469,29 @@ export function parseTextDslV05(src: string): V05ParseResult {
       i += 1;
       continue;
     }
+    if (head.key === "reveal") {
+      /*
+       * 矢印をいつ出すか (#1470)。
+       *
+       * 既定 (`phase`) は「段が名指しする矢印は、その段が来るまで描かない」。 段を進めるごとに
+       * 関係が増える図で、全ての矢印が 1 段目から見えていたことへの対処 (`cdl#582`)。
+       * `all` と書くと段に関わらず最初から全部描く。
+       */
+      const v = (head.value ?? "").trim();
+      if (v.length > 0) {
+        if ((EDGE_REVEALS as readonly string[]).includes(v)) {
+          reveal = v as EdgeReveal;
+        } else {
+          errors.push({
+            line: line.no,
+            message: `reveal が読めません (書いた値: ${v})`,
+            hint: `使える語 = ${EDGE_REVEALS.join(" / ")}`,
+          });
+        }
+      }
+      i += 1;
+      continue;
+    }
     if (head.key === "eyebrow") {
       // 空で書いた形 (`eyebrow:`) は「書かなかった」 と同じにする。 空文字を残すと
       // 描画側が中身のない帯を出す
@@ -640,6 +700,31 @@ export function parseTextDslV05(src: string): V05ParseResult {
       i = next;
       continue;
     }
+    if (head.key === "bands") {
+      /*
+       * 動いている間の帯 (#1466)。 `- DB: 1..2` の形で、段の番号の区間を書く。
+       *
+       * 面ごとに 2 行以上書ける = 途中で手が空く面はそこで切れる。 書かない図は
+       * 組み立て器が「最初に関わった段から最後まで」 の 1 本にする。
+       */
+      const { items, next } = collectIndentedList(lines, i + 1, line.indent);
+      bands = [];
+      for (const it of items) {
+        // 一覧の読み手が先頭の `- ` を落とす形と落とさない形の両方を受ける
+        const m = it.trimmed.match(/^(?:-\s*)?(.+?)\s*:\s*(\d+)\s*\.\.\s*(\d+)\s*$/);
+        if (!m) {
+          errors.push({
+            line: it.no,
+            message: `帯の書き方が読めません: "${it.trimmed}"`,
+            hint: "use `- DB: 1..2` (面の名前と、段の番号の区間)",
+          });
+          continue;
+        }
+        bands.push({ actor: m[1]!, from: Number(m[2]), to: Number(m[3]) });
+      }
+      i = next;
+      continue;
+    }
     if (head.key === "lanes") {
       // lanes:\n  l1: { x: 0, width: 320, label: "..." }\n  l2: { ... }
       const { items, next } = collectIndentedList(lines, i + 1, line.indent);
@@ -880,6 +965,7 @@ export function parseTextDslV05(src: string): V05ParseResult {
       title: title!,
       type: type!,
       ...(eyebrow !== null ? { eyebrow, eyebrowPos: { line: eyebrowLine } } : {}),
+      ...(reveal !== null ? { reveal } : {}),
       ...(axes !== undefined ? { axes, axesPos: { line: axesLine } } : {}),
       actors,
       flow,
@@ -887,6 +973,7 @@ export function parseTextDslV05(src: string): V05ParseResult {
       ...(values.length > 0 ? { values } : {}),
       viewport,
       lanes: lanesMap,
+      ...(bands && bands.length > 0 ? { bands } : {}),
       readouts: readoutsList,
       inputs: inputsList,
       formulas: formulasList,
@@ -2376,6 +2463,11 @@ function applyContinuationLines(actor: DslActor, rest: Line[], errors: DslError[
       case "値":
         out.value = stripQuotes(raw);
         break;
+      // 前の時点の値 (#1450)。 内訳を帯で示す図と値 1 つを大きく示す図が読む
+      case "previous":
+      case "前の値":
+        out.previous = stripQuotes(raw);
+        break;
       case "shape":
       case "図形":
         out.shape = 図形として読む(raw, ln.no, errors);
@@ -2413,6 +2505,22 @@ function applyContinuationLines(actor: DslActor, rest: Line[], errors: DslError[
           .map((x) => stripQuotes(x.trim()))
           .filter(Boolean);
         break;
+      /*
+       * 行頭の印 (#1466)。 `rows` と同じ並びで、空文字はその行に印を付けない。
+       *
+       * **語の意味は図の種類が決める**。 ER は `pk` / `fk` / `opt`、状態遷移は
+       * `entry` / `exit` / `do` / `internal`。 印の 2 軸 (形 × 塗り) は共通だが、その軸が
+       * 何を指すかは種類ごとに違う = 1 つの語彙に畳むと、どの図でも意味が合わない語が残る。
+       *
+       * 空の要素を捨てない (`filter(Boolean)` を掛けない) = 並びが `rows` とずれる。
+       */
+      case "marks":
+      case "印":
+        out.marks = raw
+          .replace(/^\[|\]$/g, "")
+          .split(/,(?![^[]*\])/)
+          .map((x) => stripQuotes(x.trim()));
+        break;
       case "位置":
       case "pos": {
         // `位置: 300,200` の形。 posX と posY は両方揃わないと効かないので、 1 つの項目に
@@ -2572,8 +2680,14 @@ export const ACTOR_ITEM_KEYS: ReadonlySet<string> = new Set([
   "補足",
   "value",
   "値",
+  // 前の時点の値 (#1450)。 内訳の変化を帯で示す図と、値 1 つを大きく示す図が読む
+  "previous",
+  "前の値",
   "rows",
   "行",
+  // 行頭の印 (#1466)。 `rows` と同じ並びで、形 × 塗り の 2 軸を語で書く
+  "marks",
+  "印",
   // 箱の中に描く図形 (#1374)
   "shape",
   "図形",
@@ -2736,7 +2850,9 @@ const ACTOR_RESERVED_FIELDS: ReadonlySet<string> = new Set([
   "subtitle",
   "eyebrow",
   "value",
+  "previous",
   "rows",
+  "marks",
   "lane",
   "stack",
   "initial",
@@ -2888,7 +3004,9 @@ export const INLINE_ACTOR_ALIASES: Record<string, string> = {
   種類: "kind",
   補足: "subtitle",
   値: "value",
+  前の値: "previous",
   行: "rows",
+  印: "marks",
 };
 
 /** 中括弧に書かれた日本語の項目名を、同じ意味の英語名に寄せる (#1301) */
@@ -2910,7 +3028,9 @@ export const INLINE_ACTOR_KEYS: ReadonlySet<string> = new Set([
   "subtitle",
   "eyebrow",
   "value",
+  "previous",
   "rows",
+  "marks",
   "lane",
   "stack",
   "initial",
@@ -2973,6 +3093,33 @@ const FLOW_INLINE_READERS = {
     v !== undefined && (EDGE_SIDE_VALUES as readonly string[]).includes(v)
       ? (v as "top" | "right" | "bottom" | "left")
       : undefined,
+  // 矢印の先の形 (#1462)。 書かなければ描画側の既定 (塗った三角) になる
+  head: (v: string | undefined) =>
+    v !== undefined && EDGE_HEAD_VALUES.includes(v) ? (v as EdgeHead) : undefined,
+  // 出どころ側の端の形 (#1466)。 ER は端ごとに違う個数を示すので両端に要る
+  tailHead: (v: string | undefined) =>
+    v !== undefined && EDGE_HEAD_VALUES.includes(v) ? (v as EdgeHead) : undefined,
+  // 端の印の塗り (#1466)。 白抜きの菱が「持つ」、塗った菱が「抱える」
+  headFill: (v: string | undefined) =>
+    v !== undefined && EDGE_HEAD_FILL_VALUES.includes(v) ? (v as EdgeHeadFill) : undefined,
+  tailHeadFill: (v: string | undefined) =>
+    v !== undefined && EDGE_HEAD_FILL_VALUES.includes(v) ? (v as EdgeHeadFill) : undefined,
+  /*
+   * クラス図の関係の種類 (#1466)。 書くと **線と端の形と塗りと付く側** がまとめて決まる
+   * (`CLASS_RELATION_LOOK`)。
+   *
+   * 4 つを個別に書かせない = 組合せは 6 通りしか無く、1 つでも書き違えると読み手に別の意味で
+   * 伝わる (菱を逆に置くと持ち主が入れ替わる)。 種類で書けばその 6 通りから外れない。
+   */
+  relation: (v: string | undefined) =>
+    v !== undefined && CLASS_RELATION_VALUES.includes(v) ? (v as ClassRelationType) : undefined,
+  /*
+   * 順序図の言づての種類 (#1466)。 書くと線と矢の形がまとめて決まる。
+   *
+   * 呼ぶ (実線 + 塗った矢) / 返す (破線 + 開いた矢) / 投げる (実線 + 開いた矢) の 3 つ。
+   */
+  kind: (v: string | undefined) =>
+    v !== undefined && SEQ_MESSAGE_VALUES.includes(v) ? (v as SequenceMessageKind) : undefined,
   /*
    * 矢印を値に追随させる 3 欄 (#1396)。 箱の `wBind` (#1392) と同じく文字列だけを取る。
    *
@@ -3080,6 +3227,7 @@ function parseActor(line: Line, errors: DslError[]): DslActor | null {
       owner: isPart ? undefined : opts.owner,
       end: isPart ? undefined : opts.end,
       value: opts.value,
+      previous: opts.previous,
       rows: opts.rows
         ? opts.rows
             .replace(/^\[|\]$/g, "")
@@ -3087,6 +3235,13 @@ function parseActor(line: Line, errors: DslError[]): DslActor | null {
             .map((x) => stripQuotes(x.trim()))
             .filter(Boolean)
         : undefined,
+      // 行頭の印 (#1466)。 `rows` と同じ並びなので **空の要素を捨てない**
+      marks: opts.marks
+        ? opts.marks
+            .replace(/^\[|\]$/g, "")
+            .split(/,(?![^[]*\])/)
+            .map((x) => stripQuotes(x.trim()))
+        : undefined,
       lane: opts.lane,
       // 箱の中に描く図形 (#1374)。 パーツでは状態の上書きとして意味を持つため横取りしない
       shape:
@@ -3219,6 +3374,26 @@ function parseFlowStep(line: Line, no: number, errors: DslError[]): DslStep | nu
         hint: `使える値 = ${EDGE_SIDE_VALUES.join(", ")}`,
       });
     }
+    // 読めない語を黙って捨てない (#1462)。 捨てると「書いたのに端の形が変わらない」 が
+    // 手掛かりなしで起きる
+    // 読めない語を黙って捨てない (#1462 / #1466)。 捨てると「書いたのに見た目が変わらない」 が
+    // 手掛かりなしで起きる。 端の 3 欄と関係の種類を同じ形で見る
+    for (const [欄, 使える] of [
+      ["head", EDGE_HEAD_VALUES],
+      ["tailHead", EDGE_HEAD_VALUES],
+      ["headFill", EDGE_HEAD_FILL_VALUES],
+      ["tailHeadFill", EDGE_HEAD_FILL_VALUES],
+      ["relation", CLASS_RELATION_VALUES],
+      ["kind", SEQ_MESSAGE_VALUES],
+    ] as const) {
+      if (opts[欄] !== undefined && 中括弧[欄] === undefined) {
+        errors.push({
+          line: line.no,
+          message: `矢印の ${欄} が読めません: "${opts[欄]}"`,
+          hint: `使える値 = ${使える.join(", ")}`,
+        });
+      }
+    }
     数と真偽 = 表で読む(FLOW_INLINE_VALUE_KINDS, opts, "矢印の ", line.no, errors);
     rest = 塊.前.trim();
   }
@@ -3226,6 +3401,12 @@ function parseFlowStep(line: Line, no: number, errors: DslError[]): DslStep | nu
   const guard = 中括弧.guard as string | undefined;
   const cardinality = 中括弧.cardinality as string | undefined;
   const side = 中括弧.side as "top" | "right" | "bottom" | "left" | undefined;
+  const head = 中括弧.head as EdgeHead | undefined;
+  const tailHead = 中括弧.tailHead as EdgeHead | undefined;
+  const headFill = 中括弧.headFill as EdgeHeadFill | undefined;
+  const tailHeadFill = 中括弧.tailHeadFill as EdgeHeadFill | undefined;
+  const relation = 中括弧.relation as ClassRelationType | undefined;
+  const msgKind = 中括弧.kind as SequenceMessageKind | undefined;
   // 値に追随する 3 欄 (#1396)。 空は捨てずに知らせる = 描画側は空文字を既定値へ落とさず
   // そのまま置換に使うため、書き忘れが「線が消えた」 形で出る
   const widthBind = 追随する大きさとして読む(
@@ -3306,6 +3487,12 @@ function parseFlowStep(line: Line, no: number, errors: DslError[]): DslStep | nu
     guard,
     cardinality,
     side,
+    head,
+    tailHead,
+    headFill,
+    tailHeadFill,
+    relation,
+    msgKind,
     widthBind,
     strokeBind,
     dashOffsetBind,
@@ -3512,7 +3699,10 @@ function parsePhase(block: Line[], errors: DslError[]): DslPhase | null {
       continue;
     }
     if (key === "draw") {
-      const 語 = stripQuotes(value).trim();
+      // `draw: line 0.4` = 語の後ろに「描き終えるまでに段の何割を使うか」 を書ける (#1441)。
+      // 割合を別の項目にすると「割合だけ書いて `draw` が無い段」 が書けてしまい、
+      // 何も起きない指定になる。 同じ行なら書けない
+      const [語 = "", 割合の文字, ...余り] = stripQuotes(value).trim().split(/\s+/);
       // **読めない語を黙って捨てない** (#1304 / #1306 と同じ扱い)。 受ける語は 1 つだけで、
       // 書き間違いはその段が何も描かない形になって手掛かりが残らない
       if (!DRAW_WORDS.has(語)) {
@@ -3521,9 +3711,29 @@ function parsePhase(block: Line[], errors: DslError[]): DslPhase | null {
           message: `draw に書けない語です: "${語}"`,
           hint: `使える語 = ${[...DRAW_WORDS].join(", ")}`,
         });
+      } else if (余り.length > 0) {
+        errors.push({
+          line: ln.no,
+          message: `draw に書ける項目は語と割合の 2 つまでです: "${stripQuotes(value).trim()}"`,
+          hint: "use `draw: line 0.4`",
+        });
       } else {
         phase.draw = 語;
         phase.drawPos = { line: ln.no };
+        if (割合の文字 !== undefined) {
+          const 割合 = Number(割合の文字);
+          // 範囲外を黙って捨てない。 描画側は 1 に落として図を出すため、
+          // 知らせが無いと「書いたのに速さが変わらない」 が手掛かりなしで起きる
+          if (!Number.isFinite(割合) || 割合 <= 0 || 割合 > 1) {
+            errors.push({
+              line: ln.no,
+              message: `draw の割合が範囲外です: "${割合の文字}"`,
+              hint: "0 より大きく 1 以下で書きます (例 `draw: line 0.4`)",
+            });
+          } else {
+            phase.drawRatio = 割合;
+          }
+        }
       }
       i += 1;
       continue;