cleaner.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_LIBS_STUDY_CLEANER_H__
#define __ANTARES_LIBS_STUDY_CLEANER_H__
 
#include <yuni/yuni.h>
#include <yuni/core/bind.h>
#include <yuni/core/string.h>
 
#include <antares/paths/list.h>
 
#include "version.h"
 
namespace Antares::Data
{
class StudyCleaningInfos final
{
public:
 
 
    StudyCleaningInfos();
    explicit StudyCleaningInfos(const AnyString& path);
    ~StudyCleaningInfos();
 
    bool analyze();
 
    void performCleanup();
 
    uint64_t totalSize() const;
 
    void setCustomExcludeList(const Yuni::String& c);
 
public:
    Yuni::String folder;
 
    StudyVersion version;
    ::PathList intruders;
    ::PathList exclude;
    Yuni::String customExclude;
 
    /* This list mainly ensures that a list of folders will not deleted enven if empty */
    ::PathList postExclude;
 
    std::function<bool(uint)> onProgress;
 
}; // class StudyCleaningInfos
 
} // namespace Antares::Data
 
#endif /* __ANTARES_LIBS_STUDY_CLEANER_H__ */