File indexing completed on 2024-05-05 16:09:02

 /*
     SPDX-FileCopyrightText: 2013 Vishesh Handa <me@vhanda.in>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #ifndef _KFILEMETADATA_EXTRACTIONRESULT_H
 #define _KFILEMETADATA_EXTRACTIONRESULT_H
 
 #include <QString>
 #include <QVariant>
 
 #include <memory>
 
 #include "kfilemetadata_export.h"
 #include "embeddedimagedata.h"
 #include "properties.h"
 #include "types.h"
 
 namespace KFileMetaData {
 class ExtractionResultPrivate;
 /**
  * \class ExtractionResult extractionresult.h <KFileMetaData/ExtractionResult>
  *
  * \brief The ExtractionResult class is where all the data extracted by
  * the indexer is saved. This class acts as a base class which should be
  * derived from and then passed to the relevant plugins.
  *
  * The derived class needs to implement 3 pure virtual functions through
  * which it receives the extracted data.
  *
  * \author Vishesh Handa <me@vhanda.in>
  */
 class KFILEMETADATA_EXPORT ExtractionResult
 {
 public:
     /**
      * @see Flags
      */
     enum Flag {
         ExtractNothing = 0,
         ExtractMetaData = 1,
         ExtractPlainText = 2,
         ExtractImageData = 4, ///< @since 5.76
 #if KFILEMETADATA_ENABLE_DEPRECATED_SINCE(5, 76)
     /// @deprecated since 5.76, specify explicitly
         ExtractEverything KFILEMETADATA_ENUMERATOR_DEPRECATED_VERSION_BELATED(5, 82, 5, 76, "Specify flags explicitly") = (ExtractMetaData | ExtractPlainText)
 #endif
     };
     /**
      * Stores a combination of #Flag values.
      */
     Q_DECLARE_FLAGS(Flags, Flag)
 
     /**
      * Create an ExtractionResult which can be passed be to Extractors. The
      * extractors use the \p url, \p mimetype and \p flags in order to determine
      * which file the data should be extracted from and which data should
      * be extracted.
      */
     ExtractionResult(const QString& url, const QString& mimetype = QString(), const Flags& flags = Flags{ExtractPlainText | ExtractMetaData});
     ExtractionResult(const ExtractionResult& rhs);
     virtual ~ExtractionResult();
 
     /**
      * The input url which the plugins will use to locate the file
      */
     QString inputUrl() const;
 
     /**
      * The input mimetype. This mimetype should correspond with the
      * mimetypes supported with the relevant plugin when it is being
      * passed to the Extractor, or be a subtype thereof.
      *
      * \sa ExtractorCollection::fetchExtractors
      * \sa ExtractorPlugin::supportedMimeType
      */
     QString inputMimetype() const;
 
     /**
      * The flags which the extraction plugin should considering following
      * when extracting metadata from the file
      */
     Flags inputFlags() const;
 
     /**
      * This function is called by plugins when they wish for some plain
      * text to be indexed without any property. This generally corresponds
      * to the text content in a file
      */
     virtual void append(const QString& text) = 0;
 
     /**
      * This function is called by the plugins when they wish to
      * add a key value pair which should be indexed. This function may be
      * called multiple times for the same key.
      *
      * \p property This specifies a property name. It should be one of the
      *             properties from the global list of properties.
      *
      * \p value The value of the property
      */
     virtual void add(Property::Property property, const QVariant& value) = 0;
 
     /**
      * This function is called by the plugins.
      * A type is a higher level classification of the file. A file can
      * have multiple types, but mostly when it does, those types are related.
      * Eg - Document and Presentation.
      *
      * Please choose one type from the list of available types
      */
     virtual void addType(Type::Type type) = 0;
 
     /**
      * This function is called by the plugins.
      *
      * \p images The images to add
      * \sa EmbeddedImageData
      * @since 5.76
      */
     void addImageData(QMap<EmbeddedImageData::ImageType, QByteArray>&& images);
 
     /**
      * Return embedded image data
      *
      * \sa Flags::ExtractImageData
      * @since 5.76
      */
     QMap<EmbeddedImageData::ImageType, QByteArray> imageData() const;
 
 private:
     const std::unique_ptr<ExtractionResultPrivate> d;
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(ExtractionResult::Flags)
 
 }
 
 #endif // _KFILEMETADATA_EXTRACTIONRESULT_H