Generate man pages and completions by default if possible
[alexxy/gromacs.git] / src / programs / CMakeLists.txt
index 70c646835691dd3e7dee50450a56015dd7f5c096..1b6c4518cd978e3370eb920d49522ddace8f9b65 100644 (file)
@@ -1,7 +1,7 @@
 #
 # This file is part of the GROMACS molecular simulation package.
 #
-# Copyright (c) 2010,2011,2012,2013, by the GROMACS development team, led by
+# Copyright (c) 2010,2011,2012,2013,2014, 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.
 # To help us fund GROMACS development, we humbly ask that you cite
 # the research papers on the package. Check out http://www.gromacs.org.
 
-include_directories(${CMAKE_SOURCE_DIR}/src/gromacs/gmxpreprocess)
-
 file(GLOB MDRUN_SOURCES mdrun/*.c mdrun/*.cpp)
-if(GMX_X11)
-    file(GLOB VIEW_SOURCES view/*.cpp)
-else()
-    file(GLOB VIEW_SOURCES view/view.cpp)
-endif()
+# make an "object library" that we can re-use for multiple targets
+add_library(mdrun_objlib OBJECT ${MDRUN_SOURCES})
 
 if(GMX_FAHCORE)
-    add_library(fahcore ${MDRUN_SOURCES})
+    # The lack of a real source file here alongside the object library
+    # may break some generators, according to CMake documentation. If
+    # so, we can consider adding some dummy file to make it work.
+    add_library(fahcore $<TARGET_OBJECTS:mdrun_objlib>)
 elseif(GMX_BUILD_MDRUN_ONLY)
-    add_executable(mdrun ${MDRUN_SOURCES} mdrun_main.cpp)
-    target_link_libraries(mdrun
-        ${GMX_EXTRA_LIBRARIES} libgromacs ${GMX_EXE_LINKER_FLAGS})
+    add_executable(mdrun $<TARGET_OBJECTS:mdrun_objlib> mdrun_main.cpp)
+    target_link_libraries(mdrun libgromacs ${GMX_EXE_LINKER_FLAGS})
+    set(BINARY_NAME "mdrun${GMX_BINARY_SUFFIX}")
     set_target_properties(mdrun PROPERTIES
-        OUTPUT_NAME "mdrun${GMX_BINARY_SUFFIX}"
+        OUTPUT_NAME "${BINARY_NAME}"
         COMPILE_FLAGS "${OpenMP_C_FLAGS}")
     install(TARGETS mdrun DESTINATION ${BIN_INSTALL_DIR} COMPONENT mdrun)
+    file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/gmx-completion-${BINARY_NAME}.bash
+         "complete -o nospace -F _gmx_mdrun_compl ${BINARY_NAME}")
+    install(FILES ${CMAKE_CURRENT_BINARY_DIR}/gmx-completion-${BINARY_NAME}.bash
+            DESTINATION ${BIN_INSTALL_DIR} COMPONENT runtime)
 else()
-    file(GLOB GMX_EXECUTABLE_SOURCES gmx/*.c gmx/*.cpp)
-    add_executable(gmx ${GMX_EXECUTABLE_SOURCES} ${MDRUN_SOURCES} ${VIEW_SOURCES})
-    target_link_libraries(gmx
-        ${GMX_EXTRA_LIBRARIES} libgromacs ${GMX_EXE_LINKER_FLAGS})
+    file(GLOB GMX_MAIN_SOURCES gmx.cpp legacymodules.cpp)
+    if(GMX_X11)
+        file(GLOB VIEW_SOURCES view/*.cpp)
+    else()
+        file(GLOB VIEW_SOURCES view/view.cpp)
+    endif()
+    add_library(view_objlib OBJECT ${VIEW_SOURCES})
+    add_executable(gmx
+        ${GMX_MAIN_SOURCES}
+        $<TARGET_OBJECTS:mdrun_objlib>
+        $<TARGET_OBJECTS:view_objlib>)
+    target_link_libraries(gmx libgromacs ${GMX_EXE_LINKER_FLAGS})
     if(GMX_X11)
         target_link_libraries(gmx ${X11_LIBRARIES})
     endif()
+    set(BINARY_NAME "gmx${GMX_BINARY_SUFFIX}")
     set_target_properties(gmx PROPERTIES
-        OUTPUT_NAME "gmx${GMX_BINARY_SUFFIX}"
+        OUTPUT_NAME "${BINARY_NAME}"
         COMPILE_FLAGS "${OpenMP_C_FLAGS}")
+    install(TARGETS gmx
+            RUNTIME DESTINATION ${BIN_INSTALL_DIR})
 
-    configure_file(CreateLinks.cmake.cmakein CreateLinks.cmake @ONLY)
-    set(CREATE_LINKS_SCRIPT ${CMAKE_CURRENT_BINARY_DIR}/CreateLinks.cmake)
-    # TODO: Currently this rule is always run and recreates the symlinks;
-    # it would be best to just adapt the rest of the build such that this is
-    # never needed (for now, this makes the binary directory seem like it was
-    # earlier).
-    add_custom_target(links ALL
-        ${CMAKE_COMMAND}
-            -DBINARY_DIRECTORY=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
-            -DQUIETLY=TRUE
-            -P ${CREATE_LINKS_SCRIPT}
-        DEPENDS gmx
-        COMMENT "Creating symlinks for alternative binary names"
-        VERBATIM)
+    ########################
+    # Completion generation
 
-    # TODO: Create man pages (currently not working since the old mechanism
-    # requires a target for each binary to which one can add a post-build role, and
-    # the symlinks do not have such targets).
+    include(gmxCustomCommandUtilities)
+
+    set(COMPLETION_DIR ${CMAKE_CURRENT_SOURCE_DIR}/completion)
+    # Using GMX_BUILD_HELP here is somewhat confusing, but the conditions when
+    # this can be done are exactly the same (ability to run the compiled
+    # binaries).
+    if (GMX_BUILD_HELP)
+        gmx_add_custom_output_target(completion OUTPUT STAMP
+            COMMAND ${CMAKE_COMMAND}
+                -D GMX_EXECUTABLE=$<TARGET_FILE:gmx>
+                -D ERRORS_ARE_FATAL=${GMX_BUILD_HELP_FORCE}
+                -P ${CMAKE_CURRENT_SOURCE_DIR}/BuildCompletions.cmake
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            DEPENDS gmx ${CMAKE_CURRENT_SOURCE_DIR}/BuildCompletions.cmake
+            COMMENT "Generating command-line completions for programs")
+        set_target_properties(completion PROPERTIES EXCLUDE_FROM_ALL OFF)
+        set_directory_properties(PROPERTIES
+            ADDITIONAL_MAKE_CLEAN_FILES "completion")
+        set(COMPLETION_DIR ${CMAKE_CURRENT_BINARY_DIR}/completion)
+    endif()
+    if (SOURCE_IS_SOURCE_DISTRIBUTION OR GMX_BUILD_HELP)
+        install(DIRECTORY ${COMPLETION_DIR}/
+                DESTINATION ${BIN_INSTALL_DIR} COMPONENT runtime OPTIONAL)
+        file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/gmx-completion-${BINARY_NAME}.bash
+             "complete -o nospace -F _gmx_compl ${BINARY_NAME}")
+        install(FILES ${CMAKE_CURRENT_BINARY_DIR}/gmx-completion-${BINARY_NAME}.bash
+                DESTINATION ${BIN_INSTALL_DIR} COMPONENT runtime)
+    endif()
 
-    install(TARGETS gmx
-            RUNTIME DESTINATION ${BIN_INSTALL_DIR})
     if (GMX_SYMLINK_OLD_BINARY_NAMES)
+        configure_file(CreateLinks.cmake.cmakein CreateLinks.cmake @ONLY)
+        set(CREATE_LINKS_SCRIPT ${CMAKE_CURRENT_BINARY_DIR}/CreateLinks.cmake)
         install(SCRIPT ${CREATE_LINKS_SCRIPT} COMPONENT links)
-    endif ()
+    endif()
+
+    if(BUILD_TESTING)
+        add_subdirectory(mdrun/tests)
+    endif()
 endif()