TestForANSIForScope: Update documentation
This describes the module in more details to make upgrading code easier.
This commit is contained in:
parent
5a10e0ef70
commit
8f25772351
@ -5,14 +5,32 @@
|
|||||||
TestForANSIForScope
|
TestForANSIForScope
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
Check for ANSI for scope support
|
This module checks whether the ``CXX`` compiler restricts the scope of variables
|
||||||
|
declared in a for-init-statement to the loop body. In early C++ (pre-C++98),
|
||||||
|
variables declared in ``for(<init-statement> ...)`` could remain accessible
|
||||||
|
outside the loop after its body (``for() { <body> }``).
|
||||||
|
|
||||||
Check if the compiler restricts the scope of variables declared in a
|
This module defines the following cache variable:
|
||||||
for-init-statement to the loop body.
|
|
||||||
|
|
||||||
::
|
``CMAKE_NO_ANSI_FOR_SCOPE``
|
||||||
|
A cache variable containing the result of the check. It will be set to value
|
||||||
|
``0`` if the for-init-statement has restricted scope (``C++ 98`` and newer),
|
||||||
|
and to value ``1`` if not (``ANSI C++``).
|
||||||
|
|
||||||
CMAKE_NO_ANSI_FOR_SCOPE - holds result
|
.. note::
|
||||||
|
|
||||||
|
As of the ``C++ 98`` standard, variables declared in a for-init-statement are
|
||||||
|
restricted to the loop body, making this behavior obsolete.
|
||||||
|
|
||||||
|
Examples
|
||||||
|
^^^^^^^^
|
||||||
|
|
||||||
|
Including this module will check the ``for()`` loop scope behavior and define
|
||||||
|
the ``CMAKE_NO_ANSI_FOR_SCOPE`` cache variable:
|
||||||
|
|
||||||
|
.. code-block:: cmake
|
||||||
|
|
||||||
|
include(TestForANSIForScope)
|
||||||
#]=======================================================================]
|
#]=======================================================================]
|
||||||
|
|
||||||
if(NOT DEFINED CMAKE_ANSI_FOR_SCOPE)
|
if(NOT DEFINED CMAKE_ANSI_FOR_SCOPE)
|
||||||
|
Loading…
Reference in New Issue
Block a user