Change how the bin/lib paths are set throughout CMakeLists

This should resovle #601, but standalone repos and the visualisation may also benefit from being updated.
FLAMEGPU · Aug 25, 2021 · ad05192 · ad05192
1 parent 643acde
commit ad05192
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 130 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -138,6 +138,9 @@ endif()
 # Control target CUDA_ARCH to compile for
 SET(CUDA_ARCH "${CUDA_ARCH}" CACHE STRING "List of CUDA Architectures to target. E.g. 61;70" FORCE)
 
+# Set the lib and bin dirs early, so they do not need re-setting
+include(cmake/set_output_directories.cmake)
+
 # Define a function to add a lint target.
 find_file(CPPLINT NAMES cpplint cpplint.exe)
 if(CPPLINT)

diff --git a/cmake/Tinyxml2.cmake b/cmake/Tinyxml2.cmake
@@ -33,16 +33,6 @@ if(NOT tinyxml2_POPULATED)
         # @todo - make a dynamically generated CMakeLists.txt which can be add_subdirectory'd instead, so that the .vcxproj goes in a folder. Just adding a project doesn't work.
         # project(tinyxml2 LANGUAGES CXX)
 
-        # Set location of static library files
-        # Define output location of static library
-        if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-            # If top level project
-            SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib/${CMAKE_BUILD_TYPE}/)
-        else()
-            # If called via add_subdirectory()
-            SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../lib/${CMAKE_BUILD_TYPE}/)
-        endif()
-
         # Depends on the cpp and header files in case of changes
         add_library(tinyxml2 STATIC ${tinyxml2_SOURCE_DIR}/tinyxml2.cpp ${tinyxml2_SOURCE_DIR}/tinyxml2.h)
         # Pic is sensible for any library

diff --git a/cmake/common.cmake b/cmake/common.cmake
@@ -10,6 +10,7 @@ set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/modules/ ${CMAKE_MODULE_PATH})
 # Uses -DCUDA_ARCH values (and modifies if appropriate). 
 # Adds -gencode argumetns to CMAKE_CUDA_FLAGS
 # Adds -DMIN_COMPUTE_CAPABILITY=VALUE macro to CMAKE_CC_FLAGS, CMAKE_CXX_FLAGS and CMAKE_CUDA_FLAGS.
+include(${CMAKE_CURRENT_LIST_DIR}/set_output_directories.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/cuda_arch.cmake)
 
 # Ensure that other dependencies are downloaded and available. 

diff --git a/cmake/set_output_directories.cmake b/cmake/set_output_directories.cmake
@@ -0,0 +1,14 @@
+# Set the locations of ARCHIVE (.lib/.a), LIBRARY (MODULE .dll/.so, SHARED.so) and BINARY (.dll,.exe/binary)
+
+# Only set these if they have not already been set.
+# Set them to be relative to the Project Source directory, i.e. the location of the first call to CMake
+#   CMAKE_BINARY_DIR is the top level build directory, so this should achieve the desired effect regardless of whether add_subdirectory is used or not.
+if(NOT CMAKE_ARCHIVE_OUTPUT_DIRECTORY)
+    set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/$<CONFIG>)
+endif()
+if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/$<CONFIG>)
+endif()
+if(NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY)
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin/$<CONFIG>)
+endif()
diff --git a/examples/boids_bruteforce/CMakeLists.txt b/examples/boids_bruteforce/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/boids_bruteforce_dependency_graph/CMakeLists.txt b/examples/boids_bruteforce_dependency_graph/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/boids_rtc_bruteforce/CMakeLists.txt b/examples/boids_rtc_bruteforce/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/boids_rtc_spatial3D/CMakeLists.txt b/examples/boids_rtc_spatial3D/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/boids_spatial3D/CMakeLists.txt b/examples/boids_spatial3D/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/circles_bruteforce/CMakeLists.txt b/examples/circles_bruteforce/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/circles_spatial3D/CMakeLists.txt b/examples/circles_spatial3D/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/ensemble/CMakeLists.txt b/examples/ensemble/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/game_of_life/CMakeLists.txt b/examples/game_of_life/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/host_functions/CMakeLists.txt b/examples/host_functions/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/examples/sugarscape/CMakeLists.txt b/examples/sugarscape/CMakeLists.txt
@@ -10,15 +10,6 @@ get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../.. REALPATH)
 # Include common rules.
 include(${FLAMEGPU_ROOT}/cmake/common.cmake)
 
-# Define output location of binary files
-if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-    # If top level project
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-else()
-    # If called via add_subdirectory()
-    SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../../bin/${CMAKE_BUILD_TYPE}/)
-endif()
-
 # Prepare list of source files
 # Can't do this automatically, as CMake wouldn't know when to regen (as CMakeLists.txt would be unchanged)
 SET(ALL_SRC

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -59,16 +59,14 @@ set(DYNAMIC_VERSION_HEADER_SRC "${FLAMEGPU_ROOT}/cmake/version.h.in")
 set(DYNAMIC_VERSION_HEADER_DEST "${FLAMEGPU_ROOT}/include/flamegpu/version.h")
 configure_file(${DYNAMIC_VERSION_HEADER_SRC} ${DYNAMIC_VERSION_HEADER_DEST})
 
-# Define output location of static library
+# Define output location of the doxygen target
 if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
     # If top level project
-    SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/lib/${CMAKE_BUILD_TYPE}/)
     if(${BUILD_API_DOCUMENTATION})
         create_doxygen_target("${FLAMEGPU_ROOT}" "${CMAKE_CURRENT_BINARY_DIR}" "")
     endif()
 else()
     # If called via add_subdirectory()
-    SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../lib/${CMAKE_BUILD_TYPE}/)
     if(${BUILD_API_DOCUMENTATION})
         create_doxygen_target("${FLAMEGPU_ROOT}" "${CMAKE_CURRENT_BINARY_DIR}/.." "")
     endif()

diff --git a/swig/python/CMakeLists.txt b/swig/python/CMakeLists.txt
@@ -4,6 +4,8 @@
 # Just include cuda_arch to suppress CMAKE 3.18 warnings on windows (where nvcc is used even when not neccesary)
 get_filename_component(FLAMEGPU_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../ REALPATH)
 
+# Set binary/library/archive output directories if not already set.
+include(${FLAMEGPU_ROOT}/cmake/set_output_directories.cmake)
 # Set CUDA gencode arguments
 include(${FLAMEGPU_ROOT}/cmake/cuda_arch.cmake)
 # Set the C++ and CUDA standard to use
@@ -34,11 +36,13 @@ endif()
 # Set the output directory where the wheel etc should be placed.
 # CMAKE 3.20 is required for byproducts contianing $<CONFIG> (i.e. multiconfig generators.) Workaround by only setting if supported, or usiing CMAKE_BUILD_TYPE for non-multi-generators.
 # This is required for msvc multi-generator usage. For older cmake and non-mulit-config generators CMAKE_BUILD_TYPE can be used instead.
-SET(PYTHON_LIB_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/$<CONFIG>/python)
+SET(PYTHON_LIB_OUTPUT_DIRECTORY ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/python)
 SET(PYTHON_LIB_OUTPUT_DIRECTORY_BYPRODUCTS TRUE)
 if(${CMAKE_VERSION} VERSION_LESS "3.20")
   if(NOT ${GENERATOR_IS_MULTI_CONFIG})
-    SET(PYTHON_LIB_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/${CMAKE_BUILD_TYPE}/python)
+    string(REPLACE "$<CONFIG>" "${CMAKE_BUILD_TYPE}" PYTHON_LIB_OUTPUT_DIRECTORY "${PYTHON_LIB_OUTPUT_DIRECTORY}")
+    message("PYTHON_LIB_OUTPUT_DIRECTORY ${PYTHON_LIB_OUTPUT_DIRECTORY}")
+    # SET(PYTHON_LIB_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/${CMAKE_BUILD_TYPE}/python)
   else()
     SET(PYTHON_LIB_OUTPUT_DIRECTORY_BYPRODUCTS FALSE)
   endif()

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -104,14 +104,6 @@ if(BUILD_TESTS)
         ${TESTS_SRC}
         ${HELPERS_SRC}
     )
-    # Define output location of binary files
-    if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-        # If top level project
-        SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-    else()
-        # If called via add_subdirectory()
-        SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../bin/${CMAKE_BUILD_TYPE}/)
-    endif()
     # Enable parallel compilation
     if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP")
@@ -144,14 +136,6 @@ if(BUILD_TESTS_DEV)
         ${TESTS_DEV_SRC}
         ${HELPERS_SRC}
     )
-    # Define output location of binary files
-    if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
-        # If top level project
-        SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/bin/${CMAKE_BUILD_TYPE}/)
-    else()
-        # If called via add_subdirectory()
-        SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../bin/${CMAKE_BUILD_TYPE}/)
-    endif()
     # Enable parallel compilation
     if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP")