build: rename cmake functions to avoid name conflicts

hun1er · hun1er · commit 50f2fe975ced · 2023-07-10T10:52:38.000+03:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -174,7 +174,7 @@ if(${PNAME_UPPER}_BUILD_DOCS)
       "mscgen"
   )
 
-  use_doxygen_awesome_sidebar_only_theme()
+  strpy_use_doxygen_awesome_sidebar_only_theme()
   doxygen_add_docs("${PNAME_LOWER}_docs" "include")
 endif()
 
@@ -206,7 +206,7 @@ endif()
 #-------------------------------------------------------------------------------
 
 if(${PNAME_UPPER}_INSTALL AND NOT CMAKE_SKIP_INSTALL_RULES)
-  generate_install_target()
+  strpy_generate_install_target()
 endif()
 
 #-------------------------------------------------------------------------------
@@ -215,5 +215,5 @@ endif()
 
 if(PROJECT_IS_TOP_LEVEL)
   # Run Clang-Format on the source files of a target before building it.
-  format_target_sources(TARGETS "${PNAME_LOWER}")
+  strpy_format_target_sources(TARGETS "${PNAME_LOWER}")
 endif()
diff --git a/cmake/ClangFormat.cmake b/cmake/ClangFormat.cmake
@@ -3,7 +3,7 @@
 # @param TARGETS The list of target names to run Clang-Format on.
 # @param STYLE [optional] The coding style option to pass to Clang-Format.
 # @param WORKING_DIRECTORY [optional] The working directory for the Clang-Format.
-function(format_target_sources)
+function(strpy_format_target_sources)
   # Parse the arguments passed to the function
   cmake_parse_arguments("FTS" "" "STYLE;WORKING_DIRECTORY" "TARGETS" ${ARGN})
 
diff --git a/cmake/Coverage.cmake b/cmake/Coverage.cmake
@@ -7,7 +7,7 @@ set(FILTERED_COVERAGE_INFO "filtered_coverage.info")
 # Generates a coverage target for the specified target using LCOV and genhtml.
 #
 # @param target The name of the target to generate a coverage target for.
-function(generate_coverage_target target)
+function(strpy_generate_coverage_target target)
   # Find the LCOV and genhtml programs
   find_program(LCOV_PATH "lcov" REQUIRED)
   find_program(GENHTML_PATH "genhtml" REQUIRED)
diff --git a/cmake/Doxygen.cmake b/cmake/Doxygen.cmake
@@ -62,7 +62,7 @@ set(DOXYGEN_USE_PDFLATEX YES)
 # Enable or disable verbatim copy of header files for classes with includes.
 set(DOXYGEN_VERBATIM_HEADERS NO)
 
-macro(use_doxygen_awesome)
+macro(strpy_use_doxygen_awesome)
   # Fetch and make available DoxygenAwesome content
   FetchContent_MakeAvailable(DoxygenAwesome)
 
@@ -88,9 +88,9 @@ macro(use_doxygen_awesome)
   set(DOXYGEN_HTML_EXTRA_STYLESHEET "${doxygenawesome_SOURCE_DIR}/doxygen-awesome.css")
 endmacro()
 
-macro(use_doxygen_awesome_sidebar_only_theme)
+macro(strpy_use_doxygen_awesome_sidebar_only_theme)
   # Call macro
-  use_doxygen_awesome()
+  strpy_use_doxygen_awesome()
 
   # Enable treeview generation
   set(DOXYGEN_GENERATE_TREEVIEW YES)
diff --git a/cmake/GoogleTest.cmake b/cmake/GoogleTest.cmake
@@ -12,7 +12,7 @@ FetchContent_Declare(
 # First checks if GTest is already installed on the system.
 # If GTest is not found on the system, calls FetchContent_MakeAvailable(GoogleTest)
 # to fetch GTest from the repository and make it available for use.
-function(fetch_gtest)
+function(strpy_fetch_gtest)
   find_package(GTest)
 
   if(NOT GTest_FOUND)
diff --git a/cmake/Install.cmake b/cmake/Install.cmake
@@ -10,7 +10,7 @@ if(NOT DEFINED ${PNAME_UPPER}_INSTALL_CMAKEDIR)
 endif()
 
 # Generates an install target for the project.
-function(generate_install_target)
+function(strpy_generate_install_target)
   set(rt_component "${PNAME_LOWER}")
   set(dev_component "${rt_component}-dev")
   set(targets_export "${PNAME_CAPITALIZED}Targets")
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -89,22 +89,22 @@ add_dependencies("examples" ${TARGET_LIST})
 
 if(${PNAME_UPPER}_ENABLE_CLANG_TIDY)
   # Enable Clang-Tidy for "stringpy" and all other targets in the current directory
-  enable_clang_tidy(TARGETS "stringpy" ${TARGET_LIST})
+  strpy_enable_clang_tidy(TARGETS "stringpy" ${TARGET_LIST})
 endif()
 
 if(${PNAME_UPPER}_ENABLE_CPPCHECK)
   # Enable Cppcheck for "stringpy" and all other targets in the current directory
-  enable_cppcheck(TARGETS "stringpy" ${TARGET_LIST})
+  strpy_enable_cppcheck(TARGETS "stringpy" ${TARGET_LIST})
 endif()
 
 if(${PNAME_UPPER}_ENABLE_PVS_STUDIO)
   # Enable PVS-Studio for "stringpy" and all other targets in the current directory
-  enable_pvs_studio(TARGETS "stringpy" ${TARGET_LIST})
+  strpy_enable_pvs_studio(TARGETS "stringpy" ${TARGET_LIST})
 endif()
 
 if(${PNAME_UPPER}_ENABLE_IWYU)
   # Enable Include What You Use for "stringpy" and all other targets in the current directory
-  enable_iwyu(TARGETS "stringpy" ${TARGET_LIST})
+  strpy_enable_iwyu(TARGETS "stringpy" ${TARGET_LIST})
 endif()
 
 #-------------------------------------------------------------------------------
@@ -113,5 +113,5 @@ endif()
 
 if(PROJECT_IS_TOP_LEVEL)
   # Run Clang-Format on the source files of a target before building it.
-  format_target_sources(TARGETS ${TARGET_LIST})
+  strpy_format_target_sources(TARGETS ${TARGET_LIST})
 endif()
diff --git a/examples/cmake/ClangTidy.cmake b/examples/cmake/ClangTidy.cmake
@@ -3,7 +3,7 @@
 # @param TARGETS The list of target names to enable Clang-Tidy for.
 # @param OPTIONS [optional] The options to pass to Clang-Tidy.
 # @param EXTRA_ARGS [optional] The additional arguments to append to the compiler command line.
-function(enable_clang_tidy)
+function(strpy_enable_clang_tidy)
   # Parse the arguments passed to the function
   cmake_parse_arguments("CT" "" "" "TARGETS;OPTIONS;EXTRA_ARGS" ${ARGN})
 
diff --git a/examples/cmake/CompileOptions.cmake b/examples/cmake/CompileOptions.cmake
@@ -2,7 +2,7 @@
 #
 # @param compiler_id The ID of the compiler to include options for.
 # @param lang The language to include options for.
-function(include_compiler_options compiler_id lang)
+function(strpy_include_compiler_options compiler_id lang)
   # Return early if the compiler ID is not provided or is empty.
   if(NOT compiler_id OR "${compiler_id}" STREQUAL "")
     return()
diff --git a/examples/cmake/CompileOptionsLinux.cmake b/examples/cmake/CompileOptionsLinux.cmake
@@ -139,5 +139,5 @@ endif()
 # Compiler-Specific Options
 #-------------------------------------------------------------------------------
 
-include_compiler_options("${CMAKE_C_COMPILER_ID}" "C")
-include_compiler_options("${CMAKE_CXX_COMPILER_ID}" "CXX")
+strpy_include_compiler_options("${CMAKE_C_COMPILER_ID}" "C")
+strpy_include_compiler_options("${CMAKE_CXX_COMPILER_ID}" "CXX")
diff --git a/examples/cmake/CompileOptionsWindows.cmake b/examples/cmake/CompileOptionsWindows.cmake
@@ -19,5 +19,5 @@ add_compile_options(
 # Compiler-Specific Options
 #-------------------------------------------------------------------------------
 
-include_compiler_options("${CMAKE_C_COMPILER_ID}" "C")
-include_compiler_options("${CMAKE_CXX_COMPILER_ID}" "CXX")
+strpy_include_compiler_options("${CMAKE_C_COMPILER_ID}" "C")
+strpy_include_compiler_options("${CMAKE_CXX_COMPILER_ID}" "CXX")
diff --git a/examples/cmake/Cppcheck.cmake b/examples/cmake/Cppcheck.cmake
@@ -10,7 +10,7 @@
 # @param QUIET [optional] Enable quiet mode in Cppcheck.
 # @param VERBOSE [optional] Enable verbose mode in Cppcheck.
 # @param CHECK_CONFIG [optional] Check the configuration in Cppcheck.
-function(enable_cppcheck)
+function(strpy_enable_cppcheck)
   # Parse the arguments passed to the function
   cmake_parse_arguments("CPPC" ""
     "PLATFORM;ENABLE;DISABLE;LIBRARY;INCONCLUSIVE;CTU_DEPTH;QUIET;VERBOSE;CHECK_CONFIG"
@@ -43,9 +43,9 @@ function(enable_cppcheck)
     set(CPPC_LIBRARY "boost,gnu,googletest,libcurl,posix,qt,sdl,std,windows,zlib")
   endif()
 
-  # If CTU_DEPTH is not set, set it to "6"
+  # If CTU_DEPTH is not set, set it to "16"
   if(NOT DEFINED CPPC_CTU_DEPTH)
-    set(CPPC_CTU_DEPTH "6")
+    set(CPPC_CTU_DEPTH "16")
   endif()
 
   # If QUIET is not set, set it to ON
@@ -74,10 +74,16 @@ function(enable_cppcheck)
     "--library=${CPPC_LIBRARY}" # Load file <cfg> that contains information about types and functions.
     "--max-configs=50" # Maximum number of configurations to check in a file before skipping it.
     "--max-ctu-depth=${CPPC_CTU_DEPTH}" # Max depth in whole program analysis.
-    "--suppressions-list=${CMAKE_CURRENT_SOURCE_DIR}/.cppcheck_suppressions" # Suppress warnings listed in the file.
     "--inline-suppr" # Enable inline suppressions.
   )
 
+  # If the suppression file exists, add it to the cppcheck command
+  if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.cppcheck_suppressions")
+    list(APPEND cppcheck_exe "--suppressions-list=${CMAKE_CURRENT_SOURCE_DIR}/.cppcheck_suppressions")
+  elseif(EXISTS "${CMAKE_SOURCE_DIR}/.cppcheck_suppressions")
+    list(APPEND cppcheck_exe "--suppressions-list=${CMAKE_SOURCE_DIR}/.cppcheck_suppressions")
+  endif()
+
   # Set the source directory
   set(src_dir "${PROJECT_SOURCE_DIR}/src")
 
diff --git a/examples/cmake/Iwyu.cmake b/examples/cmake/Iwyu.cmake
@@ -8,7 +8,7 @@
 # @param UPDATE_COMMENTS [optional] If set, update comments in IWYU analysis.
 # @param NO_COMMENTS [optional] If set, do not include comments in IWYU analysis.
 # @param VERBOSE [optional] The verbosity level to use for IWYU.
-function(enable_iwyu)
+function(strpy_enable_iwyu)
   # Parse the arguments passed to the function
   cmake_parse_arguments("IWYU" ""
     "TRANSITIVE_INCLUDES_ONLY;MAX_LINE_LENGTH;COMMENT_STYLE;UPDATE_COMMENTS;NO_COMMENTS;VERBOSE"
diff --git a/examples/cmake/PvsStudio.cmake b/examples/cmake/PvsStudio.cmake
@@ -32,7 +32,7 @@ FetchContent_Declare(
 # @param CXX_FLAGS [optional] The C++ compiler flags to use for PVS-Studio.
 # @param ARGS [optional] Additional arguments to pass to the PVS-Studio analyzer.
 # @param CONVERTER_ARGS [optional] Additional arguments to pass to the PVS-Studio log converter.
-function(enable_pvs_studio)
+function(strpy_enable_pvs_studio)
   # Parse the arguments passed to the function
   cmake_parse_arguments("PVS" ""
     "PLATFORM;PREPROCESSOR;CONFIG;SUPPRESS_BASE"
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -35,7 +35,7 @@ add_executable("${PROJECT_NAME}"
 )
 
 # Fetch GTest and link it to the test executable
-fetch_gtest()
+strpy_fetch_gtest()
 
 target_link_libraries("${PROJECT_NAME}"
   PRIVATE
@@ -44,7 +44,7 @@ target_link_libraries("${PROJECT_NAME}"
 )
 
 if(${PNAME_UPPER}_CODE_COVERAGE)
-  generate_coverage_target("${PROJECT_NAME}")
+  strpy_generate_coverage_target("${PROJECT_NAME}")
 endif()
 
 # Register tests

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ set(FILTERED_COVERAGE_INFO "filtered_coverage.info")`
`7`	`7`	`# Generates a coverage target for the specified target using LCOV and genhtml.`
`8`	`8`	`#`
`9`	`9`	`# @param target The name of the target to generate a coverage target for.`
`10`		`-function(generate_coverage_target target)`
	`10`	`+function(strpy_generate_coverage_target target)`
`11`	`11`	`# Find the LCOV and genhtml programs`
`12`	`12`	`find_program(LCOV_PATH "lcov" REQUIRED)`
`13`	`13`	`find_program(GENHTML_PATH "genhtml" REQUIRED)`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`#`
`3`	`3`	`# @param compiler_id The ID of the compiler to include options for.`
`4`	`4`	`# @param lang The language to include options for.`
`5`		`-function(include_compiler_options compiler_id lang)`
	`5`	`+function(strpy_include_compiler_options compiler_id lang)`
`6`	`6`	`# Return early if the compiler ID is not provided or is empty.`
`7`	`7`	`if(NOT compiler_id OR "${compiler_id}" STREQUAL "")`
`8`	`8`	`return()`