Merge pull request #17 from SaridakisStamatisChristos/codex/organize-public-and-private-headers

Refactor public headers and add version metadata

Author: SaridakisStamatisChristos

CMakeLists.txt

@@ -1,10 +1,19 @@
 cmake_minimum_required(VERSION 3.15)
-project(thermal_simd_dispatcher C)
+project(thermal_simd_dispatcher VERSION 0.1.0 LANGUAGES C)
 set(CMAKE_C_STANDARD 11)
 
 set(THERMAL_SIMD_DISPATCHER_CPU_FLAGS "-msse4.1" CACHE STRING "CPU-specific compiler flags for thermal_simd")
 
-add_library(thermal_simd_core STATIC
+include(CTest)
+
+file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/thermal/simd)
+configure_file(
+    ${CMAKE_CURRENT_SOURCE_DIR}/include/thermal/simd/version.h.in
+    ${CMAKE_CURRENT_BINARY_DIR}/include/thermal/simd/version.h
+    @ONLY
+)
+
+set(THERMAL_SIMD_CORE_SOURCES
     src/config_parser.c
     src/statistics.c
     src/thermal_config.c
@@ -13,28 +22,66 @@ add_library(thermal_simd_core STATIC
     src/thermal_perf.c
     src/thermal_signals.c
 )
-target_include_directories(thermal_simd_core PUBLIC src)
+
+add_library(thermal_simd_core STATIC ${THERMAL_SIMD_CORE_SOURCES})
+target_include_directories(thermal_simd_core
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
+        $<INSTALL_INTERFACE:include>
+    PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/src
+)
 
 add_executable(thermal_simd src/thermal_simd.c)
 target_compile_options(thermal_simd PRIVATE -O2 -pthread -fPIC -mno-avx ${THERMAL_SIMD_DISPATCHER_CPU_FLAGS})
 target_link_libraries(thermal_simd PRIVATE thermal_simd_core pthread)
 
-enable_testing()
-
-add_executable(test_config_parser tests/test_config_parser.c)
-target_link_libraries(test_config_parser PRIVATE thermal_simd_core)
-target_compile_options(test_config_parser PRIVATE -Wall -Wextra)
-add_test(NAME config_parser COMMAND test_config_parser)
-
-add_executable(test_statistics tests/test_statistics.c)
-target_link_libraries(test_statistics PRIVATE thermal_simd_core)
-target_compile_options(test_statistics PRIVATE -Wall -Wextra)
-add_test(NAME statistics COMMAND test_statistics)
-
-add_executable(test_thermal_simd
-    tests/test_thermal_simd.c
-    src/thermal_simd.c)
-target_compile_definitions(test_thermal_simd PRIVATE TSD_ENABLE_TESTS)
-target_link_libraries(test_thermal_simd PRIVATE thermal_simd_core pthread)
-target_compile_options(test_thermal_simd PRIVATE -Wall -Wextra -O1 -pthread -fPIC)
-add_test(NAME thermal_simd COMMAND test_thermal_simd)
+if(BUILD_TESTING)
+    add_library(thermal_simd_core_tests STATIC ${THERMAL_SIMD_CORE_SOURCES})
+    target_include_directories(thermal_simd_core_tests
+        PUBLIC
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/include>
+        PRIVATE
+            ${CMAKE_CURRENT_SOURCE_DIR}/src
+    )
+    target_compile_definitions(thermal_simd_core_tests PRIVATE TSD_ENABLE_TESTS)
+
+    add_executable(test_config_parser tests/test_config_parser.c)
+    target_link_libraries(test_config_parser PRIVATE thermal_simd_core_tests)
+    target_compile_options(test_config_parser PRIVATE -Wall -Wextra)
+    add_test(NAME config_parser COMMAND test_config_parser)
+
+    add_executable(test_statistics tests/test_statistics.c)
+    target_link_libraries(test_statistics PRIVATE thermal_simd_core_tests)
+    target_compile_options(test_statistics PRIVATE -Wall -Wextra)
+    add_test(NAME statistics COMMAND test_statistics)
+
+    add_executable(test_thermal_simd
+        tests/test_thermal_simd.c
+        src/thermal_simd.c)
+    target_compile_definitions(test_thermal_simd PRIVATE TSD_ENABLE_TESTS)
+    target_link_libraries(test_thermal_simd PRIVATE thermal_simd_core_tests pthread)
+    target_compile_options(test_thermal_simd PRIVATE -Wall -Wextra -O1 -pthread -fPIC)
+    target_include_directories(test_thermal_simd PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src)
+    add_test(NAME thermal_simd COMMAND test_thermal_simd)
+endif()
+
+install(TARGETS thermal_simd_core
+        EXPORT thermal_simd_dispatcherTargets
+        ARCHIVE DESTINATION lib
+        LIBRARY DESTINATION lib
+        RUNTIME DESTINATION bin)
+
+install(DIRECTORY include/
+        DESTINATION include
+        FILES_MATCHING PATTERN "*.h"
+        PATTERN "*.in" EXCLUDE)
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/thermal/simd/version.h
+        DESTINATION include/thermal/simd)
+
+install(EXPORT thermal_simd_dispatcherTargets
+        NAMESPACE thermal::
+        DESTINATION lib/cmake/thermal_simd_dispatcher)

src/config_parser.h renamed to include/thermal/simd/config_parser.h

@@ -0,0 +1,18 @@
+#ifndef TSD_SIMD_WIDTH_H
+#define TSD_SIMD_WIDTH_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef enum {
+    SIMD_SSE41 = 0,
+    SIMD_AVX2,
+    SIMD_AVX512
+} simd_width_t;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* TSD_SIMD_WIDTH_H */

include/thermal/simd/simd_width.h

@@ -3,8 +3,8 @@
 
 #include <stdint.h>
 
-#include "thermal_config.h"
-#include "thermal_simd_internal.h"
+#include <thermal/simd/simd_width.h>
+#include <thermal/simd/thermal_config.h>
 
 extern uint8_t g_tsd_avx_available;
 

src/statistics.h renamed to include/thermal/simd/statistics.h

@@ -5,7 +5,7 @@
 #include <stddef.h>
 #include <stdint.h>
 
-#include "thermal_config.h"
+#include <thermal/simd/thermal_config.h>
 
 #ifdef __cplusplus
 extern "C" {

src/thermal_config.h renamed to include/thermal/simd/thermal_config.h

@@ -6,7 +6,7 @@
 #include <stddef.h>
 #include <stdint.h>
 
-#include "thermal_simd_internal.h"
+#include <thermal/simd/simd_width.h>
 
 typedef struct {
     uint8_t code[16];

src/thermal_cpu.h renamed to include/thermal/simd/thermal_cpu.h

@@ -0,0 +1,9 @@
+#ifndef TSD_VERSION_H
+#define TSD_VERSION_H
+
+#define THERMAL_SIMD_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
+#define THERMAL_SIMD_VERSION_MINOR @PROJECT_VERSION_MINOR@
+#define THERMAL_SIMD_VERSION_PATCH @PROJECT_VERSION_PATCH@
+#define THERMAL_SIMD_VERSION "@PROJECT_VERSION@"
+
+#endif /* TSD_VERSION_H */