1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
# (C) Copyright 2011- ECMWF.
#
# This software is licensed under the terms of the Apache Licence Version 2.0
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
# In applying this licence, ECMWF does not waive the privileges and immunities
# granted to it by virtue of its status as an intergovernmental organisation nor
# does it submit to any jurisdiction.
##############################################################################
#.rst:
#
# ecbuild_compiler_flags
# ======================
#
# Set compiler specific default compilation flags for a given language. ::
#
# ecbuild_compiler_flags( <lang> )
#
# The procedure is as follows:
#
# 1. ecBuild does **not** set ``CMAKE_<lang>_FLAGS`` i.e. the user can set
# these via ``-D`` or the CMake cache and these will be the "base" flags.
#
# 2. ecBuild **overwrites** ``CMAKE_<lang>_FLAGS_<btype>`` in the CMake cache
# for all build types with compiler specific defaults for the currently
# loaded compiler i.e. any value set by the user via ``-D`` or the CMake
# cache **has no effect**.
#
# 3. Any value the user provides via ``ECBUILD_<lang>_FLAGS`` or
# ``ECBUILD_<lang>_FLAGS_<btype>`` **overrides** the corresponding
# ``CMAKE_<lang>_FLAGS`` or ``CMAKE_<lang>_FLAGS_<btype>`` **without being
# written to the CMake cache**.
#
##############################################################################
macro( ecbuild_compiler_flags _lang )
# Set compiler and language specific default flags - OVERWRITES variables in CMake cache
if( CMAKE_${_lang}_COMPILER_LOADED )
ecbuild_debug( "ecbuild_compiler_flags(${_lang}): try include ${ECBUILD_MACROS_DIR}/compiler_flags/${CMAKE_${_lang}_COMPILER_ID}_${_lang}.cmake ")
include( ${ECBUILD_MACROS_DIR}/compiler_flags/${CMAKE_${_lang}_COMPILER_ID}_${_lang}.cmake OPTIONAL )
endif()
# Apply user or toolchain specified compilation flag overrides (NOT written to cache)
foreach( _btype NONE DEBUG BIT PRODUCTION RELEASE RELWITHDEBINFO )
if( DEFINED ECBUILD_${_lang}_FLAGS_${_btype} )
ecbuild_debug( "ecbuild_compiler_flags(${_lang}): overriding CMAKE_${_lang}_FLAGS_${_btype} with ${ECBUILD_${_lang}_FLAGS_${_btype}}")
set( CMAKE_${_lang}_FLAGS_${_btype} ${ECBUILD_${_lang}_FLAGS_${_btype}} )
endif()
mark_as_advanced( CMAKE_${_lang}_FLAGS_${_btype} )
endforeach()
if( DEFINED ECBUILD_${_lang}_FLAGS )
ecbuild_debug( "ecbuild_compiler_flags(${_lang}): overriding CMAKE_${_lang}_FLAGS with ${ECBUILD_${_lang}_FLAGS}")
set( CMAKE_${_lang}_FLAGS "${ECBUILD_${_lang}_FLAGS}" )
endif()
mark_as_advanced( CMAKE_${_lang}_FLAGS )
if( DEFINED ECBUILD_${_lang}_LINK_FLAGS )
ecbuild_debug( "ecbuild_compiler_flags(${_lang}): overriding CMAKE_${_lang}_LINK_FLAGS with ${ECBUILD_${_lang}_LINK_FLAGS}")
set( CMAKE_${_lang}_LINK_FLAGS "${ECBUILD_${_lang}_LINK_FLAGS}" )
endif()
mark_as_advanced( CMAKE_${_lang}_LINK_FLAGS )
ecbuild_debug_var( CMAKE_${_lang}_FLAGS )
foreach( _btype NONE DEBUG BIT PRODUCTION RELEASE RELWITHDEBINFO )
ecbuild_debug_var( CMAKE_${_lang}_FLAGS_${_btype} )
endforeach()
endmacro()
##############################################################################
#.rst:
#
# Using custom compilation flags
# ==============================
#
# If compilation flags need to be controlled on a per source file basis,
# ecBuild supports defining custom rules in a CMake or JSON file.
#
# When using this approach, *default compilation flags are NOT loaded*!
#
# Overriding compilation flags on a per source file basis using CMake rules
# -------------------------------------------------------------------------
#
# Compiler flags can be overridden on a per source file basis by setting the
# CMake variable ``ECBUILD_COMPILE_FLAGS`` to the *full path* of a CMake file
# defining the override rules. If set, ``<PNAME>_ECBUILD_COMPILE_FLAGS``
# takes precendence and ``ECBUILD_COMPILE_FLAGS`` is ignored, allowing for
# rules that only apply to a subproject (e.g. in a bundle).
#
# Flags can be overridden in 3 different ways:
#
# 1. By defining project specific flags for a language and (optionally)
# build type e.g. ::
#
# set(<PNAME>_Fortran_FLAGS "...") # common flags for all build types
# set(<PNAME>_Fortran_FLAGS_DEBUG "...") # only for DEBUG build type
#
# 2. By defining source file specific flags which are *combined* with the
# project and target specific flags ::
#
# set_source_files_properties(<source>
# PROPERTIES COMPILE_FLAGS "..." # common flags for all build types
# COMPILE_FLAGS_DEBUG "...") # only for DEBUG build type
#
# 3. By defining source file specific flags which *override* the project and
# target specific flags ::
#
# set_source_files_properties(<source>
# PROPERTIES OVERRIDE_COMPILE_FLAGS "..."
# OVERRIDE_COMPILE_FLAGS_DEBUG "...")
#
# See ``examples/override-compile-flags`` in the ecBuild source tree for a
# complete example using this technique.
#
# Overriding compilation flags on a per source file basis using JSON rules
# ------------------------------------------------------------------------
#
# Compiler flags can be overridden on a per source file basis by setting the
# CMake variable ``ECBUILD_SOURCE_FLAGS`` to the *full path* of a JSON file
# defining the override rules. If set, ``<PNAME>_ECBUILD_SOURCE_FLAGS``
# takes precendence and ``ECBUILD_SOURCE_FLAGS`` is ignored, allowing for
# rules that only apply to a subproject (e.g. in a bundle).
#
# The JSON file lists shell glob patterns and the rule to apply to each source
# file matching the pattern, defined as an array ``[op, flag1, ...]``
# containing an operator followed by one or more flags. Valid operators are:
#
# :+: Add the flags to the default compilation flags for matching files
# :=: Set the flags for matching files, disregarding default compilation flags
# :/: Remove the flags from the default compilation flags for matching files
#
# Rules can be nested to e.g. only apply to a subdirectory by setting the rule
# to a dictionary, which will only apply to source files matching its pattern.
#
# An example JSON file demonstrating different rule types is given below: ::
#
# {
# "*" : [ "+", "-g0" ],
# "*.cxx" : [ "+", "-cxx11" ],
# "*.f90" : [ "+", "-pipe" ],
# "foo.c" : [ "+", "-O0" ],
# "foo.cc" : [ "+", "-O2", "-pipe" ],
# "bar/*": {
# "*.f90" : [ "=", "-O1" ]
# },
# "baz/*": {
# "*.f90" : [ "/", "-pipe" ],
# "*.f90" : [ "/", "-O2" ],
# "*.f90" : [ "+", "-O3" ]
# }
# }
#
# See ``examples/override-compile-flags`` in the ecBuild source tree for a
# complete example using this technique.
#
##############################################################################
string( TOUPPER ${PROJECT_NAME} PROJECT_NAME_CAPS )
# Custom (project specific) compilation flags enabled?
foreach( _flags COMPILE SOURCE )
if( ${PROJECT_NAME_CAPS}_ECBUILD_${_flags}_FLAGS )
if ( ECBUILD_${_flags}_FLAGS )
ecbuild_debug( "Override ECBUILD_${_flags}_FLAGS (${ECBUILD_${_flags}_FLAGS}) with ${PROJECT_NAME} specific flags (${${PROJECT_NAME_CAPS}_ECBUILD_${_flags}_FLAGS})" )
else()
ecbuild_debug( "Use ${PROJECT_NAME} specific ECBUILD_${_flags}_FLAGS (${${PROJECT_NAME_CAPS}_ECBUILD_${_flags}_FLAGS})" )
endif()
set( ECBUILD_${_flags}_FLAGS ${${PROJECT_NAME_CAPS}_ECBUILD_${_flags}_FLAGS} )
endif()
# Ensure ECBUILD_${_flags}_FLAGS is a valid file path
if( DEFINED ECBUILD_${_flags}_FLAGS AND NOT EXISTS ${ECBUILD_${_flags}_FLAGS} )
ecbuild_warn( "ECBUILD_${_flags}_FLAGS points to non-existent file ${ECBUILD_${_flags}_FLAGS} and will be ignored" )
unset( ECBUILD_${_flags}_FLAGS )
unset( ECBUILD_${_flags}_FLAGS CACHE )
endif()
endforeach()
if( ECBUILD_COMPILE_FLAGS )
include( "${ECBUILD_COMPILE_FLAGS}" )
endif()
foreach( _lang C CXX Fortran )
if( CMAKE_${_lang}_COMPILER_LOADED )
# Clear default compilation flags potentially inherited from parent scope
# when using custom compilation flags
if( ECBUILD_SOURCE_FLAGS OR ECBUILD_COMPILE_FLAGS )
set(CMAKE_${_lang}_FLAGS "")
foreach(_btype ALL RELEASE RELWITHDEBINFO PRODUCTION BIT DEBUG)
set(CMAKE_${_lang}_FLAGS_${_btype} "")
endforeach()
# Load default compilation flags only if custom compilation flags not enabled
else()
ecbuild_compiler_flags( ${_lang} )
endif()
endif()
endforeach()
# Apply user or toolchain specified linker flag overrides per object type (NOT written to cache)
foreach( _obj EXE SHARED MODULE )
if( ECBUILD_${_obj}_LINKER_FLAGS )
set( CMAKE_${_obj}_LINKER_FLAGS ${ECBUILD_${_obj}_LINKER_FLAGS} )
endif()
if( NOT "$ENV{LD_RUN_PATH}" EQUAL "" )
set( LD_RUN_PATH "$ENV{LD_RUN_PATH}" )
string( REPLACE ":" ";" LD_RUN_PATH "$ENV{LD_RUN_PATH}" )
foreach( rpath ${LD_RUN_PATH} )
ecbuild_regex_escape( "${rpath}" rpath_escaped )
if( NOT CMAKE_${_obj}_LINKER_FLAGS MATCHES ".*-Wl,-rpath,${rpath_escaped}.*")
set( CMAKE_${_obj}_LINKER_FLAGS "${CMAKE_${_obj}_LINKER_FLAGS} -Wl,-rpath,${rpath}" )
endif()
endforeach()
endif()
endforeach()
foreach( _btype NONE DEBUG BIT PRODUCTION RELEASE RELWITHDEBINFO )
foreach( _obj EXE SHARED MODULE )
if( ECBUILD_${_obj}_LINKER_FLAGS_${_btype} )
set( CMAKE_${_obj}_LINKER_FLAGS_${_btype} ${ECBUILD_${_obj}_LINKER_FLAGS_${_btype}} )
endif()
endforeach()
endforeach()
|
