cmake/gmxManagePluginSupport.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2016,2017,2020, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 # Executing this macro will add the option GMX_USE_PLUGINS, which
  36 # makes it possible to dynamically load modules at runtime.
  37 # This is a very neat feature, and should virtually always work
  38 # on Linux, but for now it will not work without shared libraries.
  39 # For this reason we disable it by default, to avoid triggering
  40 # errors here when dynamic libraries are disabled elsewhere.
  41 macro(gmx_manage_plugin_support)
  42     option(GMX_USE_PLUGINS "Enable support for dynamic plugins (e.g. VMD-supported file formats)" OFF)
  43     mark_as_advanced(GMX_USE_PLUGINS)
  44
  45     if(GMX_USE_PLUGINS)
  46
  47         message(STATUS "Checking build environment for dynamic plugins")
  48
  49         if(NOT BUILD_SHARED_LIBS)
  50             message(FATAL_ERROR "Shared libraries not built - required for dynamic plugins")
  51         endif()
  52
  53         # Plugins are supported natively on Windows, so nothing to check if WIN32 is set
  54
  55         if (NOT WIN32)
  56             # TODO Make a proper find_package for dlopen to find
  57             # dlfcn.h. The CMake variable CMAKE_DL_LIBS works magically
  58             # for the library, however.
  59             include(gmxTestdlopen)
  60             gmx_test_dlopen(HAVE_DLOPEN)
  61             if(NOT HAVE_DLOPEN)
  62                 message(FATAL_ERROR "dlopen() support missing - required for dynamic plugins")
  63             endif()
  64         endif()
  65
  66         message(STATUS "Checking build environment for dynamic plugins - supported")
  67
  68         list(APPEND GMX_EXTRA_LIBRARIES ${CMAKE_DL_LIBS}) # magic cross-platform pre-set variable for dlopen library
  69         set(PKG_DL_LIBS "-l${CMAKE_DL_LIBS}")
  70
  71     endif()
  72 endmacro()