CheckCXXSourceCompiles.cmake 3.82 KB
Newer Older
1 2 3 4 5 6
#.rst:
# CheckCXXSourceCompiles
# ----------------------
#
# Check if given C++ source compiles and links into an executable
#
7
# CHECK_CXX_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])
8 9 10 11 12
#
# ::
#
#   <code>       - source code to try to compile, must define 'main'
#   <var>        - variable to store whether the source code compiled
13
#                  Will be created as an internal cache variable.
14 15 16 17 18 19 20 21 22 23 24
#   <fail-regex> - fail if test output matches this regex
#
# The following variables may be set before calling this macro to modify
# the way the check is run:
#
# ::
#
#   CMAKE_REQUIRED_FLAGS = string of compile command line flags
#   CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
#   CMAKE_REQUIRED_INCLUDES = list of include directories
#   CMAKE_REQUIRED_LIBRARIES = list of libraries to link
25
#   CMAKE_REQUIRED_QUIET = execute quietly without messages
Andy Cedilnik's avatar
Andy Cedilnik committed
26

27 28 29 30 31 32 33 34 35 36
#=============================================================================
# Copyright 2005-2009 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
37
# (To distribute this file outside of CMake, substitute the full
38 39
#  License text for the above reference.)

40 41


42
macro(CHECK_CXX_SOURCE_COMPILES SOURCE VAR)
43
  if(NOT DEFINED "${VAR}")
44 45 46 47 48 49 50 51 52 53 54
    set(_FAIL_REGEX)
    set(_key)
    foreach(arg ${ARGN})
      if("${arg}" MATCHES "^(FAIL_REGEX)$")
        set(_key "${arg}")
      elseif(_key)
        list(APPEND _${_key} "${arg}")
      else()
        message(FATAL_ERROR "Unknown argument:\n  ${arg}\n")
      endif()
    endforeach()
55

56
    set(MACRO_CHECK_FUNCTION_DEFINITIONS
Andy Cedilnik's avatar
Andy Cedilnik committed
57
      "-D${VAR} ${CMAKE_REQUIRED_FLAGS}")
58 59
    if(CMAKE_REQUIRED_LIBRARIES)
      set(CHECK_CXX_SOURCE_COMPILES_ADD_LIBRARIES
60
        LINK_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES})
61
    else()
62
      set(CHECK_CXX_SOURCE_COMPILES_ADD_LIBRARIES)
63
    endif()
64 65
    if(CMAKE_REQUIRED_INCLUDES)
      set(CHECK_CXX_SOURCE_COMPILES_ADD_INCLUDES
Andy Cedilnik's avatar
Andy Cedilnik committed
66
        "-DINCLUDE_DIRECTORIES:STRING=${CMAKE_REQUIRED_INCLUDES}")
67
    else()
68
      set(CHECK_CXX_SOURCE_COMPILES_ADD_INCLUDES)
69
    endif()
70
    file(WRITE "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/src.cxx"
71
      "${SOURCE}\n")
Andy Cedilnik's avatar
Andy Cedilnik committed
72

73 74 75
    if(NOT CMAKE_REQUIRED_QUIET)
      message(STATUS "Performing Test ${VAR}")
    endif()
76
    try_compile(${VAR}
Andy Cedilnik's avatar
Andy Cedilnik committed
77
      ${CMAKE_BINARY_DIR}
78
      ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/src.cxx
79
      COMPILE_DEFINITIONS ${CMAKE_REQUIRED_DEFINITIONS}
80
      ${CHECK_CXX_SOURCE_COMPILES_ADD_LIBRARIES}
81
      CMAKE_FLAGS -DCOMPILE_DEFINITIONS:STRING=${MACRO_CHECK_FUNCTION_DEFINITIONS}
Andy Cedilnik's avatar
Andy Cedilnik committed
82 83
      "${CHECK_CXX_SOURCE_COMPILES_ADD_INCLUDES}"
      OUTPUT_VARIABLE OUTPUT)
84

85 86 87 88 89
    foreach(_regex ${_FAIL_REGEX})
      if("${OUTPUT}" MATCHES "${_regex}")
        set(${VAR} 0)
      endif()
    endforeach()
90

91 92
    if(${VAR})
      set(${VAR} 1 CACHE INTERNAL "Test ${VAR}")
93 94 95
      if(NOT CMAKE_REQUIRED_QUIET)
        message(STATUS "Performing Test ${VAR} - Success")
      endif()
96
      file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
97
        "Performing C++ SOURCE FILE Test ${VAR} succeeded with the following output:\n"
Andy Cedilnik's avatar
Andy Cedilnik committed
98
        "${OUTPUT}\n"
Bill Hoffman's avatar
Bill Hoffman committed
99
        "Source file was:\n${SOURCE}\n")
100
    else()
101 102 103
      if(NOT CMAKE_REQUIRED_QUIET)
        message(STATUS "Performing Test ${VAR} - Failed")
      endif()
104 105
      set(${VAR} "" CACHE INTERNAL "Test ${VAR}")
      file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
Andy Cedilnik's avatar
Andy Cedilnik committed
106 107
        "Performing C++ SOURCE FILE Test ${VAR} failed with the following output:\n"
        "${OUTPUT}\n"
Bill Hoffman's avatar
Bill Hoffman committed
108
        "Source file was:\n${SOURCE}\n")
109 110 111
    endif()
  endif()
endmacro()
Andy Cedilnik's avatar
Andy Cedilnik committed
112