Skip to content

Add built-in function and operators #370

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.

Sign up for GitHub

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

Draft
shoucandanghehe wants to merge 1 commit into
base: 1.19.2
Choose a base branch
from
Draft

Add built-in function and operators #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions src/main/antlr/sfml/SFML.g4
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ limit : quantity retention #QuantityRetentionLimit
| quantity #QuantityLimit
;

quantity : number EACH?;
retention : RETAIN number EACH?;
quantity : numexpr EACH?;
retention : RETAIN numexpr EACH?;

resourceExclusion : EXCEPT resourceIdList;

Expand Down Expand Up @@ -105,8 +105,23 @@ boolexpr : TRUE #BooleanTrue
| NOT boolexpr #BooleanNegation
| boolexpr AND boolexpr #BooleanConjunction
| boolexpr OR boolexpr #BooleanDisjunction
| setOp? labelAccess HAS comparisonOp number resourceIdDisjunction? with? (EXCEPT resourceIdList)? #BooleanHas
| REDSTONE (comparisonOp number)? #BooleanRedstone
| setOp? labelAccess HAS comparisonOp numexpr resourceIdDisjunction? with? (EXCEPT resourceIdList)? #BooleanHas
| REDSTONE (comparisonOp numexpr)? #BooleanRedstone
;

numexpr : numterm ((PLUS | DASH) numterm)*;
numterm : numfactor ((STAR | SLASH) numfactor)*;
numfactor : number
| LPAREN numexpr RPAREN
| functionCall
;

// more flexible function args
functionCall : identifier LPAREN (functionArg (COMMA functionArg)*)? RPAREN;
functionArg : labelAccess
| resourceIdDisjunction
| numexpr
| string
;

comparisonOp : GT
Expand Down Expand Up @@ -142,7 +157,7 @@ label : (identifier) #RawLabel
| string #StringLabel
;

identifier : (IDENTIFIER | REDSTONE | GLOBAL | SECOND | SECONDS) ;
identifier : (IDENTIFIER | STAR | REDSTONE | GLOBAL | SECOND | SECONDS) ;

// GENERAL
string: STRING ;
Expand Down Expand Up @@ -244,13 +259,14 @@ COMMA : ',';
COLON : ':';
SLASH : '/';
DASH : '-';
STAR : '*';
LPAREN : '(';
RPAREN : ')';


NUMBER_WITH_G_SUFFIX : [0-9]+[gG] ;
NUMBER : [0-9]+ ;
IDENTIFIER : [a-zA-Z_*][a-zA-Z0-9_*]* | '*'; // Note that the * in the square brackets is a literl
IDENTIFIER : [a-zA-Z_*][a-zA-Z0-9_*]* ;

STRING : '"' (~'"'|'\\"')* '"' ;

Expand Down
194 changes: 170 additions & 24 deletions src/main/java/ca/teamdman/sfml/ast/ASTBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public List<Pair<ASTNode, ParserRuleContext>> getNodesUnderCursor(int cursorPos)
.stream()
.filter(pair -> pair.getSecond() != null)
.filter(pair -> pair.getSecond().start.getStartIndex() <= cursorPos
&& pair.getSecond().stop.getStopIndex() >= cursorPos)
&& pair.getSecond().stop.getStopIndex() >= cursorPos)
.collect(Collectors.toList());
}

Expand Down Expand Up @@ -112,8 +112,8 @@ public Label visitRawLabel(SFMLParser.RawLabelContext ctx) {
if (label.name().length() > Program.MAX_LABEL_LENGTH) {
throw new IllegalArgumentException(
"Label name cannot be longer than "
+ Program.MAX_LABEL_LENGTH
+ " characters."
+ Program.MAX_LABEL_LENGTH
+ " characters."
);
}
USED_LABELS.add(label);
Expand All @@ -127,8 +127,8 @@ public Label visitStringLabel(SFMLParser.StringLabelContext ctx) {
if (label.name().length() > Program.MAX_LABEL_LENGTH) {
throw new IllegalArgumentException(
"Label name cannot be longer than "
+ Program.MAX_LABEL_LENGTH
+ " characters."
+ Program.MAX_LABEL_LENGTH
+ " characters."
);
}
USED_LABELS.add(label);
Expand Down Expand Up @@ -166,8 +166,8 @@ public ASTNode visitTimerTrigger(SFMLParser.TimerTriggerContext ctx) {

// get default min interval
int minInterval = timerTrigger.usesOnlyForgeEnergyResourceIO()
? SFMConfig.getOrDefault(SFMConfig.SERVER_CONFIG.timerTriggerMinimumIntervalInTicksWhenOnlyForgeEnergyIO)
: SFMConfig.getOrDefault(SFMConfig.SERVER_CONFIG.timerTriggerMinimumIntervalInTicks);
? SFMConfig.getOrDefault(SFMConfig.SERVER_CONFIG.timerTriggerMinimumIntervalInTicksWhenOnlyForgeEnergyIO)
: SFMConfig.getOrDefault(SFMConfig.SERVER_CONFIG.timerTriggerMinimumIntervalInTicks);

// validate interval
if (time.ticks() < minInterval) {
Expand All @@ -181,15 +181,12 @@ public ASTNode visitTimerTrigger(SFMLParser.TimerTriggerContext ctx) {
@Override
public ASTNode visitBooleanRedstone(SFMLParser.BooleanRedstoneContext ctx) {
ComparisonOperator comp = ComparisonOperator.GREATER_OR_EQUAL;
Number num = new Number(0);
if (ctx.comparisonOp() != null && ctx.number() != null) {
NumExpr rhs = new Number(0);
if (ctx.comparisonOp() != null && ctx.numexpr() != null) {
comp = visitComparisonOp(ctx.comparisonOp());
num = visitNumber(ctx.number());
rhs = visitNumexpr(ctx.numexpr());
}
if (num.value() > Integer.MAX_VALUE) {
throw new IllegalArgumentException("Redstone signal strength cannot be greater than " + Integer.MAX_VALUE);
}
BoolExpr boolExpr = new BoolRedstone(comp, (int) num.value());
BoolExpr boolExpr = new BoolRedstone(comp, rhs);
AST_NODE_CONTEXTS.add(new Pair<>(boolExpr, ctx));
return boolExpr;
}
Expand Down Expand Up @@ -311,8 +308,8 @@ public LabelAccess visitLabelAccess(SFMLParser.LabelAccessContext ctx) {
public RoundRobin visitRoundrobin(@Nullable SFMLParser.RoundrobinContext ctx) {
if (ctx == null) return RoundRobin.disabled();
RoundRobin rtn = ctx.BLOCK() != null
? new RoundRobin(RoundRobin.Behaviour.BY_BLOCK)
: new RoundRobin(RoundRobin.Behaviour.BY_LABEL);
? new RoundRobin(RoundRobin.Behaviour.BY_BLOCK)
: new RoundRobin(RoundRobin.Behaviour.BY_LABEL);
AST_NODE_CONTEXTS.add(new Pair<>(rtn, ctx));
return rtn;
}
Expand Down Expand Up @@ -365,7 +362,7 @@ public BoolExpr visitBooleanHas(SFMLParser.BooleanHasContext ctx) {
var setOperator = visitSetOp(ctx.setOp());
var labelAccess = visitLabelAccess(ctx.labelAccess());
ComparisonOperator comparisonOperator = visitComparisonOp(ctx.comparisonOp());
Number num = visitNumber(ctx.number());
NumExpr num = visitNumexpr(ctx.numexpr());
ResourceIdSet resourceIdSet;
if (ctx.resourceIdDisjunction() == null) {
resourceIdSet = ResourceIdSet.MATCH_ALL;
Expand All @@ -384,7 +381,7 @@ public BoolExpr visitBooleanHas(SFMLParser.BooleanHasContext ctx) {
} else {
except = visitResourceIdList(ctx.resourceIdList());
}
BoolHas rtn = new BoolHas(setOperator, labelAccess, comparisonOperator, num.value(), resourceIdSet, with, except);
BoolHas rtn = new BoolHas(setOperator, labelAccess, comparisonOperator, num, resourceIdSet, with, except);
AST_NODE_CONTEXTS.add(new Pair<>(rtn, ctx));
return rtn;
}
Expand Down Expand Up @@ -704,10 +701,10 @@ public ResourceQuantity visitRetention(@Nullable SFMLParser.RetentionContext ctx
if (ctx == null)
return ResourceQuantity.UNSET;
ResourceQuantity quantity = new ResourceQuantity(
visitNumber(ctx.number()),
visitNumexpr(ctx.numexpr()),
ctx.EACH() != null
? ResourceQuantity.IdExpansionBehaviour.EXPAND
: ResourceQuantity.IdExpansionBehaviour.NO_EXPAND
? ResourceQuantity.IdExpansionBehaviour.EXPAND
: ResourceQuantity.IdExpansionBehaviour.NO_EXPAND
);
AST_NODE_CONTEXTS.add(new Pair<>(quantity, ctx));
return quantity;
Expand All @@ -717,10 +714,10 @@ public ResourceQuantity visitRetention(@Nullable SFMLParser.RetentionContext ctx
public ResourceQuantity visitQuantity(@Nullable SFMLParser.QuantityContext ctx) {
if (ctx == null) return ResourceQuantity.MAX_QUANTITY;
ResourceQuantity quantity = new ResourceQuantity(
visitNumber(ctx.number()),
visitNumexpr(ctx.numexpr()),
ctx.EACH() != null
? ResourceQuantity.IdExpansionBehaviour.EXPAND
: ResourceQuantity.IdExpansionBehaviour.NO_EXPAND
? ResourceQuantity.IdExpansionBehaviour.EXPAND
: ResourceQuantity.IdExpansionBehaviour.NO_EXPAND
);
AST_NODE_CONTEXTS.add(new Pair<>(quantity, ctx));
return quantity;
Expand Down Expand Up @@ -767,4 +764,153 @@ public Block visitBlock(@Nullable SFMLParser.BlockContext ctx) {
AST_NODE_CONTEXTS.add(new Pair<>(block, ctx));
return block;
}

// --- Numeric expressions ---
public NumExpr visitNumexpr(SFMLParser.NumexprContext ctx) {
// fold left: numterm ((+|-) numterm)*
NumExpr acc = visitNumterm(ctx.numterm(0));
int childCount = ctx.getChildCount();
NumExpr currentRight;
Integer pendingOp = null; // token type: PLUS or DASH
for (int i = 0; i < childCount; i++) {
ParseTree child = ctx.getChild(i);
if (child instanceof SFMLParser.NumtermContext termCtx) {
if (pendingOp != null) {
currentRight = visitNumterm(termCtx);
NumExpr lhs = acc;
NumExpr rhs = currentRight;
if (pendingOp == SFMLParser.PLUS) {
acc = new NumExpr() {
final NumExpr L = lhs, R = rhs;

@Override
public long eval(ca.teamdman.sfm.common.program.ProgramContext context) {
return L.eval(context) + R.eval(context);
}

@Override
public String toString() {
return "(" + L + " + " + R + ")";
}
};
} else {
acc = new NumExpr() {
final NumExpr L = lhs, R = rhs;

@Override
public long eval(ca.teamdman.sfm.common.program.ProgramContext context) {
return L.eval(context) - R.eval(context);
}

@Override
public String toString() {
return "(" + L + " - " + R + ")";
}
};
}
pendingOp = null;
}
} else if (child instanceof TerminalNode tn) {
int t = tn.getSymbol().getType();
if (t == SFMLParser.PLUS || t == SFMLParser.DASH) {
pendingOp = t;
}
}
}
AST_NODE_CONTEXTS.add(new Pair<>(acc, ctx));
return acc;
}

public NumExpr visitNumterm(SFMLParser.NumtermContext ctx) {
// fold left: numfactor ((*|/) numfactor)*
NumExpr acc = visitNumfactor(ctx.numfactor(0));
int childCount = ctx.getChildCount();
NumExpr currentRight;
Integer pendingOp = null; // token: STAR or SLASH
for (int i = 0; i < childCount; i++) {
ParseTree child = ctx.getChild(i);
if (child instanceof SFMLParser.NumfactorContext fctx) {
if (pendingOp != null) {
currentRight = visitNumfactor(fctx);
NumExpr lhs = acc;
NumExpr rhs = currentRight;
if (pendingOp == SFMLParser.STAR) {
acc = new NumExpr() {
final NumExpr L = lhs, R = rhs;

@Override
public long eval(ca.teamdman.sfm.common.program.ProgramContext context) {
return L.eval(context) * R.eval(context);
}

@Override
public String toString() {
return "(" + L + " * " + R + ")";
}
};
} else {
acc = new NumExpr() {
final NumExpr L = lhs, R = rhs;

@Override
public long eval(ca.teamdman.sfm.common.program.ProgramContext context) {
long d = R.eval(context);
return d == 0 ? 0 : L.eval(context) / d;
}

@Override
public String toString() {
return "(" + L + " / " + R + ")";
}
};
}
pendingOp = null;
}
} else if (child instanceof TerminalNode tn) {
int t = tn.getSymbol().getType();
if (t == SFMLParser.STAR || t == SFMLParser.SLASH) {
pendingOp = t;
}
}
}
AST_NODE_CONTEXTS.add(new Pair<>(acc, ctx));
return acc;
}

public NumExpr visitNumfactor(SFMLParser.NumfactorContext ctx) {
if (ctx.number() != null) {
return visitNumber(ctx.number());
}
if (ctx.functionCall() != null) {
return visitFunctionCall(ctx.functionCall());
}
// parenthesized
NumExpr inner = visitNumexpr(ctx.numexpr());
AST_NODE_CONTEXTS.add(new Pair<>(inner, ctx));
return inner;
}

public NumExpr visitFunctionCall(SFMLParser.FunctionCallContext ctx) {
String fname = ctx.identifier().getText().toLowerCase(Locale.ROOT);
List<FunctionArg> ordered = new ArrayList<>();
if (ctx.functionArg() != null) {
for (SFMLParser.FunctionArgContext arg : ctx.functionArg()) {
if (arg.labelAccess() != null) {
ordered.add(FunctionArg.ofLabel(visitLabelAccess(arg.labelAccess())));
} else if (arg.resourceIdDisjunction() != null) {
ordered.add(FunctionArg.ofResourceIds(visitResourceIdDisjunction(arg.resourceIdDisjunction())));
} else if (arg.numexpr() != null) {
ordered.add(FunctionArg.ofNumExpr(visitNumexpr(arg.numexpr())));
} else if (arg.string() != null) {
ordered.add(FunctionArg.ofString(visitString(arg.string())));
} else {
throw new IllegalArgumentException("Unrecognized function argument in function: " + fname);
}
}
}
FunctionHandler handler = FunctionRegistry.get(fname);
NumExpr result = handler.build(new FunctionArgs(ordered));
AST_NODE_CONTEXTS.add(new Pair<>(result, ctx));
return result;
}
}
19 changes: 16 additions & 3 deletions src/main/java/ca/teamdman/sfml/ast/BoolHas.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,27 @@ public record BoolHas(
SetOperator setOperator,
LabelAccess labelAccess,
ComparisonOperator comparisonOperator,
long quantity,
NumExpr quantity,
ResourceIdSet resourceIdSet,
With with,
ResourceIdSet except
) implements BoolExpr {

public BoolHas(
SetOperator setOperator,
LabelAccess labelAccess,
ComparisonOperator comparisonOperator,
long quantity,
ResourceIdSet resourceIdSet,
With with,
ResourceIdSet except
) {
this(setOperator, labelAccess, comparisonOperator, new Number(quantity), resourceIdSet, with, except);
}

@Override
public boolean test(ProgramContext programContext) {
long threshold = this.quantity.eval(programContext);
AtomicLong overallCount = new AtomicLong(0);
List<Boolean> satisfactionResults = new ArrayList<>();
LabelPositionHolder labelPositionHolder = programContext.getLabelPositionHolder();
Expand All @@ -38,10 +51,10 @@ public boolean test(ProgramContext programContext) {
resourceType
);
}
satisfactionResults.add(comparisonOperator.test(inThisInv.get(), quantity));
satisfactionResults.add(comparisonOperator.test(inThisInv.get(), threshold));
}

var isOverallSatisfied = this.comparisonOperator.test(overallCount.get(), this.quantity);
var isOverallSatisfied = this.comparisonOperator.test(overallCount.get(), threshold);
return setOperator.test(isOverallSatisfied, satisfactionResults);
}

Expand Down
Loading