wikiparser-node 0.5.0 → 0.6.1

package/src/imagemap.js

@@ -0,0 +1,205 @@
+'use strict';
+
+const {generateForSelf, generateForChild} = require('../util/lint'),
+	Parser = require('..'),
+	AstText = require('../lib/text'),
+	Token = require('.'),
+	NoincludeToken = require('./nowiki/noinclude'),
+	GalleryImageToken = require('./link/galleryImage'),
+	ImagemapLinkToken = require('./imagemapLink');
+
+/**
+ * `<imagemap>`
+ * @classdesc `{childNodes: ...NoincludeToken, GalleryImageToken, ...(NoincludeToken|ImagemapLinkToken|AstText)}`
+ */
+class ImagemapToken extends Token {
+	type = 'ext-inner';
+	name = 'imagemap';
+
+	/**
+	 * 图片
+	 * @returns {GalleryImageToken}
+	 */
+	get image() {
+		return this.childNodes.find(({type}) => type === 'imagemap-image');
+	}
+
+	/**
+	 * 链接
+	 * @returns {ImagemapLinkToken[]}
+	 */
+	get links() {
+		return this.childNodes.filter(({type}) => type === 'imagemap-link');
+	}
+
+	/**
+	 * @param {string} inner 标签内部wikitext
+	 * @param {accum} accum
+	 * @throws `SyntaxError` 没有合法图片
+	 */
+	constructor(inner, config = Parser.getConfig(), accum = []) {
+		super(undefined, config, true, accum, {
+			GalleryImageToken: ':', ImagemapLinkToken: ':', NoincludeToken: ':', AstText: ':',
+		});
+		if (!inner) {
+			return;
+		}
+		const lines = inner.split('\n'),
+			fallback = /** @param {string} line 一行文本 */ line => {
+				super.insertAt(new NoincludeToken(line, config, accum));
+			};
+		let first = true,
+			error = false;
+		for (const line of lines) {
+			const trimmed = line.trim();
+			if (error || !trimmed || trimmed[0] === '#') {
+				//
+			} else if (first) {
+				const [file, ...options] = line.split('|');
+				let title;
+				try {
+					title = this.normalizeTitle(decodeURIComponent(file), 0, true);
+				} catch {
+					title = this.normalizeTitle(file, 0, true);
+				}
+				if (title.valid && !title.interwiki && title.ns === 6) {
+					const token = new GalleryImageToken(
+						file, options.length > 0 ? options.join('|') : undefined, title, config, accum,
+					);
+					token.type = 'imagemap-image';
+					super.insertAt(token);
+					first = false;
+					continue;
+				} else {
+					Parser.error('<imagemap>标签内必须先包含一张合法图片！', line);
+					error = true;
+				}
+			} else if (line.trim().split(/[\t ]/u)[0] === 'desc') {
+				super.insertAt(new AstText(line));
+				continue;
+			} else if (line.includes('[')) {
+				const i = line.indexOf('['),
+					substr = line.slice(i),
+					mtIn = /^\[{2}([^|]+)(?:\|([^\]]+))?\]{2}[\w\s]*$/u.exec(substr);
+				if (mtIn) {
+					const title = this.normalizeTitle(mtIn[1], 0, true);
+					if (title.valid) {
+						super.insertAt(new ImagemapLinkToken(
+							line.slice(0, i),
+							[...mtIn.slice(1), title],
+							substr.slice(substr.indexOf(']]') + 2),
+							config,
+							accum,
+						));
+						continue;
+					}
+				} else {
+					const protocols = config.protocol.split('|');
+					if (protocols.includes(substr.slice(1, substr.indexOf(':') + 1))
+						|| protocols.includes(substr.slice(1, substr.indexOf('//') + 2))
+					) {
+						const mtEx = /^\[([^\]\s]+)(?:(\s+)(\S[^\]]*)?)?\][\w\s]*$/u.exec(substr);
+						if (mtEx) {
+							super.insertAt(new ImagemapLinkToken(
+								line.slice(0, i),
+								mtEx.slice(1),
+								substr.slice(substr.indexOf(']') + 1),
+								config,
+								accum,
+							));
+							continue;
+						}
+					}
+				}
+			}
+			fallback(line);
+		}
+	}
+
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return super.toString(selector, '\n');
+	}
+
+	/** @override */
+	getGaps() {
+		return 1;
+	}
+
+	/** @override */
+	print() {
+		return super.print({sep: '\n'});
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			rect = this.getRootNode().posFromIndex(start);
+		if (this.image) {
+			errors.push(
+				...this.childNodes.filter(child => {
+					const str = String(child).trim();
+					return child.type === 'noinclude' && str && str[0] !== '#';
+				}).map(child => generateForChild(child, rect, '无效的<imagemap>链接')),
+			);
+		} else {
+			errors.push(generateForSelf(this, rect, '缺少图片的<imagemap>'));
+		}
+		return errors;
+	}
+
+	/**
+	 * @override
+	 * @template {string|Token} T
+	 * @param {T} token 待插入的节点
+	 * @param {number} i 插入位置
+	 * @throws `Error` 当前缺少合法图片
+	 * @throws `RangeError` 已有一张合法图片
+	 */
+	insertAt(token, i = 0) {
+		const {image} = this;
+		if (!image && (token.type === 'imagemap-link' || token.type === 'text')) {
+			throw new Error('当前缺少一张合法图片！');
+		} else if (image && token.type === 'imagemap-image') {
+			throw new RangeError('已有一张合法图片！');
+		}
+		return super.insertAt(token, i);
+	}
+
+	/**
+	 * @override
+	 * @param {number} i 移除位置
+	 * @throws `Error` 禁止移除图片
+	 */
+	removeAt(i) {
+		const child = this.childNodes[i];
+		if (child.type === 'imagemap-image') {
+			throw new Error('禁止移除<imagemap>内的图片！');
+		}
+		return super.removeAt(i);
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new ImagemapToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
+
+	/** @override */
+	text() {
+		return super.text('\n').replaceAll(/\n{2,}/gu, '\n');
+	}
+}
+
+Parser.classes.ImagemapToken = __filename;
+module.exports = ImagemapToken;

package/src/imagemapLink.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const fixedToken = require('../mixin/fixedToken'),
+	Parser = require('..'),
+	Token = require('.'),
+	LinkToken = require('./link'),
+	ExtLinkToken = require('./extLink');
+
+/**
+ * `<imagemap>`内的链接
+ * @classdesc `{childNodes: [AstText, LinkToken|ExtLinkToken, NoincludeToken]}`
+ */
+class ImagemapLinkToken extends fixedToken(Token) {
+	type = 'imagemap-link';
+
+	/**
+	 * 内外链接
+	 * @this {{childNodes: (LinkToken|ExtLinkToken)[]}}
+	 */
+	get link() {
+		return this.childNodes[1].link;
+	}
+
+	/**
+	 * @param {string} pre 链接前的文本
+	 * @param {[string, string, string|Title]} linkStuff 内外链接
+	 * @param {string} post 链接后的文本
+	 * @param {accum} accum
+	 */
+	constructor(pre, linkStuff, post, config, accum) {
+		const Title = require('../lib/title'),
+			AstText = require('../lib/text'),
+			NoincludeToken = require('./nowiki/noinclude');
+		const SomeLinkToken = linkStuff[2] instanceof Title ? LinkToken : ExtLinkToken;
+		super(undefined, config, true, accum);
+		this.append(
+			new AstText(pre), new SomeLinkToken(...linkStuff, config, accum), new NoincludeToken(post, config, accum),
+		);
+	}
+}
+
+Parser.classes.ImagemapLinkToken = __filename;
+module.exports = ImagemapLinkToken;

package/src/index.js

@@ -28,6 +28,7 @@
  * -: `{{!-}}`专用
  * +: `{{!!}}`专用
  * ~: `{{=}}`专用
+ * m: `{{fullurl:}}`、`{{canonicalurl:}}`或`{{filepath:}}`
  * t: ArgToken或TranscludeToken
  * h: HeadingToken
  * x: HtmlToken
@@ -64,14 +65,6 @@ class Token extends AstElement {
 	#protectedChildren = new Ranges();
 	/** @type {boolean} */ #include;
 
-	/**
-	 * 保护部分子节点不被移除
-	 * @param {...string|number|Range} args 子节点范围
-	 */
-	#protectChildren = (...args) => {
-		this.#protectedChildren.push(...new Ranges(args));
-	};
-
 	/**
 	 * 将维基语法替换为占位符
 	 * @param {number} n 解析阶段
@@ -144,9 +137,36 @@ class Token extends AstElement {
 		throw new Error(`解析错误！未正确标记的 Token：${s}`);
 	});
 
+	/**
+	 * 将占位符替换为子Token
+	 * @complexity `n`
+	 */
+	#build = () => {
+		this.#stage = MAX_STAGE;
+		const {length, firstChild} = this,
+			str = String(firstChild);
+		if (length === 1 && firstChild.type === 'text' && str.includes('\0')) {
+			this.replaceChildren(...this.#buildFromStr(str));
+			this.normalize();
+			if (this.type === 'root') {
+				for (const token of this.#accum) {
+					token.getAttribute('build')();
+				}
+			}
+		}
+	};
+
+	/**
+	 * 保护部分子节点不被移除
+	 * @param {...string|number|Range} args 子节点范围
+	 */
+	#protectChildren = (...args) => {
+		this.#protectedChildren.push(...new Ranges(args));
+	};
+
 	/** 所有图片，包括图库 */
 	get images() {
-		return this.querySelectorAll('file, gallery-image');
+		return this.querySelectorAll('file, gallery-image, imagemap-image');
 	}
 
 	/** 所有内链、外链和自由外链 */
@@ -167,7 +187,7 @@ class Token extends AstElement {
 	constructor(wikitext, config = Parser.getConfig(), halfParsed = false, accum = [], acceptable = null) {
 		super();
 		if (typeof wikitext === 'string') {
-			this.appendChild(halfParsed ? wikitext : wikitext.replaceAll(/[\0\x7F]/gu, ''));
+			this.insertAt(halfParsed ? wikitext : wikitext.replaceAll(/[\0\x7F]/gu, ''));
 		}
 		this.#config = config;
 		this.#accum = accum;
@@ -175,34 +195,6 @@ class Token extends AstElement {
 		accum.push(this);
 	}
 
-	/**
-	 * 深拷贝所有子节点
-	 * @complexity `n`
-	 * @returns {(AstText|Token)[]}
-	 */
-	cloneChildNodes() {
-		return this.childNodes.map(child => child.cloneNode());
-	}
-
-	/**
-	 * 深拷贝节点
-	 * @complexity `n`
-	 * @throws `Error` 未定义复制方法
-	 */
-	cloneNode() {
-		if (!this.isPlain()) {
-			throw new Error(`未定义 ${this.constructor.name} 的复制方法！`);
-		}
-		const cloned = this.cloneChildNodes();
-		return Parser.run(() => {
-			const token = new Token(undefined, this.#config, false, [], this.#acceptable);
-			token.type = this.type;
-			token.append(...cloned);
-			token.getAttribute('protectChildren')(...this.#protectedChildren);
-			return token;
-		});
-	}
-
 	/**
 	 * @override
 	 * @template {string} T
@@ -211,22 +203,24 @@ class Token extends AstElement {
 	 */
 	getAttribute(key) {
 		switch (key) {
-			case 'stage':
-				return this.#stage;
 			case 'config':
 				return structuredClone(this.#config);
 			case 'accum':
 				return this.#accum;
+			case 'parseOnce':
+				return this.#parseOnce;
+			case 'buildFromStr':
+				return this.#buildFromStr;
+			case 'build':
+				return this.#build;
+			case 'stage':
+				return this.#stage;
 			case 'acceptable':
 				return this.#acceptable ? {...this.#acceptable} : null;
 			case 'protectChildren':
 				return this.#protectChildren;
 			case 'protectedChildren':
 				return new Ranges(this.#protectedChildren);
-			case 'parseOnce':
-				return this.#parseOnce;
-			case 'buildFromStr':
-				return this.#buildFromStr;
 			case 'include': {
 				if (this.#include !== undefined) {
 					return this.#include;
@@ -252,16 +246,8 @@ class Token extends AstElement {
 	 * @template {string} T
 	 * @param {T} key 属性键
 	 * @param {TokenAttribute<T>} value 属性值
-	 * @throws `RangeError` 禁止手动指定私有属性
 	 */
 	setAttribute(key, value) {
-		if (key === 'include' || !Parser.running && (key === 'config' || key === 'accum')) {
-			throw new RangeError(`禁止手动指定私有的 #${key} 属性！`);
-		} else if (!Parser.debugging && (key === 'stage' || key === 'acceptable' || key === 'protectedChildren')
-			&& externalUse('setAttribute')
-		) {
-			throw new RangeError(`使用 ${this.constructor.name}.setAttribute 方法设置私有属性 #${key} 仅用于代码调试！`);
-		}
 		switch (key) {
 			case 'stage':
 				if (this.#stage === 0 && this.type === 'root') {
@@ -269,15 +255,6 @@ class Token extends AstElement {
 				}
 				this.#stage = value;
 				return this;
-			case 'config':
-				this.#config = value;
-				return this;
-			case 'accum':
-				this.#accum = value;
-				return this;
-			case 'protectedChildren':
-				this.#protectedChildren = value;
-				return this;
 			case 'acceptable': {
 				const /** @type {acceptable} */ acceptable = {};
 				if (value) {
@@ -308,36 +285,6 @@ class Token extends AstElement {
 		return this.constructor === Token;
 	}
 
-	/**
-	 * @override
-	 * @param {number} i 移除位置
-	 * @returns {Token}
-	 * @complexity `n`
-	 * @throws `Error` 不可移除的子节点
-	 */
-	removeAt(i) {
-		if (typeof i !== 'number') {
-			this.typeError('removeAt', 'Number');
-		}
-		const iPos = i < 0 ? i + this.childNodes.length : i;
-		if (!Parser.running) {
-			const protectedIndices = this.#protectedChildren.applyTo(this.childNodes);
-			if (protectedIndices.includes(iPos)) {
-				throw new Error(`${this.constructor.name} 的第 ${i} 个子节点不可移除！`);
-			} else if (this.#acceptable) {
-				const acceptableIndices = Object.fromEntries(
-						Object.entries(this.#acceptable)
-							.map(([str, ranges]) => [str, ranges.applyTo(this.childNodes.length - 1)]),
-					),
-					nodesAfter = i === -1 ? [] : this.childNodes.slice(i + 1);
-				if (nodesAfter.some(({constructor: {name}}, j) => !acceptableIndices[name].includes(i + j))) {
-					throw new Error(`移除 ${this.constructor.name} 的第 ${i} 个子节点会破坏规定的顺序！`);
-				}
-			}
-		}
-		return super.removeAt(i);
-	}
-
 	/**
 	 * @override
 	 * @template {string|Token} T
@@ -372,6 +319,45 @@ class Token extends AstElement {
 		return token;
 	}
 
+	/**
+	 * 规范化页面标题
+	 * @param {string} title 标题（含或不含命名空间前缀）
+	 * @param {number} defaultNs 命名空间
+	 */
+	normalizeTitle(title, defaultNs = 0, halfParsed = false) {
+		return Parser.normalizeTitle(title, defaultNs, this.#include, this.#config, halfParsed);
+	}
+
+	/**
+	 * @override
+	 * @param {number} i 移除位置
+	 * @returns {Token}
+	 * @complexity `n`
+	 * @throws `Error` 不可移除的子节点
+	 */
+	removeAt(i) {
+		if (!Number.isInteger(i)) {
+			this.typeError('removeAt', 'Number');
+		}
+		const iPos = i < 0 ? i + this.childNodes.length : i;
+		if (!Parser.running) {
+			const protectedIndices = this.#protectedChildren.applyTo(this.childNodes);
+			if (protectedIndices.includes(iPos)) {
+				throw new Error(`${this.constructor.name} 的第 ${i} 个子节点不可移除！`);
+			} else if (this.#acceptable) {
+				const acceptableIndices = Object.fromEntries(
+						Object.entries(this.#acceptable)
+							.map(([str, ranges]) => [str, ranges.applyTo(this.childNodes.length - 1)]),
+					),
+					nodesAfter = i === -1 ? [] : this.childNodes.slice(i + 1);
+				if (nodesAfter.some(({constructor: {name}}, j) => !acceptableIndices[name].includes(i + j))) {
+					throw new Error(`移除 ${this.constructor.name} 的第 ${i} 个子节点会破坏规定的顺序！`);
+				}
+			}
+		}
+		return super.removeAt(i);
+	}
+
 	/**
 	 * 替换为同类节点
 	 * @param {Token} token 待替换的节点
@@ -444,6 +430,120 @@ class Token extends AstElement {
 		throw new RangeError(`非法的标签名！${tagName}`);
 	}
 
+	/**
+	 * 创建纯文本节点
+	 * @param {string} data 文本内容
+	 */
+	createTextNode(data = '') {
+		return typeof data === 'string' ? new AstText(data) : this.typeError('createComment', 'String');
+	}
+
+	/**
+	 * 找到给定位置所在的节点
+	 * @param {number} index 位置
+	 */
+	caretPositionFromIndex(index) {
+		if (index === undefined) {
+			return undefined;
+		} else if (!Number.isInteger(index)) {
+			this.typeError('caretPositionFromIndex', 'Number');
+		}
+		const {length} = String(this);
+		if (index > length || index < -length) {
+			return undefined;
+		} else if (index < 0) {
+			index += length;
+		}
+		let child = this, // eslint-disable-line unicorn/no-this-assignment
+			acc = 0,
+			start = 0;
+		while (child.type !== 'text') {
+			const {childNodes} = child;
+			acc += child.getPadding();
+			for (let i = 0; acc <= index && i < childNodes.length; i++) {
+				const cur = childNodes[i],
+					{length: l} = String(cur);
+				acc += l;
+				if (acc >= index) {
+					child = cur;
+					acc -= l;
+					start = acc;
+					break;
+				}
+				acc += child.getGaps(i);
+			}
+			if (child.childNodes === childNodes) {
+				return {offsetNode: child, offset: index - start};
+			}
+		}
+		return {offsetNode: child, offset: index - start};
+	}
+
+	/**
+	 * 找到给定位置所在的节点
+	 * @param {number} x 列数
+	 * @param {number} y 行数
+	 */
+	caretPositionFromPoint(x, y) {
+		return this.caretPositionFromIndex(this.indexFromPos(y, x));
+	}
+
+	/**
+	 * 找到给定位置所在的最外层节点
+	 * @param {number} index 位置
+	 * @throws `Error` 不是根节点
+	 */
+	elementFromIndex(index) {
+		if (index === undefined) {
+			return undefined;
+		} else if (!Number.isInteger(index)) {
+			this.typeError('elementFromIndex', 'Number');
+		} else if (this.type !== 'root') {
+			throw new Error('elementFromIndex方法只可用于根节点！');
+		}
+		const {length} = String(this);
+		if (index > length || index < -length) {
+			return undefined;
+		} else if (index < 0) {
+			index += length;
+		}
+		const {childNodes} = this;
+		let acc = 0,
+			i = 0;
+		for (; acc < index && i < childNodes.length; i++) {
+			const {length: l} = String(childNodes[i]);
+			acc += l;
+		}
+		return childNodes[i && i - 1];
+	}
+
+	/**
+	 * 找到给定位置所在的最外层节点
+	 * @param {number} x 列数
+	 * @param {number} y 行数
+	 */
+	elementFromPoint(x, y) {
+		return this.elementFromIndex(this.indexFromPos(y, x));
+	}
+
+	/**
+	 * 找到给定位置所在的所有节点
+	 * @param {number} index 位置
+	 */
+	elementsFromIndex(index) {
+		const offsetNode = this.caretPositionFromIndex(index)?.offsetNode;
+		return offsetNode && [...offsetNode.getAncestors().reverse(), offsetNode];
+	}
+
+	/**
+	 * 找到给定位置所在的所有节点
+	 * @param {number} x 列数
+	 * @param {number} y 行数
+	 */
+	elementsFromPoint(x, y) {
+		return this.elementsFromIndex(this.indexFromPos(y, x));
+	}
+
 	/**
 	 * 判断标题是否是跨维基链接
 	 * @param {string} title 标题
@@ -453,12 +553,31 @@ class Token extends AstElement {
 	}
 
 	/**
-	 * 规范化页面标题
-	 * @param {string} title 标题（含或不含命名空间前缀）
-	 * @param {number} defaultNs 命名空间
+	 * 深拷贝所有子节点
+	 * @complexity `n`
+	 * @returns {(AstText|Token)[]}
 	 */
-	normalizeTitle(title, defaultNs = 0, halfParsed = false) {
-		return Parser.normalizeTitle(title, defaultNs, this.#include, this.#config, halfParsed);
+	cloneChildNodes() {
+		return this.childNodes.map(child => child.cloneNode());
+	}
+
+	/**
+	 * 深拷贝节点
+	 * @complexity `n`
+	 * @throws `Error` 未定义复制方法
+	 */
+	cloneNode() {
+		if (this.constructor !== Token) {
+			throw new Error(`未定义 ${this.constructor.name} 的复制方法！`);
+		}
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new Token(undefined, this.#config, false, [], this.#acceptable);
+			token.type = this.type;
+			token.append(...cloned);
+			token.getAttribute('protectChildren')(...this.#protectedChildren);
+			return token;
+		});
 	}
 
 	/**
@@ -499,7 +618,7 @@ class Token extends AstElement {
 	 * @complexity `n`
 	 */
 	section(n) {
-		return typeof n === 'number' ? this.sections()?.[n] : this.typeError('section', 'Number');
+		return Number.isInteger(n) ? this.sections()?.[n] : this.typeError('section', 'Number');
 	}
 
 	/**
@@ -590,29 +709,6 @@ class Token extends AstElement {
 		this.normalize();
 	}
 
-	/**
-	 * 将占位符替换为子Token
-	 * @complexity `n`
-	 */
-	build() {
-		if (!Parser.debugging && externalUse('build')) {
-			this.debugOnly('build');
-		}
-		this.#stage = MAX_STAGE;
-		const {childNodes: {length}, firstChild} = this,
-			str = String(firstChild);
-		if (length === 1 && firstChild.type === 'text' && str.includes('\0')) {
-			this.replaceChildren(...this.#buildFromStr(str));
-			this.normalize();
-			if (this.type === 'root') {
-				for (const token of this.#accum) {
-					token.build();
-				}
-			}
-		}
-		return this;
-	}
-
 	/** 生成部分Token的`name`属性 */
 	afterBuild() {
 		if (!Parser.debugging && externalUse('afterBuild')) {
@@ -631,16 +727,18 @@ class Token extends AstElement {
 	 * @param {boolean} include 是否嵌入
 	 */
 	parse(n = MAX_STAGE, include = false) {
-		if (typeof n !== 'number') {
+		if (!Number.isInteger(n)) {
 			this.typeError('parse', 'Number');
-		} else if (n < MAX_STAGE && !Parser.debugging && Parser.warning && externalUse('parse')) {
-			Parser.warn('指定解析层级的方法仅供熟练用户使用！');
 		}
 		this.#include = Boolean(include);
 		while (this.#stage < n) {
 			this.#parseOnce(this.#stage, include);
 		}
-		return n ? this.build().afterBuild() : this;
+		if (n) {
+			this.#build();
+			this.afterBuild();
+		}
+		return this;
 	}
 
 	/**