pluginloaderbase.h

Go to the documentation of this file.

/*  -*- c++ -*-
    This file is part of libkdepim.

    Copyright (c) 2002,2004 Marc Mutz <mutz@kde.org>

    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 PLUGINLOADERBASE_H
#define PLUGINLOADERBASE_H

#include <QString>
#include <QMap>
#include <KLibrary>

class QStringList;

class PluginMetaData
{
  public:
    PluginMetaData() : loaded(false) {}
    PluginMetaData( const QString & lib, const QString & name,
                    const QString & comment )
      : library( lib ), nameLabel( name ),
        descriptionLabel( comment ), loaded( false ) {}
    QString library;
    QString nameLabel;
    QString descriptionLabel;
    bool loaded;
};

class PluginLoaderBase
{
  protected:
    PluginLoaderBase();
    virtual ~PluginLoaderBase();

  public:
    QStringList types() const;

    const PluginMetaData * infoForName( const QString & type ) const;

    virtual void scan() = 0;

  protected:
    void doScan( const char * path );

    KLibrary::void_function_ptr mainFunc( const QString & type, const char * main_func ) const;

  private:
    const KLibrary * openLibrary( const QString & libName ) const;
    mutable QMap< QString, PluginMetaData > mPluginMap;

    class Private;
    Private * d;
};

#endif // PLUGINLOADERBASE_H