Changeset b3681ace in OpenModelica

Timestamp:

2021-11-26T20:09:08+01:00 (2 years ago)

Author:

GitHub <noreply@…>

Branches:

maintenance/v1.19, maintenance/v1.20, maintenance/v1.21, maintenance/v1.22, maintenance/v1.23, master, omlib-staging

Children:

2f015b08, 962c211

Parents:

3eae525

git-author:

perost <perost86@…> (11/26/21 20:09:08)

git-committer:

GitHub <noreply@…> (11/26/21 20:09:08)

Message:

Output comments/annotations in Flat Modelica (#8232)

Fixes #8228

Files:

• OMCompiler/Compiler/.cmake/meta_modelica_source_list.cmake (modified) (1 diff)
• OMCompiler/Compiler/NFFrontEnd/NFEquation.mo (modified) (2 diffs)
• OMCompiler/Compiler/NFFrontEnd/NFFlatModel.mo (modified) (3 diffs)
• OMCompiler/Compiler/NFFrontEnd/NFFlatModelicaUtil.mo (added)
• OMCompiler/Compiler/NFFrontEnd/NFFunction.mo (modified) (5 diffs)
• OMCompiler/Compiler/NFFrontEnd/NFFunctionDerivative.mo (modified) (1 diff)
• OMCompiler/Compiler/NFFrontEnd/NFStatement.mo (modified) (2 diffs)
• OMCompiler/Compiler/NFFrontEnd/NFVariable.mo (modified) (2 diffs)
• OMCompiler/Compiler/boot/LoadCompilerSources.mos (modified) (1 diff)
• testsuite/openmodelica/flatmodelica/Comments.mo (added)
• testsuite/openmodelica/flatmodelica/Makefile (modified) (1 diff)

OMCompiler/Compiler/.cmake/meta_modelica_source_list.cmake

@@ -318 +318 @@
     ${CMAKE_CURRENT_SOURCE_DIR}/NFFrontEnd/NFExpression.mo
     ${CMAKE_CURRENT_SOURCE_DIR}/NFFrontEnd/NFFlatModel.mo
+    ${CMAKE_CURRENT_SOURCE_DIR}/NFFrontEnd/NFFlatModelicaUtil.mo
     ${CMAKE_CURRENT_SOURCE_DIR}/NFFrontEnd/NFFlatten.mo
     ${CMAKE_CURRENT_SOURCE_DIR}/NFFrontEnd/NFFunctionDerivative.mo

OMCompiler/Compiler/NFFrontEnd/NFEquation.mo

@@ -43 +43 @@
   import Equation = NFEquation;
   import Error;
+  import FlatModelicaUtil = NFFlatModelicaUtil;
   import IOStream;
   import Util;
@@ -1225 +1226 @@
       else IOStream.append(s, "#UNKNOWN EQUATION#");
     end match;
+
+    s := FlatModelicaUtil.appendElementSourceComment(source(eq), s);
   end toFlatStream;
 

OMCompiler/Compiler/NFFrontEnd/NFFlatModel.mo

@@ -55 +55 @@
   import Prefixes = NFPrefixes;
   import NFPrefixes.Visibility;
+  import FlatModelicaUtil = NFFlatModelicaUtil;
 
   import FlatModel = NFFlatModel;
@@ -218 +219 @@
     Visibility visibility = Visibility.PUBLIC;
   algorithm
-    s := IOStream.append(s, "class '" + flat_model.name + "'\n");
+    s := IOStream.append(s, "class '" + flat_model.name + "'");
+    s := FlatModelicaUtil.appendElementSourceCommentString(flat_model.source, s);
+    s := IOStream.append(s, "\n");
 
     flat_model.variables := reconstructRecordInstances(flat_model.variables);
@@ -269 +272 @@
     end for;
 
+    s := FlatModelicaUtil.appendElementSourceCommentAnnotation(flat_model.source, "  ", ";\n", s);
     s := IOStream.append(s, "end '" + flat_model.name + "';\n");
   end appendFlatStream;

OMCompiler/Compiler/NFFrontEnd/NFFunction.mo

@@ -82 +82 @@
 import UnorderedSet;
 import Graph;
+import FlatModelicaUtil = NFFlatModelicaUtil;
 
 public
@@ -719 +720 @@
     SCode.Comment cmt;
     SCode.Mod annMod;
-    String str;
   algorithm
     if isDefaultRecordConstructor(fn) then
       s := IOStream.append(s, InstNode.toFlatString(fn.node));
     else
+      cmt := Util.getOptionOrDefault(SCodeUtil.getElementComment(InstNode.definition(fn.node)), SCode.COMMENT(NONE(), NONE()));
+
       fn_name := AbsynUtil.pathString(fn.path);
       if stringEmpty(overrideName) then
@@ -732 +734 @@
       s := IOStream.append(s, "function ");
       s := IOStream.append(s, fn_name);
+      s := FlatModelicaUtil.appendCommentString(SOME(cmt), s);
       s := IOStream.append(s, "\n");
 
@@ -758 +761 @@
       s := Sections.toFlatStream(InstNode.getSections(fn.node), fn.path, s);
 
-      cmt := Util.getOptionOrDefault(SCodeUtil.getElementComment(InstNode.definition(fn.node)), SCode.COMMENT(NONE(), NONE()));
       if isSome(cmt.annotation_) then
         SOME(SCode.ANNOTATION(modification=annMod)) := cmt.annotation_;
@@ -777 +779 @@
 
       if not SCodeUtil.emptyModOrEquality(annMod) then
-        str := SCodeDump.printAnnotationStr(SCode.COMMENT(SOME(SCode.ANNOTATION(annMod)),NONE()));
-        if not stringEmpty(str) then
-          s := IOStream.append(s, str);
-          s := IOStream.append(s, ";\n");
-        end if;
+        cmt := SCode.COMMENT(SOME(SCode.ANNOTATION(annMod)), NONE());
+        s := FlatModelicaUtil.appendCommentAnnotation(SOME(cmt), "  ", ";\n", s);
       end if;
 

OMCompiler/Compiler/NFFrontEnd/NFFunctionDerivative.mo

@@ -173 +173 @@
     for tpl in fnDer.conditions loop
       (_, id, condition) := tpl;
-      subMods := SCode.NAMEMOD(conditionToString(condition), SCode.MOD(SCode.NOT_FINAL(), SCode.NOT_EACH(), {}, SOME(Absyn.CREF(Absyn.CREF_IDENT(Util.makeQuotedIdentifier(id), {}))), info)) :: subMods;
+      subMods := SCode.NAMEMOD(conditionToString(condition), SCode.MOD(SCode.NOT_FINAL(), SCode.NOT_EACH(), {}, SOME(Absyn.CREF(Absyn.CREF_IDENT(id, {}))), info)) :: subMods;
     end for;
 
-    mod := SCode.MOD(SCode.NOT_FINAL(), SCode.NOT_EACH(), orderMod::subMods, SOME(Absyn.CREF(Absyn.CREF_IDENT(Util.makeQuotedIdentifier(AbsynUtil.pathString(InstNode.scopePath(fnDer.derivativeFn))),{}))), info);
+    mod := SCode.MOD(SCode.NOT_FINAL(), SCode.NOT_EACH(), orderMod::subMods, SOME(Absyn.CREF(Absyn.CREF_IDENT(AbsynUtil.pathString(InstNode.scopePath(fnDer.derivativeFn)),{}))), info);
     subMod := SCode.NAMEMOD("derivative", mod);
   end toSubMod;

OMCompiler/Compiler/NFFrontEnd/NFStatement.mo

@@ -39 +39 @@
   import Statement = NFStatement;
   import ElementSource;
+  import FlatModelicaUtil = NFFlatModelicaUtil;
   import Util;
   import IOStream;
@@ -811 +812 @@
     end match;
 
+    s := FlatModelicaUtil.appendElementSourceComment(source(stmt), s);
   end toFlatStream;
 

OMCompiler/Compiler/NFFrontEnd/NFVariable.mo

@@ -44 +44 @@
 protected
   import ExpandExp = NFExpandExp;
+  import FlatModelicaUtil = NFFlatModelicaUtil;
   import IOStream;
   import Util;
@@ -339 +340 @@
       s := IOStream.append(s, Binding.toFlatString(var.binding));
     end if;
+
+    s := FlatModelicaUtil.appendComment(var.comment, s);
   end toFlatStream;
 

OMCompiler/Compiler/boot/LoadCompilerSources.mos

@@ -352 +352 @@
     "../NFFrontEnd/NFExpression.mo",
     "../NFFrontEnd/NFFlatModel.mo",
+    "../NFFrontEnd/NFFlatModelicaUtil.mo",
     "../NFFrontEnd/NFFlatten.mo",
     "../NFFrontEnd/NFFunctionDerivative.mo",

testsuite/openmodelica/flatmodelica/Makefile

@@ -11 +11 @@
 TESTFILES = DoublePendulum.mos \
   Tables.mos \
-  SD.mo
+  SD.mo \
+  Comments.mo