mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-01 11:22:21 -06:00
195b009796
- Added intro code block showing how to use this module. - Added separate examples section. - Renamed "macros" to "commands". - Synced commands descriptions to other modules. - Used lowercase style for command names.
147 lines
4.7 KiB
CMake
147 lines
4.7 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file LICENSE.rst or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
CMakeForceCompiler
|
|
------------------
|
|
|
|
.. deprecated:: 3.6
|
|
|
|
Do not use.
|
|
|
|
The commands 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.
|
|
|
|
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.
|
|
|
|
Load this module in a CMake toolchain file:
|
|
|
|
.. code-block:: cmake
|
|
|
|
include(CMakeForceCompiler)
|
|
|
|
Commands
|
|
^^^^^^^^
|
|
|
|
This module provides the following commands:
|
|
|
|
.. command:: cmake_force_c_compiler
|
|
|
|
Sets the :variable:`CMAKE_C_COMPILER <CMAKE_<LANG>_COMPILER>` variable to
|
|
the given compiler and the :variable:`CMAKE_C_COMPILER_ID
|
|
<CMAKE_<LANG>_COMPILER_ID>` variable to the given compiler-id:
|
|
|
|
.. code-block:: cmake
|
|
|
|
cmake_force_c_compiler(<compiler> <compiler-id>)
|
|
|
|
This command also bypasses the check for working compiler and basic
|
|
compiler information tests.
|
|
|
|
.. command:: cmake_force_cxx_compiler
|
|
|
|
Sets the :variable:`CMAKE_CXX_COMPILER <CMAKE_<LANG>_COMPILER>` variable
|
|
to the given compiler and the :variable:`CMAKE_CXX_COMPILER_ID
|
|
<CMAKE_<LANG>_COMPILER_ID>` variable to the given compiler-id:
|
|
|
|
.. code-block:: cmake
|
|
|
|
cmake_force_cxx_compiler(<compiler> <compiler-id>)
|
|
|
|
This command also bypasses the check for working compiler and basic
|
|
compiler information tests.
|
|
|
|
.. command:: cmake_force_fortran_compiler
|
|
|
|
Sets the :variable:`CMAKE_Fortran_COMPILER <CMAKE_<LANG>_COMPILER>`
|
|
variable to the given compiler and the
|
|
:variable:`CMAKE_Fortran_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` variable
|
|
to the given compiler-id:
|
|
|
|
.. code-block:: cmake
|
|
|
|
cmake_force_fortran_compiler(<compiler> <compiler-id>)
|
|
|
|
This command also bypasses the check for working compiler and basic
|
|
compiler information tests.
|
|
|
|
Examples
|
|
^^^^^^^^
|
|
|
|
A simple toolchain file using this module could look like this:
|
|
|
|
.. code-block:: cmake
|
|
:caption: ``cmake/toolchains/example-toolchain.cmake``
|
|
|
|
include(CMakeForceCompiler)
|
|
set(CMAKE_SYSTEM_NAME Generic)
|
|
cmake_force_c_compiler(chc12 MetrowerksHicross)
|
|
cmake_force_cxx_compiler(chc12 MetrowerksHicross)
|
|
|
|
In new CMake code, compiler is detected automatically when setting required
|
|
variables instead:
|
|
|
|
.. code-block:: cmake
|
|
:caption: ``cmake/toolchains/example-toolchain.cmake``
|
|
|
|
set(CMAKE_SYSTEM_NAME Generic)
|
|
set(CMAKE_C_COMPILER chc12)
|
|
set(CMAKE_CXX_COMPILER chc12)
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
* :manual:`cmake-toolchains(7)`
|
|
#]=======================================================================]
|
|
|
|
macro(CMAKE_FORCE_C_COMPILER compiler id)
|
|
message(DEPRECATION "The CMAKE_FORCE_C_COMPILER macro is deprecated. "
|
|
"Instead just set CMAKE_C_COMPILER and allow CMake to identify the compiler.")
|
|
set(CMAKE_C_COMPILER "${compiler}")
|
|
set(CMAKE_C_COMPILER_ID_RUN TRUE)
|
|
set(CMAKE_C_COMPILER_ID ${id})
|
|
set(CMAKE_C_COMPILER_FORCED TRUE)
|
|
|
|
# Set old compiler id variables.
|
|
if(CMAKE_C_COMPILER_ID MATCHES "GNU")
|
|
set(CMAKE_COMPILER_IS_GNUCC 1)
|
|
endif()
|
|
endmacro()
|
|
|
|
macro(CMAKE_FORCE_CXX_COMPILER compiler id)
|
|
message(DEPRECATION "The CMAKE_FORCE_CXX_COMPILER macro is deprecated. "
|
|
"Instead just set CMAKE_CXX_COMPILER and allow CMake to identify the compiler.")
|
|
set(CMAKE_CXX_COMPILER "${compiler}")
|
|
set(CMAKE_CXX_COMPILER_ID_RUN TRUE)
|
|
set(CMAKE_CXX_COMPILER_ID ${id})
|
|
set(CMAKE_CXX_COMPILER_FORCED TRUE)
|
|
|
|
# Set old compiler id variables.
|
|
if("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
|
|
set(CMAKE_COMPILER_IS_GNUCXX 1)
|
|
endif()
|
|
endmacro()
|
|
|
|
macro(CMAKE_FORCE_Fortran_COMPILER compiler id)
|
|
message(DEPRECATION "The CMAKE_FORCE_Fortran_COMPILER macro is deprecated. "
|
|
"Instead just set CMAKE_Fortran_COMPILER and allow CMake to identify the compiler.")
|
|
set(CMAKE_Fortran_COMPILER "${compiler}")
|
|
set(CMAKE_Fortran_COMPILER_ID_RUN TRUE)
|
|
set(CMAKE_Fortran_COMPILER_ID ${id})
|
|
set(CMAKE_Fortran_COMPILER_FORCED TRUE)
|
|
|
|
# Set old compiler id variables.
|
|
if(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
|
|
set(CMAKE_COMPILER_IS_GNUG77 1)
|
|
endif()
|
|
endmacro()
|