← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/context.h

  • Committer: Siddharth Prakash Singh
  • Date: 2010-03-26 19:25:23 UTC
  • mfrom: (1410 drizzle)
  • mto: This revision was merged to the branch mainline in revision 1425.
  • Revision ID: spsneo@spsneo-laptop-20100326192523-ibjlbt1p692vobtj
merging with trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/context.h
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2010 Monty Taylor
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 *  This program is distributed in the hope that it will be useful,
 
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *  GNU General Public License for more details.
 
14
 *
 
15
 *  You should have received a copy of the GNU General Public License
 
16
 *  along with this program; if not, write to the Free Software
 
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 */
 
19
 
 
20
#ifndef DRIZZLED_PLUGIN_CONTEXT_H
 
21
#define DRIZZLED_PLUGIN_CONTEXT_H
 
22
 
 
23
/**
 
24
 * @file Defines a Plugin Context
 
25
 *
 
26
 * A plugin::Context object is a proxy object containing state information
 
27
 * about the plugin being registered that knows how to perform registration
 
28
 * actions.
 
29
 *
 
30
 * The plugin registration system creates a new plugin::Context for each
 
31
 * plugin::Module during the initializtion phase and passes a reference to
 
32
 * the plugin::Context to the module's init method. This allows the plugin
 
33
 * to call registration methods without having access to larger plugin::Registry
 
34
 * calls. It also provides a filter layer through which calls are made in order
 
35
 * to force things like proper name prefixing and the like.
 
36
 */
 
37
 
 
38
#include "drizzled/plugin/registry.h"
 
39
 
 
40
namespace drizzled
 
41
{
 
42
 
 
43
class sys_var;
 
44
 
 
45
namespace plugin
 
46
{
 
47
class Module;
 
48
 
 
49
class Context
 
50
{
 
51
private:
 
52
  Registry &registry;
 
53
  Module *module;
 
54
 
 
55
  Context(const Context&);
 
56
  Context& operator=(const Context&);
 
57
public:
 
58
 
 
59
  Context(Registry &registry_arg,
 
60
          Module *module_arg) :
 
61
     registry(registry_arg),
 
62
     module(module_arg)
 
63
  { }
 
64
 
 
65
  template<class T>
 
66
  void add(T *plugin)
 
67
  {
 
68
    plugin->setModule(module);
 
69
    registry.add(plugin);
 
70
  }
 
71
 
 
72
  template<class T>
 
73
  void remove(T *plugin)
 
74
  {
 
75
    registry.remove(plugin);
 
76
  }
 
77
 
 
78
  void registerVariable(sys_var *var);
 
79
};
 
80
 
 
81
inline void Context::registerVariable(sys_var *)
 
82
{
 
83
/* In here, you can do:
 
84
  sys_var->append_name_prefix(module->getName());
 
85
  register_variable_whatever();
 
86
*/
 
87
}
 
88
 
 
89
} /* end namespace plugin */
 
90
} /* end namespace drizzled */
 
91
 
 
92
#endif /* DRIZZLED_PLUGIN_CONTEXT_H */