kdirwatch.h

/*
    This file is part of the KDE libraries

    SPDX-FileCopyrightText: 1998 Sven Radej <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-only
*/
#ifndef _KDIRWATCH_H
#define _KDIRWATCH_H

#include <QDateTime>
#include <QObject>
#include <QString>

#include <kcoreaddons_export.h>

class KDirWatchPrivate;

class KCOREADDONS_EXPORT KDirWatch : public QObject
{
    Q_OBJECT

public:

    enum WatchMode {
        WatchDirOnly = 0,  
        WatchFiles = 0x01, 
        WatchSubDirs = 0x02 
    };
    Q_DECLARE_FLAGS(WatchModes, WatchMode)

    
    explicit KDirWatch(QObject *parent = nullptr);

    ~KDirWatch();

    void addDir(const QString &path, WatchModes watchModes = WatchDirOnly);

    void addFile(const QString &file);

    QDateTime ctime(const QString &path) const;

    void removeDir(const QString &path);

    void removeFile(const QString &file);

    bool stopDirScan(const QString &path);

    bool restartDirScan(const QString &path);

    void startScan(bool notify = false, bool skippedToo = false);

    void stopScan();

    bool isStopped();

    bool contains(const QString &path) const;

    void deleteQFSWatcher(); // KF6 TODO: remove from public API

    static void statistics(); // TODO implement a QDebug operator for KDirWatch instead.

    enum Method { FAM, INotify, Stat, QFSWatch };
    Method internalMethod() const;

    static KDirWatch *self();
    static bool exists();

public Q_SLOTS:

    void setCreated(const QString &path);

    void setDirty(const QString &path);

    void setDeleted(const QString &path);

Q_SIGNALS:

    void dirty(const QString &path);

    void created(const QString &path);

    void deleted(const QString &path);

private:
    KDirWatchPrivate *d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KDirWatch::WatchModes)

#endif