chore: update build system

- use configuration-arch-based path in MSVC to make sure generated package can be used by native MSVC project.
- add github action and corresponding build script. but not tested.
- fix some testbench code.

.gitattributes

@@ -1 +1,2 @@
-Doxyfile.in eol=lf
+Doxyfile.in eol=lf
+*.bat       eol=crlf

.github/workflows/nightly.yml

@@ -0,0 +1,35 @@
+name: YYCC Nightly Build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+jobs:
+  msvc-build:
+  
+    strategy:
+      matrix:
+        vs: ['2019']
+        msvc_arch: ['x86']
+
+    runs-on: windows-2019
+
+    steps:
+    - name: Fetching Repository
+      uses: actions/checkout@v3
+    - name: Building YYCC
+      shell: cmd
+      run: |
+        set VS=${{ matrix.vs }}
+        set VCVARS="C:\Program Files (x86)\Microsoft Visual Studio\%VS%\Enterprise\VC\Auxiliary\Build\vcvarsall.bat"
+        if not exist %VCVARS% set VCVARS="C:\Program Files\Microsoft Visual Studio\%VS%\Enterprise\VC\Auxiliary\Build\vcvarsall.bat"
+        call %VCVARS% ${{ matrix.msvc_arch }}
+        .\script\build.bat
+    - name: Uploading Nightly Build
+      uses: actions/upload-artifact@v3
+      with:
+        name: YYCC-windows-nightly
+        path: bin/install/*
+        retention-days: 30

CMakeLists.txt

@@ -8,6 +8,18 @@ project(YYCC
 option(YYCC_BUILD_TESTBENCH "Build testbench of YYCCommonplace." OFF)
 option(YYCC_BUILD_DOC "Build document of YYCCommonplace." OFF)
 
+# Detect MSVC IDE environment.
+# If we in it, we should add configuration and build type in install path.
+if (CMAKE_GENERATOR MATCHES "Visual Studio")
+    # Do Visual Studio specific
+    set(YYCC_INSTALL_PATH_LIB lib/${CMAKE_VS_PLATFORM_NAME}/$<CONFIG>)
+    set(YYCC_INSTALL_PATH_BIN bin/${CMAKE_VS_PLATFORM_NAME})
+else()
+    # Other stuff
+    set(YYCC_INSTALL_PATH_LIB lib)
+    set(YYCC_INSTALL_PATH_BIN bin)
+endif()
+
 # Import 2 build targets
 add_subdirectory(src)
 if (YYCC_BUILD_TESTBENCH)

script/build.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+SET README_PATH=%CD%\README.md
+IF EXIST %README_PATH% (
+    REM DO NOTHING
+) ELSE (
+    ECHO Error: You must run this script at the root folder of this project!
+    EXIT /b
+)
+
+:: Create essential folder
+MKDIR bin
+CD bin
+MKDIR Win32
+MKDIR x64
+MKDIR install
+
+:: Build for Win32
+CD Win32
+cmake -G "Visual Studio 16 2019" -A Win32 -DYYCC_BUILD_TESTBENCH=ON ../..
+cmake --build . --config Debug
+cmake --install . --prefix=../install --config Debug
+cmake --build . --config Release
+cmake --install . --prefix=../install --config Release
+CD ..
+
+:: Build for x64
+CD x64
+cmake -G "Visual Studio 16 2019" -A x64 -DYYCC_BUILD_TESTBENCH=ON ../..
+cmake --build . --config Debug
+cmake --install . --prefix=../install --config Debug
+cmake --build . --config Release
+cmake --install . --prefix=../install --config Release
+CD ..
+
+ECHO DONE

src/CMakeLists.txt

@@ -67,13 +67,11 @@ PRIVATE
     $<$<CXX_COMPILER_ID:MSVC>:/utf-8>
 )
 
-# Install project
-# Install binary
+# Install binary and headers
 install(TARGETS YYCCommonplace
     EXPORT YYCCommonplaceTargets
-    LIBRARY DESTINATION lib
-    ARCHIVE DESTINATION lib
-    RUNTIME DESTINATION bin
+    LIBRARY DESTINATION ${YYCC_INSTALL_PATH_LIB}
+    ARCHIVE DESTINATION ${YYCC_INSTALL_PATH_LIB}
     INCLUDES DESTINATION include
     FILE_SET HEADERS DESTINATION include
 )

src/COMHelper.cpp

@@ -21,6 +21,10 @@ namespace YYCC::COMHelper {
 			}
 		}
 
+		bool IsInitialized() const {
+			return m_HasInit;
+		}
+
 	protected:
 		bool m_HasInit;
 	};
@@ -33,7 +37,11 @@ namespace YYCC::COMHelper {
 	 * So we use a static instance in here.
 	 * And make it be const so no one can change it.
 	*/
-	static const ComGuard c_ComGuard;
+	static const ComGuard c_ComGuard {};
+
+	bool IsInitialized() {
+		return c_ComGuard.IsInitialized();
+	}
 
 }
 

src/COMHelper.hpp

@@ -64,6 +64,17 @@ namespace YYCC::COMHelper {
 
 	using SmartLPWSTR = std::unique_ptr<std::remove_pointer_t<LPWSTR>, CoTaskMemDeleter>;
 
+	/**
+	 * @brief Check whether COM environment has been initialized.
+	 * @return True if it is, otherwise false.
+	 * @remarks
+	 * This function will call corresponding function of COM Guard.
+	 * Do not remove this function and you must preserve at least one reference to this function in final program.
+	 * Some compiler will try to drop COM Guard in final program if no reference to it and it will cause the initialization of COM environment failed.
+	 * This is the reason why I order you do the things said above.
+	*/
+	bool IsInitialized();
+
 }
 
 #endif

src/ConsoleHelper.cpp

@@ -171,7 +171,7 @@ namespace YYCC::ConsoleHelper {
 #else
 
 		// just return true and do nothing
-		return true
+		return true;
 
 #endif
 	}
@@ -226,7 +226,7 @@ namespace YYCC::ConsoleHelper {
 		WinConsoleWrite(strl, bIsErr);
 #else
 		// in linux, directly use C function to write.
-		std::fputs(strl.c_str(), to_stderr ? stderr : stdout);
+		std::fputs(strl.c_str(), bIsErr ? stderr : stdout);
 #endif
 	}
 
@@ -245,11 +245,13 @@ namespace YYCC::ConsoleHelper {
 	}
 
 	void Write(const char* u8_strl) {
-		RawWrite<false, false, false>(u8_strl, va_list());
+		va_list empty{};
+		RawWrite<false, false, false>(u8_strl, empty);
 	}
 	
 	void WriteLine(const char* u8_strl) {
-		RawWrite<false, false, true>(u8_strl, va_list());
+		va_list empty{};
+		RawWrite<false, false, true>(u8_strl, empty);
 	}
 	
 	void ErrFormat(const char* u8_fmt, ...) {
@@ -267,11 +269,13 @@ namespace YYCC::ConsoleHelper {
 	}
 
 	void ErrWrite(const char* u8_strl) {
-		RawWrite<false, true, false>(u8_strl, va_list());
+		va_list empty{};
+		RawWrite<false, true, false>(u8_strl, empty);
 	}
 	
 	void ErrWriteLine(const char* u8_strl) {
-		RawWrite<false, true, true>(u8_strl, va_list());
+		va_list empty{};
+		RawWrite<false, true, true>(u8_strl, empty);
 	}
 
 }

src/DialogHelper.cpp

@@ -173,6 +173,9 @@ namespace YYCC::DialogHelper {
 		// prepare result variable
 		HRESULT hr;
 
+		// check whether COM environment has been initialized
+		if (!COMHelper::IsInitialized()) return false;
+
 		// create file dialog instance
 		// fetch dialog CLSID first
 		CLSID dialog_clsid;

src/EncodingHelper.cpp

@@ -1,6 +1,6 @@
 #include "EncodingHelper.hpp"
 
-#include <cuchar>
+#include <locale>
 
 namespace YYCC::EncodingHelper {
 
@@ -70,61 +70,49 @@ namespace YYCC::EncodingHelper {
 
 #endif
 
+#if defined(__cpp_char8_t)
+	using CodecvtUTF8Char_t = char8_t;
+#else
+	using CodecvtUTF8Char_t = char;
+#endif
 	template<typename _TChar, std::enable_if_t<std::is_same_v<_TChar, char16_t> || std::is_same_v<_TChar, char32_t>, int> = 0>
-	static bool UTF8ToUTFOther(const char* src, std::basic_string<_TChar>& dest) {
-		// Reference: 
-		// https://zh.cppreference.com/w/cpp/string/multibyte/mbrtoc32
-		// https://zh.cppreference.com/w/cpp/string/multibyte/mbrtoc16
-		// https://learn.microsoft.com/zh-cn/cpp/c-runtime-library/reference/mbrtoc16-mbrtoc323?view=msvc-170
-		// 
-		// Due to the same reason introduced in UTFOtherToUTF8,
-		// we use these function as convertion function.
+	using CodecvtFacet_t = std::codecvt<_TChar, CodecvtUTF8Char_t, std::mbstate_t>;
+
+	template<typename _TChar, std::enable_if_t<std::is_same_v<_TChar, char16_t> || std::is_same_v<_TChar, char32_t>, int> = 0>
+	static bool UTF8ToUTFOther(const char* _src, std::basic_string<_TChar>& dest) {
+		// Reference:
+		// https://zh.cppreference.com/w/cpp/locale/codecvt/in
 		
 		// init src string
-		if (src == nullptr) return false;
-		std::string src_string(src);
-		// init result string
-		dest.clear();
+		if (_src == nullptr) return false;
+		std::string src(_src);
 
-		// init essential cvt variables
-		std::mbstate_t state {};
-		_TChar c1632;
-		const char* ptr = src_string.c_str();
-		const char* end = src_string.c_str() + src_string.size() + 1;
-
-		// start convertion
-		while (true) {
-			// do convertion
-			size_t rc;
-			if constexpr (std::is_same_v<_TChar, char16_t>) {
-				rc = std::mbrtoc16(&c1632, ptr, end - ptr, &state);
-			} else {
-				rc = std::mbrtoc32(&c1632, ptr, end - ptr, &state);
-			}
-			if (!rc) break;
-
-			// check result
-			if (rc == static_cast<size_t>(-1)) {
-				// encoding error, return false
-				return false;
-			} else if (rc == static_cast<size_t>(-2)) {
-				// insufficient sequence, return false
-				return false;
-			} else if (rc == static_cast<size_t>(-3)) {
-				// UTF16 pair case (usually is emoji, one emoji is represented by 2 UTF16)
-				// 
-				// only push result char but do not increase pointer
-				// because this char is output from state.
-				dest.push_back(c1632);
-			} else {
-				// normal case
-				// append to result
-				dest.push_back(c1632);
-				// inc ptr
-				ptr += rc;
-			}
-		}
+		// init locale and get codecvt facet
+		// same reason in UTFOtherToUTF8 to keeping reference to locale
+		const auto& this_locale = std::locale::classic();
+		const auto& this_codecvt = std::use_facet<CodecvtFacet_t<_TChar>>(this_locale);
+		
+		// convertion preparation
+		std::mbstate_t mb{};
+		dest.resize(src.size());
+		const CodecvtUTF8Char_t* intern_from = reinterpret_cast<const CodecvtUTF8Char_t*>(src.c_str()),
+			*intern_from_end = reinterpret_cast<const CodecvtUTF8Char_t*>(src.c_str() + src.size()),
+			*intern_from_next = nullptr;
+		_TChar* extern_to = dest.data(),
+			*extern_to_end = dest.data() + dest.size(),
+			*extern_to_next = nullptr;
+		// do convertion
+		auto result = this_codecvt.in(
+			mb,
+			intern_from, intern_from_end, intern_from_next,
+			extern_to, extern_to_end, extern_to_next
+		);
 
+		// check result
+		if (result != CodecvtFacet_t<_TChar>::ok)
+			return false;
+		// resize result and return
+		dest.resize(extern_to_next - dest.data());
 		return true;
 	}
 
@@ -146,40 +134,41 @@ namespace YYCC::EncodingHelper {
 	}
 
 	template<typename _TChar, std::enable_if_t<std::is_same_v<_TChar, char16_t> || std::is_same_v<_TChar, char32_t>, int> = 0>
-	static bool UTFOtherToUTF8(const _TChar* src, std::string& dest) {
+	static bool UTFOtherToUTF8(const _TChar* _src, std::string& dest) {
 		// Reference:
-		// https://zh.cppreference.com/w/cpp/string/multibyte/c32rtomb
-		// https://zh.cppreference.com/w/cpp/string/multibyte/c16rtomb
-		// https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/c16rtomb-c32rtomb1?view=msvc-170
-		// 
-		// Due to Microsoft implementation, c16rtomb and c32rtomb 
-		// always convert UTF32 and UTF16 string into UTF8 string no matter current c locale.
-		// At the same time, most Linux use UTF8 as their locale.
-		// So using c16rtomb and c32rtomb do the convertion from UTF32 or UTF16 to UTF8 is reasonable.
-
+		// https://zh.cppreference.com/w/cpp/locale/codecvt/out
+		
 		// initialize src string
-		if (src == nullptr) return false;
-		std::basic_string<_TChar> src_string(src);
-		// init result string
-		dest.clear();
+		if (_src == nullptr) return false;
+		std::basic_string<_TChar> src(_src);
 
-		// init essential cvt variables
-		std::mbstate_t state {};
-		char out[MB_LEN_MAX] {};
-		for (_TChar c : src_string) {
-			// do convertion
-			std::size_t rc;
-			if constexpr (std::is_same_v<_TChar, char16_t>) {
-				rc = std::c16rtomb(out, c, &state);
-			} else {
-				rc = std::c32rtomb(out, c, &state);
-			}
-			// convertion failed
-			if (rc == static_cast<size_t>(-1)) return false;
-			// otherwise append result
-			dest.append(out, rc);
-		}
+		// init locale and get codecvt facet
+		// the reference to locale must be preserved until convertion done.
+		// because the life time of codecvt facet is equal to the reference to locale.
+		const auto& this_locale = std::locale::classic();
+		const auto& this_codecvt = std::use_facet<CodecvtFacet_t<_TChar>>(this_locale);
 
+		// do convertion preparation
+		std::mbstate_t mb{};
+		dest.resize(src.size() * this_codecvt.max_length());
+		const _TChar* intern_from = src.c_str(),
+			*intern_from_end = src.c_str() + src.size(),
+			*intern_from_next = nullptr;
+		CodecvtUTF8Char_t* extern_to = reinterpret_cast<CodecvtUTF8Char_t*>(dest.data()),
+			*extern_to_end = reinterpret_cast<CodecvtUTF8Char_t*>(dest.data() + dest.size()),
+			*extern_to_next = nullptr;
+		// do convertion
+		auto result = this_codecvt.out(
+			mb,
+			intern_from, intern_from_end, intern_from_next,
+			extern_to, extern_to_end, extern_to_next
+		);
+
+		// check result
+		if (result != CodecvtFacet_t<_TChar>::ok)
+			return false;
+		// resize result and retuen
+		dest.resize(extern_to_next - reinterpret_cast<CodecvtUTF8Char_t*>(dest.data()));
 		return true;
 	}
 

testbench/CMakeLists.txt

@@ -33,11 +33,9 @@ PRIVATE
     $<$<CXX_COMPILER_ID:MSVC>:/utf-8>
 )
 
-# Install binary
+# Install testbench only on Release mode
 install(TARGETS YYCCTestbench
     EXPORT YYCCTestbenchTargets
-    LIBRARY DESTINATION lib
-    ARCHIVE DESTINATION lib
-    RUNTIME DESTINATION bin
-    INCLUDES DESTINATION include
+    CONFIGURATIONS Release
+    RUNTIME DESTINATION ${YYCC_INSTALL_PATH_BIN}
 )

testbench/main.cpp

@@ -23,7 +23,7 @@ namespace YYCCTestbench {
 #define TEST_UNICODE_STR_EMOJI "\U0001F363 \u2716 \U0001F37A" // sushi x beer mug
 
 #define CONCAT(prefix, strl) prefix ## strl
-#define CPP_U8_LITERAL(strl) strl
+#define CPP_U8_LITERAL(strl) reinterpret_cast<const char*>(CONCAT(u8, strl))
 #define CPP_U16_LITERAL(strl) CONCAT(u, strl)
 #define CPP_U32_LITERAL(strl) CONCAT(U, strl)
 #define CPP_WSTR_LITERAL(strl) CONCAT(L, strl)
@@ -164,6 +164,7 @@ namespace YYCCTestbench {
 		}
 
 		// check wstring convertion on windows
+#if YYCC_OS == YYCC_OS_WINDOWS
 		for (size_t i = 0u; i < count; ++i) {
 			// get item
 			const auto& u8str = c_UTF8TestStrTable[i];
@@ -177,6 +178,7 @@ namespace YYCCTestbench {
 			Assert(YYCC::EncodingHelper::UTF8ToWchar(u8str.c_str(), wcache) && wcache == wstr, "YYCC::EncodingHelper::UTF8ToWchar");
 			Assert(YYCC::EncodingHelper::WcharToUTF8(wstr.c_str(), u8cache) && u8cache == u8str, "YYCC::EncodingHelper::WcharToUTF8");
 		}
+#endif
 
 	}
 
@@ -300,6 +302,8 @@ namespace YYCCTestbench {
 	}
 
 	static void DialogTestbench() {
+#if YYCC_OS == YYCC_OS_WINDOWS
+
 		std::string ret;
 		std::vector<std::string> rets;
 
@@ -327,9 +331,13 @@ namespace YYCCTestbench {
 		if (YYCC::DialogHelper::OpenFolderDialog(params, ret)) {
 			Console::FormatLine("Open Folder: %s", ret.c_str());
 		}
+
+#endif
 	}
 
 	static void ExceptionTestbench() {
+#if YYCC_OS == YYCC_OS_WINDOWS
+
 		YYCC::ExceptionHelper::Register();
 
 		// Perform a div zero exception.
@@ -337,10 +345,16 @@ namespace YYCCTestbench {
 		int k = i / j;
 
 		YYCC::ExceptionHelper::Unregister();
+
+#endif
 	}
 
 	static void WinFctTestbench() {
-		Console::FormatLine("Current Module HANDLE: 0x%" PRI_XPTR_LEFT_PADDING PRIXPTR, YYCC::WinFctHelper::GetCurrentModule());
+#if YYCC_OS == YYCC_OS_WINDOWS
+
+		HMODULE test_current_module;
+		Assert((test_current_module = YYCC::WinFctHelper::GetCurrentModule()) != nullptr, "YYCC::WinFctHelper::GetCurrentModule");
+		Console::FormatLine("Current Module HANDLE: 0x%" PRI_XPTR_LEFT_PADDING PRIXPTR, test_current_module);
 
 		std::string test_temp;
 		Assert(YYCC::WinFctHelper::GetTempDirectory(test_temp), "YYCC::WinFctHelper::GetTempDirectory");
@@ -353,6 +367,8 @@ namespace YYCCTestbench {
 		std::string test_localappdata_path;
 		Assert(YYCC::WinFctHelper::GetLocalAppData(test_localappdata_path), "YYCC::WinFctHelper::GetLocalAppData");
 		Console::FormatLine("Local AppData: %s", test_localappdata_path.c_str());
+
+#endif
 	}
 
 	static void FsPathPatch() {
@@ -380,10 +396,10 @@ namespace YYCCTestbench {
 int main(int argc, char** args) {
 	//YYCCTestbench::ConsoleTestbench();
 	YYCCTestbench::EncodingTestbench();
-	//YYCCTestbench::StringTestbench();
-	//YYCCTestbench::ParserTestbench();
-	//YYCCTestbench::DialogTestbench();
-	//YYCCTestbench::ExceptionTestbench();
-	//YYCCTestbench::WinFctTestbench();
-	//YYCCTestbench::FsPathPatch();
+	YYCCTestbench::StringTestbench();
+	YYCCTestbench::ParserTestbench();
+	YYCCTestbench::DialogTestbench();
+	YYCCTestbench::ExceptionTestbench();
+	YYCCTestbench::WinFctTestbench();
+	YYCCTestbench::FsPathPatch();
 }