wikiparser-node 1.4.2-b → 1.4.2

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

@@ -0,0 +1,230 @@
+import Parser from '../../index';
+import { TrBaseToken } from './trBase';
+import { SyntaxToken } from '../syntax';
+import type { LintError } from '../../base';
+import type { AttributesToken, TdToken, TrToken, Token } from '../../internal';
+import type { TableCoords } from './trBase';
+import type { TdAttrs, TdSubtypes, TdSpanAttrs } from './td';
+import type { Layout } from '../../addon/table';
+export interface TableRenderedCoords {
+    readonly row?: undefined;
+    readonly column?: undefined;
+    readonly x: number;
+    readonly y: number;
+}
+/**
+ * 表格
+ * @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 children(): [SyntaxToken, AttributesToken, ...(TdToken | TrToken)[], SyntaxToken] | [SyntaxToken, AttributesToken, ...(TdToken | TrToken)[]];
+    abstract get lastChild(): AttributesToken | TdToken | TrToken | SyntaxToken;
+    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): LintError[];
+    /**
+     * 闭合表格语法
+     * @param syntax 表格结尾语法
+     * @param halfParsed
+     */
+    close(syntax?: string, halfParsed?: boolean): void;
+    /** @override */
+    json(): object;
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     * @throws `SyntaxError` 表格的闭合部分非法
+     */
+    insertAt<T extends Token>(token: T, i?: number): T;
+    /** @override */
+    getRowCount(): number;
+    /** 获取下一行 */
+    getNextRow(): TrToken | 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;
+    /** 获取所有行 */
+    getAllRows(): (TrToken | this)[];
+    /**
+     * 获取指定坐标的单元格
+     * @param coords 表格坐标
+     */
+    getNthCell(coords: TableCoords | TableRenderedCoords): TdToken | undefined;
+    /**
+     * 获取表格布局
+     * @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;
+    /** 打印表格布局 */
+    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;
+}

package/dist/src/table/index.js

@@ -0,0 +1,390 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableToken = void 0;
+const lint_1 = require("../../util/lint");
+const debug_1 = require("../../util/debug");
+const string_1 = require("../../util/string");
+const constants_1 = require("../../util/constants");
+const index_1 = require("../../index");
+const trBase_1 = require("./trBase");
+const syntax_1 = require("../syntax");
+/* NOT FOR BROWSER END */
+const closingPattern = /^\n[^\S\n]*(?:\|\}|\{\{\s*!\s*\}\}\}|\{\{\s*!\)\s*\}\})$/u;
+/**
+ * 表格
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken, ...TrToken, ?SyntaxToken]}`
+ */
+class TableToken extends trBase_1.TrBaseToken {
+    type = 'table';
+    /** 表格是否闭合 */
+    get closed() {
+        return this.lastChild.type === 'table-syntax';
+    }
+    /* NOT FOR BROWSER */
+    set closed(closed) {
+        if (closed && !this.closed) {
+            this.close(this.closest('parameter-value') ? '\n{{!}}}' : '\n|}');
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param syntax 表格语法
+     * @param attr 表格属性
+     */
+    constructor(syntax, attr, config = index_1.default.getConfig(), accum = []) {
+        super(/^(?:\{\||\{\{\{\s*!\s*\}\}|\{\{\s*\(!\s*\}\})$/u, syntax, attr, config, accum, {
+            Token: 2, SyntaxToken: [0, -1], AttributesToken: 1, TdToken: '2:', TrToken: '2:',
+        });
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start);
+        if (!this.closed) {
+            errors.push((0, lint_1.generateForChild)(this.firstChild, { start }, index_1.default.msg('unclosed $1', 'table')));
+        }
+        return errors;
+    }
+    /**
+     * 闭合表格语法
+     * @param syntax 表格结尾语法
+     * @param halfParsed
+     */
+    close(syntax = '\n|}', halfParsed = false) {
+        const config = this.getAttribute('config'), accum = this.getAttribute('accum'), inner = halfParsed ? [syntax] : index_1.default.parse(syntax, this.getAttribute('include'), 2, config).childNodes;
+        /* NOT FOR BROWSER */
+        if (this.lastChild.type !== 'table-syntax') {
+            /* NOT FOR BROWSER END */
+            const token = debug_1.Shadow.run(() => super.insertAt(new syntax_1.SyntaxToken(undefined, closingPattern, 'table-syntax', config, accum, {
+                'Stage-1': ':', '!ExtToken': '', TranscludeToken: ':',
+            })));
+            /* NOT FOR BROWSER */
+            if (!halfParsed) {
+                token.afterBuild();
+            }
+            /* NOT FOR BROWSER END */
+        }
+        this.lastChild.replaceChildren(...inner);
+    }
+    /** @override */
+    json() {
+        return {
+            ...super.json(),
+            closed: this.closed,
+        };
+    }
+    /* NOT FOR BROWSER */
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     * @throws `SyntaxError` 表格的闭合部分非法
+     */
+    insertAt(token, i = this.length) {
+        i += i < 0 ? this.length : 0;
+        const previous = this.childNodes[i - 1];
+        if (typeof token !== 'string' && token.type === 'td' && previous?.type === 'tr') {
+            index_1.default.warn('改为将单元格插入当前行。');
+            return previous.insertAt(token);
+        }
+        else if (i > 0 && token instanceof syntax_1.SyntaxToken && token.getAttribute('pattern') !== closingPattern) {
+            throw new SyntaxError(`表格的闭合部分不符合语法：${(0, string_1.noWrap)(String(token))}`);
+        }
+        return super.insertAt(token, i);
+    }
+    /** @override */
+    getRowCount() {
+        return super.getRowCount() + this.childNodes.filter(child => child.type === 'tr' && child.getRowCount()).length;
+    }
+    /** 获取下一行 */
+    getNextRow() {
+        return this.getNthRow(super.getRowCount() ? 1 : 0, false, false);
+    }
+    getNthRow(n, force = false, insert = false) {
+        const nRows = this.getRowCount(), isRow = super.getRowCount();
+        n += n < 0 ? nRows : 0;
+        if (n === 0 && (isRow || force && nRows === 0)) {
+            return this;
+        }
+        else if (n < 0 || n > nRows || n === nRows && !insert) {
+            throw new RangeError(`不存在第 ${n} 行！`);
+        }
+        else if (isRow) {
+            n--;
+        }
+        for (const child of this.childNodes.slice(2)) {
+            if (child.type === 'tr' && child.getRowCount()) {
+                n--;
+                if (n < 0) {
+                    return child;
+                }
+            }
+            else if (child.type === 'table-syntax') {
+                return child;
+            }
+        }
+        return undefined;
+    }
+    /** 获取所有行 */
+    getAllRows() {
+        return [
+            ...super.getRowCount() ? [this] : [],
+            ...this.childNodes.slice(1)
+                .filter((child) => child.type === 'tr' && child.getRowCount() > 0),
+        ];
+    }
+    /**
+     * 获取指定坐标的单元格
+     * @param coords 表格坐标
+     */
+    getNthCell(coords) {
+        require('../../addon/table');
+        return this.getNthCell(coords);
+    }
+    /**
+     * 获取表格布局
+     * @param stop 中止条件
+     * @param stop.row 中止行
+     * @param stop.column 中止列
+     * @param stop.x 中止行
+     * @param stop.y 中止列
+     */
+    getLayout(stop) {
+        require('../../addon/table');
+        return this.getLayout(stop);
+    }
+    /** 打印表格布局 */
+    printLayout() {
+        require('../../addon/table');
+        this.printLayout();
+    }
+    /**
+     * 转换为渲染后的表格坐标
+     * @param {TableCoords} coord wikitext中的表格坐标
+     */
+    toRenderedCoords(coord) {
+        require('../../addon/table');
+        return this.toRenderedCoords(coord);
+    }
+    /**
+     * 转换为wikitext中的表格坐标
+     * @param {TableRenderedCoords} coord 渲染后的表格坐标
+     */
+    toRawCoords(coord) {
+        require('../../addon/table');
+        return this.toRawCoords(coord);
+    }
+    /**
+     * 获取完整行
+     * @param y 行号
+     */
+    getFullRow(y) {
+        require('../../addon/table');
+        return this.getFullRow(y);
+    }
+    /**
+     * 获取完整列
+     * @param x 列号
+     */
+    getFullCol(x) {
+        require('../../addon/table');
+        return this.getFullCol(x);
+    }
+    /**
+     * 设置行格式
+     * @param y 行号
+     * @param attr 表格属性
+     * @param multiRow 是否对所有单元格设置，或是仅对行首单元格设置
+     */
+    formatTableRow(y, attr = {}, multiRow = false) {
+        require('../../addon/table');
+        this.formatTableRow(y, attr, multiRow);
+    }
+    /**
+     * 设置列格式
+     * @param x 列号
+     * @param attr 表格属性
+     * @param multiCol 是否对所有单元格设置，或是仅对行首单元格设置
+     */
+    formatTableCol(x, attr = {}, multiCol = false) {
+        require('../../addon/table');
+        this.formatTableCol(x, attr, multiCol);
+    }
+    /**
+     * 填补表格行
+     * @param y 行号
+     * @param inner 填充内容
+     * @param subtype 单元格类型
+     * @param attr 表格属性
+     */
+    fillTableRow(y, inner, subtype = 'td', attr = {}) {
+        require('../../addon/table');
+        this.fillTableRow(y, inner, subtype, attr);
+    }
+    /**
+     * 填补表格
+     * @param inner 填充内容
+     * @param subtype 单元格类型
+     * @param attr 表格属性
+     */
+    fillTable(inner, subtype = 'td', attr = {}) {
+        require('../../addon/table');
+        this.fillTable(inner, subtype, attr);
+    }
+    /**
+     * @override
+     * @param inner 单元格内部wikitext
+     * @param coords 单元格坐标
+     * @param subtype 单元格类型
+     * @param attr 单元格属性
+     * @throws `RangeError` 指定的坐标不是单元格起始点
+     */
+    insertTableCell(inner, coords, subtype = 'td', attr = {}) {
+        require('../../addon/table');
+        return this.insertTableCell(inner, coords, subtype, attr);
+    }
+    /** @private */
+    prependTableRow() {
+        require('../../addon/table');
+        return this.prependTableRow();
+    }
+    /**
+     * 插入表格行
+     * @param y 行号
+     * @param attr 表格行属性
+     * @param inner 内部wikitext
+     * @param subtype 单元格类型
+     * @param innerAttr 单元格属性
+     */
+    insertTableRow(y, attr = {}, inner, subtype = 'td', innerAttr = {}) {
+        require('../../addon/table');
+        return this.insertTableRow(y, attr, inner, subtype, innerAttr);
+    }
+    /**
+     * 插入表格列
+     * @param x 列号
+     * @param inner 内部wikitext
+     * @param subtype 单元格类型
+     * @param attr 单元格属性
+     * @throws `RangeError` 列号过大
+     */
+    insertTableCol(x, inner, subtype = 'td', attr = {}) {
+        require('../../addon/table');
+        this.insertTableCol(x, inner, subtype, attr);
+    }
+    /**
+     * 移除表格行
+     * @param y 行号
+     */
+    removeTableRow(y) {
+        require('../../addon/table');
+        return this.removeTableRow(y);
+    }
+    /**
+     * 移除表格列
+     * @param x 列号
+     */
+    removeTableCol(x) {
+        require('../../addon/table');
+        this.removeTableCol(x);
+    }
+    /**
+     * 合并单元格
+     * @param xlim 列范围
+     * @param ylim 行范围
+     * @throws `RangeError` 待合并区域与外侧区域有重叠
+     */
+    mergeCells(xlim, ylim) {
+        require('../../addon/table');
+        return this.mergeCells(xlim, ylim);
+    }
+    /** @private */
+    split(coords, dirs) {
+        require('../../addon/table');
+        this.split(coords, dirs);
+    }
+    /**
+     * 分裂成多行
+     * @param coords 单元格坐标
+     */
+    splitIntoRows(coords) {
+        require('../../addon/table');
+        this.splitIntoRows(coords);
+    }
+    /**
+     * 分裂成多列
+     * @param coords 单元格坐标
+     */
+    splitIntoCols(coords) {
+        require('../../addon/table');
+        this.splitIntoCols(coords);
+    }
+    /**
+     * 分裂成单元格
+     * @param coords 单元格坐标
+     */
+    splitIntoCells(coords) {
+        require('../../addon/table');
+        this.splitIntoCells(coords);
+    }
+    /**
+     * 复制一行并插入该行之前
+     * @param row 行号
+     */
+    replicateTableRow(row) {
+        require('../../addon/table');
+        return this.replicateTableRow(row);
+    }
+    /**
+     * 复制一列并插入该列之前
+     * @param x 列号
+     */
+    replicateTableCol(x) {
+        require('../../addon/table');
+        return this.replicateTableCol(x);
+    }
+    /** @private */
+    moveCol(x, reference, after) {
+        require('../../addon/table');
+        this.moveCol(x, reference, after);
+    }
+    /**
+     * 移动表格行
+     * @param y 行号
+     * @param before 新位置
+     * @throws `RangeError` 无法移动
+     */
+    moveTableRowBefore(y, before) {
+        require('../../addon/table');
+        return this.moveTableRowBefore(y, before);
+    }
+    /**
+     * 移动表格行
+     * @param y 行号
+     * @param after 新位置
+     * @throws `RangeError` 无法移动
+     */
+    moveTableRowAfter(y, after) {
+        require('../../addon/table');
+        return this.moveTableRowAfter(y, after);
+    }
+    /**
+     * 移动表格列
+     * @param x 列号
+     * @param before 新位置
+     */
+    moveTableColBefore(x, before) {
+        require('../../addon/table');
+        this.moveTableColBefore(x, before);
+    }
+    /**
+     * 移动表格列
+     * @param x 列号
+     * @param after 新位置
+     */
+    moveTableColAfter(x, after) {
+        require('../../addon/table');
+        this.moveTableColAfter(x, after);
+    }
+}
+exports.TableToken = TableToken;
+constants_1.classes['TableToken'] = __filename;

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

@@ -0,0 +1,88 @@
+import Parser from '../../index';
+import { Token } from '../index';
+import { TableBaseToken } from './base';
+import type { LintError } from '../../base';
+import type { SyntaxToken, AttributesToken, TrToken, TableToken } from '../../internal';
+export type TdSubtypes = 'td' | 'th' | 'caption';
+export interface TdSpanAttrs {
+    rowspan?: number;
+    colspan?: number;
+}
+declare type TdAttrGetter<T extends string> = T extends keyof TdSpanAttrs ? number : string | true | undefined;
+declare type TdAttrSetter<T extends string> = T extends keyof TdSpanAttrs ? number : string | boolean;
+export type TdAttrs = Record<string, string | true> & TdSpanAttrs;
+export declare abstract class TdToken extends TableBaseToken {
+    #private;
+    readonly type = "td";
+    readonly childNodes: readonly [SyntaxToken, AttributesToken, Token];
+    abstract get children(): [SyntaxToken, AttributesToken, Token];
+    abstract get parentNode(): TrToken | TableToken | undefined;
+    abstract get parentElement(): TrToken | TableToken | undefined;
+    abstract get nextSibling(): this | TrToken | SyntaxToken | undefined;
+    abstract get nextElementSibling(): this | TrToken | SyntaxToken | undefined;
+    abstract get previousSibling(): Token | undefined;
+    /** 单元格类型 */
+    get subtype(): TdSubtypes;
+    set subtype(subtype: TdSubtypes);
+    /** rowspan */
+    get rowspan(): number;
+    set rowspan(rowspan: number);
+    /** colspan */
+    get colspan(): number;
+    set colspan(colspan: number);
+    /** 内部wikitext */
+    get innerText(): string;
+    set innerText(text: string);
+    /**
+     * @param syntax 单元格语法
+     * @param inner 内部wikitext
+     */
+    constructor(syntax: string, inner?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    print(): string;
+    /** @override */
+    json(): object;
+    /** 是否位于行首 */
+    isIndependent(): boolean;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * @override
+     * @param syntax 表格语法
+     * @param esc 是否需要转义
+     */
+    setSyntax(syntax: string, esc?: boolean): void;
+    /** 改为独占一行 */
+    independence(): void;
+    /**
+     * @override
+     * @param key 属性键
+     */
+    getAttr<T extends string>(key: T): TdAttrGetter<T>;
+    /** @override */
+    getAttrs(): TdAttrs;
+    /**
+     * @override
+     * @param key 属性键
+     * @param value 属性值
+     * @param prop 属性对象
+     */
+    setAttr<T extends string>(key: T, value: TdAttrSetter<T>): void;
+    setAttr(prop: Record<string, string | number | boolean>): void;
+    /** @override */
+    escape(): void;
+}
+/**
+ * 创建新的单元格
+ * @param inner 内部wikitext
+ * @param subtype 单元格类型
+ * @param attr 单元格属性
+ * @param include 是否嵌入
+ * @param config
+ */
+export declare const createTd: (inner: string | Token, subtype?: TdSubtypes, attr?: TdAttrs, include?: boolean, config?: Parser.Config) => TdToken;
+export {};