From 8fceb4f0fd36bad99def97e770edeeb0487ab40e Mon Sep 17 00:00:00 2001
From: Thomas Beutlich <modelica@tbeu.de>
Date: Mon, 21 Oct 2024 21:15:57 +0200
Subject: [PATCH] refs #4484: Restore ModelicaUtilities.h

Revert "refs #3867: Remove LICENSE_ModelicaUtilities.txt"

This reverts commit 7fe506f5217f69f03ba8336e5ed446a522f044c4.

Revert "refs #3867: Remove ModelicaUtilities.h"

This reverts commit 1bb1d40d50ee1547d0c052babb6f099bb87f0362.
---
 .CI/Jenkinsfile                               |  6 ++---
 .CI/Test/Common.c                             |  2 +-
 .github/workflows/checkCI.yml                 |  2 +-
 .../VisualStudio2005/ModelicaIO.vcproj        | 16 ++++++-----
 .../VisualStudio2005/ModelicaMatIO.vcproj     | 12 ++++++---
 .../ModelicaStandardTables.vcproj             | 12 ++++++---
 Modelica/Resources/BuildProjects/readme.txt   |  8 ++----
 .../Resources/C-Sources}/ModelicaUtilities.h  |  0
 .../Licenses/LICENSE_ModelicaUtilities.txt    | 27 +++++++++++++++++++
 Modelica/Utilities/Streams.mo                 |  2 +-
 10 files changed, 60 insertions(+), 27 deletions(-)
 rename {.CI/Test => Modelica/Resources/C-Sources}/ModelicaUtilities.h (100%)
 create mode 100644 Modelica/Resources/Licenses/LICENSE_ModelicaUtilities.txt

diff --git a/.CI/Jenkinsfile b/.CI/Jenkinsfile
index 4018c1f6ee..ca8170359e 100644
--- a/.CI/Jenkinsfile
+++ b/.CI/Jenkinsfile
@@ -197,14 +197,14 @@ def allAutotools() {
 def autotools(CC, CPPFLAGS, config, nostatic, dotest) {
   sh label: "Build $CC $CPPFLAGS", script: """
   export CC=$CC
-  export CPPFLAGS="$CPPFLAGS -I${WORKSPACE}/.CI/Test"
+  export CPPFLAGS=$CPPFLAGS
   export CFLAGS="-Os -fPIC"
   rm -rf Modelica/Resources/Library/*
   mkdir -p Modelica/Resources/Library/\$LIBDIR
   cd Modelica/Resources/BuildProjects/autotools
   git clean -fdx .
   ./autogen.sh
-  ./configure --libdir="${WORKSPACE}/Modelica/Resources/Library/\$LIBDIR" $config
+  ./configure --libdir="\$PWD/../../Library/\$LIBDIR" $config
   make --output-sync -j${numPhysicalCPU()}
   make install
   """
@@ -223,7 +223,7 @@ def makefile(CC, dotest) {
   rm -rf Modelica/Resources/Library/*
   mkdir -p "Modelica/Resources/Library/$LIBDIR"
   cd Modelica/Resources/BuildProjects/gcc
-  make --output-sync -j${numPhysicalCPU()} TARGETDIR="$LIBDIR" CPPFLAGS="-I${WORKSPACE}/.CI/Test"
+  make --output-sync -j${numPhysicalCPU()} TARGETDIR="$LIBDIR"
   """
   sh label: "Test $CC", script: """
   export CC=$CC
diff --git a/.CI/Test/Common.c b/.CI/Test/Common.c
index e5b6600f82..6454689ed9 100644
--- a/.CI/Test/Common.c
+++ b/.CI/Test/Common.c
@@ -1,4 +1,4 @@
-#include "ModelicaUtilities.h"
+#include "../../Modelica/Resources/C-Sources/ModelicaUtilities.h"
 #include <assert.h>
 #include <stdlib.h>
 #include <stdio.h>
diff --git a/.github/workflows/checkCI.yml b/.github/workflows/checkCI.yml
index bca5cc58b4..55dfefdddb 100644
--- a/.github/workflows/checkCI.yml
+++ b/.github/workflows/checkCI.yml
@@ -17,7 +17,7 @@ jobs:
           pushd Modelica/Resources/BuildProjects/autotools
           git clean -fdx .
           ./autogen.sh
-          ./configure --libdir="$PWD/../../Library/$LIBDIR" --enable-static --disable-shared --enable-static-zlib --disable-hdf5 CPPFLAGS="-I${GITHUB_WORKSPACE}/.CI/Test"
+          ./configure --libdir="$PWD/../../Library/$LIBDIR" --enable-static --disable-shared --enable-static-zlib --disable-hdf5
           make --output-sync
           sudo make install
           popd
diff --git a/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaIO.vcproj b/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaIO.vcproj
index 2cd3e4eedb..b6e0a79592 100644
--- a/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaIO.vcproj
+++ b/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaIO.vcproj
@@ -43,7 +43,7 @@
 			<Tool
 				Name="VCCLCompilerTool"
 				Optimization="0"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;MODELICAIO_EXPORTS"
 				MinimalRebuild="true"
 				BasicRuntimeChecks="3"
@@ -106,7 +106,7 @@
 			<Tool
 				Name="VCCLCompilerTool"
 				Optimization="0"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;MODELICAIO_EXPORTS"
 				MinimalRebuild="true"
 				BasicRuntimeChecks="3"
@@ -168,7 +168,7 @@
 			/>
 			<Tool
 				Name="VCCLCompilerTool"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;MODELICAIO_EXPORTS;_CRT_SECURE_NO_WARNINGS"
 				RuntimeLibrary="0"
 				ProgramDataBaseFileName="$(IntDir)\$(ProjectName).pdb"
@@ -228,7 +228,7 @@
 			/>
 			<Tool
 				Name="VCCLCompilerTool"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;MODELICAIO_EXPORTS;_CRT_SECURE_NO_WARNINGS"
 				RuntimeLibrary="0"
 				ProgramDataBaseFileName="$(IntDir)\$(ProjectName).pdb"
@@ -281,12 +281,16 @@
 			Filter="h;hpp;hxx;hm;inl;inc;xsd"
 			UniqueIdentifier="{93995380-89BD-4b04-88EB-625FBE52EBFB}"
 			>
+			<File
+				RelativePath="..\..\C-Sources\ModelicaMatIO.h"
+				>
+			</File>
 			<File
 				RelativePath="..\..\C-Sources\ModelicaIO.h"
 				>
 			</File>
 			<File
-				RelativePath="..\..\C-Sources\ModelicaMatIO.h"
+				RelativePath="..\..\C-Sources\ModelicaUtilities.h"
 				>
 			</File>
 		</Filter>
@@ -297,6 +301,4 @@
 			>
 		</Filter>
 	</Files>
-	<Globals>
-	</Globals>
 </VisualStudioProject>
diff --git a/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaMatIO.vcproj b/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaMatIO.vcproj
index 8c02967f5a..0e08ee6da4 100644
--- a/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaMatIO.vcproj
+++ b/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaMatIO.vcproj
@@ -43,7 +43,7 @@
 			<Tool
 				Name="VCCLCompilerTool"
 				Optimization="0"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;;&quot;..\..\C-Sources\zlib\&quot;"
+				AdditionalIncludeDirectories="..\..\C-Sources\zlib\"
 				PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;MODELICAMATIO_EXPORTS;PSNIP_SAFE_FORCE_PORTABLE;HAVE_ZLIB=1"
 				MinimalRebuild="true"
 				BasicRuntimeChecks="3"
@@ -106,7 +106,7 @@
 			<Tool
 				Name="VCCLCompilerTool"
 				Optimization="0"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;;&quot;..\..\C-Sources\zlib\&quot;"
+				AdditionalIncludeDirectories="..\..\C-Sources\zlib\"
 				PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;MODELICAMATIO_EXPORTS;PSNIP_SAFE_FORCE_PORTABLE;HAVE_ZLIB=1"
 				MinimalRebuild="true"
 				BasicRuntimeChecks="3"
@@ -168,7 +168,7 @@
 			/>
 			<Tool
 				Name="VCCLCompilerTool"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;;&quot;..\..\C-Sources\zlib\&quot;"
+				AdditionalIncludeDirectories="..\..\C-Sources\zlib\"
 				PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;MODELICAMATIO_EXPORTS;PSNIP_SAFE_FORCE_PORTABLE;_CRT_SECURE_NO_WARNINGS;HAVE_ZLIB=1"
 				RuntimeLibrary="0"
 				ProgramDataBaseFileName="$(IntDir)\$(ProjectName).pdb"
@@ -228,7 +228,7 @@
 			/>
 			<Tool
 				Name="VCCLCompilerTool"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;;&quot;..\..\C-Sources\zlib\&quot;"
+				AdditionalIncludeDirectories="..\..\C-Sources\zlib\"
 				PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;MODELICAMATIO_EXPORTS;PSNIP_SAFE_FORCE_PORTABLE;_CRT_SECURE_NO_WARNINGS;HAVE_ZLIB=1"
 				RuntimeLibrary="0"
 				ProgramDataBaseFileName="$(IntDir)\$(ProjectName).pdb"
@@ -289,6 +289,10 @@
 				RelativePath="..\..\C-Sources\ModelicaMatIO.h"
 				>
 			</File>
+			<File
+				RelativePath="..\..\C-Sources\ModelicaUtilities.h"
+				>
+			</File>
 		</Filter>
 		<Filter
 			Name="Resource Files"
diff --git a/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaStandardTables.vcproj b/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaStandardTables.vcproj
index 9a0a6e2161..bc3b0d00cc 100644
--- a/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaStandardTables.vcproj
+++ b/Modelica/Resources/BuildProjects/VisualStudio2005/ModelicaStandardTables.vcproj
@@ -43,7 +43,7 @@
 			<Tool
 				Name="VCCLCompilerTool"
 				Optimization="0"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;MODELICASTANDARDTABLES_EXPORTS;DEBUG_TIME_EVENTS;TABLE_SHARE"
 				MinimalRebuild="true"
 				BasicRuntimeChecks="3"
@@ -106,7 +106,7 @@
 			<Tool
 				Name="VCCLCompilerTool"
 				Optimization="0"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;MODELICASTANDARDTABLES_EXPORTS;DEBUG_TIME_EVENTS;TABLE_SHARE"
 				MinimalRebuild="true"
 				BasicRuntimeChecks="3"
@@ -168,7 +168,7 @@
 			/>
 			<Tool
 				Name="VCCLCompilerTool"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;MODELICASTANDARDTABLES_EXPORTS;_CRT_SECURE_NO_WARNINGS;TABLE_SHARE"
 				RuntimeLibrary="0"
 				ProgramDataBaseFileName="$(IntDir)\$(ProjectName).pdb"
@@ -228,7 +228,7 @@
 			/>
 			<Tool
 				Name="VCCLCompilerTool"
-				AdditionalIncludeDirectories="&quot;$(MODELICA_UTILITIES_INCLUDE)&quot;"
+				AdditionalIncludeDirectories=""
 				PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;MODELICASTANDARDTABLES_EXPORTS;_CRT_SECURE_NO_WARNINGS;TABLE_SHARE"
 				RuntimeLibrary="0"
 				ProgramDataBaseFileName="$(IntDir)\$(ProjectName).pdb"
@@ -293,6 +293,10 @@
 				RelativePath="..\..\C-Sources\ModelicaStandardTables.h"
 				>
 			</File>
+			<File
+				RelativePath="..\..\C-Sources\ModelicaUtilities.h"
+				>
+			</File>
 		</Filter>
 		<Filter
 			Name="Resource Files"
diff --git a/Modelica/Resources/BuildProjects/readme.txt b/Modelica/Resources/BuildProjects/readme.txt
index 013c942a31..62c3aad975 100644
--- a/Modelica/Resources/BuildProjects/readme.txt
+++ b/Modelica/Resources/BuildProjects/readme.txt
@@ -22,11 +22,7 @@ from the C-code under ../C-Sources
 The intention is that interested tool vendors can build these libraries
 by using the provided build projects as a start.
 
-The tool vendors are responsible for building the binary libraries
+Note, the tool vendors are responsible for building the binary libraries
 and including them in their tools.
 
-When building the binary libraries by VisualStudio2005 the environment
-variable MODELICA_UTILITIES_INCLUDE needs to be set to the path of the
-(tool-vendor-specific) ModelicaUtilities.h header file.
-
-September 24, 2021
+May 17, 2018
diff --git a/.CI/Test/ModelicaUtilities.h b/Modelica/Resources/C-Sources/ModelicaUtilities.h
similarity index 100%
rename from .CI/Test/ModelicaUtilities.h
rename to Modelica/Resources/C-Sources/ModelicaUtilities.h
diff --git a/Modelica/Resources/Licenses/LICENSE_ModelicaUtilities.txt b/Modelica/Resources/Licenses/LICENSE_ModelicaUtilities.txt
new file mode 100644
index 0000000000..78dd979593
--- /dev/null
+++ b/Modelica/Resources/Licenses/LICENSE_ModelicaUtilities.txt
@@ -0,0 +1,27 @@
+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.
diff --git a/Modelica/Utilities/Streams.mo b/Modelica/Utilities/Streams.mo
index ceed866f44..b19600e407 100644
--- a/Modelica/Utilities/Streams.mo
+++ b/Modelica/Utilities/Streams.mo
@@ -120,7 +120,7 @@ separated by LF or CR-LF.
   pure function error "Print error message and cancel all actions - in case of an unrecoverable error"
     extends Modelica.Icons.Function;
     input String string "String to be printed to error message window";
-    external "C" ModelicaError(string) annotation(Include="#include \"ModelicaUtilities.h\"", Library="ModelicaExternalC");
+    external "C" ModelicaError(string) annotation(IncludeDirectory="modelica://Modelica/Resources/C-Sources", Include="#include \"ModelicaUtilities.h\"", Library="ModelicaExternalC");
     annotation (Documentation(info="<html>
 <h4>Syntax</h4>
 <blockquote><pre>