LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
iscriptloader.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2013 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 #ifndef INTERFACES_ISCRIPTLOADER_H
31 #define INTERFACES_ISCRIPTLOADER_H
32 #include <memory>
33 #include <QVariant>
34 
40 class Q_DECL_EXPORT IScript
41 {
42 public:
43  virtual ~IScript () {}
44 
58  virtual QVariant InvokeMethod (const QString& name,
59  const QVariantList& args) const = 0;
60 };
61 
62 typedef std::shared_ptr<IScript> IScript_ptr;
63 
96 class Q_DECL_EXPORT IScriptLoaderInstance
97 {
98 public:
99  virtual ~IScriptLoaderInstance () {}
100 
105  virtual QObject* GetQObject () = 0;
106 
113  virtual void AddGlobalPrefix () = 0;
114 
119  virtual void AddLocalPrefix (QString prefix = QString ()) = 0;
120 
129  virtual QStringList EnumerateScripts () const = 0;
130 
133  virtual QVariantMap GetScriptInfo (const QString& script) = 0;
134 
151  virtual IScript_ptr LoadScript (const QString& script) = 0;
152 };
153 
167 class Q_DECL_EXPORT IScriptLoader
168 {
169 public:
170  virtual ~IScriptLoader () {}
171 
187  virtual IScriptLoaderInstance* CreateScriptLoaderInstance (const QString& relPath) = 0;
188 };
189 
190 Q_DECLARE_INTERFACE (IScript, "org.Deviant.LeechCraft.IScript/1.0");
191 Q_DECLARE_INTERFACE (IScriptLoaderInstance, "org.Deviant.LeechCraft.IScriptLoaderInstance/1.0");
192 Q_DECLARE_INTERFACE (IScriptLoader, "org.Deviant.LeechCraft.IScriptLoader/1.0");
193 
194 #endif
Interface for plugins providing scripting.
virtual ~IScript()
Definition: iscriptloader.h:43
Q_DECLARE_INTERFACE(IColorThemeManager,"org.Deviant.LeechCraft.IColorThemeManager/1.0")
Interface for script loaders.
Definition: iscriptloader.h:96
std::shared_ptr< IScript > IScript_ptr
Definition: iscriptloader.h:62
virtual ~IScriptLoader()
Interface for objects representing scripts.
Definition: iscriptloader.h:40
virtual ~IScriptLoaderInstance()
Definition: iscriptloader.h:99