LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
ipluginsmanager.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <memory>
33 #include <QStringList>
34 #include <QObjectList>
35 
37 using ILoadProgressReporter_ptr = std::shared_ptr<ILoadProgressReporter>;
38 
53 class Q_DECL_EXPORT IPluginsManager
54 {
55 public:
56  virtual ~IPluginsManager () {}
57 
62  virtual QObjectList GetAllPlugins () const = 0;
63 
73  template<typename T>
74  QObjectList Filter (const QObjectList& source) const
75  {
76  QObjectList result;
77  for (const auto sp : source)
78  if (qobject_cast<T> (sp))
79  result << sp;
80  return result;
81  }
82 
92  template<typename T>
93  QObjectList GetAllCastableRoots () const
94  {
95  return Filter<T> (GetAllPlugins ());
96  }
97 
109  template<typename T>
111  {
112  QList<T> result;
113  for (const auto root : GetAllCastableRoots<T> ())
114  result << qobject_cast<T> (root);
115  return result;
116  }
117 
126  virtual QObject* GetPluginByID (const QByteArray& id) const = 0;
127 
144  virtual QString GetPluginLibraryPath (const QObject* object) const = 0;
145 
157  virtual void InjectPlugin (QObject *object) = 0;
158 
174  virtual void ReleasePlugin (QObject *object) = 0;
175 
183  virtual QObject* GetQObject () = 0;
184 
192  virtual void OpenSettings (QObject *plugin) = 0;
193 
210  virtual ILoadProgressReporter_ptr CreateLoadProgressReporter (QObject *thisPlugin) = 0;
211 };
212 
213 Q_DECLARE_INTERFACE (IPluginsManager, "org.Deviant.LeechCraft.IPluginsManager/1.0")
QObjectList GetAllCastableRoots() const
This is the same as Filter<T> (GetAllPlugins()).
std::shared_ptr< ILoadProgressReporter > ILoadProgressReporter_ptr
This interface is used to represent LeechCraft&#39;s global plugin manager.
QList< T > GetAllCastableTo() const
Similar to GetAlLCastableRoots() and provided for convenience.
QObjectList Filter(const QObjectList &source) const
Filters the given list of plugins and returns only those that can be casted to the given template typ...
virtual ~IPluginsManager()
Interface for reporting progress of some long-running operation during load time. ...