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

#ifndef WRAPPER_ASPELLCHECKER_HPP_
#define WRAPPER_ASPELLCHECKER_HPP_

#include "AspellConfig.hpp"
#include "AspellList.hpp"

#include "../Main/Exception.hpp"

#include <aspell.h>

#include <string>   // std::string, std::to_string
#include <vector>   // std::vector

namespace crawlservpp::Wrapper {

    /*
     * DECLARATION
     */


    class AspellChecker {
    public:

        AspellChecker() = default;

        virtual ~AspellChecker();


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


        void create(AspellConfig& configuration);


        [[nodiscard]] bool check(
                const std::string& token,
                std::vector<std::string>& suggestionsTo
        );


        void clear();



        AspellChecker(AspellChecker&) = delete;

        AspellChecker& operator=(AspellChecker&) = delete;

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


        MAIN_EXCEPTION_CLASS();

    private:
        // underlying pointer to the spell checker
        AspellSpeller * ptr{nullptr};
    };

    /*
     * IMPLEMENTATION
     */

    /*
     * CONSTRUCTION AND DESTRUCTION
     */


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

    /*
     * GETTERS
     */


    inline AspellSpeller * AspellChecker::get() {
        return this->ptr;
    }


    inline const AspellSpeller * AspellChecker::getc() const {
        return this->ptr;
    }


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

    /*
     * CREATION
     */


    inline void AspellChecker::create(AspellConfig& configuration) {
        this->clear();

        if(!configuration.valid()) {
            throw Exception(
                    "AspellChecker::create():"
                    " The configuration is not valid"
            );
        }

        AspellCanHaveError * possibleError{
            new_aspell_speller(configuration.get())
        };
        const auto errorNumber{
            aspell_error_number(possibleError)
        };

        if(errorNumber != 0) {
            throw Exception(
                    "AspellChecker::create():"
                    " Aspell error #"
                    + std::to_string(errorNumber)
                    + ": "
                    + aspell_error_message(possibleError)
            );
        }

        this->ptr = to_aspell_speller(possibleError);
    }

    /*
     * SPELL CHECK
     */


    inline bool AspellChecker::check(
            const std::string& token,
            std::vector<std::string>& suggestionsTo
    ) {
        if(this->ptr == nullptr) {
            throw Exception(
                    "AspellChecker::check():"
                    " The spell checker is not valid"
            );
        }

        const auto result{
            aspell_speller_check(this->ptr, token.c_str(), token.size())
        };

        if(result < 0) {
            throw Exception(
                    "AspellChecker::check():"
                    " Aspell error #"
                    + std::to_string(aspell_speller_error_number(this->ptr))
                    + ": "
                    + aspell_speller_error_message(this->ptr)
            );
        }

        if(result > 0) {
            return true;
        }

        AspellList suggestions(aspell_speller_suggest(this->ptr, token.c_str(), token.size()));
        std::string suggestion;

        while(suggestions.next(suggestion)) {
            suggestionsTo.emplace_back(suggestion);
        }

        return false;
    }

    /*
     * CLEANUP
     */

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

            this->ptr = nullptr;
        }
    }

    /*
     * COPY AND MOVE
     */


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


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

            this->ptr = other.ptr;

            other.ptr = nullptr;
        }

        return *this;
    }

} /* namespace crawlservpp::Wrapper */

#endif /* WRAPPER_ASPELLCONFIG_HPP_ */