CurlList.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/>.
 *
 * ---
 *
 * CurlList.hpp
 *
 * RAII wrapper for pointer to libcurl list.
 *  Does NOT have ownership of the pointer!
 *
 *  Created on: Feb 7, 2019
 *      Author: ans
 */

#ifndef WRAPPER_CURLLIST_HPP_
#define WRAPPER_CURLLIST_HPP_

#ifndef CRAWLSERVPP_TESTING

#include <curl/curl.h>

#else

#include "FakeCurl/FakeCurl.hpp"

#endif

#include <cstddef>      // std::size_t
#include <stdexcept>    // std::runtime_error
#include <string>       // std::string
#include <vector>       // std::vector

namespace crawlservpp::Wrapper {

    /*
     * DECLARATION
     */


    class CurlList {
    public:

        CurlList() = default;

        virtual ~CurlList();


        [[nodiscard]] curl_slist * get() noexcept;
        [[nodiscard]] const curl_slist * getc() const noexcept;
        [[nodiscard]] bool valid() const noexcept;
        [[nodiscard]] std::size_t size() const noexcept;
        [[nodiscard]] bool empty() const noexcept;


        void append(const CurlList& other);
        void append(const std::vector<std::string>& newElements);
        void append(const std::string& newElement);
        void clear() noexcept;



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


    private:
        curl_slist * ptr{nullptr};
    };

    /*
     * IMPLEMENTATION
     */

    /*
     * CONSTRUCTION AND DESTRUCTION
     */

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

    /*
     * GETTERS
     */


    inline curl_slist * CurlList::get() noexcept {
        return this->ptr;
    }


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


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


    inline std::size_t CurlList::size() const noexcept {
        std::size_t count{};
        const auto * element{this->ptr};

        while(element != nullptr) {
            if(element->data != nullptr) {
                ++count;
            }

            element = element->next;
        }

        return count;
    }


    inline bool CurlList::empty() const noexcept {
        const auto * element{this->ptr};

        while(element != nullptr) {
            if(element->data != nullptr) {
                return false;
            }
        }

        return true;
    }

    /*
     * MANIPULATION AND CLEANUP
     */


    inline void CurlList::append(const CurlList& other) {
        if(this == &other) {
            return;
        }

        auto * item = other.ptr;

        while(item != nullptr) {
            this->append(item->data);

            item = item->next;
        }
    }


    inline void CurlList::append(const std::vector<std::string>& newElements) {
        for(const auto& element : newElements) {
            this->append(element);
        }
    }


    inline void CurlList::append(const std::string& newElement) {
        auto * const temp{
            curl_slist_append(this->ptr, newElement.c_str())
        };

        if(temp == nullptr) {
            throw std::runtime_error("curl_slist_append() failed");
        }

        this->ptr = temp;
    }


    inline void CurlList::clear() noexcept {
        if(this->ptr != nullptr) {
            curl_slist_free_all(this->ptr);
        }

        this->ptr = nullptr;
    }

    /*
     * COPY AND MOVE
     */


    inline CurlList::CurlList(const CurlList& other) {
        this->append(other);
    }


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

            this->append(other);
        }

        return *this;
    }


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


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

            this->ptr = other.ptr;

            other.ptr = nullptr;
        }

        return *this;
    }

    } /* namespace crawlservpp::Wrapper */

#endif /* WRAPPER_CURLLIST_HPP_ */