lfilesystem_FileWatcher.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#include <memory>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_FilesystemEntry.h"
 
namespace limes::files
{
 
class LFILE_EXPORT FileWatcher
{
public:
    explicit FileWatcher (const FilesystemEntry& fileToWatch);
 
    FileWatcher() noexcept;
 
    virtual ~FileWatcher();
 
    FileWatcher (const FileWatcher&) = delete;
    FileWatcher& operator= (const FileWatcher&) = delete;
 
    FileWatcher (FileWatcher&&) = delete;
    FileWatcher& operator= (FileWatcher&&) = delete;
 
    virtual void fileAccessed (const FilesystemEntry& /*path*/) { }
 
    virtual void fileMetadataChanged (const FilesystemEntry& /*path*/) { }
 
    virtual void fileHandleClosed (const FilesystemEntry& /*path*/) { }
 
    virtual void fileCreated (const FilesystemEntry& /*path*/) { }
 
    virtual void fileDeleted (const FilesystemEntry& /*path*/) { }
 
    virtual void fileModified (const FilesystemEntry& /*path*/) { }
 
    virtual void fileMoved (const FilesystemEntry& /*path*/) { }
 
    virtual void fileOpened (const FilesystemEntry& /*path*/) { }
 
    virtual void otherEventType (const FilesystemEntry& /*path*/) { }
 
    bool start();
 
    bool start (const FilesystemEntry& newPathToWatch);
 
    void stop();
 
    bool isRunning();
 
    [[nodiscard]] FilesystemEntry getWatchedPath() const noexcept;
 
    static bool supportedBySystem() noexcept;
 
private:
    class Impl;
 
    [[maybe_unused]] std::unique_ptr<Impl> pimpl;
 
    [[maybe_unused]] FilesystemEntry watchedPath;
};
 
}  // namespace files