Use GMXAPI CMake option guard for gmxapi target declaration.
authorM. Eric Irrgang <mei2n@virginia.edu>
Wed, 29 Jul 2020 12:48:17 +0000 (12:48 +0000)
committerPaul Bauer <paul.bauer.q@gmail.com>
Wed, 29 Jul 2020 12:48:17 +0000 (12:48 +0000)
A recent change moved the declaration of the `gmxapi` CMake library
target outside of a conditional. This change isolates the initial
configuration of the CMake target and restores the option guard.

Fixes #3604.

api/CMakeLists.txt
api/gmxapi.cmake [new file with mode: 0644]
src/CMakeLists.txt

index e8f72b921524136c93281ec54ae76ebcb6255555..bdbd3ead6c7bb876dd286bb0990794613e319aeb 100644 (file)
 # To help us fund GROMACS development, we humbly ask that you cite
 # the research papers on the package. Check out http://www.gromacs.org.
 
-# This list file provides the Gromacs::gmxapi cmake module.
-
-##########################
-# Set up public interface.
-
-# Note: GROMACS releases have a single-integer monotonic version in GMX_API_VERSION
-# and LIBRARY_VERSION annotates the shared object for libgromacs. GMXAPI versioning
-# is not synchronized to releases and may increment faster or slower.
-#
-# Prior to 0.1, GMXAPI patch levels are used to mark short term development cycles
-# and allow compatibility checks for client software of the early releases.
-#
-# gmxapi 0.2 will be the first release candidate for gmxapi 1.0 and will attempt
-# to establish compatibility guarantees consistent with semantic versioning.
-# (https://semver.org). When the API is deemed suitably stable, gmxapi 1.0 should
-# be tagged. Official GROMACS releases should be mappable to a distinct gmxapi
-# release string. For roadmap details, see https://gitlab.com/gromacs/gromacs/-/issues/2585
-set(GMXAPI_MAJOR 0)
-set(GMXAPI_MINOR 1)
-set(GMXAPI_PATCH 0)
-set(GMXAPI_RELEASE ${GMXAPI_MAJOR}.${GMXAPI_MINOR}.${GMXAPI_PATCH})
-
-add_library(gmxapi)
-set_target_properties(gmxapi PROPERTIES
-                      VERSION_MAJOR ${GMXAPI_MAJOR}
-                      VERSION_MINOR ${GMXAPI_MINOR}
-                      VERSION_PATCH ${GMXAPI_PATCH}
-                      RELEASE ${GMXAPI_RELEASE})
-
-##########################
-# Define public interface.
-#
-# The include directory should be mostly empty so that we can use it internally as
-# the public interface include directory during build and testing.
-configure_file(include/gmxapiversion.h.in include/gmxapi/version.h)
-target_include_directories(gmxapi PUBLIC
-                           $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-                           $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
-                           $<INSTALL_INTERFACE:include>
-                           )
-
-###############################
-# Install the public interface.
-#
-# If any item begins in a generator expression it must evaluate to a full path,
-# so we can't just use something like $<TARGET_PROPERTIES:gmxapiPublicHeaders,SOURCES>.
-# Instead, we use a canonical list defined in the parent scope.
-
-# Install public header directories.
-install(DIRECTORY include/gmxapi
-        DESTINATION include)
-
-# Install "configured" files from the build tree.
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/gmxapi/version.h
-        DESTINATION include/gmxapi)
 
+# Activate targets for new C++ API components and docs.
+if(GMX_NATIVE_WINDOWS OR GMX_BUILD_MDRUN_ONLY)
+    # GMXAPI has not been tested in Microsoft environments.
+    # GMXAPI relies on libgromacs and is incompatible with an `mdrun`-only build.
+    # GMXAPI requires position-independent code
+    set(_GMXAPI_DEFAULT OFF)
+else()
+    set(_GMXAPI_DEFAULT ON)
+endif()
+option(GMXAPI "Install GROMACS API." ${_GMXAPI_DEFAULT})
+if (GMXAPI)
+    include(gmxapi.cmake)
+endif()
diff --git a/api/gmxapi.cmake b/api/gmxapi.cmake
new file mode 100644 (file)
index 0000000..e8f72b9
--- /dev/null
@@ -0,0 +1,90 @@
+#
+# This file is part of the GROMACS molecular simulation package.
+#
+# Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
+# Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+# and including many others, as listed in the AUTHORS file in the
+# top-level source directory and at http://www.gromacs.org.
+#
+# GROMACS is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public License
+# as published by the Free Software Foundation; either version 2.1
+# of the License, or (at your option) any later version.
+#
+# GROMACS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with GROMACS; if not, see
+# http://www.gnu.org/licenses, or write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
+#
+# If you want to redistribute modifications to GROMACS, please
+# consider that scientific software is very special. Version
+# control is crucial - bugs must be traceable. We will be happy to
+# consider code for inclusion in the official distribution, but
+# derived work must not be called official GROMACS. Details are found
+# in the README & COPYING files - if they are missing, get the
+# official version at http://www.gromacs.org.
+#
+# To help us fund GROMACS development, we humbly ask that you cite
+# the research papers on the package. Check out http://www.gromacs.org.
+
+# This list file provides the Gromacs::gmxapi cmake module.
+
+##########################
+# Set up public interface.
+
+# Note: GROMACS releases have a single-integer monotonic version in GMX_API_VERSION
+# and LIBRARY_VERSION annotates the shared object for libgromacs. GMXAPI versioning
+# is not synchronized to releases and may increment faster or slower.
+#
+# Prior to 0.1, GMXAPI patch levels are used to mark short term development cycles
+# and allow compatibility checks for client software of the early releases.
+#
+# gmxapi 0.2 will be the first release candidate for gmxapi 1.0 and will attempt
+# to establish compatibility guarantees consistent with semantic versioning.
+# (https://semver.org). When the API is deemed suitably stable, gmxapi 1.0 should
+# be tagged. Official GROMACS releases should be mappable to a distinct gmxapi
+# release string. For roadmap details, see https://gitlab.com/gromacs/gromacs/-/issues/2585
+set(GMXAPI_MAJOR 0)
+set(GMXAPI_MINOR 1)
+set(GMXAPI_PATCH 0)
+set(GMXAPI_RELEASE ${GMXAPI_MAJOR}.${GMXAPI_MINOR}.${GMXAPI_PATCH})
+
+add_library(gmxapi)
+set_target_properties(gmxapi PROPERTIES
+                      VERSION_MAJOR ${GMXAPI_MAJOR}
+                      VERSION_MINOR ${GMXAPI_MINOR}
+                      VERSION_PATCH ${GMXAPI_PATCH}
+                      RELEASE ${GMXAPI_RELEASE})
+
+##########################
+# Define public interface.
+#
+# The include directory should be mostly empty so that we can use it internally as
+# the public interface include directory during build and testing.
+configure_file(include/gmxapiversion.h.in include/gmxapi/version.h)
+target_include_directories(gmxapi PUBLIC
+                           $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+                           $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
+                           $<INSTALL_INTERFACE:include>
+                           )
+
+###############################
+# Install the public interface.
+#
+# If any item begins in a generator expression it must evaluate to a full path,
+# so we can't just use something like $<TARGET_PROPERTIES:gmxapiPublicHeaders,SOURCES>.
+# Instead, we use a canonical list defined in the parent scope.
+
+# Install public header directories.
+install(DIRECTORY include/gmxapi
+        DESTINATION include)
+
+# Install "configured" files from the build tree.
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/gmxapi/version.h
+        DESTINATION include/gmxapi)
+
index 4d75aabea445d73d8c4af593adbd60761d3ffe73..8c7107072d8429bae262c9e975d5bea2043b96a4 100644 (file)
@@ -129,15 +129,6 @@ add_subdirectory(gromacs)
 add_subdirectory(programs)
 
 # Activate targets for new C++ API components and docs.
-if(GMX_NATIVE_WINDOWS OR GMX_BUILD_MDRUN_ONLY OR NOT BUILD_SHARED_LIBS)
-    # GMXAPI has not been tested in Microsoft environments.
-    # GMXAPI relies on libgromacs and is incompatible with an `mdrun`-only build.
-    # GMXAPI requires position-independent code
-    set(_GMXAPI_DEFAULT OFF)
-else()
-    set(_GMXAPI_DEFAULT ON)
-endif()
-option(GMXAPI "Experimental external interfaces" ${_GMXAPI_DEFAULT})
 if (GMXAPI)
    if (GMX_BUILD_MDRUN_ONLY)
        message(FATAL_ERROR "GMXAPI relies on libgromacs and is incompatible with GMX_BUILD_MDRUN_ONLY.")