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

#ifndef WRAPPER_ASPELLCONFIG_HPP_
#define WRAPPER_ASPELLCONFIG_HPP_

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

#include <aspell.h>

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

namespace crawlservpp::Wrapper {

    /*
     * DECLARATION
     */


    class AspellConfig {
    public:

        AspellConfig();
        virtual ~AspellConfig();


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


        void setOption(const std::string& name, const std::string& value);


        void clear();



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


        MAIN_EXCEPTION_CLASS();

    private:
        // underlying pointer to the configuration
        ::AspellConfig * ptr{nullptr};
    };

    /*
     * IMPLEMENTATION
     */

    /*
     * CONSTRUCTION AND DESTRUCTION
     */

    inline AspellConfig::AspellConfig() {
        this->ptr = new_aspell_config();
    }


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

    /*
     * GETTERS
     */


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


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


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

    /*
     * SETTER
     */


    inline void AspellConfig::setOption(const std::string& name, const std::string& value) {
        if(this->ptr == nullptr) {
            throw Exception(
                    "AspellConfig::setOption():"
                    " The configuration is not valid"
            );
        }

        if(aspell_config_replace(this->ptr, name.c_str(), value.c_str()) == 0) {
            throw Exception(
                    "AspellConfig::setOption():"
                    " Aspell error #"
                    + std::to_string(aspell_config_error_number(this->ptr))
                    + ": "
                    + aspell_config_error_message(this->ptr)
            );
        }
    }

    /*
     * CLEANUP
     */

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

            this->ptr = nullptr;
        }
    }

    /*
     * COPY AND MOVE
     */


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


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


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

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

        return *this;
    }


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

            this->ptr = other.ptr;

            other.ptr = nullptr;
        }

        return *this;
    }

} /* namespace crawlservpp::Wrapper */

#endif /* WRAPPER_ASPELLCONFIG_HPP_ */