wikiparser-node 0.3.1 → 0.5.0

package/src/imageParameter.js

@@ -1,41 +1,39 @@
 'use strict';
 
-const {text, noWrap, extUrlChar} = require('../util/string'),
-	Title = require('../lib/title'),
-	/** @type {Parser} */ Parser = require('..'),
-	Token = require('.');
+const {text, noWrap, print, extUrlChar} = require('../util/string'),
+	Parser = require('..'),
+	Token = require('.'),
+	AstText = require('../lib/text');
 
 /**
  * 图片参数
- * @classdesc `{childNodes: ...(string|Token)}`
+ * @classdesc `{childNodes: ...(AstText|Token)}`
  */
 class ImageParameterToken extends Token {
-	type = 'image-parameter';
-	#syntax = '';
-
-	static #noLink = Symbol('no-link');
+	static noLink = Symbol('no-link'); // 这个Symbol需要公开
 
 	/**
+	 * 检查图片参数是否合法
 	 * @template {string} T
-	 * @param {T} key
-	 * @param {string} value
+	 * @param {T} key 参数名
+	 * @param {string} value 参数值
 	 * @returns {T extends 'link' ? string|Symbol : boolean}
 	 */
-	static #validate(key, value, config = Parser.getConfig()) {
-		value = value.replace(/\0\d+t\x7f/g, '').trim();
+	static #validate(key, value, config = Parser.getConfig(), halfParsed = false) {
+		value = value.replaceAll(/\0\d+t\x7F/gu, '').trim();
 		if (key === 'width') {
-			return /^\d*(?:x\d*)?$/.test(value);
+			return /^\d*(?:x\d*)?$/u.test(value);
 		} else if (['alt', 'class', 'manualthumb', 'frameless', 'framed', 'thumbnail'].includes(key)) {
 			return true;
 		} else if (key === 'link') {
 			if (!value) {
-				return this.#noLink;
+				return this.noLink;
 			}
-			const regex = RegExp(`(?:${config.protocol}|//)${extUrlChar}(?=\0\\d+t\x7f|$)`, 'iu');
+			const regex = new RegExp(`(?:${config.protocol}|//)${extUrlChar}(?=\0\\d+t\x7F|$)`, 'iu');
 			if (regex.test(value)) {
 				return value;
 			}
-			if (/^\[\[.+\]\]$/.test(value)) {
+			if (value.startsWith('[[') && value.endsWith(']]')) {
 				value = value.slice(2, -2);
 			}
 			if (value.includes('%')) {
@@ -43,24 +41,39 @@ class ImageParameterToken extends Token {
 					value = decodeURIComponent(value);
 				} catch {}
 			}
-			const {title, fragment, valid} = new Title(value, 0, config);
-			return valid && `${title}${fragment && '#'}${fragment}`;
+			const title = Parser.normalizeTitle(value, 0, false, config, halfParsed);
+			return title.valid && String(title);
 		}
 		return !isNaN(value);
 	}
 
+	type = 'image-parameter';
+	#syntax = '';
+
+	/** getValue()的getter */
+	get value() {
+		return this.getValue();
+	}
+
+	set value(value) {
+		this.setValue(value);
+	}
+
+	/** 图片链接 */
 	get link() {
-		if (this.name === 'link') {
-			return ImageParameterToken.#validate('link', this.getValue(), this.getAttribute('config'));
-		}
-		return undefined;
+		return this.name === 'link'
+			? ImageParameterToken.#validate('link', this.getValue(), this.getAttribute('config'))
+			: undefined;
 	}
+
 	set link(value) {
 		if (this.name === 'link') {
-			value = value === ImageParameterToken.#noLink ? '' : value;
+			value = value === ImageParameterToken.noLink ? '' : value;
 			this.setValue(value);
 		}
 	}
+
+	/** 图片大小 */
 	get size() {
 		if (this.name === 'width') {
 			const /** @type {string} */ size = this.getValue().trim();
@@ -68,30 +81,36 @@ class ImageParameterToken extends Token {
 				const [width, height = ''] = size.split('x');
 				return {width, height};
 			}
-			const token = Parser.parse(size, false, 2, this.getAttribute('config')),
-				{childNodes} = token,
-				i = childNodes.findIndex(child => typeof child === 'string' && child.includes('x'));
+			const /** @type {{childNodes: AstText[]}} */ token = Parser.parse(size, false, 2, this.getAttribute('config')),
+				i = token.childNodes.findIndex(({type, data}) => type === 'text' && data.includes('x')),
+				str = token.childNodes[i];
 			if (i === -1) {
 				return {width: size, height: ''};
 			}
-			token.splitText(i, childNodes[i].indexOf('x'));
-			token.splitText(i + 1, 1);
+			str.splitText(str.data.indexOf('x'));
+			str.nextSibling.splitText(1);
 			return {width: text(token.childNodes.slice(0, i + 1)), height: text(token.childNodes.slice(i + 2))};
 		}
 		return undefined;
 	}
+
+	/** 图片宽度 */
 	get width() {
 		return this.size?.width;
 	}
+
 	set width(width) {
 		if (this.name === 'width') {
 			const {height} = this;
 			this.setValue(`${String(width || '')}${height && 'x'}${height}`);
 		}
 	}
+
+	/** 图片高度 */
 	get height() {
 		return this.size?.height;
 	}
+
 	set height(height) {
 		height = String(height || '');
 		if (this.name === 'width') {
@@ -100,20 +119,18 @@ class ImageParameterToken extends Token {
 	}
 
 	/**
-	 * @param {string} str
+	 * @param {string} str 图片参数
 	 * @param {accum} accum
 	 */
 	constructor(str, config = Parser.getConfig(), accum = []) {
 		const regexes = Object.entries(config.img).map(
 				/** @returns {[string, string, RegExp]} */
-				([syntax, param]) => [syntax, param, RegExp(`^(\\s*)${syntax.replace('$1', '(.*)')}(\\s*)$`)],
+				([syntax, param]) => [syntax, param, new RegExp(`^(\\s*)${syntax.replace('$1', '(.*)')}(\\s*)$`, 'u')],
 			),
 			param = regexes.find(([,, regex]) => regex.test(str));
 		if (param) {
 			const mt = param[2].exec(str);
-			if (mt.length === 4 && !ImageParameterToken.#validate(param[1], mt[2], config)) {
-				// pass
-			} else {
+			if (mt.length !== 4 || ImageParameterToken.#validate(param[1], mt[2], config, true)) {
 				if (mt.length === 3) {
 					super(undefined, config, true, accum);
 					this.#syntax = str;
@@ -129,8 +146,9 @@ class ImageParameterToken extends Token {
 		this.setAttribute('name', 'caption').setAttribute('stage', 7);
 	}
 
+	/** @override */
 	cloneNode() {
-		const cloned = this.cloneChildren(),
+		const cloned = this.cloneChildNodes(),
 			config = this.getAttribute('config'),
 			token = Parser.run(() => new ImageParameterToken(this.#syntax.replace('$1', ''), config));
 		token.replaceChildren(...cloned);
@@ -138,47 +156,59 @@ class ImageParameterToken extends Token {
 	}
 
 	/**
+	 * @override
 	 * @template {string} T
-	 * @param {T} key
+	 * @param {T} key 属性键
 	 * @returns {TokenAttribute<T>}
 	 */
 	getAttribute(key) {
-		if (key === 'syntax') {
-			return this.#syntax;
-		}
-		return super.getAttribute(key);
+		return key === 'syntax' ? this.#syntax : super.getAttribute(key);
 	}
 
+	/** @override */
 	isPlain() {
 		return true;
 	}
 
+	/** 是否是不可变参数 */
 	#isVoid() {
 		return this.#syntax && !this.#syntax.includes('$1');
 	}
 
-	toString() {
-		if (!this.#syntax) {
-			return super.toString();
-		}
-		return this.#syntax.replace('$1', super.toString());
+	/**
+	 * @override
+	 * @param {string} selector
+	 */
+	toString(selector) {
+		return this.#syntax && !(selector && this.matches(selector))
+			? this.#syntax.replace('$1', super.toString(selector))
+			: super.toString(selector);
 	}
 
+	/** @override */
 	getPadding() {
 		return Math.max(0, this.#syntax.indexOf('$1'));
 	}
 
+	/** @override */
+	print() {
+		return this.#syntax
+			? `<span class="wpb-image-parameter">${this.#syntax.replace('$1', print(this.childNodes))}</span>`
+			: super.print({class: 'image-caption'});
+	}
+
+	/** @override */
 	text() {
-		if (!this.#syntax) {
-			return super.text().trim();
-		}
-		return this.#syntax.replace('$1', super.text()).trim();
+		return this.#syntax ? this.#syntax.replace('$1', super.text()).trim() : super.text().trim();
 	}
 
 	/**
-	 * @template {string|Token} T
-	 * @param {T} token
+	 * @override
+	 * @template {Token} T
+	 * @param {T} token 待插入的子节点
+	 * @param {number} i 插入位置
 	 * @complexity `n`
+	 * @throws `Error` 不接受自定义输入的图片参数
 	 */
 	insertAt(token, i = this.childNodes.length) {
 		if (!Parser.running && this.#isVoid()) {
@@ -187,14 +217,19 @@ class ImageParameterToken extends Token {
 		return super.insertAt(token, i);
 	}
 
-	/** @complexity `n` */
+	/**
+	 * 获取参数值
+	 * @complexity `n`
+	 */
 	getValue() {
 		return this.#isVoid() || super.text();
 	}
 
 	/**
-	 * @param {string|boolean} value
+	 * 设置参数值
+	 * @param {string|boolean} value 参数值
 	 * @complexity `n`
+	 * @throws	SyntaxError` 非法的参数值
 	 */
 	setValue(value) {
 		if (this.#isVoid()) {
@@ -210,14 +245,14 @@ class ImageParameterToken extends Token {
 		const root = Parser.parse(`[[File:F|${
 				this.#syntax ? this.#syntax.replace('$1', value) : value
 			}]]`, this.getAttribute('include'), 6, this.getAttribute('config')),
-			{childNodes: {length}, firstElementChild} = root,
-			param = firstElementChild?.lastElementChild;
-		if (length !== 1 || !firstElementChild?.matches('file#File:F')
-			|| firstElementChild.childNodes.length !== 2 || param.name !== this.name
+			{childNodes: {length}, firstChild: file} = root,
+			{lastChild: imageParameter, type, name, childNodes: {length: fileLength}} = file;
+		if (length !== 1 || type !== 'file' || name !== 'File:F' || fileLength !== 2
+			|| imageParameter.name !== this.name
 		) {
 			throw new SyntaxError(`非法的 ${this.name} 参数：${noWrap(value)}`);
 		}
-		this.replaceChildren(...param.childNodes);
+		this.replaceChildren(...imageParameter.childNodes);
 	}
 }