Merge branch 'develop'

# Conflicts:
#	test/Catch2

conflict resolution: manually update Catch2 submodule to tag v3.5.0
(same as in develop branch).

Author: herzbube

.github/workflows/build.yml

@@ -14,7 +14,6 @@ jobs:
     # - We use the *-latest runners because we strive to build with relatively
     #   new versions of each environment that have modern compilers (we need at
     #   least C++17, see CMakeLists.txt) and tools.
-    # - As of writing this all of the *-latest runners use CMake 3.19.1.
     # - The library should not only be cross-platform, it should also not rely
     #   on any particular compiler. On macOS the clang compiler is used
     #   (AppleClang), on Ubuntu the default is GNU GCC, and on Windows it's
@@ -26,7 +25,10 @@ jobs:
 
     steps:
     - name: Checking out the sources
-      uses: actions/checkout@v2
+      # @v4 refers to the Git tag "v4" in https://github.com/actions/checkout.
+      # The repo maintainers update the "v4" tag to always point to the latest
+      # v4 release of the checkout action.
+      uses: actions/checkout@v4
       with:
         submodules: recursive
 
@@ -40,19 +42,11 @@ jobs:
         cmake -DCMAKE_BUILD_TYPE=Release ..
       if: matrix.os == 'macos-latest' || matrix.os == 'ubuntu-latest'
 
-    - name: Generat build system (Windows)
+    - name: Generate build system (Windows)
       run: |
         mkdir build
         cd build
-        # Setting CMAKE_SYSTEM_VERSION defines the Windows SDK that CMake should
-        # use for the build. We have to do this in order to override the
-        # Windows SDK that CMake would select on its own. The default Windows SDK
-        # on the windows-latest runner is currently 10.0.17763.0, and for unknown
-        # reasons that SDK version breaks the build. The symptoms are many C5105
-        # warnings, and eventually also some compiler errors. Windows SDK
-        # 10.0.18362.0 is a version that is known to work and that is also known
-        # to be installed on the windows-latest runner.
-        cmake -DCMAKE_SYSTEM_VERSION="10.0.18362.0" ..
+        cmake ..
       if: matrix.os == 'windows-latest'
 
     - name: Build the project

CMakeLists.txt

@@ -21,7 +21,7 @@ project (
   # The project version.
   # Sets PROJECT_VERSION, PROJECT_VERSION_MAJOR, PROJECT_VERSION_MINOR,
   # PROJECT_VERSION_PATCH and PROJECT_VERSION_TWEAK.
-  VERSION 1.0
+  VERSION 2.0.0
 
   # Some informational package metadata. Not necessary for the build.
   # Sets PROJECT_HOMEPAGE_URL and PROJECT_DESCRIPTION

NOTICE

@@ -1,5 +1,5 @@
 libsgfc++
-Copyright 2020-2021 Patrick Näf ([email protected])
+Copyright 2020-2024 Patrick Näf ([email protected])
 
 This product uses the source code provided by the SGFC command line utility to
 read, parse and write SGF data. SGFC was developed by Arno Hollosi

doc/Build.md

@@ -1,5 +1,40 @@
 # ChangeLog
 
+## Version 2.0.0 (January 3 2024)
+
+### Features
+
+- None
+
+### Bugfixes
+
+- Fixed numeric value of `SgfcMessageID::IllegalVariationStartCorrected` (#39). The enum value had the same numeric value as `SgfcMessageID::IllegalVariationStartIgnored`.
+- Changed the value type for referencing line and column numbers in messages to `unsigned long`, to match the error reporting interface of SGFC (#40). The old type `int` was insufficient to hold all possible `unsigned long` values, also the there was a signed/unsigned mismatch. The change affects the `ISgfcMessage` getters `GetLineNumber()` and `GetColumnNumber()`, as well as the constants `SgfcConstants::InvalidLineNumber` and `SgfcConstants::InvalidColumnNumber`. The constants also changed their value (previously -1, now 0).
+
+### Regressions
+
+- None
+
+### Technical changes
+
+- Replaced internal custom code to determine the path to a temporary folder with `std::filesystem::temp_directory_path()` (#18).
+- Updated unit test library Catch2 from v2.13.4 to v3.5.0.
+- Updated the [Cross-compiling for iOS](Build.md#cross-compiling-for-ios) documentation for modern CMake/Xcode versions.
+- Updated the GitHub build pipelines.
+
+### GitHub issue list
+
+A list of all issues closed for this release is available [on GitHub](https://github.com/herzbube/libsgfcplusplus/milestone/4?closed=1)
+
+
+## Version 1.0 (February 23 2021)
+
+Initial 1.0 release that includes SGFC v2.0.
+
+## Version 0.2 (beta) (January 12 2021)
+
+Release of version 0.2 (beta).
+
 ## Version 0.1 (alpha) (October 11 2020)
 
 Release of version 0.1 (alpha).

doc/ChangeLog.md

@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------------
-// Copyright 2020 Patrick Näf ([email protected])
+// Copyright 2024 Patrick Näf ([email protected])
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -76,13 +76,13 @@ namespace LibSgfcPlusPlus
     /// that caused the message. Returns SgfcConstants::InvalidLineNumber if
     /// the message does not refer to a specific line in the SGF data (most
     /// fatal errors, but also some errors and warnings).
-    virtual int GetLineNumber() const = 0;
+    virtual unsigned long GetLineNumber() const = 0;
 
     /// @brief Returns the number of the column (1-based) in the parsed SGF data
     /// that caused the message. Returns SgfcConstants::InvalidColumnNumber if
     /// the message does not refer to a specific column in the SGF data (most
     /// fatal errors, but also some errors and warnings).
-    virtual int GetColumnNumber() const = 0;
+    virtual unsigned long GetColumnNumber() const = 0;
 
     /// @brief Returns true if the message describes a critical problem. Only
     /// warning and error messages can be critical. Always returns false for

include/ISgfcMessage.h

@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------------
-// Copyright 2020 Patrick Näf ([email protected])
+// Copyright 2024 Patrick Näf ([email protected])
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -58,10 +58,10 @@ namespace LibSgfcPlusPlus
     //@{
     /// @brief Indicates an invalid line number. This is used for messages
     /// that do not refer to a specific line number in a piece of SGF content.
-    static const int InvalidLineNumber;
+    static const unsigned long InvalidLineNumber;
     /// @brief Indicates an invalid column number. This is used for messages
     /// that do not refer to a specific column number in a piece of SGF content.
-    static const int InvalidColumnNumber;
+    static const unsigned long InvalidColumnNumber;
     /// @brief A library error number (= errno value) indicating "no error".
     /// This is defined to be the value 0 (zero).
     static const int LibraryErrorNumberNoError;

include/SgfcConstants.h

@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------------
-// Copyright 2020 Patrick Näf ([email protected])
+// Copyright 2024 Patrick Näf ([email protected])
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -276,7 +276,7 @@ namespace LibSgfcPlusPlus
     /// @brief SGFC found (and fixed) a node that was not in any variation.
     NodeNotInVariation = 66,
     /// @brief SGFC found (and corrected) an illegal variation start.
-    IllegalVariationStartCorrected = 21,
+    IllegalVariationStartCorrected = 67,
     /// @brief SGFC was invoked with an argument that is not a supported long
     /// command line option.
     ///

include/SgfcMessageID.h

@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------------
-// Copyright 2020 Patrick Näf ([email protected])
+// Copyright 2024 Patrick Näf ([email protected])
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -24,11 +24,13 @@
 namespace LibSgfcPlusPlus
 {
   const std::string SgfcConstants::LibraryName = "libsgfc++";
-  const std::string SgfcConstants::LibraryVersion = "1.0";
+  const std::string SgfcConstants::LibraryVersion = "2.0.0";
   const std::string SgfcConstants::SgfcVersion = "2.0";
 
-  const int SgfcConstants::InvalidLineNumber = -1;
-  const int SgfcConstants::InvalidColumnNumber = -1;
+  // SgfcMessage line and column numbers are 1-based, so value 0 (zero) can be
+  // used as indicator for an invalid line or column number.
+  const unsigned long SgfcConstants::InvalidLineNumber = 0;
+  const unsigned long SgfcConstants::InvalidColumnNumber = 0;
 
   const int SgfcConstants::LibraryErrorNumberNoError = 0;
 

src/SgfcConstants.cpp

@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------------
-// Copyright 2020 Patrick Näf ([email protected])
+// Copyright 2024 Patrick Näf ([email protected])
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,18 +21,17 @@
 
 // C++ Standard Library includes
 #include <cstdio>       // for remove()
+#include <filesystem>   // for std::filesystem::temp_directory_path()
 #include <fstream>      // for std::ofstream and std::ifstream
 #include <random>
 #include <sstream>
 #include <stdexcept>
 
 // System includes
 #ifdef _MSC_VER
-  #include <Windows.h>  // for GetTempPath()
   #include <io.h>       // for _access_s()
   #include <process.h>  // for _getpid()
 #else
-  #include <cstdlib>    // for std::getenv()
   #include <unistd.h>   // for access() and getpid()
 #endif
 
@@ -190,53 +189,8 @@ namespace LibSgfcPlusPlus
 
   std::string SgfcUtility::GetTempFolderPath()
   {
-    std::string tempFolderPath;
-
-#ifdef _MSC_VER
-
-    DWORD bufferLength = MAX_PATH + 1;
-    char* buffer = new char[bufferLength];
-
-    // The Win32 API works with TCHAR, but since everything else in libsgfc++
-    // does not work with wchar or wstring we don't bother here and just use
-    // char and string.
-
-    DWORD getTempPathResult = GetTempPath(bufferLength, buffer);
-    if (getTempPathResult == 0 || getTempPathResult > bufferLength)
-    {
-      delete[] buffer;
-      throw std::runtime_error("Win32 API function GetTempPath() failed");
-    }
-
-    tempFolderPath = buffer;
-    delete[] buffer;
-
-#else
-
-    // Environment variable names taken from
-    // https://en.cppreference.com/w/cpp/filesystem/temp_directory_path
-    static std::vector<std::string> environmentVariableNames = { "TMPDIR", "TMP", "TEMP", "TEMPDIR" };
-
-    tempFolderPath = "/tmp";
-
-    for ( const auto& environmentVariableName : environmentVariableNames )
-    {
-      const char* environmentVariableValue = std::getenv(environmentVariableName.c_str());
-      if (environmentVariableValue != nullptr)
-      {
-        tempFolderPath = environmentVariableValue;
-        break;
-      }
-    }
-
-#endif
-
-    // On all platforms we have no guarantee that the folder actually exists.
-    // This works purely by convention. Because we intend to replace all this
-    // cruft with std::filesystem::temp_directory_path() anyway sooner or later,
-    // this implementation is good enough.
-
-    return tempFolderPath;
+    std::filesystem::path tempFolderPath = std::filesystem::temp_directory_path();
+    return tempFolderPath.u8string();
   }
 
   std::string SgfcUtility::GetUniqueTempFileName()