Restructure project

* Move headers to relevant include directories within the target tree(s)
* Adjust doxygen configuration to search correct paths
* Adjust CMake configuration to use new include paths

Author: jhunkeler

CMakeLists.txt

@@ -24,6 +24,11 @@ elseif (CMAKE_C_COMPILER_ID STREQUAL "MSVC")
 	add_compile_options(${win_cflags})
 endif()
 
+set(core_INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/src/lib/core/include)
+set(delivery_INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/src/lib/delivery/include)
+set(SYSCONFDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_SYSCONFDIR}")
+configure_file(${PROJECT_SOURCE_DIR}/include/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/config.h @ONLY)
+include_directories(${PROJECT_BINARY_DIR}/include)
 add_subdirectory(src)
 
 # Toggle extremely verbose output
@@ -52,8 +57,6 @@ else()
 	message(CHECK_PASS "no")
 endif()
 
-set(SYSCONFDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_SYSCONFDIR}")
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/include/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/config.h @ONLY)
 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/stasis_pandoc.css DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/stasis)
 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/stasis.ini DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/stasis)
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/mission DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/stasis)

docs/Doxyfile

@@ -124,7 +124,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = devel.md ../README.md ../src ../include
+INPUT                  = devel.md ../README.md ../src/lib
 INPUT_ENCODING         = UTF-8
 INPUT_FILE_ENCODING    =
 FILE_PATTERNS          = *.c \
@@ -177,7 +177,7 @@ FILE_PATTERNS          = *.c \
                          *.ucf \
                          *.qsf \
                          *.ice
-RECURSIVE              = NO
+RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =

src/CMakeLists.txt

@@ -1,7 +1,3 @@
-include_directories(${CMAKE_BINARY_DIR}/include)
-include_directories(${CMAKE_SOURCE_DIR}/include)
-include_directories(${PROJECT_BINARY_DIR})
-
 add_subdirectory(lib)
 add_subdirectory(cli)
 

src/cli/stasis/CMakeLists.txt

@@ -1,4 +1,3 @@
-include_directories(${CMAKE_SOURCE_DIR})
 add_executable(stasis
         stasis_main.c
         args.c
@@ -10,6 +9,11 @@ target_link_libraries(stasis PRIVATE
         stasis_core
         stasis_delivery
 )
+target_include_directories(stasis PRIVATE
+        ${core_INCLUDE}
+        ${delivery_INCLUDE}
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
 target_link_libraries(stasis PUBLIC LibXml2::LibXml2)
 
 install(TARGETS stasis RUNTIME)

src/cli/stasis/args.h renamed to src/cli/stasis/include/args.h

@@ -5,11 +5,13 @@ add_executable(stasis_indexer
         helpers.c
         junitxml_report.c
         website.c
-        website.h
         readmes.c
-        readmes.h
 )
-target_include_directories(stasis_indexer PRIVATE ${CMAKE_SOURCE_DIR})
+target_include_directories(stasis_indexer PRIVATE
+        ${core_INCLUDE}
+        ${delivery_INCLUDE}
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
 target_link_libraries(stasis_indexer PRIVATE
         stasis_core
         stasis_delivery

src/cli/stasis/callbacks.h renamed to src/cli/stasis/include/callbacks.h

@@ -1,5 +1,3 @@
-include_directories(${PROJECT_BINARY_DIR})
-
 add_library(stasis_core STATIC
         globals.c
         str.c
@@ -24,4 +22,8 @@ add_library(stasis_core STATIC
         envctl.c
         multiprocessing.c
 )
-
+target_include_directories(stasis_core PRIVATE
+        ${core_INCLUDE}
+        ${delivery_INCLUDE}
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)

src/cli/stasis/system_requirements.h renamed to src/cli/stasis/include/system_requirements.h

@@ -1,5 +1,3 @@
-include_directories(${PROJECT_BINARY_DIR})
-
 add_library(stasis_delivery STATIC
         delivery_postprocess.c
         delivery_conda.c
@@ -13,4 +11,9 @@ add_library(stasis_delivery STATIC
         delivery_init.c
         delivery.c
 )
+target_include_directories(stasis_delivery PRIVATE
+        ${core_INCLUDE}
+        ${delivery_INCLUDE}
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
 target_link_libraries(stasis_delivery stasis_core)

src/cli/stasis/tpl.h renamed to src/cli/stasis/include/tpl.h

@@ -9,16 +9,16 @@
 #include <sys/utsname.h>
 #include <fnmatch.h>
 #include <sys/statvfs.h>
-#include "core.h"
+#include "artifactory.h"
+#include "conda.h"
 #include "copy.h"
+#include "core.h"
+#include "docker.h"
 #include "environment.h"
-#include "conda.h"
 #include "ini.h"
-#include "artifactory.h"
-#include "docker.h"
-#include "wheel.h"
 #include "multiprocessing.h"
 #include "recipe.h"
+#include "wheel.h"
 
 #define DELIVERY_PLATFORM_MAX 4
 #define DELIVERY_PLATFORM_MAXLEN 65

src/cli/stasis_indexer/CMakeLists.txt

@@ -1,7 +1,3 @@
-include_directories(
-        ${CMAKE_SOURCE_DIR}/include
-        ${CMAKE_BINARY_DIR}/include
-)
 find_program(BASH_PROGRAM bash)
 set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/tests)
 set(CTEST_BINARY_DIRECTORY ${PROJECT_BINARY_DIR}/tests)
@@ -22,8 +18,6 @@ if (BASH_PROGRAM AND BUILD_TESTING_RT)
         string(REGEX REPLACE ${ext_pattern} "" rt_name ${rt_file})
         add_test (${rt_name} ${BASH_PROGRAM} ${rt_file})
     endforeach()
-    add_test (rt_generic_based_on ${BASH_PROGRAM} ${CMAKE_CURRENT_SOURCE_DIR}/rt_generic_based_on.sh)
-    add_test (rt_generic ${BASH_PROGRAM} ${CMAKE_CURRENT_SOURCE_DIR}/rt_generic.sh)
 endif()
 
 foreach(source_file ${source_files})
@@ -36,6 +30,11 @@ foreach(source_file ${source_files})
     elseif (CMAKE_C_COMPILER_ID STREQUAL "MSVC")
         target_compile_options(${test_executable} PRIVATE ${win_cflags} ${win_msvc_cflags})
     endif()
+    target_include_directories(${test_executable} PRIVATE
+            ${core_INCLUDE}
+            ${delivery_INCLUDE}
+            ${CMAKE_CURRENT_SOURCE_DIR}/include
+    )
     target_link_libraries(${test_executable} PRIVATE
             stasis_core
             stasis_delivery