Add logFormat=xmltcp

logFormat=xmltcp requires a port to be passed and changes the format of
the status sent periodically to be an XML message.

All messages are buffered and sent when the message is finished in order
to always send complete XML fragments to OMEdit.

Author: sjoelund

SimulationRuntime/c/simulation/options.c

@@ -30,6 +30,7 @@
 
 #include "options.h"
 #include "util/omc_error.h"
+#include "simulation_runtime.h"
 
 #include <string.h>
 #include <stdio.h>
@@ -50,22 +51,19 @@ int helpFlagSet(int argc, char** argv)
 int setLogFormat(int argc, char** argv)
 {
   const char* value = getOption(FLAG_NAME[FLAG_LOG_FORMAT], argc, argv);
-  if(NULL == value)
+  if (NULL == value) {
     value = getFlagValue(FLAG_NAME[FLAG_LOG_FORMAT], argc, argv);
+  }
 
-  if (NULL != value)
-  {
-    if (0 == strcmp(value, "xml"))
-    {
+  if (NULL != value) {
+    if (0 == strcmp(value, "xml")) {
       setStreamPrintXML(1);
-    }
-    else if (0 == strcmp(value, "text"))
-    {
+    } else if (0 == strcmp(value, "xmltcp")) {
+      setStreamPrintXML(2);
+    } else if (0 == strcmp(value, "text")) {
       setStreamPrintXML(0);
-    }
-    else
-    {
-      warningStreamPrint(LOG_STDOUT, 0, "invalid command line option: -logFormat=%s, expected text or xml", value);
+    } else {
+      warningStreamPrint(LOG_STDOUT, 0, "invalid command line option: -logFormat=%s, expected text, xml, or xmltcp", value);
       return 1;
     }
   }

SimulationRuntime/c/simulation/simulation_runtime.cpp

@@ -94,6 +94,7 @@ using namespace std;
 #ifndef NO_INTERACTIVE_DEPENDENCY
   Socket sim_communication_port;
   static int sim_communication_port_open = 0;
+  static int isXMLTCP=0;
 #endif
 
 extern "C" {
@@ -861,24 +862,25 @@ int initRuntimeAndSimulation(int argc, char**argv, DATA *data, threadData_t *thr
 
   sim_noemit = omc_flag[FLAG_NOEMIT];
 
-  // ppriv - NO_INTERACTIVE_DEPENDENCY - for simpler debugging in Visual Studio
-
 #ifndef NO_INTERACTIVE_DEPENDENCY
-  if(omc_flag[FLAG_PORT])
-  {
+  if(omc_flag[FLAG_PORT]) {
     std::istringstream stream(omc_flagValue[FLAG_PORT]);
     int port;
     stream >> port;
     sim_communication_port_open = 1;
     sim_communication_port_open &= sim_communication_port.create();
     sim_communication_port_open &= sim_communication_port.connect("127.0.0.1", port);
 
-    if(0 != strcmp("ia", data->simulationInfo->outputFormat))
-    {
-      communicateStatus("Starting", 0.0);
+    if(0 != strcmp("ia", data->simulationInfo->outputFormat)) {
+      communicateStatus("Starting", 0.0, data->simulationInfo->startTime, 0);
     }
   }
 #endif
+  if (isXMLTCP && !sim_communication_port_open) {
+    errorStreamPrint(LOG_STDOUT, 0, "xmltcp log format requires a TCP-port to be passed (and successfully open)");
+    EXIT(1);
+  }
+  // ppriv - NO_INTERACTIVE_DEPENDENCY - for simpler debugging in Visual Studio
 
   return 0;
 }
@@ -899,20 +901,6 @@ void SimulationRuntime_printStatus(int sig)
   printf("</status>\n");
 }
 
-void communicateStatus(const char *phase, double completionPercent /*0.0 to 1.0*/)
-{
-#ifndef NO_INTERACTIVE_DEPENDENCY
-  if(sim_communication_port_open)
-  {
-    std::stringstream s;
-    s << (int)(completionPercent*10000) << " " << phase << endl;
-    std::string str(s.str());
-    sim_communication_port.send(str);
-    // cout << str;
-  }
-#endif
-}
-
 void communicateMsg(char id, unsigned int size, const char *data)
 {
 #ifndef NO_INTERACTIVE_DEPENDENCY
@@ -992,4 +980,154 @@ const char* prettyPrintNanoSec(int64_t ns, int *v)
 }
 #endif
 
+#ifndef NO_INTERACTIVE_DEPENDENCY
+static std::stringstream xmlTcpStream;
+static int numOpenTags=0;
+
+static void printEscapedXMLTCP(std::stringstream *s, const char *msg)
+{
+  while (*msg) {
+    if (*msg == '&') {
+      *s << "&amp;";
+    } else if (*msg == '<') {
+      *s << "&lt;";
+    } else if (*msg == '>') {
+      *s << "&gt;";
+    } else if (*msg == '"') {
+      *s << "&quot;";
+    } else {
+      *s << *msg;
+    }
+    msg++;
+  }
+}
+
+static inline void sendXMLTCPIfClosed()
+{
+  if (numOpenTags==0) {
+    sim_communication_port.send(xmlTcpStream.str());
+    xmlTcpStream.clear();
+  }
+}
+
+static void messageXMLTCP(int type, int stream, int indentNext, char *msg, int subline, const int *indexes)
+{
+  xmlTcpStream << "<message stream=\"" << LOG_STREAM_NAME[stream] << "\" type=\"" << LOG_TYPE_DESC[type] << "\" text=\"";
+  printEscapedXMLTCP(&xmlTcpStream, msg);
+  if (indexes) {
+    int i;
+    xmlTcpStream << "\">\n";
+    for (i=1; i<=*indexes; i++) {
+      xmlTcpStream << "<used index=\"" << indexes[i] << "%d\" />\n";
+    }
+    if (!indentNext) {
+      xmlTcpStream << "</message>\n";
+    }
+  } else {
+    xmlTcpStream << (indentNext ? "\">\n" : "\" />\n");
+  }
+  sendXMLTCPIfClosed();
+}
+
+static void messageCloseXMLTCP(int stream)
+{
+  if (ACTIVE_STREAM(stream)) {
+    numOpenTags--;
+    xmlTcpStream << "</message>\n";
+    sendXMLTCPIfClosed();
+  }
+}
+
+static void messageCloseXMLTCPWarning(int stream)
+{
+  if (ACTIVE_WARNING_STREAM(stream)) {
+    numOpenTags--;
+    xmlTcpStream << "</message>\n";
+    sendXMLTCPIfClosed();
+  }
+}
+#endif
+
+static void printEscapedXML(const char *msg)
+{
+  while (*msg) {
+    if (*msg == '&') fputs("&amp;", stdout);
+    else if (*msg == '<') fputs("&lt;", stdout);
+    else if (*msg == '>') fputs("&gt;", stdout);
+    else if (*msg == '"') fputs("&quot;", stdout);
+    else fputc(*msg, stdout);
+    msg++;
+  }
+}
+
+static void messageXML(int type, int stream, int indentNext, char *msg, int subline, const int *indexes)
+{
+  printf("<message stream=\"%s\" type=\"%s\" text=\"", LOG_STREAM_NAME[stream], LOG_TYPE_DESC[type]);
+  printEscapedXML(msg);
+  if (indexes) {
+    int i;
+    printf("\">\n");
+    for (i=1; i<=*indexes; i++) {
+      printf("<used index=\"%d\" />\n", indexes[i]);
+    }
+    if (!indentNext) {
+      fputs("</message>\n",stdout);
+    }
+  } else {
+    fputs(indentNext ? "\">\n" : "\" />\n", stdout);
+  }
+  fflush(stdout);
+}
+
+static void messageCloseXML(int stream)
+{
+  if (ACTIVE_STREAM(stream)) {
+    fputs("</message>\n", stdout);
+    fflush(stdout);
+  }
+}
+
+static void messageCloseXMLWarning(int stream)
+{
+  if (ACTIVE_WARNING_STREAM(stream)) {
+    fputs("</message>\n", stdout);
+    fflush(stdout);
+  }
+}
+
+void setStreamPrintXML(int isXML)
+{
+  if (isXML==1) {
+    messageFunction = messageXML;
+    messageClose = messageCloseXML;
+    messageCloseWarning = messageCloseXMLWarning;
+#ifndef NO_INTERACTIVE_DEPENDENCY
+  } else if (isXML==2) {
+    messageFunction = messageXMLTCP;
+    messageClose = messageCloseXMLTCP;
+    messageCloseWarning = messageCloseXMLTCPWarning;
+    isXMLTCP = 1;
+#endif
+  } else {
+    /* Already set... */
+  }
+}
+
+void communicateStatus(const char *phase, double completionPercent /*0.0 to 1.0*/, double currentTime, double currentStepSize)
+{
+#ifndef NO_INTERACTIVE_DEPENDENCY
+  if (sim_communication_port_open && isXMLTCP) {
+    std::stringstream s;
+    s << "<status phase=\"" << phase << "\" currentStepSize=\"" << currentStepSize << "\" time=\"" << currentTime << "\" progress=\"" << (int)(completionPercent*10000) << "\" />" << std::endl;
+    std::string str(s.str());
+    sim_communication_port.send(str);
+  } else if (sim_communication_port_open) {
+    std::stringstream s;
+    s << (int)(completionPercent*10000) << " " << phase << endl;
+    std::string str(s.str());
+    sim_communication_port.send(str);
+  }
+#endif
+}
+
 } // extern "C"

SimulationRuntime/c/simulation/simulation_runtime.h

@@ -74,7 +74,7 @@ extern const char* getNameString(const char** ptr);
 extern double getSimulationStepSize();
 extern void printSimulationStepSize(double in_stepSize, double time);
 
-extern void communicateStatus(const char *phase, double completionPercent);
+extern void communicateStatus(const char *phase, double completionPercent, double currentTime, double currentStepSize);
 extern void communicateMsg(char id, unsigned int size, const char *data);
 
 /* the main function of the simulation runtime!
@@ -86,6 +86,8 @@ extern int _main_SimulationRuntime(int argc, char**argv, DATA *data, threadData_
 const char* prettyPrintNanoSec(int64_t ns, int *v);
 #endif
 
+void setStreamPrintXML(int isXML);
+
 #ifdef __cplusplus
 }
 #endif

SimulationRuntime/c/simulation/solver/perform_qss_simulation.c

@@ -211,7 +211,7 @@ int prefixedName_performQSSSimulation(DATA* data, threadData_t *threadData, SOLV
   while(solverInfo->currentTime < simInfo->stopTime)
   {
     modelica_integer success = 0;
-	uinteger k = 0, j = 0;
+  uinteger k = 0, j = 0;
 
     threadData->currentErrorStage = ERROR_SIMULATION;
     omc_alloc_interface.collect_a_little();
@@ -280,9 +280,8 @@ int prefixedName_performQSSSimulation(DATA* data, threadData_t *threadData, SOLV
     tqp[ind] = tq[ind] + dTnextQ;
     nQh[ind] = nextQ;
 
-    if (0 != strcmp("ia", data->simulationInfo->outputFormat))
-    {
-      communicateStatus("Running", (solverInfo->currentTime-simInfo->startTime)/(simInfo->stopTime-simInfo->startTime));
+    if (0 != strcmp("ia", data->simulationInfo->outputFormat)) {
+      communicateStatus("Running", (solverInfo->currentTime-simInfo->startTime)/(simInfo->stopTime-simInfo->startTime), solverInfo->currentTime, 0.0);
     }
 
     /* get the derivatives depending on state[ind] */

SimulationRuntime/c/simulation/solver/perform_simulation.c

@@ -141,9 +141,8 @@ static int simulationStep(DATA* data, threadData_t *threadData, SOLVER_INFO* sol
 {
   SIMULATION_INFO *simInfo = data->simulationInfo;
 
-  if(0 != strcmp("ia", data->simulationInfo->outputFormat))
-  {
-    communicateStatus("Running", (solverInfo->currentTime - simInfo->startTime)/(simInfo->stopTime - simInfo->startTime));
+  if(0 != strcmp("ia", data->simulationInfo->outputFormat)) {
+    communicateStatus("Running", (solverInfo->currentTime - simInfo->startTime)/(simInfo->stopTime - simInfo->startTime), solverInfo->currentTime, solverInfo->currentStepSize);
   }
   return solver_main_step(data, threadData, solverInfo);
 }

SimulationRuntime/c/simulation/solver/solver_main.c

@@ -548,7 +548,7 @@ int finishSimulation(DATA* data, threadData_t *threadData, SOLVER_INFO* solverIn
   }
 
   if (0 != strcmp("ia", data->simulationInfo->outputFormat)) {
-    communicateStatus("Finished", 1);
+    communicateStatus("Finished", 1, solverInfo->currentTime, solverInfo->currentStepSize);
   }
 
   /* we have output variables in the command line -output a,b,c */