Implement interface library

.gitignore

@@ -17,3 +17,5 @@ example
 unittests
 _deps
 html/
+build/
+.DS_Store

CMakeLists.txt

@@ -1,6 +1,17 @@
-cmake_minimum_required(VERSION 3.11.4 FATAL_ERROR)
+# Based in https://github.com/TheLartians/ModernCppStarter/blob/master/CMakeLists.txt
 
-project(coulombgalore)
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+project(coulombgalore VERSION 0.1.2 LANGUAGES CXX)
+
+# ---- Include guards ----
+
+if(PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)
+    message(
+        FATAL_ERROR
+        "In-source builds not allowed. Please make a new directory (called a build directory) and run CMake from there."
+    )
+endif()
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
@@ -9,34 +20,61 @@ enable_testing()
 
 include(cmake/CPM.cmake)
 
-## GCC
-if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
-    add_compile_options(-Wall -Wextra -Wpedantic -Wunreachable-code -Wstrict-aliasing)
-## Clang
-elseif (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-    add_compile_options(-Wall -Wextra -Wpedantic -Wunreachable-code -Wstrict-aliasing)
-endif()
-
 # dependencies 
-
 CPMAddPackage("gh:doctest/doctest#v2.4.11")
 CPMAddPackage("gh:nlohmann/[email protected]")
+CPMAddPackage("gh:TheLartians/[email protected]")
 
-# Eigen
 CPMAddPackage(NAME Eigen VERSION 3.4.0 DOWNLOAD_ONLY YES
     URL https://gitlab.com/libeigen/eigen/-/archive/3.4.0/eigen-3.4.0.tar.gz)
 if(Eigen_ADDED)
     add_library(Eigen INTERFACE IMPORTED)
     target_include_directories(Eigen INTERFACE ${Eigen_SOURCE_DIR})
 endif()
 
-include_directories(${CMAKE_SOURCE_DIR}/include)
+file(GLOB_RECURSE headers CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/include/*.hpp")
 
-add_executable(example test/example.cpp)
-target_link_libraries(example Eigen nlohmann_json)
+add_library(${PROJECT_NAME} INTERFACE ${headers})
+set_target_properties(${PROJECT_NAME} PROPERTIES CXX_STANDARD 17)
+target_link_libraries(${PROJECT_NAME} INTERFACE Eigen)
 
-add_executable(tests test/unittests.cpp)
-target_link_libraries(tests doctest Eigen nlohmann_json)
+target_include_directories(
+    ${PROJECT_NAME} INTERFACE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+)
 
+# Compile flags
+
+# being a cross-platform target, we enforce standards conformance on MSVC
+target_compile_options(${PROJECT_NAME} INTERFACE "$<$<COMPILE_LANG_AND_ID:CXX,MSVC>:/permissive->")
+
+if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
+    add_compile_options(-Wall -Wextra -Wpedantic -Wunreachable-code -Wstrict-aliasing)
+elseif (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    add_compile_options(-Wall -Wextra -Wpedantic -Wunreachable-code -Wstrict-aliasing)
+endif()
+
+# the location where the project's version header will be placed should match the project's regular
+# header paths
+string(TOLOWER ${PROJECT_NAME}/version.h VERSION_HEADER_LOCATION)
+
+packageProject(
+    NAME ${PROJECT_NAME}
+    VERSION ${PROJECT_VERSION}
+    NAMESPACE ${PROJECT_NAME}
+    BINARY_DIR ${PROJECT_BINARY_DIR}
+    INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include
+    INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}
+    VERSION_HEADER "${VERSION_HEADER_LOCATION}"
+    DEPENDENCIES "eigen 3"
+)
+
+# example
+add_executable(example EXCLUDE_FROM_ALL test/example.cpp)
+target_link_libraries(example ${PROJECT_NAME} nlohmann_json)
+
+# unittests
+add_executable(tests test/unittests.cpp)
+target_link_libraries(tests ${PROJECT_NAME} doctest Eigen nlohmann_json)
 add_test(NAME tests COMMAND tests)
 

include/coulombgalore/all.hpp

@@ -24,15 +24,15 @@
  */
 #pragma once
 
-#include "ewald.h"
-#include "ewald_truncated.h"
-#include "fanourgakis.h"
-#include "fennell.h"
-#include "plain.h"
-#include "poisson.h"
-#include "qpotential.h"
-#include "reactionfield.h"
-#include "splined.h"
-#include "wolf.h"
-#include "zahn.h"
-#include "zerodipole.h"
+#include "ewald.hpp"
+#include "ewald_truncated.hpp"
+#include "fanourgakis.hpp"
+#include "fennell.hpp"
+#include "plain.hpp"
+#include "poisson.hpp"
+#include "qpotential.hpp"
+#include "reactionfield.hpp"
+#include "splined.hpp"
+#include "wolf.hpp"
+#include "zahn.hpp"
+#include "zerodipole.hpp"

include/coulombgalore/ewald.hpp

@@ -24,7 +24,7 @@
 */
 #pragma once
 
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 

include/coulombgalore/ewald_truncated.hpp

@@ -24,7 +24,7 @@
 */
 #pragma once
 
-#include "ewald.h"
+#include "coulombgalore/ewald.hpp"
 
 namespace CoulombGalore {
 

include/coulombgalore/fanourgakis.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -134,4 +134,4 @@ inline std::shared_ptr<SchemeBase> createScheme(const nlohmann::json &j) {
 }
 #endif
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/fennell.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -81,4 +81,4 @@ class Fennell : public EnergyImplementation<Fennell> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/plain.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 
@@ -56,4 +56,4 @@ class Plain : public EnergyImplementation<Plain> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/poisson.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -231,4 +231,4 @@ class Poisson : public EnergyImplementation<Poisson> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/qpotential.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 

include/coulombgalore/reactionfield.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -85,4 +85,4 @@ class ReactionField : public EnergyImplementation<ReactionField> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/splined.hpp

@@ -24,7 +24,7 @@
  */
 #pragma once
 
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 namespace Tabulate {
@@ -385,4 +385,4 @@ class Splined : public EnergyImplementation<Splined> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/wolf.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -79,4 +79,4 @@ class Wolf : public EnergyImplementation<Wolf> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/zahn.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -84,4 +84,4 @@ class Zahn : public EnergyImplementation<Zahn> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

include/coulombgalore/zerodipole.hpp

@@ -24,7 +24,7 @@
  */
 
 #pragma once
-#include "core.h"
+#include "coulombgalore/core.hpp"
 
 namespace CoulombGalore {
 /**
@@ -89,4 +89,4 @@ class ZeroDipole : public EnergyImplementation<ZeroDipole> {
 #endif
 };
 
-} // namespace CoulombGalore
+} // namespace CoulombGalore

test/example.cpp

@@ -1,9 +1,9 @@
 #include <iostream>
 #include <nlohmann/json.hpp>
-#include "coulombgalore/plain.h"
-#include "coulombgalore/qpotential.h"
-#include "coulombgalore/fanourgakis.h"
-#include "coulombgalore/ewald.h"
+#include "coulombgalore/plain.hpp"
+#include "coulombgalore/qpotential.hpp"
+#include "coulombgalore/fanourgakis.hpp"
+#include "coulombgalore/ewald.hpp"
 
 using namespace CoulombGalore;
 

test/unittests.cpp

@@ -5,7 +5,7 @@
 
 #include <doctest/doctest.h>
 #include <nlohmann/json.hpp>
-#include "coulombgalore/all.h"
+#include "coulombgalore/all.hpp"
 
 using namespace CoulombGalore;