Merge pull request #369 from esmf-org/feature/esmx-cmake-api

Make the ESMX CMake API directly usable for (complex) projects that leverage CMake. The component build type `cmake` now uses `add_subdirectory()`. A new build type, `cmake.external` can be used to build a component explicitly by ESMX with CMake commands and then using its CMake configuration file (the old default behavior for `cmake` build type).

Author: theurich

cmake/FindESMF.cmake

@@ -114,6 +114,9 @@ if(EXISTS ${ESMFMKFILE})
     if(NOT TARGET ESMF::ESMF)
       add_library(ESMF::ESMF STATIC IMPORTED)
     endif()
+    if(NOT TARGET ESMF::ESMC)
+      add_library(ESMF::ESMC STATIC IMPORTED)
+    endif()
   else()
     find_library(ESMF_LIBRARY_LOCATION NAMES esmf PATHS ${ESMF_LIBSDIR} NO_DEFAULT_PATH)
     if(ESMF_LIBRARY_LOCATION MATCHES "ESMF_LIBRARY_LOCATION-NOTFOUND")
@@ -122,6 +125,9 @@ if(EXISTS ${ESMFMKFILE})
     if(NOT TARGET ESMF::ESMF)
       add_library(ESMF::ESMF UNKNOWN IMPORTED)
     endif()
+    if(NOT TARGET ESMF::ESMC)
+      add_library(ESMF::ESMC UNKNOWN IMPORTED)
+    endif()
   endif()
 
   # Add ESMF as an alias to ESMF::ESMF for backward compatibility
@@ -136,17 +142,27 @@ if(EXISTS ${ESMFMKFILE})
     string(REGEX REPLACE "^-I" "" _ITEM "${_ITEM}")
     list(APPEND ESMF_INCLUDE_DIRECTORIES ${_ITEM})
   endforeach()
+  set(ESMC_INCLUDE_DIRECTORIES "")
+  separate_arguments(_ESMF_CCOMPILEPATHS UNIX_COMMAND ${ESMF_CCOMPILEPATHS})
+  foreach(_ITEM ${_ESMF_CCOMPILEPATHS})
+    string(REGEX REPLACE "^-I" "" _ITEM "${_ITEM}")
+    list(APPEND ESMC_INCLUDE_DIRECTORIES ${_ITEM})
+  endforeach()
 
   # Add ESMF link libraries
   string(STRIP "${ESMF_F90LINKRPATHS} ${ESMF_F90ESMFLINKRPATHS} ${ESMF_F90ESMFLINKPATHS} ${ESMF_F90LINKPATHS} ${ESMF_F90LINKLIBS} ${ESMF_F90LINKOPTS}" ESMF_INTERFACE_LINK_LIBRARIES)
+  string(STRIP "${ESMF_CLINKRPATHS} ${ESMF_CESMFLINKRPATHS} ${ESMF_CESMFLINKPATHS} ${ESMF_CLINKPATHS} ${ESMF_CLINKLIBS} ${ESMF_CLINKOPTS}" ESMC_INTERFACE_LINK_LIBRARIES)
 
   # Finalize find_package
   include(FindPackageHandleStandardArgs)
 
   find_package_handle_standard_args(
         ${CMAKE_FIND_PACKAGE_NAME}
         REQUIRED_VARS ESMF_LIBRARY_LOCATION
+                      ESMF_INCLUDE_DIRECTORIES
+                      ESMC_INCLUDE_DIRECTORIES
                       ESMF_INTERFACE_LINK_LIBRARIES
+                      ESMC_INTERFACE_LINK_LIBRARIES
                       ESMF_F90COMPILEPATHS
         VERSION_VAR ESMF_VERSION)
 
@@ -155,6 +171,11 @@ if(EXISTS ${ESMFMKFILE})
         INTERFACE_INCLUDE_DIRECTORIES "${ESMF_INCLUDE_DIRECTORIES}"
         INTERFACE_LINK_LIBRARIES "${ESMF_INTERFACE_LINK_LIBRARIES}")
 
+  set_target_properties(ESMF::ESMC PROPERTIES
+        IMPORTED_LOCATION "${ESMF_LIBRARY_LOCATION}"
+        INTERFACE_INCLUDE_DIRECTORIES "${ESMC_INCLUDE_DIRECTORIES}"
+        INTERFACE_LINK_LIBRARIES "${ESMC_INTERFACE_LINK_LIBRARIES}")
+
 else()
   set(ESMF_FOUND FALSE CACHE BOOL "esmf.mk file NOT found" FORCE)
   message(WARNING "ESMFMKFILE ${ESMFMKFILE} not found. Try setting ESMFMKFILE \

src/addon/ESMX/CMakeLists.txt

@@ -1,34 +1,42 @@
 cmake_minimum_required(VERSION 3.22)
 
 # Where to look for the local Find<Package>.cmake files
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/Driver/cmake")
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
 # Find ESMF
-find_package(ESMF 8.6.0 MODULE REQUIRED)
+find_package(ESMF 8.9.0 MODULE REQUIRED)
 
-# Set compilers consistent with ESMF
-set(CMAKE_Fortran_COMPILER        "${ESMF_F90COMPILER}")
-set(CMAKE_CXX_COMPILER            "${ESMF_CXXCOMPILER}")
-set(CMAKE_C_COMPILER              "${ESMF_CCOMPILER}")
+if(NOT DEFINED CMAKE_Fortran_COMPILER)
+  set(CMAKE_Fortran_COMPILER        "${ESMF_F90COMPILER}")
+endif()
+if(NOT DEFINED CMAKE_CXX_COMPILER)
+  set(CMAKE_CXX_COMPILER            "${ESMF_CXXCOMPILER}")
+endif()
+if(NOT DEFINED CMAKE_C_COMPILER)
+  set(CMAKE_C_COMPILER              "${ESMF_CCOMPILER}")
+endif()
 
 # Project
 project(ESMX
-        VERSION 1.0.0
+        VERSION 8.9.0
         LANGUAGES Fortran CXX C
         )
 
+# Define standard installation directories
+include(GNUInstallDirs)
+
 # Add ESMX driver
 add_subdirectory(Driver)
 
-if(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
+if(CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2")
   set(CMAKE_Fortran_FLAGS_RELWITHDEBINFO "-g -fbacktrace -O2")
   set(CMAKE_Fortran_FLAGS_DEBUG "-g -fbacktrace -O0 -fcheck=all -ffpe-trap=invalid,zero,overflow,underflow")
-elseif(CMAKE_Fortran_COMPILER_ID MATCHES "Intel")
+elseif(CMAKE_Fortran_COMPILER_ID STREQUAL "Intel")
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2")
   set(CMAKE_Fortran_FLAGS_RELWITHDEBINFO "-g -traceback -O2")
   set(CMAKE_Fortran_FLAGS_DEBUG "-g -traceback -O0 -check all -fpe0 -ftrapuv -init=snan,arrays")
-elseif(CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC")
+elseif(CMAKE_Fortran_COMPILER_ID STREQUAL "NVHPC")
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2 -fast")
   set(CMAKE_Fortran_FLAGS_RELWITHDEBINFO "-g -traceback -O2 -fast")
   set(CMAKE_Fortran_FLAGS_DEBUG "-g -traceback -O0")
@@ -45,12 +53,10 @@ endif()
 add_executable(${ESMX_EXE_NAME} ESMX_App.F90)
 target_include_directories(${ESMX_EXE_NAME} PUBLIC ${PROJECT_BINARY_DIR})
 target_link_libraries(${ESMX_EXE_NAME} PUBLIC esmx_driver)
-set_target_properties(${ESMX_EXE_NAME} PROPERTIES INSTALL_RPATH_USE_LINK_PATH TRUE)
+set_target_properties(${ESMX_EXE_NAME} PROPERTIES
+  INSTALL_RPATH     "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR};${CMAKE_INSTALL_PREFIX}/lib"
+  LINKER_LANGUAGE   Fortran
+)
 
 # Install executable
-install(
-  TARGETS ${ESMX_EXE_NAME}
-  EXPORT esmx
-  RUNTIME DESTINATION bin
-  LIBRARY DESTINATION lib
-  ARCHIVE DESTINATION lib)
+install(TARGETS ${ESMX_EXE_NAME})

src/addon/ESMX/Comps/ESMX_Data/CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.22)
 
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
-find_package(ESMF 8.6.0 MODULE REQUIRED)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../cmake)
+find_package(ESMF 8.9.0 MODULE REQUIRED)
 
 if(NOT DEFINED CMAKE_Fortran_COMPILER)
   set(CMAKE_Fortran_COMPILER "${ESMF_F90COMPILER}")
@@ -11,19 +11,21 @@ if(NOT DEFINED CMAKE_Fortran_FLAGS)
 endif()
 
 project(ESMX_Data
-        VERSION 1.0
+        VERSION 8.9.0
         LANGUAGES Fortran)
 
-if(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
+include(GNUInstallDirs)
+
+if(CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
   set(CMAKE_Fortran_FLAGS -ffree-line-length-none)
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2")
   set(CMAKE_Fortran_FLAGS_RELWITHDEBINFO "-g -fbacktrace -O2")
   set(CMAKE_Fortran_FLAGS_DEBUG "-g -fbacktrace -O0 -fcheck=all -ffpe-trap=invalid,zero,overflow,underflow")
-elseif(CMAKE_Fortran_COMPILER_ID MATCHES "Intel")
+elseif(CMAKE_Fortran_COMPILER_ID STREQUAL "Intel")
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2")
   set(CMAKE_Fortran_FLAGS_RELWITHDEBINFO "-g -traceback -O2")
   set(CMAKE_Fortran_FLAGS_DEBUG "-g -traceback -O0 -check all -fpe0 -ftrapuv -init=snan,arrays")
-elseif(CMAKE_Fortran_COMPILER_ID MATCHES "NVHPC")
+elseif(CMAKE_Fortran_COMPILER_ID STREQUAL "NVHPC")
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2 -fast")
   set(CMAKE_Fortran_FLAGS_RELWITHDEBINFO "-g -traceback -O2 -fast")
   set(CMAKE_Fortran_FLAGS_DEBUG "-g -traceback -O0")
@@ -32,18 +34,11 @@ else()
 endif()
 
 add_library(ESMX_Data ESMX_Data.F90)
-target_link_libraries(ESMX_Data ESMF)
-
-install(TARGETS ESMX_Data
-        EXPORT ESMX_Data
-        LIBRARY DESTINATION lib
-        ARCHIVE DESTINATION lib
-        INCLUDES DESTINATION mod
+target_include_directories(ESMX_Data
+  INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_INCLUDEDIR}>
+  $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
 )
-install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/
-        DESTINATION mod
-        FILES_MATCHING
-        PATTERN "*.mod"
-        PATTERN "CMakeFiles" EXCLUDE
+set_target_properties(ESMX_Data
+  PROPERTIES Fortran_MODULE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_INCLUDEDIR}
 )
-install(EXPORT ESMX_Data DESTINATION cmake)
+target_link_libraries(ESMX_Data ESMF)

src/addon/ESMX/Driver/CMakeLists.txt

@@ -1,12 +1,12 @@
 cmake_minimum_required(VERSION 3.22)
 
 # load packages and modules
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake)
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/../cmake)
 set(Python_FIND_UNVERSIONED_NAMES "FIRST")
 set(Python_FIND_FRAMEWORK "LAST")
 set(Python_FIND_REGISTRY  "LAST")
 find_package(Python 3.5 REQUIRED COMPONENTS Interpreter)
-find_package(ESMF 8.6.0 MODULE REQUIRED)
+find_package(ESMF 8.9.0 MODULE REQUIRED)
 include(FetchContent)
 
 # esmx functions
@@ -16,7 +16,7 @@ function(esmx_check_ret RETVAL MESSAGE)
   endif()
 endfunction()
 
-# unset user ESMF variables stored in cache
+# unset user ESMX variables stored in cache
 get_cmake_property(_variableNames VARIABLES)
 foreach (_variableName ${_variableNames})
   if("${_variableName}" MATCHES "^ESMX_*")
@@ -103,6 +103,17 @@ elseif(DEFINED ESMX_BUILD_JOBS)
   set(ESMX_MAKE_BUILD_JOBS "--jobs=${ESMX_BUILD_JOBS}")
 endif()
 
+# diagnostic output
+message("")
+message("ESMX_BUILD_FILE ............. ${ESMX_BUILD_FILE}")
+message("ESMX_EXE_NAME ............... ${ESMX_EXE_NAME}")
+message("ESMX_DISABLE_COMPS .......... ${ESMX_DISABLE_COMPS}")
+#message("ESMX_CMAKE_BUILD_VERBOSE .... ${ESMX_CMAKE_BUILD_VERBOSE}")
+#message("ESMX_CMAKE_BUILD_JOBS ....... ${ESMX_CMAKE_BUILD_JOBS}")
+#message("ESMX_TEST_DIR ............... ${ESMX_TEST_DIR}")
+#message("ESMX_TEST_TASKS ............. ${ESMX_TEST_TASKS}")
+message("")
+
 # compiler options
 if(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
   set(CMAKE_Fortran_FLAGS_RELEASE "-O2")
@@ -181,6 +192,7 @@ set(CMP_OPTIONS BUILD_TYPE;
                 GIT_TAG;
                 GIT_DIR;
                 CMAKE_CONFIG;
+                CMAKE_TARGET;
                 INSTALL_PREFIX;
                 LIBRARY_DIR;
                 CONFIG_DIR;
@@ -209,6 +221,7 @@ foreach(CMP IN ITEMS ${COMPS})
   if(CMP_INSTALL_PREFIX STREQUAL "")
     set(CMP_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX})
   endif()
+  string(REPLACE "," ";" "${${CMP}-CMAKE_TARGET}" CMP_CMAKE_TARGET)
   string(REPLACE "," ";" "${${CMP}-LIBRARIES}" CMP_LIBRARIES)
   string(REPLACE "," ";" "${${CMP}-LINK_LIBRARIES}" CMP_LINK_LIBRARIES)
   string(REPLACE "," ";" "${${CMP}-LINK_PATHS}" CMP_LINK_PATHS)
@@ -318,7 +331,11 @@ foreach(CMP IN ITEMS ${COMPS})
 
   # build component with cmake
   if(${CMP_BUILD_TYPE} STREQUAL "cmake")
-    message(STATUS "ESMX building (CMAKE) - ${CMP} - ${CMP_SOURCE_DIR}")
+    # CMake builds are only configured at this stage!
+
+  # build component with cmake.external
+  elseif(${CMP_BUILD_TYPE} STREQUAL "cmake.external")
+    message(STATUS "ESMX building (CMAKE external) - ${CMP} - ${CMP_SOURCE_DIR}")
     find_file(FND_CMAKE_LISTS
       NAMES CMakeLists.txt cmakelists.txt CMAKELISTS.txt
       PATHS ${CMP_SOURCE_DIR}
@@ -415,53 +432,74 @@ foreach(CMP IN ITEMS ${COMPS})
     message(FATAL_ERROR "Invalid BUILD_TYPE: ${CMP_BUILD_TYPE} for ${CMP}")
   endif()
 
-  # include modules and link libraries
-  if(${CMP_LINK_INTO_APP} STREQUAL "True")
+  # look for CMake target and conditionally include config, modules, link libs
+  if(TARGET ${CMP_CMAKE_TARGET})
+    if(${CMP_LINK_INTO_APP} STREQUAL "True")
+      message(STATUS "ESMX Found CMake target dependency for ${CMP}: ${CMP_CMAKE_TARGET}")
+      target_link_libraries(esmx_driver PUBLIC ${CMP_CMAKE_TARGET})
+    endif()
+  elseif(${CMP_BUILD_TYPE} STREQUAL "cmake")
+    message(STATUS "ESMX Found CMake subdirectory for ${CMP}: ${CMP_SOURCE_DIR}")
+    # add source subdirectory with explicit binary directory path. This works for
+    # internal as well as external component source directories
+    add_subdirectory(${CMP_SOURCE_DIR} ${CMAKE_BINARY_DIR}/${CMP})
+    if(TARGET ${CMP_CMAKE_TARGET})
+      if(${CMP_LINK_INTO_APP} STREQUAL "True")
+        message(STATUS "ESMX Found CMake target dependency for ${CMP}: ${CMP_CMAKE_TARGET}")
+        target_link_libraries(esmx_driver PUBLIC ${CMP_CMAKE_TARGET})
+      endif()
+    else()
+      message(FATAL_ERROR "ESMX Did not find expected CMake target dependency for ${CMP} after adding subdirectory: ${CMP_CMAKE_TARGET}")
+    endif()
+  else()
+    # not a known CMake target -> find the config file
     find_file(FND_CMAKE_CONFIG
       NAMES ${CMP_CMAKE_CONFIG}
       HINTS ${CMP_INSTALL_PREFIX} ${CMAKE_BINARY_DIR}/${CMP}
       PATH_SUFFIXES ${CMP_CONFIG_DIR} "." "cmake" "config"
       NO_CACHE NO_DEFAULT_PATH
     )
     if(FND_CMAKE_CONFIG)
+      message(STATUS "ESMX found CMake configuration for ${CMP}: ${FND_CMAKE_CONFIG}")
       include(${FND_CMAKE_CONFIG})
     endif()
+    unset(FND_CMAKE_CONFIG)
+    # not a known CMake target -> find the Fortran module
     find_path(FND_FORT_MODULE
       NAMES ${CMP_FORT_MODULE}
       HINTS ${CMP_INSTALL_PREFIX} ${CMAKE_BINARY_DIR}/${CMP}
       PATH_SUFFIXES ${CMP_INCLUDE_DIR} "." "include" "mod"
       NO_CACHE NO_DEFAULT_PATH
     )
     if(FND_FORT_MODULE)
+      message(STATUS "ESMX Found Fortran module ${CMP_FORT_MODULE} for ${CMP} in: ${FND_FORT_MODULE}")
       target_include_directories(esmx_driver PUBLIC ${FND_FORT_MODULE})
-    elseif(NOT FND_CMAKE_CONFIG)
-      message(FATAL_ERROR "Cannot find fort_module ${CMP_FORT_MODULE} in ${CMP_INSTALL_PREFIX}")
+    else()
+      message(FATAL_ERROR "Cannot find fort_module ${CMP_FORT_MODULE} for ${CMP} in ${CMP_INSTALL_PREFIX}")
     endif()
     unset(FND_FORT_MODULE)
-    unset(FND_CMAKE_CONFIG)
+    # not a known CMake target -> find the libraries
     foreach(CMP_LIBRARY IN ITEMS ${CMP_LIBRARIES})
-      if(TARGET ${CMP_LIBRARY})
-        target_link_libraries(esmx_driver PUBLIC ${CMP_LIBRARY})
-      else()
-        find_library(FND_LIBRARY
-          NAMES ${CMP_LIBRARY}
-          HINTS ${CMP_INSTALL_PREFIX} ${CMAKE_BINARY_DIR}/${CMP}
-          PATH_SUFFIXES ${CMP_LIBRARY_DIR} "." "lib" "lib64"
-          NO_CACHE NO_DEFAULT_PATH
-        )
-        if(NOT FND_LIBRARY)
-          message(FATAL_ERROR "Cannot find libraries ${CMP_LIBRARY} in ${CMP_INSTALL_PREFIX}")
-        endif()
-        target_link_libraries(esmx_driver PUBLIC ${FND_LIBRARY})
-        unset(FND_LIBRARY)
+      find_library(FND_LIBRARY
+        NAMES ${CMP_LIBRARY}
+        HINTS ${CMP_INSTALL_PREFIX} ${CMAKE_BINARY_DIR}/${CMP}
+        PATH_SUFFIXES ${CMP_LIBRARY_DIR} "." "lib" "lib64"
+        NO_CACHE NO_DEFAULT_PATH
+      )
+      if(NOT FND_LIBRARY)
+        message(FATAL_ERROR "Cannot find libraries ${CMP_LIBRARY} for ${CMP} in ${CMP_INSTALL_PREFIX}")
       endif()
+      message(STATUS "ESMX Found link library for ${CMP}: ${FND_LIBRARY}")
+      target_link_libraries(esmx_driver PUBLIC ${FND_LIBRARY})
+      unset(FND_LIBRARY)
     endforeach()
   endif()
 
   # link external libraries
   if(${CMP_LINK_INTO_APP} STREQUAL "True")
     foreach(CMP_LINK_LIBRARY IN ITEMS ${CMP_LINK_LIBRARIES})
       if(TARGET ${CMP_LINK_LIBRARY})
+        message(STATUS "ESMX Found external link library for ${CMP}: ${CMP_LINK_LIBRARY}")
         target_link_libraries(esmx_driver PUBLIC ${CMP_LINK_LIBRARY})
       else()
         find_library(FND_LINK_LIBRARY
@@ -471,8 +509,9 @@ foreach(CMP IN ITEMS ${COMPS})
           NO_CACHE
         )
         if(NOT FND_LINK_LIBRARY)
-          message(FATAL_ERROR "Cannot find link_libraries ${CMP_LINK_LIBRARY} in ${CMP_LINK_PATHS}")
+          message(FATAL_ERROR "Cannot find link_libraries ${CMP_LINK_LIBRARY} for ${CMP} in ${CMP_LINK_PATHS}")
         endif()
+        message(STATUS "ESMX Found external link library for ${CMP}: ${FND_LINK_LIBRARY}")
         target_link_libraries(esmx_driver PUBLIC ${FND_LINK_LIBRARY})
         unset(FND_LINK_LIBRARY)
       endif()
@@ -484,7 +523,7 @@ foreach(CMP IN ITEMS ${COMPS})
     if(CMP_TEST_DIR STREQUAL "")
       message(WARNING "No test directory provided for ${CMP}")
     elseif(NOT EXISTS ${CMP_TEST_DIR})
-      message(FATAL_ERROR "Cannot find test directory ${CMP_TEST_DIR}")
+      message(FATAL_ERROR "Cannot find test directory for ${CMP}: ${CMP_TEST_DIR}")
     else()
       if(CMP_TEST_EXE STREQUAL "")
         set(CMP_TEST_EXE ${ESMX_TEST_EXE})
@@ -508,7 +547,7 @@ foreach(CMP IN ITEMS ${COMPS})
         NO_CACHE
       )
       if(NOT FND_TEST_EXE)
-        message(FATAL_ERROR "Cannot find test executable: ${CMP_TEST_EXE}")
+        message(FATAL_ERROR "Cannot find test executable for ${CMP}: ${CMP_TEST_EXE}")
       endif()
 
       # add test