Drizzled Public API Documentation

library.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 
30 #include <string>
31 #include <boost/filesystem.hpp>
32 
33 namespace drizzled {
34 namespace module {
35 
36 struct Manifest;
37 
38 /* A handle for the dynamic library containing a plugin or plugins. */
39 class Library : boost::noncopyable
40 {
41  std::string name;
42  void *handle;
43  const Manifest *manifest;
44 
45  /* Construction should only happen through the static factory method */
46  Library(const std::string &name_arg, void *handle_arg, const Manifest*);
47 
48 public:
49  ~Library();
50 
51  const std::string &getName() const
52  {
53  return name;
54  }
55 
56  const Manifest *getManifest() const
57  {
58  return manifest;
59  }
60 
61  static const boost::filesystem::path getLibraryPath(const std::string &plugin_name);
62  static Library *loadLibrary(const std::string &plugin_name, bool builtin);
63 };
64 
65 } /* namespace module */
66 } /* namespace drizzled */
TODO: Rename this file - func.h is stupid.