build(CMakeLists.txt): small changes + improved install targets

Author: Electron7-7

CMakeLists.txt

@@ -1,23 +1,27 @@
 cmake_minimum_required(VERSION 3.30.0..4.3.0)
 project(Nostalgia
-    VERSION 0.1.1
+    VERSION 0.1.3
     LANGUAGES CXX C)
 
 option(BUILD_SHARED_LIBS "Build the shared version of Nostalgia" OFF)
+option(NOSTALGIA_INSTALL "Generate install targets" ON)
 option(NOSTALGIA_INCLUDE_GLM_HEADERS "When installing Nostalgia's headers, include Nostalgia/thirdparty/glm" ON)
 option(NOSTALGIA_INCLUDE_JOLT_HEADERS "When installing Nostalgia's headers, include Nostalgia/thirdparty/Jolt" ON)
+option(NOSTALGIA_ADD_SUFFIX_TO_DEBUG_BUILD "When building the debug version of Nostalgia, name the library 'NostalgiaDebug'" ON)
 
-set(NOSTALGIA_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/Nostalgia")
-set(NOSTALGIA_PCH_SRC ${NOSTALGIA_ROOT}/Nostalgia.hpp)
-
-# taken from brotli
 if(NOT CMAKE_BUILD_TYPE)
-    message(STATUS "Setting build type to Release as none was specified")
     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build" FORCE)
-else()
-    message(STATUS "Build type is '${CMAKE_BUILD_TYPE}'")
+endif()
+message(STATUS "Build type is '${CMAKE_BUILD_TYPE}'")
+
+if(${NOSTALGIA_ADD_SUFFIX_TO_DEBUG_BUILD} AND "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
+    set(NOSTALGIA_LIB_VERSION_SUFFIX Debug)
 endif()
 
+set(NOSTALGIA_LIBRARY_NAME Nostalgia${NOSTALGIA_LIB_VERSION_SUFFIX})
+set(NOSTALGIA_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/Nostalgia)
+set(NOSTALGIA_PCH_SRC ${NOSTALGIA_ROOT}/Nostalgia.hpp)
+
 if(MSVC)
     set(NOSTALGIA_JPH_DEFINITIONS JPH_PROFILE_ENABLED JPH_USE_DX12)
 else()
@@ -32,12 +36,22 @@ add_custom_target(EmbedAssets
 include(Sources.cmake)
 include(Thirdparty.cmake)
 
-add_library(Nostalgia ${LIBRARY_VERSION} ${NOSTALGIA_SRC_FILES} ${NOSTALGIA_OBJ_FILES})
-add_dependencies(Nostalgia EmbedAssets)
-target_compile_definitions(Nostalgia PUBLIC
+add_library(${NOSTALGIA_LIBRARY_NAME} ${LIBRARY_VERSION} ${NOSTALGIA_SRC_FILES} ${NOSTALGIA_OBJ_FILES})
+add_dependencies(${NOSTALGIA_LIBRARY_NAME}
+    EmbedAssets
+    freetype-object
+    zlib-object
+    bz2-object
+    brotlicommon-object
+    brotlidec-object
+    brotlienc-object
+    png-object
+    glfw-object
+    Jolt-object)
+target_compile_definitions(${NOSTALGIA_LIBRARY_NAME} PUBLIC
     ${NOSTALGIA_VERSION_DEFINITION}
     ${NOSTALGIA_JPH_DEFINITIONS})
-target_link_libraries(Nostalgia PRIVATE
+target_link_libraries(${NOSTALGIA_LIBRARY_NAME} PRIVATE
     freetype-object
     zlib-object
     bz2-object
@@ -48,10 +62,10 @@ target_link_libraries(Nostalgia PRIVATE
     glfw-object
     Jolt-object)
 
-target_precompile_headers(Nostalgia PUBLIC
+target_precompile_headers(${NOSTALGIA_LIBRARY_NAME} PUBLIC
     "$<$<COMPILE_LANGUAGE:CXX>:${NOSTALGIA_PCH_SRC}>"
     "$<$<COMPILE_LANGUAGE:C>:<stddef.h$<ANGLE-R>>")
-target_include_directories(Nostalgia
+target_include_directories(${NOSTALGIA_LIBRARY_NAME}
     PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
     PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
     PUBLIC ${NOSTALGIA_ROOT}
@@ -67,28 +81,36 @@ if(NOSTALGIA_INCLUDE_JOLT_HEADERS)
     set(NOSTALGIA_HEADERS ${NOSTALGIA_HEADERS} ${NOSTALGIA_JOLT_HEADERS})
 endif()
 
-if(UNIX)
-    install(TARGETS Nostalgia DESTINATION lib)
-
+if(NOSTALGIA_INSTALL)
     # Stolen from JoltPhysics/Build/CMakeLists.txt:338-345
     foreach(HEADER_FILE ${NOSTALGIA_HEADERS})
         string(REPLACE ${NOSTALGIA_ROOT} "Nostalgia" RELATIVE_HEADER_FILE ${HEADER_FILE})
         get_filename_component(DESTINATION_PATH ${RELATIVE_HEADER_FILE} DIRECTORY)
         cmake_path(SET DST_FILE NORMALIZE "${CMAKE_INSTALL_INCLUDEDIR}/${DESTINATION_PATH}")
         install(FILES ${HEADER_FILE} DESTINATION ${DST_FILE})
     endforeach()
+    # Install the engine last; this lets users install headers without building the library
+    # it also lets the more important build message show up at the bottom.
+    if(WIN32)
+        install(TARGETS ${NOSTALGIA_LIBRARY_NAME})
+        set(_install_dir ${CMAKE_INSTALL_PREFIX})
+    else()
+        install(TARGETS ${NOSTALGIA_LIBRARY_NAME} DESTINATION lib)
+        set(_install_dir ${CMAKE_INSTALL_PREFIX}/lib)
+    endif()
+    message(STATUS "Library Install Dir: ${_install_dir}")
+    message(STATUS "Headers Install Dir: ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}")
 endif()
 
-
 ################
 #### EDITOR ####
 ################
 set(EDITOR_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/Editor)
 
 if(BUILD_SHARED_LIBS)
-    set(EDITOR_ENGINE_LIBRARY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_SHARED_LIBRARY_PREFIX}Nostalgia${CMAKE_SHARED_LIBRARY_SUFFIX})
+    set(EDITOR_ENGINE_LIBRARY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_SHARED_LIBRARY_PREFIX}${NOSTALGIA_LIBRARY_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
 else()
-    set(EDITOR_ENGINE_LIBRARY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_STATIC_LIBRARY_PREFIX}Nostalgia${CMAKE_STATIC_LIBRARY_SUFFIX})
+    set(EDITOR_ENGINE_LIBRARY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_STATIC_LIBRARY_PREFIX}${NOSTALGIA_LIBRARY_NAME}${CMAKE_STATIC_LIBRARY_SUFFIX})
 endif()
 
 if(WIN32 OR MINGW)
@@ -98,36 +120,37 @@ else()
 endif()
 
 add_executable(NostalgiaGoggles ${EDITOR_SRC_FILES})
+add_dependencies(NostalgiaGoggles ${NOSTALGIA_LIBRARY_NAME})
 target_include_directories(NostalgiaGoggles
     PRIVATE ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} ${EDITOR_ROOT}/thirdparty/freetype
     PUBLIC ${EDITOR_ROOT} ${EDITOR_ROOT}/thirdparty ${NOSTALGIA_ROOT}/thirdparty/JoltPhysics)
 target_link_directories(NostalgiaGoggles PUBLIC ${CMAKE_CURRENT_BINARY_DIR} ${EDITOR_LIBRARIES_DIR})
 target_link_libraries(NostalgiaGoggles PUBLIC ${EDITOR_ENGINE_LIBRARY} getargs)
 
 if(MSVC)
-    target_compile_features(Nostalgia PUBLIC cxx_std_23)
+    target_compile_features(${NOSTALGIA_LIBRARY_NAME} PUBLIC cxx_std_23)
     target_compile_features(NostalgiaGoggles PUBLIC cxx_std_23)
-    set_property(TARGET Nostalgia PROPERTY
+    set_property(TARGET ${NOSTALGIA_LIBRARY_NAME} PROPERTY
         MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
     set_property(TARGET NostalgiaGoggles PROPERTY
         MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
     set_property(TARGET Jolt PROPERTY
         MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 else()
-    target_compile_features(Nostalgia PUBLIC cxx_std_26)
+    target_compile_features(${NOSTALGIA_LIBRARY_NAME} PUBLIC cxx_std_26)
     target_compile_features(NostalgiaGoggles PUBLIC cxx_std_26)
 endif()
 
 if(MINGW)
     # std:: print, println, ...
-    target_link_libraries(Nostalgia PUBLIC stdc++exp)
+    target_link_libraries(${NOSTALGIA_LIBRARY_NAME} PUBLIC stdc++exp)
     target_link_libraries(NostalgiaGoggles PUBLIC stdc++exp)
 endif()
 
-if(${CMAKE_BUILD_TYPE} STREQUAL Debug)
+if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
     if(NOT MSVC AND ${CMAKE_CXX_COMPILER_ID} EQUAL Clang)
-        target_compile_options(Nostalgia PUBLIC -Wall -O0 -g -fsanitize=address)
-        target_link_options(Nostalgia PUBLIC -Wall -O0 -g -fsanitize=address)
+        target_compile_options(${NOSTALGIA_LIBRARY_NAME} PUBLIC -Wall -O0 -g -fsanitize=address)
+        target_link_options(${NOSTALGIA_LIBRARY_NAME} PUBLIC -Wall -O0 -g -fsanitize=address)
         target_compile_options(NostalgiaGoggles PUBLIC -Wall -O0 -g -fsanitize=address)
         target_link_options(NostalgiaGoggles PUBLIC -Wall -O0 -g -fsanitize=address)
     endif()