Merge pull request #5708 from kwvanderlinde/bugfix/5706-defineFunction-this

kwvanderlinde · web-flow · commit e30553f28a35 · 2025-07-22T08:25:47.000-07:00
1.18 - fix for lib: prefix handling
diff --git a/src/main/java/net/rptools/maptool/client/MapToolLineParser.java b/src/main/java/net/rptools/maptool/client/MapToolLineParser.java
@@ -1232,28 +1232,24 @@ public String runMacro(
     switch (mloc.getSource()) {
       case library, uri -> {
         try {
-          String namespace;
-          String macro;
-          switch (mloc.getSource()) {
-            case uri -> {
-              namespace = mloc.getUri().getHost();
-              macro = mloc.getUri().toString();
-            }
-            case library -> {
-              namespace = mloc.getLocation().replaceFirst("^(?i)lib:", "");
-              macro = mloc.getName();
-            }
-            case null, default -> {
-              throw new IllegalStateException("Unexpected value: " + mloc.getSource());
-            }
-          }
+          var namespace = mloc.getLocation();
           var lib = new LibraryManager().getLibrary(namespace);
           if (lib.isEmpty()) {
             throw new ParserException(
                 I18N.getText("lineParser.unknownLibToken", mloc.getLocation()));
           }
           var library = lib.get();
-          var macroInfo = library.getMTScriptMacroInfo(macro).get();
+
+          var macroInfoFuture =
+              switch (mloc.getSource()) {
+                case uri -> library.getMTScriptMacroInfoForUriPath(mloc.getName());
+                case library -> library.getMTScriptMacroInfo(mloc.getName());
+                case null, default -> {
+                  throw new IllegalStateException("Unexpected value: " + mloc.getSource());
+                }
+              };
+
+          var macroInfo = macroInfoFuture.get();
           if (macroInfo.isEmpty()) {
             // if the macro source is the same as the location then check private macros.
             if (!contextStackEmpty()) {
diff --git a/src/main/java/net/rptools/maptool/client/functions/DefineMacroFunction.java b/src/main/java/net/rptools/maptool/client/functions/DefineMacroFunction.java
@@ -60,7 +60,7 @@ public Object childEvaluate(
       if (macro.toLowerCase().endsWith("@this")) {
         macro =
             macro.substring(0, macro.length() - 4)
-                + MapTool.getParser().getMacroSource().getLocation();
+                + MapTool.getParser().getMacroSource().getCallableLocation();
       }
 
       boolean ignoreOutput = false;
diff --git a/src/main/java/net/rptools/maptool/client/functions/ParserPropertyFunctions.java b/src/main/java/net/rptools/maptool/client/functions/ParserPropertyFunctions.java
@@ -87,7 +87,7 @@ public Object childEvaluate(
       MapToolMacroContext mc = mtlParser.getContext();
       mco.addProperty("stackSize", mtlParser.getContextStackSize());
       mco.addProperty("name", mc.getName());
-      mco.addProperty("source", mc.getSource().getLocation());
+      mco.addProperty("source", mc.getSource().getCallableLocation());
       mco.addProperty("trusted", mc.isTrusted());
       if (mc.getMacroButtonIndex() >= 0) {
         mco.addProperty("buttonIndex", mc.getMacroButtonIndex());
diff --git a/src/main/java/net/rptools/maptool/client/functions/TokenPropertyFunctions.java b/src/main/java/net/rptools/maptool/client/functions/TokenPropertyFunctions.java
@@ -508,19 +508,8 @@ public Object childEvaluate(
     if (functionName.equalsIgnoreCase("getLibProperty")) {
       FunctionUtil.checkNumberParam(functionName, parameters, 1, 2);
       String propertyName = parameters.get(0).toString();
-      String location;
-      if (parameters.size() > 1) {
-        location = parameters.get(1).toString();
-      } else {
-        location = MapTool.getParser().getMacroSource().getLocation();
-      }
 
-      String libName;
-      if (location.toLowerCase().startsWith("lib:")) {
-        libName = location.substring(4);
-      } else {
-        libName = location;
-      }
+      String libName = findLibNamespaceFromParams(parameters, 1, false);
 
       try {
         var library =
@@ -550,20 +539,7 @@ public Object childEvaluate(
       FunctionUtil.checkNumberParam(functionName, parameters, 2, 3);
       String property = parameters.get(0).toString();
       Object value = parameters.get(1);
-
-      String location;
-      if (parameters.size() > 2) {
-        location = parameters.get(2).toString();
-      } else {
-        location = MapTool.getParser().getMacroSource().getLocation();
-      }
-
-      String libName;
-      if (location.toLowerCase().startsWith("lib:")) {
-        libName = location.substring(4);
-      } else {
-        libName = location;
-      }
+      String libName = findLibNamespaceFromParams(parameters, 2, false);
 
       var library =
           new LibraryManager()
@@ -589,22 +565,7 @@ public Object childEvaluate(
      */
     if (functionName.equalsIgnoreCase("getLibPropertyNames")) {
       FunctionUtil.checkNumberParam(functionName, parameters, 0, 2);
-      String location;
-      if (parameters.size() > 0) {
-        location = parameters.get(0).toString();
-        if (location.equals("*") || location.equalsIgnoreCase("this")) {
-          location = MapTool.getParser().getMacroSource().getLocation();
-        }
-      } else {
-        location = MapTool.getParser().getMacroSource().getLocation();
-      }
-
-      String libName;
-      if (location.toLowerCase().startsWith("lib:")) {
-        libName = location.substring(4);
-      } else {
-        libName = location;
-      }
+      String libName = findLibNamespaceFromParams(parameters, 0, true);
       String delim = parameters.size() > 1 ? parameters.get(1).toString() : ",";
       return getMatchingLibProperties(libName, delim, ".*", functionName);
     }
@@ -614,23 +575,8 @@ public Object childEvaluate(
      */
     if (functionName.equalsIgnoreCase("getMatchingLibProperties")) {
       FunctionUtil.checkNumberParam(functionName, parameters, 1, 3);
-      String location;
       String pattern = parameters.get(0).toString();
-      if (parameters.size() > 1) {
-        location = parameters.get(1).toString();
-        if (location.equals("*") || location.equalsIgnoreCase("this")) {
-          location = MapTool.getParser().getMacroSource().getLocation();
-        }
-      } else {
-        location = MapTool.getParser().getMacroSource().getLocation();
-      }
-
-      String libName;
-      if (location.toLowerCase().startsWith("lib:")) {
-        libName = location.substring(4);
-      } else {
-        libName = location;
-      }
+      String libName = findLibNamespaceFromParams(parameters, 1, true);
 
       String delim = parameters.size() > 2 ? parameters.get(2).toString() : ",";
       return getMatchingLibProperties(libName, delim, pattern, functionName);
@@ -1338,4 +1284,18 @@ private BigDecimal getBigDecimalFromParam(String functionName, List<Object> para
               "macro.function.general.argumentTypeN", functionName, index, param.toString()));
     }
   }
+
+  private String findLibNamespaceFromParams(
+      List<Object> parameters, int libIndex, boolean allowWildcards) {
+    if (parameters.size() <= libIndex) {
+      return MapTool.getParser().getMacroSource().getLocation();
+    }
+
+    var location = parameters.get(libIndex).toString();
+    if (allowWildcards && (location.equals("*") || location.equalsIgnoreCase("this"))) {
+      return MapTool.getParser().getMacroSource().getLocation();
+    }
+
+    return location.toLowerCase().startsWith("lib:") ? location.substring(4) : location;
+  }
 }
diff --git a/src/main/java/net/rptools/maptool/client/macro/impl/SayMacro.java b/src/main/java/net/rptools/maptool/client/macro/impl/SayMacro.java
@@ -37,7 +37,7 @@ public void execute(MacroContext context, String macro, MapToolMacroContext exec
               null,
               MapTool.getParser().isMacroPathTrusted(),
               executionContext.getName(),
-              executionContext.getSource().getLocation());
+              executionContext.getSource().getCallableLocation());
     } else {
       msg = MessageUtil.getFormattedSay(macro, null, false, null, null);
     }
diff --git a/src/main/java/net/rptools/maptool/client/macro/impl/ToGMMacro.java b/src/main/java/net/rptools/maptool/client/macro/impl/ToGMMacro.java
@@ -36,7 +36,7 @@ public void execute(MacroContext context, String macro, MapToolMacroContext exec
               MapTool.getPlayer().getName(),
               MapTool.getParser().isMacroPathTrusted(),
               executionContext.getName(),
-              executionContext.getSource().getLocation());
+              executionContext.getSource().getCallableLocation());
     } else {
       toGmMsg =
           MessageUtil.getFormattedToGmRecipient(
diff --git a/src/main/java/net/rptools/maptool/model/library/Library.java b/src/main/java/net/rptools/maptool/model/library/Library.java
@@ -154,6 +154,14 @@ public interface Library {
    */
   CompletableFuture<LibraryInfo> getLibraryInfo();
 
+  /**
+   * Returns the information about MapTool Macro Script on this library.
+   *
+   * @param macroPath The path to the macro, as used in lib: URIs.
+   * @return the information about the MapTool Macro Script.
+   */
+  CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfoForUriPath(String macroPath);
+
   /**
    * Returns the information about MapTool Macro Script on this library.
    *
diff --git a/src/main/java/net/rptools/maptool/model/library/addon/AddOnLibrary.java b/src/main/java/net/rptools/maptool/model/library/addon/AddOnLibrary.java
@@ -359,6 +359,13 @@ private CompletableFuture<Optional<MTScriptMacroInfo>> getMacroInfo(
         });
   }
 
+  @Override
+  public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfoForUriPath(
+      String macroPath) {
+    // For add-ons, the path and the macro name are the same.
+    return getMTScriptMacroInfo(macroPath);
+  }
+
   @Override
   public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfo(String macroName) {
     var macro = mtsFunctionAssetMap.get(MTSCRIPT_PUBLIC_DIR + macroName);
diff --git a/src/main/java/net/rptools/maptool/model/library/builtin/ClassPathAddOnLibrary.java b/src/main/java/net/rptools/maptool/model/library/builtin/ClassPathAddOnLibrary.java
@@ -131,6 +131,12 @@ public CompletableFuture<LibraryInfo> getLibraryInfo() {
     return addOnLibrary.getLibraryInfo();
   }
 
+  @Override
+  public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfoForUriPath(
+      String macroPath) {
+    return addOnLibrary.getMTScriptMacroInfoForUriPath(macroPath);
+  }
+
   @Override
   public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfo(String macroName) {
     return addOnLibrary.getMTScriptMacroInfo(macroName);
diff --git a/src/main/java/net/rptools/maptool/model/library/builtin/MapToolBuiltInLibrary.java b/src/main/java/net/rptools/maptool/model/library/builtin/MapToolBuiltInLibrary.java
@@ -223,6 +223,12 @@ public CompletableFuture<LibraryInfo> getLibraryInfo() {
             licenseFile.isEmpty() ? null : licenseFile));
   }
 
+  @Override
+  public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfoForUriPath(
+      String macroPath) {
+    return CompletableFuture.completedFuture(Optional.empty());
+  }
+
   @Override
   public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfo(String macroName) {
     return CompletableFuture.completedFuture(Optional.empty());
diff --git a/src/main/java/net/rptools/maptool/model/library/token/LibraryToken.java b/src/main/java/net/rptools/maptool/model/library/token/LibraryToken.java
@@ -300,21 +300,24 @@ public CompletableFuture<LibraryInfo> getLibraryInfo() {
             null));
   }
 
+  @Override
+  public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfoForUriPath(
+      String macroPath) {
+    final var prefix = "macro/";
+    if (!macroPath.toLowerCase().startsWith(prefix)) {
+      return CompletableFuture.completedFuture(Optional.empty());
+    }
+
+    return getMTScriptMacroInfo(macroPath.substring(prefix.length()));
+  }
+
   @Override
   public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfo(String macroName) {
     return new ThreadExecutionHelper<Optional<MTScriptMacroInfo>>()
         .runOnSwingThread(
             () -> {
-              // Cater for the different ways the macro name can be specified
-              String expectedMacroName = macroName;
-              if (macroName.toLowerCase().startsWith("lib://")) {
-                expectedMacroName = macroName.replaceFirst("(?i)lib:\\/\\/.*\\/macro\\/", "");
-              } else if (macroName.toLowerCase().startsWith("lib:")) {
-                expectedMacroName = macroName.substring(4);
-              }
-
               Token library = findLibrary(id);
-              MacroButtonProperties buttonProps = library.getMacro(expectedMacroName, false);
+              MacroButtonProperties buttonProps = library.getMacro(macroName, false);
               if (buttonProps == null) {
                 // Try the "unknown macro"
                 buttonProps = library.getMacro(UNKNOWN_LIB_MACRO, false);
@@ -325,7 +328,7 @@ public CompletableFuture<Optional<MTScriptMacroInfo>> getMTScriptMacroInfo(Strin
 
               return Optional.of(
                   new MTScriptMacroInfo(
-                      expectedMacroName,
+                      macroName,
                       buttonProps.getCommand(),
                       library.isOwnedByNone() || !buttonProps.getAllowPlayerEdits(),
                       !buttonProps.getAllowPlayerEdits() && buttonProps.getAutoExecute(),
diff --git a/src/main/java/net/rptools/maptool/model/library/token/LibraryTokenManager.java b/src/main/java/net/rptools/maptool/model/library/token/LibraryTokenManager.java
@@ -229,9 +229,7 @@ public CompletableFuture<Library> getLibrary(String namespace) {
     return new ThreadExecutionHelper<Library>()
         .runOnSwingThread(
             () -> {
-              var libNamespace =
-                  namespace.toLowerCase().startsWith("lib:") ? namespace : "lib:" + namespace;
-              var tokenList = getTokensWithName(libNamespace);
+              var tokenList = getTokensWithName("lib:" + namespace);
               if (tokenList.isEmpty()) {
                 return null;
               } else {

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public Object childEvaluate(`
`60`	`60`	`if (macro.toLowerCase().endsWith("@this")) {`
`61`	`61`	`macro =`
`62`	`62`	`macro.substring(0, macro.length() - 4)`
`63`		`- + MapTool.getParser().getMacroSource().getLocation();`
	`63`	`+ + MapTool.getParser().getMacroSource().getCallableLocation();`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`boolean ignoreOutput = false;`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public void execute(MacroContext context, String macro, MapToolMacroContext exec`
`37`	`37`	`null,`
`38`	`38`	`MapTool.getParser().isMacroPathTrusted(),`
`39`	`39`	`executionContext.getName(),`
`40`		`- executionContext.getSource().getLocation());`
	`40`	`+ executionContext.getSource().getCallableLocation());`
`41`	`41`	`} else {`
`42`	`42`	`msg = MessageUtil.getFormattedSay(macro, null, false, null, null);`
`43`	`43`	`}`