Differential D16894 Diff 50812 modules/ECMAddCompilerFlag.cmake

Changeset View

Standalone View

View Options

modules/ECMAddCompilerFlag.cmake

  • This file was added.
1​#.rst:
2​# ECMAddCompilerFlag
3​# ------------------
4​#
5​# Add compiler one or more flag conditionally
6​#
7​# ::
8​#
9​# ECM_ADD_CXX_COMPILER_FLAGS_IF_SUPPORTED(FLAGS <flag|flags>
10​# [SUPPORTED_IF <support_condition>]
11​# [QUERY_IF <query_condition>])
12​#
13​# C-language equivalent::
14​#
15​# ECM_ADD_C_COMPILER_FLAGS_IF_SUPPORTED(FLAGS <flag|flags>
16​# [SUPPORTED_IF <support_condition>]
17​# [QUERY_IF <query_condition>])
18​#
19​# add ``<flag>`` or ``<flags>`` to CMAKE_CXX_FLAGS if the compiler supports them.
20​# Support is determined by the ``SUPPORTED_IF`` expression if provided or by
21​# querying the compiler directly if a ``QUERY_IF`` expression is true. The
22​# ``QUERY_IF`` expression takes precedence if it evaluates to true.
23​# The compiler is also queried if no conditions are given at all.
24​# The compiler is queried for each flag in turn and only the supported
25​# flag(s) are added. The ``SUPPORTED_IF`` condition applies to all flags.
26​#
kropUnsubmitted
Done

Shall be moved after the module documentation

krop: Shall be moved after the module documentation
rjvbbAuthorUnsubmitted
Not Done

I'm guessing you meant "Please move [...]" and not that this would somehow happen automagically(?)

rjvbb: I'm guessing you meant "Please move [...]" and not that this would somehow happen automagically…
kropUnsubmitted
Not Done

Indeed.

krop: Indeed.
27​# examples:
28​#
29​# add flags -a, -b and -c when using a GCC compiler or Clang:
30​#
kropUnsubmitted
Done

Shall be moved after the license block

krop: Shall be moved after the license block
31​# .. code-block:: cmake
32​#
33​# ecm_add_cxx_compiler_flags_if_supported(FLAGS -a -b -c SUPPORTED_IF CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
34​#
35​# add flags -d, -e and/or -f if the compiler supports them:
36​#
37​# .. code-block:: cmake
38​#
39​# ecm_add_cxx_compiler_flags_if_supported(FLAGS -d -e -f)
40​#
41​# add flag -a when using a GCC > 5 compiler, or query the compiler when running on a Mac
42​# (a more specific test would be APPLE AND CMAKE_CXX_COMPILER_ID MATCHES "Clang" but there is
43​# little chance another compiler will be used on that platform):
44​#
45​# .. code-block:: cmake
46​#
47​# ecm_add_c_compiler_flags_if_supported(FLAGS -g
48​# SUPPORTED_IF CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "5.0.0"
49​# QUERY_IF APPLE)
50​#
51​# Since 5.xx
52​
53​#=============================================================================
54​# Copyright 2018,9 René J.V. Bertin <rjvbertin@gmail.com>
55​#
56​# Redistribution and use in source and binary forms, with or without
57​# modification, are permitted provided that the following conditions
58​# are met:
59​#
kropUnsubmitted
Done

Sphinx cannot parse this doc.

Also don't forget to create ECMAddCompilerFlag.rst in docs/modules/

krop: Sphinx cannot parse this doc. Also don't forget to create ECMAddCompilerFlag.rst in…
kropUnsubmitted
Done

Missing "Since 5.xx"

krop: Missing "Since 5.xx"
60​# 1. Redistributions of source code must retain the copyright
61​# notice, this list of conditions and the following disclaimer.
62​# 2. Redistributions in binary form must reproduce the copyright
kropUnsubmitted
Done

Unneeded extra space

krop: Unneeded extra space
63​# notice, this list of conditions and the following disclaimer in the
64​# documentation and/or other materials provided with the distribution.
65​# 3. The name of the author may not be used to endorse or promote products
66​# derived from this software without specific prior written permission.
67​#
kropUnsubmitted
Done

Unneeded extra space

krop: Unneeded extra space
68​# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
69​# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
kropUnsubmitted
Done

Unneeded extra spaces

krop: Unneeded extra spaces
70​# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
71​# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
72​# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
73​# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
74​# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
75​# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
76​# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
77​# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78​
79​include(CMakeParseArguments)
80​include(CheckCXXCompilerFlag)
81​include(CheckCCompilerFlag)
82​
83​
84​function(ECM_ADD_CXX_COMPILER_FLAGS_IF_SUPPORTED)
85​ set(_OPTIONS_ARGS)
86​ set(_ONE_VALUE_ARGS)
87​ set(_MULTI_VALUE_ARGS FLAGS SUPPORTED_IF QUERY_IF)
88​
89​ cmake_parse_arguments(EASCXXFLAGS "${_OPTIONS_ARGS}" "${_ONE_VALUE_ARGS}" "${_MULTI_VALUE_ARGS}" ${ARGN})
90​ if(NOT EASCXXFLAGS_FLAGS)
91​ message(FATAL_ERROR "ecm_add_cxx_compiler_flags_if_supported: 'FLAGS' is a required argument.")
92​ endif()
93​ # if the user provided conditions, evaluate them now to simplify things later
94​ if(EASCXXFLAGS_SUPPORTED_IF AND (${EASCXXFLAGS_SUPPORTED_IF}))
95​ set(EASCXXFLAGS_is_supported ON)
kropUnsubmitted
Not Done

EASCXXFLAGS_SUPPORTED_IF

krop: EASCXXFLAGS_SUPPORTED_IF
96​ endif()
97​ if((EASCXXFLAGS_QUERY_IF AND (${EASCXXFLAGS_QUERY_IF}))
kropUnsubmitted
Done

Unneeded extra space

krop: Unneeded extra space
98​ OR (NOT EASCXXFLAGS_SUPPORTED_IF AND NOT EASCXXFLAGS_QUERY_IF))
99​ set(EASCXXFLAGS_needs_query ON)
kropUnsubmitted
Not Done

EASCXXFLAGS_SUPPORTED_IF

krop: EASCXXFLAGS_SUPPORTED_IF
100​ endif()
101​ if(EASCXXFLAGS_needs_query)
102​ # without conditions, or when QUERY_IF is true we'll need to ask the compiler directly.
kropUnsubmitted
Done

Unneeded extra space

krop: Unneeded extra space
103​ # one flag at a time:
104​ set(flags)
kropUnsubmitted
Not Done

Unneeded extra space

krop: Unneeded extra space
105​ foreach(flag IN ITEMS ${EASCXXFLAGS_FLAGS})
106​ # use a standardised and informative cached test variable
107​ set(HASFLAG "${CMAKE_CXX_COMPILER_ID}++_ACCEPTS${flag}")
108​ check_cxx_compiler_flag(${flag} ${HASFLAG})
109​ if(${${HASFLAG}})
kropUnsubmitted
Not Done

if(HASFLAG)

you're testing the result, not the string

krop: if(HASFLAG) you're testing the result, not the string
kropUnsubmitted
Not Done

Forget that. The syntax is confusing, please remove this HASFLAG

krop: Forget that. The syntax is confusing, please remove this HASFLAG
110​ set(flags "${flags} ${flag}")
111​ endif()
112​ endforeach()
113​ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flags}" PARENT_SCOPE)
114​ elseif(EASCXXFLAGS_is_supported)
115​ # all flags can be appended at once
116​ string(REPLACE ";" " " FLAGS "${EASCXXFLAGS_FLAGS}")
117​ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${FLAGS}" PARENT_SCOPE)
118​ endif()
119​endfunction()
120​
121​function(ECM_ADD_C_COMPILER_FLAGS_IF_SUPPORTED)
122​ set(_OPTIONS_ARGS)
123​ set(_ONE_VALUE_ARGS)
124​ set(_MULTI_VALUE_ARGS FLAGS SUPPORTED_IF QUERY_IF)
125​
126​ cmake_parse_arguments(EASCFLAGS "${_OPTIONS_ARGS}" "${_ONE_VALUE_ARGS}" "${_MULTI_VALUE_ARGS}" ${ARGN})
127​ if(NOT EASCFLAGS_FLAGS)
128​ message(FATAL_ERROR "ecm_add_c_compiler_flags_if_supported: 'FLAGS' is a required argument.")
129​ endif()
130​ # if the user provided conditions, evaluate them now to simplify things later
kropUnsubmitted
Not Done

EASCFLAGS_SUPPORTED_IF

krop: EASCFLAGS_SUPPORTED_IF
131​ if(EASCFLAGS_SUPPORTED_IF AND (${EASCFLAGS_SUPPORTED_IF}))
132​ set(EASCFLAGS_is_supported ON)
133​ endif()
134​ if((EASCFLAGS_QUERY_IF AND (${EASCFLAGS_QUERY_IF}))
kropUnsubmitted
Not Done

EASCFLAGS_SUPPORTED_IF

krop: EASCFLAGS_SUPPORTED_IF
135​ OR (NOT EASCFLAGS_SUPPORTED_IF AND NOT EASCFLAGS_QUERY_IF))
136​ set(EASCFLAGS_needs_query ON)
137​ endif()
138​ if(EASCFLAGS_needs_query)
139​ set(flags)
140​ foreach(flag IN ITEMS ${EASCFLAGS_FLAGS})
141​ set(HASFLAG "${CMAKE_C_COMPILER_ID}_ACCEPTS${flag}")
142​ check_c_compiler_flag(${flag} ${HASFLAG})
143​ if(${${HASFLAG}})
144​ set(flags "${flags} ${flag}")
145​ endif()
146​ endforeach()
147​ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${flags}" PARENT_SCOPE)
148​ elseif(EASCFLAGS_is_supported)
149​ string(REPLACE ";" " " FLAGS "${EASCFLAGS_FLAGS}")
150​ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${FLAGS}" PARENT_SCOPE)
151​ endif()
152​endfunction()
153​