Fix variable uses list which wasn't including variable "0"'s uses in text fields

Author: chrismaltby

CHANGELOG.md

@@ -49,6 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix issue where instanced prefabs were showing incorrect icons in actor select inputs
 - Fix issue preventing engine plugins stored in subfolders from being included in project
 - Fix bottom margins when using GB Printer [@untoxa](https://github.com/untoxa)
+- Fix variable uses list which wasn't including variable "0"'s uses in text fields
 
 ## [4.1.3] - 2024-09-16
 

src/components/editors/VariableUses.worker.ts

@@ -28,6 +28,10 @@ import {
 } from "shared/lib/scripts/walk";
 import { variableInScriptValue } from "shared/lib/scriptValue/helpers";
 import { isScriptValue } from "shared/lib/scriptValue/types";
+import {
+  variableInDialogueText,
+  variableInExpressionText,
+} from "shared/lib/variables/variablesInText";
 
 export type VariableUse = {
   id: string;
@@ -132,25 +136,11 @@ workerCtx.onmessage = async (evt) => {
       const allText = String(
         Array.isArray(argValue) ? argValue.join("|") : argValue
       );
-      const textTokens = lexText(allText);
-      if (
-        textTokens.some(
-          (token) =>
-            token.type === "variable" &&
-            token.variableId.replace(/^0+/, "") === variableId
-        )
-      ) {
+      if (variableInDialogueText(variableId, allText)) {
         return true;
       }
     } else if (field.type === "matharea" && typeof argValue === "string") {
-      const expressionTokens = tokenizer(argValue);
-      if (
-        expressionTokens.some(
-          (token) =>
-            token.type === "VAR" &&
-            token.symbol.replace(/\$/g, "").replace(/^0/g, "") === variableId
-        )
-      ) {
+      if (variableInExpressionText(variableId, argValue)) {
         return true;
       }
     }

src/shared/lib/compiler/lexText.ts

@@ -1,6 +1,6 @@
 import { fromSigned8Bit } from "shared/lib/helpers/8bit";
 
-type Token =
+export type Token =
   | {
       type: "text";
       value: string;

src/shared/lib/variables/variablesInText.ts

@@ -0,0 +1,51 @@
+import { lexText, Token as TextToken } from "shared/lib/compiler/lexText";
+import { Token as ExpressionToken } from "shared/lib/rpn/types";
+import tokenizer from "shared/lib/rpn/tokenizer";
+
+/**
+ * Extracts a variable ID from a dialogue token by removing any leading zeros.
+ * @param {TextToken} token - The token to process, expected to be of type 'variable'.
+ * @returns {string | undefined} - The variable ID without leading zeros, or undefined if the token is not of type 'variable'.
+ */
+export const dialogueTokenToVariableId = (token: TextToken) =>
+  token.type === "variable" ? token.variableId.replace(/^0/, "") : undefined;
+
+/**
+ * Extracts a variable ID from an expression token by removing dollar signs and any leading zeros.
+ * @param {ExpressionToken} token - The token to process, expected to be of type 'VAR'.
+ * @returns {string | undefined} - The variable ID without '$' symbols or leading zeros, or undefined if the token is not of type 'VAR'.
+ */
+export const expressionTokenToVariableId = (token: ExpressionToken) =>
+  token.type === "VAR" && token.symbol.replace(/\$/g, "").replace(/^0/g, "");
+
+/**
+ * Checks if a given variable ID exists in a dialogue text input.
+ * @param {string} variableId - The ID of the variable to search for in the text (without leading zeros).
+ * @param {string} input - The dialogue text input to search within.
+ * @returns {boolean} - True if the variable ID is found in the text, false otherwise.
+ */
+export const variableInDialogueText = (
+  variableId: string,
+  input: string
+): boolean => {
+  const textTokens = lexText(input);
+  const isMatch = (token: TextToken) =>
+    dialogueTokenToVariableId(token) === variableId;
+  return textTokens.some(isMatch);
+};
+
+/**
+ * Checks if a given variable ID exists in an expression text input.
+ * @param {string} variableId - The ID of the variable to search for in the expression (without leading zeros).
+ * @param {string} input - The expression text input to search within.
+ * @returns {boolean} - True if the variable ID is found in the expression, false otherwise.
+ */
+export const variableInExpressionText = (
+  variableId: string,
+  input: string
+): boolean => {
+  const expressionTokens = tokenizer(input);
+  const isMatch = (token: ExpressionToken) =>
+    expressionTokenToVariableId(token) === variableId;
+  return expressionTokens.some(isMatch);
+};

test/variables/variablesInText.test.ts

@@ -0,0 +1,94 @@
+import {
+  dialogueTokenToVariableId,
+  expressionTokenToVariableId,
+  variableInDialogueText,
+  variableInExpressionText,
+} from "shared/lib/variables/variablesInText";
+
+describe("dialogueTokenToVariableId", () => {
+  test("should return variable id without leading zero", () => {
+    const token = { type: "variable", variableId: "01" } as const;
+    expect(dialogueTokenToVariableId(token)).toBe("1");
+  });
+
+  test("should return zero first first variable", () => {
+    const token = { type: "variable", variableId: "00" } as const;
+    expect(dialogueTokenToVariableId(token)).toBe("0");
+  });
+
+  test("should not remove trailing zeros", () => {
+    const token = { type: "variable", variableId: "500" } as const;
+    expect(dialogueTokenToVariableId(token)).toBe("500");
+  });
+});
+
+describe("expressionTokenToVariableId", () => {
+  test("should return variable id without leading zero", () => {
+    const token = { type: "VAR", symbol: "$01$" } as const;
+    expect(expressionTokenToVariableId(token)).toBe("1");
+  });
+
+  test("should return zero first first variable", () => {
+    const token = { type: "VAR", symbol: "$00$" } as const;
+    expect(expressionTokenToVariableId(token)).toBe("0");
+  });
+
+  test("should not remove trailing zeros", () => {
+    const token = { type: "VAR", symbol: "$500$" } as const;
+    expect(expressionTokenToVariableId(token)).toBe("500");
+  });
+});
+
+describe("variableInDialogueText", () => {
+  test("should match when variable contains leading zero", () => {
+    const text = "Value is $01$";
+    expect(variableInDialogueText("1", text)).toBeTruthy();
+  });
+
+  test("should match when variable contains is zero", () => {
+    const text = "Value is $00$";
+    expect(variableInDialogueText("0", text)).toBeTruthy();
+  });
+
+  test("should match when variable contains trailing zeros", () => {
+    const text = "Value is $500$";
+    expect(variableInDialogueText("500", text)).toBeTruthy();
+  });
+
+  test("should match when multiple variables are found", () => {
+    const text = "Value is $01$ $02$ $03$";
+    expect(variableInDialogueText("3", text)).toBeTruthy();
+  });
+
+  test("should not match when variable isn't in text", () => {
+    const text = "Value is $02$";
+    expect(variableInDialogueText("3", text)).toBeFalsy();
+  });
+});
+
+describe("variableInExpressionText", () => {
+  test("should match when variable contains leading zero", () => {
+    const text = "5 + $01$";
+    expect(variableInExpressionText("1", text)).toBeTruthy();
+  });
+
+  test("should match when variable contains is zero", () => {
+    const text = "5 + $00$";
+    expect(variableInExpressionText("0", text)).toBeTruthy();
+  });
+
+  test("should match when variable contains trailing zeros", () => {
+    const text = "5 + $500$";
+    expect(variableInExpressionText("500", text)).toBeTruthy();
+  });
+
+  test("should match when multiple variables are found", () => {
+    const text = "$01$ + $02$ - $03$";
+    expect(variableInExpressionText("3", text)).toBeTruthy();
+  });
+
+  test("should not match when variable isn't in text", () => {
+    const text = "5 + $02$";
+    expect(variableInExpressionText("3", text)).toBeFalsy();
+  });
+});