Use delimiters literally in macro functions #4381
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`JSONMacroFunctionsOld` and `MapTool.addGlobalMessage(String, String, String)` are not in use, so have been removed.
These functions had their delimiters interpreted as regex rather than literal strings: - json.toList() - 2nd parameter - json.fromStrProp() - 2nd parameter - execLink() - 4th parameter - execFunction() - 5th parameter - selectTokens() - 3rd parameter - deselectTokens() - 2nd parameter - broadcast() - 3rd parameter - exposeFOW() - 3rd parameter - input() - "DELIMITER=" for lists and radios This was done by introducing a new `StringUtil.split()` utility method, and changing the implementation of these functions to use it instead of `String.split()` directly.
kwvanderlinde
force-pushed
the
bugfix/4380-split-delimiters
branch
from
8364590 to
27dc1c7
Compare
cwisniew
approved these changes
Nov 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Identify the Bug or Feature request
#4380
Description of the Change
Introduces a
StringUtil.split()function that macro functions and others can use to split strings using a literal delimiter.The following functions were updated to use
StringUtil.split()and thus no longer interpret their delimiters as regex:json.toList()json.fromStrProp()execLink()execFunction()selectTokens()deselectTokens()broadcast()exposeFOW()input()Also removed are the unused
JSONMacroFunctionsOldclass and theMapTool.addGlobalMessage(String, String, String)method which also had improper uses ofString.split().Possible Drawbacks
Existing macros that depend on the incorrect behaviour will need to be updated.
Documentation Notes
This brings each function in line with its documentation.
Release Notes
This change is