HTML.hpp

Go to the documentation of this file.

/*
 *
 * ---
 *
 *  Copyright (C) 2020 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/>.
 *
 * ---
 *
 * HTML.hpp
 *
 * Parse HTML, tidy it up and convert it to %XML using tidy5-html.
 *
 *  Created on: Feb 1, 2019
 *      Author: ans
 */

#ifndef PARSING_HTML_HPP_
#define PARSING_HTML_HPP_

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

#include <queue>        // std::queue
#include <string>       // std::string
#include <string_view>  // std::string_view

namespace crawlservpp::Parsing {

    /*
     * CONSTANTS
     */


    inline constexpr std::string_view tidyEncoding{"utf8"};


    /*
     * DECLARATION
     */


    class HTML {
    private:
        // for convenience
        using TidyDoc = Wrapper::TidyDoc;

    public:

        HTML() = default;

        virtual ~HTML() = default;


        void tidyAndConvert(
                std::string& inOut,
                bool warnings,
                ulong numOfErrors,
                std::queue<std::string>& warningsTo
        );



        MAIN_EXCEPTION_CLASS();


        HTML(HTML&) = delete;

        HTML(HTML&&) = delete;

        HTML& operator=(HTML&) = delete;

        HTML& operator=(HTML&&) = delete;


    private:
        TidyDoc doc;
    };

    /*
     * IMPLEMENTATION
     */


    inline void HTML::tidyAndConvert(
            std::string& inOut,
            bool warnings,
            ulong numOfErrors,
            std::queue<std::string>& warningsTo
    ) {
        // set options
        try {
            this->doc.setOption(TidyXmlOut, true);
            this->doc.setOption(TidyQuiet, true);
            this->doc.setOption(TidyNumEntities, true);
            this->doc.setOption(TidyMark, false);
            this->doc.setOption(TidyShowWarnings, warnings);
            this->doc.setOption(TidyForceOutput, true);
            this->doc.setOption(TidyDropEmptyElems, false);
            this->doc.setOption(TidyShowErrors, numOfErrors);
            this->doc.setOption(TidyOutCharEncoding, std::string(tidyEncoding));

            this->doc.parse(inOut, warningsTo);
            this->doc.cleanAndRepair(warningsTo);

            const auto output(this->doc.getOutput(warningsTo));

            if(output.empty()) {
                return;
            }

            inOut = output;
        }
        catch(const TidyDoc::Exception& e) {
            // re-throw as HTML::Exception
            throw HTML::Exception(e.what());
        }
    }

} /* namespace crawlservpp::Parsing */

#endif /* PARSING_HTML_HPP_ */