1
0
mirror of https://github.com/VDR4Arch/vdr.git synced 2023-10-10 13:36:52 +02:00
vdr/plugin.h

116 lines
3.3 KiB
C
Raw Permalink Normal View History

2002-05-09 16:26:56 +02:00
/*
* plugin.h: The VDR plugin interface
*
* See the main source file 'vdr.c' for copyright information and
* how to reach the author.
*
* $Id: plugin.h 4.1 2020/06/29 09:29:06 kls Exp $
2002-05-09 16:26:56 +02:00
*/
#ifndef __PLUGIN_H
#define __PLUGIN_H
#include "i18n.h"
#include "menuitems.h"
2004-05-16 10:35:36 +02:00
#include "osdbase.h"
2002-05-09 16:26:56 +02:00
#include "tools.h"
#define VDRPLUGINCREATOR(PluginClass) \
extern "C" void *VDRPluginCreator(void) { return new PluginClass; } \
extern "C" void VDRPluginDestroyer(PluginClass *p) { delete p; }
2002-05-09 16:26:56 +02:00
class cPlugin {
friend class cDll;
2005-01-30 14:23:01 +01:00
friend class cPluginManager;
2002-05-09 16:26:56 +02:00
private:
static cString configDirectory;
static cString cacheDirectory;
static cString resourceDirectory;
2002-05-09 16:26:56 +02:00
const char *name;
2005-01-30 14:23:01 +01:00
bool started;
2002-05-09 16:26:56 +02:00
void SetName(const char *s);
public:
cPlugin(void);
virtual ~cPlugin();
const char *Name(void) { return name; }
virtual const char *Version(void) = 0;
virtual const char *Description(void) = 0;
virtual const char *CommandLineHelp(void);
virtual bool ProcessArgs(int argc, char *argv[]);
2003-05-09 15:27:46 +02:00
virtual bool Initialize(void);
virtual bool Start(void);
2005-01-30 14:23:01 +01:00
virtual void Stop(void);
virtual void Housekeeping(void);
virtual void MainThreadHook(void);
2006-04-15 11:18:36 +02:00
virtual cString Active(void);
virtual time_t WakeupTime(void);
2002-05-09 16:26:56 +02:00
virtual const char *MainMenuEntry(void);
2002-11-24 10:45:39 +01:00
virtual cOsdObject *MainMenuAction(void);
2002-05-09 16:26:56 +02:00
virtual cMenuSetupPage *SetupMenu(void);
virtual bool SetupParse(const char *Name, const char *Value);
void SetupStore(const char *Name, const char *Value = NULL);
void SetupStore(const char *Name, int Value);
virtual bool Service(const char *Id, void *Data = NULL);
2005-08-27 16:42:28 +02:00
virtual const char **SVDRPHelpPages(void);
virtual cString SVDRPCommand(const char *Command, const char *Option, int &ReplyCode);
static void SetConfigDirectory(const char *Dir);
static const char *ConfigDirectory(const char *PluginName = NULL);
static void SetCacheDirectory(const char *Dir);
static const char *CacheDirectory(const char *PluginName = NULL);
static void SetResourceDirectory(const char *Dir);
static const char *ResourceDirectory(const char *PluginName = NULL);
2002-05-09 16:26:56 +02:00
};
class cDll : public cListObject {
private:
char *fileName;
char *args;
void *handle;
cPlugin *plugin;
typedef void destroy_t(cPlugin *);
destroy_t *destroy;
2002-05-09 16:26:56 +02:00
public:
cDll(const char *FileName, const char *Args);
virtual ~cDll();
bool Load(bool Log = false);
cPlugin *Plugin(void) { return plugin; }
};
class cDlls : public cList<cDll> {};
class cPluginManager {
private:
static cPluginManager *pluginManager;
char *directory;
time_t lastHousekeeping;
int nextHousekeeping;
2002-05-09 16:26:56 +02:00
cDlls dlls;
public:
cPluginManager(const char *Directory);
virtual ~cPluginManager();
void SetDirectory(const char *Directory);
void AddPlugin(const char *Args);
bool LoadPlugins(bool Log = false);
2003-05-09 15:27:46 +02:00
bool InitializePlugins(void);
bool StartPlugins(void);
void Housekeeping(void);
void MainThreadHook(void);
2006-04-15 11:18:36 +02:00
static bool Active(const char *Prompt = NULL);
static cPlugin *GetNextWakeupPlugin(void);
2002-05-09 16:26:56 +02:00
static bool HasPlugins(void);
static cPlugin *GetPlugin(int Index);
static cPlugin *GetPlugin(const char *Name);
static cPlugin *CallFirstService(const char *Id, void *Data = NULL);
static bool CallAllServices(const char *Id, void *Data = NULL);
2005-01-30 14:23:01 +01:00
void StopPlugins(void);
void Shutdown(bool Log = false);
2002-05-09 16:26:56 +02:00
};
#endif //__PLUGIN_H