Changes to enable building of MRtrix3 extensions

CMakeLists.txt

@@ -38,6 +38,17 @@ else()
     set(QT_MAJOR_VERSION 6)
 endif()
 
+# If MRTRIX_SUBPROJECT_INSTALL_PREFIX is set, it will be used as the install prefix
+# for all targets in this project. This is useful when MRtrix3 is built as a
+# subproject of another project (e.g. via add_subdirectory or FetchContent).
+if(NOT DEFINED MRTRIX_SUBPROJECT_INSTALL_PREFIX)
+    set(MRTRIX_SUBPROJECT_INSTALL_PREFIX "")
+endif()
+set(MRTRIX_INSTALL_BINDIR ${MRTRIX_SUBPROJECT_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR} CACHE INTERNAL "" FORCE)
+set(MRTRIX_INSTALL_LIBDIR ${MRTRIX_SUBPROJECT_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR} CACHE INTERNAL "" FORCE)
+set(MRTRIX_INSTALL_INCLUDEDIR ${MRTRIX_SUBPROJECT_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR} CACHE INTERNAL "" FORCE)
+set(MRTRIX_INSTALL_DATADIR ${MRTRIX_SUBPROJECT_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR} CACHE INTERNAL "" FORCE)
+
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
@@ -57,8 +68,8 @@ else()
 endif()
 
 file(RELATIVE_PATH relDir
-    ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}
-    ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}
+    ${CMAKE_CURRENT_BINARY_DIR}/${MRTRIX_INSTALL_BINDIR}
+    ${CMAKE_CURRENT_BINARY_DIR}/${MRTRIX_INSTALL_LIBDIR}
 )
 
 set(CMAKE_INSTALL_RPATH ${base} ${base}/${relDir})

cmake/FindVersion.cmake

@@ -1,4 +1,4 @@
-if(GIT_EXECUTABLE)
+if(GIT_EXECUTABLE AND PROJECT_IS_TOP_LEVEL)
     message(VERBOSE "Git found: ${GIT_EXECUTABLE}")
     # Get tag
     execute_process(
@@ -31,7 +31,11 @@ endif()
 
 if(NOT MRTRIX_VERSION)
     set(MRTRIX_VERSION ${MRTRIX_BASE_VERSION})
-    message(STATUS "Failed to determine version from Git, using default base version: ${MRTRIX_BASE_VERSION}")
+    if(PROJECT_IS_TOP_LEVEL)
+        message(STATUS "Failed to determine version from Git, using default base version: ${MRTRIX_BASE_VERSION}")
+    else()
+        message(VERBOSE "MRtrix3 version is set to version: ${MRTRIX_BASE_VERSION}")
+    endif()
 endif()
 
 

cmake/MakePythonExecutable.cmake

@@ -2,6 +2,14 @@
 # Inputs:
 #   - CMDNAME: Name of the command
 #   - OUTPUT_DIR: Directory in which to create the executable
+#   - EXTERNAL_PROJECT_COMMAND: Boolean indicating whether the command is part of an MRtrix3 external project
+
+set(PYTHON_LIB_PATH  "os.path.normpath(os.path.join(os.path.dirname(os.path.realpath(__file__)), os.pardir, 'lib'))")
+
+# For external projects the python library sources are located in ../lib/mrtrix3/lib
+if(EXTERNAL_PROJECT_COMMAND)
+    set(PYTHON_LIB_PATH "os.path.normpath(os.path.join(os.path.dirname(os.path.realpath(__file__)), os.pardir, 'lib', 'mrtrix3', 'lib'))")
+endif()
 
 set(BINPATH_CONTENTS
     "#!/usr/bin/python3\n"
@@ -11,7 +19,7 @@ set(BINPATH_CONTENTS
     "import os\n"
     "import sys\n"
     "\n"
-    "mrtrix_lib_path = os.path.normpath(os.path.join(os.path.dirname(os.path.realpath(__file__)), os.pardir, 'lib'))\n"
+    "mrtrix_lib_path = ${PYTHON_LIB_PATH}\n"
     "sys.path.insert(0, mrtrix_lib_path)\n"
     "from mrtrix3.app import _execute\n"
     "\n"

cmd/CMakeLists.txt

@@ -44,8 +44,8 @@ function(add_cmd CMD_SRC IS_GUI)
     endif ()
 
     install(TARGETS ${CMD_NAME}
-        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-        BUNDLE DESTINATION ${CMAKE_INSTALL_BINDIR}
+        RUNTIME DESTINATION ${MRTRIX_INSTALL_BINDIR}
+        BUNDLE DESTINATION ${MRTRIX_INSTALL_BINDIR}
     )
 endfunction()
 

core/CMakeLists.txt

@@ -96,6 +96,6 @@ target_include_directories(mrtrix-core PUBLIC
 )
 
 install(TARGETS mrtrix-core
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${MRTRIX_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${MRTRIX_INSTALL_LIBDIR}
 )

python/mrtrix3/CMakeLists.txt

@@ -66,10 +66,10 @@ add_custom_target(PythonLibFiles
 
 install(FILES ${PYTHON_LIB_FILES}
     PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
-    DESTINATION ${CMAKE_INSTALL_LIBDIR}/mrtrix3
+    DESTINATION ${MRTRIX_INSTALL_LIBDIR}/mrtrix3
 )
 
 install(FILES ${PYTHON_VERSION_FILE}
     PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
-    DESTINATION ${CMAKE_INSTALL_LIBDIR}/mrtrix3
+    DESTINATION ${MRTRIX_INSTALL_LIBDIR}/mrtrix3
 )

python/mrtrix3/commands/CMakeLists.txt

@@ -63,7 +63,7 @@ foreach(PYTHON_SRC_PATH ${PYTHON_ALL_COMMANDS_FILES})
     get_filename_component(DST_INSTALLDIR ${DST_RELPATH} DIRECTORY)
     install(FILES ${PYTHON_SRC_PATH}
         PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
-        DESTINATION ${CMAKE_INSTALL_LIBDIR}/mrtrix3/commands/${DST_INSTALLDIR}
+        DESTINATION ${MRTRIX_INSTALL_LIBDIR}/mrtrix3/commands/${DST_INSTALLDIR}
     )
     list(APPEND PYTHON_BUILD_COMMAND_FILES ${DST_PATH})
 endforeach()
@@ -100,10 +100,10 @@ add_custom_target(PythonCommands
 
 install(FILES ${PYTHON_BIN_FILES}
     PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
-    DESTINATION ${CMAKE_INSTALL_BINDIR}
+    DESTINATION ${MRTRIX_INSTALL_BINDIR}
 )
 
 install(FILES ${PYTHON_COMMANDS_INIT_FILE}
     PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
-    DESTINATION ${CMAKE_INSTALL_LIBDIR}/mrtrix3/commands/
+    DESTINATION ${MRTRIX_INSTALL_LIBDIR}/mrtrix3/commands/
 )

share/CMakeLists.txt

@@ -5,17 +5,17 @@ add_custom_target(copy-share-data ALL
 )
 
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/mrtrix3/
-    DESTINATION ${CMAKE_INSTALL_DATADIR}/mrtrix3
+    DESTINATION ${MRTRIX_INSTALL_DATADIR}/mrtrix3
 )
 
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/icons/hicolor
-    DESTINATION ${CMAKE_INSTALL_DATADIR}/icons
+    DESTINATION ${MRTRIX_INSTALL_DATADIR}/icons
 )
 
 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/applications/mrview.desktop
-    DESTINATION ${CMAKE_INSTALL_DATADIR}/applications
+    DESTINATION ${MRTRIX_INSTALL_DATADIR}/applications
 )
 
 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/mime/mrtrix-mime.xml
-    DESTINATION ${CMAKE_INSTALL_DATADIR}/mime
+    DESTINATION ${MRTRIX_INSTALL_DATADIR}/mime
 )

src/CMakeLists.txt

@@ -112,13 +112,13 @@ if(WIN32)
 endif()
 
 install(TARGETS mrtrix-headless
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    RUNTIME DESTINATION ${MRTRIX_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${MRTRIX_INSTALL_LIBDIR}
 )
 
 if(MRTRIX_BUILD_GUI)
     install(TARGETS mrtrix-gui
-        RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-        LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+        RUNTIME DESTINATION ${MRTRIX_INSTALL_BINDIR}
+        LIBRARY DESTINATION ${MRTRIX_INSTALL_LIBDIR}
     )
 endif()