tibia-client/src/framework/core/module.h

87 lines
3.0 KiB
C
Raw Normal View History

2011-08-28 15:17:58 +02:00
/*
* Copyright (c) 2010-2013 OTClient <https://github.com/edubart/otclient>
2011-08-28 15:17:58 +02:00
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
2011-08-14 04:09:11 +02:00
#ifndef MODULE_H
#define MODULE_H
2011-08-15 16:06:15 +02:00
#include "declarations.h"
2011-08-14 04:09:11 +02:00
2011-08-15 16:06:15 +02:00
#include <framework/otml/declarations.h>
#include <framework/luaengine/luaobject.h>
2011-08-14 04:09:11 +02:00
2012-06-22 05:14:13 +02:00
// @bindclass
2012-02-06 02:44:47 +01:00
class Module : public LuaObject
2011-08-14 04:09:11 +02:00
{
public:
Module(const std::string& name);
2011-08-14 04:09:11 +02:00
bool load();
void unload();
2012-02-06 20:19:47 +01:00
bool reload();
2011-08-14 04:09:11 +02:00
bool canUnload() { return m_loaded && m_reloadable && !isDependent(); }
bool canReload() { return m_reloadable && !isDependent(); }
bool isLoaded() { return m_loaded; }
bool isReloadable() { return m_reloadable; }
2012-02-06 20:19:47 +01:00
bool isDependent();
2012-07-24 02:22:38 +02:00
bool isSandboxed() { return m_sandboxed; }
2013-01-26 17:54:19 +01:00
bool hasDependency(const std::string& name, bool recursive = false);
2012-07-24 02:22:38 +02:00
int getSandbox(LuaInterface *lua);
std::string getDescription() { return m_description; }
std::string getName() { return m_name; }
std::string getAuthor() { return m_author; }
std::string getWebsite() { return m_website; }
std::string getVersion() { return m_version; }
bool isAutoLoad() { return m_autoLoad; }
int getAutoLoadPriority() { return m_autoLoadPriority; }
2011-08-14 04:09:11 +02:00
2012-06-22 05:14:13 +02:00
// @dontbind
ModulePtr asModule() { return static_self_cast<Module>(); }
2012-02-06 20:19:47 +01:00
2012-02-06 02:44:47 +01:00
protected:
void discover(const OTMLNodePtr& moduleNode);
friend class ModuleManager;
2011-08-14 04:09:11 +02:00
private:
stdext::boolean<false> m_loaded;
stdext::boolean<false> m_autoLoad;
stdext::boolean<false> m_reloadable;
stdext::boolean<false> m_sandboxed;
int m_autoLoadPriority;
int m_sandboxEnv;
std::tuple<std::string, std::string> m_onLoadFunc;
std::tuple<std::string, std::string> m_onUnloadFunc;
2011-08-14 04:09:11 +02:00
std::string m_name;
std::string m_description;
std::string m_author;
std::string m_website;
std::string m_version;
std::function<void()> m_loadCallback;
std::function<void()> m_unloadCallback;
2011-08-14 04:09:11 +02:00
std::list<std::string> m_dependencies;
std::list<std::string> m_scripts;
std::list<std::string> m_loadLaterModules;
2011-08-14 04:09:11 +02:00
};
#endif