← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/module/context.h

  • Committer: Brian Aker
  • Date: 2008-07-08 16:17:31 UTC
  • Revision ID: brian@tangent.org-20080708161731-io36j7igglok79py
DATE cleanup.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/module/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_MODULE_CONTEXT_H
21
 
#define DRIZZLED_MODULE_CONTEXT_H
22
 
 
23
 
/**
24
 
 * @file Defines a Plugin Context
25
 
 *
26
 
 * A module::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 module::Context for each
31
 
 * module::Module during the initializtion phase and passes a reference to
32
 
 * the module::Context to the module's init method. This allows the plugin
33
 
 * to call registration methods without having access to larger module::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/module/registry.h"
39
 
 
40
 
namespace drizzled
41
 
{
42
 
 
43
 
class sys_var;
44
 
 
45
 
namespace module
46
 
{
47
 
 
48
 
class Module;
49
 
class option_map;
50
 
 
51
 
class Context
52
 
{
53
 
private:
54
 
  module::Registry &registry;
55
 
  module::Module *module;
56
 
 
57
 
  Context(const Context&);
58
 
  Context& operator=(const Context&);
59
 
public:
60
 
 
61
 
  Context(module::Registry &registry_arg,
62
 
          module::Module *module_arg) :
63
 
     registry(registry_arg),
64
 
     module(module_arg)
65
 
  { }
66
 
 
67
 
  template<class T>
68
 
  void add(T *plugin)
69
 
  {
70
 
    plugin->setModule(module);
71
 
    registry.add(plugin);
72
 
  }
73
 
 
74
 
  template<class T>
75
 
  void remove(T *plugin)
76
 
  {
77
 
    registry.remove(plugin);
78
 
  }
79
 
 
80
 
  void registerVariable(sys_var *var);
81
 
 
82
 
  option_map getOptions();
83
 
};
84
 
 
85
 
inline void Context::registerVariable(sys_var *)
86
 
{
87
 
/* In here, you can do:
88
 
  sys_var->append_name_prefix(module->getName());
89
 
  register_variable_whatever();
90
 
*/
91
 
}
92
 
 
93
 
} /* namespace module */
94
 
} /* namespace drizzled */
95
 
 
96
 
#endif /* DRIZZLED_MODULE_CONTEXT_H */