Better CMake Defaults (#10294)

* Auto generate CMAKE_PREFIX_PATH/DESTDIR

* Auto set CMAKE_INSTALL_PREFIX

* Always default SLIC3R_STATIC to on

* Only allow one value for CMAKE_OSX_ARCHITECTURES

* Set arch for OpenSSL from CMAKE_OSX_ARCHITECTURES

* Set CMAKE_INSTALL_RPATH from CMAKE_PREFIX_PATH

* Default CMAKE_MACOSX_RPATH and CMAKE_MACOSX_BUNDLE to on

* Auto set BBL_RELEASE_TO_PUBLIC based on build config

* Default to GTK 3

* Fix linux debug build

Update find modules to also look for the debug variant of the libraries

* Set DEP_DEBUG and ORCA_INCLUDE_DEBUG_INFO based on CMAKE_BUILD_TYPE

* Add a fallback value for Windows SDK if the env variables are not set

* Reflect CMake changes in the build scripts

* Add missing line

* Fix auto setting DEP_DEBUG and ORCA_INCLUDE_DEBUG_INFO

* Update dep folder name for linux in GH actions

* Invert dep-folder-name conditions

`''` is considered a falsy value, which was causing the value to always be set to 'OrcaSlicer_dep'

* Properly handle finding the debug version of libnoise

* Convert FindNLopt.cmake to a config mode wrapper

* Use separate build directory for debug builds on Linux

* Move find_package for libnoise

* Cleanup and improve linux build script

- Add dry run
- Add build in RelWithDebInfo
- Add function to print and run commands

* Remove linux destdir deprecation and cleanup

* Fix flatpak build

* Disable fail fast for flatpak builds

* Flatpak improvements

- Build wxWidgets using deps cmake
- Improve handling of space freeing commands while building deps
- Allow cmake to directly download deps
- Set needed flags within cmake instead of the build manifest

* Print clean build commands

* Implement shellcheck recommendations

* Cleanup

* Fix CMakeLists.txt syntax by replacing empty elseif with else statement

---------

Co-authored-by: SoftFever <softfeverever@gmail.com>

deps/CMakeLists.txt

@@ -36,6 +36,11 @@ endif()
 
 project(OrcaSlicer-deps)
 
+# Backward compatibility for old CMake versions
+if (CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_VERSION VERSION_LESS "3.25")
+    set(LINUX ON CACHE BOOL "" FORCE)
+endif ()
+
 include(ExternalProject)
 include(ProcessorCount)
 
@@ -44,9 +49,36 @@ if (NPROC EQUAL 0)
     set(NPROC 1)
 endif ()
 
-set(DESTDIR "${CMAKE_CURRENT_BINARY_DIR}/destdir" CACHE PATH "Destination directory")
 set(DEP_DOWNLOAD_DIR ${CMAKE_CURRENT_SOURCE_DIR}/DL_CACHE CACHE PATH "Path for downloaded source packages.")
 set(FLATPAK FALSE CACHE BOOL "Toggles various build settings for flatpak, like /usr/local in DESTDIR or not building wxwidgets")
+
+if ("${DESTDIR}" STREQUAL "" OR "${DESTDIR}" STREQUAL "${AUTOGENERATED_DESTDIR}")
+    if (LINUX AND (NOT DEFINED USE_OLD_DESTDIR_PREV OR USE_OLD_DESTDIR_PREV) AND EXISTS "${CMAKE_BINARY_DIR}/destdir/usr/local" AND NOT EXISTS "${CMAKE_BINARY_DIR}/OrcaSlicer_dep/usr/local")
+        set(USE_OLD_DESTDIR TRUE)
+        message(WARNING "You are using an old directory name for dependencies that is being deprecated. "
+                "Please remove the \"destdir\" directory and rebuild to update to the new name. "
+                "The current \"destdir\" directory will be used until then.")
+    endif ()
+    if (NOT USE_OLD_DESTDIR AND USE_OLD_DESTDIR_PREV)
+        set(REGEN_DESTDIR TRUE)
+    endif ()
+else ()
+    unset(AUTOGENERATED_DESTDIR CACHE)
+endif ()
+
+if ("${DESTDIR}" STREQUAL "" OR REGEN_DESTDIR)
+    if (USE_OLD_DESTDIR) # backward compatibility for old directory name
+        set(DESTDIR "${CMAKE_BINARY_DIR}/destdir" CACHE PATH "Path to dependencies install directory" FORCE)
+    else ()
+        set(DESTDIR "${CMAKE_BINARY_DIR}/OrcaSlicer_dep" CACHE PATH "Path to dependencies install directory" FORCE)
+    endif ()
+    set(DESTDIR_MSG "(generated automatically and saved to cache)")
+    set(AUTOGENERATED_DESTDIR ${DESTDIR} CACHE STRING "Provides the last autogenerated destdir" FORCE)
+    unset(REGEN_DESTDIR CACHE)
+else ()
+    set(DESTDIR_MSG "(from cache or command line)")
+endif ()
+
 if (NOT FLATPAK)
     set(DESTDIR "${DESTDIR}/usr/local/")
 endif()
@@ -56,15 +88,32 @@ get_property(_is_multi GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
 if (_is_multi)
     option(DEP_DEBUG "Build debug variants (only applicable on Windows)" OFF)
     option(ORCA_INCLUDE_DEBUG_INFO "Includes debug information in a release build (like RelWithDebInfo) in a way that works with multi-configuration generators and incompatible dependencies. DEP_DEBUG option takes priority over this." OFF)
+    option(AUTO_DEBUG_WORKAROUND "Automatically sets DEP_DEBUG and ORCA_INCLUDE_DEBUG_INFO based on CMAKE_BUILD_TYPE" ON)
+
+    if (AUTO_DEBUG_WORKAROUND)
+        set(DEP_DEBUG OFF)
+        set(ORCA_INCLUDE_DEBUG_INFO OFF)
+        if (CMAKE_BUILD_TYPE STREQUAL "Debug")
+            set(DEP_DEBUG ON)
+            message(STATUS "DEP_DEBUG has been automatically turned ON due to CMAKE_BUILD_TYPE being set to Debug")
+        elseif (CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
+            set(ORCA_INCLUDE_DEBUG_INFO ON)
+            message(STATUS "ORCA_INCLUDE_DEBUG_INFO has been automatically turned ON due to CMAKE_BUILD_TYPE being set to RelWithDebInfo")
+        endif ()
+    endif ()
 endif ()
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
-    option(DEP_WX_GTK3 "Build wxWidgets against GTK3" OFF)
+    option(DEP_WX_GTK3 "Build wxWidgets against GTK3" ON)
 endif()
 
 set(IS_CROSS_COMPILE FALSE)
 
 if (APPLE)
+    list(LENGTH CMAKE_OSX_ARCHITECTURES _arch_len)
+    if (_arch_len GREATER 1)
+        message(FATAL_ERROR "OrcaSlicer only supports building for one architecture at a time. Please make sure only one architecture is specified in CMAKE_OSX_ARCHITECTURES")
+    endif ()
     set(CMAKE_FIND_FRAMEWORK LAST)
     set(CMAKE_FIND_APPBUNDLE LAST)
     list(FIND CMAKE_OSX_ARCHITECTURES ${CMAKE_SYSTEM_PROCESSOR} _arch_idx)
@@ -87,7 +136,7 @@ endif ()
 # Slic3r compiles with a different version which will cause runtime errors.
 # option(DEP_BUILD_IGL_STATIC "Build IGL as a static library. Might cause link errors and increase binary size." OFF)
 
-message(STATUS "OrcaSlicer deps DESTDIR: ${DESTDIR}")
+message(STATUS "OrcaSlicer deps DESTDIR: ${DESTDIR} ${DESTDIR_MSG}")
 message(STATUS "OrcaSlicer download dir for source packages: ${DEP_DOWNLOAD_DIR}")
 message(STATUS "OrcaSlicer deps debug build: ${DEP_DEBUG}")
 
@@ -144,39 +193,26 @@ if (NOT IS_CROSS_COMPILE OR NOT APPLE)
        BUILD_COMMAND ${CMAKE_COMMAND} --build . --config Release -- ${_build_j}
        INSTALL_COMMAND ${CMAKE_COMMAND} --build . --target install --config Release
     )
-elseif(FLATPAK)
-    # the only reason this is here is because of the HACK at the bottom for ci
-    #
-    # note for future devs: shared libs may actually create a size reduction
-    # but orcaslicer_deps tends to get really funny regarding linking after that (notably boost)
-    # so, as much as I would like to use that, it's not happening
-    ExternalProject_Add(
-        dep_${projectname}
-        EXCLUDE_FROM_ALL    ON
-        INSTALL_DIR         ${DESTDIR}
-        DOWNLOAD_DIR        ${DEP_DOWNLOAD_DIR}/${projectname}
-        ${_gen}
-        CMAKE_ARGS
-            -DCMAKE_INSTALL_PREFIX:STRING=${DESTDIR}
-            -DCMAKE_MODULE_PATH:STRING=${PROJECT_SOURCE_DIR}/../cmake/modules
-            -DCMAKE_PREFIX_PATH:STRING=${DESTDIR}
-            -DCMAKE_DEBUG_POSTFIX:STRING=d
-            -DCMAKE_C_COMPILER:STRING=${CMAKE_C_COMPILER}
-            -DCMAKE_CXX_COMPILER:STRING=${CMAKE_CXX_COMPILER}
-            -DCMAKE_TOOLCHAIN_FILE:STRING=${CMAKE_TOOLCHAIN_FILE}
-            -DBUILD_SHARED_LIBS:BOOL=OFF
-            ${_cmake_osx_arch}
-            "${_configs_line}"
-            ${DEP_CMAKE_OPTS}
-            ${P_ARGS_CMAKE_ARGS}
-       ${P_ARGS_UNPARSED_ARGUMENTS}
-       BUILD_COMMAND ${CMAKE_COMMAND} --build . --config Release -- ${_build_j}
-       INSTALL_COMMAND ${CMAKE_COMMAND} --build . --target install --config Release
-       # HACK: save space after each compile job, because CI
-       # reasoning: cmake changes directory after this command, so just keep only the folders
-       # so that it can navigate out
-       COMMAND find "${CMAKE_BINARY_DIR}/dep_${projectname}-prefix/" -type f -delete
-    )
+
+    if (FLATPAK)
+        # Free up space during flatpak builds to prevent running out of space during CI/CD
+
+        # note for future devs: shared libs may actually create a size reduction
+        # but orcaslicer_deps tends to get really funny regarding linking after that (notably boost)
+        # so, as much as I would like to use that, it's not happening
+        ExternalProject_Add_Step(dep_${projectname} free_download_space
+                DEPENDEES download # do after download
+                COMMENT "Freeing Space: Removing source archive"
+                WORKING_DIRECTORY ${DEP_DOWNLOAD_DIR}
+                COMMAND ${CMAKE_COMMAND} -E rm -r ${projectname}
+        )
+        ExternalProject_Add_Step(dep_${projectname} free_build_space
+                DEPENDEES install # do after install
+                COMMENT "Freeing Space: Removing source and build files"
+                WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/dep_${projectname}-prefix/src
+                COMMAND ${CMAKE_COMMAND} -E rm -rf dep_${projectname} dep_${projectname}-build
+        )
+    endif ()
 else()
     ExternalProject_Add(
         dep_${projectname}
@@ -320,10 +356,10 @@ if (NOT JPEG_FOUND)
     set(JPEG_PKG dep_JPEG)
 endif()
 
-# flatpak builds wxwidgets separately 
+# flatpak builds wxwidgets separately, so it is not included in the deps target
 set(WXWIDGETS_PKG "")
+include(wxWidgets/wxWidgets.cmake)
 if (NOT FLATPAK)
-    include(wxWidgets/wxWidgets.cmake)
     set(WXWIDGETS_PKG "dep_wxWidgets")
 endif()
 

deps/OpenSSL/OpenSSL.cmake

@@ -8,7 +8,7 @@ else()
     if(WIN32)
         set(_cross_arch "VC-WIN64A")
     elseif(APPLE)
-        set(_cross_arch "darwin64-arm64-cc")
+        set(_cross_arch "darwin64-${CMAKE_OSX_ARCHITECTURES}-cc")
 	endif()
 endif()
 

deps/wxWidgets/wxWidgets.cmake

@@ -1,5 +1,7 @@
 set(_wx_toolkit "")
-set(_wx_private_font "-DwxUSE_PRIVATE_FONTS=1")
+set(_wx_debug_postfix "")
+set(_wx_shared -DwxBUILD_SHARED=OFF)
+set(_wx_flatpak_patch "")
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
     set(_gtk_ver 2)
@@ -9,6 +11,11 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
     endif ()
 
     set(_wx_toolkit "-DwxBUILD_TOOLKIT=gtk${_gtk_ver}")
+    if (FLATPAK)
+        set(_wx_debug_postfix "d")
+        set(_wx_shared -DwxBUILD_SHARED=ON -DBUILD_SHARED_LIBS:BOOL=ON)
+        set(_wx_flatpak_patch PATCH_COMMAND ${PATCH_CMD} ${CMAKE_CURRENT_LIST_DIR}/0001-flatpak.patch)
+    endif ()
 endif()
 
 if (MSVC)
@@ -17,34 +24,29 @@ else ()
     set(_wx_edge "-DwxUSE_WEBVIEW_EDGE=OFF")
 endif ()
 
-# Note: The flatpak build builds wxwidgets separately due to CI size constraints.
-# ANY CHANGES MADE IN HERE MUST ALSO BE REFLECTED IN `scripts/flatpak/io.github.SoftFever.OrcaSlicer.yml`.
-# ** THIS INCLUDES BUILD ARGS. **
-# ...if you can find a way around this size limitation, be my guest.
-
 orcaslicer_add_cmake_project(
     wxWidgets
     GIT_REPOSITORY "https://github.com/SoftFever/Orca-deps-wxWidgets"
     GIT_SHALLOW ON
     DEPENDS ${PNG_PKG} ${ZLIB_PKG} ${EXPAT_PKG} ${JPEG_PKG}
+    ${_wx_flatpak_patch}
     CMAKE_ARGS
         -DwxBUILD_PRECOMP=ON
         ${_wx_toolkit}
-        "-DCMAKE_DEBUG_POSTFIX:STRING="
+        "-DCMAKE_DEBUG_POSTFIX:STRING=${_wx_debug_postfix}"
         -DwxBUILD_DEBUG_LEVEL=0
         -DwxBUILD_SAMPLES=OFF
-        -DwxBUILD_SHARED=OFF
+        ${_wx_shared}
         -DwxUSE_MEDIACTRL=ON
         -DwxUSE_DETECT_SM=OFF
         -DwxUSE_UNICODE=ON
-        ${_wx_private_font}
+        -DwxUSE_PRIVATE_FONTS=ON
         -DwxUSE_OPENGL=ON
         -DwxUSE_WEBREQUEST=ON
         -DwxUSE_WEBVIEW=ON
         ${_wx_edge}
         -DwxUSE_WEBVIEW_IE=OFF
         -DwxUSE_REGEX=builtin
-        -DwxUSE_LIBXPM=builtin
         -DwxUSE_LIBSDL=OFF
         -DwxUSE_XTEST=OFF
         -DwxUSE_STC=OFF
@@ -53,7 +55,6 @@ orcaslicer_add_cmake_project(
         -DwxUSE_ZLIB=sys
         -DwxUSE_LIBJPEG=sys
         -DwxUSE_LIBTIFF=OFF
-        -DwxUSE_NANOSVG=OFF
         -DwxUSE_EXPAT=sys
 )