Fix errors to comply with VS 2022 (#20)

mbeckh · web-flow · commit 46d30951ec74 · 2022-11-11T22:12:26.000+01:00
* Fixes for VS 2022 
* Reusable workflows
* Update vcpkg baseline
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,4 +1,4 @@
-name: build
+name: Build
 
 on:
   push:
@@ -11,91 +11,5 @@ on:
 
 jobs:
   build:
-    name: Build and Analyze
-    runs-on: windows-2022
-    strategy:
-      matrix:
-        configuration: [ Debug, Release ]
-    
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: Cache vcpkg
-      uses: actions/cache@v2
-      with:
-        path: build/${{matrix.configuration}}/vcpkg_installed
-        key: vcpkg_installed-${{matrix.configuration}}-${{hashFiles('**/vcpkg.json', '**/vcpkg-configuration.json', '!build/**')}}
-
-    - name: Setup MSVC Environment
-      uses: mbeckh/msvc-dev-cmd@master
-
-    - name: Configure
-      uses: mbeckh/cmake-utils/configure@master
-      with:
-        build-root: build
-        binary-dir: build/${{matrix.configuration}}
-        configuration: ${{matrix.configuration}}
-        extra-args: -D CMAKE_UNITY_BUILD:BOOL=ON -D CMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON -D CMU_DISABLE_DEBUG_INFORMATION_RELEASE:BOOL=ON
-
-    - name: Build
-      shell: cmd
-      working-directory: build/${{matrix.configuration}}
-      run: cmake --build .
-
-    - name: Test
-      if: matrix.configuration != 'Debug'
-      shell: cmd
-      working-directory: build/${{matrix.configuration}}
-      run: ctest --output-on-failure
-
-    - name: Coverage
-      if: matrix.configuration == 'Debug'
-      uses: mbeckh/code-quality-actions/coverage@master
-      with:
-        binary-dir: build/${{matrix.configuration}}
-        codacy-token: ${{secrets.CODACY_PROJECT_API_TOKEN}}
-
-    - name: Codecov
-      if: matrix.configuration == 'Debug'
-      uses: codecov/codecov-action@v2
-      with:
-        files: build/${{matrix.configuration}}/coverage-*.xml
-        fail_ci_if_error: true
-
-    - name: Analyze
-      shell: cmd
-      working-directory: build/${{matrix.configuration}}
-      run: cmake --build . --target clang-tidy
-
-    - name: Report
-      uses: mbeckh/code-quality-actions/report@master
-      with:
-        mode: partial
-        binary-dir: build/${{matrix.configuration}}
-        codacy-token: ${{secrets.CODACY_PROJECT_API_TOKEN}}
-
-    - name: Save Logs
-      if: always()
-      uses: actions/upload-artifact@v2.2.4
-      with:
-        name: ${{matrix.configuration}}-Logs
-        path: |
-            build/**/vcpkg-buildtrees/*/*.log
-            build/${{matrix.configuration}}/Testing/**/*.log
-            build/${{matrix.configuration}}/clang-tidy-*.log
-
-  final:
-    name: Send Completion Message
-    runs-on: windows-latest
-    needs: build
-    
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: Report
-      uses: mbeckh/code-quality-actions/report@master
-      with:
-        mode: final
-        codacy-token: ${{secrets.CODACY_PROJECT_API_TOKEN}}
+    uses: mbeckh/cmake-utils/.github/workflows/run-build.yml@v1
+    secrets: inherit
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -9,53 +9,9 @@ on:
       - '**/*.md'
       - '**/*.txt'
   schedule:
-    - cron: '21 8 * * 1'
+    - cron: '21 8 4 * *'
 
 jobs:
-  analyse:
-    name: Analyze
-    runs-on: windows-2019
-    permissions:
-      security-events: write
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    - name: Cache vcpkg
-      uses: actions/cache@v2
-      with:
-        path: build/Release/vcpkg_installed
-        key: vcpkg_installed-Release-${{hashFiles('**/vcpkg.json', '**/vcpkg-configuration.json', '!build/**')}}
-
-    - name: Setup MSVC Environment
-      uses: mbeckh/msvc-dev-cmd@master
-
-    - name: Configure
-      uses: mbeckh/cmake-utils/configure@master
-      with:
-        build-root: build
-        binary-dir: build/Release
-        configuration: Release
-        extra-args: -D CMAKE_UNITY_BUILD:BOOL=ON -D CMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON -D CMU_DISABLE_DEBUG_INFORMATION:BOOL=ON
-
-    - name: Initialize CodeQL
-      if: github.event_name != 'pull_request'
-      uses: github/codeql-action/init@v1
-      with:
-        languages: cpp
-        queries: security-and-quality
-
-    - name: Initialize CodeQL for Pull Request
-      if: github.event_name == 'pull_request'
-      uses: github/codeql-action/init@v1
-      with:
-        languages: cpp
-
-    - name: Build
-      shell: cmd
-      working-directory: build/Release
-      run: cmake --build .
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+  build:
+    uses: mbeckh/cmake-utils/.github/workflows/run-codeql.yml@v1
+    secrets: inherit
diff --git a/NOTICE b/NOTICE
@@ -1,5 +1,5 @@
 common-cpp
-Copyright 2019 Michael Beckh
+Copyright 2019-2022 Michael Beckh
 
 This product includes software developed by
 Michael Beckh (https://github.com/mbeckh/common-cpp/).
diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
 # common-cpp
+A collection of common classes for C++ programming, particularly for targeting Windows API and COM.
 
-[![Release](https://img.shields.io/github/v/tag/mbeckh/common-cpp?label=Release&style=flat-square)](https://github.com/mbeckh/common-cpp/releases/)
-[![Tests](https://img.shields.io/github/workflow/status/mbeckh/common-cpp/build/master?label=Tests&logo=GitHub&style=flat-square)](https://github.com/mbeckh/common-cpp/actions)
+[![Release](https://img.shields.io/github/v/release/mbeckh/common-cpp?display_name=tag&sort=semver&label=Release&style=flat-square)](https://github.com/mbeckh/common-cpp/releases/)
+[![Tests](https://img.shields.io/github/workflow/status/mbeckh/common-cpp/Build/master?label=Tests&logo=GitHub&style=flat-square)](https://github.com/mbeckh/common-cpp/actions)
 [![Coverage](https://img.shields.io/codecov/c/gh/mbeckh/common-cpp/master?label=Coverage&logo=codecov&style=flat-square)](https://codecov.io/gh/mbeckh/common-cpp)
 [![Codacy Grade](https://img.shields.io/codacy/grade/d1c1975989c642f2817ffc7160ff6f92?label=Code%20Quality&logo=codacy&style=flat-square)](https://www.codacy.com/manual/mbeckh/common-cpp?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mbeckh/SystemTools&amp;utm_campaign=Badge_Grade)
 [![License](https://img.shields.io/github/license/mbeckh/common-cpp?label=License&style=flat-square)](https://github.com/mbeckh/common-cpp/blob/master/LICENSE)
 
-A collection of common classes for C++ programming, particularly for targeting Windows API and COM.
+## License
+The code is released under the Apache License Version 2.0. Please see [LICENSE](LICENSE) for details and
+[NOTICE](NOTICE) for the required information when using common-cpp in your own work.
diff --git a/include/m3c/LogArgs.h b/include/m3c/LogArgs.h
@@ -336,7 +336,7 @@ class LogFormatArgs : private internal::LogFormatArgsBase {
 			AddArgumentFallback(arg);
 		} else {
 			// prevent storing references to temporary objects
-			static_assert_no_clang(false, "MUST NOT use rvalue to add to LogFormatArgs");
+			static_assert(sizeof(T) == 0, "MUST NOT use rvalue to add to LogFormatArgs");
 		}
 		return *this;
 	}
@@ -356,7 +356,7 @@ class LogFormatArgs : private internal::LogFormatArgsBase {
 			AddArgumentFallback(arg);
 		} else {
 			// prevent storing references to temporary objects
-			static_assert_no_clang(false, "MUST NOT use rvalue to add to LogFormatArgs");
+			static_assert(sizeof(T) == 0, "MUST NOT use rvalue to add to LogFormatArgs");
 		}
 		return *this;
 	}
@@ -398,10 +398,10 @@ class LogEventArgs : private internal::LogEventArgsBase {
 			AddArgument(std::forward<T>(arg));
 		} else {
 			if constexpr (std::is_rvalue_reference_v<T&&>) {
-				static_assert_no_clang(false, "MUST NOT use rvalue to add to LogEventArgs");
+				static_assert(sizeof(T) == 0, "MUST NOT use rvalue to add to LogEventArgs");
 			}
 			// prevent storing references to temporary objects
-			static_assert_no_clang(false, "MUST use custom operator>> to add to LogEventArgs");
+			static_assert(sizeof(T) == 0, "MUST use custom operator>> to add to LogEventArgs");
 		}
 		return *this;
 	}
diff --git a/include/m3c/type_traits.h b/include/m3c/type_traits.h
@@ -24,14 +24,6 @@ limitations under the License.
 #include <span>
 #include <type_traits>
 
-#ifdef __clang_analyzer__
-// clang can't handle some static_assert checks in templated code
-// NOLINTNEXTLINE(readability-identifier-naming): Kind of funny that clang complains about a macro to work around shortcomings of clang.
-#define static_assert_no_clang(...)
-#else
-#define static_assert_no_clang(...) static_assert(__VA_ARGS__)
-#endif
-
 #define M3C_SELECT_STRING(...) __VA_ARGS__, L##__VA_ARGS__
 
 namespace m3c {
@@ -48,7 +40,7 @@ consteval _Ret_z_ const CharT* SelectString(_In_z_ const char* const sz, _In_z_
 	} else if constexpr (std::is_same_v<wchar_t, CharT>) {
 		return wsz;
 	} else {
-		static_assert_no_clang(false, "Unknown char type");
+		static_assert(sizeof(CharT) == 0, "Unknown char type");
 	}
 }
 
diff --git a/src/ComObject.cpp b/src/ComObject.cpp
@@ -40,7 +40,7 @@ ULONG Unknown::UnknownImpl::Release() noexcept {
 }
 
 AbstractComObject* Unknown::UnknownImpl::GetAbstractComObject() noexcept {
-	static_assert_no_clang(offsetof(Unknown, m_unknown) == 0);
+	static_assert(offsetof(Unknown, m_unknown) == 0);
 #pragma warning(suppress : 26491)                                              // valid as checked by static_assert
 	return static_cast<AbstractComObject*>(reinterpret_cast<Unknown*>(this));  // NOLINT(cppcoreguidelines-pro-type-static-cast-downcast): Pointer magic :-)
 }
diff --git a/src/LogData.cpp b/src/LogData.cpp
@@ -312,7 +312,7 @@ void DecodeArgument(_Inout_ A& args, _In_ const std::byte* __restrict const buff
 			args << arg;
 		}
 	} else {
-		static_assert_no_clang(false, "Unknown argument type");
+		static_assert(sizeof(A) == 0, "Unknown argument type");
 	}
 
 	position += kTypeSize<T> + padding;
@@ -341,10 +341,10 @@ void DecodeArgument(_Inout_ A& args, _In_ const std::byte* __restrict const buff
 		} else if constexpr (std::is_same_v<B, wchar_t>) {
 			args + EncodeUtf8(str, length);
 		} else {
-			static_assert_no_clang(false, "Unknown string type");
+			static_assert(sizeof(B) == 0, "Unknown string type");
 		}
 	} else {
-		static_assert_no_clang(false, "Unknown argument type");
+		static_assert(sizeof(A), "Unknown argument type");
 	}
 	position += kTypeSize<T> + padding + length * static_cast<Align>(sizeof(B)) + static_cast<Align>(sizeof(B));
 }
@@ -369,7 +369,7 @@ void DecodeArgument(_Inout_ A& args, _In_ const std::byte* __restrict const buff
 	} else if constexpr (std::is_same_v<A, LogFormatArgs>) {
 		args << arg;
 	} else {
-		static_assert_no_clang(false, "Unknown argument type");
+		static_assert(sizeof(A) == 0, "Unknown argument type");
 	}
 
 	position += kTypeSize<SID> + padding + size;
@@ -394,7 +394,7 @@ void DecodeArgument(_Inout_ A& args, _Inout_ const std::byte* __restrict const b
 	} else if constexpr (std::is_same_v<A, LogFormatArgs>) {
 		pFunctionTable->addFormatArgs(args, &buffer[position + kArgSize + padding]);
 	} else {
-		static_assert_no_clang(false, "Unknown argument type");
+		static_assert(sizeof(A) == 0, "Unknown argument type");
 	}
 	position += kArgSize + padding + pFunctionTable->size;
 }
@@ -783,13 +783,13 @@ LogDataBase::~LogDataBase() noexcept {
 	// ensure proper memory layout
 	static_assert(sizeof(LogDataBase) == M3C_LOGDATA_SIZE, "size of LogLine");
 
-	static_assert_no_clang(offsetof(LogDataBase, m_stackBuffer) == 0, "offset of m_stackBuffer");
+	static_assert(offsetof(LogDataBase, m_stackBuffer) == 0, "offset of m_stackBuffer");
 #if UINTPTR_MAX == UINT64_MAX
-	static_assert_no_clang(offsetof(LogDataBase, m_used) == M3C_LOGDATA_SIZE - 4, "offset of m_used");
+	static_assert(offsetof(LogDataBase, m_used) == M3C_LOGDATA_SIZE - 4, "offset of m_used");
 #elif UINTPTR_MAX == UINT32_MAX
-	static_assert_no_clang(offsetof(LogDataBase, m_used) == M3C_LOGDATA_SIZE - 4, "offset of m_used");
+	static_assert(offsetof(LogDataBase, m_used) == M3C_LOGDATA_SIZE - 4, "offset of m_used");
 #else
-	static_assert_no_clang(false, "layout assertions not defined");
+	static_assert(false, "layout assertions not defined");
 #endif
 	if ((!m_hasHeapBuffer || GetHeapBuffer().use_count() == 1) && m_hasNonTriviallyCopyable) {
 		[[unlikely]];
diff --git a/test/Log.test.cpp b/test/Log.test.cpp
@@ -209,7 +209,7 @@ class Log_Test : public t::Test {
 	}
 
 	template <EVENT_DESCRIPTOR kLoggedExceptionEvent = EVENT_DESCRIPTOR{}, bool kNested = false, bool kHResult = false, typename E = int, typename D = int, typename... Args>
-	auto TestMethod(const char* const dynamicLogMessage = "", E&& exception = 0, const char* const exceptionMessage = nullptr, const D detail = 0, Args&&... args) {
+	auto TestMethod(const char* const dynamicLogMessage = "", E&& exception = 0, const char* const exceptionMessage = nullptr, [[maybe_unused]] const D detail = 0, Args&&... args) {
 		constexpr bool kException = !std::is_same_v<E, int>;
 		constexpr bool kDetail = !std::is_same_v<D, int>;
 		const EventType eventType = GetEventType();
diff --git a/test/lazy_string.test.cpp b/test/lazy_string.test.cpp
@@ -92,7 +92,7 @@ struct CharTNames {
 		} else if constexpr (std::is_same_v<T, wchar_t>) {
 			return "1_wchar_t";
 		} else {
-			static_assert_no_clang(false, "unknown type");
+			static_assert(sizeof(T) == 0, "unknown type");
 		}
 	}
 };
diff --git a/vcpkg-configuration.json b/vcpkg-configuration.json
@@ -1,13 +1,13 @@
 {
   "default-registry": {
     "kind": "builtin",
-    "baseline": "70033dbb31527fb3e69654731f540f59c87787f9"
+    "baseline": "48cc0c71ed61be1c0e3c9543dd0f2b997037d1c9"
   },
   "registries": [
     {
       "kind": "git",
       "repository": "https://github.com/mbeckh/vcpkg-registry.git",
-      "baseline": "ded1cdfa4453537af1dcf9dda1de2d82e7646fe6",
+      "baseline": "3968e6edc820dc3d666b3d3383f096b1998eb8e7",
       "packages": [ "common-cpp-testing", "detours", "detours-gmock", "fmt", "gtest" ]
     }
   ]

Original file line number	Diff line number	Diff line change
`@@ -336,7 +336,7 @@ class LogFormatArgs : private internal::LogFormatArgsBase {`
`336`	`336`	`AddArgumentFallback(arg);`
`337`	`337`	`} else {`
`338`	`338`	`// prevent storing references to temporary objects`
`339`		`- static_assert_no_clang(false, "MUST NOT use rvalue to add to LogFormatArgs");`
	`339`	`+ static_assert(sizeof(T) == 0, "MUST NOT use rvalue to add to LogFormatArgs");`
`340`	`340`	`}`
`341`	`341`	`return *this;`
`342`	`342`	`}`
`@@ -356,7 +356,7 @@ class LogFormatArgs : private internal::LogFormatArgsBase {`
`356`	`356`	`AddArgumentFallback(arg);`
`357`	`357`	`} else {`
`358`	`358`	`// prevent storing references to temporary objects`
`359`		`- static_assert_no_clang(false, "MUST NOT use rvalue to add to LogFormatArgs");`
	`359`	`+ static_assert(sizeof(T) == 0, "MUST NOT use rvalue to add to LogFormatArgs");`
`360`	`360`	`}`
`361`	`361`	`return *this;`
`362`	`362`	`}`
`@@ -398,10 +398,10 @@ class LogEventArgs : private internal::LogEventArgsBase {`
`398`	`398`	`AddArgument(std::forward<T>(arg));`
`399`	`399`	`} else {`
`400`	`400`	`if constexpr (std::is_rvalue_reference_v<T&&>) {`
`401`		`- static_assert_no_clang(false, "MUST NOT use rvalue to add to LogEventArgs");`
	`401`	`+ static_assert(sizeof(T) == 0, "MUST NOT use rvalue to add to LogEventArgs");`
`402`	`402`	`}`
`403`	`403`	`// prevent storing references to temporary objects`
`404`		`- static_assert_no_clang(false, "MUST use custom operator>> to add to LogEventArgs");`
	`404`	`+ static_assert(sizeof(T) == 0, "MUST use custom operator>> to add to LogEventArgs");`
`405`	`405`	`}`
`406`	`406`	`return *this;`
`407`	`407`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ ULONG Unknown::UnknownImpl::Release() noexcept {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`AbstractComObject* Unknown::UnknownImpl::GetAbstractComObject() noexcept {`
`43`		`- static_assert_no_clang(offsetof(Unknown, m_unknown) == 0);`
	`43`	`+ static_assert(offsetof(Unknown, m_unknown) == 0);`
`44`	`44`	`#pragma warning(suppress : 26491) // valid as checked by static_assert`
`45`	`45`	`return static_cast<AbstractComObject>(reinterpret_cast<Unknown>(this)); // NOLINT(cppcoreguidelines-pro-type-static-cast-downcast): Pointer magic :-)`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ class Log_Test : public t::Test {`
`209`	`209`	`}`
`210`	`210`
`211`	`211`	`template <EVENT_DESCRIPTOR kLoggedExceptionEvent = EVENT_DESCRIPTOR{}, bool kNested = false, bool kHResult = false, typename E = int, typename D = int, typename... Args>`
`212`		`- auto TestMethod(const char* const dynamicLogMessage = "", E&& exception = 0, const char* const exceptionMessage = nullptr, const D detail = 0, Args&&... args) {`
	`212`	`+ auto TestMethod(const char* const dynamicLogMessage = "", E&& exception = 0, const char* const exceptionMessage = nullptr, [[maybe_unused]] const D detail = 0, Args&&... args) {`
`213`	`213`	`constexpr bool kException = !std::is_same_v<E, int>;`
`214`	`214`	`constexpr bool kDetail = !std::is_same_v<D, int>;`
`215`	`215`	`const EventType eventType = GetEventType();`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ struct CharTNames {`
`92`	`92`	`} else if constexpr (std::is_same_v<T, wchar_t>) {`
`93`	`93`	`return "1_wchar_t";`
`94`	`94`	`} else {`
`95`		`- static_assert_no_clang(false, "unknown type");`
	`95`	`+ static_assert(sizeof(T) == 0, "unknown type");`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`	`};`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`{`
`2`	`2`	`"default-registry": {`
`3`	`3`	`"kind": "builtin",`
`4`		`- "baseline": "70033dbb31527fb3e69654731f540f59c87787f9"`
	`4`	`+ "baseline": "48cc0c71ed61be1c0e3c9543dd0f2b997037d1c9"`
`5`	`5`	`},`
`6`	`6`	`"registries": [`
`7`	`7`	`{`
`8`	`8`	`"kind": "git",`
`9`	`9`	`"repository": "https://github.com/mbeckh/vcpkg-registry.git",`
`10`		`- "baseline": "ded1cdfa4453537af1dcf9dda1de2d82e7646fe6",`
	`10`	`+ "baseline": "3968e6edc820dc3d666b3d3383f096b1998eb8e7",`
`11`	`11`	`"packages": [ "common-cpp-testing", "detours", "detours-gmock", "fmt", "gtest" ]`
`12`	`12`	`}`
`13`	`13`	`]`