Merge branch 'development' into f-ClangTidyIdentifierRenameControlFlow

Author: pdschubert

.clang-tidy

@@ -11,6 +11,9 @@ Checks: '-*,
            -readability-static-definition-in-anonymous-namespace,
            -readability-implicit-bool-conversion,
            -readability-magic-numbers,
+           -readability-function-cognitive-complexity,
+           -readability-convert-member-functions-to-static,
+           -readability-isolate-declaration,
          cppcoreguidelines-*,
            -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
            -cppcoreguidelines-owning-memory,
@@ -20,8 +23,10 @@ Checks: '-*,
            -cppcoreguidelines-init-variables,
            -cppcoreguidelines-macro-usage,
          bugprone-*,
+           -bugprone-easily-swappable-parameters,
          modernize-*,
            -modernize-use-trailing-return-type,
+           -modernize-pass-by-value,
          performance-*,
          clang-analyzer-*,
         '

CMakeLists.txt

@@ -20,11 +20,17 @@ include(GNUInstallDirs)
 set_property(GLOBAL PROPERTY TARGET_MESSAGES OFF)
 
 if (NOT CMAKE_BUILD_TYPE)
-  set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build mode ('Debug' or 'Release', default is 'Debug')" FORCE)
+  set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build mode ('DebugSan' or 'Debug' or 'Release', default is 'Debug')" FORCE)
 endif ()
-if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+
+if(CMAKE_BUILD_TYPE STREQUAL "DebugSan")
+  message(STATUS "Selected Debug Build with sanitizers")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -g -fno-omit-frame-pointer -fsanitize=address,undefined")
+elseif(CMAKE_BUILD_TYPE STREQUAL "Debug")
+  message(STATUS "Selected Debug Build")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -g")
 else()
+  message(STATUS "Selected Release Build")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -march=native")
 endif()
 
@@ -43,7 +49,6 @@ file(STRINGS ${PHASAR_SRC_DIR}/include/phasar/Config/Version.h VERSION_NUMBER_FI
 string(REPLACE " " ";" VERSION_NUMBER_FILE ${VERSION_NUMBER_FILE})
 list(GET VERSION_NUMBER_FILE 2 VERSION_NUMBER_PHASAR)
 
-
 include("phasar_macros")
 
 option(PHASAR_BUILD_UNITTESTS "Build all tests (default is ON)" ON)
@@ -52,6 +57,8 @@ option(PHASAR_BUILD_OPENSSL_TS_UNITTESTS "Build OPENSSL typestate tests (require
 
 option(PHASAR_BUILD_IR "Build IR test code (default is ON)" ON)
 
+option(PHASAR_ENABLE_CLANG_TIDY_DURING_BUILD "Run clang-tidy during build (default is OFF)" OFF)
+
 option(PHASAR_BUILD_DOC "Build documentation" OFF)
 
 option(PHASAR_DEBUG_LIBDEPS "Debug internal library dependencies (private linkage)" OFF)
@@ -96,12 +103,10 @@ endif()
 configure_file(config.h.in config.h @ONLY)
 include_directories(${CMAKE_CURRENT_BINARY_DIR})
 
-
 include_directories(
   ${PHASAR_SRC_DIR}/include
 )
 
-
 set(PHASAR_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR}/phasar)
 
 set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/${PHASAR_INSTALL_LIBDIR})
@@ -122,6 +127,9 @@ find_package(Boost 1.65.1 COMPONENTS filesystem graph system program_options log
 #find_package(Boost 1.72.0 COMPONENTS filesystem graph system program_options log ${BOOST_THREAD} REQUIRED)
 include_directories(${Boost_INCLUDE_DIRS})
 
+# Disable clang-tidy for the external projects
+set(CMAKE_CXX_CLANG_TIDY "")
+
 # We need to work around the behavior of nlohmann_json_schema_validator and nlohmann_json here
 # The validator needs the json part, but if you include it, the library of nlohmann_json_schema_validator
 # is not installed, leading to linker error. But just including nlohmann_json is not sufficient, as
@@ -237,8 +245,17 @@ endif()
 add_subdirectory(external/WALi-OpenNWA)
 include_directories(external/WALi-OpenNWA/Source/wali/include)
 
+# Set up clang-tidy to run during PhASAR's compilation to indicate code smells
+if (PHASAR_ENABLE_CLANG_TIDY_DURING_BUILD)
+  message(STATUS "Enabled clang-tidy during build")
+  set(CMAKE_CXX_CLANG_TIDY
+    clang-tidy;
+    -header-filter=include/phasar.*h$;
+    # -warnings-as-errors=*;
+  )
+endif ()
 
-# Add the Phasar subdirectories
+# Add PhASAR's subdirectories
 add_subdirectory(include)
 add_subdirectory(lib)
 

include/phasar/Config/Version.h

@@ -1 +1,6 @@
-#define PHASAR_VERSION v0521
+#ifndef PHASAR_CONFIG_VERSION_H
+#define PHASAR_CONFIG_VERSION_H
+
+#define PHASAR_VERSION v0521
+
+#endif

include/phasar/Controller/AnalysisController.h

@@ -7,8 +7,8 @@
  *     Philipp Schubert and others
  *****************************************************************************/
 
-#ifndef PHASAR_CONTROLLER_ANALYSIS_CONTROLLER_H_
-#define PHASAR_CONTROLLER_ANALYSIS_CONTROLLER_H_
+#ifndef PHASAR_CONTROLLER_ANALYSISCONTROLLER_H
+#define PHASAR_CONTROLLER_ANALYSISCONTROLLER_H
 
 #include <iostream>
 #include <set>

include/phasar/PhasarClang/ClangController.h

@@ -10,11 +10,9 @@
 #ifndef PHASAR_PHASARCLANG_CLANGCONTROLLER_H_
 #define PHASAR_PHASARCLANG_CLANGCONTROLLER_H_
 
-namespace clang {
-namespace tooling {
+namespace clang::tooling {
 class CommonOptionsParser;
-}
-} // namespace clang
+} // namespace clang::tooling
 
 namespace psr {
 

include/phasar/PhasarLLVM/AnalysisStrategy/Strategies.h

@@ -7,8 +7,8 @@
  *     Philipp Schubert and others
  *****************************************************************************/
 
-#ifndef PHASAR_PHASARLLVM_ANALYSISSTRATEGY_STRATEGIES
-#define PHASAR_PHASARLLVM_ANALYSISSTRATEGY_STRATEGIES
+#ifndef PHASAR_PHASARLLVM_ANALYSISSTRATEGY_STRATEGIES_H
+#define PHASAR_PHASARLLVM_ANALYSISSTRATEGY_STRATEGIES_H
 
 #include <iosfwd>
 #include <string>

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/DefaultSeeds.h

@@ -14,8 +14,8 @@
  *      Author: pdschbrt
  */
 
-#ifndef PHASAR_PHASARLLVM_IFDSIDE_DEFAULTSEEDS_H_
-#define PHASAR_PHASARLLVM_IFDSIDE_DEFAULTSEEDS_H_
+#ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_DEFAULTSEEDS_H
+#define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_DEFAULTSEEDS_H
 
 #include <map>
 #include <set>

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFact.h

@@ -7,8 +7,8 @@
  *     Philipp Schubert and others
  *****************************************************************************/
 
-#ifndef PHASAR_PHASARLLVM_IFDSIDE_EDGEFACT_H_
-#define PHASAR_PHASARLLVM_IFDSIDE_EDGEFACT_H_
+#ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFACT_H_
+#define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFACT_H_
 
 #include <iosfwd>
 

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFactWrapper.h

@@ -7,8 +7,8 @@
  *     Philipp Schubert and others
  *****************************************************************************/
 
-#ifndef PHASAR_PHASARLLVM_IFDSIDE_EDGEFACTWRAPPER_H_
-#define PHASAR_PHASARLLVM_IFDSIDE_EDGEFACTWRAPPER_H_
+#ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFACTWRAPPER_H
+#define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFACTWRAPPER_H
 
 #include <map>
 #include <memory>

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctionComposer.h

@@ -7,8 +7,8 @@
  *     Philipp Schubert and others
  *****************************************************************************/
 
-#ifndef PHASAR_PHASARLLVM_IFDSIDE_EDGEFUNCTIONCOMPOSER_H
-#define PHASAR_PHASARLLVM_IFDSIDE_EDGEFUNCTIONCOMPOSER_H
+#ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONCOMPOSER_H
+#define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONCOMPOSER_H
 
 #include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions.h"