Strings.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                       SIMPLY POWERFUL TOOLKIT (SPTK)                         ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library is free software; you can redistribute it and/or modify it    │
│   under the terms of the GNU Library General Public License as published by  │
│   the Free Software Foundation; either version 2 of the License, or (at your │
│   option) any later version.                                                 │
│                                                                              │
│   This library 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 GNU Library   │
│   General Public License for more details.                                   │
│                                                                              │
│   You should have received a copy of the GNU Library General Public License  │
│   along with this library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <sptk5/String.h>
 
#ifdef _WIN32
#include <iterator>
#endif
 
namespace sptk {
 
class Exception;
 
class SP_EXPORT Strings
    : public std::vector<String>
{
public:
    enum class SortOrder : uint8_t
    {
        UNSORTED,
        ASCENDING,
        DESCENDING
    };
 
    enum class SplitMode : uint8_t
    {
        DELIMITER,
 
        ANYCHAR,
 
        REGEXP
 
    };
 
    Strings() = default;
 
    Strings(const Strings& other) = default;
 
    Strings(Strings&& other) = default;
 
    Strings(std::initializer_list<String> list)
    {
        std::copy(list.begin(), list.end(), back_inserter(*this));
    }
 
    Strings(const String& src, const char* delimiter, SplitMode mode = SplitMode::DELIMITER) noexcept;
 
    virtual ~Strings() = default;
 
    void fromString(const String& src, const char* delimiter, SplitMode mode);
 
    virtual int indexOf(const String& needle) const;
 
    void saveToFile(const fs::path& fileName) const;
 
    void loadFromFile(const fs::path& fileName);
 
    int64_t argument() const
    {
        return (int) m_userData;
    }
 
    void argument(int64_t d)
    {
        m_userData = d;
    }
 
    iterator remove(size_t i)
    {
        return StringVector::erase(begin() + i);
    }
 
    iterator remove(const String& str)
    {
        if (auto itor = std::find(begin(), end(), str); itor != end())
        {
            return StringVector::erase(itor);
        }
        return end();
    }
 
    Strings& operator=(const Strings& other) = default;
    Strings& operator=(Strings&& other) = default;
 
    String join(const String& delimiter) const;
 
    Strings grep(const String& pattern) const;
 
    void sort(bool ascending = true);
 
    void clear()
    {
        m_sorted = SortOrder::UNSORTED;
        StringVector::clear();
        m_userData = 0;
    }
 
    void resize(size_t size)
    {
        if (size > this->size())
        {
            m_sorted = SortOrder::UNSORTED;
        }
        StringVector::resize(size);
    }
 
    void push_back(const String& str)
    {
        m_sorted = SortOrder::UNSORTED;
        StringVector::push_back(str);
    }
 
    void push_back(String&& str)
    {
        m_sorted = SortOrder::UNSORTED;
        StringVector::push_back(std::move(str));
    }
 
    template<typename... Args>
    void emplace_back(Args&&... args)
    {
        m_sorted = SortOrder::UNSORTED;
        StringVector::emplace_back(args...);
    }
 
    String& operator[](size_t index)
    {
        m_sorted = SortOrder::UNSORTED;
        return StringVector::operator[](index);
    }
 
    const String& operator[](size_t index) const
    {
        return StringVector::operator[](index);
    }
 
private:
    using StringVector = std::vector<String>;
 
    int64_t m_userData {0};
 
    SortOrder m_sorted {SortOrder::UNSORTED};
};
 
} // namespace sptk