list.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_PATHS_LIST_H__
#define __ANTARES_LIBS_PATHS_LIST_H__
 
#include <cstdio>
#include <map>
 
#include <yuni/yuni.h>
#include <yuni/core/bind.h>
#include <yuni/core/string.h>
 
enum PathListOption
{
    pathListOptNotFound = -1,
 
    pathListOptNone = 0,
    pathListOptMustExist = 1,
    pathListOptFolder = 2,
};
 
class PathList final
{
public:
    struct FileInfo
    {
        size_t size;
        enum PathListOption options;
    };
 
    using ItemList = std::map<Yuni::Clob, FileInfo>;
 
    using iterator = ItemList::iterator;
    using const_iterator = ItemList::const_iterator;
 
public:
    PathList()
    {
    }
 
    ~PathList()
    {
    }
 
    iterator begin()
    {
        return item.begin();
    }
 
    const_iterator begin() const
    {
        return item.begin();
    }
 
    iterator end()
    {
        return item.end();
    }
 
    const_iterator end() const
    {
        return item.end();
    }
 
    void clear();
 
    template<class StringT>
    void add(const StringT& s)
    {
        add(s, pathListOptNone);
    }
 
    template<class StringT>
    void add(const StringT& s, size_t size)
    {
        add(s, pathListOptNone, size);
    }
 
    template<class StringT>
    void add(const StringT& s, const PathListOption opt)
    {
        internalPrepare(s);
        if (item.find(pTmp) == item.end())
        {
            FileInfo& info = item[pTmp];
            info.options = opt;
            info.size = 0;
        }
    }
 
    template<class StringT>
    void add(const StringT& s, const PathListOption opt, size_t size)
    {
        internalPrepare(s);
        if (item.find(pTmp) == item.end())
        {
            FileInfo& info = item[pTmp];
            info.options = opt;
            info.size = size;
        }
    }
 
    template<class StringT>
    void addFromFolder(const StringT& folder, const PathList& exclude)
    {
        Yuni::Clob s;
        s = folder;
        internalAddFromFolder(s, exclude);
    }
 
    template<class StringT>
    PathListOption find(const StringT& s) const
    {
        internalPrepare(s);
        ItemList::const_iterator i = item.find(pTmp);
        return ((i != item.end()) ? i->second.options : pathListOptNotFound);
    }
 
    template<class StringT>
    void remove(const StringT& s)
    {
        if (!item.empty())
        {
            internalPrepare(s);
            ItemList::iterator i = item.find(pTmp);
            if (i != item.end())
            {
                item.erase(i);
            }
        }
    }
 
    void remove(const PathList& toDelete)
    {
        if (item.empty() || toDelete.empty())
        {
            return;
        }
        const ItemList::const_iterator end = toDelete.item.end();
        for (ItemList::const_iterator i = toDelete.item.begin(); i != end; ++i)
        {
            this->remove(i->first);
        }
    }
 
    uint size() const
    {
        return (uint)item.size();
    }
 
    bool empty() const
    {
        return item.empty();
    }
 
    size_t totalSizeInBytes() const;
 
    template<class StringT>
    uint deleteAllEmptyFolders(const StringT& sourceFolder)
    {
        if (item.empty())
        {
            return 0;
        }
        pTmp = sourceFolder;
        return internalDeleteAllEmptyFolders();
    }
 
    template<class StringT>
    uint deleteAllFiles(const StringT& sourceFolder)
    {
        if (item.empty())
        {
            return 0;
        }
        pTmp = sourceFolder;
        return internalDeleteAllFiles();
    }
 
public:
    std::function<bool(uint)> onProgress;
 
private:
    template<class StringT>
    void internalPrepare(const StringT& s) const
    {
        pTmp = s;
        for (uint i = 0; i != pTmp.size(); ++i)
        {
#ifdef YUNI_OS_WINDOWS
            if (pTmp[i] == '/')
            {
                pTmp[i] = '\\';
            }
#else
            if (pTmp[i] == '\\')
            {
                pTmp[i] = '/';
            }
#endif
        }
    }
 
    size_t internalSizeOnDisk() const;
    uint internalDeleteAllEmptyFolders();
    uint internalDeleteAllFiles();
    void internalAddFromFolder(const Yuni::Clob& folder, const PathList& exclude);
 
private:
    ItemList item;
    mutable Yuni::Clob pTmp;
 
}; /* struct PathList */
 
#endif /* __ANTARES_LIBS_PATHS_LIST_H__ */