Modules/CheckOBJCXXCompilerFlag.cmake

   1 # Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   2 # file Copyright.txt or https://cmake.org/licensing for details.
   3
   4 #[=======================================================================[.rst:
   5 CheckOBJCXXCompilerFlag
   6 -----------------------
   7
   8 .. versionadded:: 3.16
   9
  10 Check whether the Objective-C++ compiler supports a given flag.
  11
  12 .. command:: check_objcxx_compiler_flag
  13
  14   .. code-block:: cmake
  15
  16     check_objcxx_compiler_flag(<flag> <resultVar>)
  17
  18   Check that the ``<flag>`` is accepted by the compiler without
  19   a diagnostic.  Stores the result in an internal cache entry
  20   named ``<resultVar>``.
  21
  22 A positive result from this check indicates only that the compiler did not
  23 issue a diagnostic message when given the flag.  Whether the flag has any
  24 effect or even a specific one is beyond the scope of this module.
  25
  26 The check is only performed once, with the result cached in the variable named
  27 by ``<resultVar>``. Every subsequent CMake run will reuse this cached value
  28 rather than performing the check again, even if the ``<code>`` changes. In
  29 order to force the check to be re-evaluated, the variable named by
  30 ``<resultVar>`` must be manually removed from the cache.
  31
  32 The compile and link commands can be influenced by setting any of the
  33 following variables prior to calling ``check_objcxx_compiler_flag()``
  34
  35 .. include:: /module/CMAKE_REQUIRED_FLAGS.txt
  36
  37 .. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
  38
  39 .. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
  40
  41 .. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
  42
  43 .. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
  44
  45 .. include:: /module/CMAKE_REQUIRED_QUIET.txt
  46
  47 #]=======================================================================]
  48
  49 include_guard(GLOBAL)
  50 include(Internal/CheckCompilerFlag)
  51
  52 macro (CHECK_OBJCXX_COMPILER_FLAG _FLAG _RESULT)
  53   cmake_check_compiler_flag(OBJCXX "${_FLAG}" ${_RESULT})
  54 endmacro ()
  55
  56 # FIXME(#24994): The following module is included only for compatibility
  57 # with projects that accidentally relied on it with CMake 3.26 and below.
  58 include(CheckOBJCXXSourceCompiles)