ISkipRule.h

/*
 * Copyright 2023-2025 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/conversion_rules/MatchMode.h>
#include <quentier/utility/Printable.h>

#include <QtGlobal>

namespace quentier::enml::conversion_rules {

class ISkipRule : public utility::Printable
{
public:
    ~ISkipRule() override;

    enum class Target
    {
        Element,
        AttibuteName,
        AttributeValue
    };

    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, Target target);

    friend QUENTIER_EXPORT QDebug & operator<<(QDebug & dbg, Target target);

    [[nodiscard]] virtual Target target() const = 0;

    [[nodiscard]] virtual QString value() const = 0;

    [[nodiscard]] virtual MatchMode matchMode() const = 0;

    [[nodiscard]] virtual bool includeContents() const = 0;

    [[nodiscard]] virtual Qt::CaseSensitivity caseSensitivity() const = 0;

public: // utility::Printable
    QTextStream & print(QTextStream & strm) const override;
};

} // namespace quentier::enml::conversion_rules