Setup CI checks via GitHub Actions

.CI/Test/ModelicaUtilities.h

@@ -0,0 +1,222 @@
+/* ModelicaUtilities.h - External utility functions header
+
+   Copyright (C) 2010-2024, Modelica Association and contributors
+   All rights reserved.
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+   3. Neither the name of the copyright holder nor the names of its
+      contributors may be used to endorse or promote products derived from
+      this software without specific prior written permission.
+
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+   CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+/* Utility functions which can be called by external Modelica functions.
+
+   These functions are defined in section 12.9.6 of the Modelica Specification 3.6.
+
+   A generic C-implementation of these functions cannot be given,
+   because it is tool dependent how strings are output in a
+   console or window of the respective simulation tool.
+*/
+
+#ifndef MODELICA_UTILITIES_H
+#define MODELICA_UTILITIES_H
+
+#include <stddef.h>
+#include <stdarg.h>
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+/*
+  Some of the functions never return to the caller. In order to compile
+  external Modelica C-code in most compilers, noreturn attributes need to
+  be present to avoid warnings or errors.
+
+  The following macros handle noreturn attributes according to the
+  C11/C++11 standard with fallback to GNU, Clang or MSVC extensions if using
+  an older compiler.
+*/
+#undef MODELICA_NORETURN
+#undef MODELICA_NORETURNATTR
+#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
+#define MODELICA_NORETURN _Noreturn
+#define MODELICA_NORETURNATTR
+#elif defined(__cplusplus) && __cplusplus >= 201103L
+#if (defined(__GNUC__) && __GNUC__ >= 5) || \
+    (defined(__GNUC__) && defined(__GNUC_MINOR__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 8)
+#define MODELICA_NORETURN [[noreturn]]
+#define MODELICA_NORETURNATTR
+#elif (defined(__GNUC__) && __GNUC__ >= 3) || \
+      (defined(__GNUC__) && defined(__GNUC_MINOR__) && __GNUC__ == 2 && __GNUC_MINOR__ >= 8)
+#define MODELICA_NORETURN
+#define MODELICA_NORETURNATTR __attribute__((noreturn))
+#elif defined(__GNUC__)
+#define MODELICA_NORETURN
+#define MODELICA_NORETURNATTR
+#else
+#define MODELICA_NORETURN [[noreturn]]
+#define MODELICA_NORETURNATTR
+#endif
+#elif defined(__clang__)
+/* Encapsulated for Clang since GCC fails to process __has_attribute */
+#if __has_attribute(noreturn)
+#define MODELICA_NORETURN
+#define MODELICA_NORETURNATTR __attribute__((noreturn))
+#else
+#define MODELICA_NORETURN
+#define MODELICA_NORETURNATTR
+#endif
+#elif (defined(__GNUC__) && __GNUC__ >= 3) || \
+      (defined(__GNUC__) && defined(__GNUC_MINOR__) && __GNUC__ == 2 && __GNUC_MINOR__ >= 8) || \
+      (defined(__SUNPRO_C) && __SUNPRO_C >= 0x5110)
+#define MODELICA_NORETURN
+#define MODELICA_NORETURNATTR __attribute__((noreturn))
+#elif (defined(_MSC_VER) && _MSC_VER >= 1200) || \
+       defined(__BORLANDC__)
+#define MODELICA_NORETURN __declspec(noreturn)
+#define MODELICA_NORETURNATTR
+#else
+#define MODELICA_NORETURN
+#define MODELICA_NORETURNATTR
+#endif
+
+/*
+  The following macros handle format attributes for type-checks against a
+  format string.
+*/
+
+#if defined(__clang__)
+/* Encapsulated for Clang since GCC fails to process __has_attribute */
+#if __has_attribute(format)
+#define MODELICA_FORMATATTR_PRINTF __attribute__((format(printf, 1, 2)))
+#define MODELICA_FORMATATTR_VPRINTF __attribute__((format(printf, 1, 0)))
+#else
+#define MODELICA_FORMATATTR_PRINTF
+#define MODELICA_FORMATATTR_VPRINTF
+#endif
+#elif defined(__GNUC__) && __GNUC__ >= 3
+#define MODELICA_FORMATATTR_PRINTF __attribute__((format(printf, 1, 2)))
+#define MODELICA_FORMATATTR_VPRINTF __attribute__((format(printf, 1, 0)))
+#else
+#define MODELICA_FORMATATTR_PRINTF
+#define MODELICA_FORMATATTR_VPRINTF
+#endif
+
+void ModelicaMessage(const char *string);
+/*
+Output the message string (no format control).
+*/
+
+void ModelicaFormatMessage(const char *format, ...) MODELICA_FORMATATTR_PRINTF;
+/*
+Output the message under the same format control as the C-function printf.
+*/
+
+void ModelicaVFormatMessage(const char *format, va_list args) MODELICA_FORMATATTR_VPRINTF;
+/*
+Output the message under the same format control as the C-function vprintf.
+*/
+
+MODELICA_NORETURN void ModelicaError(const char *string) MODELICA_NORETURNATTR;
+/*
+Output the error message string (no format control). This function
+never returns to the calling function, but handles the error
+similarly to an assert in the Modelica code.
+*/
+
+void ModelicaWarning(const char *string);
+/*
+Output the warning message string (no format control).
+*/
+
+void ModelicaFormatWarning(const char *format, ...) MODELICA_FORMATATTR_PRINTF;
+/*
+Output the warning message under the same format control as the C-function printf.
+*/
+
+void ModelicaVFormatWarning(const char *format, va_list args) MODELICA_FORMATATTR_VPRINTF;
+/*
+Output the warning message under the same format control as the C-function vprintf.
+*/
+
+MODELICA_NORETURN void ModelicaFormatError(const char *format, ...) MODELICA_NORETURNATTR MODELICA_FORMATATTR_PRINTF;
+/*
+Output the error message under the same format control as the C-function
+printf. This function never returns to the calling function,
+but handles the error similarly to an assert in the Modelica code.
+*/
+
+MODELICA_NORETURN void ModelicaVFormatError(const char *format, va_list args) MODELICA_NORETURNATTR MODELICA_FORMATATTR_VPRINTF;
+/*
+Output the error message under the same format control as the C-function
+vprintf. This function never returns to the calling function,
+but handles the error similarly to an assert in the Modelica code.
+*/
+
+char* ModelicaAllocateString(size_t len);
+/*
+Allocate memory for a Modelica string which is used as return
+argument of an external Modelica function. Note, that the storage
+for string arrays (= pointer to string array) is still provided by the
+calling program, as for any other array. If an error occurs, this
+function does not return, but calls "ModelicaError".
+*/
+
+char* ModelicaAllocateStringWithErrorReturn(size_t len);
+/*
+Same as ModelicaAllocateString, except that in case of error, the
+function returns 0. This allows the external function to close files
+and free other open resources in case of error. After cleaning up
+resources use ModelicaError or ModelicaFormatError to signal
+the error.
+*/
+
+char* ModelicaDuplicateString(const char* str);
+/*
+Duplicate (= allocate memory and deep copy) a Modelica string which
+is used as return argument of an external Modelica function. Note,
+that the storage for string arrays (= pointer to string array) is still
+provided by the calling program, as for any other array. If an error
+occurs, this function does not return, but calls "ModelicaError".
+*/
+
+char* ModelicaDuplicateStringWithErrorReturn(const char* str);
+/*
+Same as ModelicaDuplicateString, except that in case of error, the
+function returns 0. This allows the external function to close files
+and free other open resources in case of error. After cleaning up
+resources use, ModelicaError or ModelicaFormatError to signal
+the error.
+*/
+
+#undef MODELICA_NORETURN
+#undef MODELICA_NORETURNATTR
+#undef MODELICA_FORMATATTR_PRINTF
+#undef MODELICA_FORMATATTR_VPRINTF
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif

.CI/checkHTMLDoc/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-

.CI/checkHTMLDoc/checkLinks.py

@@ -0,0 +1,95 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+'''
+Copyright (C) 2020, Modelica Association and contributors
+All rights reserved.
+
+Check Modelica HTML documentation for link validity
+'''
+
+import re
+import os
+try:
+    import urllib2
+except ImportError:
+    import urllib.request as urllib2
+import ssl
+
+from concurrent.futures import ProcessPoolExecutor as PoolExecutor
+
+# See https://haacked.com/archive/2004/10/25/usingregularexpressionstomatchhtml.aspx/
+PATTERN = re.compile(r'</?\w+((\s+\w+(\s*=\s*(?:\\"(.|\n)*?\\"|\'(.|\n)*?\'|[^\'">\s]+))?)+\s*|\s*)/?>',
+    re.IGNORECASE)
+
+def _getFileURLs(file_name):
+    urls = []
+    with open(file_name) as file:
+        i = 1
+        for line in file:
+            for match in PATTERN.finditer(line):
+                tag = match.group(0)
+                tag = tag.strip('< >')
+                if tag.split(' ')[0].lower() != 'a':
+                    continue
+                url = re.search(r'(?<=href=\\")http.*?(?=\\")', tag)
+                if url is None:
+                    continue
+                url = url.group(0)
+                if url in urls:
+                    continue
+                urls.append(url)
+            i = i + 1
+    return {file_name: urls}
+
+def _getURLs(path):
+    urls = {}
+    for subdir, _, files in os.walk(path):
+        for file in files:
+            if os.path.splitext(file)[1] == '.mo':
+                file_name = os.path.join(subdir, file)
+                urls.update(_getFileURLs(file_name))
+    return urls
+
+def _checkURL(url):
+    try:
+        rc = urllib2.urlopen(url).getcode()
+        return (url, rc)
+    except:
+        pass
+    try:
+        headers = {'User-Agent': 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)'}
+        rc = urllib2.urlopen(urllib2.Request(url, None, headers), context=ssl._create_unverified_context()).getcode()
+    except urllib2.HTTPError as e:
+        rc = e.code
+        if rc == 429:
+            # Ignore too many requests
+            rc = 200
+        elif rc in (301, 302):
+            # Handle redirect errors
+            rc = urllib2.build_opener(urllib2.HTTPCookieProcessor).open(url).code
+    except:
+        rc = 0
+    return (url, rc)
+
+def checkLinks(path):
+    if os.path.isdir(path):
+        urls = _getURLs(path)
+    elif os.path.isfile(path):
+        urls = _getFileURLs(path)
+    else:
+        return 1
+
+    all_urls = set()
+    for url_list in urls.values():
+        all_urls.update(url_list)
+
+    errors = 0
+    with PoolExecutor(max_workers=8) as executor:
+        for url, rc in executor.map(_checkURL, all_urls):
+            if rc != 200:
+                errors = errors + 1
+                # Only get first match for file name
+                file_name = next(file_name for file_name, url_list in urls.items() if url in url_list)
+                print('File "{0}": Error {1}for URL "{2}"'.format(file_name, '' if rc == 0 else str(rc) + ' ', url))
+    return errors