From 35970bde0a65a0e1b3f442e73410c29954f2ad6d Mon Sep 17 00:00:00 2001 From: Loy van Beek Date: Fri, 5 Nov 2021 13:36:54 +0100 Subject: [PATCH 1/6] Add cmake functions to include an existing .csproj in a cmake project --- cmake/Modules/FindDotNETExtra.cmake | 18 ++++ .../dotnet/UseCSharpProjectBuilder.cmake | 91 +++++++++++++++++++ 2 files changed, 109 insertions(+) diff --git a/cmake/Modules/FindDotNETExtra.cmake b/cmake/Modules/FindDotNETExtra.cmake index 81c214c..e90ddf1 100644 --- a/cmake/Modules/FindDotNETExtra.cmake +++ b/cmake/Modules/FindDotNETExtra.cmake @@ -107,6 +107,24 @@ function(add_dotnet_test _TARGET_NAME) endfunction() +function(add_dotnet_project _TARGET_NAME) + cmake_parse_arguments(_add_dotnet_project + "" + "" + "PROJ;INCLUDE_DLLS" + ${ARGN} + ) + + csharp_add_existing_project(${_TARGET_NAME} + EXECUTABLE + PROJ + ${_add_dotnet_project_PROJ} + ${_add_dotnet_project_UNPARSED_ARGUMENTS} + INCLUDE_DLLS + ${_add_dotnet_project_INCLUDE_DLLS} + ) +endfunction() + function(install_dotnet _TARGET_NAME) get_target_property(_target_executable ${_TARGET_NAME} EXECUTABLE) get_target_property(_target_path ${_TARGET_NAME} OUTPUT_PATH) diff --git a/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake b/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake index 523c0a7..53c10e2 100644 --- a/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake +++ b/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake @@ -192,3 +192,94 @@ function(csharp_add_project name) ${DOTNET_CORE_FOUND} ) endfunction() + +function(csharp_add_existing_project name) + if(CSBUILD_PROJECT_DIR) + set(CURRENT_TARGET_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/${CSBUILD_PROJECT_DIR}") + else() + set(CURRENT_TARGET_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}") + endif() + set(CSBUILD_PROJECT_DIR "") + file(MAKE_DIRECTORY ${CURRENT_TARGET_BINARY_DIR}/${name}) + cmake_parse_arguments(_csharp_add_existing_project + "EXECUTABLE" + "" + "PROJ;INCLUDE_DLLS" + ${ARGN} + ) + + foreach(it ${_csharp_add_existing_project_INCLUDE_DLLS}) + file(TO_NATIVE_PATH ${it} nit) + list(APPEND refs " \n") + endforeach() + + list(LENGTH refs REFERENCE_COUNT) + + if(REFERENCE_COUNT GREATER 0) + set(refs_concat "${refs}") + else() + set(refs_concat "") + endif() + + get_filename_component(_csharp_add_existing_project_PROJ_PATH ${_csharp_add_existing_project_PROJ} DIRECTORY) + get_filename_component(_csharp_add_existing_project_PROJ_PATH_ABSOLUTE ${_csharp_add_existing_project_PROJ_PATH} ABSOLUTE) + + get_filename_component(_csharp_add_existing_project_PROJ_ABSOLUTE ${_csharp_add_existing_project_PROJ} ABSOLUTE) + + set(_csharp_add_existing_project_PROPS_PATH ${_csharp_add_existing_project_PROJ_PATH_ABSOLUTE}/obj/CMake.g.props) + + set(CSHARP_BUILDER_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}) + file(TO_NATIVE_PATH ${CSHARP_BUILDER_OUTPUT_PATH} CSHARP_BUILDER_OUTPUT_PATH_NATIVE) + + # TODO: add to add_custom_target to avoid writing every time + file(WRITE ${_csharp_add_existing_project_PROPS_PATH} + "\n" + " \n" + ${refs_concat} + " \n" + " \n" + " " + ${CSHARP_BUILDER_OUTPUT_PATH_NATIVE} + "\n" + "" + ${_TARGET_NAME} + "\n" + " " + "\n" + ) + + if(${_csharp_add_existing_project_EXECUTABLE} AND NOT DOTNET_CORE_FOUND) + set(ext "exe") + else() + set(ext "dll") + endif() + + add_custom_target( + ${name} ALL + + COMMAND ${RESTORE_CMD} + + COMMAND ${CSBUILD_EXECUTABLE} ${CSBUILD_RESTORE_FLAGS} ${_csharp_add_existing_project_PROJ_ABSOLUTE} + COMMAND ${CSBUILD_EXECUTABLE} ${CSBUILD_BUILD_FLAGS} ${_csharp_add_existing_project_PROJ_ABSOLUTE} + WORKING_DIRECTORY ${CURRENT_TARGET_BINARY_DIR}/${name} + COMMENT "${RESTORE_CMD};${CSBUILD_EXECUTABLE} ${CSBUILD_RESTORE_FLAGS} ${_csharp_add_existing_project_PROJ_ABSOLUTE}; ${CSBUILD_EXECUTABLE} ${CSBUILD_BUILD_FLAGS} ${_csharp_add_existing_project_PROJ_ABSOLUTE} -> ${CURRENT_TARGET_BINARY_DIR}/${name}" + + # TODO: How to deal with changes to *.cs files (Implicit include in *.csproj) + # DEPENDS ${sources_dep} + DEPENDS ${_csharp_add_existing_project_PROJ_ABSOLUTE} + ) + + set(DOTNET_OUTPUT_PATH ${CSHARP_BUILDER_OUTPUT_PATH}/${CSHARP_TARGET_FRAMEWORK}/${DOTNET_CORE_RUNTIME}/publish/) + + set_target_properties(${name} + PROPERTIES + EXECUTABLE + ${_csharp_add_existing_project_EXECUTABLE} + OUTPUT_PATH + ${DOTNET_OUTPUT_PATH} + OUTPUT_NAME + ${name}${CSBUILD_OUTPUT_SUFFIX}.${ext} + DOTNET_CORE + ${DOTNET_CORE_FOUND} + ) +endfunction() From 2502d9c2ef81732d6c0e744604a68aabe39dfb2b Mon Sep 17 00:00:00 2001 From: Loy van Beek Date: Fri, 5 Nov 2021 13:42:03 +0100 Subject: [PATCH 2/6] Some docs on .csproj support in README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12a376d..e04b4d5 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,14 @@ Parts of this project based on code by Illumina. For more info: -https://github.com/Illumina/interop \ No newline at end of file +https://github.com/Illumina/interop + +## `.csproj` support +It is possible to include eg. a C# project `.csproj` file with the `add_dotnet_project` function. +This `.csproj` file must include a line + +```xml + +``` + +as this is where CMake generates references to other ROS 2 packages in, as well as the output path and the assembly name. From 5291049f64bc73aad6100609c93ef3fd7724dc3c Mon Sep 17 00:00:00 2001 From: Loy van Beek Date: Fri, 5 Nov 2021 14:38:49 +0100 Subject: [PATCH 3/6] Use template file to generate CMake.g.props instead of generating text directly from CMake --- cmake/Modules/dotnet/CMake.g.props.in | 8 ++++++++ .../dotnet/UseCSharpProjectBuilder.cmake | 20 ++++--------------- 2 files changed, 12 insertions(+), 16 deletions(-) create mode 100644 cmake/Modules/dotnet/CMake.g.props.in diff --git a/cmake/Modules/dotnet/CMake.g.props.in b/cmake/Modules/dotnet/CMake.g.props.in new file mode 100644 index 0000000..64491ef --- /dev/null +++ b/cmake/Modules/dotnet/CMake.g.props.in @@ -0,0 +1,8 @@ + + +@CSHARP_BUILDER_INCLUDE_DLLS_STR@ + + @CSHARP_BUILDER_OUTPUT_PATH_NATIVE@ + @_TARGET_NAME@ + + diff --git a/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake b/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake index 53c10e2..169cc7f 100644 --- a/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake +++ b/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake @@ -210,7 +210,7 @@ function(csharp_add_existing_project name) foreach(it ${_csharp_add_existing_project_INCLUDE_DLLS}) file(TO_NATIVE_PATH ${it} nit) - list(APPEND refs " \n") + list(APPEND refs " \n") endforeach() list(LENGTH refs REFERENCE_COUNT) @@ -232,21 +232,9 @@ function(csharp_add_existing_project name) file(TO_NATIVE_PATH ${CSHARP_BUILDER_OUTPUT_PATH} CSHARP_BUILDER_OUTPUT_PATH_NATIVE) # TODO: add to add_custom_target to avoid writing every time - file(WRITE ${_csharp_add_existing_project_PROPS_PATH} - "\n" - " \n" - ${refs_concat} - " \n" - " \n" - " " - ${CSHARP_BUILDER_OUTPUT_PATH_NATIVE} - "\n" - "" - ${_TARGET_NAME} - "\n" - " " - "\n" - ) + string (REPLACE ";" "" CSHARP_BUILDER_INCLUDE_DLLS_STR "${refs_concat}") + set(CSHARP_BUILDER_INCLUDE_DLLS ${refs_concat}) + configure_file(${dotnet_cmake_module_DIR}/Modules/dotnet/CMake.g.props.in ${_csharp_add_existing_project_PROPS_PATH} @ONLY) if(${_csharp_add_existing_project_EXECUTABLE} AND NOT DOTNET_CORE_FOUND) set(ext "exe") From 47d62d607422bcdb530840f7ce1cbab2f7783490 Mon Sep 17 00:00:00 2001 From: Stefan Hoffmann Date: Tue, 7 Dec 2021 17:19:02 +0100 Subject: [PATCH 4/6] Fix CSHARP_BUILDER_OUTPUT_PATH to contain the target name Otherwise all targets inside the package would use the same directory and overwrite each other. --- cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake b/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake index 169cc7f..c51ca03 100644 --- a/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake +++ b/cmake/Modules/dotnet/UseCSharpProjectBuilder.cmake @@ -228,7 +228,7 @@ function(csharp_add_existing_project name) set(_csharp_add_existing_project_PROPS_PATH ${_csharp_add_existing_project_PROJ_PATH_ABSOLUTE}/obj/CMake.g.props) - set(CSHARP_BUILDER_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}) + set(CSHARP_BUILDER_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/${name}/${CMAKE_BUILD_TYPE}) file(TO_NATIVE_PATH ${CSHARP_BUILDER_OUTPUT_PATH} CSHARP_BUILDER_OUTPUT_PATH_NATIVE) # TODO: add to add_custom_target to avoid writing every time From 21e3991f83d254674ae8e2a1f7cd815fe121c01b Mon Sep 17 00:00:00 2001 From: Stefan Hoffmann Date: Tue, 7 Dec 2021 17:20:20 +0100 Subject: [PATCH 5/6] add the add_dotnet_test_project function --- cmake/Modules/FindDotNETExtra.cmake | 38 +++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/cmake/Modules/FindDotNETExtra.cmake b/cmake/Modules/FindDotNETExtra.cmake index e90ddf1..641fb68 100644 --- a/cmake/Modules/FindDotNETExtra.cmake +++ b/cmake/Modules/FindDotNETExtra.cmake @@ -125,6 +125,44 @@ function(add_dotnet_project _TARGET_NAME) ) endfunction() +function(add_dotnet_test_project _TARGET_NAME) + # TODO: (sh) It seems the test project gets build twice with different output directories + # e.g.: the same output files are contained in "build///net6.0/" and "build///net6.0/linux-x64" + # But this seems to be the case with other projects as well (package rcldotnet and targets rcldotnet_assemblies and test_messages). + # So maybe this is how it should be, but why? + + cmake_parse_arguments(_add_dotnet_test_project + "" + "" + "PROJ;INCLUDE_DLLS" + ${ARGN} + ) + + csharp_add_existing_project(${_TARGET_NAME} + EXECUTABLE + PROJ + ${_add_dotnet_test_project_PROJ} + ${_add_dotnet_test_project_UNPARSED_ARGUMENTS} + INCLUDE_DLLS + ${_add_dotnet_test_project_INCLUDE_DLLS} + ) + + if(CSBUILD_PROJECT_DIR) + set(CURRENT_TARGET_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/${CSBUILD_PROJECT_DIR}") + else() + set(CURRENT_TARGET_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}") + endif() + + get_filename_component(_add_dotnet_test_project_PROJ_ABSOLUTE ${_add_dotnet_test_project_PROJ} ABSOLUTE) + + ament_add_test( + ${_TARGET_NAME} + GENERATE_RESULT_FOR_RETURN_CODE_ZERO + WORKING_DIRECTORY ${CURRENT_TARGET_BINARY_DIR}/${_TARGET_NAME} + COMMAND dotnet test ${_add_dotnet_test_project_PROJ_ABSOLUTE} + ) +endfunction() + function(install_dotnet _TARGET_NAME) get_target_property(_target_executable ${_TARGET_NAME} EXECUTABLE) get_target_property(_target_path ${_TARGET_NAME} OUTPUT_PATH) From a416560a8e33029b67301ec1672ccf647476ce4c Mon Sep 17 00:00:00 2001 From: Stefan Hoffmann Date: Thu, 9 Dec 2021 17:09:15 +0100 Subject: [PATCH 6/6] Rename add_dotnet_project to add_dotnet_executable_project; Add add_dotnet_library_project --- cmake/Modules/FindDotNETExtra.cmake | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/cmake/Modules/FindDotNETExtra.cmake b/cmake/Modules/FindDotNETExtra.cmake index 641fb68..a3085b7 100644 --- a/cmake/Modules/FindDotNETExtra.cmake +++ b/cmake/Modules/FindDotNETExtra.cmake @@ -107,8 +107,25 @@ function(add_dotnet_test _TARGET_NAME) endfunction() -function(add_dotnet_project _TARGET_NAME) - cmake_parse_arguments(_add_dotnet_project +function(add_dotnet_library_project _TARGET_NAME) + cmake_parse_arguments(_add_dotnet_library_project + "" + "" + "PROJ;INCLUDE_DLLS" + ${ARGN} + ) + + csharp_add_existing_project(${_TARGET_NAME} + PROJ + ${_add_dotnet_library_project_PROJ} + ${_add_dotnet_library_project_UNPARSED_ARGUMENTS} + INCLUDE_DLLS + ${_add_dotnet_library_project_INCLUDE_DLLS} + ) +endfunction() + +function(add_dotnet_executable_project _TARGET_NAME) + cmake_parse_arguments(_add_dotnet_executable_project "" "" "PROJ;INCLUDE_DLLS" @@ -118,10 +135,10 @@ function(add_dotnet_project _TARGET_NAME) csharp_add_existing_project(${_TARGET_NAME} EXECUTABLE PROJ - ${_add_dotnet_project_PROJ} - ${_add_dotnet_project_UNPARSED_ARGUMENTS} + ${_add_dotnet_executable_project_PROJ} + ${_add_dotnet_executable_project_UNPARSED_ARGUMENTS} INCLUDE_DLLS - ${_add_dotnet_project_INCLUDE_DLLS} + ${_add_dotnet_executable_project_INCLUDE_DLLS} ) endfunction()