wikiparser-node 0.9.2-b → 0.10.0

package/src/extLink.js

@@ -0,0 +1,180 @@
+'use strict';
+
+const Parser = require('..'),
+	{noWrap, normalizeSpace} = require('../util/string'),
+	Token = require('.'),
+	MagicLinkToken = require('./magicLink');
+
+/**
+ * 外链
+ * @classdesc `{childNodes: [MagicLinkToken, ?Token]}`
+ */
+class ExtLinkToken extends Token {
+	type = 'ext-link';
+	#space;
+
+	/**
+	 * 协议
+	 * @this {{firstChild: MagicLinkToken}}
+	 */
+	get protocol() {
+		return this.firstChild.protocol;
+	}
+
+	/** @this {{firstChild: MagicLinkToken}} */
+	set protocol(value) {
+		this.firstChild.protocol = value;
+	}
+
+	/**
+	 * 和内链保持一致
+	 * @this {{firstChild: MagicLinkToken}}
+	 */
+	get link() {
+		return this.firstChild.link;
+	}
+
+	set link(url) {
+		this.setTarget(url);
+	}
+
+	/** 链接显示文字 */
+	get innerText() {
+		return this.length > 1
+			? this.lastChild.text()
+			: `[${this.getRootNode().querySelectorAll('ext-link[childElementCount=1]').indexOf(this) + 1}]`;
+	}
+
+	/**
+	 * @param {string} url 网址
+	 * @param {string} space 空白字符
+	 * @param {string} text 链接文字
+	 * @param {accum} accum
+	 */
+	constructor(url, space = '', text = '', config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true, accum, {
+			MagicLinkToken: 0, Token: 1,
+		});
+		this.insertAt(new MagicLinkToken(url, true, config, accum));
+		this.#space = space;
+		if (text) {
+			const inner = new Token(text, config, true, accum, {
+				'Stage-7': ':', ConverterToken: ':',
+			});
+			inner.type = 'ext-link-text';
+			this.insertAt(inner.setAttribute('stage', Parser.MAX_STAGE - 1));
+		}
+		this.getAttribute('protectChildren')(0);
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		if (selector && this.matches(selector)) {
+			return '';
+		} else if (this.length === 1) {
+			return `[${super.toString(selector)}${this.#space}]`;
+		}
+		this.#correct();
+		normalizeSpace(this.lastChild);
+		return `[${super.toString(selector, this.#space)}]`;
+	}
+
+	/** @override */
+	text() {
+		normalizeSpace(this.childNodes[1]);
+		return `[${super.text(' ')}]`;
+	}
+
+	/** @override */
+	getPadding() {
+		return 1;
+	}
+
+	/** @override */
+	getGaps() {
+		this.#correct();
+		return this.#space.length;
+	}
+
+	/** @override */
+	print() {
+		return super.print(
+			this.length > 1 ? {pre: '[', sep: this.#space, post: ']'} : {pre: '[', post: `${this.#space}]`},
+		);
+	}
+
+	/** @override */
+	cloneNode() {
+		const [url, text] = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new ExtLinkToken(undefined, '', '', this.getAttribute('config'));
+			token.firstChild.safeReplaceWith(url);
+			if (text) {
+				token.insertAt(text);
+			}
+			return token;
+		});
+	}
+
+	/** 修正空白字符 */
+	#correct() {
+		if (!this.#space && this.length > 1
+			// 都替换成`<`肯定不对，但无妨
+			&& /^[^[\]<>"{\0-\x1F\x7F\p{Zs}\uFFFD]/u.test(this.lastChild.text().replace(/&[lg]t;/u, '<'))
+		) {
+			this.#space = ' ';
+		}
+	}
+
+	/**
+	 * 获取网址
+	 * @this {{firstChild: MagicLinkToken}}
+	 */
+	getUrl() {
+		return this.firstChild.getUrl();
+	}
+
+	/**
+	 * 设置链接目标
+	 * @param {string|URL} url 网址
+	 * @throws `SyntaxError` 非法的外链目标
+	 */
+	setTarget(url) {
+		url = String(url);
+		const root = Parser.parse(`[${url}]`, this.getAttribute('include'), 8, this.getAttribute('config')),
+			{length, firstChild: extLink} = root;
+		if (length !== 1 || extLink.type !== 'ext-link' || extLink.length !== 1) {
+			throw new SyntaxError(`非法的外链目标：${url}`);
+		}
+		const {firstChild} = extLink;
+		extLink.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
+	}
+
+	/**
+	 * 设置链接显示文字
+	 * @param {string} text 链接显示文字
+	 * @throws `SyntaxError` 非法的链接显示文字
+	 */
+	setLinkText(text) {
+		text = String(text);
+		const root = Parser.parse(`[//url ${text}]`, this.getAttribute('include'), 8, this.getAttribute('config')),
+			{length, firstChild: extLink} = root;
+		if (length !== 1 || extLink.type !== 'ext-link' || extLink.length !== 2) {
+			throw new SyntaxError(`非法的外链文字：${noWrap(text)}`);
+		}
+		const {lastChild} = extLink;
+		if (this.length === 1) {
+			this.insertAt(lastChild);
+		} else {
+			this.lastChild.safeReplaceWith(lastChild);
+		}
+		this.#space ||= ' ';
+	}
+}
+
+Parser.classes.ExtLinkToken = __filename;
+module.exports = ExtLinkToken;

package/src/gallery.js

@@ -0,0 +1,149 @@
+'use strict';
+
+const Parser = require('..'),
+	Token = require('.'),
+	GalleryImageToken = require('./link/galleryImage'),
+	HiddenToken = require('./atom/hidden');
+
+/**
+ * gallery标签
+ * @classdesc `{childNodes: ...(GalleryImageToken|HiddenToken|AstText)}`
+ */
+class GalleryToken extends Token {
+	type = 'ext-inner';
+	name = 'gallery';
+
+	/** 所有图片 */
+	get images() {
+		return this.childNodes.filter(({type}) => type === 'gallery-image');
+	}
+
+	/**
+	 * @param {string} inner 标签内部wikitext
+	 * @param {accum} accum
+	 */
+	constructor(inner, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true, accum, {
+			AstText: ':', GalleryImageToken: ':', HiddenToken: ':',
+		});
+		for (const line of inner?.split('\n') ?? []) {
+			const matches = /^([^|]+)(?:\|(.*))?/u.exec(line);
+			if (!matches) {
+				super.insertAt(line.trim()
+					? new HiddenToken(line, undefined, config, [], {
+						AstText: ':',
+					})
+					: line);
+				continue;
+			}
+			const [, file, alt] = matches,
+				title = this.normalizeTitle(file, 6, true, true);
+			if (title.valid) {
+				super.insertAt(new GalleryImageToken(file, alt, config, accum));
+			} else {
+				super.insertAt(new HiddenToken(line, undefined, config, [], {
+					AstText: ':',
+				}));
+			}
+		}
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return super.toString(selector, '\n');
+	}
+
+	/** @override */
+	text() {
+		return super.text('\n').replace(/\n\s*\n/gu, '\n');
+	}
+
+	/** @override */
+	getGaps() {
+		return 1;
+	}
+
+	/** @override */
+	print() {
+		return super.print({sep: '\n'});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = this.getAbsoluteIndex()) {
+		const {top, left} = this.getRootNode().posFromIndex(start),
+			/** @type {LintError[]} */ errors = [];
+		for (let i = 0, startIndex = start; i < this.length; i++) {
+			const child = this.childNodes[i],
+				str = String(child),
+				{length} = str,
+				trimmed = str.trim(),
+				startLine = top + i,
+				startCol = i ? 0 : left;
+			if (child.type === 'hidden' && trimmed && !/^<!--.*-->$/u.test(trimmed)) {
+				errors.push({
+					message: Parser.msg('invalid content in <$1>', 'gallery'),
+					severity: 'error',
+					startIndex,
+					endIndex: startIndex + length,
+					startLine,
+					endLine: startLine,
+					startCol,
+					endCol: startCol + length,
+					excerpt: String(child).slice(0, 50),
+				});
+			} else if (child.type !== 'hidden' && child.type !== 'text') {
+				errors.push(...child.lint(startIndex));
+			}
+			startIndex += length + 1;
+		}
+		return errors;
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new GalleryToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+
+	/**
+	 * 插入图片
+	 * @param {string} file 图片文件名
+	 * @param {number} i 插入位置
+	 * @throws `SyntaxError` 非法的文件名
+	 */
+	insertImage(file, i = this.length) {
+		const title = this.normalizeTitle(file, 6, true, true);
+		if (title.valid) {
+			const token = Parser.run(() => new GalleryImageToken(file, undefined, this.getAttribute('config')));
+			return this.insertAt(token, i);
+		}
+		throw new SyntaxError(`非法的文件名：${file}`);
+	}
+
+	/**
+	 * @override
+	 * @template {string|Token} T
+	 * @param {T} token 待插入的节点
+	 * @param {number} i 插入位置
+	 * @throws `RangeError` 插入不可见内容
+	 */
+	insertAt(token, i = 0) {
+		if (typeof token === 'string' && token.trim() || token instanceof HiddenToken) {
+			throw new RangeError('请勿向图库中插入不可见内容！');
+		}
+		return super.insertAt(token, i);
+	}
+}
+
+Parser.classes.GalleryToken = __filename;
+module.exports = GalleryToken;

package/src/hasNowiki/index.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const Parser = require('../..'),
+	Token = require('..'),
+	NoincludeToken = require('../nowiki/noinclude');
+
+/**
+ * `<pre>`
+ * @classdesc `{childNodes: [...AstText|NoincludeToken]}`
+ */
+class HasNowikiToken extends Token {
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {string} type type
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, type, config = Parser.getConfig(), accum = []) {
+		wikitext = wikitext.replace(
+			/(<nowiki>)(.*?)(<\/nowiki>)/giu,
+			/** @type {function(...string): string} */ (_, opening, inner, closing) => {
+				new NoincludeToken(opening, config, accum);
+				new NoincludeToken(closing, config, accum);
+				return `\0${accum.length - 1}c\x7F${inner}\0${accum.length}c\x7F`;
+			},
+		);
+		super(wikitext, config, true, accum, {
+			AstText: ':', NoincludeToken: ':',
+		});
+		this.type = type;
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new HasNowikiToken(undefined, this.type, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+}
+
+Parser.classes.HasNowikiToken = __filename;
+module.exports = HasNowikiToken;

package/src/hasNowiki/pre.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const Parser = require('../..'),
+	HasNowikiToken = require('.');
+
+/**
+ * `<pre>`
+ * @classdesc `{childNodes: [...AstText|NoincludeToken|ConverterToken]}`
+ */
+class PreToken extends HasNowikiToken {
+	name = 'pre';
+
+	/**
+	 * @param {string} wikitext wikitext
+	 * @param {accum} accum
+	 */
+	constructor(wikitext, config = Parser.getConfig(), accum = []) {
+		super(wikitext, 'ext-inner', config, accum);
+		this.setAttribute('stage', Parser.MAX_STAGE - 1);
+		this.setAttribute('acceptable', {AstText: ':', NoincludeToken: ':', ConverterToken: ':'});
+	}
+
+	/** @override */
+	isPlain() {
+		return true;
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new PreToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+}
+
+Parser.classes.PreToken = __filename;
+module.exports = PreToken;

package/src/heading.js

@@ -0,0 +1,134 @@
+'use strict';
+
+const {generateForSelf} = require('../util/lint'),
+	fixedToken = require('../mixin/fixedToken'),
+	sol = require('../mixin/sol'),
+	Parser = require('..'),
+	Token = require('.'),
+	SyntaxToken = require('./syntax');
+
+/**
+ * 章节标题
+ * @classdesc `{childNodes: [Token, SyntaxToken]}`
+ */
+class HeadingToken extends fixedToken(sol(Token)) {
+	type = 'heading';
+
+	/** 内部wikitext */
+	get innerText() {
+		return this.firstChild.text();
+	}
+
+	/**
+	 * @param {number} level 标题层级
+	 * @param {string[]} input 标题文字
+	 * @param {accum} accum
+	 */
+	constructor(level, input, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true, accum);
+		this.setAttribute('name', String(level));
+		const token = new Token(input[0], config, true, accum);
+		token.type = 'heading-title';
+		token.setAttribute('name', this.name);
+		token.setAttribute('stage', 2);
+		const trail = new SyntaxToken(input[1], /^[^\S\n]*$/u, 'heading-trail', config, accum, {
+			'Stage-1': ':', '!ExtToken': '',
+		});
+		this.append(token, trail);
+	}
+
+	/**
+	 * @override
+	 * @this {{prependNewLine(): ''|'\n'} & HeadingToken}
+	 * @param {string} selector
+	 * @returns {string}
+	 */
+	toString(selector) {
+		const equals = '='.repeat(Number(this.name));
+		return selector && this.matches(selector)
+			? ''
+			: `${this.prependNewLine()}${equals}${
+				this.firstChild.toString(selector)
+			}${equals}${this.lastChild.toString(selector)}`;
+	}
+
+	/**
+	 * @override
+	 * @this {HeadingToken & {prependNewLine(): ''|'\n'}}
+	 * @returns {string}
+	 */
+	text() {
+		const equals = '='.repeat(Number(this.name));
+		return `${this.prependNewLine()}${equals}${this.firstChild.text()}${equals}`;
+	}
+
+	/** @override */
+	getPadding() {
+		return super.getPadding() + Number(this.name);
+	}
+
+	/** @override */
+	getGaps() {
+		return Number(this.name);
+	}
+
+	/** @override */
+	print() {
+		const equals = '='.repeat(Number(this.name));
+		return super.print({pre: equals, sep: equals});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = this.getAbsoluteIndex()) {
+		const errors = super.lint(start),
+			innerText = String(this.firstChild);
+		let refError;
+		if (this.name === '1') {
+			refError = generateForSelf(this, {start}, '<h1>');
+			errors.push(refError);
+		}
+		if (innerText[0] === '=' || innerText.endsWith('=')) {
+			refError ||= generateForSelf(this, {start}, '');
+			errors.push({...refError, message: Parser.msg('unbalanced "=" in a section header')});
+		}
+		if (this.closest('html-attrs, table-attrs')) {
+			refError ||= generateForSelf(this, {start}, '');
+			errors.push({...refError, message: Parser.msg('section header in a HTML tag')});
+		}
+		return errors;
+	}
+
+	/** @override */
+	cloneNode() {
+		const [title, trail] = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new HeadingToken(Number(this.name), [], this.getAttribute('config'));
+			token.firsthild.safeReplaceWith(title);
+			token.lastChild.safeReplaceWith(trail);
+			return token;
+		});
+	}
+
+	/**
+	 * 设置标题层级
+	 * @param {number} n 标题层级
+	 */
+	setLevel(n) {
+		if (!Number.isInteger(n)) {
+			this.typeError('setLevel', 'Number');
+		}
+		n = Math.min(Math.max(n, 1), 6);
+		this.setAttribute('name', String(n)).firstChild.setAttribute('name', this.name);
+	}
+
+	/** 移除标题后的不可见内容 */
+	removeTrail() {
+		this.lastChild.replaceChildren();
+	}
+}
+
+Parser.classes.HeadingToken = __filename;
+module.exports = HeadingToken;