Renaming fmi3_terminals* to fmi_terminals* for straight forward repla…

…cements

Test/FMI2/fmi2_import_terminals_and_icons_test.cpp

@@ -29,7 +29,7 @@ TEST_CASE("Test parse terminals and icons") {
     REQUIRE(fmi2_import_get_has_terminals_and_icons(xml) != 0);
 
     SECTION("Testing getting terminal by name") {
-        fmi3_import_terminal_t* term;
+        fmi_import_terminal_t* term;
 
         // test the existing ones
         term = fmi2_import_get_terminal_by_name(xml, "terminalA");

Test/FMI3/fmi3_import_terminals_and_icons_test.cpp

@@ -29,7 +29,7 @@ TEST_CASE("Test parse terminals and icons") {
     REQUIRE(fmi3_import_get_has_terminals_and_icons(xml) != 0);
 
     SECTION("Testing getting terminal by name") {
-        fmi3_import_terminal_t* term;
+        fmi_import_terminal_t* term;
 
         // test the existing ones
         term = fmi3_import_get_terminal_by_name(xml, "terminalA");
@@ -139,7 +139,7 @@ TEST_CASE("Test clearing of attribute buffer with invalid elements") {
 
     REQUIRE(fmi3_testutil_log_contains(tfmu, "Parsing XML element 'Terminal': required attribute 'name' not found"));
 
-    fmi3_import_terminal_t* term = fmi3_import_get_terminal_by_name(fmu, "terminalA");
+    fmi_import_terminal_t* term = fmi3_import_get_terminal_by_name(fmu, "terminalA");
     REQUIRE(term != nullptr);
     REQUIRE_STREQ(fmi3_import_get_terminal_name(term), "terminalA");
     // TODO: Check that optional attributes from Terminal without name are not present in this one

src/Import/include/FMI/fmi_import_terminals_and_icons.h

@@ -47,7 +47,7 @@ extern "C" {
  */
 
 /** \brief Opaque Terminal type */
-typedef struct fmi3_xml_terminal_t fmi3_import_terminal_t;
+typedef struct fmi_xml_terminal_t fmi_import_terminal_t;
 
 /**
  * \brief Returns non-zero if terminalsAndIcons.xml has been found and successfully parsed.
@@ -67,22 +67,22 @@ FMILIB_EXPORT int fmi3_import_get_has_terminals_and_icons(fmi3_import_t* fmu);
     @param name terminal name
     @return terminal pointer. NULL if terminal with given name does not exist.
  */
-FMILIB_EXPORT fmi3_import_terminal_t* fmi2_import_get_terminal_by_name(fmi2_import_t* fmu, const char* name);
+FMILIB_EXPORT fmi_import_terminal_t* fmi2_import_get_terminal_by_name(fmi2_import_t* fmu, const char* name);
 
 /**
     \brief Get terminal by terminal name.
     @param fmu An #fmi3_import_t object as returned by #fmi3_import_parse_xml().
     @param name terminal name
     @return terminal pointer. NULL if terminal with given name does not exist.
  */
-FMILIB_EXPORT fmi3_import_terminal_t* fmi3_import_get_terminal_by_name(fmi3_import_t* fmu, const char* name);
+FMILIB_EXPORT fmi_import_terminal_t* fmi3_import_get_terminal_by_name(fmi3_import_t* fmu, const char* name);
 
 /** 
     \brief Get the variable name
-    @param term An #fmi3_import_terminal_t pointer
+    @param term An #fmi_import_terminal_t pointer
     @return name
 */ 
-FMILIB_EXPORT const char* fmi3_import_get_terminal_name(fmi3_import_terminal_t* term);
+FMILIB_EXPORT const char* fmi3_import_get_terminal_name(fmi_import_terminal_t* term);
 
 /** @} */
 

src/Import/src/FMI/fmi_import_terminals_and_icons.c

@@ -27,14 +27,14 @@ int fmi3_import_get_has_terminals_and_icons(fmi3_import_t* fmu) {
     return fmu ? fmi3_xml_get_has_terminals_and_icons(fmu->termIcon) : 0;
 }
 
-fmi3_import_terminal_t* fmi2_import_get_terminal_by_name(fmi2_import_t* fmu, const char* name){
-    return fmu ? fmi3_xml_get_terminal_by_name(fmu->termIcon, name) : NULL;
+fmi_import_terminal_t* fmi2_import_get_terminal_by_name(fmi2_import_t* fmu, const char* name){
+    return fmu ? fmi_xml_get_terminal_by_name(fmu->termIcon, name) : NULL;
 }
 
-fmi3_import_terminal_t* fmi3_import_get_terminal_by_name(fmi3_import_t* fmu, const char* name){
-    return fmu ? fmi3_xml_get_terminal_by_name(fmu->termIcon, name) : NULL;
+fmi_import_terminal_t* fmi3_import_get_terminal_by_name(fmi3_import_t* fmu, const char* name){
+    return fmu ? fmi_xml_get_terminal_by_name(fmu->termIcon, name) : NULL;
 }
 
-const char* fmi3_import_get_terminal_name(fmi3_import_terminal_t* term){
-    return term ? fmi3_xml_get_terminal_name(term) : NULL;
+const char* fmi3_import_get_terminal_name(fmi_import_terminal_t* term){
+    return term ? fmi_xml_get_terminal_name(term) : NULL;
 }

src/Import/src/FMI2/fmi2_import.c

@@ -59,7 +59,7 @@ fmi2_import_t* fmi2_import_allocate(jm_callbacks* cb) {
         goto err1;
     }
 
-    fmu->termIcon = fmi3_xml_allocate_terminals_and_icons(cb);
+    fmu->termIcon = fmi_xml_allocate_terminals_and_icons(cb);
     if (!fmu->termIcon) {
         goto err2;
     }
@@ -74,7 +74,7 @@ fmi2_import_t* fmi2_import_allocate(jm_callbacks* cb) {
     return fmu;
 
 err3:
-    fmi3_xml_free_terminals_and_icons(fmu->termIcon);
+    fmi_xml_free_terminals_and_icons(fmu->termIcon);
 err2:
     fmi2_xml_free_model_description(fmu->md);
 err1:
@@ -150,7 +150,7 @@ fmi2_import_t* fmi2_import_parse_xml(fmi_import_context_t* context, const char*
         // TODO: Callbacks
         if (fmi3_xml_parse_terminals_and_icons(fmu->termIcon, terminalsAndIconsPath, NULL)) {
             // failure to parse terminalsAndIcons does not constitute parsing failure
-            fmi3_xml_free_terminals_and_icons(fmu->termIcon);
+            fmi_xml_free_terminals_and_icons(fmu->termIcon);
             fmu->termIcon = NULL;
         }
     }
@@ -172,7 +172,7 @@ void fmi2_import_free(fmi2_import_t* fmu) {
 
     fmi2_import_destroy_dllfmu(fmu);
     fmi2_xml_free_model_description(fmu->md);
-    fmi3_xml_free_terminals_and_icons(fmu->termIcon);
+    fmi_xml_free_terminals_and_icons(fmu->termIcon);
     fmi_util_free_options(cb, fmu->options);
     jm_vector_free_data(char)(&fmu->logMessageBufferCoded);
     jm_vector_free_data(char)(&fmu->logMessageBufferExpanded);

src/Import/src/FMI2/fmi2_import_impl.h

@@ -41,7 +41,7 @@ struct fmi2_import_t {
     char* resourceLocation;
     jm_callbacks* callbacks;
     fmi2_xml_model_description_t* md;
-    fmi3_xml_terminals_and_icons_t* termIcon;
+    fmi_xml_terminals_and_icons_t* termIcon;
     fmi2_capi_t* capi;
     jm_vector(char) logMessageBufferCoded;
     jm_vector(char) logMessageBufferExpanded;

src/Import/src/FMI3/fmi3_import.c

@@ -60,7 +60,7 @@ fmi3_import_t* fmi3_import_allocate(jm_callbacks* cb) {
         return NULL;
     }
 
-    fmu->termIcon = fmi3_xml_allocate_terminals_and_icons(cb);
+    fmu->termIcon = fmi_xml_allocate_terminals_and_icons(cb);
     if (!fmu->termIcon) {
         fmi3_xml_free_model_description(fmu->md);
         cb->free(fmu);
@@ -72,7 +72,7 @@ fmi3_import_t* fmi3_import_allocate(jm_callbacks* cb) {
     fmu->options = fmi_util_allocate_options(cb);
     if (!fmu->options) {
         fmi3_xml_free_model_description(fmu->md);
-        fmi3_xml_free_terminals_and_icons(fmu->termIcon);
+        fmi_xml_free_terminals_and_icons(fmu->termIcon);
         cb->free(fmu);
         return NULL;
      }
@@ -143,7 +143,7 @@ fmi3_import_t* fmi3_import_parse_xml(
         // TODO: Callbacks
         if (fmi3_xml_parse_terminals_and_icons(fmu->termIcon, terminalsAndIconsPath, NULL)) {
             // failure to parse terminalsAndIcons does not constitute parsing failure
-            fmi3_xml_free_terminals_and_icons(fmu->termIcon);
+            fmi_xml_free_terminals_and_icons(fmu->termIcon);
             fmu->termIcon = NULL;
         }
     }
@@ -165,7 +165,7 @@ void fmi3_import_free(fmi3_import_t* fmu) {
 
     fmi3_import_destroy_dllfmu(fmu);
     fmi3_xml_free_model_description(fmu->md);
-    fmi3_xml_free_terminals_and_icons(fmu->termIcon);
+    fmi_xml_free_terminals_and_icons(fmu->termIcon);
     fmi_util_free_options(cb, fmu->options);
     jm_vector_free_data(char)(&fmu->logMessageBufferCoded);
     jm_vector_free_data(char)(&fmu->logMessageBufferExpanded);

src/Import/src/FMI3/fmi3_import_impl.h

@@ -42,7 +42,7 @@ struct fmi3_import_t {
     char* instanceName;
     jm_callbacks* callbacks;
     fmi3_xml_model_description_t* md;
-    fmi3_xml_terminals_and_icons_t* termIcon;
+    fmi_xml_terminals_and_icons_t* termIcon;
     fmi3_capi_t* capi;
     /* log message buffer */
     jm_vector(char) logMessageBufferCoded;

src/XML/include/FMI/fmi_xml_terminals_and_icons.h

@@ -13,12 +13,12 @@
     along with this program. If not, contact Modelon AB <http://www.modelon.com>.
 */
 
-/** \file fmi3_xml_terminals_and_icons.h
+/** \file fmi_xml_terminals_and_icons.h
 *  \brief Public interface to the FMI XML C-library.
 */
 
-#ifndef FMI3_XML_TERMINALS_AND_ICONS_H_
-#define FMI3_XML_TERMINALS_AND_ICONS_H_
+#ifndef FMI_XML_TERMINALS_AND_ICONS_H_
+#define FMI_XML_TERMINALS_AND_ICONS_H_
 
 #include <stddef.h>
 #include <JM/jm_callbacks.h>
@@ -30,47 +30,47 @@ extern "C" {
 #endif
 
 /**
-    \addtogroup fmi3_xml
+    \addtogroup fmi_xml
     @{
-    \addtogroup fmi3_xml_terminals_and_icons Functions for handling terminals and icons
+    \addtogroup fmi_xml_terminals_and_icons Functions for handling terminals and icons
     @{
 */
 
 /* Structure encapsulating terminals and icons information */
-typedef struct fmi3_xml_terminals_and_icons_t fmi3_xml_terminals_and_icons_t;
+typedef struct fmi_xml_terminals_and_icons_t fmi_xml_terminals_and_icons_t;
 /* Structure encapsulating terminal information */
-typedef struct fmi3_xml_terminal_t fmi3_xml_terminal_t;
+typedef struct fmi_xml_terminal_t fmi_xml_terminal_t;
 
-fmi3_xml_terminals_and_icons_t* fmi3_xml_allocate_terminals_and_icons(jm_callbacks* callbacks);
-void fmi3_xml_free_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon);
+fmi_xml_terminals_and_icons_t* fmi_xml_allocate_terminals_and_icons(jm_callbacks* callbacks);
+void fmi_xml_free_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon);
 
 /**
    \brief Parse XML file
    Repeated calls invalidate the data structures created with the previous call to fmiParseXML,
    i.e., fmiClearModelDescrition is automatically called before reading in the new file.
 
-    @param termIcon A terminalsAndIcons object as returned by #fmi3_xml_allocate_terminals_and_icons.
+    @param termIcon A terminalsAndIcons object as returned by #fmi_xml_allocate_terminals_and_icons.
     @param fileName A name (full path) of the terminalsAndIcons.xml file.
     @param xml_callbacks Callbacks to use for processing annotations (may be NULL).
     @return 0 if parsing was successful. Non-zero value indicates an error.
 */
-int fmi3_xml_parse_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon,
+int fmi3_xml_parse_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon,
                                        const char* fileName,
                                        fmi_termicon_xml_callbacks_t* xml_callbacks);
-int fmi2_xml_terminals_and_icons_set_model_description(fmi3_xml_terminals_and_icons_t* termIcon,
+int fmi2_xml_terminals_and_icons_set_model_description(fmi_xml_terminals_and_icons_t* termIcon,
                                                        fmi2_xml_model_description_t* md);
-int fmi3_xml_terminals_and_icons_set_model_description(fmi3_xml_terminals_and_icons_t* termIcon,
+int fmi3_xml_terminals_and_icons_set_model_description(fmi_xml_terminals_and_icons_t* termIcon,
                                                        fmi3_xml_model_description_t* md);
 
-int fmi2_xml_get_has_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon);
-int fmi3_xml_get_has_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon);
-fmi3_xml_terminal_t* fmi3_xml_get_terminal_by_name(fmi3_xml_terminals_and_icons_t* termIcon, const char* name);
-const char* fmi3_xml_get_terminal_name(fmi3_xml_terminal_t* term);
+int fmi2_xml_get_has_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon);
+int fmi3_xml_get_has_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon);
+fmi_xml_terminal_t* fmi_xml_get_terminal_by_name(fmi_xml_terminals_and_icons_t* termIcon, const char* name);
+const char* fmi_xml_get_terminal_name(fmi_xml_terminal_t* term);
 
 /** @} */
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif // FMI3_XML_TERMINALS_AND_ICONS_H_
+#endif // FMI_XML_TERMINALS_AND_ICONS_H_

src/XML/src/FMI/fmi_xml_terminals_and_icons.c

@@ -22,10 +22,10 @@
 
 static const char* module = "FMI3XML";
 
-fmi3_xml_terminals_and_icons_t* fmi3_xml_allocate_terminals_and_icons(jm_callbacks* callbacks) {
+fmi_xml_terminals_and_icons_t* fmi_xml_allocate_terminals_and_icons(jm_callbacks* callbacks) {
     jm_callbacks* cb = callbacks ? callbacks : jm_get_default_callbacks();
 
-    fmi3_xml_terminals_and_icons_t* termIcon = (fmi3_xml_terminals_and_icons_t*)callbacks->calloc(1, sizeof(fmi3_xml_terminals_and_icons_t));
+    fmi_xml_terminals_and_icons_t* termIcon = (fmi_xml_terminals_and_icons_t*)callbacks->calloc(1, sizeof(fmi_xml_terminals_and_icons_t));
     if (!termIcon) {
         jm_log_fatal(cb, module, "Could not allocate memory");
         return 0;
@@ -44,29 +44,29 @@ fmi3_xml_terminals_and_icons_t* fmi3_xml_allocate_terminals_and_icons(jm_callbac
     return termIcon;
 }
 
-static fmi3_xml_terminal_t* fmi3_xml_alloc_terminal(fmi3_xml_parser_context_t* context) {
-    fmi3_xml_terminal_t* term = (fmi3_xml_terminal_t*)context->callbacks->calloc(1, sizeof(fmi3_xml_terminal_t));
+static fmi_xml_terminal_t* fmi_xml_alloc_terminal(fmi3_xml_parser_context_t* context) {
+    fmi_xml_terminal_t* term = (fmi_xml_terminal_t*)context->callbacks->calloc(1, sizeof(fmi_xml_terminal_t));
     if (!term) {
         fmi3_xml_parse_fatal(context, "Could not allocate memory");
         return NULL;
     }
     return term;
 }
 
-static void fmi3_xml_free_terminal(jm_callbacks* callbacks, fmi3_xml_terminal_t* term) {
+static void fmi_xml_free_terminal(jm_callbacks* callbacks, fmi_xml_terminal_t* term) {
     callbacks->free(term);
 }
 
-void fmi3_xml_free_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon) {
+void fmi_xml_free_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon) {
     if (!termIcon) {return;}
     jm_callbacks* callbacks = termIcon->callbacks;
     if (termIcon) {
         jm_vector_free_data(char)(&(termIcon->fmi3_xml_standard_version));
 
         // free terminals
         for (size_t i = 0; i < jm_vector_get_size(jm_voidp)(&(termIcon->terminalsOrigOrder)); i++) {
-            fmi3_xml_terminal_t* term = (fmi3_xml_terminal_t*) jm_vector_get_item(jm_voidp)(&(termIcon->terminalsOrigOrder), i);
-            fmi3_xml_free_terminal(callbacks, term);
+            fmi_xml_terminal_t* term = (fmi_xml_terminal_t*) jm_vector_get_item(jm_voidp)(&(termIcon->terminalsOrigOrder), i);
+            fmi_xml_free_terminal(callbacks, term);
         }
         jm_vector_free_data(jm_voidp)(&(termIcon->terminalsOrigOrder));
         jm_vector_free_data(jm_named_ptr)(&termIcon->terminalsByName);
@@ -81,7 +81,7 @@ void fmi3_xml_free_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon)
     callbacks->free(termIcon);
 }
 
-int fmi2_xml_terminals_and_icons_set_model_description(fmi3_xml_terminals_and_icons_t* termIcon,
+int fmi2_xml_terminals_and_icons_set_model_description(fmi_xml_terminals_and_icons_t* termIcon,
                                                        fmi2_xml_model_description_t* md) {
     if (!termIcon || !md || termIcon->md3) {
         return -1;
@@ -91,7 +91,7 @@ int fmi2_xml_terminals_and_icons_set_model_description(fmi3_xml_terminals_and_ic
     }
 }
 
-int fmi3_xml_terminals_and_icons_set_model_description(fmi3_xml_terminals_and_icons_t* termIcon,
+int fmi3_xml_terminals_and_icons_set_model_description(fmi_xml_terminals_and_icons_t* termIcon,
                                                        fmi3_xml_model_description_t* md) {
     if (!termIcon || !md || termIcon->md2) {
         return -1;
@@ -102,7 +102,7 @@ int fmi3_xml_terminals_and_icons_set_model_description(fmi3_xml_terminals_and_ic
 }
 
 int fmi3_xml_handle_fmiTerminalsAndIcons(fmi3_xml_parser_context_t* context, const char* data) {
-    fmi3_xml_terminals_and_icons_t* termIcon = context->termIcon;
+    fmi_xml_terminals_and_icons_t* termIcon = context->termIcon;
     if (!data) {
         int ret;
         if (context->currentElmID != fmi3_xml_elmID_none) {
@@ -141,7 +141,7 @@ int fmi3_xml_handle_fmiTerminalsAndIcons(fmi3_xml_parser_context_t* context, con
 }
 
 int fmi3_xml_handle_Terminals(fmi3_xml_parser_context_t* context, const char* data) {
-    fmi3_xml_terminals_and_icons_t* termIcon = context->termIcon;
+    fmi_xml_terminals_and_icons_t* termIcon = context->termIcon;
     if (!data) {
         ;
     } else { // post process <Terminals>
@@ -152,7 +152,7 @@ int fmi3_xml_handle_Terminals(fmi3_xml_parser_context_t* context, const char* da
         jm_vector_resize(jm_named_ptr)(&termIcon->terminalsByName, 0);      // Make sure we start pushback at index=0
         for (size_t i = 0; i < nVars; i++) {
             jm_named_ptr named;
-            fmi3_xml_terminal_t* term = jm_vector_get_item(jm_voidp)(&termIcon->terminalsOrigOrder, i);
+            fmi_xml_terminal_t* term = jm_vector_get_item(jm_voidp)(&termIcon->terminalsOrigOrder, i);
             named.name = term->name;
             named.ptr = term;
             jm_vector_push_back(jm_named_ptr)(&termIcon->terminalsByName, named);
@@ -176,9 +176,9 @@ int fmi3_xml_handle_Terminals(fmi3_xml_parser_context_t* context, const char* da
 }
 
 int fmi3_xml_handle_Terminal(fmi3_xml_parser_context_t* context, const char* data) {
-    fmi3_xml_terminals_and_icons_t* termIcon = context->termIcon;
+    fmi_xml_terminals_and_icons_t* termIcon = context->termIcon;
     if (!data) {
-        fmi3_xml_terminal_t* term = fmi3_xml_alloc_terminal(context);
+        fmi_xml_terminal_t* term = fmi_xml_alloc_terminal(context);
         if (!term) {return -1;}
 
         /* Add Terminal ptr to terminalAndIcons obj */
@@ -238,15 +238,15 @@ int fmi3_xml_handle_TerminalGraphicalRepresentation(fmi3_xml_parser_context_t* c
     return 0;
 }
 
-int fmi2_xml_get_has_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon) {
+int fmi2_xml_get_has_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon) {
     return termIcon ? 1 : 0;
 }
 
-int fmi3_xml_get_has_terminals_and_icons(fmi3_xml_terminals_and_icons_t* termIcon) {
+int fmi3_xml_get_has_terminals_and_icons(fmi_xml_terminals_and_icons_t* termIcon) {
     return termIcon ? 1 : 0;
 }
 
-fmi3_xml_terminal_t* fmi3_xml_get_terminal_by_name(fmi3_xml_terminals_and_icons_t* termIcon, const char* name){
+fmi_xml_terminal_t* fmi_xml_get_terminal_by_name(fmi_xml_terminals_and_icons_t* termIcon, const char* name){
     if (!name) return NULL;
     jm_named_ptr key, *found;
     key.name = name;
@@ -255,6 +255,6 @@ fmi3_xml_terminal_t* fmi3_xml_get_terminal_by_name(fmi3_xml_terminals_and_icons_
     return found->ptr;
 }
 
-const char* fmi3_xml_get_terminal_name(fmi3_xml_terminal_t* term) {
+const char* fmi_xml_get_terminal_name(fmi_xml_terminal_t* term) {
     return term ? term->name : NULL;
 }