RegularExpression.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/Strings.h>
#include <sptk5/sptk-config.h>
#include <sptk5/sptk.h>
 
#include <atomic>
#include <functional>
#include <memory>
#include <vector>
 
#ifdef HAVE_PCRE2
#define PCRE2_STATIC
#define PCRE2_CODE_UNIT_WIDTH 8
 
#include <pcre2.h>
 
#define SPRE_CASELESS PCRE2_CASELESS
#define SPRE_MULTILINE PCRE2_MULTILINE
#define SPRE_DOTALL PCRE2_DOTALL
#define SPRE_EXTENDED PCRE2_EXTENDED
using pcre_offset_t = long;
#endif
 
#ifdef HAVE_PCRE
 
#include <pcre.h>
 
#define SPRE_CASELESS PCRE_CASELESS
#define SPRE_MULTILINE PCRE_MULTILINE
#define SPRE_DOTALL PCRE_DOTALL
#define SPRE_EXTENDED PCRE_EXTENDED
using pcre_offset_t = int;
#endif
 
#if defined(HAVE_PCRE2) | defined(HAVE_PCRE)
 
namespace sptk {
 
class MatchData;
 
class SP_EXPORT RegularExpression
{
 
#ifdef HAVE_PCRE2
    using PCREHandle = pcre2_code;    
    using PCREExtraHandle = uint8_t*; 
#else
    using PCREHandle = pcre;            
    using PCREExtraHandle = pcre_extra; 
#endif
 
public:
    class SP_EXPORT Group
    {
    public:
        Group(String value, pcre_offset_t start, pcre_offset_t end)
            : value(move(value))
            , start(start)
            , end(end)
        {
        }
 
        Group() = default;
 
        String value;            
        pcre_offset_t start {0}; 
        pcre_offset_t end {0};   
    };
 
    class SP_EXPORT Groups
    {
        friend class RegularExpression;
 
    public:
        const Group& operator[](int index) const;
 
        const Group& operator[](const char* name) const;
 
        const std::vector<Group>& groups() const
        {
            return m_groups;
        }
 
        const std::map<String, Group>& namedGroups() const
        {
            return m_namedGroups;
        }
 
        bool empty() const
        {
            return m_groups.empty();
        }
 
        explicit operator bool() const
        {
            return !m_groups.empty();
        }
 
    protected:
        void grow(size_t groupCount);
 
        void add(Group&& group)
        {
            m_groups.push_back(std::move(group));
        }
 
        void add(const String& name, Group&& group)
        {
            m_namedGroups[name] = std::move(group);
        }
 
    private:
        void clear();
 
        std::vector<Group> m_groups;           
        std::map<String, Group> m_namedGroups; 
        static const Group emptyGroup;         
    };
 
    explicit RegularExpression(const String& pattern, const String& options = "");
 
    bool operator==(const String& text) const;
 
    bool operator!=(const String& text) const;
 
    bool matches(const String& text) const;
 
    Groups m(const String& text) const
    {
        size_t offset = 0;
        return m(text, offset);
    }
 
    Groups m(const String& text, size_t& offset) const;
 
    String s(const String& text, const String& outputPattern) const;
 
    String s(const String& text, const std::function<String(const String&)>& replace, bool& replaced) const;
 
    Strings split(const String& text) const;
 
    String replaceAll(const String& text, const String& outputPattern, bool& replaced) const;
 
    String replaceAll(const String& text, const std::map<String, String>& substitutions, bool& replaced) const;
 
    const String& pattern() const;
 
private:
    String m_pattern;      
    bool m_global {false}; 
    String m_error;        
 
    std::shared_ptr<PCREHandle> m_pcre;           
    std::shared_ptr<PCREExtraHandle> m_pcreExtra; 
 
    uint32_t m_options {0};    
    size_t m_captureCount {0}; 
 
    void compile();
 
    size_t nextMatch(const String& text, size_t& offset, MatchData& matchData) const;
 
    size_t getCaptureCount() const;
 
    size_t getNamedGroupCount() const;
 
    void getNameTable(const char*& nameTable, int& nameEntrySize) const;
 
    static size_t findNextPlaceholder(size_t pos, const String& outputPattern);
 
    void extractNamedMatches(const String& text, Groups& matchedStrings, const MatchData& matchData,
                             size_t matchCount) const;
};
 
using SRegularExpression = std::shared_ptr<RegularExpression>;
 
} // namespace sptk
 
#endif