Feature dependency (#154)

* Add shapelib to third party

* In progress with add cpp-api

* Remove OSM dependencies

* Clean cmake file

* Done with an initial version of external project

* Add fmm prefix to header

* Update installation path

* Fix RPATH issue

Author: cyang-kth

CMakeLists.txt

@@ -18,21 +18,19 @@ if (POLICY CMP0078)
 endif()
 
 # Prevent in source build
-set(CMAKE_DISABLE_SOURCE_CHANGES  ON)
+set(CMAKE_DISABLE_SOURCE_CHANGES  OFF)
 set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
 
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 project(fmm)
 
 set(CMAKE_BUILD_TYPE "Release")
-# set(CMAKE_C_FLAGS "-std=c11")
 set(CMAKE_CXX_FLAGS "-O3 -DSPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_TRACE")
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/build")
 
-list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake"
-     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/libosmium/cmake")
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 find_package(Conda)
 if(CONDA_PREFIX)
@@ -42,22 +40,6 @@ else()
   message(STATUS "Non conda exist, search library in default path")
 endif()
 
-if(NOT OSMIUM_INCLUDE_DIR)
-  set(OSMIUM_INCLUDE_DIR "third_party/libosmium/include")
-endif()
-if(NOT PROTOZERO_INCLUDE_DIR)
-  set(PROTOZERO_INCLUDE_DIR "third_party/protozero/include")
-endif()
-
-find_package(Osmium REQUIRED COMPONENTS io)
-if(OSMIUM_FOUND)
-  message(STATUS "OSMium found at ${OSMIUM_INCLUDE_DIRS}")
-  message(STATUS "OSMium library found at ${OSMIUM_LIBRARIES}")
-  include_directories(${OSMIUM_INCLUDE_DIR})
-else()
-  message(FATAL_ERROR "Libosmium not found!\n")
-endif()
-
 find_package(GDAL 2.2 REQUIRED)
 if (GDAL_FOUND)
   message(STATUS "GDAL headers found at ${GDAL_INCLUDE_DIR}")
@@ -84,10 +66,32 @@ if(OPENMP_FOUND)
   message(STATUS "OpenMP_CXX_LIBRARIES found at ${OpenMP_CXX_LIBRARIES}")
 endif()
 
-include_directories(third_party)
-include_directories(third_party/libosmium/include)
-include_directories(third_party/protozero/include)
-include_directories(src)
+### Set RPATH properties
+
+set(CMAKE_SKIP_BUILD_RPATH FALSE)
+
+set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
+
+set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
+
+set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
+
+# Build h3 objects
+
+set(UNCONFIGURED_API_HEADER
+  ${CMAKE_CURRENT_SOURCE_DIR}/third_party/h3/include/h3api.h.in)
+set(CONFIGURED_API_HEADER
+  ${CMAKE_CURRENT_SOURCE_DIR}/third_party/h3/include/h3api.h)
+configure_file(${UNCONFIGURED_API_HEADER} ${CONFIGURED_API_HEADER})
+
+# Creation of FMMLIB
+
+set(FMM_INCLUDE_PATH
+${CMAKE_CURRENT_SOURCE_DIR}/src
+${CMAKE_CURRENT_SOURCE_DIR}/third_party
+${CMAKE_CURRENT_SOURCE_DIR}/third_party/h3/include)
+
+include_directories(${FMM_INCLUDE_PATH})
 
 file(GLOB CoreGlob src/core/*.cpp)
 file(GLOB AlgorithmGlob src/algorithm/*.cpp)
@@ -98,6 +102,7 @@ file(GLOB UtilGlob src/util/*.cpp)
 file(GLOB MMGlob src/mm/*.cpp)
 file(GLOB FMMGlob src/mm/fmm/*.cpp)
 file(GLOB STMATCHGlob src/mm/stmatch/*.cpp)
+file(GLOB h3Glob third_party/h3/lib/*.c)
 
 add_library(CORE OBJECT ${CoreGlob})
 add_library(ALGORITHM OBJECT ${AlgorithmGlob})
@@ -108,36 +113,8 @@ add_library(NETWORK OBJECT ${NetworkGlob})
 add_library(MM_OBJ OBJECT ${MMGlob})
 add_library(FMM_OBJ OBJECT ${FMMGlob})
 add_library(STMATCH_OBJ OBJECT ${STMATCHGlob})
-
-# Build h3 objects
-
-set(UNCONFIGURED_API_HEADER third_party/h3/src/h3lib/include/h3api.h.in)
-set(CONFIGURED_API_HEADER third_party/h3/src/h3lib/include/h3api.h)
-configure_file(${UNCONFIGURED_API_HEADER} ${CONFIGURED_API_HEADER})
-message(STATUS "Copy h3 header to ${CONFIGURED_API_HEADER}")
-set(H3_INCLUDE_PATH
-    ${CMAKE_CURRENT_BINARY_DIR}/third_party/h3/src/h3lib/include
-    ${CMAKE_CURRENT_SOURCE_DIR}/third_party/h3/src/h3lib/include)
-
-file(GLOB h3Glob third_party/h3/src/h3lib/lib/*.c)
 add_library(H3_OBJ OBJECT ${h3Glob})
-target_include_directories(H3_OBJ PUBLIC ${H3_INCLUDE_PATH})
 
-### Set RPATH properties
-
-set(CMAKE_SKIP_BUILD_RPATH FALSE)
-
-# when building, don't use the install RPATH already
-# (but later on when installing)
-set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
-
-set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
-
-# add the automatically determined parts of the RPATH
-# which point to directories outside the build tree to the install RPATH
-set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
-
-# Creation of FMMLIB
 add_library(FMMLIB SHARED
   $<TARGET_OBJECTS:MM_OBJ>
   $<TARGET_OBJECTS:FMM_OBJ>
@@ -149,11 +126,10 @@ add_library(FMMLIB SHARED
   $<TARGET_OBJECTS:NETWORK>
   $<TARGET_OBJECTS:IO>
   $<TARGET_OBJECTS:H3_OBJ>)
+
 target_link_libraries(FMMLIB
-          ${OSMIUM_LIBRARIES}
           ${GDAL_LIBRARIES} ${Boost_LIBRARIES}
           ${OpenMP_CXX_LIBRARIES})
-install(TARGETS FMMLIB DESTINATION lib)
 
 # Add executables
 
@@ -167,14 +143,47 @@ add_executable(stmatch src/app/stmatch.cpp)
 target_link_libraries(stmatch FMMLIB)
 
 add_executable(h3mm src/app/h3mm.cpp)
-target_include_directories(
-  h3mm PUBLIC ${H3_INCLUDE_PATH})
-
 target_link_libraries(h3mm FMMLIB)
 
 message(STATUS "Installation folder ${CMAKE_INSTALL_PREFIX}")
 
+install(TARGETS FMMLIB LIBRARY DESTINATION lib)
+
 install(TARGETS fmm ubodt_gen stmatch h3mm DESTINATION bin)
 
+set(FMM_DIST_INCLUDE_PATH
+${CMAKE_CURRENT_SOURCE_DIR}/src/algorithm
+${CMAKE_CURRENT_SOURCE_DIR}/src/config
+${CMAKE_CURRENT_SOURCE_DIR}/src/core
+${CMAKE_CURRENT_SOURCE_DIR}/src/io
+${CMAKE_CURRENT_SOURCE_DIR}/src/mm
+${CMAKE_CURRENT_SOURCE_DIR}/src/network
+${CMAKE_CURRENT_SOURCE_DIR}/src/python
+${CMAKE_CURRENT_SOURCE_DIR}/src/util
+${CMAKE_CURRENT_SOURCE_DIR}/third_party/cxxopts
+${CMAKE_CURRENT_SOURCE_DIR}/third_party/fiboheap
+${CMAKE_CURRENT_SOURCE_DIR}/third_party/h3
+${CMAKE_CURRENT_SOURCE_DIR}/third_party/spdlog)
+
+set(FMM_API_HEADER
+${CMAKE_CURRENT_SOURCE_DIR}/src/fmm-api.hpp
+)
+
+install(
+    DIRECTORY
+    ${FMM_DIST_INCLUDE_PATH}
+    DESTINATION
+    "include/fmm"
+    FILES_MATCHING
+    PATTERN "*.hpp"
+    PATTERN "*.h"
+)
+install(
+    FILES
+    ${FMM_API_HEADER}
+    DESTINATION
+    "include/fmm"
+)
+
 add_subdirectory(python)
-add_subdirectory(test EXCLUDE_FROM_ALL)
+# add_subdirectory(test EXCLUDE_FROM_ALL)

appveyor.yml

@@ -17,7 +17,7 @@ init:
     - '%CYG_INSTALL% "wget"'
     - '%CYG_SH% "wget rawgit.com/transcode-open/apt-cyg/master/apt-cyg"'
     - '%CYG_SH% "install apt-cyg /bin"'
-    - '%CYG_SH% "apt-cyg install make gcc-g++ cmake gdal libboost-devel zlib-devel libgdal-devel libexpat1-devel libbz2-devel"'
+    - '%CYG_SH% "apt-cyg install make gcc-g++ cmake gdal libboost-devel libgdal-devel"'
     - '%CYG_SH% "apt-cyg install swig python-devel"'
 
 # clone directory

example/README.md

@@ -22,8 +22,5 @@
 
 - [web_demo](web_demo)
 
-### OSM example
-- [OSM example](osm_example)
-
 ### OSMNX example
 - [OSMNX example](osmnx_example)

example/cpp-api/CMakeLists.txt

@@ -0,0 +1,23 @@
+cmake_minimum_required( VERSION 3.5.1)
+
+project(fmm-contrib)
+
+set(CMAKE_CXX_FLAGS "-O3 -DSPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_TRACE")
+set(CMAKE_CXX_STANDARD 11)
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+
+find_package(FMM REQUIRED)
+if (FMM_FOUND)
+    message(STATUS "FMM headers found at ${FMM_INCLUDE_DIR}")
+    message(STATUS "FMM library found at ${FMM_LIBRARY}")
+    include_directories(${FMM_INCLUDE_DIR})
+    include_directories(${FMM_INCLUDE_DIR}/fmm)
+else()
+    message(FATAL_ERROR "FMM Not Found!")
+endif (FMM_FOUND)
+
+add_executable(fmm_print_network main.cpp)
+target_link_libraries(fmm_print_network ${FMM_LIBRARY})
+
+install(TARGETS fmm_print_network DESTINATION bin)

example/cpp-api/README.md

@@ -0,0 +1,17 @@
+### Use fmm in an external project
+
+Build the program
+
+```
+mkdir build
+cd build
+cmake .. -DFMM_LIB -DFMM_HEADER
+make
+sudo make install
+```
+
+Run it with
+
+```
+fmm_print_network example/data/edges.shp
+```

example/cpp-api/cmake/findFMM.cmake

@@ -0,0 +1,15 @@
+if (NOT FMM_INCLUDE_DIR)
+    find_path(FMM_INCLUDE_DIR fmm/fmm-api.hpp ${CMAKE_PREFIX_PATH} PATH_SUFFIXES include)
+else ()
+    file(TO_CMAKE_PATH "${FMM_INCLUDE_DIR}" FMM_INCLUDE_DIR)
+endif ()
+
+if (NOT FMM_LIBRARY)
+    find_library(FMM_LIBRARY NAMES fmmlib NAMES_PER_DIR PATH_SUFFIXES lib)
+else ()
+    file(TO_CMAKE_PATH "${FMM_LIBRARY}" FMM_LIBRARY)
+endif ()
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(FMM
+                                  REQUIRED_VARS FMM_LIBRARY FMM_INCLUDE_DIR)

example/cpp-api/main.cpp

@@ -0,0 +1,19 @@
+#include <fmm/fmm-api.hpp>
+#include <iostream>
+using namespace FMM;
+using namespace FMM::NETWORK;
+using namespace FMM::CORE;
+using namespace FMM::MM;
+
+int main(int argc, char **argv){
+  SPDLOG_INFO("Use FMM in an external project");
+  if (argc!=2){
+    SPDLOG_ERROR("Incorrect number of arguments");
+  } else {
+    std::string filename(argv[1]);
+    SPDLOG_INFO("Network file {}",filename);
+    Network network(filename,"id","source","target");
+    SPDLOG_INFO("Network node count {}",network.get_node_count());
+    SPDLOG_INFO("Network edge count {}",network.get_edge_count());
+  }
+};