@sie-js/vkp 1.0.4 → 1.0.6

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sie-js/vkp",
-	"version": "1.0.4",
+	"version": "1.0.6",
 	"description": "Parser and utils for the .VKP files format which is used in the V-Klay.",
 	"main": "src/index.js",
 	"type": "module",

package/src/index.js

@@ -117,9 +117,26 @@ function vkpDetectContent(text) {
 	return "UNKNOWN";
 }
 
-// CP1251 -> UTF-8 + CRLF -> LF (with RTC support)
+// CP1251 -> UTF-8 + CRLF -> LF (with RTF support)
 async function vkpNormalizeWithRTF(text) {
+	if (!Buffer.isBuffer(text))
+		throw new Error(`Patch text is not Buffer!`);
+
 	if (text.indexOf('{\\rtf1') >= 0) {
+		// Strip RTF images
+		while (true) {
+			let pictureIndex = text.indexOf('{\\pict');
+			if (pictureIndex >= 0) {
+				let pictureEndIndex = text.indexOf('}', pictureIndex);
+				if (pictureIndex >= 0) {
+					text = Buffer.concat([ text.slice(0, pictureIndex), text.slice(pictureEndIndex + 1) ]);
+					continue;
+				}
+			}
+			break;
+		}
+
+		text = text.toString('utf-8').replace(/{\\pict.*?\}/gsi, ''); // remove pictures
 		let parsed = await new Promise((resolve, reject) => {
 			RTFParser.string(text, (err, doc) => {
 				if (err) {
@@ -129,9 +146,11 @@ async function vkpNormalizeWithRTF(text) {
 				}
 			});
 		});
+
 		let lines = [];
-		for (let p of parsed.content)
+		for (let p of parsed.content) {
 			lines.push(p.content.map((s) => s.value).join(''));
+		}
 		return lines.join('\n');
 	}
 	return iconv.decode(text, 'windows-1251').replace(/(\r\n|\n|\r)/g, "\n");
@@ -139,6 +158,8 @@ async function vkpNormalizeWithRTF(text) {
 
 // CP1251 -> UTF-8 + CRLF -> LF
 function vkpNormalize(text) {
+	if (!Buffer.isBuffer(text))
+		throw new Error(`Patch text is not Buffer!`);
 	return iconv.decode(text, 'windows-1251').replace(/(\r\n|\n|\r)/g, "\n");
 }
 
@@ -147,4 +168,4 @@ function vkpCanonicalize(text) {
 	return iconv.encode(text.replace(/(\r\n|\n|\r)/g, "\r\n"), 'windows-1251');
 }
 
-export { vkpParse, vkpRawParser, vkpNormalize, vkpNormalizeWithRTF, vkpCanonicalize, vkpDetectContent };
+export { vkpParse, vkpRawParser, vkpNormalize, vkpNormalizeWithRTF, vkpCanonicalize, vkpDetectContent, VkpParseError };

package/src/parser.js

@@ -97,6 +97,9 @@ function vkpRawParser(text, options = {}) {
 				throw new VkpParseError("Syntax error", getLocation());
 			}
 		} catch (e) {
+			if (!(e instanceof VkpParseError))
+				throw e;
+
 			let loc = getLocation();
 			let token;
 			while ((token = nextToken())) {
@@ -122,7 +125,8 @@ function parseComments() {
 		} else if (token.type == TOKEN.COMMENT || token.type == TOKEN.MULTILINE_COMMENT || token.type == TOKEN.UNFINISHED_COMMENT) {
 			if (token.type == TOKEN.UNFINISHED_COMMENT)
 				state.onWarning(new VkpParseError(`Unfinished multiline comment`, getLocation()));
-			comments.push(nextToken());
+			comments.push(parseCommentValue(token.value));
+			nextToken();
 		} else {
 			break;
 		}
@@ -133,16 +137,16 @@ function parseComments() {
 function parsePatchPragma() {
 	let pragma = parsePragmaValue(peekToken().value);
 	nextToken();
-	let comments = parseCommentsAfterExpr();
-	return { pragma, comments };
+	let comment = parseCommentsAfterExpr();
+	return { pragma, comment };
 }
 
 function parsePatchOffsetCorrector() {
 	let text = peekToken().value;
 	let offset = parseOffsetValue(text);
 	nextToken();
-	let comments = parseCommentsAfterExpr();
-	return { text, offset, comments };
+	let comment = parseCommentsAfterExpr();
+	return { text, offset, comment };
 }
 
 function parsePatchRecord() {
@@ -160,10 +164,10 @@ function parsePatchRecord() {
 	if (!data.length)
 		throw new VkpParseError(`Empty patch data record!`, getLocation());
 
-	let comments = parseCommentsAfterExpr();
+	let comment = parseCommentsAfterExpr();
 	return {
 		address,
-		comments,
+		comment,
 		old:	data.length == 2 ? data[0] : null,
 		new:	data.length == 2 ? data[1] : data[0],
 	};
@@ -244,12 +248,13 @@ function parseCommentsAfterExpr() {
 		} else if (token.type == TOKEN.COMMENT || token.type == TOKEN.MULTILINE_COMMENT || token.type == TOKEN.UNFINISHED_COMMENT) {
 			if (token.type == TOKEN.UNFINISHED_COMMENT)
 				state.onWarning(new VkpParseError(`Unfinished multiline comment`, getLocation()));
-			comments.push(nextToken());
+			comments.push(parseCommentValue(token.value));
+			nextToken();
 		} else {
 			throw new VkpParseError("Syntax error", getLocation());
 		}
 	}
-	return comments;
+	return comments.join(" ");
 }
 
 function nextToken() {
@@ -272,6 +277,19 @@ function prevToken() {
 /**
  * Token value parsers
  * */
+function parseCommentValue(v) {
+	if (v.startsWith(';')) {
+		return v.substr(1);
+	} else if (v.startsWith('#')) {
+		return v.substr(1);
+	} else if (v.startsWith('//')) {
+		return v.substr(2);
+	} else if (v.startsWith('/*')) {
+		return v.slice(2, -2);
+	}
+	throw new VkpParseError(`Invalid comment type`, getLocation());
+}
+
 function parseAnyNumberValue(v) {
 	let m;
 	let tmpBuffer = Buffer.allocUnsafe(8);