Use CMake's FetchContent module to (optionally) download and build FMILibrary #23

prashanthr05 · 2018-08-09T13:29:16Z

Uses CMake 3.11 FetchContent.cmake option to download and compile FMILibrary , if find_package fails to find FMILibrary.

The minimum cmake version is still 3.5. However, the cmake 3.11 specific files are copied into the repository's cmake/cmake-3.11 folder.

…ebo-fmi into cmake/fetchContent

traversaro · 2018-08-09T14:23:00Z

CMakeLists.txt

@@ -49,13 +53,17 @@ if (gazebo_VERSION_MAJOR LESS 7.0)
 endif()

 find_package(FMILibrary REQUIRED)
+if (NOT FMILibary_FOUND})


Typo, it should be NOT FMILibrary_FOUND

traversaro

Ok, but I think we should never take decision based on the availability of a library at runtime without offering the possibility of toggling this behavior with an option.
Whenever we did that in the past, we had this kind of problems:
When gazebo-fmi library will be integrated in the superbuild, if for some reason the superbuild provided FMILibrary or the system-provided FMILibrary is not found, I want to get a clear error, instead of silently switching to downloading FMILibrary instead.

traversaro · 2018-08-09T14:31:34Z

The compromise we found in iDynTree/YARP/ICUB is: there is always an option USE_<dep> or USE_SYSTEM_<dep> , and its default value is initialized to ON or OFF depending on wherever the dep was found in the system or not. However, if the user/superbuild specifies the option, the option is observed. See robotology/idyntree#322 and robotology/idyntree#323 .

traversaro · 2018-08-09T14:45:50Z

@prashanthr05 I edited the title to be more descriptive.

traversaro · 2018-08-09T14:47:35Z

README.md

 See [CGold guide](https://cgold.readthedocs.io/en/latest/first-step.html) if you need some details on how to build a CMake project.

+An easier option is provided by the gazebo-fmi repository which downloads and compiles the FMILibrary internally within its build folder using CMake's FetchContent option. This is performed when FMILibrary package is not already existing in the system or if the FMILibrary related environment variable (`FMI_ROOT`) is not set, making gazebo-fmi unable to find FMILibrary package.
+


FMI_ROOT --> FMILibrary_ROOT

…ackage and FetchContent

prashanthr05 · 2018-08-09T15:20:59Z

The requested changes addressed in this commit

prashanthr05 · 2018-08-10T10:55:45Z

Feature #2

traversaro · 2018-08-21T09:07:22Z

CMakeLists.txt

+if (USES_SYSTEM_FMILIBRARY)
+    find_package(FMILibrary REQUIRED)
+else()
+   message("Could not find FMILIbrary package. Downloading it using FetchContent...")


I would remove this message.

traversaro

Thanks @prashanthr05 .

Two comments:

For consistency with YCM's superbuild, I would name the option USE_SYSTEM_FMILIBRARY . I know in iDynTree we have options IDYNTREE_USES_SOMETHING, but USE_SYSTEM_ stuff is mostly used in superbuild.
Considering that the internal FMILibrary will also be installed by the project (given how the add_subdirectory workflow works), I think it is extremely bad to enable this option by default. Similarly to what we done in iDynTree (https://github.com/robotology/idyntree/blob/master/cmake/iDynTreeDependencies.cmake#L14) and discussed in Use CMake's FetchContent module to (optionally) download and build FMILibrary #23 (comment) , I think the best option is to first search for FMILibrary, and use the presence or not of the library to set the default value of the option, something like:

find_package(FMILibrary QUIET)
option(USE_SYSTEM_FMILIBRARY "If TRUE/ON use system FMILibrary, otherwise download and compile using FetchContent" ${FMILibrary_FOUND})
if (USE_SYSTEM_FMILIBRARY)
    find_package(FMILibrary REQUIRED)
else()
   include(FetchFMILibrary)
endif()

traversaro · 2018-08-21T10:56:54Z

Ok, I just noticed that the default value is not to use the Fetched library. In this case, feel free to decide to stick with the current behavior or to adopt the logic that I suggested in the previous comment.

…ayground/gazebo-fmi into cmake/fetchContent

prashanthr05 · 2018-08-21T11:20:09Z

Addressed the changes. Thanks @traversaro

traversaro · 2018-08-21T11:21:36Z

README.md

 See [CGold guide](https://cgold.readthedocs.io/en/latest/first-step.html) if you need some details on how to build a CMake project.

+An easier option is provided by the gazebo-fmi repository which downloads and compiles the FMILibrary internally within its build folder using CMake's FetchContent option. This is performed when FMILibrary package is not already existing in the system or if the FMILibrary related environment variable (`FMILibrary_ROOT`) is not set, making gazebo-fmi unable to find FMILibrary package. To use this option, the CMake option `USES_SYSTEM_FMILIBRARY` should be set to `OFF`.
+


Update the docs considering the name variable change.

traversaro · 2018-08-21T11:21:45Z

CMakeLists.txt

+if (USE_SYSTEM_FMILIBRARY)
+    find_package(FMILibrary REQUIRED)
+else()
+   include(FetchFMILibrary)


3 spaces, instead of 4

traversaro

Almost there!

prashanthr05 · 2018-08-21T11:23:00Z

haha ;D sorry for being ignorant. Making the changes.

traversaro · 2018-08-21T11:47:25Z

Thanks!

prashanthr05 added 2 commits August 9, 2018 15:24

[cmake] Downlaod FMILibrary using FetchContent if not found

a11efdf

Merge branch 'master' of https://github.com/robotology-playground/gaz…

166be2a

…ebo-fmi into cmake/fetchContent

prashanthr05 requested a review from traversaro August 9, 2018 13:29

traversaro reviewed Aug 9, 2018

View reviewed changes

traversaro requested changes Aug 9, 2018

View reviewed changes

traversaro changed the title ~~Cmake/fetch content~~ Use CMake's FetchContent.cmake to (optionally) download and build FMILibrary Aug 9, 2018

traversaro changed the title ~~Use CMake's FetchContent.cmake to (optionally) download and build FMILibrary~~ Use CMake's FetchContent module to (optionally) download and build FMILibrary Aug 9, 2018

traversaro reviewed Aug 9, 2018

View reviewed changes

[cmake] Adding USES_SYSTEM_FMILIBRARY option to switch between find_p…

6393d1c

…ackage and FetchContent

Merge branch 'master' into cmake/fetchContent

9a6adaf

traversaro reviewed Aug 21, 2018

View reviewed changes

traversaro requested changes Aug 21, 2018

View reviewed changes

traversaro mentioned this pull request Aug 21, 2018

Add Travis support #24

Merged

prashanthr05 added 2 commits August 21, 2018 13:17

[cmake] fix USE_SYSTEM_FMILIBRARY option

714bf45

Merge branch 'cmake/fetchContent' of https://github.com/robotology-pl…

d7dbcb6

…ayground/gazebo-fmi into cmake/fetchContent

traversaro reviewed Aug 21, 2018

View reviewed changes

[cmake] formatting

b1df7b5

traversaro approved these changes Aug 21, 2018

View reviewed changes

traversaro merged commit 4a584c6 into master Aug 21, 2018

traversaro mentioned this pull request Aug 21, 2018

Get and build FMILibrary using CMake's FetchContent #2

Closed

traversaro deleted the cmake/fetchContent branch October 5, 2018 12:59

traversaro mentioned this pull request Dec 23, 2018

Use FetchContent for bootstrap phase robotology/ycm-cmake-modules#138

Closed

traversaro mentioned this pull request Jun 7, 2019

CMake > 3.11 and YCM dependency robotology/how-to-export-cpp-library#46

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use CMake's FetchContent module to (optionally) download and build FMILibrary #23

Use CMake's FetchContent module to (optionally) download and build FMILibrary #23

prashanthr05 commented Aug 9, 2018

traversaro Aug 9, 2018

traversaro left a comment

traversaro commented Aug 9, 2018

traversaro commented Aug 9, 2018

traversaro Aug 9, 2018

prashanthr05 commented Aug 9, 2018

prashanthr05 commented Aug 10, 2018

traversaro Aug 21, 2018

traversaro left a comment •

edited

Loading

traversaro commented Aug 21, 2018

prashanthr05 commented Aug 21, 2018

traversaro Aug 21, 2018

traversaro Aug 21, 2018

traversaro left a comment

prashanthr05 commented Aug 21, 2018

traversaro commented Aug 21, 2018

		See [CGold guide](https://cgold.readthedocs.io/en/latest/first-step.html) if you need some details on how to build a CMake project.

		An easier option is provided by the gazebo-fmi repository which downloads and compiles the FMILibrary internally within its build folder using CMake's FetchContent option. This is performed when FMILibrary package is not already existing in the system or if the FMILibrary related environment variable (`FMI_ROOT`) is not set, making gazebo-fmi unable to find FMILibrary package.

Use CMake's FetchContent module to (optionally) download and build FMILibrary #23

Use CMake's FetchContent module to (optionally) download and build FMILibrary #23

Conversation

prashanthr05 commented Aug 9, 2018

traversaro Aug 9, 2018

Choose a reason for hiding this comment

traversaro left a comment

Choose a reason for hiding this comment

traversaro commented Aug 9, 2018

traversaro commented Aug 9, 2018

traversaro Aug 9, 2018

Choose a reason for hiding this comment

prashanthr05 commented Aug 9, 2018

prashanthr05 commented Aug 10, 2018

traversaro Aug 21, 2018

Choose a reason for hiding this comment

traversaro left a comment • edited Loading

Choose a reason for hiding this comment

traversaro commented Aug 21, 2018

prashanthr05 commented Aug 21, 2018

traversaro Aug 21, 2018

Choose a reason for hiding this comment

traversaro Aug 21, 2018

Choose a reason for hiding this comment

traversaro left a comment

Choose a reason for hiding this comment

prashanthr05 commented Aug 21, 2018

traversaro commented Aug 21, 2018

traversaro left a comment •

edited

Loading