enable cmake import (#82)

Author: tzaeschke

.gitignore

@@ -14,4 +14,4 @@ out
 cygwin
 CMakeSettings.json
 
-/cmake-build-debug/
+**/cmake-build-debug/

BUILD

@@ -69,3 +69,30 @@ filegroup(
     name = "dot_clang_format",
     srcs = [".clang-format"],
 )
+
+cc_library(
+    name = "phtree",
+    srcs = glob(
+        include = [
+            "include/**/*.h",
+        ],
+    ),
+    hdrs = [
+        "include/phtree/converter.h",
+        "include/phtree/distance.h",
+        "include/phtree/filter.h",
+        "include/phtree/phtree.h",
+        "include/phtree/phtree_multimap.h",
+    ],
+    includes = [
+        "include",
+    ],
+    linkstatic = True,
+    visibility = [
+        "//visibility:public",
+    ],
+    deps = [
+        "//include/phtree/common",
+        "//include/phtree/v16",
+    ],
+)

CHANGELOG.md

@@ -6,15 +6,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 ### Added
-- Added build features: 
+- Added build features: [#53](https://github.com/tzaeschke/phtree-cpp/issues/53) 
   - linting for C++ and bazel files.
   - Added CI status badges.
   - Added test coverage
-    [#53](https://github.com/tzaeschke/phtree-cpp/issues/53)
 
 ### Changed
 - Cleaned up build scripts. [#53](https://github.com/tzaeschke/phtree-cpp/issues/53)
 - Fixed code coverage + migrate to linux. [#80](https://github.com/tzaeschke/phtree-cpp/issues/80)
+- ***BREAKING CHANGE*** The project has been restructured to have a more "standard" directory structure.
+  This affects how **bazel** dependencies work (use `deps = ["@phtree//:phtree",]`) and enables **cmake FetchContent_**.
+  See README for details. [#75](https://github.com/tzaeschke/phtree-cpp/issues/75)
 
 ### Removed
 - Nothing.

CMakeLists.txt

@@ -1,8 +1,8 @@
 cmake_minimum_required(VERSION 3.14)
 
-# set the project name
 project(phtree VERSION 1.3.0
         DESCRIPTION "PH-Tree C++"
+        HOMEPAGE_URL "https://github.com/tzaeschke/phtree-cpp"
         LANGUAGES CXX)
 
 
@@ -19,16 +19,13 @@ endif ()
 # ---------------------------------------------------------------------------------------
 # Build options
 # ---------------------------------------------------------------------------------------
-# example options
 option(PHTREE_BUILD_ALL "Build examples, tests and benchmarks" OFF)
 
 # example options
 option(PHTREE_BUILD_EXAMPLES "Build examples" OFF)
-#option(PHTREE_BUILD_EXAMPLE_HO "Build header only example" OFF)
 
 # testing options
 option(PHTREE_BUILD_TESTS "Build tests" OFF)
-#option(PHTREE_BUILD_TESTS_HO "Build tests using the header only version" OFF)
 option(PHTREE_CODE_COVERAGE "Collect coverage from test library" OFF)
 if (PHTREE_CODE_COVERAGE)
     set(PHTREE_BUILD_TESTS ON)
@@ -57,8 +54,7 @@ if (NOT CMAKE_CXX_STANDARD)
 endif ()
 
 if (MSVC)
-    #set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++17 /Wall")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++17")
+    #set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Wall")
     set(CMAKE_CXX_FLAGS_RELEASE "/O2")
 
     if (PHTREE_BUILD_TESTS OR PHTREE_BUILD_ALL)
@@ -78,7 +74,7 @@ if (MSVC)
         # set(BENCHMARK_ENABLE_GTEST_TESTS OFF)
     endif ()
 else ()
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -Wall -Werror")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Werror")
     if (PHTREE_BUILD_BENCHMARKS)
         set(CMAKE_CXX_FLAGS_RELEASE "-O3 -mavx -pthread")
     else ()
@@ -93,7 +89,17 @@ endif ()
 # ---------------------------------------------------------------------------------------
 # Build binaries
 # ---------------------------------------------------------------------------------------
-add_subdirectory(phtree)
+
+# ---------------------------------------------------------------------------------------
+# Header only version
+# ---------------------------------------------------------------------------------------
+add_library(phtree INTERFACE)
+add_library(phtree::phtree ALIAS phtree)
+target_compile_features(phtree INTERFACE cxx_std_17)
+
+target_include_directories(phtree INTERFACE
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
 
 if (PHTREE_BUILD_EXAMPLES OR PHTREE_BUILD_ALL)
     message(STATUS "Generating examples")
@@ -107,26 +113,6 @@ endif ()
 
 if (PHTREE_BUILD_TESTS OR PHTREE_BUILD_ALL)
     message(STATUS "Generating tests")
-    if (FALSE)
-        add_compile_definitions(GTEST_HAS_ABSL=0)
-        add_compile_definitions(GTEST_OS_WINDOWS_MOBILE=0)
-        if (MSVC)
-            add_compile_definitions(GTEST_OS_WINDOWS_MINGW=0)
-        endif ()
-        add_compile_definitions(GTEST_OS_LINUX_ANDROID=0)
-        if (LINUX)
-            add_compile_definitions(GTEST_OS_LINUX=1)
-        else ()
-            add_compile_definitions(GTEST_OS_LINUX=0)
-        endif ()
-        add_compile_definitions(
-                GTEST_OS_WINDOWS_MOBILE=0
-                GTEST_OS_WINDOWS_PHONE=0
-                GTEST_OS_WINDOWS_RT=0
-                GTEST_OS_ESP8266=0
-                GTEST_OS_XTENSA=0)
-    endif ()
-
     enable_testing()
     include(GoogleTest)
     add_subdirectory(test)

README.md

@@ -533,8 +533,8 @@ There are numerous ways to improve performance. The following list gives an over
 
 ## Compiling the PH-Tree
 
-The PH-Tree index itself is a *header only* library, it can be used by simply copying all headers in the `phtree` 
-folder. 
+The PH-Tree index itself is a *header only* library, it can be used by simply copying everything in the 
+`include/phtree` folder. 
 The examples, tests and benchmarks can be build with bazel or cmake.  
 
 <a id="build-system-and-dependencies"></a>
@@ -545,7 +545,7 @@ PH-Tree can be built with [Bazel](https://bazel.build) (primary build system) or
 [cmake](https://cmake.org/) *3.14*. 
 All code is written in C++ targeting the C++17 standard. 
 The code has been verified to compile on Linux with Clang 11 and GCC 9, and on Windows with Visual Studio 2019
-(except benchmarks, which don't work wi VS).
+(except benchmarks, which don't work with VS).
 The PH-tree makes use of vectorization, so suggested compilation options for clang/gcc are:
 ```
 -O3 -mavx
@@ -555,6 +555,25 @@ The PH-tree makes use of vectorization, so suggested compilation options for cla
 <a id="bazel"></a>
 
 ### Bazel
+<!--
+`WORKSPACE` file:
+```
+http_archive(
+    name = "phtree",
+    strip_prefix = "phtree-cpp-v1.4.0",
+    url = "https://github.com/tzaeschke/phtree-cpp",
+)
+```
+`BUILD` file:
+```
+cc_binary(
+    ...
+    deps = [
+        "@phtree//:phtree",
+    ],
+)
+```
+-->
 
 Once you have set up your dependencies, you should be able to build the PH-Tree repository by running:
 ```
@@ -575,6 +594,19 @@ bazel run //benchmark:update_mm_d_benchmark --config=benchmark  -- --benchmark_c
 <a id="cmake"></a>
 
 ### cmake
+<!--With `FetchContent_...()`: ***NOTE This will only work once v1.4.0 has been released!***
+```
+include(FetchContent)
+FetchContent_Declare(
+        phtree
+        GIT_REPOSITORY https://github.com/tzaeschke/phtree-cpp.git
+        #GIT_TAG v1.3.0
+        GIT_TAG 9e81dd52560b346895379586d03ff4c51508d9d4
+)
+FetchContent_MakeAvailable(phtree)
+```
+-->
+
 `cmake` uses `ccache` when available.
 ```
 mkdir build
@@ -597,7 +629,8 @@ cmake --build .
 ctest
 ```
 Next to example (`PHTREE_BUILD_EXAMPLES`) there are also tests (`PHTREE_BUILD_TESTS`) and 
-benchmarks (`PHTREE_BUILD_BENCHMARKS`). To build all, use `PHTREE_BUILD_ALL`.
+benchmarks (`PHTREE_BUILD_BENCHMARKS`). To build all, use `PHTREE_BUILD_ALL`. 
+**Note that the benchmarks currently don't work on Windows.** 
 
 ## Further Resources
 

WORKSPACE

@@ -28,7 +28,6 @@ http_archive(
 
 http_archive(
     name = "gtest",
-    build_file = "@third_party//gtest:BUILD",
     sha256 = "b4870bf121ff7795ba20d20bcdd8627b8e088f2d1dab299a031c1034eddc93d5",
     strip_prefix = "googletest-release-1.11.0",
     url = "https://github.com/google/googletest/archive/release-1.11.0.tar.gz",