Introduce JRL CMake Modules v2 #798

ahoarau · 2025-12-10T16:05:56Z

In this PR we introduce the JRL CMake Modules v2, extracted from the repo: https://github.com/ahoarau/jrl-cmakemodules-v2

The integration on the user-side can be done as follows:

set(JRL_CMAKEMODULES_USE_V2 ON CACHE BOOL "Use jrl-cmakemodules v2")
if(JRL_CMAKEMODULES_SOURCE_DIR)
  message(STATUS "Using jrl-cmakemodules from source directory: ${JRL_CMAKEMODULES_SOURCE_DIR}")
  add_subdirectory(${JRL_CMAKEMODULES_SOURCE_DIR} jrl-cmakemodules)
else()
  find_package(jrl-cmakemodules 0.2.0 CONFIG REQUIRED)
endif()

We can still use the repo jrl-cmakemodules as usual, i.e. with pixi or manually installing it.
Either set an env variable JRL_CMAKEMODULES_SOURCE_DIR pointing to the jrl repo source location or use the installed version (find_package(...)).
Then define JRL_CMAKEMODULES_USE_V2 ON to bypass the v1 and use exclusively the v2.
We do not intend to use both v1 and v2 in projects.

TODO:

Port the main modules
Test the integration in client repo (proxsuite, eigenpy, nanoeigenpy, coal)
Figure out why gersemi still needs to re-format the new modules
Add COMPATIBLITY_OPTION for jrl_cmake_dependent_option()
Port tests from original repo
Port CI from original repo
Rewrite release.cmake in python (help wanted)

jorisv · 2025-12-11T16:29:27Z

v2/find-modules/FindAccelerate.cmake

We must add copyright on all new files:

# Copyright 2025 INRIA

jorisv · 2025-12-11T16:40:04Z

v2/modules/BoostPython.cmake

@@ -0,0 +1,58 @@
+# jrl_boostpy_add_module(name [sources...])
+function(jrl_boostpy_add_module name)
+    python_add_library(${name} MODULE WITH_SOABI ${ARGN})


This function depend of find_package(Python) call. We need to add guards to print a nice error if python_add_library is not defined.

Done for the Boost::python target as well

jorisv · 2025-12-11T16:55:17Z

v2/jrl-cmakemodules-v2/templates/__init__.py.in

+    mgr = DllDirectoryManager()
+    module_path = os.path.dirname(__file__)
+    mgr.safe_add_dll_directory(os.path.join(module_path, '..', '..', '..', 'bin'))
+    dll_dirs = @__DLL_DIRS__@
+    for dll_dir in dll_dirs:
+        mgr.safe_add_dll_directory(os.path.join(module_path, dll_dir))


I think DllDirectoryManager.__del__ will never be called here.

mgr will never be delete when we import @__MODULE_NAME__@.

You can check it with toto.py:

class Toto: def __init__(self): print("toto.__init__") def __del__(self): print("toto.__del__") t = Toto()

If you import toto Only enter will be called.

You need to use contextlib to handle it well.

fixed, thank for the insights. ✅

jorisv · 2025-12-12T13:03:58Z

v2/jrl-cmakemodules-v2/CMakeLists.txt

+
+include(${CMAKE_CURRENT_SOURCE_DIR}/modules/jrl.cmake)
+
+if(CMAKE_UTILS_BUILD_TESTS)


JRL_CMAKEMODULES_BUILD_TESTS is more appropriate.

Also, this should be an option.

oops I forgot that one, done ✅

jorisv · 2025-12-12T13:04:38Z

CMakeLists.txt

@@ -1,5 +1,10 @@
 cmake_minimum_required(VERSION 3.22)

+if(JRL_CMAKEMODULES_USE_V2)


JRL_CMAKEMODULES_USE_V2 should be an option

jorisv · 2025-12-12T15:12:30Z

v2/modules/jrl.cmake

+    endif()
+endfunction()
+
+function(jrl_python_generate_init_py name)


Add some documentation

jorisv · 2025-12-12T15:15:25Z

v2/modules/jrl.cmake

+    if(NOT Python_EXECUTABLE)
+        message(
+            FATAL_ERROR
+            "Python_EXECUTABLE not defined.
+        Please use jrl_find_package(Python REQUIRED COMPONENT Interpreter)"
+        )
+    endif()


Why not use jrl_check_var_defined ?

Also, in BoostPython.cmake you use $<TARGET_FILE:Python::Interpreter>. Which one is the best ?

jorisv · 2025-12-12T15:18:05Z

v2/modules/jrl.cmake

+    if(NOT Python_EXECUTABLE)
+        message(
+            FATAL_ERROR
+            "Python_EXECUTABLE not defined.
+        Please use jrl_find_package(Python REQUIRED COMPONENT Interpreter)"
+        )
+    endif()


Why not use jrl_check_var_defined ?

Also, in BoostPython.cmake you use $<TARGET_FILE:Python::Interpreter>. Which one is the best ?

jorisv · 2025-12-12T15:18:18Z

v2/modules/jrl.cmake

+    endif()
+endfunction()
+
+function(jrl_python_compute_install_dir output)


Add some documentation

jorisv · 2025-12-12T15:23:04Z

v2/jrl-cmakemodules-v2/CMakeLists.txt

+if(NOT PROJECT_IS_TOP_LEVEL)
+    return()
+endif()
+


I don't get it. We will return if included from the main CMakeLists.txt. Then we will not generate the configuration file.

It's maybe clearer to directly include v2/modules/jrl.cmake in the PACKAGE_TOP_MACROS.

…kemodules-v2

the dll needs to be closed after the import coal call

…F by default

otherwise, the dll are already close():28

also fixes an error when running in script mode

…ke the installed version

remove the test for now

…on dir This commit might be reverted as we already have ${PROJECT_NAME}_PYTHON_INSTALL_DIR to override the installation path

This reverts commit 8148456.

this is a proper way to enfore the policy CMP0057, required to NEW on CMake 3.22

…build in build dir

…uired

…dows exception

…ve error messaging

ahoarau marked this pull request as draft December 11, 2025 16:41

jorisv requested changes Dec 12, 2025

View reviewed changes

nim65s self-requested a review December 15, 2025 10:24

ahoarau added 23 commits December 19, 2025 16:21

introduce jrl cmake modules v2

478beaf

allow to pass content at the top of config.cmake via PACKAGE_TOP_MACROS

416c19e

let's keep the message reasonable

0d3e007

integrate jrl-cmakemodules-v2 from https://github.com/ahoarau/jrl-cma…

cdbdfdb

…kemodules-v2

add JRL_CMAKEMODULES_USE_V2 option to use v2 API

2ada3d6

add contexte manager to DllDirectoryManager

88c01b8

the dll needs to be closed after the import coal call

check python_add_library is available

18b6c87

check Boost::python target exists

2e961a1

improve jrl_target_headers documentation

245e8a6

remove unused GENERATED_DIR in jrl_target_headers

6e0251e

improve documentation of jrl_boostpy_add_module

8da98a2

add inria 2026 copyright

847ba38

formatting (prek run -a)

cbcf643

add BSD-3 Clause License

1b76f9d

rename CMAKE_UTILS_BUILD_TESTS to JRL_CMAKEMODULES_V2_BUILD_TESTS, OF…

6303cd5

…F by default

update copyright for 2025-2026

ffd0283

fix jrl_print_options_summary not logging anything

5c296cd

import libraries in the DLLDirectorymanager context

8cf48d1

otherwise, the dll are already close():28

ignore build and instal dirs

cf1bc4a

no need to include PytestAddTest, only discover like boost

a2256c5

also fixes an error when running in script mode

update ruff(legacy) to ruff-check

38bc886

add jrl_ prefix to copy_compile_commands_in_source_dir

4b66b42

add info about where the jrl V2 are loaded

c15b782

ahoarau added 10 commits December 19, 2025 16:21

look for tsl-robin-map only if nanobind is found

083d1fe

convert path to cmake path lists

f0382ba

add more explicit message about export component beeing created

be2b051

fix trailing space (pre-commit)

d3123d1

add jrl_cmakemodules_get_version and jrl_print_banner

b05a1dd

use jrl-cmakemodules project name and set jrl-cmakemodules_VERSION li…

e0ae3df

…ke the installed version

remove intermediate cmakelists and print banner

e329f43

move jrl v2 into the v2 folder only

34f4004

fix comment about creating a separate export

ded1726

do not bypass the install dir

8148456

remove the test for now

ahoarau force-pushed the jrl-next branch from 81d0ea4 to 8148456 Compare December 19, 2025 15:21

ahoarau added 8 commits December 19, 2025 16:25

automatically detect the python environment to compute the installati…

7ac1e53

…on dir This commit might be reverted as we already have ${PROJECT_NAME}_PYTHON_INSTALL_DIR to override the installation path

Revert "do not bypass the install dir"

c044115

This reverts commit 8148456.

print banner when using installed version

94717f5

install the whole jrl v2 package

88f1021

specify a dir name as we are technically an out of tree subdirectory

4e63e16

on nix compute a python install dir relative to the data dir

342967b

we only need to have a fix for conda python install dir

39a0023

fix the os detection python script

68b07aa

nim65s mentioned this pull request Dec 20, 2025

Revert "Refactor CMake with JRL CMake Modules v2" Simple-Robotics/nanoeigenpy#36

Open

ahoarau added 10 commits December 21, 2025 15:05

set min cmake version required to allow to use IN_LIST in CMake 3.22

abce403

this is a proper way to enfore the policy CMP0057, required to NEW on CMake 3.22

jrl_copy_compile_commands_in_source_dir is only useful when we don't …

b114b4c

…build in build dir

add documentation for jrl_target_set_output_directory

840b917

add jrl_get_cxx_compiler_id to handle the clang-cl and msvc exceptions

401266e

jrl_target_generate_header: remove CMAKE_CURRENT_BINARY_DIR being req…

f9f1f52

…uired

use LIBRARY_VERSION instead of PROJECT_VERSION

c7be266

improve jrl_find_package documentation

1a7efec

jrl_python_compute_install_dir: refactor on handle only the conda+win…

05551dd

…dows exception

only convert path on windows

39328c3

jrl_find_nanobind: add support for REQUIRED, QUIET argument and impro…

634fbe4

…ve error messaging


		include(${CMAKE_CURRENT_SOURCE_DIR}/modules/jrl.cmake)

		if(CMAKE_UTILS_BUILD_TESTS)

		@@ -1,5 +1,10 @@
		cmake_minimum_required(VERSION 3.22)

		if(JRL_CMAKEMODULES_USE_V2)

Introduce JRL CMake Modules v2 #798

Are you sure you want to change the base?

Introduce JRL CMake Modules v2 #798

Uh oh!

Conversation

ahoarau commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ahoarau commented Dec 10, 2025 •

edited

Loading