build: Check package version in find_package (#643)

Modify the `ftxui-config.cmake.in` file so that it includes
`ftxui-targets.cmake`. This causes cmake to check the version is
compatible with what the user requested.

This patch also includes additional minor changes.

Co-authored-by: ArthurSonzogni <sonzogniarthur@gmail.com>

CHANGELOG.md

@@ -12,6 +12,9 @@ current (development)
 - Feature: `input` is now supporting multiple lines.
 - Feature: `input` style is now customizeable.
 
+### Build
+- Check version compatibility when using cmake find_package()
+
 4.1.0
 -----
 

cmake/ftxui-config.cmake.in

@@ -2,3 +2,5 @@
 
 include(CMakeFindDependencyMacro)
 find_dependency(Threads)
+
+include("${CMAKE_CURRENT_LIST_DIR}/ftxui-targets.cmake")

cmake/ftxui_install.cmake

@@ -3,41 +3,60 @@ if(NOT FTXUI_ENABLE_INSTALL)
 endif()
 
 include(GNUInstallDirs)
-install(TARGETS screen dom component
+include(CMakePackageConfigHelpers)
-    EXPORT ftxui-export
+
+# ------------------------------------------------------------------------------
+# Install the library and its public headers into the standard subdirectories
+# ------------------------------------------------------------------------------
+install(
+  TARGETS screen dom component
+  EXPORT ftxui-targets
   LIBRARY  DESTINATION ${CMAKE_INSTALL_LIBDIR}
   ARCHIVE  DESTINATION ${CMAKE_INSTALL_LIBDIR}
-)
+  )
 
-install(DIRECTORY include/ftxui DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+install(
+  DIRECTORY include/ftxui
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  )
 
-# CMake package configuration for easy use of library in CMake
+# ------------------------------------------------------------------------------
-include(CMakePackageConfigHelpers)
+# Install the exported cmake targets for use in other CMake projects.
-configure_package_config_file(ftxui-config.cmake.in
+# ------------------------------------------------------------------------------
-  ${CMAKE_CURRENT_BINARY_DIR}/ftxui-config.cmake
+install(
-  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/ftxui/cmake
+  EXPORT ftxui-targets
-  PATH_VARS CMAKE_INSTALL_INCLUDEDIR
-)
-write_basic_package_version_file(
-  ftxui-config-version.cmake
-  VERSION ${PACKAGE_VERSION}
-  COMPATIBILITY AnyNewerVersion
-)
-
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ftxui-config.cmake
-  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ftxui
-)
-install(EXPORT ftxui-export
-  FILE ftxui-config-version.cmake
   NAMESPACE ftxui::
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ftxui
-)
+  )
 
-# pkg-config file for easy use of library in build systems other than CMake
+# ------------------------------------------------------------------------------
-configure_file(ftxui.pc.in
+# Create and install the ftuxi-config.cmake and ftuxi-config-version.cmake files
-  ${CMAKE_CURRENT_BINARY_DIR}/ftxui.pc
+# needed to support users of find_package()
-  @ONLY)
+# ------------------------------------------------------------------------------
+configure_package_config_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/ftxui-config.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/ftxui-config.cmake
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/ftxui/cmake
+  PATH_VARS CMAKE_INSTALL_INCLUDEDIR
+  )
+write_basic_package_version_file(
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/ftxui-config-version.cmake
+  VERSION ${PACKAGE_VERSION}
+  COMPATIBILITY SameMajorVersion
+  )
+install(
+  FILES
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/ftxui-config.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/ftxui-config-version.cmake
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ftxui
+  )
 
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ftxui.pc
+# ------------------------------------------------------------------------------
-  DESTINATION lib/pkgconfig
+# Create and install pkg-config file for easy use of library in build systems
-)
+# other than CMake:
+# ------------------------------------------------------------------------------
+configure_file(ftxui.pc.in ${CMAKE_CURRENT_BINARY_DIR}/ftxui.pc @ONLY)
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/ftxui.pc
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  )