From 23da1299d6b8d8137a063dc1fcd4b8d1086e52f0 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Sat, 13 Mar 2021 19:53:09 +0100 Subject: [PATCH] build: CMake scripts cleanup --- CMakeLists.txt | 5 +- cmake/warnings.cmake | 149 ++++++++++++++++++++++++------------------- docs/CMakeLists.txt | 2 + src/CMakeLists.txt | 4 +- 4 files changed, 92 insertions(+), 68 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 13c73ed7..933c9274 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -22,9 +22,10 @@ cmake_minimum_required(VERSION 3.15) project(mp-units - LANGUAGES CXX) + LANGUAGES CXX +) -list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") +list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") # set restrictive compilation warnings include(warnings) diff --git a/cmake/warnings.cmake b/cmake/warnings.cmake index e21ecdb2..cf1a8435 100644 --- a/cmake/warnings.cmake +++ b/cmake/warnings.cmake @@ -22,87 +22,108 @@ # Based on https://github.com/lefticus/cpp_starter_project/blob/master/cmake/CompilerWarnings.cmake -cmake_minimum_required(VERSION 3.2) +cmake_minimum_required(VERSION 3.3) -# Configure compiler warning level -function(set_warnings) - option(WARNINGS_AS_ERRORS "Treat compiler warnings as errors" TRUE) +option(WARNINGS_AS_ERRORS "Treat compiler warnings as errors" ON) +macro(_set_flags) set(MSVC_WARNINGS - /W4 # Baseline reasonable warnings - /w14062 # enumerator 'identifier' in a switch of enum 'enumeration' is not handled - /w14242 # 'identifier': conversion from 'type1' to 'type1', possible loss of data - /w14254 # 'operator': conversion from 'type1:field_bits' to 'type2:field_bits', possible loss of data - /w14263 # 'function': member function does not override any base class virtual member function - /w14265 # 'classname': class has virtual functions, but destructor is not - # virtual instances of this class may not be destructed correctly - /w14266 # 'function': no override available for virtual member function from base 'type'; function is hidden - /w14287 # 'operator': unsigned/negative constant mismatch - /we4289 # nonstandard extension used: 'variable': loop control variable - # declared in the for-loop is used outside the for-loop scope - /w14296 # 'operator': expression is always 'boolean_value' - /w14311 # 'variable': pointer truncation from 'type1' to 'type2' - /w14545 # expression before comma evaluates to a function which is missing - # an argument list - /w14546 # function call before comma missing argument list - /w14547 # 'operator': operator before comma has no effect; expected - # operator with side-effect - /w14549 # 'operator': operator before comma has no effect; did you intend - # 'operator'? - /w14555 # expression has no effect; expected expression with side- effect - /w14619 # pragma warning: there is no warning number 'number' - /w14640 # Enable warning on thread un-safe static member initialization - /w14826 # Conversion from 'type1' to 'type_2' is sign-extended. This may - # cause unexpected runtime behavior. - /w14905 # wide string literal cast to 'LPSTR' - /w14906 # string literal cast to 'LPWSTR' - /w14928 # illegal copy-initialization; more than one user-defined - # conversion has been implicitly applied - /permissive- # standards conformance mode for MSVC compiler. - ) + /W4 # Baseline reasonable warnings + /w14062 # enumerator 'identifier' in a switch of enum 'enumeration' is not handled + /w14242 # 'identifier': conversion from 'type1' to 'type1', possible loss of data + /w14254 # 'operator': conversion from 'type1:field_bits' to 'type2:field_bits', possible loss of data + /w14263 # 'function': member function does not override any base class virtual member function + /w14265 # 'classname': class has virtual functions, but destructor is not virtual instances of this class may not be destructed correctly + /w14266 # 'function': no override available for virtual member function from base 'type'; function is hidden + /w14287 # 'operator': unsigned/negative constant mismatch + /we4289 # nonstandard extension used: 'variable': loop control variable declared in the for-loop is used outside the for-loop scope + /w14296 # 'operator': expression is always 'boolean_value' + /w14311 # 'variable': pointer truncation from 'type1' to 'type2' + /w14545 # expression before comma evaluates to a function which is missing an argument list + /w14546 # function call before comma missing argument list + /w14547 # 'operator': operator before comma has no effect; expected operator with side-effect + /w14549 # 'operator': operator before comma has no effect; did you intend 'operator'? + /w14555 # expression has no effect; expected expression with side- effect + /w14619 # pragma warning: there is no warning number 'number' + /w14640 # Enable warning on thread un-safe static member initialization + /w14826 # Conversion from 'type1' to 'type_2' is sign-extended. This may cause unexpected runtime behavior. + /w14905 # wide string literal cast to 'LPSTR' + /w14906 # string literal cast to 'LPWSTR' + /w14928 # illegal copy-initialization; more than one user-defined conversion has been implicitly applied + /permissive- # standards conformance mode for MSVC compiler. + ) set(CLANG_WARNINGS - -Wall - -Wextra # reasonable and standard - -Wpedantic # warn if non-standard C++ is used - -Wshadow # warn the user if a variable declaration shadows one from a parent context - -Wnon-virtual-dtor # warn the user if a class with virtual functions has a - # non-virtual destructor. This helps catch hard to - # track down memory errors - -Wold-style-cast # warn for c-style casts - -Wcast-align # warn for potential performance problem casts - -Wunused # warn on anything being unused - -Woverloaded-virtual # warn if you overload (not override) a virtual function - -Wcast-qual # warn on dropping const or volatile qualifiers - -Wconversion # warn on type conversions that may lose data - -Wsign-conversion # warn on sign conversions - -Wnull-dereference # warn if a null dereference is detected - -Wdouble-promotion # warn if float is implicit promoted to double - -Wformat=2 # warn on security issues around functions that format output (ie printf) - ) + -Wall + -Wextra # reasonable and standard + -Wpedantic # warn if non-standard C++ is used + -Wshadow # warn the user if a variable declaration shadows one from a parent context + -Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-virtual destructor. This helps catch hard to track down memory errors + -Wold-style-cast # warn for c-style casts + -Wcast-align # warn for potential performance problem casts + -Wunused # warn on anything being unused + -Woverloaded-virtual # warn if you overload (not override) a virtual function + -Wcast-qual # warn on dropping const or volatile qualifiers + -Wconversion # warn on type conversions that may lose data + -Wsign-conversion # warn on sign conversions + -Wnull-dereference # warn if a null dereference is detected + -Wdouble-promotion # warn if float is implicit promoted to double + -Wformat=2 # warn on security issues around functions that format output (ie printf) + ) + + set(GCC_WARNINGS + ${CLANG_WARNINGS} + -Wmisleading-indentation # warn if indentation implies blocks where blocks do not exist + -Wduplicated-cond # warn if if / else chain has duplicated conditions + -Wduplicated-branches # warn if if / else branches have duplicated code + -Wlogical-op # warn about logical operations being used where bitwise were probably wanted + ) if(WARNINGS_AS_ERRORS) + set(GCC_WARNINGS ${GCC_WARNINGS} -Werror) set(CLANG_WARNINGS ${CLANG_WARNINGS} -Werror) set(MSVC_WARNINGS ${MSVC_WARNINGS} /WX) endif() - set(GCC_WARNINGS - ${CLANG_WARNINGS} - -Wmisleading-indentation # warn if indentation implies blocks where blocks do not exist - -Wduplicated-cond # warn if if / else chain has duplicated conditions - -Wduplicated-branches # warn if if / else branches have duplicated code - -Wlogical-op # warn about logical operations being used where bitwise were probably wanted - ) - if(MSVC) string(REGEX REPLACE "/W[0-4]" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}" PARENT_SCOPE) - add_compile_options(${MSVC_WARNINGS}) + set(flags ${MSVC_WARNINGS}) elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang") - add_compile_options(${CLANG_WARNINGS}) + set(flags ${CLANG_WARNINGS}) elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU") - add_compile_options(${GCC_WARNINGS}) + set(flags ${GCC_WARNINGS}) else() message(AUTHOR_WARNING "No compiler warnings set for '${CMAKE_CXX_COMPILER_ID}' compiler.") + return() endif() +endmacro() + +# Set global compiler warning level +function(set_warnings) + _set_flags() + + message(STATUS "Setting restrictive compilation warnings") + message(STATUS " Treat warnings as errors: ${WARNINGS_AS_ERRORS}") + message(STATUS " Flags: ${flags}") + message(STATUS "Setting restrictive compilation warnings - done") + + add_compile_options(${flags}) +endfunction() + +# Set compiler warning level for a provided CMake target +function(set_target_warnings target scope) + set(scopes PUBLIC INTERFACE PRIVATE) + if(NOT scope IN_LIST scopes) + message(FATAL_ERROR "'scope' argument should be one of ${scopes} ('${scope}' received)") + endif() + + _set_flags() + + message(STATUS "Setting ${scope} restrictive compilation warnings for '${target}'") + message(STATUS " Treat warnings as errors: ${WARNINGS_AS_ERRORS}") + message(STATUS " Flags: ${flags}") + message(STATUS "Setting ${scope} restrictive compilation warnings for '${target}' - done") + + target_compile_options(${target} ${scope} ${flags}) endfunction() diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 79f5b1ad..0b1d18d1 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -23,6 +23,8 @@ cmake_minimum_required(VERSION 3.2) option(UNITS_BUILD_DOCS "Generate project documentation" ON) +message(STATUS "Project documentation generation: ${UNITS_BUILD_DOCS}") + if(NOT UNITS_BUILD_DOCS) return() endif() diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index cc8343d9..8416b741 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -71,9 +71,9 @@ if(DEFINED UNITS_DOWNCAST_MODE) set(downcast_mode_options OFF ON AUTO) list(FIND downcast_mode_options "${UNITS_DOWNCAST_MODE}" downcast_mode) if(downcast_mode EQUAL -1) - message(FATAL_ERROR "'${UNITS_DOWNCAST_MODE}' is an invalid UNITS_DOWNCAST_MODE value") + message(FATAL_ERROR "'UNITS_DOWNCAST_MODE' should be one of ${downcast_mode_options} ('${UNITS_DOWNCAST_MODE}' received)") else() - message(STATUS "Configuring UNITS_DOWNCAST_MODE=${UNITS_DOWNCAST_MODE}") + message(STATUS "UNITS_DOWNCAST_MODE: ${UNITS_DOWNCAST_MODE}") target_compile_definitions(mp-units INTERFACE UNITS_DOWNCAST_MODE=${downcast_mode}) endif() endif()