overpy 9.6.1 → 9.6.3

package/README.md

@@ -594,6 +594,14 @@ Suppresses the specified warnings globally across the program. Warnings must be
 #!suppressWarnings w_type_check w_unsuitable_event
 ```
 
+## #!allowMacroRedeclaration
+
+If specified, will replace the existing macro instead of throwing an error. Can be useful for OOP-like projects where the same codebase is used for multiple different gamemodes.
+
+## #!debugElementCount
+
+Will generate a summary of the used elements per rule in the output, and add a comment with the number of elements used for each rule/condition/action.
+
 ## Optimizations
 
 By default, OverPy automatically optimizes gamemodes for speed. This means useless code is removed, calculations are done when possible, and function patterns are replaced with builtin functions.
@@ -606,7 +614,7 @@ For example:
 
 You can check [here](https://github.com/Zezombye/overpy/issues/33) for a list of optimizations.
 
-The `#!disableOptimizations` directive can be used to disable all optimizations done by the compiler. Should be only used for debugging, if you suspect that OverPy has bugs in its optimizations, or if you want to generate an unoptimize instruction for some reason.
+The `#!disableOptimizations` directive can be used to disable all optimizations done by the compiler. Should be only used for debugging, if you suspect that OverPy has bugs in its optimizations, or if you want to generate an unoptimized instruction for some reason.
 
 The `#!optimizeForSize` directive prioritizes lowering the number of elements over optimizing the runtime (see [here](https://github.com/Zezombye/overpy/issues/238) for a list of optimizations).
 
@@ -823,17 +831,11 @@ The template is an OverPy expression with the following variables:
 
 Examples :
 
-- `#!rulePrefixTemplate f"[{$prefix}] {$rule}" if $prefix and $rule else $rule` (default): adds the prefix in square brackets before the rule name, if the prefix and rule name are not empty. This is the default if this directive is unspecified.
+- `#!rulePrefixTemplate f"[{$prefix}] {$rule}" if $prefix and $rule and not $isDelimiter else $rule` (default): adds the prefix in square brackets before the rule name, if the prefix and rule name are not empty. This is the default if this directive is unspecified.
 - `#!rulePrefixTemplate f"[{$pathTitle.replace('_', ' ')}] {$rule}" if $rule and not $isDelimiter else $rule`": if you have an `heroes/junker_queen.opy` file, will yield rule names like `"[Heroes/Junker Queen] Spawn particles"`. This is the default if the directive is specified without an expression (just `#!rulePrefixTemplate`).
 
 The expression has to evaluate to a string without arguments.
 
-#!rulePrefix "effects"
-
-rule "Spawn particles":
-    #compiled rule name: (EFFECTS) Spawn particles
-```
-
 # Advanced constructs
 
 ## Switches

package/overpy.js

@@ -38655,6 +38655,20 @@ ${scriptText}`, {
       setReplacementForTeam1("getControlScoringTeam");
       return;
     }
+    if (content2.startsWith("#!replaceEmptyStringByEmptyArray")) {
+      if (replacementForEmptyString !== "") {
+        error("A replacement for empty string has already been defined");
+      }
+      setReplacementForEmptyString("emptyArray");
+      return;
+    }
+    if (content2.startsWith("#!replaceEmptyStringByVariable")) {
+      if (replacementForEmptyString !== "") {
+        error("A replacement for empty string has already been defined");
+      }
+      setReplacementForEmptyString("variable");
+      return;
+    }
     if (content2.startsWith("#!suppressWarnings ")) {
       var firstSpaceIndex = content2.indexOf(" ");
       globallySuppressedWarningTypes.push(
@@ -38681,6 +38695,18 @@ ${scriptText}`, {
       setRulePrefixTemplateFilestack(_rulePrefixTemplateFilestack);
       return;
     }
+    if (content2.startsWith("#!useVariableForCompressionAlphabet")) {
+      setUseVariableForCompressionAlphabet(true);
+      return;
+    }
+    if (content2.startsWith("#!debugElementCount")) {
+      setDebugElementCount(true);
+      return;
+    }
+    if (content2.startsWith("#!allowMacroRedeclaration")) {
+      setAllowMacroRedeclaration(true);
+      return;
+    }
     error("Unknown preprocessor directive '" + content2 + "'");
   }
   for (i = 0; i < content.length; moveCursor(1)) {
@@ -38989,7 +39015,11 @@ function parseMacro(initialMacroData) {
     replacement: isFunctionMacro ? trimmedMacroContent.substring(bracketPos[1] + 1).trim() : trimmedMacroContent.substring(trimmedMacroContent.indexOf(" ")).trim()
   };
   if (macros.some((m) => m.name === macro.name)) {
-    error("Macro '" + macro.name + "' is already defined");
+    if (allowMacroRedeclaration) {
+      macros.splice(macros.findIndex((m) => m.name === macro.name), 1);
+    } else {
+      error("Macro '" + macro.name + "' is already defined");
+    }
   }
   if (macro.text === macro.replacement) {
     error("Macro '" + macro.name + "' references itself");
@@ -45117,8 +45147,9 @@ astParsingFunctions.__if__ = function(content) {
       }
     }
   }
+  let isLoneIf = content.parent.childIndex === content.parent.children.length - 1 || content.parent.childIndex < content.parent.children.length - 1 && !["__elif__", "__else__"].includes(content.parent.children[content.parent.childIndex + 1].name);
   if (enableOptimization) {
-    if (content.children.length === 1 && (content.parent.childIndex === content.parent.children.length - 1 || content.parent.children[content.parent.childIndex + 1].name !== "__elif__" && content.parent.children[content.parent.childIndex + 1].name !== "__else__") && ["return", "loop", "__skip__"].includes(content.children[0].name)) {
+    if (content.children.length === 1 && isLoneIf && ["return", "loop", "__skip__"].includes(content.children[0].name)) {
       if (currentRuleHasVariableGoto) {
         content.parent.children.splice(content.parent.childIndex + 1, 0, content.children[0], getAstForUselessInstruction());
       }
@@ -45140,7 +45171,7 @@ astParsingFunctions.__if__ = function(content) {
       makeChildrenUseless(content.children);
     }
   }
-  if (content.parent.childIndex === content.parent.children.length - 1 || content.parent.childIndex < content.parent.children.length - 1 && !["__elif__", "__else__"].includes(content.parent.children[content.parent.childIndex + 1].name)) {
+  if (isLoneIf) {
     var includeEnd = true;
     if (enableOptimization && currentRuleEvent !== "__subroutine__" && content.parent.childIndex === content.parent.children.length - 1) {
       var root = content;
@@ -45156,6 +45187,16 @@ astParsingFunctions.__if__ = function(content) {
         }
       }
     }
+    if (optimizeForSize2 && (content.args[0].name === "__not__" || content.children.length === 1 && includeEnd && ["__equals__", "__inequals__", "__greaterThan__", "__greaterThanOrEquals__", "__lessThan__", "__lessThanOrEquals__"].includes(content.args[0].name))) {
+      let label = "__label_if_" + getUniqueNumber() + "__";
+      content.parent.children.splice(content.parent.childIndex + 1, 0, ...content.children, new Ast2(label, [], [], "Label"), getAstForUselessInstruction());
+      if (content.args[0].name === "__not__") {
+        content.args[0] = content.args[0].args[0];
+      } else {
+        content.args[0] = astParsingFunctions.__not__(new Ast2("__not__", [content.args[0]]));
+      }
+      return new Ast2("__skipIf__", [content.args[0], new Ast2("__distanceTo__", [new Ast2(label, [], [], "Label")])]);
+    }
     if (includeEnd) {
       content.parent.children.splice(content.parent.childIndex + 1, 0, getAstForEnd());
     }
@@ -45383,6 +45424,14 @@ astParsingFunctions.__negate__ = function(content) {
 };
 
 // src/compiler/functions/__not__.ts
+var inverseComparisonMapping = {
+  "__equals__": "__inequals__",
+  "__inequals__": "__equals__",
+  "__greaterThan__": "__lessThanOrEquals__",
+  "__greaterThanOrEquals__": "__lessThan__",
+  "__lessThan__": "__greaterThanOrEquals__",
+  "__lessThanOrEquals__": "__greaterThan__"
+};
 astParsingFunctions.__not__ = function(content) {
   if (enableOptimization) {
     if (isDefinitelyFalsy(content.args[0])) {
@@ -45400,6 +45449,9 @@ astParsingFunctions.__not__ = function(content) {
     if (content.args[0].name === ".isDead") {
       return new Ast2(".isAlive", [content.args[0].args[0]]);
     }
+    if (content.args[0].name in inverseComparisonMapping) {
+      return new Ast2(inverseComparisonMapping[content.args[0].name], content.args[0].args);
+    }
   }
   return content;
 };
@@ -46819,16 +46871,18 @@ function compressToString(compressionInfo) {
 }
 function getDecompressionAst(compressedString, compressionInfo) {
   let { minDecimalPlace, maxDecimalPlace, offset, arrayType } = compressionInfo;
+  let formulaAlphabet = useVariableForCompressionAlphabet ? "__compressionAlphabet__" : "x.last()";
+  let formulaCompressedArray = useVariableForCompressionAlphabet ? `$compressedString.split(null[0])` : `[e.concat(${escapeString(alphabet2, false)}) for e in $compressedString.split(null[0])]`;
   if (arrayType === "number") {
-    let decompressionFormula = Array(Math.ceil((maxDecimalPlace - minDecimalPlace) / 2)).fill(0).map((x, i) => i).map((x) => `${Math.pow(100, x + minDecimalPlace / 2)}*x.last().strIndex(x[0].charAt(${x}))`).join(" + ");
-    return parseOpyMacro(`[${decompressionFormula} - ${offset} for x in [e.concat(${escapeString(alphabet2, false)}) for e in $compressedString.split(null[0])]]`, ["$compressedString"], [compressedString]);
+    let decompressionFormula = Array(Math.ceil((maxDecimalPlace - minDecimalPlace) / 2)).fill(0).map((x, i) => i).map((x) => `${Math.pow(100, x + minDecimalPlace / 2)}*${formulaAlphabet}.strIndex(x.charAt(${x}))`).join(" + ");
+    return parseOpyMacro(`[${decompressionFormula} - ${offset} for x in ${formulaCompressedArray}]`, ["$compressedString"], [compressedString]);
   } else {
     let decompressionFormulas = Array(3).fill(0).map((_, h) => {
       return Array(Math.ceil((maxDecimalPlace - minDecimalPlace) / 2)).fill(0).map((x, i) => i).map((x) => `
-                    ${Math.pow(100, x + minDecimalPlace / 2)}*x.last().strIndex(x[0].charAt(${x + Math.ceil((maxDecimalPlace - minDecimalPlace) / 2) * h}))
+                    ${Math.pow(100, x + minDecimalPlace / 2)}*${formulaAlphabet}.strIndex(x.charAt(${x + Math.ceil((maxDecimalPlace - minDecimalPlace) / 2) * h}))
                 `).join(" + ");
     });
-    return parseOpyMacro(`[vect(${decompressionFormulas[0]},${decompressionFormulas[2]},${decompressionFormulas[1]}) - vect(1,1,1)*${offset} for x in [e.concat(${escapeString(alphabet2, false)}) for e in $compressedString.split(null[0])]]`, ["$compressedString"], [compressedString]);
+    return parseOpyMacro(`[vect(${decompressionFormulas[0]},${decompressionFormulas[2]},${decompressionFormulas[1]}) - vect(1,1,1)*${offset} for x in ${formulaCompressedArray}]`, ["$compressedString"], [compressedString]);
   }
 }
 astParsingFunctions.compressed = function(content) {
@@ -51548,7 +51602,8 @@ var actionKw = (
         {
           "name": "name",
           "description": "The name to be forced.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         }
       ],
       "return": "void",
@@ -53113,19 +53168,22 @@ var actionKw = (
           "name": "header",
           "description": "The text to be displayed (can be blank)",
           "type": "Object",
-          "default": null
+          "default": null,
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "subheader",
           "description": "The subheader text to be displayed (can be blank)",
           "type": "Object",
-          "default": null
+          "default": null,
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "text",
           "description": "The body text to be displayed (can be blank)",
           "type": "Object",
-          "default": null
+          "default": null,
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "location",
@@ -59619,7 +59677,10 @@ var valueFuncKw = (
         {
           "name": "condition",
           "description": "The mapping expression that is evaluated for each element of the copied array. Use the current array element value to reference the element of the array currently being considered.",
-          "type": "bool"
+          "type": [
+            "Object",
+            "Array"
+          ]
         }
       ],
       "isConstant": true,
@@ -60141,7 +60202,8 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The String value whose character to acquire.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "index",
@@ -60177,12 +60239,14 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The String Value from which to search for the character.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "character",
           "description": "The character for which to search",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         }
       ],
       isConstant: true,
@@ -60211,17 +60275,20 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The String Value with which to search for replacements.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "pattern",
           "description": "The String pattern to be replaced.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "replacement",
           "description": "The String Value with which to replace the pattern String",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         }
       ],
       isConstant: true,
@@ -60250,12 +60317,14 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The String Value to split.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "separator",
           "description": "The separator String with which to split the String Value.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         }
       ],
       "return": {
@@ -60286,7 +60355,8 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The string value from which to build the substring.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "substringStartIndex",
@@ -64050,12 +64120,14 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The string in which to search for the specified substring.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         },
         {
           "name": "substring",
           "description": "The substring for which to search.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         }
       ],
       "isConstant": true,
@@ -64083,7 +64155,8 @@ var valueFuncKw = (
         {
           "name": "string",
           "description": "The string whose characters to count.",
-          "type": "String"
+          "type": "String",
+          canReplaceEmptyStringByEmptyArray: true
         }
       ],
       "isConstant": true,
@@ -64482,6 +64555,7 @@ var valueFuncKw = (
 // src/compiler/astToWorkshop.ts
 function astRulesToWs(rules) {
   var compiledRules = [];
+  var ruleElementCounts = [];
   for (var rule of rules) {
     setCurrentRuleConditions([]);
     var result = "";
@@ -64530,9 +64604,11 @@ function astRulesToWs(rules) {
       popRulePrefixStack();
       continue;
     }
+    let elementsBefore = nbElements;
     if (rule.ruleAttributes.isDisabled) {
       result += tows("__disabled__", ruleKw) + " ";
     }
+    let oldRuleName = rule.ruleAttributes.name;
     let finalRuleName = applyRulePrefixTemplate(rule);
     result += tows("__rule__", ruleKw) + " (";
     result += escapeBadWords(escapeString(finalRuleName, true));
@@ -64572,12 +64648,23 @@ function astRulesToWs(rules) {
     }
     result += "}\n\n";
     incrementNbElements();
+    let ruleElements = nbElements - elementsBefore;
+    if (debugElementCount && ruleElements > 1) {
+      let { filePath } = getRuleFilePath(rule.fileStack);
+      ruleElementCounts.push({ name: oldRuleName, file: filePath, elements: ruleElements });
+      result = "//" + ruleElements + " element" + (ruleElements !== 1 ? "s" : "") + "\n" + result;
+    }
     compiledRules.push(result);
   }
+  let elementCountSummary = "";
+  if (debugElementCount && ruleElementCounts.length > 0) {
+    ruleElementCounts.sort((a, b) => b.elements - a.elements);
+    elementCountSummary = "/* Element count: (total " + nbElements + ")\n\n" + ruleElementCounts.map((r) => ("" + r.elements).padStart(5, " ") + ": rule " + escapeString(r.name, false) + (r.file ? " (" + r.file + ")" : "")).join("\n") + "\n\n*/\n\n";
+  }
   setOptimizationEnabled2(true);
   setOptimizeStrict2(false);
   setOptimizationForSize2(false);
-  return compiledRules;
+  return { compiledRules, elementCountSummary };
 }
 function astRuleConditionToWs(condition) {
   var funcToOpMapping = {
@@ -64589,6 +64676,7 @@ function astRuleConditionToWs(condition) {
     __greaterThan__: ">"
   };
   var result = "";
+  let nbElementsBefore = nbElements;
   if (condition.comment) {
     result += tabLevel(2) + escapeString(condition.comment.trim(), true) + "\n";
   }
@@ -64623,21 +64711,25 @@ function astRuleConditionToWs(condition) {
     incrementNbElements(Math.floor(nbHeroesInValue / 2));
     result += " " + funcToOpMapping[condition.name] + " ";
     resetNbHeroesInValue();
-    result += astToWs(condition.args[1]) + ";\n";
+    result += astToWs(condition.args[1]) + ";";
     incrementNbElements(Math.floor(nbHeroesInValue / 2));
   } else {
     resetNbHeroesInValue();
     incrementNbElements();
     if (condition.name === "__not__") {
-      result += tabLevel(2) + astToWs(condition.args[0]) + " == " + tows("false", valueFuncKw) + ";\n";
+      result += tabLevel(2) + astToWs(condition.args[0]) + " == " + tows("false", valueFuncKw) + ";";
     } else if (condition.type === "bool") {
-      result += tabLevel(2) + astToWs(condition) + " == " + tows("true", valueFuncKw) + ";\n";
+      result += tabLevel(2) + astToWs(condition) + " == " + tows("true", valueFuncKw) + ";";
     } else {
-      result += tabLevel(2) + astToWs(condition) + " != " + tows("false", valueFuncKw) + ";\n";
+      result += tabLevel(2) + astToWs(condition) + " != " + tows("false", valueFuncKw) + ";";
     }
     incrementNbElements(Math.floor(nbHeroesInValue / 2));
   }
   decrementNbElements();
+  if (debugElementCount) {
+    result += " // " + (nbElements - nbElementsBefore) + " element" + (nbElements - nbElementsBefore !== 1 ? "s" : "");
+  }
+  result += "\n";
   return result;
 }
 function astActionToWs(action, nbTabs2) {
@@ -64671,6 +64763,7 @@ function astActionToWs(action, nbTabs2) {
   if (action.type !== "void") {
     error("Expected an action, but got " + functionNameToString(action) + " which is a value", action.fileStack);
   }
+  let nbElementsBefore = nbElements;
   let result = "";
   if (action.name === "pass" && !action.comment) {
     action.comment = "pass";
@@ -64679,7 +64772,11 @@ function astActionToWs(action, nbTabs2) {
     result += `${tabLevel(nbTabs2)}${escapeString(action.comment.trim(), true)}
 `;
   }
-  result += tabLevel(nbTabs2) + astToWs(action) + ";\n";
+  result += tabLevel(nbTabs2) + astToWs(action) + ";";
+  if (debugElementCount) {
+    result += " // " + (nbElements - nbElementsBefore) + " element" + (nbElements - nbElementsBefore !== 1 ? "s" : "");
+  }
+  result += "\n";
   let oldEnableOptimization = enableOptimization;
   let oldOptimizeForSize = optimizeForSize2;
   let oldOptimizeStrict = optimizeStrict;
@@ -64745,6 +64842,24 @@ function astToWs(content) {
         return astToWs(new Ast2("Vector.BACKWARD"));
       }
       if (optimizeForSize2 && !(x === 0 && y === 0 && z === 0)) {
+        let vectorPairMapping = {
+          "1,1,0": ["left", "up"],
+          "1,-1,0": ["left", "down"],
+          "1,0,1": ["left", "forward"],
+          "1,0,-1": ["left", "backward"],
+          "-1,1,0": ["right", "up"],
+          "-1,-1,0": ["right", "down"],
+          "-1,0,1": ["right", "forward"],
+          "-1,0,-1": ["right", "backward"],
+          "0,1,1": ["up", "forward"],
+          "0,1,-1": ["up", "backward"],
+          "0,-1,1": ["down", "forward"],
+          "0,-1,-1": ["down", "backward"]
+        };
+        let vectorArgs = x + "," + y + "," + z;
+        if (vectorArgs in vectorPairMapping) {
+          return astToWs(new Ast2("__add__", [new Ast2("Vector." + vectorPairMapping[vectorArgs][0].toUpperCase()), new Ast2("Vector." + vectorPairMapping[vectorArgs][1].toUpperCase())]));
+        }
         if (y === 0 && z === 0) {
           return astToWs(new Ast2("__multiply__", [content.args[0], new Ast2("Vector.LEFT")]));
         }
@@ -64787,6 +64902,14 @@ function astToWs(content) {
         }
       } else if (replacementForTeam1 !== "" && content.args[i].name === "__team__" && content.args[i].args[0].name === "1") {
         content.args[i] = new Ast2(replacementForTeam1);
+      } else if (content.args[i].name === "__customString__" && content.args[i].args[0].name === "") {
+        if (argInfo.canReplaceEmptyStringByEmptyArray || replacementForEmptyString === "emptyArray") {
+          content.args[i] = getAstForEmptyArray();
+        } else if (replacementForEmptyString === "variable") {
+          content.args[i] = new Ast2("__globalVar__", [new Ast2("__emptyString__", [], [], "GlobalVariable")]);
+        } else {
+          content.args[i] = new Ast2(".charAt", [getAstForEmptyArray(), getAstForNull()]);
+        }
       }
     }
   }
@@ -65204,26 +65327,41 @@ function splitCustomString(tokens, args) {
   }
   return new Ast2("__customString__", [new Ast2(result, [], [], "CustomStringLiteral")].concat(resultArgs));
 }
-function applyRulePrefixTemplate(rule) {
-  let ruleName = rule.ruleAttributes.name;
-  let prefix = currentRulePrefix;
-  let fileStackForRule = rule.fileStack;
-  if (!prefix && !rulePrefixTemplate) {
-    return ruleName;
-  }
+function getRuleFilePath(fileStackForRule) {
   let fileName = "";
   let filePath = "";
   for (let k = fileStackForRule.length - 1; k >= 0; k--) {
     if (fileStackForRule[k].path) {
       let fullPath = fileStackForRule[k].path.replace(/\\/g, "/");
-      let baseName = fullPath.substring(fullPath.lastIndexOf("/") + 1);
-      fileName = baseName.replace(/\.opy$/i, "");
+      fileName = fullPath.substring(fullPath.lastIndexOf("/") + 1);
       filePath = fullPath.startsWith(rootPath) ? fullPath.substring(rootPath.length) : fullPath;
-      filePath = filePath.replace(/\.opy$/i, "");
       break;
     }
   }
-  let template = rulePrefixTemplate || 'f"[{$prefix}] {$rule}" if $prefix and $rule else $rule';
+  let pathParts = filePath.split("/");
+  let resolvedPathParts = [];
+  for (let part of pathParts) {
+    if (part === "..") {
+      if (resolvedPathParts.length > 0) {
+        resolvedPathParts.pop();
+      }
+    } else if (part !== ".") {
+      resolvedPathParts.push(part);
+    }
+  }
+  filePath = resolvedPathParts.join("/");
+  return { fileName, filePath };
+}
+function applyRulePrefixTemplate(rule) {
+  let ruleName = rule.ruleAttributes.name;
+  let prefix = currentRulePrefix;
+  if (!prefix && !rulePrefixTemplate) {
+    return ruleName;
+  }
+  let { fileName, filePath } = getRuleFilePath(rule.fileStack);
+  fileName = fileName.replace(/\.opy$/i, "");
+  filePath = filePath.replace(/\.opy$/i, "");
+  let template = rulePrefixTemplate || 'f"[{$prefix}] {$rule}" if $prefix and $rule and not $isDelimiter else $rule';
   let argNames = [
     "$rule",
     "$prefix",
@@ -65526,6 +65664,12 @@ async function compile(content, language = "en-US", _rootPath = "", _mainFileNam
   if (enableTagsSetup) {
     addVariable("__holygrail__", true, -1, getInternalFileStack());
   }
+  if (replacementForEmptyString === "variable") {
+    addVariable("__emptyString__", true, -1, getInternalFileStack(), tokenize("[].charAt(null)")[0].tokens);
+  }
+  if (useVariableForCompressionAlphabet) {
+    addVariable("__compressionAlphabet__", true, -1, getInternalFileStack(), tokenize(escapeString(alphabet2, false))[0].tokens);
+  }
   if (translationLanguages2.length > 0) {
     setTranslatedStrings(importFromPoFiles());
   }
@@ -65664,7 +65808,7 @@ rule "Disable inspector":
     encounteredWarnings: uniqueEncounteredWarnings,
     hiddenWarnings,
     enumMembers,
-    nbElements: nbElements2,
+    nbElements,
     activatedExtensions,
     spentExtensionPoints,
     availableExtensionPoints,
@@ -65677,16 +65821,16 @@ function compileRules(astRules) {
   if (DEBUG_MODE) {
     console.log(parsedAstRules);
   }
-  var compiledRules = astRulesToWs(parsedAstRules).join("");
+  var { compiledRules, elementCountSummary } = astRulesToWs(parsedAstRules);
   setFileStack(getInternalFileStack());
-  var result = compiledCustomGameSettings;
+  var result = elementCountSummary + compiledCustomGameSettings;
   if (!excludeVariablesInCompilation) {
     result += generateVariablesField();
     result += generateSubroutinesField();
   }
-  result += compiledRules;
-  if (nbElements2 > ELEMENT_LIMIT) {
-    warn("w_element_limit", "The gamemode is over the element limit (" + nbElements2 + " > " + ELEMENT_LIMIT + " elements)");
+  result += compiledRules.join("");
+  if (nbElements > ELEMENT_LIMIT) {
+    warn("w_element_limit", "The gamemode is over the element limit (" + nbElements + " > " + ELEMENT_LIMIT + " elements)");
   }
   var spentExtensionPoints = 0;
   for (var ext of activatedExtensions) {
@@ -65787,7 +65931,7 @@ function generateVariablesField() {
     }
   }
   if (result) {
-    result = tows("__variables__", ruleKw) + " {\n" + result + "}\n";
+    result = tows("__variables__", ruleKw) + " {\n" + result + "}\n\n";
   }
   return result;
 }
@@ -65835,7 +65979,7 @@ function generateSubroutinesField() {
     }
   }
   if (result) {
-    result = tows("__subroutines__", ruleKw) + " {\n" + result + "}\n";
+    result = tows("__subroutines__", ruleKw) + " {\n" + result + "}\n\n";
   }
   return result;
 }
@@ -66091,7 +66235,7 @@ function compileCustomGameSettings(customGameSettings) {
     result2 += tabLevel(nbTabs, true) + "}";
     return result2;
   }
-  setCompiledCustomGameSettings(tows("__settings__", ruleKw) + deserializeObject(result) + "\n");
+  setCompiledCustomGameSettings(tows("__settings__", ruleKw) + deserializeObject(result) + "\n\n");
 }
 
 // src/data/opy/textures.ts
@@ -66580,7 +66724,9 @@ function parseLines(lines) {
         }
         resetAstMacroLocalVariables();
         if (name in astMacros) {
-          error("Macro '" + name + "' already exists", lineMembers[0][1].fileStack);
+          if (!allowMacroRedeclaration) {
+            error("Macro '" + name + "' already exists", lineMembers[0][1].fileStack);
+          }
         }
         if (name in funcKw) {
           error("Macro '" + name + "' is already a built-in function", lineMembers[0][1].fileStack);
@@ -68994,7 +69140,7 @@ Wrapping a string with \`___\` has the same caveats as putting a translated stri
     return: "String"
   },
   "compressed": {
-    "description": "Compresses in-place the specified array of numbers or vectors into a string, then returns the decompressed array. Strings take much fewer elements, so use this function if you are running out of elements.\n\nNote that numbers will get rounded to 3 decimal places, and vectors to 2 decimal places.\n\nThis function is only effective once the array has at least 18 vectors or 26 numbers.\n\nThis function can be more effective than `compress()` and `decompressNumbers()` / `decompressVectors()`, as it can apply optimizations if all numbers have a low amount of significant digits or if they are all positive.",
+    "description": "Compresses in-place the specified array of numbers or vectors into a string, then returns the decompressed array. Strings take much fewer elements, so use this function if you are running out of elements.\n\nNote that numbers will get rounded to 3 decimal places, and vectors to 2 decimal places.\n\nThis function is only effective once the array has at least 5 vectors or 7 numbers (depending on the complexity; use `#!debugElementCount` to compare).\n\nThis function can be more effective than `compress()` and `decompressNumbers()` / `decompressVectors()`, as it can apply optimizations if all numbers have a low amount of significant digits or if they are all positive.",
     "args": [
       {
         "name": "array",
@@ -69553,9 +69699,11 @@ var replacementFor1 = "";
 var setReplacementFor1 = (replacement) => replacementFor1 = replacement;
 var replacementForTeam1 = "";
 var setReplacementForTeam1 = (replacement) => replacementForTeam1 = replacement;
-var nbElements2;
-var incrementNbElements = (amount = 1) => nbElements2 += amount;
-var decrementNbElements = (amount = 1) => nbElements2 -= amount;
+var replacementForEmptyString = "";
+var setReplacementForEmptyString = (replacement) => replacementForEmptyString = replacement;
+var nbElements;
+var incrementNbElements = (amount = 1) => nbElements += amount;
+var decrementNbElements = (amount = 1) => nbElements -= amount;
 var nbHeroesInValue;
 var resetNbHeroesInValue = () => nbHeroesInValue = 0;
 var incrementNbHeroesInValue = (amount = 1) => nbHeroesInValue += amount;
@@ -69592,6 +69740,10 @@ var playervarInitRuleName;
 var setPlayervarInitRuleName = (name) => playervarInitRuleName = name;
 var disableInspector = false;
 var setDisableInspector = (disable) => disableInspector = disable;
+var debugElementCount = false;
+var setDebugElementCount = (debug3) => debugElementCount = debug3;
+var allowMacroRedeclaration = false;
+var setAllowMacroRedeclaration = (allow) => allowMacroRedeclaration = allow;
 var rulePrefixStack = [];
 var currentRulePrefix = "";
 var setCurrentRulePrefix = (prefix) => currentRulePrefix = prefix;
@@ -69603,6 +69755,8 @@ var rulePrefixTemplate = "";
 var setRulePrefixTemplate = (template) => rulePrefixTemplate = template;
 var rulePrefixTemplateFilestack = [];
 var setRulePrefixTemplateFilestack = (filestack) => rulePrefixTemplateFilestack = filestack;
+var useVariableForCompressionAlphabet = false;
+var setUseVariableForCompressionAlphabet = (use) => useVariableForCompressionAlphabet = use;
 var decompilerGotos;
 var resetDecompilerGotos = () => decompilerGotos = [];
 var nbTabs;
@@ -69654,7 +69808,8 @@ function resetGlobalVariables(language) {
   replacementFor0 = "";
   replacementFor1 = "";
   replacementForTeam1 = "";
-  nbElements2 = 0;
+  replacementForEmptyString = "";
+  nbElements = 0;
   activatedExtensions = [];
   availableExtensionPoints = 0;
   enableTagsSetup = false;
@@ -69671,6 +69826,8 @@ function resetGlobalVariables(language) {
   globalvarInitRuleName = "Initialize global variables";
   playervarInitRuleName = "Initialize player variables";
   disableInspector = false;
+  debugElementCount = false;
+  allowMacroRedeclaration = false;
   keepUnusedTranslations = false;
   disableTranslationSourceLines = false;
   usedMaps = /* @__PURE__ */ new Set();
@@ -69679,6 +69836,7 @@ function resetGlobalVariables(language) {
   currentRulePrefix = "";
   rulePrefixTemplate = "";
   rulePrefixTemplateFilestack = [];
+  useVariableForCompressionAlphabet = false;
 }
 var operatorPrecedence = {
   "=": 1,
@@ -71957,10 +72115,16 @@ var key;
 
 // src/data/opy/preprocessing.ts
 var preprocessingDirectives = {
+  "allowMacroRedeclaration": {
+    "description": "If enabled, redefining a `macro` or `#!define` will not throw an error but will overwrite the previous definition. Can be useful for OOP-like projects where the same codebase is used for multiple different gamemodes."
+  },
   "define": {
     "description": '**Warning**: This directive performs a text-based replacement! Use `macro` or `const` instead, unless absolutely necessary.\n\nCreates a macro, like in C/C++. Macros must be defined before any code. Examples:\n\n    #!define currentSectionWalls A\n    #!define GAME_NOT_STARTED 3`\n\nFunction macros are supported as well:\n\n    #!define getFirstAvailableMei() [player for player in getPlayers(Team.2) if not player.isFighting][0]\n    #!define spawnMei(type, location)     getFirstAvailableMei().meiType = type\\\n    wait(0.1)\\\n    getFirstAvailableMei().teleport(location)\\\n    getFirstAvailableMei().isFighting = true\n\nNote the usage of the backslashed lines.\n\nJS scripts can be inserted with the special `__script__` function:\n\n    #!define addFive(x) __script__("addfive.js")\n\nwhere the `addfive.js` script contains `x+5` (no `return`).\n\nArguments of JS scripts are inserted automatically at the beginning (so `addFive(123)` would cause `var x = 123;` to be inserted). The script is then evaluated using `eval()`.\n\nA `vect()` function is also inserted, so that `vect(1,2,3)` returns an object with the correct properties and `toString()` function.\n\nWhen resolving the macro, the indentation on the macro call is prepended to each line of the replacement.\n',
     "snippet": "define $0"
   },
+  "debugElementCount": {
+    "description": "Generates a summary of the number of elements used by each rule at the top of the compilation result (sorted by element count descending), and adds a comment with the element count before each rule and after each condition/action."
+  },
   "disableInspector": {
     "description": "Adds a rule to disable the inspector at the very start of the gamemode."
   },
@@ -72075,6 +72239,16 @@ rule "Integrity check":
     @Condition getControlScoringTeam() != Team.1
     print("This gamemode cannot be played!")
 \`\`\`
+`
+  },
+  "replaceEmptyStringByEmptyArray": {
+    "description": `
+Replaces all instances of "" (empty string) by [] (empty array). WARNING: This might break your code in some cases (eg, \`.concat([])\` won't work because it unrolls the array)! Only use this if you are sure that it won't cause issues in your gamemode. Size optimizations must be enabled.
+`
+  },
+  "replaceEmptyStringByVariable": {
+    "description": `
+Replaces all instances of "" (empty string) by a global variable \`__emptyString__\`. This takes one more element per empty string than \`#!replaceEmptyStringByEmptyArray\`. Size optimizations must be enabled.
 `
   },
   "translations": {
@@ -72125,6 +72299,9 @@ You can specify \`noDetectionRule\` to not create the rule which sets the variab
 You can also specify \`noTlErr\` to have spectators view the default language when viewing a translated string (the \`__languageIndex__\` variable is now 0-indexed instead of 1-indexed). Keep in mind that, if translations aren't used properly, you may not see it if you playtest with the default language.
         `
   },
+  "useVariableForCompressionAlphabet": {
+    "description": `If enabled, the compression functions will use a global variable \`__compressionAlphabet__\` instead of a hardcoded string for the alphabet, which will save further elements.`
+  },
   "extension": {
     "description": "You shouldn't be reading this. Contact Zezombye if you can see this.",
     "snippet": "You shouldn't be reading this. Contact Zezombye if you can see this."

package/package.json

@@ -7,7 +7,7 @@
         "url": "https://github.com/Zezombye/overpy"
     },
     "description": "High-level language for the Overwatch Workshop, with decompilation and compilation.",
-    "version": "9.6.1",
+    "version": "9.6.3",
     "readme": "README.md",
     "keywords": [
         "overpy",