PCREMatch.hpp

Go to the documentation of this file.

/*
 *
 * ---
 *
 *  Copyright (C) 2021 Anselm Schmidt (ans[ät]ohai.su)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version in addition to the terms of any
 *  licences already herein identified.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * ---
 *
 * PCREMatch.hpp
 *
 * RAII wrapper for pointer to Perl-Compatible Regular Expression match.
 *  Does NOT have ownership of the pointer, but takes care of its deletion!
 *
 *  Created on: Feb 7, 2019
 *      Author: ans
 */

#ifndef WRAPPER_PCREMATCH_HPP_
#define WRAPPER_PCREMATCH_HPP_

#include <pcre2.h>

namespace crawlservpp::Wrapper {

    /*
     * DECLARATION
     */


    class PCREMatch {
    public:

        explicit PCREMatch(pcre2_match_data * setPtr) noexcept;
        virtual ~PCREMatch();


        [[nodiscard]] pcre2_match_data * get() noexcept;
        [[nodiscard]] const pcre2_match_data * getc() const noexcept;
        [[nodiscard]] bool valid() const noexcept;


        void clear() noexcept;



        PCREMatch(PCREMatch&) = delete;

        PCREMatch& operator=(PCREMatch&) = delete;

        PCREMatch(PCREMatch&& other) noexcept;
        PCREMatch& operator=(PCREMatch&& other) noexcept;


    private:
        // underlying pointer to regular expression match
        pcre2_match_data * ptr{nullptr};
    };

    /*
     * IMPLEMENTATION
     */

    /*
     * CONSTRUCTION AND DESTRUCTION
     */


    inline PCREMatch::PCREMatch(pcre2_match_data * setPtr) noexcept : ptr(setPtr) {}

    inline PCREMatch::~PCREMatch() {
        this->clear();
    }

    /*
     * GETTERS
     */


    inline pcre2_match_data * PCREMatch::get() noexcept {
        return this->ptr;
    }


    inline const pcre2_match_data * PCREMatch::getc() const noexcept {
        return this->ptr;
    }


    inline bool PCREMatch::valid() const noexcept {
        return this->ptr != nullptr;
    }

    /*
     * CLEANUP
     */

    inline void PCREMatch::clear() noexcept {
        if(this->ptr != nullptr) {
            pcre2_match_data_free(this->ptr);

            this->ptr = nullptr;
        }
    }

    /*
     * COPY AND MOVE
     */


    inline PCREMatch::PCREMatch(PCREMatch&& other) noexcept : ptr(other.ptr) {
        other.ptr = nullptr;
    }


    inline PCREMatch& PCREMatch::operator=(PCREMatch&& other) noexcept {
        if(&other != this) {
            this->clear();

            this->ptr = other.ptr;

            other.ptr = nullptr;
        }

        return *this;
    }

} /* namespace crawlservpp::Wrapper */

#endif /* WRAPPER_PCREMATCH_HPP_ */