fswalker.h

/*
** Copyright 2007-2025, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#ifndef __ANTARES_FS_WALKER_FS_WALKER_H__
#define __ANTARES_FS_WALKER_FS_WALKER_H__
 
#include <memory>
 
#include <yuni/yuni.h>
#include <yuni/core/bind.h>
#include <yuni/core/noncopyable.h>
#include <yuni/core/string.h>
#include <yuni/thread/thread.h>
 
#include "job.h"
#include "statistics.h"
 
namespace FSWalker
{
enum Flow
{
    flContinue,
    flAbort,
    flSkip
};
 
using OnDirectoryEvent = Flow (*)(const YString& path, bool empty, void* user);
using OnFileEvent = void (*)(const YString& filename,
                             const YString& parent,
                             int64_t modified,
                             uint64_t size,
                             void* user);
using DispatchJobEvent = std::function<void(IJob::Ptr job)>;
 
class IExtension
{
public:
    using Ptr = std::shared_ptr<IExtension>;
    using Vector = std::vector<Ptr>;
 
public:
    IExtension()
    {
    }
 
    virtual ~IExtension()
    {
    }
 
    virtual const char* caption() const = 0;
 
    virtual int priority() const
    {
        return 0;
    }
 
    virtual OnDirectoryEvent directoryEvent()
    {
        return nullptr;
    }
 
    virtual OnFileEvent fileEvent()
    {
        return nullptr;
    }
 
    virtual void* userdataCreate(DispatchJobEvent&)
    {
        return nullptr;
    }
 
    virtual void userdataDestroy(void* /*userdata*/)
    {
    }
 
}; // class IExtension
 
class Walker final: public Yuni::NonCopyable<Walker>
{
public:
    Walker();
    explicit Walker(const AnyString& logprefix);
    ~Walker();
 
    void add(IExtension::Ptr extension);
 
    void directory(const AnyString& path);
 
    YString directory() const;
 
    void run();
 
    void retrieveStatistics(Statistics& out);
 
private:
    YString pDirectory;
    Statistics pStats;
    IExtension::Vector pExtensions;
    YString pLogPrefix;
 
}; // class Walker
 
} // namespace FSWalker
 
#endif // __ANTARES_FS_WALKER_FS_WALKER_H__