AspellList.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/>.
 *
 * ---
 *
 * AspellList.hpp
 *
 * RAII wrapper for pointer to aspell word lists.
 *  Does NOT have ownership of the pointer, but takes care of its deletion!
 *
 *  Created on: Feb 27, 2021
 *      Author: ans
 */

#ifndef WRAPPER_ASPELLLIST_HPP_
#define WRAPPER_ASPELLLIST_HPP_

#include <aspell.h>

#include <string>   // std::string

namespace crawlservpp::Wrapper {

    /*
     * DECLARATION
     */


    class AspellList {
    public:

        explicit AspellList(const AspellWordList * source);
        virtual ~AspellList();


        [[nodiscard]] bool valid() const;


        bool next(std::string& nextTo);


        void clear();



        AspellList(const AspellList& other);
        AspellList(AspellList&& other) noexcept;
        AspellList& operator=(const AspellList& other);
        AspellList& operator=(AspellList&& other) noexcept;


        MAIN_EXCEPTION_CLASS();

    private:
        // underlying pointer to the word list
        AspellStringEnumeration * ptr{nullptr};
    };

    /*
     * IMPLEMENTATION
     */

    /*
     * CONSTRUCTION AND DESTRUCTION
     */


    inline AspellList::AspellList(const AspellWordList * source) {
        if(source != nullptr) {
            this->ptr = aspell_word_list_elements(source);
        }
    }


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

    /*
     * GETTERS
     */


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

    /*
     * LIST ITERATION
     */


    inline bool AspellList::next(std::string& nextTo) {
        const auto * next{aspell_string_enumeration_next(this->ptr)};

        if(next == nullptr) {
            return false;
        }

        nextTo = std::string(next);

        return true;
    }

    /*
     * CLEANUP
     */

    inline void AspellList::clear() {
        if(this->ptr != nullptr) {
            delete_aspell_string_enumeration(this->ptr);

            this->ptr = nullptr;
        }
    }

    /*
     * COPY AND MOVE
     */


    inline AspellList::AspellList(const AspellList& other) {
        if(other.ptr != nullptr) {
            aspell_string_enumeration_assign(this->ptr, other.ptr);
        }
    }


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


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

            aspell_string_enumeration_assign(this->ptr, other.ptr);
        }

        return *this;
    }


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

            this->ptr = other.ptr;

            other.ptr = nullptr;
        }

        return *this;
    }

} /* namespace crawlservpp::Wrapper */

#endif /* WRAPPER_ASPELLLIST_HPP_ */