Refactor: Remove precompiled headers and update CMake

Removed `stdafx.h` includes from multiple source files and deleted `stdafx.cpp`, `stdafx.h`, `targetver.h`, and `platform_defines.h`. Updated `CMakeLists.txt` to replace platform-specific checks with `LIBCZI_HAVE_WIN32_API` and set `CZICMD_WINDOWSAPIAVAILABLE` accordingly. Adjusted `CMakeLists.txt` to conditionally link Windows libraries and updated the `RapidJSON` Git tag. Replaced platform-specific macros with `CZICMD_WINDOWSAPI_AVAILABLE` in various source files. Added necessary includes to `consoleio.h`. Removed `#pragma once` and other preprocessor directives from multiple files.
ZEISS · Sep 20, 2024 · ca5c619 · ca5c619
1 parent d3cba5d
commit ca5c619
Show file tree

Hide file tree

Showing 25 changed files with 38 additions and 120 deletions.
diff --git a/Src/CZICmd/BitmapGen.cpp b/Src/CZICmd/BitmapGen.cpp
@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
-
 #include "IBitmapGen.h"
 #include "BitmapGenGdiplus.h"
 #include "BitmapGenNull.h"

diff --git a/Src/CZICmd/BitmapGenFreeType.cpp b/Src/CZICmd/BitmapGenFreeType.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "inc_CZIcmd_Config.h"
 
 #if CZICMD_USE_FREETYPE == 1

diff --git a/Src/CZICmd/BitmapGenGdiplus.cpp b/Src/CZICmd/BitmapGenGdiplus.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "BitmapGenGdiplus.h"
 #include "BitmapGenNull.h"
 #include "utils.h"

diff --git a/Src/CZICmd/BitmapGenNull.cpp b/Src/CZICmd/BitmapGenNull.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "BitmapGenNull.h"
 #include "utils.h"
 #include "inc_libCZI.h"

diff --git a/Src/CZICmd/CMakeLists.txt b/Src/CZICmd/CMakeLists.txt
@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: LGPL-3.0-or-later
 
-IF(UNIX)
+IF(NOT LIBCZI_HAVE_WIN32_API)
  find_package(ZLIB QUIET)
  if (NOT ZLIB_FOUND)
     message(FATAL_ERROR [=[
@@ -24,7 +24,7 @@ IF(UNIX)
     message("** FreeType was not found, CZICmd with the option \"CreateCZI\" will create only empty images.")
 	  message("   (consider installing FreeType with e.g. 'sudo apt-get install libfreetype6-dev')")
  ENDIF()
-ENDIF(UNIX)
+ENDIF()
 
 include(FetchContent)
 
@@ -43,7 +43,7 @@ else()
      FetchContent_Declare(
             RapidJSON
             GIT_REPOSITORY https://github.com/Tencent/rapidjson.git
-            GIT_TAG        "v1.1.0"
+            GIT_TAG        7c73dd7de7c4f14379b781418c6e947ad464c818 # master as of 2024-08-16
             GIT_SHALLOW    TRUE
             PREFIX "${CMAKE_BINARY_DIR}/vendor/rapidjson"
     )
@@ -68,7 +68,6 @@ endif()
 set (CZICMDSRCFILES
          BitmapGen.cpp          
          DisplaySettingsHelper.h  
-         targetver.h
          BitmapGenFreeType.cpp  
          cmdlineoptions.cpp  
          execute.cpp              
@@ -84,17 +83,14 @@ set (CZICMDSRCFILES
          consoleio.cpp       
          executeCreateCzi.h       
          inc_CZIcmd_Config.h  
-         stdafx.cpp
          BitmapGenGdiplus.h     
          consoleio.h         
          execute.h                
          inc_libCZI.h         
-         stdafx.h
          BitmapGenNull.cpp      
          inc_rapidjson.h      
          BitmapGenNull.h        
          CZIcmd.cpp          
-         platform_defines.h
          executePlaneScan.h
          executePlaneScan.cpp
          executeBase.h
@@ -108,8 +104,8 @@ target_compile_definitions(CZIcmd PRIVATE _LIBCZISTATICLIB)
 target_link_libraries(CZIcmd PRIVATE ${ZLIB_LIBRARIES}  ${PNG_LIBRARIES} CLI11::CLI11 libCZIStatic)
 target_include_directories(CZIcmd PRIVATE ${CMAKE_CURRENT_BINARY_DIR} ${RAPIDJSON_INCLUDE_DIRS})
 
-IF(WIN32)
-  target_link_libraries(CZIcmd PRIVATE gdiplus Windowscodecs)
+IF(LIBCZI_HAVE_WIN32_API)
+  target_link_libraries(CZIcmd PRIVATE gdiplus Windowscodecs ole32)
 ENDIF()
 
 IF (FREETYPE_FOUND)
@@ -118,16 +114,17 @@ IF (FREETYPE_FOUND)
     target_link_libraries(CZIcmd PRIVATE ${FREETYPE_LIBRARIES})
 ENDIF()
 
-IF(UNIX)
+IF(NOT LIBCZI_HAVE_WIN32_API)
   target_include_directories(CZIcmd PRIVATE ${ZLIB_INCLUDE_DIR} ${PNG_INCLUDE_DIR})
   # seems to be problem with glibc I'd reckon -> https://stackoverflow.com/questions/51584960/stdcall-once-throws-stdsystem-error-unknown-error-1
   target_link_libraries(CZIcmd  PUBLIC pthread)
-ENDIF(UNIX)
+ENDIF()
 
 set(CZICMD_USE_FREETYPE 0)
 set(CZICMD_USE_WIC 0)
 set(CZICMD_USE_GDIPLUS 0)
 set(CZICMD_USE_LIBPNG 0)
+set(CZICMD_WINDOWSAPIAVAILABLE 0)
 
 IF (FREETYPE_FOUND)
 	set(CZICMD_USE_FREETYPE 1)
@@ -139,7 +136,8 @@ IF(PNG_FOUND)
 	set(CZICMD_LIBPNG_VERSION_STRING "${PNG_VERSION_STRING}")
 ENDIF()
 
-IF(WIN32)
+IF(LIBCZI_HAVE_WIN32_API)
+  set(CZICMD_WINDOWSAPIAVAILABLE 1)
 	set(CZICMD_USE_WIC 1)
 	set(CZICMD_USE_GDIPLUS 1)
 ENDIF()

diff --git a/Src/CZICmd/CZIcmd.cpp b/Src/CZICmd/CZIcmd.cpp
@@ -2,18 +2,13 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
+#include "inc_CZIcmd_Config.h"
 #include "consoleio.h"
 #include "cmdlineoptions.h"
 #include "execute.h"
 #include "inc_libCZI.h"
-
-#if defined(LINUXENV)
 #include <clocale>
-#endif
-
-#if defined(WIN32ENV)
-#define NOMINMAX
+#if CZICMD_WINDOWSAPI_AVAILABLE
 #include <Windows.h>
 #endif
 
@@ -24,7 +19,7 @@ class CLibCZISite : public libCZI::ISite
 public:
     explicit CLibCZISite(const CCmdLineOptions& opts) : options(opts)
     {
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
         if (options.GetUseWICJxrDecoder())
         {
             this->pSite = libCZI::GetDefaultSiteObject(libCZI::SiteObjectType::WithWICDecoder);
@@ -61,11 +56,10 @@ class CLibCZISite : public libCZI::ISite
 
 int main(int argc, char** _argv)
 {
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
     CoInitialize(NULL);
     CommandlineArgsWindowsHelper args_helper;
-#endif
-#if defined(LINUXENV)
+#else
     setlocale(LC_CTYPE, "");
 #endif
 
@@ -74,7 +68,7 @@ int main(int argc, char** _argv)
     try
     {
         CCmdLineOptions options(log);
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
         auto cmdLineParseResult = options.Parse(args_helper.GetArgc(), args_helper.GetArgv());
 #else
         auto cmdLineParseResult = options.Parse(argc, _argv);
@@ -110,7 +104,7 @@ int main(int argc, char** _argv)
         retVal = 1;
     }
 
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
     CoUninitialize();
 #endif
 

diff --git a/Src/CZICmd/CZIcmd_Config.h.in b/Src/CZICmd/CZIcmd_Config.h.in
@@ -4,6 +4,9 @@
 
 #pragma once
 
+// whether Win32-API can be used
+#define CZICMD_WINDOWSAPI_AVAILABLE     @CZICMD_WINDOWSAPIAVAILABLE@
+
 #define CZICMD_USE_WIC						      @CZICMD_USE_WIC@
 
 #define CZICMD_USE_LIBPNG					      @CZICMD_USE_LIBPNG@

diff --git a/Src/CZICmd/SaveBitmap.cpp b/Src/CZICmd/SaveBitmap.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "SaveBitmap.h"
 #include <fstream>
 #include <stdexcept>

diff --git a/Src/CZICmd/cmdlineoptions.cpp b/Src/CZICmd/cmdlineoptions.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "cmdlineoptions.h"
 #include "inc_libCZI.h"
 #include <clocale>

diff --git a/Src/CZICmd/consoleio.cpp b/Src/CZICmd/consoleio.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include <cstdarg>
 #include "consoleio.h"
 #include <iostream>

diff --git a/Src/CZICmd/consoleio.h b/Src/CZICmd/consoleio.h
@@ -4,6 +4,9 @@
 
 #pragma once
 
+#include <string>
+#include <memory>
+
 class ILog
 {
 public:

diff --git a/Src/CZICmd/execute.cpp b/Src/CZICmd/execute.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "execute.h"
 #include "executeBase.h"
 #include "executeCreateCzi.h"

diff --git a/Src/CZICmd/executeCreateCzi.cpp b/Src/CZICmd/executeCreateCzi.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "executeCreateCzi.h"
 #include "IBitmapGen.h"
 #include "inc_libCZI.h"

diff --git a/Src/CZICmd/executePlaneScan.cpp b/Src/CZICmd/executePlaneScan.cpp
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
 #include "executePlaneScan.h"
 #include "executeBase.h"
 #include "SaveBitmap.h"

diff --git a/Src/CZICmd/inc_rapidjson.h b/Src/CZICmd/inc_rapidjson.h
@@ -4,7 +4,7 @@
 
 #pragma once
 
-#define RAPIDJSON_HAS_STDSTRING (1)
+#define RAPIDJSON_HAS_STDSTRING 1
 
 #include <rapidjson/document.h>
 #include <rapidjson/prettywriter.h>

diff --git a/Src/CZICmd/platform_defines.h b/Src/CZICmd/platform_defines.h
diff --git a/Src/CZICmd/stdafx.cpp b/Src/CZICmd/stdafx.cpp
diff --git a/Src/CZICmd/stdafx.h b/Src/CZICmd/stdafx.h
diff --git a/Src/CZICmd/targetver.h b/Src/CZICmd/targetver.h
diff --git a/Src/CZICmd/utils.cpp b/Src/CZICmd/utils.cpp
@@ -2,13 +2,13 @@
 //
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
-#include "stdafx.h"
+#include "inc_CZIcmd_Config.h"
 #include "utils.h"
 #include <cwctype>
 #include <iomanip>
 #include <regex>
 
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
 #define HAS_CODECVT
 #include <Windows.h>
 #endif
@@ -434,7 +434,7 @@ bool TryParseGuid(const std::wstring& str, libCZI::GUID* outGuid)
     return false;
 }
 
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
 CommandlineArgsWindowsHelper::CommandlineArgsWindowsHelper()
 {
     int number_arguments;

diff --git a/Src/CZICmd/utils.h b/Src/CZICmd/utils.h
@@ -4,6 +4,7 @@
 
 #pragma once
 
+#include "inc_CZIcmd_Config.h"
 #include <string>
 #include <vector>
 #include "inc_libCZI.h"
@@ -78,7 +79,7 @@ inline final_act<F> finally(F&& f) noexcept
     return final_act<F>(std::forward<F>(f));
 }
 
-#if defined(WIN32ENV)
+#if CZICMD_WINDOWSAPI_AVAILABLE
 /// A utility which is providing the command-line arguments (on Windows) as UTF8-encoded strings.
 class CommandlineArgsWindowsHelper
 {