/*
    SPDX-FileCopyrightText: 2014 Vishesh Handa <me@vhanda.in>

    SPDX-License-Identifier: LGPL-2.1-or-later
*/

#ifndef KFILEMETADATA_EXTRACTOR_H
#define KFILEMETADATA_EXTRACTOR_H

#include "kfilemetadata_export.h"
#include <QStringList>
#include <QVariantMap>

#include <memory>

namespace KFileMetaData {

class ExtractionResult;
class ExtractorCollection;
class ExtractorPlugin;
class ExtractorPrivate;

/*!
 * \class KFileMetaData::Extractor
 * \inheaderfile KFileMetaData/Extractor
 * \inmodule KFileMetaData
 *
 * \brief The Extractor class is used to extract data from a file.
 */
class KFILEMETADATA_EXPORT Extractor
{
    /*!
     * \value AutoDeletePlugin
     * \value DoNotDeletePlugin
     */
    enum ExtractorPluginOwnership {
        AutoDeletePlugin,
        DoNotDeletePlugin,
    };

public:
    Extractor(Extractor&&);
    virtual ~Extractor() noexcept;

    /*!
     *
     */
    void extract(ExtractionResult* result);

    /*!
     *
     */
    QStringList mimetypes() const;

    /*!
     *
     */
    QVariantMap extractorProperties() const;

private:
    KFILEMETADATA_NO_EXPORT Extractor();

    Extractor(const Extractor&) = delete;
    void operator =(const Extractor&) = delete;

    KFILEMETADATA_NO_EXPORT void setExtractorPlugin(ExtractorPlugin *extractorPlugin);

    KFILEMETADATA_NO_EXPORT void setAutoDeletePlugin(ExtractorPluginOwnership autoDelete);

    KFILEMETADATA_NO_EXPORT void setMetaData(const QVariantMap &metaData);

    friend class ExtractorCollection;
    friend class ExtractorCollectionPrivate;
    friend class ExtractorPrivate;
    std::unique_ptr<ExtractorPrivate> d;
};
}

#endif // KFILEMETADATA_EXTRACTOR_H