@phoenix-wing/kt-codegen 0.4.1

package/dist/KtCodegenRenderer.d.ts

@@ -0,0 +1,114 @@
+import { type KtCodegenBlockKey } from "./blocks/legacy-blocks.js";
+import type { KtCodegenArtifact, KtCodegenSnapshot } from "./api/contracts.js";
+import type { KtCodegenMarkerRegion } from "./KtCodegenMarker.js";
+import type { KtCodegenDiagnostic } from "./model/diagnostic.js";
+import type { KtCodegenPlatform, KtCodegenTargetId } from "./model/target.js";
+import type { KtCodegenParam } from "./KtCodegenParam.js";
+import type { KtCodegenItem } from "./KtCodegenItem.js";
+/** 单次目标生成所需的只读上下文。 */
+export interface KtCodegenRendererContext {
+    /** MVC-C 各层共享的参数数据；Renderer 只能消费，不能暗中修改。 */
+    readonly param: KtCodegenParam;
+    /** 本次要求 Renderer 处理的具体 CAA、Qt 或 C++ 目标。 */
+    readonly target: KtCodegenTargetId;
+    /** 本次允许生成或更新的旧自动代码块身份。 */
+    readonly blockKeys: readonly KtCodegenBlockKey[];
+    /** Analyze 开始时由宿主提供的只读源码快照。 */
+    readonly snapshot: KtCodegenSnapshot;
+    /** Core 已扫描并确认结构安全的旧自动代码标记区域。 */
+    readonly markerRegions: readonly KtCodegenMarkerRegion[];
+}
+/** 单个 Renderer 的生成结果。 */
+export interface KtCodegenRendererResult {
+    /** `ready` 表示所请求目标块均已实现；`scaffold` 表示仍含待迁移块。 */
+    readonly status: "ready" | "scaffold";
+    /** Renderer 产生的候选代码块；部分迁移的 scaffold 结果也可以包含。 */
+    readonly artifacts: readonly KtCodegenArtifact[];
+    /** 生成过程中产生的错误、警告和说明信息。 */
+    readonly diagnostics: readonly KtCodegenDiagnostic[];
+}
+/** 可注入 `KtCodegenRenderer` 的纯生成回调。 */
+export type KtCodegenRenderFunction = (context: KtCodegenRendererContext) => KtCodegenRendererResult;
+/** C++ Renderer 从 Core 注入的旧默认值表达式格式化函数。 */
+export type KtCodegenDefaultValueFormatter = (item: KtCodegenItem, addQuotation?: boolean) => string;
+/** CAA Renderer 从 Core 注入的旧参数列表分类函数。 */
+export type KtCodegenParamSpecListClassifier = (item: KtCodegenItem) => boolean;
+/** CAA Renderer 从 Core 注入的末尾单独大写字符解析函数。 */
+export type KtCodegenTrailingUppercaseResolver = (value: string | null | undefined) => string;
+/** CAA block 生成所需、由 Core 统一提供的已验证算法。 */
+export interface KtCodegenCaaAlgorithms {
+    /** 按旧顺序判断 Item 是否使用列表式参数读写。 */
+    readonly isParamSpecList: KtCodegenParamSpecListClassifier;
+    /** 按旧单位、字符串和分隔符规则格式化默认值。 */
+    readonly formatDefaultValue: KtCodegenDefaultValueFormatter;
+    /** 提取参数名末尾单独的大写字符，用于列表排序函数后缀。 */
+    readonly getLastStandaloneUppercase: KtCodegenTrailingUppercaseResolver;
+    /** 判断类型是否属于旧3D点、向量、方向或射线集合。 */
+    readonly isPointOrVector3DType: (dataType: string) => boolean;
+    /** 按旧大写边界规则生成 CAA 特征树显示标题。 */
+    readonly formatTreeName: (value: string) => string;
+    /** 判断 Item 是否属于旧 CAA 点、向量或方向类型。 */
+    readonly isCaaVector: (item: KtCodegenItem) => boolean;
+    /** 按旧 `GetCurrentSelectorList` 规则判断 Item 是否为 Dialog/Command Field。 */
+    readonly isSelectorField: (item: KtCodegenItem) => boolean;
+    /** 判断 Field 是否支持旧 Command 自动宏分支。 */
+    readonly isCommandAutoField: (item: KtCodegenItem) => boolean;
+    /** 从 Field 参数名推断旧 BuildGraph 建议选择过滤器。 */
+    readonly getCommandSuggestedFilter: (paramString: string) => string;
+}
+/** Qt 对话框生成所需、由 Core 注入的已验证类型算法。 */
+export interface KtCodegenQtAlgorithms {
+    /** 判断类型是否属于旧 Qt 更新逻辑识别的3D点、向量、方向或射线集合。 */
+    readonly isPointOrVector3DType: (dataType: string) => boolean;
+}
+/**
+ * 单一 Renderer 类型；不同生成目标通过元数据和 render 回调组合。
+ *
+ * Core 根据 `targets` 查找 Renderer，再把共享参数和源码快照作为只读上下文
+ * 传入。未提供回调时返回稳定的 scaffold 诊断，便于逐步迁移旧生成器。
+ */
+export declare class KtCodegenRenderer {
+    /** Renderer 的稳定身份，用于计划、诊断和宿主展示。 */
+    readonly id: string;
+    /** Renderer 所属的平台类别。 */
+    readonly platform: KtCodegenPlatform;
+    /** 此 Renderer 能处理的生成目标列表。 */
+    readonly targets: readonly KtCodegenTargetId[];
+    /** 实际生成回调；未提供时 Renderer 保持 scaffold 状态。 */
+    private readonly renderFunction;
+    /** 创建一个目标 Renderer，并可注入纯生成回调。 */
+    constructor(options: {
+        id: string;
+        platform: KtCodegenPlatform;
+        targets: readonly KtCodegenTargetId[];
+        render?: KtCodegenRenderFunction;
+    });
+    /**
+     * 创建已实现四个旧 Parameter block 的普通 C++ Renderer。
+     *
+     * 默认值格式化函数由 Core 注入，使 Renderer 能复用已验证算法，同时避免
+     * Renderer 模块反向导入 Core 形成循环依赖。
+     */
+    static createCppParameter(formatDefaultValue: KtCodegenDefaultValueFormatter): KtCodegenRenderer;
+    /**
+     * 创建逐步迁移 CAA block 的 Renderer。
+     *
+     * 当前实现 CAA 二十六个 block。列表、默认值、3D类型、树标题和大写后缀
+     * 算法由 Core 注入；仍含待迁移 block 的 CAA 目标继续返回 scaffold。
+     */
+    static createCaa(algorithms: KtCodegenCaaAlgorithms): KtCodegenRenderer;
+    /**
+     * 创建 Qt Dialog/Parameter 双向更新 Renderer。
+     *
+     * Renderer 只生成旧标记区域候选文本；3D类型判断由 Core 注入，不访问 UI
+     * 或文件系统，也不修改共享 Parameter/Item。
+     */
+    static createQt(algorithms: KtCodegenQtAlgorithms): KtCodegenRenderer;
+    /**
+     * 生成当前目标的候选 artifact 和诊断。
+     *
+     * 本方法不得写文件，也不得修改 `context.param` 或 `context.snapshot`。
+     */
+    render(context: KtCodegenRendererContext): KtCodegenRendererResult;
+}
+//# sourceMappingURL=KtCodegenRenderer.d.ts.map

package/dist/KtCodegenRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KtCodegenRenderer.d.ts","sourceRoot":"","sources":["../src/KtCodegenRenderer.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,iBAAiB,EACvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAkExD,sBAAsB;AACtB,MAAM,WAAW,wBAAwB;IACvC,4CAA4C;IAC5C,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAE/B,2CAA2C;IAC3C,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC,0BAA0B;IAC1B,QAAQ,CAAC,SAAS,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAEjD,+BAA+B;IAC/B,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IAErC,iCAAiC;IACjC,QAAQ,CAAC,aAAa,EAAE,SAAS,qBAAqB,EAAE,CAAC;CAC1D;AAED,yBAAyB;AACzB,MAAM,WAAW,uBAAuB;IACtC,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;IAEtC,gDAAgD;IAChD,QAAQ,CAAC,SAAS,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAEjD,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,EAAE,SAAS,mBAAmB,EAAE,CAAC;CACtD;AAED,sCAAsC;AACtC,MAAM,MAAM,uBAAuB,GAAG,CACpC,OAAO,EAAE,wBAAwB,KAC9B,uBAAuB,CAAC;AAE7B,2CAA2C;AAC3C,MAAM,MAAM,8BAA8B,GAAG,CAC3C,IAAI,EAAE,aAAa,EACnB,YAAY,CAAC,EAAE,OAAO,KACnB,MAAM,CAAC;AAEZ,wCAAwC;AACxC,MAAM,MAAM,gCAAgC,GAAG,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,CAAC;AAEhF,2CAA2C;AAC3C,MAAM,MAAM,kCAAkC,GAAG,CAC/C,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,KAC7B,MAAM,CAAC;AAEZ,wCAAwC;AACxC,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,QAAQ,CAAC,eAAe,EAAE,gCAAgC,CAAC;IAC3D,4BAA4B;IAC5B,QAAQ,CAAC,kBAAkB,EAAE,8BAA8B,CAAC;IAC5D,iCAAiC;IACjC,QAAQ,CAAC,0BAA0B,EAAE,kCAAkC,CAAC;IACxE,+BAA+B;IAC/B,QAAQ,CAAC,qBAAqB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IAC9D,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACnD,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,CAAC;IACvD,sEAAsE;IACtE,QAAQ,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,CAAC;IAC3D,oCAAoC;IACpC,QAAQ,CAAC,kBAAkB,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,CAAC;IAC9D,yCAAyC;IACzC,QAAQ,CAAC,yBAAyB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAC;CACrE;AAED,oCAAoC;AACpC,MAAM,WAAW,qBAAqB;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;CAC/D;AA6pDD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,mCAAmC;IACnC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAE3B,wBAAwB;IACxB,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,6BAA6B;IAC7B,SAAgB,OAAO,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAEtD,2CAA2C;IAC3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAsC;IAErE,iCAAiC;gBACrB,OAAO,EAAE;QACnB,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,iBAAiB,CAAC;QAC5B,OAAO,EAAE,SAAS,iBAAiB,EAAE,CAAC;QACtC,MAAM,CAAC,EAAE,uBAAuB,CAAC;KAClC;IAOD;;;;;OAKG;WACW,kBAAkB,CAC9B,kBAAkB,EAAE,8BAA8B,GACjD,iBAAiB;IASpB;;;;;OAKG;WACW,SAAS,CAAC,UAAU,EAAE,sBAAsB,GAAG,iBAAiB;IAgB9E;;;;;OAKG;WACW,QAAQ,CAAC,UAAU,EAAE,qBAAqB,GAAG,iBAAiB;IAS5E;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,uBAAuB;CAenE"}