extractorengine.h

/*
   Copyright (c) 2017 Volker Krause <[email protected]>

   This library is free software; you can redistribute it and/or modify it
   under the terms of the GNU Library General Public License as published by
   the Free Software Foundation; either version 2 of the License, or (at your
   option) any later version.

   This library 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 Library General Public
   License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to the
   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.
*/

#ifndef EXTRACTORENGINE_H
#define EXTRACTORENGINE_H

#include "kitinerary_export.h"
#include "extractorinput.h"

#include <QString>

#include <memory>
#include <vector>

template <typename T> class QSharedPointer;

namespace KCalendarCore {
class Calendar;
}

namespace KPkPass {
class Pass;
}

namespace KMime {
class Content;
}

class QByteArray;
class QDateTime;
class QJsonArray;

namespace KItinerary {

class Extractor;
class ExtractorEnginePrivate;
class HtmlDocument;
class PdfDocument;

class KITINERARY_EXPORT ExtractorEngine
{
public:
    ExtractorEngine();
    ~ExtractorEngine();
    ExtractorEngine(ExtractorEngine &&) noexcept;
    ExtractorEngine(const ExtractorEngine &) = delete;

    void clear();

    void setText(const QString &text);
    void setHtmlDocument(HtmlDocument *htmlDoc);
    void setPdfDocument(PdfDocument *pdfDoc);
    void setPass(KPkPass::Pass *pass);
    void setCalendar(const QSharedPointer<KCalendarCore::Calendar> &calendar);

    void setContent(KMime::Content *content);
    void setData(const QByteArray &data, const QString &fileName = {});

    void setData(const QByteArray &data, ExtractorInput::Type type);

    void setContext(KMime::Content *context);

    void setContextDate(const QDateTime &dt);

    void setUseSeparateProcess(bool separateProcess);

    void setAdditionalExtractors(std::vector<Extractor> &&extractors);

    QJsonArray extract();

    QString usedCustomExtractor() const;

private:
    std::unique_ptr<ExtractorEnginePrivate> d;
};

}

#endif // EXTRACTORENGINE_H