← 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: 2009-02-21 00:18:15 UTC
  • Revision ID: brian@tangent.org-20090221001815-x20e8h71e984lvs1
Completion (?) of uint conversion.

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
 
#include "drizzled/visibility.h"
41
 
 
42
 
namespace drizzled
43
 
{
44
 
 
45
 
class sys_var;
46
 
 
47
 
namespace module
48
 
{
49
 
 
50
 
class Module;
51
 
class option_map;
52
 
 
53
 
class DRIZZLED_API Context
54
 
{
55
 
private:
56
 
  module::Registry &registry;
57
 
  module::Module *module;
58
 
 
59
 
  Context(const Context&);
60
 
  Context& operator=(const Context&);
61
 
public:
62
 
 
63
 
  Context(module::Registry &registry_arg,
64
 
          module::Module *module_arg) :
65
 
     registry(registry_arg),
66
 
     module(module_arg)
67
 
  { }
68
 
 
69
 
  template<class T>
70
 
  void add(T *plugin)
71
 
  {
72
 
    plugin->setModule(module);
73
 
    registry.add(plugin);
74
 
  }
75
 
 
76
 
  template<class T>
77
 
  void remove(T *plugin)
78
 
  {
79
 
    registry.remove(plugin);
80
 
  }
81
 
 
82
 
  void registerVariable(sys_var *var);
83
 
 
84
 
  option_map getOptions();
85
 
 
86
 
  static std::string prepend_name(std::string module_name,
87
 
                                  const std::string &var_name);
88
 
};
89
 
 
90
 
 
91
 
} /* namespace module */
92
 
} /* namespace drizzled */
93
 
 
94
 
#endif /* DRIZZLED_MODULE_CONTEXT_H */