admin/includedeps.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2012,2013,2014, 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 function (generate_module_file_list SRCDIR OUTFILE MODE)
  36     set(_file_list)
  37     file(GLOB_RECURSE _file_list
  38         ${SRCDIR}/src/gromacs/*.cpp
  39         ${SRCDIR}/src/gromacs/*.c
  40         ${SRCDIR}/src/gromacs/*.cu
  41         ${SRCDIR}/src/gromacs/*.h
  42         ${SRCDIR}/src/gromacs/*.cuh
  43         ${SRCDIR}/src/testutils/*.cpp
  44         ${SRCDIR}/src/testutils/*.h
  45         )
  46     string(REPLACE ";" "\n" _file_list "${_file_list}")
  47     file(WRITE ${OUTFILE} "${_file_list}")
  48 endfunction ()
  49
  50 function (generate_installed_file_list SRCDIR BUILDDIR OUTFILE)
  51     file(GLOB_RECURSE INSTALL_FILE_LIST "${BUILDDIR}/cmake_install.cmake")
  52     set(MATCH_REGEX "${SRCDIR}/.*\\.h")
  53     set(HEADER_LIST)
  54     foreach (INSTALL_FILE ${INSTALL_FILE_LIST})
  55         file(STRINGS ${INSTALL_FILE} HEADER_LINES REGEX "${MATCH_REGEX}")
  56         foreach (HEADER_LINE ${HEADER_LINES})
  57             string (REGEX MATCH "${MATCH_REGEX}" HEADER "${HEADER_LINE}")
  58             list(APPEND HEADER_LIST "${HEADER}")
  59         endforeach ()
  60     endforeach ()
  61     string(REPLACE ";" "\n" HEADER_LIST "${HEADER_LIST}")
  62     file(WRITE ${OUTFILE} "${HEADER_LIST}")
  63 endfunction ()
  64
  65 if (NOT DEFINED SRCDIR OR NOT DEFINED BUILDDIR OR NOT DEFINED OUTDIR)
  66     message(FATAL_ERROR "Required input variable (SRCDIR, BUILDDIR, OUTDIR) not set")
  67 endif()
  68
  69 if (NOT DEFINED PYTHON_EXECUTABLE)
  70     set(PYTHON_EXECUTABLE python)
  71 endif()
  72
  73 if (NOT DEFINED MODE)
  74     set(MODE "CHECK")
  75 endif()
  76
  77 if (MODE STREQUAL "CHECK")
  78     set(GRAPHOPTIONS --check)
  79 elseif (MODE STREQUAL "CHECKDOC")
  80     # TODO: Add --warn-undoc after most code has at least rudimentary comments.
  81     set(GRAPHOPTIONS --check --check-doc)
  82 elseif (MODE STREQUAL "GRAPHS")
  83     set(GRAPHOPTIONS
  84         --module-graph module-deps.dot --module-file-graphs
  85         -o ${OUTDIR})
  86 else()
  87     message(FATAL_ERROR "Unknown mode ${MODE}")
  88 endif()
  89
  90 file(MAKE_DIRECTORY ${OUTDIR})
  91 generate_module_file_list(${SRCDIR} ${OUTDIR}/module-files.txt ${MODE})
  92 generate_installed_file_list(${SRCDIR} ${BUILDDIR} ${OUTDIR}/installed-headers.txt)
  93 execute_process(COMMAND ${PYTHON_EXECUTABLE} ${SRCDIR}/admin/includedeps.py
  94                         -f ${OUTDIR}/module-files.txt
  95                         --installed ${OUTDIR}/installed-headers.txt
  96                         -R ${SRCDIR}/src -R ${BUILDDIR}/src
  97                         -I ${SRCDIR}/src/gromacs/legacyheaders
  98                         -I ${BUILDDIR}/src/gromacs/utility
  99                         ${GRAPHOPTIONS})
 100
 101 if (MODE STREQUAL "GRAPHS" AND DOT_EXECUTABLE)
 102     file(GLOB DOT_INPUT_FILES ${OUTDIR}/*.dot)
 103     execute_process(COMMAND ${DOT_EXECUTABLE} -Tpng -O ${DOT_INPUT_FILES})
 104 endif()