diff options
Diffstat (limited to 'cmake')
| -rw-r--r-- | cmake/SetClangTidy.cmake | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/cmake/SetClangTidy.cmake b/cmake/SetClangTidy.cmake new file mode 100644 index 000000000..ce66286e2 --- /dev/null +++ b/cmake/SetClangTidy.cmake @@ -0,0 +1,72 @@ +# Copyright (c) 2014-2020, The Monero Project +# +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are +# permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, this list of +# conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, this list +# of conditions and the following disclaimer in the documentation and/or other +# materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors may be +# used to endorse or promote products derived from this software without specific +# prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY +# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL +# THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +# https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_CLANG_TIDY.html +# This module sets the following variables: +# CMAKE_C_CLANG_TIDY +# CMAKE_CXX_CLANG_TIDY +# when clang-tidy is found in PATH. Afterwards, the code is being linted by the tool. +# The checks to be enabled can be manipulated with the variable MONERO_CLANG_TIDY_CHECKS + +macro (monero_clang_tidy LANGUAGE) + set(TOOL_NAME "clang-tidy") + set(MONERO_CLANG_TIDY_MIN_VERSION "3.6") + if(${CMAKE_VERSION} VERSION_LESS "${MONERO_CLANG_TIDY_MIN_VERSION}") + message(FATAL_ERROR "Sorry, ${TOOL_NAME} is available for CMake from version ${MONERO_CLANG_TIDY_MIN_VERSION}") + else() + message(STATUS "Trying to enable ${TOOL_NAME}") + find_program(MONERO_CLANG_BIN ${TOOL_NAME}) + if(NOT MONERO_CLANG_BIN) + message(FATAL_ERROR "${TOOL_NAME} not found! Try running: sudo apt install ${TOOL_NAME}") + else() + message(STATUS "Found ${MONERO_CLANG_BIN}") + set(MONERO_CLANG_TIDY_CHECKS + -header-filter=.; # By default the headers are excluded. This line enables them. + -checks=*; # Currently enabling all checks + # An example of selectively enabling checks: + #-checks=bugprone-*,cppcoreguidelines-avoid-goto # Have to be in one line :( + ) + # Current list of checks is avaibale under: + # https://clang.llvm.org/extra/clang-tidy/ + if (${LANGUAGE} STREQUAL "C") + set(CMAKE_C_CLANG_TIDY + ${MONERO_CLANG_BIN}; # Mind the semicolon + ${MONERO_CLANG_TIDY_CHECKS} + ) + elseif (${LANGUAGE} STREQUAL "CXX") + set(CMAKE_CXX_CLANG_TIDY + ${MONERO_CLANG_BIN}; # Mind the semicolon + ${MONERO_CLANG_TIDY_CHECKS} + ) + else() + message(FATAL_ERROR "${TOOL_NAME}: Unsupported language: ${LANGUAGE}") + endif() + endif() + endif() +endmacro() + |