Workaround installation issue (#532)

* fix installation

* small refactoring in phasarConfig.cmake

* Fix pre-commit

* Get rid of unnecessary manual config files

* pre-commit

Author: fabianbs96

Config.cmake.in

@@ -3,24 +3,47 @@ set(PHASAR_VERSION 1.0.0)
 @PACKAGE_INIT@
 set_and_check(PHASAR_INCLUDE_DIR "@PACKAGE_INCLUDE_INSTALL_DIR@")
 
-foreach(component ${phasar_FIND_COMPONENTS})
-  include("${CMAKE_CURRENT_LIST_DIR}/phasar_${component}-config.cmake")
+include (CMakeFindDependencyMacro)
+find_dependency(nlohmann_json)
+find_dependency(nlohmann_json_schema_validator)
+find_package(Boost 1.65.1 COMPONENTS program_options graph REQUIRED)
+
+# TODO: The order seems to be important. Fix this!
+
+set(PHASAR_COMPONENTS
+  utils
+  config
+  phasarllvm_utils
+  passes
+  db
+  pointer
+  typehierarchy
+  controlflow
+  taintconfig
+  ifdside
+)
+
+foreach(component ${PHASAR_COMPONENTS})
   include("${CMAKE_CURRENT_LIST_DIR}/phasar_${component}-targets.cmake")
+  list(APPEND PHASAR_NEEDED_LIBS phasar::phasar_${component})
 endforeach()
 
+list(REMOVE_DUPLICATES PHASAR_NEEDED_LIBS)
+
+find_package(LLVM 14 REQUIRED CONFIG)
+include_directories(${LLVM_INCLUDE_DIRS})
+link_directories(${LLVM_LIB_PATH} ${LLVM_LIBRARY_DIRS})
+find_library(LLVM_LIBRARY NAMES LLVM HINTS ${LLVM_LIBRARY_DIRS})
+
 function(phasar_config executable)
-  find_package(LLVM 14 REQUIRED CONFIG)
-  include_directories(${LLVM_INCLUDE_DIRS})
-  link_directories(${LLVM_LIB_PATH} ${LLVM_LIBRARY_DIRS})
-  find_library(LLVM_LIBRARY NAMES LLVM HINTS ${LLVM_LIBRARY_DIRS})
   if(NOT ${LLVM_LIBRARY} STREQUAL "LLVM_LIBRARY-NOTFOUND")
     llvm_config(${executable} USE_SHARED ${PHASAR_LLVM_DEPS})
   else()
     llvm_config(${executable} ${PHASAR_LLVM_DEPS})
   endif()
-  list(REMOVE_DUPLICATES PHASAR_NEEDED_LIBS)
+
   target_link_libraries(${executable}
     PUBLIC
     ${PHASAR_NEEDED_LIBS}
-    )
+  )
 endfunction()

cmake/phasar_macros.cmake

@@ -24,6 +24,7 @@ function(add_phasar_unittest test_name)
     phasar_mono
     phasar_db
     phasar_experimental
+
     # phasar_clang
     phasar_passes
     phasar_pointer
@@ -49,23 +50,28 @@ endfunction()
 function(generate_ll_file)
   set(options MEM2REG DEBUG O1 O2 O3)
   set(testfile FILE)
-  cmake_parse_arguments(GEN_LL "${options}" "${testfile}" "" ${ARGN} )
+  cmake_parse_arguments(GEN_LL "${options}" "${testfile}" "" ${ARGN})
+
   # get file extension
   get_filename_component(test_code_file_ext ${GEN_LL_FILE} EXT)
   string(REPLACE "." "_" ll_file_suffix ${test_code_file_ext})
+
   # define .ll file name
-#  set(ll_file_suffix "_${test_code_file_ext}")
+  # set(ll_file_suffix "_${test_code_file_ext}")
   if(GEN_LL_MEM2REG)
     set(ll_file_suffix "${ll_file_suffix}_m2r")
   endif()
+
   if(GEN_LL_DEBUG)
     set(ll_file_suffix "${ll_file_suffix}_dbg")
   endif()
-#  set(ll_file_suffix "${ll_file_suffix}.ll")
+
+  # set(ll_file_suffix "${ll_file_suffix}.ll")
   string(REPLACE ${test_code_file_ext}
     "${ll_file_suffix}.ll" test_code_ll_file
     ${GEN_LL_FILE}
   )
+
   # get file path
   set(test_code_file_path "${CMAKE_CURRENT_SOURCE_DIR}/${GEN_LL_FILE}")
 
@@ -79,31 +85,37 @@ function(generate_ll_file)
   set(GEN_CXX_FLAGS -std=c++17 -fno-discard-value-names -emit-llvm -S)
   set(GEN_C_FLAGS -fno-discard-value-names -emit-llvm -S)
   set(GEN_CMD_COMMENT "[LL]")
+
   if(GEN_LL_MEM2REG)
     list(APPEND GEN_CXX_FLAGS -Xclang -disable-O0-optnone)
     list(APPEND GEN_C_FLAGS -Xclang -disable-O0-optnone)
     set(GEN_CMD_COMMENT "${GEN_CMD_COMMENT}[M2R]")
   endif()
+
   if(GEN_LL_DEBUG)
     list(APPEND GEN_CXX_FLAGS -g)
     list(APPEND GEN_C_FLAGS -g)
     set(GEN_CMD_COMMENT "${GEN_CMD_COMMENT}[DBG]")
   endif()
+
   if(GEN_LL_O1)
     list(APPEND GEN_CXX_FLAGS -O1)
     list(APPEND GEN_C_FLAGS -O1)
     set(GEN_CMD_COMMENT "${GEN_CMD_COMMENT}[O1]")
   endif()
+
   if(GEN_LL_O2)
     list(APPEND GEN_CXX_FLAGS -O2)
     list(APPEND GEN_C_FLAGS -O2)
     set(GEN_CMD_COMMENT "${GEN_CMD_COMMENT}[O2]")
   endif()
+
   if(GEN_LL_03)
     list(APPEND GEN_CXX_FLAGS -O3)
     list(APPEND GEN_C_FLAGS -O3)
     set(GEN_CMD_COMMENT "${GEN_CMD_COMMENT}[O3]")
   endif()
+
   set(GEN_CMD_COMMENT "${GEN_CMD_COMMENT} ${GEN_LL_FILE}")
 
   # define .ll file generation command
@@ -114,6 +126,7 @@ function(generate_ll_file)
     set(GEN_CMD ${CMAKE_C_COMPILER_LAUNCHER} ${CMAKE_C_COMPILER})
     list(APPEND GEN_CMD ${GEN_C_FLAGS})
   endif()
+
   if(GEN_LL_MEM2REG)
     add_custom_command(
       OUTPUT ${test_code_ll_file}
@@ -125,13 +138,14 @@ function(generate_ll_file)
     )
   else()
     add_custom_command(
-    OUTPUT ${test_code_ll_file}
-    COMMAND ${GEN_CMD} ${test_code_file_path} -o ${test_code_ll_file}
-    COMMENT ${GEN_CMD_COMMENT}
-    DEPENDS ${GEN_LL_FILE}
-    VERBATIM
+      OUTPUT ${test_code_ll_file}
+      COMMAND ${GEN_CMD} ${test_code_file_path} -o ${test_code_ll_file}
+      COMMENT ${GEN_CMD_COMMENT}
+      DEPENDS ${GEN_LL_FILE}
+      VERBATIM
     )
   endif()
+
   add_custom_target(${test_code_file_target}
     DEPENDS ${test_code_ll_file}
   )
@@ -141,41 +155,46 @@ endfunction()
 macro(add_phasar_executable name)
   set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/bin)
   set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib)
-  add_llvm_executable( ${name} ${ARGN} )
+  add_llvm_executable(${name} ${ARGN})
   set_target_properties(${name} PROPERTIES FOLDER "phasar_executables")
-  install (TARGETS ${name}
+  install(TARGETS ${name}
     RUNTIME DESTINATION bin
   )
 endmacro(add_phasar_executable)
 
 macro(add_phasar_library name)
   set(srcs ${ARGN})
+
   if(MSVC_IDE OR XCODE)
-    file( GLOB_RECURSE headers *.h *.td *.def)
+    file(GLOB_RECURSE headers *.h *.td *.def)
     set(srcs ${srcs} ${headers})
-    string( REGEX MATCHALL "/[^/]" split_path ${CMAKE_CURRENT_SOURCE_DIR})
-    list( GET split_path -1 dir)
-    file( GLOB_RECURSE headers
+    string(REGEX MATCHALL "/[^/]" split_path ${CMAKE_CURRENT_SOURCE_DIR})
+    list(GET split_path -1 dir)
+    file(GLOB_RECURSE headers
       ../../include/phasar${dir}/*.h)
     set(srcs ${srcs} ${headers})
   endif(MSVC_IDE OR XCODE)
-  if (MODULE)
+
+  if(MODULE)
     set(libkind MODULE)
-  elseif (SHARED_LIBRARY)
+  elseif(SHARED_LIBRARY)
     set(libkind SHARED)
   else()
     set(libkind)
   endif()
-  add_library( ${name} ${libkind} ${srcs} )
-  add_library( phasar::${name} ALIAS ${name} )
-  if( LLVM_COMMON_DEPENDS )
-    add_dependencies( ${name} ${LLVM_COMMON_DEPENDS} )
-  endif( LLVM_COMMON_DEPENDS )
-  if( LLVM_USED_LIBS )
+
+  add_library(${name} ${libkind} ${srcs})
+  add_library(phasar::${name} ALIAS ${name})
+
+  if(LLVM_COMMON_DEPENDS)
+    add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
+  endif(LLVM_COMMON_DEPENDS)
+
+  if(LLVM_USED_LIBS)
     foreach(lib ${LLVM_USED_LIBS})
-      target_link_libraries( ${name} ${lib} )
+      target_link_libraries(${name} ${lib})
     endforeach(lib)
-  endif( LLVM_USED_LIBS )
+  endif(LLVM_USED_LIBS)
 
   if(PHASAR_LINK_LIBS)
     foreach(lib ${PHASAR_LINK_LIBS})
@@ -187,65 +206,71 @@ macro(add_phasar_library name)
     endforeach(lib)
   endif(PHASAR_LINK_LIBS)
 
-  if( LLVM_LINK_COMPONENTS )
-    if( USE_LLVM_FAT_LIB )
+  if(LLVM_LINK_COMPONENTS)
+    if(USE_LLVM_FAT_LIB)
       llvm_config(${name} USE_SHARED ${LLVM_LINK_COMPONENTS})
     else()
       llvm_config(${name} ${LLVM_LINK_COMPONENTS})
     endif()
-  endif( LLVM_LINK_COMPONENTS )
+  endif(LLVM_LINK_COMPONENTS)
+
   if(MSVC)
     get_target_property(cflag ${name} COMPILE_FLAGS)
+
     if(NOT cflag)
       set(cflag "")
     endif(NOT cflag)
+
     set(cflag "${cflag} /Za")
     set_target_properties(${name} PROPERTIES COMPILE_FLAGS ${cflag})
   endif(MSVC)
-  #cut off prefix phasar_ for convenient component names
+
+  # cut off prefix phasar_ for convenient component names
   string(REGEX REPLACE phasar_ "" name component_name)
+
   if(PHASAR_IN_TREE)
     install(TARGETS ${name}
       EXPORT LLVMExports
       LIBRARY DESTINATION lib
       ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX})
   else()
-    install(TARGETS ${name}
-      EXPORT phasarTargets
-      LIBRARY DESTINATION ${PHASAR_INSTALL_LIBDIR}
-      ARCHIVE DESTINATION ${PHASAR_INSTALL_LIBDIR})
     install(TARGETS ${name}
       EXPORT ${name}-targets
       COMPONENT ${component_name}
-      DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/phasar
-      LIBRARY DESTINATION ${PHASAR_INSTALL_LIBDIR}
-      ARCHIVE DESTINATION ${PHASAR_INSTALL_LIBDIR})
+
+      # NOTE: Library, archive and runtime destination are automatically set by
+      # GNUInstallDirs which is included in the top-level CMakeLists.txt
+    )
     install(EXPORT ${name}-targets
       FILE ${name}-targets.cmake
       NAMESPACE phasar::
-      DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/phasar
-      COMPONENT ${component_name})
-    install(FILES ${name}-config.cmake
-      DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/phasar)
+      DESTINATION lib/cmake/phasar
+      COMPONENT ${component_name}
+    )
   endif()
+
   set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
 endmacro(add_phasar_library)
 
 macro(add_phasar_loadable_module name)
   set(srcs ${ARGN})
+
   # klduge: pass different values for MODULE with multiple targets in same dir
   # this allows building shared-lib and module in same dir
   # there must be a cleaner way to achieve this....
-  if (MODULE)
+  if(MODULE)
   else()
     set(GLOBAL_NOT_MODULE TRUE)
   endif()
+
   set(MODULE TRUE)
   add_phasar_library(${name} ${srcs})
-  if (GLOBAL_NOT_MODULE)
-    unset (MODULE)
+
+  if(GLOBAL_NOT_MODULE)
+    unset(MODULE)
   endif()
-  if (APPLE)
+
+  if(APPLE)
     # Darwin-specific linker flags for loadable modules.
     set_target_properties(${name} PROPERTIES
       LINK_FLAGS "-Wl,-flat_namespace -Wl,-undefined -Wl,suppress")
@@ -255,10 +280,12 @@ endmacro(add_phasar_loadable_module)
 macro(subdirlist result curdir)
   file(GLOB children RELATIVE ${curdir} ${curdir}/*)
   set(dirlist "")
+
   foreach(child ${children})
     if(IS_DIRECTORY ${curdir}/${child})
       list(APPEND dirlist ${child})
     endif()
   endforeach()
+
   set(${result} ${dirlist})
 endmacro(subdirlist)