[Cpp,FMI] extend FMI export with optional custom annotations (#15727)

* [Cpp,FMI] extend FMI export with optional custom annotations

This is particularly interesting for applications that go beyond simulation,
like optimization, to specify additional things like constraints via custom
annotations in a Modelica model.

- new flag --fmiExtraAnnotations=<regex for annotations of interest>
- while building the Cpp FMU, CevalScriptBackend.callBuildModelFMU dumps the
  model instance JSON (<prefix>_modelInstance.json), guarded by the flag
- a standalone jq filter Compiler/scripts/filter-annotations.jq (installed to
  share/omc/scripts) selects the annotations of interest
- FMI export adds file extra/org.openmodelica/modelAnnotations.json to the FMU

This keeps codegen free of an NFApi dependency and moves the jq filter out of
the template for better portability (e.g. paths with spaces on Windows/OMDev).

Note: adds jq as a runtime dependency of the Cpp FMU export when
--fmiExtraAnnotations is used.

Co-authored-by: rfranke <rfranke@users.noreply.github.com>

* [OMDev] bump runtime CXX standard to c++17 for std::string_view

Makefile.omdev.mingw still forced -std=c++11, breaking the OMDev/MinGW
build after std::string_view was introduced in systemimplmisc.cpp
(f643f51). CMake already enforces C++17, so match it here.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Adrian Pop <adrian.pop@liu.se>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: 3 people

OMCompiler/Compiler/Makefile.in

@@ -29,7 +29,7 @@ CORBAHOME = @CORBAHOME@
 
 PROG = omc
 
-SCRIPT_FILES = openmodelica.lefty default_profiling.xsl replace-startValue.sh replace-startValue.xsl simcodedump.xsl ngspicetoModelica.py
+SCRIPT_FILES = openmodelica.lefty default_profiling.xsl replace-startValue.sh replace-startValue.xsl simcodedump.xsl ngspicetoModelica.py filter-annotations.jq
 
 SUBDIRS	= FrontEndCpp runtime Script
 

OMCompiler/Compiler/Makefile.omdev.mingw

@@ -16,7 +16,7 @@ LIBSOCKET = -lwsock32
 
 SHELL	= /bin/sh
 
-SCRIPT_FILES = Compile.bat Prompt.bat openmodelica.lefty default_profiling.xsl replace-startValue.* simcodedump.xsl ngspicetoModelica.py
+SCRIPT_FILES = Compile.bat Prompt.bat openmodelica.lefty default_profiling.xsl replace-startValue.* simcodedump.xsl ngspicetoModelica.py filter-annotations.jq
 
 SUBDIRS	= runtime Script
 

OMCompiler/Compiler/Script/CevalScriptBackend.mo

@@ -4455,6 +4455,11 @@ algorithm
   dir := fmutmp+"/sources/";
 
   if Config.simCodeTarget() == "Cpp" then
+    // dump modelInstance.json so the FMU makefile can filter out the
+    // requested extra annotations (see flag --fmiExtraAnnotations)
+    if Flags.getConfigString(Flags.FMI_EXTRA_ANNOTATIONS) <> "" then
+      System.writeFile(filenameprefix + "_modelInstance.json", ValuesUtil.extractValueString(NFApi.getModelInstance(className, className, "", true)));
+    end if;
     System.removeDirectory("binaries");
     for platform in platforms loop
       if platform == "dynamic" or platform == "static" then

OMCompiler/Compiler/Template/CodegenFMUCpp.tpl

@@ -108,6 +108,8 @@ case SIMCODE(modelInfo=modelInfo as MODELINFO(__)) then
   let numBoolVars = numBoolvars(modelInfo)
   let numStringVars = numStringvars(modelInfo)
 
+  let extraAnnotations = Flags.getConfigString(FMI_EXTRA_ANNOTATIONS)
+
   let _ = FlagsUtil.set(Flags.HARDCODED_START_VALUES, true)
   let cpp = CodegenCpp.translateModel(simCode)
   let()= textFile(fmuWriteOutputHeaderFile(simCode , &extraFuncs , &extraFuncsDecl, ""),'OMCpp<%fileNamePrefix%>WriteOutput.h')
@@ -116,7 +118,7 @@ case SIMCODE(modelInfo=modelInfo as MODELINFO(__)) then
   let()= textFile((if isFMIVersion10(FMUVersion) then CodegenCppInit.modelInitXMLFile(simCode, numRealVars, numIntVars, numBoolVars, numStringVars, FMUVersion, FMUType, guid, true, "cpp-runtime", complexStartExpressions, stateDerVectorName) else
                    CodegenFMU.fmuModelDescriptionFile(simCode, guid, FMUVersion, FMUType, sourceFiles)), 'modelDescription.xml')
   let()= textFile(fmudeffile(simCode, FMUVersion), '<%fileNamePrefix%>.def')
-  let()= textFile(fmuMakefile(target,simCode, extraFuncs, extraFuncsDecl, "", FMUVersion, "", "", "", ""), '<%fileNamePrefix%>_FMU.makefile')
+  let()= textFile(fmuMakefile(target, simCode, extraFuncs, extraFuncsDecl, "", FMUVersion, "", "", "", "", extraAnnotations), '<%fileNamePrefix%>_FMU.makefile')
   let()= textFile(fmuCalcHelperMainfile(simCode), 'OMCpp<%fileNamePrefix%>CalcHelperMain.cpp')
   let _ = FlagsUtil.set(Flags.HARDCODED_START_VALUES, false)
 
@@ -708,7 +710,7 @@ case SIMCODE(modelInfo=MODELINFO(), modelStructure=fmiModelStructure) then
 end directionalDerivativeFunction;
 
 template fmuMakefile(String target, SimCode simCode, Text& extraFuncs, Text& extraFuncsDecl, Text extraFuncsNamespace, String FMUVersion, String additionalLinkerFlags_GCC,
-                            String additionalLinkerFlags_MSVC, String additionalCFlags_GCC, String additionalCFlags_MSVC)
+                     String additionalLinkerFlags_MSVC, String additionalCFlags_GCC, String additionalCFlags_MSVC, String extraAnnotations)
  "Generates the contents of the makefile for the simulation case. Copy libexpat & correct linux fmu"
 ::=
 match getGeneralTarget(target)
@@ -907,14 +909,22 @@ case SIMCODE(modelInfo=MODELINFO(__), makefileParams=MAKEFILE_PARAMS(__), simula
   <%\t%>zip -r "<%fmuTargetName%>.fmu" modelDescription.xml binaries sources
   endif
   endif
+  ifneq ("<%extraAnnotations%>","")
+  <%\t%><%mkdir%> -p extra/org.openmodelica
+  <%\t%>jq --arg regex "<%extraAnnotations%>" -f "$(OMHOME)/share/omc/scripts/filter-annotations.jq" <%fileNamePrefix%>_modelInstance.json > extra/org.openmodelica/modelAnnotations.json
+  ifeq ($(ZIP_FMU),ON)
+  <%\t%>zip -ur "<%fmuTargetName%>.fmu" extra
+  endif
+  endif
 
   ifeq ($(ZIP_FMU),OFF)
   <%\t%>rm -f OMCpp<%fileNamePrefix%>* <%fileNamePrefix%>_FMU.* <%fileNamePrefix%>.def <%fileNamePrefix%>.sh <%fileNamePrefix%>.bat <%fileNamePrefix%>.makefile <%fileNamePrefix%>_init.xml
+  <%\t%>rm -f <%fileNamePrefix%>_modelInstance.json
   endif
 
   clean:
   <%\t%>rm -f OMCpp<%fileNamePrefix%>* <%fileNamePrefix%>_FMU.* <%fileNamePrefix%>.def <%fileNamePrefix%>.sh <%fileNamePrefix%>.bat <%fileNamePrefix%>.makefile <%fileNamePrefix%>_init.xml
-  <%\t%>rm -rf modelDescription.xml binaries sources documentation
+  <%\t%>rm -rf modelDescription.xml binaries sources documentation extra <%fileNamePrefix%>_modelInstance.json
 
   >>
 end fmuMakefile;

OMCompiler/Compiler/Template/CodegenFMUCppHpcom.tpl

@@ -152,7 +152,7 @@ template fmuMakefile(String target, SimCode simCode, Text& extraFuncs, Text& ext
 
   <<
   <%CodegenCppHpcom.getAdditionalMakefileFlags(additionalCFlags_GCC, additionalCFlags_MSVC, additionalLinkerFlags_GCC, additionalLinkerFlags_MSVC)%>
-  <%CodegenFMUCpp.fmuMakefile(target, simCode, extraFuncs, extraFuncsDecl, extraFuncsNamespace, FMUVersion, additionalLinkerFlags_GCC, additionalLinkerFlags_MSVC, additionalCFlags_GCC, additionalCFlags_MSVC)%>
+  <%CodegenFMUCpp.fmuMakefile(target, simCode, extraFuncs, extraFuncsDecl, extraFuncsNamespace, FMUVersion, additionalLinkerFlags_GCC, additionalLinkerFlags_MSVC, additionalCFlags_GCC, additionalCFlags_MSVC, "")%>
   >>
 end fmuMakefile;
 

OMCompiler/Compiler/Template/SimCodeTV.mo

@@ -4172,6 +4172,7 @@ package Flags
   constant ConfigFlag OBFUSCATE;
   constant ConfigFlag MAX_SIZE_LINEARIZATION;
   constant ConfigFlag NEW_BACKEND;
+  constant ConfigFlag FMI_EXTRA_ANNOTATIONS;
 
   function isSet
     input DebugFlag inFlag;

OMCompiler/Compiler/Util/Flags.mo

@@ -1404,6 +1404,9 @@ constant ConfigFlag EXECUTE_COMMAND = CONFIG_FLAG(162, "cmd",
 constant ConfigFlag MOO_DYNAMIC_OPTIMIZATION = CONFIG_FLAG(163, "moo",
   NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
   Gettext.gettext("Generate code for dynamic optimization library MOO."));
+constant ConfigFlag FMI_EXTRA_ANNOTATIONS = CONFIG_FLAG(164, "fmiExtraAnnotations",
+  NONE(), EXTERNAL(), STRING_FLAG(""), NONE(),
+  Gettext.gettext("Export annotations matching the given regex to extra/org.openmodelica/modelAnnotations.json."));
 
 function getFlags
   "Loads the flags with getGlobalRoot. Assumes flags have been loaded."

OMCompiler/Compiler/Util/FlagsUtil.mo

@@ -429,7 +429,8 @@ constant list<Flags.ConfigFlag> allConfigFlags = {
   Flags.CAUSALIZE_DAE_MODE,
   Flags.SIM_CODE_SCALARIZE,
   Flags.EXECUTE_COMMAND,
-  Flags.MOO_DYNAMIC_OPTIMIZATION
+  Flags.MOO_DYNAMIC_OPTIMIZATION,
+  Flags.FMI_EXTRA_ANNOTATIONS
 };
 
 public function new

OMCompiler/Compiler/runtime/Makefile.omdev.mingw

@@ -48,6 +48,6 @@ SHELL	= /bin/sh
 CC	= gcc
 CXX = g++
 override CFLAGS += $(CORBA_C_CLFAGS) $(USE_METIS) -Werror=implicit-function-declaration -Wall -Wno-unused-variable -I$(OMC_CONFIG_INC) -I$(top_builddir)/SimulationRuntime/c -I$(top_builddir)/SimulationRuntime/c/simulation/results -I$(top_builddir)/SimulationRuntime/c/util -I$(top_builddir)/SimulationRuntime/c/meta -I$(top_builddir)/SimulationRuntime/c/meta/gc $(CORBAINCL) $(GCINCLUDE) -I$(FMIINCLUDE) -I$(CJSONINCLUDE) -I$(GRAPHINCLUDE) -I$(SQLITE3INCLUDE) -I$(ZMQINCLUDE) -I"$(TOP_DIR)/3rdParty/zlib" -I"$(TOP_DIR)/3rdParty/libffi/install/include/" -DWIN32_LEAN_AND_MEAN
-override CXXFLAGS += -std=c++11 $(CFLAGS)
+override CXXFLAGS += -std=c++17 $(CFLAGS)
 
 include Makefile.common

OMCompiler/Compiler/scripts/filter-annotations.jq

@@ -0,0 +1,43 @@
+# Filter annotations of interest out of a modelInstance.json file produced by
+# the OpenModelica getModelInstance API. Used by the Cpp FMU export when the
+# --fmiExtraAnnotations=<regex> flag is set.
+#
+# Usage:
+#   jq --arg regex "__Optimization|__Estimation" -f filter-annotations.jq Model_modelInstance.json > modelAnnotations.json
+def keep_annotation:
+  if type == "object" then
+    if (.prefixes? | type) == "object" and (.prefixes.outer? // false) then
+      null
+    else
+      (
+        . as $obj
+        # place dims first to know them when parsing a name or type in one pass
+        # | reduce ($obj | keys_unsorted[]) as $k
+        | reduce ((if has("dims") then {dims} else {} end)
+                  + with_entries(select(.key != "dims")) | keys_unsorted[]) as $k
+            ({};
+              if $k | test($regex) then
+                . + {($k): $obj[$k]}
+              elif ($k == "name" or $k == "restriction" or $k == "dims")
+                    and ($obj | any(.. | objects; .annotation? | objects | keys | any(test($regex)))) then
+                . + if $k == "dims" then {($k): $obj[$k]["typed"]} else {($k): $obj[$k]} end
+              else
+                ($obj[$k] | keep_annotation) as $v
+                | if $v == null or $v == {} or $v == [] then
+                    .
+                  else
+                    . + {($k): $v}
+                  end
+              end
+            )
+      )
+      | if . == {} then null else . end
+    end
+  elif type == "array" then
+    map(keep_annotation)
+    | map(select(. != null and . != {} and . != []))
+    | if length == 0 then null else . end
+  else null
+  end;
+
+keep_annotation