cmake/gmxTestImageMagick.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2018,2019,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 # - Define macro to check if image conversion using ImageMagick convert
  36 # actually works, because recent changes to it made it necessary to set
  37 # a number of flags in /etc/ImageMagick-6/policy.xml. If a sample
  38 # conversion fails due to this, the user is informed about this being
  39 # a possible issue.
  40 #
  41 #  GMX_TEST_IMAGEMAGICK(VARIABLE)
  42 #
  43 #  VARIABLE will be set in the cache to either true or false
  44 #  if convert is working or not.
  45
  46 function(GMX_TEST_IMAGEMAGICK VARIABLE)
  47     if(NOT ${ImageMagick_CONVERT_FOUND})
  48         MESSAGE(STATUS "No image conversion possible without ImageMagick")
  49         set(value_ OFF)
  50     elseif(NOT DEFINED ${VARIABLE})
  51         set(TEMPDIR "${CMAKE_CURRENT_BINARY_DIR}/imagemagicktmp")
  52         FILE(MAKE_DIRECTORY ${TEMPDIR})
  53         set(SAMPLE_INPUT "${CMAKE_CURRENT_SOURCE_DIR}/cmake/TestImageMagickConvert.pdf")
  54         set(SAMPLE_OUTPUT "${TEMPDIR}/TestImageMagickConvert.png")
  55         execute_process(
  56             COMMAND ${ImageMagick_convert_EXECUTABLE}  ${SAMPLE_INPUT} -antialias -quality 03 -quiet -pointsize 12 -density 1200 -units PixelsPerInch ${SAMPLE_OUTPUT}
  57             RESULT_VARIABLE TEST_OUTPUT
  58             OUTPUT_QUIET
  59             ERROR_QUIET
  60             )
  61         if (EXISTS ${SAMPLE_OUTPUT})
  62             set(value_ ON)
  63         else()
  64             if (GMX_BUILD_MANUAL)
  65                 set(type_ "WARNING")
  66             else()
  67                 set(type_ "STATUS")
  68             endif()
  69             MESSAGE(${type_} "Could not convert sample image, ImageMagick convert can not be used. A possible way to fix it can be found here: https://alexvanderbist.com/2018/fixing-imagick-error-unauthorized")
  70             set(value_ OFF)
  71         endif()
  72         FILE(REMOVE_RECURSE ${TEMPDIR})
  73     endif()
  74     if(NOT DEFINED ${VARIABLE})
  75         set(${VARIABLE} ${value_} CACHE INTERNAL "Test if image conversion works")
  76         mark_as_advanced(${VARIABLE})
  77     endif()
  78 endfunction()