mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-05 21:31:08 -06:00
caabb6e1f3
Move the C++ subset rules from the `cmake-developer(7)` into our dedicated coding guide since they do not need to be in user-facing documentation.
43 lines
1.6 KiB
ReStructuredText
43 lines
1.6 KiB
ReStructuredText
CMake Source Code Guide
|
|
***********************
|
|
|
|
The following is a guide to the CMake source code for developers.
|
|
See documentation on `CMake Development`_ for more information.
|
|
|
|
.. _`CMake Development`: README.rst
|
|
|
|
C++ Code Style
|
|
==============
|
|
|
|
We use `clang-format`_ version **3.8** to define our style for C++ code in
|
|
the CMake source tree. See the `.clang-format`_ configuration file for our
|
|
style settings. Use the `Utilities/Scripts/clang-format.bash`_ script to
|
|
format source code. It automatically runs ``clang-format`` on the set of
|
|
source files for which we enforce style. The script also has options to
|
|
format only a subset of files, such as those that are locally modified.
|
|
|
|
.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
|
|
.. _`.clang-format`: ../../.clang-format
|
|
.. _`Utilities/Scripts/clang-format.bash`: ../../Utilities/Scripts/clang-format.bash
|
|
|
|
C++ Subset Permitted
|
|
====================
|
|
|
|
CMake supports compiling as C++98 in addition to C++11 and C++14.
|
|
In order to support building on older toolchains some constructs
|
|
need to be handled with care:
|
|
|
|
* Use ``CM_AUTO_PTR`` instead of ``std::auto_ptr``.
|
|
|
|
The ``std::auto_ptr`` template is deprecated in C++11. We want to use it
|
|
so we can build on C++98 compilers but we do not want to turn off compiler
|
|
warnings about deprecated interfaces in general. Use the ``CM_AUTO_PTR``
|
|
macro instead.
|
|
|
|
* Use ``size_t`` instead of ``std::size_t``.
|
|
|
|
Various implementations have differing implementation of ``size_t``.
|
|
When assigning the result of ``.size()`` on a container for example,
|
|
the result should be assigned to ``size_t`` not to ``std::size_t``,
|
|
``unsigned int`` or similar types.
|