extractorplugin.h

Go to the documentation of this file.

/*
    <one line to give the library's name and an idea of what it does.>
    Copyright (C) 2012  Vishesh Handa <me@vhanda.in>

    This library 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; either
    version 2.1 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
    Lesser General Public License for more details.

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


#ifndef EXTRACTOR_H
#define EXTRACTOR_H

#include <QtCore/QStringList>
#include <QtCore/QDateTime>

#include "simpleresourcegraph.h"
#include "simpleresource.h"
#include "nepomuk_export.h"

#include <KService>

#ifndef NEPOMUK_EXTRACTOR_EXPORT
# if defined(KDELIBS_STATIC_LIBS)
   /* No export/import for static libraries */
#  define NEPOMUK_EXTRACTOR_EXPORT
# elif defined(MAKE_NEPOMUKEXTRACTOR_LIB)
   /* We are building this library */
#  define NEPOMUK_EXTRACTOR_EXPORT KDE_EXPORT
# else
   /* We are using this library */
#  define NEPOMUK_EXTRACTOR_EXPORT KDE_IMPORT
# endif
#endif

namespace Nepomuk2 {

    class NEPOMUK_EXTRACTOR_EXPORT ExtractorPlugin : public QObject
    {
        Q_OBJECT
    public:
        ExtractorPlugin(QObject* parent);
        virtual ~ExtractorPlugin();

        enum ExtractingCritera {
            BasicMimeType = 1,

            Custom = 2
        };

        virtual ExtractingCritera criteria();

        virtual bool shouldExtract(const QUrl& url, const QString& mimeType);

        virtual QStringList mimetypes();

        virtual SimpleResourceGraph extract(const QUrl& resUri, const QUrl& fileUrl, const QString& mimeType) = 0;

        //
        // Helper functions
        //

        static QDateTime dateTimeFromString(const QString& dateString);

        static QList<SimpleResource> contactsFromString(const QString& string);

        static int maxPlainTextSize();

        static void setMaxPlainTextSize(int size);
        static void resetMaxPlainTextSize();

    private:
        static int s_plainTextSize;
    };
}

#define NEPOMUK_EXPORT_EXTRACTOR( classname, libname )    \
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
K_EXPORT_PLUGIN(factory(#libname))

#endif // EXTRACTOR_H