Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add slash command macro functions #4249

Merged
merged 14 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
441 changes: 441 additions & 0 deletions src/main/gen/MTScript2Lexer.interp

Large diffs are not rendered by default.

1,347 changes: 1,347 additions & 0 deletions src/main/gen/MTScript2Lexer.java

Large diffs are not rendered by default.

249 changes: 249 additions & 0 deletions src/main/gen/MTScript2Lexer.tokens
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
OPEN_SCRIPT_MODE=1
OPEN_ROLL_MODE=2
OPEN_MARKDOWN_LINK_MODE=3
OPEN_HANDLBARS_RAW_MODE=4
OPEN_HANDLEBARS_MODE=5
TEXT=6
CLOSE_HANDLEBARS_MODE=7
HANDLEBARS_TEXT=8
CLOSE_HANDLEBARS_RAW_MODE=9
HANDLEBARS_RAW_TEXT=10
CLOSE_MARKDOWN_LINK_MODE=11
MARKDOWN_LINK_TEXT=12
CLOSE_ROLL_MODE=13
ROLL_DECIMAL_LITERAL=14
ROLL_IDENTIFIER=15
ROLL_WS=16
CLOSE_EMBEDED_ROLL_MODE=17
EM_ROLL_DECIMAL_LITERAL=18
EM_ROLL_IDENTIFIER=19
EM_ROLL_WS=20
OPEN_EMBEDED_ROLL_MODE=21
CLOSE_SCRIPT_MODE=22
KEYWORD_ASSERT=23
KEYWORD_BREAK=24
KEYWORD_CASE=25
KEYWORD_CONST=26
KEYWORD_VAR=27
KEYWORD_REF=28
KEYWORD_CONTINUE=29
KEYWORD_DEFAULT=30
KEYWORD_DO=31
KEYWORD_ELSE=32
KEYWORD_FOR=33
KEYWORD_FOREACH=34
KEYWORD_FUNCTION=35
KEYWORD_PROCEDURE=36
KEYWORD_IF=37
KEYWORD_RETURN=38
KEYWORD_SWITCH=39
KEYWORD_WHILE=40
KEYWORD_TRY=41
KEYWORD_CATCH=42
KEYWORD_FINALLY=43
KEYWORD_THROW=44
KEYWORD_TYPE=45
KEYWORD_OF=46
KEYWORD_YIELD=47
KEYWORD_DATA=48
KEYWORD_PRINT=49
KEYWORD_DEBUG=50
KEYWORD_LOG=51
KEYWORD_ERROR=52
KEYWORD_WARN=53
KEYWORD_INFO=54
KEYWORD_I18N=55
KEYWORD_USING=56
KEYWORD_USE=57
KEYWORD_AS=58
KEYWORD_FROM=59
KEYWORD_EXPORT=60
KEYWORD_IMPORT=61
KEYWORD_INTERNAL=62
KEYWORD_CHAT=63
KEYWORD_GM=64
KEYWORD_TRUSTED=65
PROPERTY_LEADER=66
REFERENCE_LEADER=67
STRING_INTERPORLATION_PREFIX=68
KEYWORD_BOOLEAN=69
KEYWORD_NUMBER=70
KEYWORD_STRING=71
KEYWORD_LIST=72
KEYWORD_DICT=73
KEYWORD_INT=74
KEYWORD_ROLL=75
KEYWORD_ANY=76
KEYWORD_MAP=77
KEYWORD_TOKEN=78
KEYWORD_ACTOR=79
KEYWORD_IMAGE=80
KEYWORD_SOUND=81
KEYWORD_TABLE=82
KEYWORD_LIGHT=83
KEYWORD_LIGHTSOURCE=84
KEYWORD_PATH=85
KEYWORD_ITEM=86
DECIMAL_LITERAL=87
HEX_LITERAL=88
NUMBER_LITERAL=89
BOOL_LITERAL=90
STRING_LITERAL=91
NULL_LITERAL=92
NONE_LITERAL=93
LPAREN=94
RPAREN=95
LBRACE=96
RBRACE=97
LBRACK=98
RBRACK=99
SEMI=100
COMMA=101
DOT=102
COLON=103
OP_GT=104
OP_LT=105
OP_BANG=106
OP_TILDE=107
OP_QUESTION=108
OP_EQUAL=109
OP_LE=110
OP_GE=111
OP_NOTEQUAL=112
OP_AND=113
OP_OR=114
OP_INC=115
OP_DEC=116
OP_ADD=117
OP_SUB=118
OP_MUL=119
OP_DIV=120
OP_BITAND=121
OP_BITOR=122
OP_CARET=123
OP_MOD=124
OP_ASSIGN=125
OP_ADD_ASSIGN=126
OP_SUB_ASSIGN=127
OP_MUL_ASSIGN=128
OP_DIV_ASSIGN=129
OP_AND_ASSIGN=130
OP_OR_ASSIGN=131
OP_XOR_ASSIGN=132
OP_MOD_ASSIGN=133
OP_ARROW=134
WS=135
COMMENT=136
LINE_COMMENT=137
IDENTIFIER=138
'[[['=1
'{{{'=4
'{{'=5
'}}'=7
'}}}'=9
']]]'=22
'assert'=23
'break'=24
'case'=25
'const'=26
'var'=27
'ref'=28
'continue'=29
'default'=30
'do'=31
'else'=32
'for'=33
'foreach'=34
'function'=35
'procedure'=36
'if'=37
'return'=38
'switch'=39
'while'=40
'try'=41
'catch'=42
'finally'=43
'throw'=44
'type'=45
'of'=46
'yield'=47
'data'=48
'print'=49
'debug'=50
'log'=51
'error'=52
'warn'=53
'info'=54
'i18n'=55
'using'=56
'uses'=57
'as'=58
'from'=59
'export'=60
'import'=61
'internal'=62
'chat'=63
'gm'=64
'trusted'=65
'@'=66
'#'=67
'$'=68
'bool'=69
'number'=70
'string'=71
'list'=72
'dict'=73
'int'=74
'roll'=75
'any'=76
'map'=77
'token'=78
'actor'=79
'image'=80
'sound'=81
'table'=82
'light'=83
'lightsource'=84
'path'=85
'item'=86
'null'=92
'none'=93
'('=94
')'=95
'{'=96
'}'=97
';'=100
','=101
'.'=102
':'=103
'>'=104
'<'=105
'!'=106
'~'=107
'?'=108
'=='=109
'<='=110
'>='=111
'!='=112
'&&'=113
'||'=114
'++'=115
'--'=116
'+'=117
'-'=118
'*'=119
'/'=120
'&'=121
'|'=122
'^'=123
'%'=124
'='=125
'+='=126
'-='=127
'*='=128
'/='=129
'&='=130
'|='=131
'^='=132
'%='=133
'->'=134
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ public class MapToolExpressionParser extends ExpressionParser {
new PlayerFunctions(),
new LibraryFunctions(),
new DataFunctions(),
new ServerFunctions())
new ServerFunctions(),
new SlashCommands())
.collect(Collectors.toList());

public MapToolExpressionParser() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/*
* This software Copyright by the RPTools.net development team, and
* licensed under the Affero GPL Version 3 or, at your option, any later
* version.
*
* MapTool Source Code is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the GNU Affero General Public
* License * along with this source Code. If not, please visit
* <http://www.gnu.org/licenses/> and specifically the Affero license
* text at <http://www.gnu.org/licenses/agpl.html>.
*/
package net.rptools.maptool.client.functions;

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import java.util.List;
import net.rptools.maptool.client.macro.MacroManager;
import net.rptools.maptool.client.macro.MacroManager.Scope;
import net.rptools.maptool.language.I18N;
import net.rptools.maptool.util.FunctionUtil;
import net.rptools.parser.Parser;
import net.rptools.parser.ParserException;
import net.rptools.parser.VariableResolver;
import net.rptools.parser.function.AbstractFunction;

/** Class that implements slash command alias functions. */
public class SlashCommands extends AbstractFunction {

/** Creates a new {@code SlashCommands} object. */
public SlashCommands() {
super(0, 3, "slash.setAlias", "slash.getAliases", "slash.clearAlias");
}

@Override
public Object childEvaluate(
Parser parser, VariableResolver resolver, String functionName, List<Object> parameters)
throws ParserException {

String fName = functionName.toLowerCase();
return switch (fName) {
case "slash.setalias" -> setSlashAlias(parameters);
case "slash.getaliases" -> getSlashAliases();
case "slash.clearalias" -> clearSlashAlias(parameters);
default -> throw new ParserException(
I18N.getText("macro.function.general.unknownFunction", functionName));
};
}

/**
* Sets a slash command alias.
*
* @param args The arguments to the function.
* @return empty string
* @throws ParserException if the number of arguments is incorrect.
*/
private Object setSlashAlias(List<Object> args) throws ParserException {
FunctionUtil.checkNumberParam("slash.setAlias", args, 2, 3);
String desc;
if (args.size() == 3) {
desc = args.get(2).toString();
} else {
desc = "";
}
MacroManager.setAlias(args.get(0).toString(), args.get(1).toString(), Scope.CAMPAIGN, desc);
return "";
}

/**
* Gets the slash command aliases.
*
* @return a JSON string containing the aliases.
*/
private JsonElement getSlashAliases() {
Gson gson = new Gson();
return gson.toJsonTree(MacroManager.getAliasCommandMap());
}

/**
* Clears a slash command alias.
*
* @param args The arguments to the function.
* @return empty string
* @throws ParserException if the number of arguments is incorrect.
*/
private Object clearSlashAlias(List<Object> args) throws ParserException {
FunctionUtil.checkNumberParam("server.clearAlias", args, 1, 1);
MacroManager.removeAlias(args.get(0).toString());
return "";
}
}