/***************************************************************************
                             qgslayermetadatavalidator.h
                             ---------------------------
    begin                : April 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSLAYERMETADATAVALIDATOR_H
#define QGSLAYERMETADATAVALIDATOR_H

#include "qgis_core.h"
#include "qgis_sip.h"

#include <QString>
#include <QVariant>

class QgsAbstractMetadataBase;
class QgsLayerMetadata;

/**
 * \ingroup core
 * \class QgsAbstractMetadataBaseValidator
 * \brief Abstract base class for metadata validators.
 */

class CORE_EXPORT QgsAbstractMetadataBaseValidator
{
  public:
    /**
     * \ingroup core
     * \brief Contains the parameters describing a metadata validation failure.
     */
    class ValidationResult
    {
      public:
        /**
         * Constructor for ValidationResult.
         */
        ValidationResult( const QString &section, const QString &note, const QVariant &identifier = QVariant() )
          : section( section )
          , note( note )
          , mIdentifier( identifier )
        {}

        //! Metadata section which failed the validation
        QString section;

        // TODO QGIS 5.0 - remove compatibility code

        /**
         * Returns the optional identifier for the failed metadata item.
         * For instance, in list type metadata elements this
         * will be set to the list index of the failed metadata
         * item.
         */
        QVariant identifier() const SIP_PYNAME( _identifier ) { return mIdentifier; }

        /**
         * Sets the optional \a identifier for the failed metadata item.
         * For instance, in list type metadata elements this
         * will be set to the list index of the failed metadata
         * item.
         */
        void setIdentifier( const QVariant &identifier ) { mIdentifier = identifier; }

        //! The reason behind the validation failure.
        QString note;

      private:
        QVariant mIdentifier;
    };

    virtual ~QgsAbstractMetadataBaseValidator() = default;

    /**
     * Validates a \a metadata object, and returns TRUE if the
     * metadata is considered valid.
     * If validation fails, the \a results list will be filled with a list of
     * items describing why the validation failed and what needs to be rectified
     * to fix the metadata.
     */
    virtual bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const = 0;
};

/**
 * \ingroup core
 * \class QgsNativeMetadataBaseValidator
 * \brief A validator for the native base QGIS metadata schema definition.
 * \since QGIS 3.2
 */

class CORE_EXPORT QgsNativeMetadataBaseValidator : public QgsAbstractMetadataBaseValidator
{
  public:
    QgsNativeMetadataBaseValidator() = default;

    bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const override;
};


/**
 * \ingroup core
 * \class QgsNativeMetadataValidator
 * \brief A validator for the native QGIS layer metadata schema definition.
 */

class CORE_EXPORT QgsNativeMetadataValidator : public QgsNativeMetadataBaseValidator
{
  public:
    QgsNativeMetadataValidator() = default;

    bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const override;
};

/**
 * \ingroup core
 * \class QgsNativeProjectMetadataValidator
 * \brief A validator for the native QGIS project metadata schema definition.
 * \since QGIS 3.2
 */

class CORE_EXPORT QgsNativeProjectMetadataValidator : public QgsNativeMetadataBaseValidator
{
  public:
    QgsNativeProjectMetadataValidator() = default;

    bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const override;
};

#endif // QGSLAYERMETADATAVALIDATOR_H
