Move string utility functions to stringutil

CMakeLists.txt

@@ -95,6 +95,7 @@ set( HEADERS
      src/internal/stdinputitem.hpp
      src/internal/streamextractcallback.hpp
      src/internal/streamutil.hpp
+     src/internal/stringutil.hpp
      src/internal/updatecallback.hpp
      src/internal/util.hpp
      src/internal/windows.hpp )
@@ -156,8 +157,8 @@ set( SOURCES
      src/internal/renameditem.cpp
      src/internal/stdinputitem.cpp
      src/internal/streamextractcallback.cpp
+     src/internal/stringutil.cpp
      src/internal/updatecallback.cpp
-     src/internal/util.cpp
      src/internal/windows.cpp )
 
 # library output file name options

src/bit7zlibrary.cpp

@@ -13,8 +13,9 @@
 #include "bit7zlibrary.hpp"
 #include "bitexception.hpp"
 #include "bitformat.hpp"
+#include "internal/com.hpp"
 #include "internal/guids.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 #include <7zip/Archive/IArchive.h>
 

src/bitarchiveeditor.cpp

@@ -18,7 +18,7 @@
 #include "internal/fsitem.hpp"
 #include "internal/renameditem.hpp"
 #include "internal/stdinputitem.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 namespace bit7z {
 

src/bitarchiveitem.cpp

@@ -12,7 +12,7 @@
 
 #include "bitarchiveitem.hpp"
 #include "internal/fsutil.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 // For checking posix file attributes
 #include <sys/stat.h>

src/bitinputarchive.cpp

@@ -26,6 +26,7 @@
 #include "internal/fixedbufferextractcallback.hpp"
 #include "internal/streamextractcallback.hpp"
 #include "internal/opencallback.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 #ifdef BIT7Z_AUTO_FORMAT

src/bititemsvector.cpp

@@ -15,7 +15,7 @@
 #include "internal/bufferitem.hpp"
 #include "internal/fsindexer.hpp"
 #include "internal/stdinputitem.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 using namespace bit7z;
 using filesystem::FilesystemItem;

src/bitoutputarchive.cpp

@@ -16,8 +16,8 @@
 #include "internal/archiveproperties.hpp"
 #include "internal/cbufferoutstream.hpp"
 #include "internal/cmultivolumeoutstream.hpp"
-#include "internal/fsutil.hpp"
 #include "internal/genericinputitem.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/updatecallback.hpp"
 #include "internal/util.hpp"
 

src/bitpropvariant.cpp

@@ -14,11 +14,12 @@
 #include "biterror.hpp"
 #include "bitpropvariant.hpp"
 #include "internal/dateutil.hpp"
+#include "internal/windows.hpp"
 
 #if defined( BIT7Z_USE_NATIVE_STRING ) && defined( _WIN32 ) // Windows
 #define BSTR_TO_TSTRING( bstr ) std::wstring( bstr, ::SysStringLen( bstr ) )
 #else
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 #define BSTR_TO_TSTRING( bstr ) bit7z::narrow( bstr, SysStringLen( bstr ) )
 #endif
 

src/bittypes.cpp

@@ -13,7 +13,7 @@
 #include "bittypes.hpp"
 
 #if defined( _WIN32 ) && !defined( BIT7Z_USE_NATIVE_STRING )
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 #endif
 
 namespace bit7z {

src/internal/bufferextractcallback.cpp

@@ -14,6 +14,7 @@
 #include "internal/bufferextractcallback.hpp"
 #include "internal/cbufferoutstream.hpp"
 #include "internal/fs.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 using namespace std;

src/internal/bufferitem.cpp

@@ -15,6 +15,7 @@
 #include "internal/bufferitem.hpp"
 #include "internal/cbufferinstream.hpp"
 #include "internal/dateutil.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 using std::vector;

src/internal/cfileinstream.cpp

@@ -12,7 +12,7 @@
 
 #include "bitexception.hpp"
 #include "internal/cfileinstream.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 #if defined( _WIN32 ) && defined( __GLIBCXX__ ) && defined( _WIO_DEFINED )
 #include "internal/fsutil.hpp"

src/internal/cfileoutstream.cpp

@@ -14,7 +14,7 @@
 
 #include "bitexception.hpp"
 #include "internal/cfileoutstream.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 #if defined( _WIN32 ) && defined( __GLIBCXX__ ) && defined( _WIO_DEFINED )
 #include "internal/fsutil.hpp"

src/internal/extractcallback.cpp

@@ -15,7 +15,7 @@
 #include "bitexception.hpp"
 #include "internal/extractcallback.hpp"
 #include "internal/operationcategory.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 namespace bit7z {
 

src/internal/fileextractcallback.cpp

@@ -13,6 +13,7 @@
 #include "bitexception.hpp"
 #include "internal/fileextractcallback.hpp"
 #include "internal/fsutil.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 using namespace std;

src/internal/fsitem.cpp

@@ -16,6 +16,7 @@
 #include "internal/cfileinstream.hpp"
 #include "internal/csymlinkinstream.hpp"
 #include "internal/fsitem.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 namespace bit7z { // NOLINT(modernize-concat-nested-namespaces)

src/internal/fsutil.cpp

@@ -23,7 +23,7 @@
 #endif
 
 #include "internal/fsutil.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 using namespace std;
 

src/internal/genericinputitem.cpp

@@ -11,7 +11,7 @@
  */
 
 #include "internal/genericinputitem.hpp"
-#include "util.hpp"
+#include "internal/stringutil.hpp"
 
 namespace bit7z {
 

src/internal/opencallback.cpp

@@ -13,6 +13,7 @@
 #include "bitexception.hpp"
 #include "internal/cfileinstream.hpp"
 #include "internal/opencallback.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 namespace bit7z {

src/internal/renameditem.cpp

@@ -13,7 +13,7 @@
 #include "internal/dateutil.hpp"
 #include "internal/fsutil.hpp"
 #include "internal/renameditem.hpp"
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 namespace bit7z {
 

src/internal/stdinputitem.cpp

@@ -15,6 +15,7 @@
 #include "internal/cstdinstream.hpp"
 #include "internal/dateutil.hpp"
 #include "internal/stdinputitem.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 using std::istream;

src/internal/util.cpp → src/internal/stringutil.cpp

@@ -12,9 +12,10 @@
 
 #include <locale>
 
-#include "internal/util.hpp"
+#include "internal/stringutil.hpp"
 
 #ifdef _WIN32
+#include <Windows.h>
 #ifdef BIT7Z_USE_SYSTEM_CODEPAGE
 #define CODEPAGE CP_ACP
 #define CODEPAGE_WC_FLAGS WC_NO_BEST_FIT_CHARS

src/internal/stringutil.hpp

@@ -0,0 +1,79 @@
+/*
+ * bit7z - A C++ static library to interface with the 7-zip shared libraries.
+ * Copyright (c) 2014-2023 Riccardo Ostani - All Rights Reserved.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+#ifndef STRINGUTIL_HPP
+#define STRINGUTIL_HPP
+
+#include "bittypes.hpp"
+#include "internal/fsutil.hpp"
+
+namespace bit7z {
+
+#if defined( BIT7Z_USE_NATIVE_STRING ) && defined( _WIN32 )
+// On Windows, with native strings enabled, strings are already wide!
+#   define WIDEN( tstr ) tstr
+#else
+#   define WIDEN( tstr ) bit7z::widen(tstr)
+
+auto narrow( const wchar_t* wideString, size_t size ) -> std::string;
+
+auto widen( const std::string& narrowString ) -> std::wstring;
+#endif
+
+inline auto path_to_tstring( const fs::path& path ) -> tstring {
+    /* In an ideal world, we should only use fs::path's string< tchar >() function for converting a path to a tstring.
+     * However, MSVC converts paths to std::string using the system codepage instead of UTF-8,
+     * which is the default encoding of bit7z. */
+#if defined( _WIN32 ) && defined( BIT7Z_USE_NATIVE_STRING )
+    return path.wstring();
+#elif defined( _WIN32 ) && defined( BIT7Z_USE_SYSTEM_CODEPAGE )
+    /* If we encounter a path with Unicode characters, MSVC will throw an exception
+     * while converting from a fs::path to std::string if any character is invalid in the system codepage.
+     * Hence, here we use bit7z's own string conversion function, which substitutes invalid Unicode characters
+     * with '?' characters. */
+    const auto& native_path = path.native();
+    return narrow( native_path.c_str(), native_path.size() );
+#else
+    return path.u8string();
+#endif
+}
+
+#if defined( _MSC_VER ) && !defined( BIT7Z_USE_NATIVE_STRING ) && !defined( BIT7Z_USE_SYSTEM_CODEPAGE )
+#define PATH_FROM_TSTRING( str ) fs::u8path( str )
+#else
+#define PATH_FROM_TSTRING( str ) fs::path{ str }
+#endif
+
+inline auto tstring_to_path( const tstring& str ) -> fs::path {
+#if defined( _WIN32 ) && defined( BIT7Z_AUTO_PREFIX_LONG_PATHS )
+    auto result = PATH_FROM_TSTRING( str );
+    if ( filesystem::fsutil::should_format_long_path( result ) ) {
+        result = filesystem::fsutil::format_long_path( result );
+    }
+    return result;
+#else
+    // By default, MSVC treats strings as encoded using the system codepage, but bit7z uses UTF-8.
+    return PATH_FROM_TSTRING( str );
+#endif
+}
+
+inline auto path_to_wide_string( const fs::path& path ) -> std::wstring {
+#if defined( _MSC_VER ) || !defined( BIT7Z_USE_STANDARD_FILESYSTEM )
+    return path.wstring();
+#else
+    /* On some compilers and platforms (e.g., GCC before v12.3),
+     * the direct conversion of the fs::path to wstring might throw an exception due to unicode characters.
+     * So we simply convert to tstring, and then widen it if necessary. */
+    return WIDEN( path.string< tchar >() );
+#endif
+}
+
+} // namespace bit7z
+
+#endif //STRINGUTIL_HPP

src/internal/updatecallback.cpp

@@ -12,6 +12,7 @@
 
 #include "internal/cfileoutstream.hpp"
 #include "internal/updatecallback.hpp"
+#include "internal/stringutil.hpp"
 #include "internal/util.hpp"
 
 namespace bit7z {