DROOLS-1697 Augment FEEL AST node at compilation with standard return…

… type (apache#1411) * Start implement some FEEL node result type * Implement InfixOpNode.getResultType() * Add AST node return type inference for QualifiedName node. * Refactorings and implementation of negated unary test. * Extending result type support to additional AST nodes. * Limited support for result type for inner AST nodes in Contexts. * Rebased * Complete support for type inference for ContextNode * Extend AST node return type coverage * cleanup * cleanup * .
kiegroup · Aug 12, 2017 · 06bc3db · 06bc3db
1 parent cc3e015
commit 06bc3db
Show file tree

Hide file tree

Showing 28 changed files with 409 additions and 63 deletions.
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ASTBuilderFactory.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ASTBuilderFactory.java
@@ -17,6 +17,7 @@
 package org.kie.dmn.feel.lang.ast;
 
 import org.antlr.v4.runtime.ParserRuleContext;
+import org.kie.dmn.feel.lang.Type;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -95,12 +96,12 @@ public static ForExpressionNode newForExpression(ParserRuleContext ctx, ListNode
         return new ForExpressionNode( ctx, list, expr );
     }
 
-    public static NameRefNode newNameRefNode( ParserRuleContext ctx ) {
-        return new NameRefNode( ctx );
+    public static NameRefNode newNameRefNode( ParserRuleContext ctx, Type type ) {
+        return new NameRefNode( ctx, type );
     }
 
-    public static QualifiedNameNode newQualifiedNameNode(ParserRuleContext ctx, ArrayList<NameRefNode> parts) {
-        return new QualifiedNameNode( ctx, parts );
+    public static QualifiedNameNode newQualifiedNameNode(ParserRuleContext ctx, ArrayList<NameRefNode> parts, Type type ) {
+        return new QualifiedNameNode( ctx, parts, type );
     }
 
     public static IfExpressionNode newIfExpression(ParserRuleContext ctx, BaseNode c, BaseNode t, BaseNode e) {

diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/BaseNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/BaseNode.java
@@ -19,13 +19,12 @@
 import java.util.function.Supplier;
 
 import org.antlr.v4.runtime.ParserRuleContext;
-import org.antlr.v4.runtime.misc.Interval;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent.Severity;
 import org.kie.dmn.feel.lang.EvaluationContext;
 import org.kie.dmn.feel.lang.Type;
-import org.kie.dmn.feel.lang.impl.EvaluationContextImpl;
 import org.kie.dmn.feel.lang.types.BuiltInType;
+import org.kie.dmn.feel.parser.feel11.ParserHelper;
 import org.kie.dmn.feel.runtime.events.ASTEventBase;
 import org.kie.dmn.feel.util.Msg;
 
@@ -50,7 +49,7 @@ public BaseNode( ParserRuleContext ctx ) {
         this.setEndChar( ctx.getStop().getStopIndex() );
         this.setEndLine( ctx.getStop().getLine() );
         this.setEndColumn( ctx.getStop().getCharPositionInLine() + ctx.getStop().getText().length() );
-        this.setText( getOriginalText( ctx ) );
+        this.setText( ParserHelper.getOriginalText( ctx ) );
     }
 
     @Override
@@ -139,11 +138,4 @@ public Object evaluate(EvaluationContext ctx) {
         return null;
     }
 
-    private String getOriginalText( ParserRuleContext ctx ) {
-        int a = ctx.start.getStartIndex();
-        int b = ctx.stop.getStopIndex();
-        Interval interval = new Interval(a,b);
-        return ctx.getStart().getInputStream().getText(interval);
-    }
-
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/BetweenNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/BetweenNode.java
@@ -19,6 +19,8 @@
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent.Severity;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 import org.kie.dmn.feel.util.Msg;
 
 public class BetweenNode
@@ -88,4 +90,9 @@ public Object evaluate(EvaluationContext ctx) {
 
         return val.compareTo( s ) >= 0 && val.compareTo( e ) <= 0;
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.BOOLEAN;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/BooleanNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/BooleanNode.java
@@ -18,6 +18,8 @@
 
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 
 public class BooleanNode
         extends BaseNode {
@@ -37,4 +39,9 @@ public Boolean getValue() {
     public Object evaluate(EvaluationContext ctx) {
         return value;
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.BOOLEAN;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ContextEntryNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ContextEntryNode.java
@@ -18,6 +18,7 @@
 
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
 
 public class ContextEntryNode
         extends BaseNode {
@@ -59,4 +60,9 @@ public String evaluateName( EvaluationContext ctx ) {
     public Object evaluate(EvaluationContext ctx) {
         return value.evaluate( ctx );
     }
+
+    @Override
+    public Type getResultType() {
+        return value.getResultType();
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ContextNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ContextNode.java
@@ -18,6 +18,9 @@
 
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.impl.MapBackedType;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 import org.kie.dmn.feel.runtime.functions.CustomFEELFunction;
 import org.kie.dmn.feel.runtime.functions.DTInvokerFunction;
 import org.kie.dmn.feel.runtime.functions.JavaFunction;
@@ -29,6 +32,7 @@ public class ContextNode
         extends BaseNode {
 
     private List<ContextEntryNode> entries = new ArrayList<>();
+    private MapBackedType parsedResultType = new MapBackedType();
 
     public ContextNode(ParserRuleContext ctx) {
         super( ctx );
@@ -37,7 +41,9 @@ public ContextNode(ParserRuleContext ctx) {
     public ContextNode(ParserRuleContext ctx, ListNode list) {
         super( ctx );
         for( BaseNode node : list.getElements() ) {
-            entries.add( (ContextEntryNode) node );
+            ContextEntryNode entry = (ContextEntryNode) node;
+            entries.add( entry );
+            parsedResultType.addField(entry.getName().getText(), entry.getResultType());
         }
     }
 
@@ -75,4 +81,9 @@ public Object evaluate(EvaluationContext ctx) {
         }
     }
 
+    @Override
+    public Type getResultType() {
+        return parsedResultType;
+    }
+
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/DashNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/DashNode.java
@@ -18,6 +18,8 @@
 
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 import org.kie.dmn.feel.runtime.UnaryTest;
 
 public class DashNode
@@ -49,4 +51,9 @@ public String toString() {
             return "UnaryTest{-}";
         }
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.BOOLEAN;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ForExpressionNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ForExpressionNode.java
@@ -18,6 +18,8 @@
 
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -88,6 +90,11 @@ private boolean nextIteration( EvaluationContext ctx, ForIteration[] ictx ) {
     private void setValueIntoContext(EvaluationContext ctx, ForIteration forIteration) {
         ctx.setValue( forIteration.getName(), forIteration.getNextValue() );
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.LIST;
+    }
 
     private ForIteration[] initializeContexts(EvaluationContext ctx, List<IterationContextNode> iterationContexts) {
         ForIteration[] ictx = new ForIteration[iterationContexts.size()];

diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/FunctionDefNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/FunctionDefNode.java
@@ -19,6 +19,8 @@
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent.Severity;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 import org.kie.dmn.feel.runtime.functions.CustomFEELFunction;
 import org.kie.dmn.feel.runtime.functions.JavaFunction;
 import org.kie.dmn.feel.util.Msg;
@@ -189,5 +191,9 @@ public static Class<?> convertPrimitiveNameToType( String typeName ) {
         return null;
     }
 
-
+    @Override
+    public Type getResultType() {
+        // TODO when built-in type can be parametrized as FUNCTION<type>
+        return BuiltInType.FUNCTION;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/FunctionInvocationNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/FunctionInvocationNode.java
@@ -19,6 +19,7 @@
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent.Severity;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
 import org.kie.dmn.feel.runtime.FEELFunction;
 import org.kie.dmn.feel.runtime.UnaryTest;
 import org.kie.dmn.feel.util.Msg;
@@ -84,4 +85,8 @@ public Object evaluate(EvaluationContext ctx) {
         return null;
     }
 
+    @Override
+    public Type getResultType() {
+        return name.getResultType();
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/IfExpressionNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/IfExpressionNode.java
@@ -19,6 +19,8 @@
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent.Severity;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 import org.kie.dmn.feel.util.Msg;
 
 public class IfExpressionNode
@@ -72,4 +74,14 @@ public Object evaluate(EvaluationContext ctx) {
         ctx.notifyEvt( astEvent(Severity.ERROR, Msg.createMessage(Msg.CONDITION_WAS_NOT_A_BOOLEAN)) );
         return null;
     }
+
+    @Override
+    public Type getResultType() {
+        if ( thenExpression.getResultType().equals(elseExpression.getResultType()) ) {
+            return thenExpression.getResultType();
+        } else {
+            return BuiltInType.UNKNOWN;
+        }
+    }
+
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/InNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/InNode.java
@@ -19,6 +19,8 @@
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent.Severity;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 import org.kie.dmn.feel.runtime.Range;
 import org.kie.dmn.feel.runtime.UnaryTest;
 import org.kie.dmn.feel.util.Msg;
@@ -94,4 +96,9 @@ private Boolean in(EvaluationContext ctx, Object value, Object expr) {
             return Boolean.FALSE;
         }
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.BOOLEAN;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/InfixOpNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/InfixOpNode.java
@@ -115,9 +115,47 @@ public void setRight(BaseNode right) {
 
     @Override
     public Type getResultType() {
-        // bellow is not exactly correct, as the result type depends on both
-        // left and right
-        return operator.isBoolean() ? BuiltInType.BOOLEAN : this.left.getResultType();
+        // see FEEL spec Table 45.
+        if ( operator.isBoolean() ) { return BuiltInType.BOOLEAN; }
+        switch ( operator ) {
+            case ADD:
+            case SUB: {
+                if ( left.getResultType() == BuiltInType.NUMBER && right.getResultType() == BuiltInType.NUMBER ) {
+                    return BuiltInType.NUMBER;
+                } else if ( left.getResultType() == BuiltInType.DATE_TIME && right.getResultType() == BuiltInType.DATE_TIME ) {
+                    return BuiltInType.DATE_TIME;
+                } else if ( left.getResultType() == BuiltInType.TIME && right.getResultType() == BuiltInType.TIME ) {
+                    return BuiltInType.TIME;
+                } else if ( left.getResultType() == BuiltInType.DURATION || right.getResultType() == BuiltInType.DURATION ) {
+                    if ( left.getResultType() == BuiltInType.DATE_TIME || right.getResultType() == BuiltInType.DATE_TIME ) {
+                        return BuiltInType.DATE_TIME;
+                    } else if ( left.getResultType() == BuiltInType.TIME || right.getResultType() == BuiltInType.TIME ) {
+                        return BuiltInType.TIME;
+                    } else if ( left.getResultType() == BuiltInType.DURATION && right.getResultType() == BuiltInType.DURATION ) {
+                        return BuiltInType.DURATION;
+                    }
+                } else if ( left.getResultType() == BuiltInType.STRING && right.getResultType() == BuiltInType.STRING ) {
+                    return BuiltInType.STRING;
+                }
+            }
+            case MULT:
+            case DIV: {
+                if ( left.getResultType() == BuiltInType.NUMBER && right.getResultType() == BuiltInType.NUMBER ) {
+                    return BuiltInType.NUMBER;
+                } else if ( left.getResultType() == BuiltInType.DURATION || right.getResultType() == BuiltInType.DURATION ) {
+                    if ( left.getResultType() == BuiltInType.NUMBER || right.getResultType() == BuiltInType.NUMBER ) {
+                        return BuiltInType.NUMBER;
+                    }
+                }
+            }
+            case POW: {
+                if ( left.getResultType() == BuiltInType.NUMBER && right.getResultType() == BuiltInType.NUMBER ) {
+                    return BuiltInType.NUMBER;
+                }
+            }
+            default:
+                return BuiltInType.UNKNOWN;
+        }
     }
 
     @Override

diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/InstanceOfNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/InstanceOfNode.java
@@ -55,4 +55,9 @@ public Object evaluate(EvaluationContext ctx) {
         Type t = type.evaluate( ctx );
         return t.isInstanceOf( value );
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.BOOLEAN;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ListNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/ListNode.java
@@ -18,7 +18,9 @@
 
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
 import org.kie.dmn.feel.lang.impl.EvaluationContextImpl;
+import org.kie.dmn.feel.lang.types.BuiltInType;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -51,4 +53,9 @@ public void setElements(List<BaseNode> elements) {
     public List evaluate(EvaluationContext ctx) {
         return elements.stream().map( e -> e != null ? e.evaluate( ctx ) : null ).collect( Collectors.toList() );
     }
+
+    @Override
+    public Type getResultType() {
+        return BuiltInType.LIST;
+    }
 }
diff --git a/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/NameRefNode.java b/kie-dmn/kie-dmn-feel/src/main/java/org/kie/dmn/feel/lang/ast/NameRefNode.java
@@ -19,6 +19,7 @@
 import org.antlr.v4.runtime.ParserRuleContext;
 import org.kie.dmn.api.feel.runtime.events.FEELEvent;
 import org.kie.dmn.feel.lang.EvaluationContext;
+import org.kie.dmn.feel.lang.Type;
 import org.kie.dmn.feel.lang.impl.FEELEventListenersManager;
 import org.kie.dmn.feel.runtime.events.SyntaxErrorEvent;
 import org.kie.dmn.feel.runtime.events.UnknownVariableErrorEvent;
@@ -28,8 +29,11 @@
 public class NameRefNode
         extends BaseNode {
 
-    public NameRefNode(ParserRuleContext ctx) {
+    private Type resultType;
+
+    public NameRefNode(ParserRuleContext ctx, Type type) {
         super( ctx );
+        this.resultType = type;
     }
 
     @Override
@@ -41,4 +45,11 @@ public Object evaluate(EvaluationContext ctx) {
         }
         return ctx.getValue( varName );
     }
+
+    @Override
+    public Type getResultType() {
+        return resultType;
+    }
+
+
 }