Drizzled Public API Documentation

manifest.h
1 /* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3  *
4  * Copyright (C) 2009 Sun Microsystems, Inc.
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 #pragma once
21 
28 #include <drizzled/module/context.h>
30 
31 namespace drizzled
32 {
33 
34 struct drizzle_show_var;
35 struct drizzle_sys_var;
36 
37 /* We use the following strings to define licenses for plugins */
38 enum plugin_license_type {
39  PLUGIN_LICENSE_GPL,
40  PLUGIN_LICENSE_BSD,
41  PLUGIN_LICENSE_LGPL,
42  PLUGIN_LICENSE_PROPRIETARY,
43  PLUGIN_LICENSE_MAX=PLUGIN_LICENSE_LGPL
44 };
45 
46 
47 namespace module
48 {
49 
50 typedef int (*initialize_func_t)(::drizzled::module::Context &);
51 typedef void (*options_func_t)(::drizzled::module::option_context &);
52 
61 struct Manifest
62 {
63  uint64_t drizzle_version; /* Drizzle version the plugin was compiled for */
64  const char *name; /* plugin name (for SHOW PLUGINS) */
65  const char *version; /* plugin version (for SHOW PLUGINS) */
66  const char *author; /* plugin author (for SHOW PLUGINS) */
67  const char *descr; /* general descriptive text (for SHOW PLUGINS ) */
68  plugin_license_type license; /* plugin license (PLUGIN_LICENSE_XXX) */
69  initialize_func_t init; /* function to invoke when plugin is loaded */
70  const char *depends;
71  options_func_t init_options; /* register command line options */
72 };
73 
74 } /* namespace module */
75 } /* namespace drizzled */
76 
TODO: Rename this file - func.h is stupid.
An Proxy Wrapper around options_description_easy_init.