Improve error message for when-statement in function

[Henrik Tidefelt]

A more informative error message than STATEMENT_GENERIC_FAILURE is needed in the case of a when-statement appearing in a function.

The following diff (from a MathCore perspective) describes a possible solution:

diff --git a/OMCLibrary/Code/Compiler/FrontEnd/InstSection.mo b/OMCLibrary/Code/Compiler/FrontEnd/InstSection.mo
index dfba61c..d0034f4 100644
--- a/OMCLibrary/Code/Compiler/FrontEnd/InstSection.mo
+++ b/OMCLibrary/Code/Compiler/FrontEnd/InstSection.mo
@@ -2550,6 +2550,14 @@ algorithm
       then
         (cache,{stmt});

+    // illegal when clause in function algorithm^M
+    case (cache,env,ih,pre,_,alg as SCode.ALG_WHEN_A(_, _, _),_,_,impl,_,_)^M
+      equation^M
+        true = ClassInf.isFunction(ci_state);^M
+        Error.addSourceMessage(Error.WHEN_IN_FUNCTION,{},SCode.getStatementInfo(alg));^M
+      then^M
+        fail();^M
+^M
     // assert(cond,msg)
     case (cache,env,ih,pre,_,SCode.ALG_NORETCALL(exp=Absyn.CALL(function_ = Absyn.CREF_IDENT(name = "assert"),
           functionArgs = Absyn.FUNCTIONARGS(args = {cond,msg},argNames = {})), info = info),source,_,impl,_,_)
diff --git a/OMCLibrary/Code/Compiler/Util/Error.mo b/OMCLibrary/Code/Compiler/Util/Error.mo
index 02c3701..c00d9fa 100644
--- a/OMCLibrary/Code/Compiler/Util/Error.mo
+++ b/OMCLibrary/Code/Compiler/Util/Error.mo
@@ -616,6 +616,8 @@ public constant Message SEPARATE_COMPILATION_PACKAGE_FAILED = MESSAGE(536, SCRIP
   Util.gettext("Failed to compile all functions in package %s."));
 public constant Message INVALID_ARRAY_DIM_IN_SCALAR_OP = MESSAGE(537, TRANSLATION(), ERROR(),
   Util.gettext("The operator scalar requires all dimension size to be 1, but the input has type %s."));
+public constant Message WHEN_IN_FUNCTION = MESSAGE(538, TRANSLATION(), ERROR(),^M
+  Util.gettext("Functions may not contain when-statements."));^M


 public constant Message MATCH_SHADOWING = MESSAGE(5001, TRANSLATION(), ERROR(),

[Martin Sjölund]

This ticket was not closed for 1.9.1, which has now been released. It was batch modified for milestone 1.9.2 (but maybe an empty milestone was more appropriate; feel free to change it).

[Martin Sjölund]

Milestone changed to 1.9.3 since 1.9.2 was released.

[Martin Sjölund]

Moved to new milestone 1.9.4

[Martin Sjölund]

Milestone pushed to 1.9.5

[Martin Sjölund]

Milestone renamed

[Martin Sjölund]

Ticket retargeted after milestone closed

[Martin Sjölund]

Milestone moved to 1.12.0 due to 1.11.0 already being released.

[Francesco Casella]

The milestone of this ticket has been reassigned to "Future".

If you think the issue is still valid and relevant for you, please select milestone 1.13.0 for back-end, code generation and run-time issues, or 2.0.0 for front-end issues.

If you are aware that the problem is no longer present, please select the milestone corresponding to the version of OMC you used to check that, and set the status to "worksforme".

In both cases, a short informative comment would be welcome.

[Per Östlund]

Both the old and the new frontend forbids using a when-statement in a function.