// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html       *
// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved        *
// **************************************************************************

#ifndef WATCHER_H_INCLUDED
#define WATCHER_H_INCLUDED

#include <zen/dir_watcher.h>
#include <zen/file_error.h>


namespace rts
{
const int UI_UPDATE_INTERVAL = 100; //unit: [ms]; perform ui updates not more often than necessary, 100 seems to be a good value with only a minimal performance loss
bool updateUiIsAllowed();


class WaitCallback
{
public:
    virtual ~WaitCallback() {}
    virtual void requestUiRefresh(bool readyForSync = false) = 0; //opportunity to abort must be implemented in a frequently executed method like requestUiRefresh()
};


//wait until changes are detected or if a directory is not available (anymore)
enum ChangeType
{
    CHANGE_DETECTED,
    CHANGE_DIR_MISSING
};

struct WaitResult
{
    WaitResult(const zen::DirWatcher::Entry& changedItem) : type(CHANGE_DETECTED), changedItem_(changedItem) {}
    WaitResult(const Zstring& dirname) : type(CHANGE_DIR_MISSING), dirname_(dirname) {}

    ChangeType type;
    zen::DirWatcher::Entry changedItem_; //for type == CHANGE_DETECTED: file or directory
    Zstring dirname_;                    //for type == CHANGE_DIR_MISSING
};

WaitResult waitForChanges(const std::vector<Zstring>& dirNamesNonFmt,
                          //non-formatted dirnames that yet require call to getFormattedDirectoryName(); empty directories must be checked by caller!
                          WaitCallback& statusHandler); //throw FileError

//wait until all directories become available (again) + logs in network share
void waitForMissingDirs(const std::vector<Zstring>& dirNamesNonFmt,
                        WaitCallback& statusHandler); //throw FileError
}

#endif // WATCHER_H_INCLUDED