Merge pull request #1 from SvenGroot/v2.0.2-dev

Merge v2.0.2 into main

Author: SvenGroot

.github/workflows/cmake.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Install Package
       # You may pin to the exact commit or the version.

CMakeLists.txt

@@ -4,7 +4,7 @@ include(CMakePackageConfigHelpers)
 
 project (
     "Ookii.CommandLine.Cpp"
-    VERSION 2.0.0
+    VERSION 2.0.2
     HOMEPAGE_URL "https://github.com/SvenGroot/Ookii.CommandLine.Cpp"
     LANGUAGES CXX)
 

docs/ChangeLog.md

@@ -1,12 +1,19 @@
 # What's new in Ookii.CommandLine for C++
 
-## Ookii.CommandLine for C++ 2.0.1
+## Ookii.CommandLine for C++ 2.0.2 (2025-05-13)
+
+- Fix compilation errors affecting the unit tests with recent versions of Visual Studio 2022.
+  - There is a small chance this could affect your code if you were using certain helper functions
+    defined in the `format_helper.h` header directly (they are otherwise not used outside the unit
+    tests).
+
+## Ookii.CommandLine for C++ 2.0.1 (2023-10-11)
 
 - Fix the description of the NuGet package.
 - This release is NuGet-only and does not contain any other changes. The project version number has
   not changed; only the NuGet package version.
 
-## Ookii.CommandLine for C++ 2.0
+## Ookii.CommandLine for C++ 2.0 (2023-01-12)
 
 - Argument parsing
   - Added support for a [new parsing mode](Arguments.md#longshort-mode) where arguments can have a
@@ -33,7 +40,8 @@
     list ordering and filtering, the ability to override any string or format, and more.
   - Arguments that have no description but that have other information not shown in the usage syntax
     (like aliases or a default value) will be included in the description list by default.
-- [`line_wrapping_ostream`][] has an option to flush all content, including the last unfinished line.
+- [`line_wrapping_ostream`][] has an option to flush all content, including the last unfinished
+  line.
 - Added [`line_wrapping_ostringstream`][] class.
 - [Code generation](Scripts.md) supports the new functionality.
 - Updated and improved documentation.
@@ -45,24 +53,26 @@ There are a number of breaking API changes from version 1.0:
 
 - The callback used by [`command_line_parser::on_parsed()`][] takes an [`std::optional<std::string_view>`][]
   for the value, instead of just [`std::string_view`][].
-- The [`command_line_parser::get_argument()`][command_line_parser::get_argument()_0] method returns `nullptr` instead of throwing an
-  exception for a non-existent argument.
+- The [`command_line_parser::get_argument()`][command_line_parser::get_argument()_0] method returns
+  `nullptr` instead of throwing an exception for a non-existent argument.
 - Default values for arguments are now displayed with stream insertion ([`operator<<`][]), so custom
   types must define that instead of a formatter.
-- The `for_each_argument_in_usage_order()` method has been removed; the [`arguments()`][] method returns
-  the arguments in that order.
+- The `for_each_argument_in_usage_order()` method has been removed; the [`arguments()`][] method
+  returns the arguments in that order.
 - The `<shell_command.h>` header was renamed to `<subcommand.h>`.
   - Recommended: include `<command_line.h>` instead; it now includes subcommands.
 - The `shell_command` class was renamed to [`command`][].
 - The `shell_command_manager` class was renamed to [`command_manager`][].
-- Several overloads of the [`create_command()`][create_command()_0] and [`run_command()`][run_command()_2] methods have been removed. This
-  was necessary to support commands with custom argument parsing.
-- The [`command_manager::run_command()`][command_manager::run_command()_1] method returns an [`std::optional<int>`][].
+- Several overloads of the [`create_command()`][create_command()_0] and
+  [`run_command()`][run_command()_2] methods have been removed. This was necessary to support
+  commands with custom argument parsing.
+- The [`command_manager::run_command()`][command_manager::run_command()_1] method returns an
+  [`std::optional<int>`][].
 - Several changes to the code generation scripts mean that any generated files must be regenerated.
-- The `OOKII_DECLARE_PARSE_METHOD()` macro has been replaced with the [`OOKII_GENERATED_METHODS()`][]
-  macro.
+- The `OOKII_DECLARE_PARSE_METHOD()` macro has been replaced with the
+  [`OOKII_GENERATED_METHODS()`][] macro.
 
-## Ookii.CommandLine for C++ 1.0
+## Ookii.CommandLine for C++ 1.0 (2022-10-23)
 
 - Initial release
 - Feature parity with [Ookii.CommandLine 2.4 for .Net](https://github.com/SvenGroot/Ookii.CommandLine),

docs/Tutorial.md

@@ -29,7 +29,7 @@ set(CMAKE_CXX_STANDARD 20)
 
 FetchContent_Declare(OOKIICL
     GIT_REPOSITORY "https://github.com/SvenGroot/Ookii.CommandLine.Cpp"
-    GIT_TAG "v2.0")
+    GIT_TAG "v2.0.2")
 
 FetchContent_MakeAvailable(OOKIICL)
 

include/ookii/format_helper.h

@@ -52,9 +52,9 @@ namespace ookii::format
     //! \param args The arguments
     //! \return The formatted string.
     template<typename... Args>
-    std::string ncformat(const std::locale &loc, std::string_view format, Args&&... args)
+    std::string ncformat(const std::locale &loc, std::string_view format, Args&... args)
     {
-        return OOKII_FMT_NS vformat(loc, format, OOKII_FMT_NS make_format_args(std::forward<Args>(args)...));
+        return OOKII_FMT_NS vformat(loc, format, OOKII_FMT_NS make_format_args(args...));
     }
 
     //! \brief Helper to format using a non-const format wide string without needing to explicitly
@@ -66,9 +66,9 @@ namespace ookii::format
     //! \param args The arguments
     //! \return The formatted string.
     template<typename... Args>
-    std::wstring ncformat(const std::locale &loc, std::wstring_view format, Args&&... args)
+    std::wstring ncformat(const std::locale &loc, std::wstring_view format, Args&... args)
     {
-        return OOKII_FMT_NS vformat(loc, format, OOKII_FMT_NS make_format_args<OOKII_FMT_NS wformat_context>(std::forward<Args>(args)...));
+        return OOKII_FMT_NS vformat(loc, format, OOKII_FMT_NS make_format_args<OOKII_FMT_NS wformat_context>(args...));
     }
 }
 

include/ookii/vt_helper.h

@@ -10,6 +10,7 @@
 #include "format_helper.h"
 #include <string_view>
 #include <locale>
+#include <cstring>
 
 //! \brief Namespace containing functions and types for working with virtual terminal sequences.
 namespace ookii::vt
@@ -307,7 +308,7 @@ namespace ookii::vt
 #endif
 
             // If "TERM=dumb" is set, assume no support.
-            if (has_term && strcmp(term, "dumb") == 0)
+            if (has_term && std::strcmp(term, "dumb") == 0)
             {
                 return {};
             }

nuget/package/Ookii.CommandLine.Cpp.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
   <metadata>
     <id>Ookii.CommandLine.Cpp</id>
-    <version>2.0.1</version>
+    <version>2.0.2</version>
     <title>Ookii.CommandLine for C++</title>
     <authors>Sven Groot</authors>
     <owners>Sven Groot</owners>

unittests/CommandLineParserTests.cpp

@@ -966,7 +966,8 @@ class CommandLineParserTests : public test::TestClass
     {
         if (expected_error != result.error)
         {
-            test::LogMessage(test::LogMessageType::Error, TEXT("{}"), result.get_error_message());
+            auto message = result.get_error_message();
+            test::LogMessage(test::LogMessageType::Error, TEXT("{}"), message);
         }
 
         VERIFY_EQUAL((int)expected_error, (int)result.error);

unittests/framework.h

@@ -52,7 +52,7 @@ namespace details
     // https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2508r1.html. The type is available
     // in libfmt.
     template<typename... Args>
-    void LogMessagePart(LogMessageType type, const std::basic_string_view<tchar_t> format, Args&&... args)
+    void LogMessagePart(LogMessageType type, const std::basic_string_view<tchar_t> format, Args&... args)
     {
         switch (type)
         {
@@ -81,16 +81,16 @@ namespace details
             break;
         }
 
-        tcout << format::ncformat({}, format, std::forward<Args>(args)...);
+        tcout << format::ncformat({}, format, args...);
     }
 
 }
 
 template<typename... Args>
-void LogMessage(LogMessageType type, const std::basic_string_view<tchar_t> format, Args&&... args)
+void LogMessage(LogMessageType type, const std::basic_string_view<tchar_t> format, Args&... args)
 {
     std::lock_guard<std::mutex> lock{details::g_logMutex};
-    details::LogMessagePart(type, format, std::forward<Args>(args)...);
+    details::LogMessagePart(type, format, args...);
     tcout << std::endl;
 }
 
@@ -246,7 +246,9 @@ class TestClass
         }
         catch (const std::exception &ex)
         {
-            LogMessage(LogMessageType::Error, TEXT("Unexpected exception of type {}: {}"), get_type_name<tchar_t>(typeid(ex)), string_convert<tchar_t>::from_bytes(ex.what()));
+            auto type = get_type_name<tchar_t>(typeid(ex));
+            auto what = string_convert<tchar_t>::from_bytes(ex.what());
+            LogMessage(LogMessageType::Error, TEXT("Unexpected exception of type {}: {}"), type, what);
         }
         catch (...)
         {
@@ -348,22 +350,26 @@ namespace details
 #define OOKII_TEST_THROW_FAILED_IF(condition) if (condition) { OOKII_TEST_THROW_FAILED(); }
 
     template<typename... Args>
-    void LogVerify(const VerifyInfo &info, bool success, std::basic_string_view<tchar_t> format, Args... args)
+    void LogVerify(const VerifyInfo &info, bool success, std::basic_string_view<tchar_t> format, Args&... args)
     {
         auto olderrno = errno;
         std::lock_guard<std::mutex> lock{g_logMutex};
         if (success)
         {
             if (g_verbose)
-                LogMessagePart(LogMessageType::Info, TEXT("{}:{}: Verify: "), string_convert<tchar_t>::from_bytes(info.FunctionName), info.Line);
+            {
+                auto functionName = string_convert<tchar_t>::from_bytes(info.FunctionName);
+                LogMessagePart(LogMessageType::Info, TEXT("{}:{}: Verify: "), functionName, info.Line);
+            }
         }
         else
         {
-            LogMessagePart(LogMessageType::Error, TEXT("{}:{}: Failed: "), string_convert<tchar_t>::from_bytes(info.FunctionName), info.Line);
+            auto functionName = string_convert<tchar_t>::from_bytes(info.FunctionName);
+            LogMessagePart(LogMessageType::Error, TEXT("{}:{}: Failed: "), functionName, info.Line);
         }
 
         if (!success || g_verbose)
-            tcout << format::ncformat({}, format, std::forward<Args>(args)...) << std::endl;
+            tcout << format::ncformat({}, format, args...) << std::endl;
 
         errno = olderrno;
     }
@@ -471,9 +477,11 @@ namespace details
         using std::begin;
         using std::end;
         using std::size;
-        if (size(expected) != size(actual))
+        auto expectedSize = size(expected);
+        auto actualSize = size(actual);
+        if (expectedSize != actualSize)
         {
-            LogVerify(info, false, TEXT("Range: {} == {} (size differs: {} != {})"), expectedName, actualName, size(expected), size(actual));
+            LogVerify(info, false, TEXT("Range: {} == {} (size differs: {} != {})"), expectedName, actualName, expectedSize, actualSize);
             OOKII_TEST_THROW_FAILED();
         }
 
@@ -482,14 +490,16 @@ namespace details
         {
             if (*item1 != *item2)
             {
+                const auto& item1Ref = *item1;
+                const auto& item2Ref = *item2;
                 LogVerify(info, false, TEXT("Range: {} == {} (items at index {} differ: <{}> != <{}>)"), expectedName, actualName,
-                          index, *item1, *item2);
+                          index, item1Ref, item2Ref);
 
                 OOKII_TEST_THROW_FAILED();
             }
         }
 
-        LogVerify(info, true, TEXT("Range: {} == {} (size {})"), expectedName, actualName, size(expected));
+        LogVerify(info, true, TEXT("Range: {} == {} (size {})"), expectedName, actualName, expectedSize);
     }
 
     inline void VerifyUnexpectedException(const tchar_t *operation, const VerifyInfo &info)
@@ -504,8 +514,9 @@ namespace details
         }
         catch (const std::exception &ex)
         {
-            LogVerify(info, false, TEXT("Operation {} threw unexpected exception {}: {}"), operation,
-                      get_type_name<tchar_t>(typeid(ex)), string_convert<tchar_t>::from_bytes(ex.what()));
+            auto what = string_convert<tchar_t>::from_bytes(ex.what());
+            auto type = get_type_name<tchar_t>(typeid(ex));
+            LogVerify(info, false, TEXT("Operation {} threw unexpected exception {}: {}"), operation, type, what);
         }
         catch (...)
         {

unittests/unittests.rc

@@ -55,8 +55,8 @@ END
 //
 
 VS_VERSION_INFO VERSIONINFO
- FILEVERSION 2,0,0,0
- PRODUCTVERSION 2,0,0,0
+ FILEVERSION 2,0,2,0
+ PRODUCTVERSION 2,0,2,0
  FILEFLAGSMASK 0x3fL
 #ifdef _DEBUG
  FILEFLAGS 0x1L
@@ -73,12 +73,12 @@ BEGIN
         BEGIN
             VALUE "CompanyName", "Sven Groot (Ookii.org)"
             VALUE "FileDescription", "Unit tests for Ookii.CommandLine for C++"
-            VALUE "FileVersion", "2.0.0.0"
+            VALUE "FileVersion", "2.0.2.0"
             VALUE "InternalName", "unittests.rc"
             VALUE "LegalCopyright", "Copyright (C) Sven Groot (Ookii.org)"
             VALUE "OriginalFilename", "unittests.rc"
             VALUE "ProductName", "Ookii.CommandLine for C++"
-            VALUE "ProductVersion", "2.0.0.0"
+            VALUE "ProductVersion", "2.0.2.0"
         END
     END
     BLOCK "VarFileInfo"