Merge pull request #76 from erikzenker/feature/erikzenker/std-filesystem

feat: Update to c++17 (std::filesystem)

Author: erikzenker

.github/workflows/build_and_test.yml

@@ -9,12 +9,12 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-16.04
+    runs-on: ubuntu-20.04
 
     steps:
     - uses: actions/checkout@v2
     - name: Install Dependencies
-      run: sudo apt install cmake libboost-filesystem-dev libboost-test-dev gcc
+      run: sudo apt install cmake libboost-all-dev libboost-test-dev gcc
     - name: Print System Information
       run: |
         cmake --version

.github/workflows/example.yml

@@ -9,12 +9,12 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-16.04
+    runs-on: ubuntu-20.04
 
     steps:
     - uses: actions/checkout@v2
     - name: Install Dependencies
-      run: sudo apt install cmake libboost-filesystem-dev libboost-test-dev gcc
+      run: sudo apt install cmake libboost-all-dev gcc
     - name: Print System Information
       run: |
         cmake --version
@@ -25,7 +25,7 @@ jobs:
         export CXX=g++
         export CC=gcc
         mkdir build && cd build
-        cmake .. 
+        cmake .. -DBUILD_TEST=OFF
         cmake --build . --target inotify_example
     - name: Run example
       run: |

.gitignore

@@ -9,4 +9,5 @@ test/unit/testDirectory/
 install_manifest.txt
 .idea/
 **/build/
-cmake-build-debug/
+cmake-build-debug/
+.vscode

README.md

@@ -11,7 +11,7 @@ the implementation of a simple filesystem event watcher for the commandline.
   ```c++
 #include <inotify-cpp/NotifierBuilder.h>
 
-#include <boost/filesystem.hpp>
+#include <filesystem>
 
 #include <iostream>
 #include <thread>
@@ -27,7 +27,7 @@ int main(int argc, char** argv)
     }
 
     // Parse the directory to watch
-    boost::filesystem::path path(argv[1]);
+    std::filesystem::path path(argv[1]);
 
     // Set the event handler which will be used to process particular events
     auto handleNotification = [&](Notification notification) {
@@ -98,7 +98,7 @@ cmake --build . --target inotify_example
 ## Dependencies ##
  + lib
    + boost 1.54.0
-   + c++11
+   + c++17
    + linux 2.6.13
  + build
    + cmake 3.8  

example/CMakeLists.txt

@@ -13,7 +13,7 @@ endif()
 ###############################################################################
 find_package(
         Boost 1.54.0
-        COMPONENTS unit_test_framework system filesystem
+        COMPONENTS unit_test_framework system
         REQUIRED
 )
 
@@ -26,10 +26,8 @@ find_package(Threads)
 # Target
 ###############################################################################
 add_executable(inotify_example main.cpp)
+target_compile_features(inotify_example PRIVATE cxx_std_17)
 target_link_libraries(inotify_example
         PRIVATE
         inotify-cpp::inotify-cpp
-        Boost::unit_test_framework
-        Boost::system
-        Boost::filesystem
         ${CMAKE_THREAD_LIBS_INIT})

example/main.cpp

@@ -1,6 +1,6 @@
 #include <inotify-cpp/NotifierBuilder.h>
 
-#include <boost/filesystem.hpp>
+#include <filesystem>
 
 #include <iostream>
 #include <thread>
@@ -16,7 +16,7 @@ int main(int argc, char** argv)
     }
 
     // Parse the directory to watch
-    boost::filesystem::path path(argv[1]);
+    std::filesystem::path path(argv[1]);
 
     // Set the event handler which will be used to process particular events
     auto handleNotification = [&](Notification notification) {

src/CMakeLists.txt

@@ -15,7 +15,6 @@ include(GNUInstallDirs)
 # dependencies
 find_package(
         Boost 1.54.0
-        COMPONENTS system filesystem
         REQUIRED
 )
 
@@ -40,8 +39,7 @@ macro(configure_target target)
         target_include_directories(${target} PUBLIC
                 $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
                 $<INSTALL_INTERFACE:include>)
-        target_link_libraries(${target}
-                INTERFACE Boost::system Boost::filesystem)
+        target_compile_features(${target} PRIVATE cxx_std_17)
 endmacro(configure_target target)
 
 # library definition

src/FileSystemEvent.cpp

@@ -6,7 +6,7 @@ namespace inotify {
 FileSystemEvent::FileSystemEvent(
     const int wd,
     uint32_t mask,
-    const boost::filesystem::path& path,
+    const std::filesystem::path& path,
     const std::chrono::steady_clock::time_point& eventTime)
     : wd(wd)
     , mask(mask)

src/Inotify.cpp

@@ -1,15 +1,16 @@
 
 #include <inotify-cpp/Inotify.h>
 
+#include <iostream>
+#include <optional>
 #include <string>
 #include <vector>
-#include <iostream>
 
 #include <sys/epoll.h>
 #include <fcntl.h>
 #include <unistd.h>
 
-namespace fs = boost::filesystem;
+namespace fs = std::filesystem;
 
 namespace inotify {
 
@@ -97,14 +98,15 @@ Inotify::~Inotify()
  */
 void Inotify::watchDirectoryRecursively(fs::path path)
 {
-    std::vector<boost::filesystem::path> paths;
+    std::vector<std::filesystem::path> paths;
 
     if (fs::exists(path)) {
         paths.push_back(path);
 
         if (fs::is_directory(path)) {
-            boost::system::error_code ec;
-            fs::recursive_directory_iterator it(path, fs::symlink_option::recurse, ec);
+            std::error_code ec;
+            fs::recursive_directory_iterator it(
+                path, fs::directory_options::follow_directory_symlink, ec);
             fs::recursive_directory_iterator end;
 
             for (; it != end; it.increment(ec)) {
@@ -234,7 +236,7 @@ void Inotify::setEventTimeout(
  * @return A new FileSystemEvent
  *
  */
-boost::optional<FileSystemEvent> Inotify::getNextEvent()
+std::optional<FileSystemEvent> Inotify::getNextEvent()
 {
     std::vector<FileSystemEvent> newEvents;
 
@@ -245,7 +247,7 @@ boost::optional<FileSystemEvent> Inotify::getNextEvent()
     }
 
     if (mStopped) {
-        return boost::none;
+        return std::nullopt;
     }
 
     auto event = mEventQueue.front();

src/Notification.cpp

@@ -4,7 +4,7 @@ namespace inotify {
 
 Notification::Notification(
     const Event& event,
-    const boost::filesystem::path& path,
+    const std::filesystem::path& path,
     std::chrono::steady_clock::time_point time)
     : event(event)
     , path(path)