IConverter.h

/*
 * Copyright 2023-2024 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/enml/Fwd.h>
#include <quentier/enml/conversion_rules/Fwd.h>
#include <quentier/types/ErrorString.h>
#include <quentier/types/Result.h>
#include <quentier/utility/Linkage.h>

#include <QList>
#include <QStringList>
#include <QTextDocument>

#include <qevercloud/types/Note.h>

namespace quentier::enml {

class QUENTIER_EXPORT IConverter
{
public:
    virtual ~IConverter();

    [[nodiscard]] virtual Result<QString, ErrorString> convertHtmlToEnml(
        const QString & html, IDecryptedTextCache & decryptedTextCache,
        const QList<conversion_rules::ISkipRulePtr> & skipRules = {}) const = 0;

    [[nodiscard]] virtual Result<void, ErrorString> convertHtmlToDoc(
        const QString & html, QTextDocument & doc,
        const QList<conversion_rules::ISkipRulePtr> & skipRules = {}) const = 0;

    [[nodiscard]] virtual Result<QString, ErrorString> convertHtmlToXml(
        const QString & html) const = 0;

    [[nodiscard]] virtual Result<QString, ErrorString> convertHtmlToXhtml(
        const QString & html) const = 0;

    [[nodiscard]] virtual Result<IHtmlDataPtr, ErrorString> convertEnmlToHtml(
        const QString & enml,
        IDecryptedTextCache & decryptedTextCache) const = 0;

    [[nodiscard]] virtual Result<QString, ErrorString> convertEnmlToPlainText(
        const QString & enml) const = 0;

    [[nodiscard]] virtual Result<QStringList, ErrorString>
        convertEnmlToWordsList(const QString & enml) const = 0;

    [[nodiscard]] virtual QStringList convertPlainTextToWordsList(
        const QString & plainText) const = 0;

    [[nodiscard]] virtual Result<void, ErrorString> validateEnml(
        const QString & enml) const = 0;

    [[nodiscard]] virtual Result<QString, ErrorString> validateAndFixupEnml(
        const QString & enml) const = 0;

    enum class EnexExportTags
    {
        Yes = 0,
        No
    };

    [[nodiscard]] virtual Result<QString, ErrorString> exportNotesToEnex(
        const QList<qevercloud::Note> & notes,
        const QHash<QString, QString> & tagNamesByTagLocalIds,
        EnexExportTags exportTagsOption,
        const QString & version = {}) const = 0;

    [[nodiscard]] virtual Result<QList<qevercloud::Note>, ErrorString>
        importEnex(const QString & enex) const = 0;
};

} // namespace quentier::enml