From f68f891adbbdc5f6940b6921db61cf3e79cd60e9 Mon Sep 17 00:00:00 2001
From: villberg <villberg@ac1ea38d-2e2b-0410-8846-a27921b304fc>
Date: Mon, 15 Sep 2014 07:58:59 +0000
Subject: [PATCH] Support break and return in functions. Fix for initialization
 of function local variables refs #5224

git-svn-id: https://www.simantics.org/svn/simantics/sysdyn/trunk@30274 ac1ea38d-2e2b-0410-8846-a27921b304fc
---
 .../src/fi/semantum/sysdyn/solver/Break.java  | 29 +++++++++++++++++++
 .../semantum/sysdyn/solver/ForStatement.java  | 17 +++++++----
 .../fi/semantum/sysdyn/solver/Function.java   |  7 ++++-
 .../fi/semantum/sysdyn/solver/IStatement.java |  6 +++-
 .../semantum/sysdyn/solver/IfStatement.java   |  6 ++--
 .../sysdyn/solver/MultiStatement.java         |  3 +-
 .../src/fi/semantum/sysdyn/solver/Parser.java | 10 ++++++-
 .../src/fi/semantum/sysdyn/solver/Return.java | 29 +++++++++++++++++++
 .../fi/semantum/sysdyn/solver/Statement.java  |  3 +-
 .../semantum/sysdyn/solver/StatementList.java |  8 +++--
 .../src/fi/semantum/sysdyn/solver/While.java  | 10 +++++--
 .../sysdyn/solver/parser/ModelParser.java     |  2 ++
 .../sysdyn/solver/parser/ModelicaParser.jj    |  4 +--
 .../sysdyn/solver/parser/ModelicaParser.jjt   |  4 +--
 14 files changed, 115 insertions(+), 23 deletions(-)
 create mode 100644 fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Break.java
 create mode 100644 fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Return.java

diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Break.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Break.java
new file mode 100644
index 00000000..588cfe06
--- /dev/null
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Break.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Semantum Oy.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Semantum Oy - initial API and implementation
+ *******************************************************************************/
+package fi.semantum.sysdyn.solver;
+
+
+public class Break implements IStatement {
+	
+    public Break() {
+    }
+    
+    @Override
+    public String toString() {
+    	return "break";
+    }
+    
+    @Override
+    public ReturnValue evaluate(IEnvironment environment) {
+    	return ReturnValue.BREAK;
+    }
+    
+}
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/ForStatement.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/ForStatement.java
index 5dedd79e..bd487b19 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/ForStatement.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/ForStatement.java
@@ -27,23 +27,28 @@ public class ForStatement implements IStatement {
 		return "for " + indices + " loop "+ statement + " end for";
 	}
 	
-	private void loop(IEnvironment environment, int i) {
+	private ReturnValue loop(IEnvironment environment, int i) {
 		if(i == indices.size()) {
-			statement.evaluate(environment);
-			return;
+			ReturnValue ret = statement.evaluate(environment);
+			if(ReturnValue.BREAK.equals(ret)) return ReturnValue.CONTINUE;
+			else if(ReturnValue.RETURN.equals(ret)) return ReturnValue.RETURN;
+			else return ReturnValue.CONTINUE;
 		} else {
 			ForIndex index = indices.get(i);
 			Array array = (Array)index.expression.evaluate(environment);
 			for(Object element : array.elements()) {
 				environment.put(index.base.index, element);
-				loop(environment, i+1);
+				ReturnValue ret = loop(environment, i+1);
+				if(ReturnValue.BREAK.equals(ret)) return ReturnValue.CONTINUE;
+				else if(ReturnValue.RETURN.equals(ret)) return ReturnValue.RETURN;
 			}
+			return ReturnValue.CONTINUE;
 		}
 	}
 	
 	@Override
-	public void evaluate(IEnvironment environment) {
-		loop(environment, 0);
+	public ReturnValue evaluate(IEnvironment environment) {
+		return loop(environment, 0);
 	}
 	
 }
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Function.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Function.java
index 200cf365..9af1f4b3 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Function.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Function.java
@@ -48,7 +48,12 @@ final public class Function implements Fn, IFrame {
 		}
 		for(int i=0;i<internals.size();i++) {
 			VariableDeclaration decl = internals.get(i);
-			decl.variable.assignPlain(environment, null);
+			if(decl.modification.args.length == 1) {
+				Object o = decl.modification.args[0].modification.evaluate(environment);
+				decl.variable.assignPlain(environment, o);
+			} else {
+				decl.variable.assignPlain(environment, null);
+			}
 		}
 	}
 	
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IStatement.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IStatement.java
index e50a09bc..efb5472f 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IStatement.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IStatement.java
@@ -12,6 +12,10 @@ package fi.semantum.sysdyn.solver;
 
 public interface IStatement {
 
-	public void evaluate(IEnvironment environment);
+	public enum ReturnValue {
+		CONTINUE,BREAK,RETURN;
+	}
+	
+	public ReturnValue evaluate(IEnvironment environment);
 	
 }
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IfStatement.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IfStatement.java
index 37dc2af2..8fb020e7 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IfStatement.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/IfStatement.java
@@ -28,11 +28,11 @@ public class IfStatement implements IStatement {
     }
     
 	@Override
-	public void evaluate(IEnvironment environment) {
+	public ReturnValue evaluate(IEnvironment environment) {
 		if((Boolean)exp.evaluate(environment)) {
-			t.evaluate(environment);
+			return t.evaluate(environment);
 		} else {
-			e.evaluate(environment);
+			return e.evaluate(environment);
 		}
 	}
     
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/MultiStatement.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/MultiStatement.java
index ff330375..f7c5083f 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/MultiStatement.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/MultiStatement.java
@@ -30,12 +30,13 @@ public class MultiStatement implements IStatement {
     }
     
     @Override
-    public void evaluate(IEnvironment environment) {
+    public ReturnValue evaluate(IEnvironment environment) {
     	@SuppressWarnings("unchecked")
     	ArrayList<Object> values = (ArrayList<Object>)environment.getSystem().evaluateFunction(environment, fn.base.name, args);
     	for(int i=0;i<targets.size();i++) {
     		targets.get(i).assignPlain(environment, values.get(i));
     	}
+    	return ReturnValue.CONTINUE;
     }
     
 }
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Parser.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Parser.java
index 95d01166..6560e2d1 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Parser.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Parser.java
@@ -153,7 +153,15 @@ public class Parser {
 //					| when_statement() )
 //				comment() 
 			
-			if(n.jjtGetNumChildren() == 1) {
+			if(n.jjtGetNumChildren() == 0) {
+				if("break".equals(n.op)) {
+					return new Break();
+				} else if ("return".equals(n.op)) {
+					return new Return();
+				} else {
+					throw new IllegalStateException();
+				}
+			} else if(n.jjtGetNumChildren() == 1) {
 				return (IStatement)walk((SimpleNode)n.jjtGetChild(0), indent+2, frame);
 			} else if (n.jjtGetNumChildren() == 2) {
 				SimpleNode n0 = (SimpleNode)n.jjtGetChild(1);
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Return.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Return.java
new file mode 100644
index 00000000..023ae534
--- /dev/null
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Return.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Semantum Oy.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Semantum Oy - initial API and implementation
+ *******************************************************************************/
+package fi.semantum.sysdyn.solver;
+
+
+public class Return implements IStatement {
+	
+    public Return() {
+    }
+    
+    @Override
+    public String toString() {
+    	return "return";
+    }
+    
+    @Override
+    public ReturnValue evaluate(IEnvironment environment) {
+    	return ReturnValue.RETURN;
+    }
+    
+}
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Statement.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Statement.java
index a3dcd40f..381192f8 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Statement.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/Statement.java
@@ -28,9 +28,10 @@ public class Statement implements IStatement {
     }
     
     @Override
-    public void evaluate(IEnvironment environment) {
+    public ReturnValue evaluate(IEnvironment environment) {
 		Object value = expression.evaluate(environment);
 		target.assign(environment, subscripts, value);
+		return ReturnValue.CONTINUE;
     }
     
 }
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/StatementList.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/StatementList.java
index b8c17f88..a7df2cd3 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/StatementList.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/StatementList.java
@@ -26,8 +26,12 @@ public class StatementList implements IStatement {
     }
     
     @Override
-    public void evaluate(IEnvironment environment) {
-    	for(IStatement stm : statements) stm.evaluate(environment);
+    public ReturnValue evaluate(IEnvironment environment) {
+    	for(IStatement stm : statements) {
+    		ReturnValue ret = stm.evaluate(environment);
+    		if(ReturnValue.RETURN.equals(ret)) return ReturnValue.RETURN;
+    	}
+    	return ReturnValue.CONTINUE;
     }
     
 }
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/While.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/While.java
index 47e94c86..61af2515 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/While.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/While.java
@@ -26,9 +26,13 @@ public class While implements IStatement {
 	}
 	
 	@Override
-	public void evaluate(IEnvironment environment) {
-		while ((Boolean)expression.evaluate(environment))
-			statement.evaluate(environment);
+	public ReturnValue evaluate(IEnvironment environment) {
+		while ((Boolean)expression.evaluate(environment)) {
+			ReturnValue ret = statement.evaluate(environment);
+			if(ReturnValue.BREAK.equals(ret)) return ReturnValue.CONTINUE;
+			else if(ReturnValue.RETURN.equals(ret)) return ReturnValue.RETURN;
+		}
+		return ReturnValue.CONTINUE;
 	}
 	
 }
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelParser.java b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelParser.java
index 94455168..bcd1d520 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelParser.java
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelParser.java
@@ -2193,9 +2193,11 @@ public class ModelParser/*@bgen(jjtree)*/implements ModelParserTreeConstants, Mo
         break;
       case 29:
         jj_consume_token(29);
+                            jjtn000.op = "break";
         break;
       case 18:
         jj_consume_token(18);
+                             jjtn000.op = "return";
         break;
       case 31:
         if_statement();
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jj b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jj
index 0af3f17b..3f908483 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jj
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jj
@@ -1454,8 +1454,8 @@ void statement() : {/*@bgen(jjtree) statement */
 //	comment
 	( component_reference() ( ":=" expression() | function_call_args() )
 		| "(" output_expression_list() ")" ":=" component_reference() function_call_args()
-		| "break"
-		| "return"
+		| "break" { jjtn000.op = "break";}
+		| "return" { jjtn000.op = "return";}
 		| if_statement()
 		| for_statement()
 		| while_statement()
diff --git a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jjt b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jjt
index 7c4de3d3..b4231401 100644
--- a/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jjt
+++ b/fi.semantum.sysdyn.solver/src/fi/semantum/sysdyn/solver/parser/ModelicaParser.jjt
@@ -445,8 +445,8 @@ void statement() : {
 //	comment
 	( component_reference() ( ":=" expression() | function_call_args() )
 		| "(" output_expression_list() ")" ":=" component_reference() function_call_args()
-		| "break"
-		| "return"
+		| "break" { jjtThis.op = "break";}
+		| "return" { jjtThis.op = "return";}
 		| if_statement()
 		| for_statement()
 		| while_statement()
-- 
2.47.1