vdr  2.6.9
plugin.h
Go to the documentation of this file.
1 /*
2  * plugin.h: The VDR plugin interface
3  *
4  * See the main source file 'vdr.c' for copyright information and
5  * how to reach the author.
6  *
7  * $Id: plugin.h 4.1 2020/06/29 09:29:06 kls Exp $
8  */
9 
10 #ifndef __PLUGIN_H
11 #define __PLUGIN_H
12 
13 #include "i18n.h"
14 #include "menuitems.h"
15 #include "osdbase.h"
16 #include "tools.h"
17 
18 #define VDRPLUGINCREATOR(PluginClass) \
19  extern "C" void *VDRPluginCreator(void) { return new PluginClass; } \
20  extern "C" void VDRPluginDestroyer(PluginClass *p) { delete p; }
21 
22 class cPlugin {
23  friend class cDll;
24  friend class cPluginManager;
25 private:
29  const char *name;
30  bool started;
31  void SetName(const char *s);
32 public:
33  cPlugin(void);
34  virtual ~cPlugin();
35 
36  const char *Name(void) { return name; }
37  virtual const char *Version(void) = 0;
38  virtual const char *Description(void) = 0;
39  virtual const char *CommandLineHelp(void);
40 
41  virtual bool ProcessArgs(int argc, char *argv[]);
42  virtual bool Initialize(void);
43  virtual bool Start(void);
44  virtual void Stop(void);
45  virtual void Housekeeping(void);
46  virtual void MainThreadHook(void);
47  virtual cString Active(void);
48  virtual time_t WakeupTime(void);
49 
50  virtual const char *MainMenuEntry(void);
51  virtual cOsdObject *MainMenuAction(void);
52 
53  virtual cMenuSetupPage *SetupMenu(void);
54  virtual bool SetupParse(const char *Name, const char *Value);
55  void SetupStore(const char *Name, const char *Value = NULL);
56  void SetupStore(const char *Name, int Value);
57 
58  virtual bool Service(const char *Id, void *Data = NULL);
59  virtual const char **SVDRPHelpPages(void);
60  virtual cString SVDRPCommand(const char *Command, const char *Option, int &ReplyCode);
61 
62  static void SetConfigDirectory(const char *Dir);
63  static const char *ConfigDirectory(const char *PluginName = NULL);
64  static void SetCacheDirectory(const char *Dir);
65  static const char *CacheDirectory(const char *PluginName = NULL);
66  static void SetResourceDirectory(const char *Dir);
67  static const char *ResourceDirectory(const char *PluginName = NULL);
68  };
69 
70 class cDll : public cListObject {
71 private:
72  char *fileName;
73  char *args;
74  void *handle;
76  typedef void destroy_t(cPlugin *);
78 public:
79  cDll(const char *FileName, const char *Args);
80  virtual ~cDll();
81  bool Load(bool Log = false);
82  cPlugin *Plugin(void) { return plugin; }
83  };
84 
85 class cDlls : public cList<cDll> {};
86 
88 private:
90  char *directory;
94 public:
95  cPluginManager(const char *Directory);
96  virtual ~cPluginManager();
97  void SetDirectory(const char *Directory);
98  void AddPlugin(const char *Args);
99  bool LoadPlugins(bool Log = false);
100  bool InitializePlugins(void);
101  bool StartPlugins(void);
102  void Housekeeping(void);
103  void MainThreadHook(void);
104  static bool Active(const char *Prompt = NULL);
105  static cPlugin *GetNextWakeupPlugin(void);
106  static bool HasPlugins(void);
107  static cPlugin *GetPlugin(int Index);
108  static cPlugin *GetPlugin(const char *Name);
109  static cPlugin *CallFirstService(const char *Id, void *Data = NULL);
110  static bool CallAllServices(const char *Id, void *Data = NULL);
111  void StopPlugins(void);
112  void Shutdown(bool Log = false);
113  };
114 
115 #endif //__PLUGIN_H
Definition: plugin.h:70
void * handle
Definition: plugin.h:74
cPlugin * plugin
Definition: plugin.h:75
void destroy_t(cPlugin *)
Definition: plugin.h:76
cPlugin * Plugin(void)
Definition: plugin.h:82
destroy_t * destroy
Definition: plugin.h:77
cDll(const char *FileName, const char *Args)
Definition: plugin.c:179
char * args
Definition: plugin.h:73
virtual ~cDll()
Definition: plugin.c:188
bool Load(bool Log=false)
Definition: plugin.c:219
char * fileName
Definition: plugin.h:72
Definition: plugin.h:85
Definition: tools.h:644
static cPluginManager * pluginManager
Definition: plugin.h:89
void StopPlugins(void)
Definition: plugin.c:512
static cPlugin * GetNextWakeupPlugin(void)
Definition: plugin.c:444
void MainThreadHook(void)
Definition: plugin.c:418
bool StartPlugins(void)
Definition: plugin.c:388
cPluginManager(const char *Directory)
Definition: plugin.c:303
void SetDirectory(const char *Directory)
Definition: plugin.c:324
bool InitializePlugins(void)
Definition: plugin.c:375
void AddPlugin(const char *Args)
Definition: plugin.c:330
static bool Active(const char *Prompt=NULL)
Definition: plugin.c:427
static bool HasPlugins(void)
Definition: plugin.c:464
cDlls dlls
Definition: plugin.h:93
int nextHousekeeping
Definition: plugin.h:92
static bool CallAllServices(const char *Id, void *Data=NULL)
Definition: plugin.c:499
bool LoadPlugins(bool Log=false)
Definition: plugin.c:366
void Shutdown(bool Log=false)
Definition: plugin.c:524
static cPlugin * CallFirstService(const char *Id, void *Data=NULL)
Definition: plugin.c:487
char * directory
Definition: plugin.h:90
virtual ~cPluginManager()
Definition: plugin.c:316
void Housekeeping(void)
Definition: plugin.c:402
time_t lastHousekeeping
Definition: plugin.h:91
static cPlugin * GetPlugin(int Index)
Definition: plugin.c:469
Definition: plugin.h:22
virtual time_t WakeupTime(void)
Definition: plugin.c:85
virtual bool Initialize(void)
Definition: plugin.c:58
virtual void Stop(void)
Definition: plugin.c:68
virtual cMenuSetupPage * SetupMenu(void)
Definition: plugin.c:100
virtual const char * CommandLineHelp(void)
Definition: plugin.c:48
virtual ~cPlugin()
Definition: plugin.c:38
virtual const char * Description(void)=0
virtual bool Start(void)
Definition: plugin.c:63
const char * Name(void)
Definition: plugin.h:36
virtual void Housekeeping(void)
Definition: plugin.c:72
static cString cacheDirectory
Definition: plugin.h:27
bool started
Definition: plugin.h:30
void SetName(const char *s)
Definition: plugin.c:42
void SetupStore(const char *Name, const char *Value=NULL)
Definition: plugin.c:110
virtual const char * MainMenuEntry(void)
Definition: plugin.c:90
static cString resourceDirectory
Definition: plugin.h:28
static void SetCacheDirectory(const char *Dir)
Definition: plugin.c:149
virtual bool Service(const char *Id, void *Data=NULL)
Definition: plugin.c:120
virtual const char * Version(void)=0
const char * name
Definition: plugin.h:29
virtual cOsdObject * MainMenuAction(void)
Definition: plugin.c:95
static void SetConfigDirectory(const char *Dir)
Definition: plugin.c:135
static void SetResourceDirectory(const char *Dir)
Definition: plugin.c:163
static const char * CacheDirectory(const char *PluginName=NULL)
Definition: plugin.c:154
static const char * ResourceDirectory(const char *PluginName=NULL)
Definition: plugin.c:168
static const char * ConfigDirectory(const char *PluginName=NULL)
Definition: plugin.c:140
cPlugin(void)
Definition: plugin.c:32
virtual void MainThreadHook(void)
Definition: plugin.c:76
virtual cString SVDRPCommand(const char *Command, const char *Option, int &ReplyCode)
Definition: plugin.c:130
virtual cString Active(void)
Definition: plugin.c:80
virtual const char ** SVDRPHelpPages(void)
Definition: plugin.c:125
static cString configDirectory
Definition: plugin.h:26
virtual bool SetupParse(const char *Name, const char *Value)
Definition: plugin.c:105
virtual bool ProcessArgs(int argc, char *argv[])
Definition: plugin.c:53
Definition: tools.h:178