Add a ** b syntax for number::pow (#60)

chaiNNer-org · May 12, 2024 · f99087b · f99087b
1 parent d0a0dda
commit f99087b
Show file tree

Hide file tree

Showing 7 changed files with 778 additions and 637 deletions.
diff --git a/src/antlr4/Navi.g4 b/src/antlr4/Navi.g4
@@ -61,7 +61,10 @@ ifExpression:
 
 fieldAccessExpression: primaryExpression ('.' Identifier)*;
 
-negateExpression: OpMinus? fieldAccessExpression;
+powExpression:
+	fieldAccessExpression (OpPow fieldAccessExpression)?;
+
+negateExpression: OpMinus? powExpression;
 
 multiplicativeExpression:
 	negateExpression ((OpMult | OpDiv) negateExpression)*;
@@ -168,6 +171,7 @@ OpMinus: '-';
 OpPlus: '+';
 OpMult: '*';
 OpDiv: '/';
+OpPow: '**';
 OpEqual: '==';
 OpNotEqual: '!=';
 OpGt: '>';

diff --git a/src/antlr4/NaviLexer.js b/src/antlr4/NaviLexer.js
diff --git a/src/antlr4/NaviListener.js b/src/antlr4/NaviListener.js
@@ -176,6 +176,15 @@ export default class NaviListener extends antlr4.tree.ParseTreeListener {
 	}
 
 
+	// Enter a parse tree produced by NaviParser#powExpression.
+	enterPowExpression(ctx) {
+	}
+
+	// Exit a parse tree produced by NaviParser#powExpression.
+	exitPowExpression(ctx) {
+	}
+
+
 	// Enter a parse tree produced by NaviParser#negateExpression.
 	enterNegateExpression(ctx) {
 	}

diff --git a/src/antlr4/NaviParser.js b/src/antlr4/NaviParser.js
diff --git a/src/parse.ts b/src/parse.ts
@@ -367,6 +367,7 @@ class AstConverter {
             | Contexts['AdditiveExpressionContext']
             | Contexts['MultiplicativeExpressionContext']
             | Contexts['NegateExpressionContext']
+            | Contexts['PowExpressionContext']
             | Contexts['FieldAccessExpressionContext']
             | Contexts['PrimaryExpressionContext']
             | Contexts['FunctionCallContext']
@@ -465,12 +466,30 @@ class AstConverter {
             );
         }
         if (context instanceof NaviParser.NegateExpressionContext) {
-            const expr = this.toExpression(getRequired(context, 'fieldAccessExpression'));
+            const powContext = getRequired(context, 'powExpression');
+            const expr = this.toExpression(powContext);
+
             if (getOptionalToken(context, 'OpMinus')) {
+                if (getOptionalToken(powContext, 'OpPow')) {
+                    // error: -a ** b is not allowed
+                    throw new ConversionError(
+                        context,
+                        'Negation cannot be applied to exponentiation. -a**b is not allowed. Write either -(a**b) or (-a)**b instead.'
+                    );
+                }
                 return new FunctionCallExpression('number::neg', [expr]);
             }
+
             return expr;
         }
+        if (context instanceof NaviParser.PowExpressionContext) {
+            const expressions = getMultiple(context, 'fieldAccessExpression').map(
+                this.toExpression
+            );
+            if (expressions.length === 1) return expressions[0];
+            const [x, y] = expressions;
+            return new FunctionCallExpression('number::pow', [x, y]);
+        }
         if (context instanceof NaviParser.FieldAccessExpressionContext) {
             const ofExpression = this.toExpression(getRequired(context, 'primaryExpression'));
             const fields = getMultipleTokens(context, 'Identifier').map((t) => t.getText());

diff --git a/tests/__snapshots__/parse.test.ts.snap b/tests/__snapshots__/parse.test.ts.snap
@@ -458,6 +458,18 @@ number::add(-100, number::neg(-100))
 >>> a---100
 number::add(a, number::neg(number::neg(-100)))
 
+>>> a**b
+number::pow(a, b)
+
+>>> (-a)**b
+number::pow(number::neg(a), b)
+
+>>> -(a**b)
+number::neg(number::pow(a, b))
+
+>>> a*b**c*d
+number::mul(a, number::pow(b, c), d)
+
 >>> not a and b or c
 bool::or(bool::and(bool::not(a), b), c)
 
@@ -844,8 +856,11 @@ SyntaxError: At 1:3: extraneous input '-' expecting {'{', '(', 'if', 'match', In
 >>> a++a
 SyntaxError: At 1:2: extraneous input '+' expecting {'{', '(', 'if', 'match', IntInterval, NonIntInterval, IntervalInclusive, IntervalMinExclusive, IntervalMaxExclusive, IntervalExclusive, Number, String, Identifier, '-'}
 
->>> a**a
-SyntaxError: At 1:2: extraneous input '*' expecting {'{', '(', 'if', 'match', IntInterval, NonIntInterval, IntervalInclusive, IntervalMinExclusive, IntervalMaxExclusive, IntervalExclusive, Number, String, Identifier, '-'}
+>>> a* *a
+SyntaxError: At 1:3: extraneous input '*' expecting {'{', '(', 'if', 'match', IntInterval, NonIntInterval, IntervalInclusive, IntervalMinExclusive, IntervalMaxExclusive, IntervalExclusive, Number, String, Identifier, '-'}
+
+>>> -a**a
+Error: Unable to convert \`-a**a\`: Negation cannot be applied to exponentiation. -a**b is not allowed. Write either -(a**b) or (-a)**b instead.
 
 >>> a-100
 SyntaxError: At 1:1: extraneous input '-100' expecting <EOF>

diff --git a/tests/parse.test.ts b/tests/parse.test.ts
@@ -165,6 +165,10 @@ const expressionSnippets: string[] = [
     String.raw`a + b * c`,
     String.raw`-100 - -100`,
     String.raw`a---100`,
+    String.raw`a**b`,
+    String.raw`(-a)**b`,
+    String.raw`-(a**b)`,
+    String.raw`a*b**c*d`,
 
     // logical
     String.raw`not a and b or c`,
@@ -308,7 +312,8 @@ const invalidExpressionSnippets: string[] = [
     String.raw`--a`,
     String.raw`a+--a`,
     String.raw`a++a`,
-    String.raw`a**a`,
+    String.raw`a* *a`,
+    String.raw`-a**a`,
     String.raw`a-100`,
 
     // logical