CMakeForceCompiler.cmake 4.28 KB
Newer Older
1 2 3 4
#.rst:
# CMakeForceCompiler
# ------------------
#
5
# Deprecated.  Do not use.
6
#
7 8 9 10 11 12 13
# The macros provided by this module were once intended for use by
# cross-compiling toolchain files when CMake was not able to automatically
# detect the compiler identification.  Since the introduction of this module,
# CMake's compiler identification capabilities have improved and can now be
# taught to recognize any compiler.  Furthermore, the suite of information
# CMake detects from a compiler is now too extensive to be provided by
# toolchain files using these macros.
14
#
15 16 17 18 19
# One common use case for this module was to skip CMake's checks for a
# working compiler when using a cross-compiler that cannot link binaries
# without special flags or custom linker scripts.  This case is now supported
# by setting the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable in the
# toolchain file instead.
20
#
21
# -------------------------------------------------------------------------
22 23
#
# Macro CMAKE_FORCE_C_COMPILER has the following signature:
24 25 26 27 28 29 30 31 32
#
# ::
#
#    CMAKE_FORCE_C_COMPILER(<compiler> <compiler-id>)
#
# It sets CMAKE_C_COMPILER to the given compiler and the cmake internal
# variable CMAKE_C_COMPILER_ID to the given compiler-id.  It also
# bypasses the check for working compiler and basic compiler information
# tests.
33 34
#
# Macro CMAKE_FORCE_CXX_COMPILER has the following signature:
35 36 37 38 39
#
# ::
#
#    CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>)
#
40
# It sets CMAKE_CXX_COMPILER to the given compiler and the cmake
41 42
# internal variable CMAKE_CXX_COMPILER_ID to the given compiler-id.  It
# also bypasses the check for working compiler and basic compiler
43
# information tests.
44
#
45
# Macro CMAKE_FORCE_Fortran_COMPILER has the following signature:
46 47 48 49 50
#
# ::
#
#    CMAKE_FORCE_Fortran_COMPILER(<compiler> <compiler-id>)
#
51 52 53 54 55
# It sets CMAKE_Fortran_COMPILER to the given compiler and the cmake
# internal variable CMAKE_Fortran_COMPILER_ID to the given compiler-id.
# It also bypasses the check for working compiler and basic compiler
# information tests.
#
56
# So a simple toolchain file could look like this:
57 58 59 60 61 62 63
#
# ::
#
#    include (CMakeForceCompiler)
#    set(CMAKE_SYSTEM_NAME Generic)
#    CMAKE_FORCE_C_COMPILER   (chc12 MetrowerksHicross)
#    CMAKE_FORCE_CXX_COMPILER (chc12 MetrowerksHicross)
64

65 66 67 68 69 70 71 72 73 74
#=============================================================================
# Copyright 2007-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.
#=============================================================================
75
# (To distribute this file outside of CMake, substitute the full
76 77
#  License text for the above reference.)

78
macro(CMAKE_FORCE_C_COMPILER compiler id)
79 80
  message(DEPRECATION "The CMAKE_FORCE_C_COMPILER macro is deprecated.  "
    "Instead just set CMAKE_C_COMPILER and allow CMake to identify the compiler.")
81 82 83 84
  set(CMAKE_C_COMPILER "${compiler}")
  set(CMAKE_C_COMPILER_ID_RUN TRUE)
  set(CMAKE_C_COMPILER_ID ${id})
  set(CMAKE_C_COMPILER_FORCED TRUE)
85 86

  # Set old compiler id variables.
87
  if(CMAKE_C_COMPILER_ID MATCHES "GNU")
88
    set(CMAKE_COMPILER_IS_GNUCC 1)
89 90
  endif()
endmacro()
91

92
macro(CMAKE_FORCE_CXX_COMPILER compiler id)
93 94
  message(DEPRECATION "The CMAKE_FORCE_CXX_COMPILER macro is deprecated.  "
    "Instead just set CMAKE_CXX_COMPILER and allow CMake to identify the compiler.")
95 96 97 98
  set(CMAKE_CXX_COMPILER "${compiler}")
  set(CMAKE_CXX_COMPILER_ID_RUN TRUE)
  set(CMAKE_CXX_COMPILER_ID ${id})
  set(CMAKE_CXX_COMPILER_FORCED TRUE)
99 100

  # Set old compiler id variables.
101 102
  if("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
    set(CMAKE_COMPILER_IS_GNUCXX 1)
103 104
  endif()
endmacro()
105

106
macro(CMAKE_FORCE_Fortran_COMPILER compiler id)
107 108
  message(DEPRECATION "The CMAKE_FORCE_Fortran_COMPILER macro is deprecated.  "
    "Instead just set CMAKE_Fortran_COMPILER and allow CMake to identify the compiler.")
109 110 111 112
  set(CMAKE_Fortran_COMPILER "${compiler}")
  set(CMAKE_Fortran_COMPILER_ID_RUN TRUE)
  set(CMAKE_Fortran_COMPILER_ID ${id})
  set(CMAKE_Fortran_COMPILER_FORCED TRUE)
113 114

  # Set old compiler id variables.
115
  if(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
116
    set(CMAKE_COMPILER_IS_GNUG77 1)
117 118
  endif()
endmacro()