wikiparser-node 1.7.0-beta.3 → 1.7.0

package/dist/src/table/base.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableBaseToken = void 0;
+const debug_1 = require("../../util/debug");
+const constants_1 = require("../../util/constants");
+const attributesParent_1 = require("../../mixin/attributesParent");
+const index_1 = require("../../index");
+const index_2 = require("../index");
+const syntax_1 = require("../syntax");
+const attributes_1 = require("../attributes");
+/* NOT FOR BROWSER */
+/**
+ * 转义表格语法
+ * @param syntax 表格语法节点
+ */
+const escapeTable = (syntax) => {
+    const wikitext = syntax.childNodes.map(child => child.type === 'text'
+        ? child.data.replace(/\|/gu, '{{!}}')
+        : String(child)).join(''), { childNodes } = index_1.default.parse(wikitext, syntax.getAttribute('include'), 2, syntax.getAttribute('config'));
+    syntax.replaceChildren(...childNodes);
+};
+/**
+ * 表格行，含开头的换行，不含结尾的换行
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ...Token]}`
+ */
+class TableBaseToken extends (0, attributesParent_1.attributesParent)(1)(index_2.Token) {
+    /* NOT FOR BROWSER END */
+    /**
+     * @param pattern 表格语法正则
+     * @param syntax 表格语法
+     * @param attr 表格属性
+     */
+    constructor(pattern, syntax, attr, config = index_1.default.getConfig(), accum = [], acceptable = {}) {
+        super(undefined, config, accum, acceptable);
+        this.append(new syntax_1.SyntaxToken(syntax, pattern, 'table-syntax', config, accum, {
+            'Stage-1': ':', '!ExtToken': '', TranscludeToken: ':',
+        }), 
+        // @ts-expect-error abstract class
+        new attributes_1.AttributesToken(attr, 'table-attrs', this.type, config, accum));
+        /* NOT FOR BROWSER */
+        this.protectChildren(0, 1);
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const [syntax, attr, ...cloned] = this.cloneChildNodes();
+        return debug_1.Shadow.run(() => {
+            const { constructor } = this, token = new constructor(undefined, undefined, this.getAttribute('config'));
+            token.firstChild.safeReplaceWith(syntax);
+            token.childNodes[1].safeReplaceWith(attr);
+            if (token.type === 'td') { // TdToken
+                token.childNodes[2].safeReplaceWith(cloned[0]);
+            }
+            else {
+                token.append(...cloned);
+            }
+            return token;
+        });
+    }
+    /** 转义表格语法 */
+    escape() {
+        for (const child of this.childNodes) {
+            if (child instanceof syntax_1.SyntaxToken) {
+                escapeTable(child);
+            }
+            else if (child instanceof TableBaseToken) {
+                child.escape();
+            }
+        }
+    }
+    /** @private */
+    setSyntax(syntax, esc) {
+        const { firstChild } = this;
+        firstChild.replaceChildren(syntax);
+        if (esc) {
+            escapeTable(firstChild);
+        }
+    }
+}
+exports.TableBaseToken = TableBaseToken;
+constants_1.classes['TableBaseToken'] = __filename;

package/dist/src/table/index.d.ts

@@ -0,0 +1,242 @@
+import Parser from '../../index';
+import { TrBaseToken } from './trBase';
+import { SyntaxToken } from '../syntax';
+import type { LintError, AST } from '../../base';
+import type { SyntaxBase } from '../../mixin/syntax';
+import type { AttributesToken, TdToken, TrToken, Token } from '../../internal';
+import type { TableCoords } from './trBase';
+import type { TdAttrs, TdSubtypes, TdSpanAttrs } from './td';
+export interface TableRenderedCoords {
+    readonly row?: undefined;
+    readonly column?: undefined;
+    readonly x: number;
+    readonly y: number;
+}
+export interface TableToken extends SyntaxBase {
+}
+/**
+ * 是否是行尾
+ * @param {Token} cell 表格单元格
+ */
+export declare const isRowEnd: ({ type }: Token) => boolean;
+/** @extends {Array<TableCoords[]>} */
+export declare class Layout extends Array<TableCoords[]> {
+    /** 打印表格布局 */
+    print(): void;
+}
+/**
+ * 表格
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken, ...TrToken, ?SyntaxToken]}`
+ */
+export declare abstract class TableToken extends TrBaseToken {
+    readonly type = "table";
+    readonly childNodes: readonly [SyntaxToken, AttributesToken, ...(TdToken | TrToken)[], SyntaxToken] | readonly [SyntaxToken, AttributesToken, ...(TdToken | TrToken)[]];
+    abstract get lastChild(): AttributesToken | TdToken | TrToken | SyntaxToken;
+    abstract get children(): [SyntaxToken, AttributesToken, ...(TdToken | TrToken)[], SyntaxToken] | [SyntaxToken, AttributesToken, ...(TdToken | TrToken)[]];
+    abstract get lastElementChild(): AttributesToken | TdToken | TrToken | SyntaxToken;
+    /** 表格是否闭合 */
+    get closed(): boolean;
+    set closed(closed: boolean);
+    /**
+     * @param syntax 表格语法
+     * @param attr 表格属性
+     */
+    constructor(syntax: string, attr?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    lint(start?: number, re?: RegExp): LintError[];
+    /**
+     * 闭合表格语法
+     * @param syntax 表格结尾语法
+     * @param halfParsed
+     */
+    close(syntax?: string, halfParsed?: boolean): void;
+    /**
+     * 获取表格布局
+     * @param stop 中止条件
+     * @param stop.row 中止行
+     * @param stop.column 中止列
+     * @param stop.x 中止行
+     * @param stop.y 中止列
+     */
+    getLayout(stop?: {
+        row?: number;
+        column?: number;
+        x?: number;
+        y?: number;
+    }): Layout;
+    /** 获取所有行 */
+    getAllRows(): (TrToken | this)[];
+    /**
+     * 获取指定坐标的单元格
+     * @param coords 表格坐标
+     */
+    getNthCell(coords: TableCoords | TableRenderedCoords): TdToken | undefined;
+    /**
+     * 获取第n行
+     * @param n 行号
+     * @param force 是否将表格自身视为第一行
+     * @param insert 是否用于判断插入新行的位置
+     * @throws `RangeError` 不存在该行
+     */
+    getNthRow(n: number, force?: boolean, insert?: false): TrToken | this | undefined;
+    getNthRow(n: number, force: boolean, insert: true): TrToken | this | SyntaxToken | undefined;
+    /** @override */
+    json(): AST;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     * @throws `SyntaxError` 表格的闭合部分非法
+     */
+    insertAt<T extends Token>(token: T, i?: number): T;
+    /** @override */
+    getRowCount(): number;
+    /** 获取下一行 */
+    getNextRow(): TrToken | undefined;
+    /** 打印表格布局 */
+    printLayout(): void;
+    /**
+     * 转换为渲染后的表格坐标
+     * @param {TableCoords} coord wikitext中的表格坐标
+     */
+    toRenderedCoords(coord: TableCoords): TableRenderedCoords | undefined;
+    /**
+     * 转换为wikitext中的表格坐标
+     * @param {TableRenderedCoords} coord 渲染后的表格坐标
+     */
+    toRawCoords(coord: TableRenderedCoords): TableCoords | undefined;
+    /**
+     * 获取完整行
+     * @param y 行号
+     */
+    getFullRow(y: number): Map<TdToken, boolean>;
+    /**
+     * 获取完整列
+     * @param x 列号
+     */
+    getFullCol(x: number): Map<TdToken, boolean>;
+    /**
+     * 设置行格式
+     * @param y 行号
+     * @param attr 表格属性
+     * @param multiRow 是否对所有单元格设置，或是仅对行首单元格设置
+     */
+    formatTableRow(y: number, attr?: TdAttrs | string, multiRow?: boolean): void;
+    /**
+     * 设置列格式
+     * @param x 列号
+     * @param attr 表格属性
+     * @param multiCol 是否对所有单元格设置，或是仅对行首单元格设置
+     */
+    formatTableCol(x: number, attr?: TdAttrs | string, multiCol?: boolean): void;
+    /**
+     * 填补表格行
+     * @param y 行号
+     * @param inner 填充内容
+     * @param subtype 单元格类型
+     * @param attr 表格属性
+     */
+    fillTableRow(y: number, inner: string | Token, subtype?: TdSubtypes, attr?: TdAttrs): void;
+    /**
+     * 填补表格
+     * @param inner 填充内容
+     * @param subtype 单元格类型
+     * @param attr 表格属性
+     */
+    fillTable(inner: string | Token, subtype?: TdSubtypes, attr?: TdAttrs): void;
+    /**
+     * @override
+     * @param inner 单元格内部wikitext
+     * @param coords 单元格坐标
+     * @param subtype 单元格类型
+     * @param attr 单元格属性
+     * @throws `RangeError` 指定的坐标不是单元格起始点
+     */
+    insertTableCell(inner: string | Token, coords: TableCoords | TableRenderedCoords, subtype?: TdSubtypes, attr?: TdAttrs): TdToken;
+    /**
+     * 插入表格行
+     * @param y 行号
+     * @param attr 表格行属性
+     * @param inner 内部wikitext
+     * @param subtype 单元格类型
+     * @param innerAttr 单元格属性
+     */
+    insertTableRow(y: number, attr?: Record<string, string | true>, inner?: string | Token, subtype?: TdSubtypes, innerAttr?: TdAttrs): TrToken;
+    /**
+     * 插入表格列
+     * @param x 列号
+     * @param inner 内部wikitext
+     * @param subtype 单元格类型
+     * @param attr 单元格属性
+     * @throws `RangeError` 列号过大
+     */
+    insertTableCol(x: number, inner: string | Token, subtype?: TdSubtypes, attr?: TdAttrs): void;
+    /**
+     * 移除表格行
+     * @param y 行号
+     */
+    removeTableRow(y: number): TrToken;
+    /**
+     * 移除表格列
+     * @param x 列号
+     */
+    removeTableCol(x: number): void;
+    /**
+     * 合并单元格
+     * @param xlim 列范围
+     * @param ylim 行范围
+     * @throws `RangeError` 待合并区域与外侧区域有重叠
+     */
+    mergeCells(xlim: readonly [number, number], ylim: readonly [number, number]): TdToken;
+    /**
+     * 分裂成多行
+     * @param coords 单元格坐标
+     */
+    splitIntoRows(coords: TableCoords | TableRenderedCoords): void;
+    /**
+     * 分裂成多列
+     * @param coords 单元格坐标
+     */
+    splitIntoCols(coords: TableCoords | TableRenderedCoords): void;
+    /**
+     * 分裂成单元格
+     * @param coords 单元格坐标
+     */
+    splitIntoCells(coords: TableCoords | TableRenderedCoords): void;
+    /**
+     * 复制一行并插入该行之前
+     * @param row 行号
+     */
+    replicateTableRow(row: number): TrToken;
+    /**
+     * 复制一列并插入该列之前
+     * @param x 列号
+     */
+    replicateTableCol(x: number): TdToken[];
+    /**
+     * 移动表格行
+     * @param y 行号
+     * @param before 新位置
+     * @throws `RangeError` 无法移动
+     */
+    moveTableRowBefore(y: number, before: number): TrToken;
+    /**
+     * 移动表格行
+     * @param y 行号
+     * @param after 新位置
+     * @throws `RangeError` 无法移动
+     */
+    moveTableRowAfter(y: number, after: number): TrToken;
+    /**
+     * 移动表格列
+     * @param x 列号
+     * @param before 新位置
+     */
+    moveTableColBefore(x: number, before: number): void;
+    /**
+     * 移动表格列
+     * @param x 列号
+     * @param after 新位置
+     */
+    moveTableColAfter(x: number, after: number): void;
+}