mirror of
https://bitbucket.org/librepilot/librepilot.git
synced 2025-02-07 22:54:14 +01:00
37a66b2340
git-svn-id: svn://svn.openpilot.org/OpenPilot/trunk@281 ebee16cc-31ac-478f-84a7-5cbb03baadba
117 lines
3.2 KiB
C++
117 lines
3.2 KiB
C++
/**
|
|
******************************************************************************
|
|
*
|
|
* @file pluginspec.h
|
|
* @author The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
|
|
* Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
|
|
* @brief
|
|
* @see The GNU Public License (GPL) Version 3
|
|
* @defgroup
|
|
* @{
|
|
*
|
|
*****************************************************************************/
|
|
/*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License
|
|
* for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*/
|
|
|
|
#ifndef PLUGINSPEC_H
|
|
#define PLUGINSPEC_H
|
|
|
|
#include "extensionsystem_global.h"
|
|
|
|
#include <QtCore/QString>
|
|
#include <QtCore/QList>
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
class QStringList;
|
|
QT_END_NAMESPACE
|
|
|
|
namespace ExtensionSystem {
|
|
|
|
namespace Internal {
|
|
class PluginSpecPrivate;
|
|
class PluginManagerPrivate;
|
|
}
|
|
|
|
class IPlugin;
|
|
|
|
struct EXTENSIONSYSTEM_EXPORT PluginDependency
|
|
{
|
|
QString name;
|
|
QString version;
|
|
bool operator==(const PluginDependency &other);
|
|
};
|
|
|
|
struct EXTENSIONSYSTEM_EXPORT PluginArgumentDescription
|
|
{
|
|
QString name;
|
|
QString parameter;
|
|
QString description;
|
|
};
|
|
|
|
class EXTENSIONSYSTEM_EXPORT PluginSpec
|
|
{
|
|
public:
|
|
enum State { Invalid, Read, Resolved, Loaded, Initialized, Running, Stopped, Deleted};
|
|
|
|
~PluginSpec();
|
|
|
|
// information from the xml file, valid after 'Read' state is reached
|
|
QString name() const;
|
|
QString version() const;
|
|
QString compatVersion() const;
|
|
QString vendor() const;
|
|
QString copyright() const;
|
|
QString license() const;
|
|
QString description() const;
|
|
QString url() const;
|
|
QList<PluginDependency> dependencies() const;
|
|
|
|
typedef QList<PluginArgumentDescription> PluginArgumentDescriptions;
|
|
PluginArgumentDescriptions argumentDescriptions() const;
|
|
|
|
// other information, valid after 'Read' state is reached
|
|
QString location() const;
|
|
QString filePath() const;
|
|
|
|
QStringList arguments() const;
|
|
void setArguments(const QStringList &arguments);
|
|
void addArgument(const QString &argument);
|
|
|
|
bool provides(const QString &pluginName, const QString &version) const;
|
|
|
|
// dependency specs, valid after 'Resolved' state is reached
|
|
QList<PluginSpec *> dependencySpecs() const;
|
|
|
|
// linked plugin instance, valid after 'Loaded' state is reached
|
|
IPlugin *plugin() const;
|
|
|
|
// state
|
|
State state() const;
|
|
bool hasError() const;
|
|
QString errorString() const;
|
|
|
|
private:
|
|
PluginSpec();
|
|
|
|
Internal::PluginSpecPrivate *d;
|
|
friend class Internal::PluginManagerPrivate;
|
|
};
|
|
|
|
} // namespace ExtensionSystem
|
|
|
|
#endif // PLUGINSPEC_H
|
|
|