~drizzle-trunk/drizzle/development : contents of drizzled/plugin/plugin.h at revision 1259.6.2

~drizzle-trunk/drizzle/development : (revision 1259.6.2)

/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 *
 *  Copyright (C) 2009 Sun Microsystems
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef DRIZZLED_PLUGIN_PLUGIN_H
#define DRIZZLED_PLUGIN_PLUGIN_H

#include <string>
#include <vector>

namespace drizzled
{
namespace plugin
{

class Module;

class Plugin
{
private:
  const std::string name;
  bool is_active;
  Module *module;
  const std::string type_name;

  Plugin();
  Plugin(const Plugin&);
  Plugin& operator=(const Plugin &);
public:

  explicit Plugin(std::string in_name, std::string in_type_name);
  virtual ~Plugin() {}

  void activate()
  {
    is_active= true;
  }
 
  void deactivate()
  {
    is_active= false;
  }
 
  bool isActive() const
  {
    return is_active;
  }

  const std::string &getName() const
  {
    return name;
  } 

  void setModule(Module *module_arg)
  {
    module= module_arg;
  }

  const std::string& getTypeName() const
  {
    return type_name;
  }

  const std::string& getModuleName() const;
};
} /* end namespace plugin */
} /* end namespace drizzled */

#endif /* DRIZZLED_PLUGIN_PLUGIN_H */

1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	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
	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_PLUGIN_H
	21	#define DRIZZLED_PLUGIN_PLUGIN_H
	22
1130.2.6 by Monty Taylor Merged in latest plugin-slot-reorg.	23	#include <string>
	24	#include <vector>
	25
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	26	namespace drizzled
	27	{
	28	namespace plugin
	29	{
	30
1192.2.3 by Monty Taylor Renamed plugin::Handle to plugin::Module for clarity.	31	class Module;
1130.2.2 by Monty Taylor Added support for the global list of plugin::Plugin objects to slot::Function	32
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	33	class Plugin
	34	{
	35	private:
	36	const std::string name;
1130.2.29 by Monty Taylor Removed runtime active flag from plugin::Plugin. Put a runtime enabled flag on CommandApplier and CommandReplicator - we can refactor this down into plugin::Plugin later if we need to.	37	bool is_active;
1192.2.3 by Monty Taylor Renamed plugin::Handle to plugin::Module for clarity.	38	Module *module;
1192.2.5 by Monty Taylor Replaced overridable virtual methods with passing name to constructor. Now individual plugins will not be allowed to set their own plugin type name. :)	39	const std::string type_name;
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	40
	41	Plugin();
	42	Plugin(const Plugin&);
	43	Plugin& operator=(const Plugin &);
	44	public:
1130.2.24 by Monty Taylor Additional changes to command_log to work with how jay was using active/enable.	45
1192.2.5 by Monty Taylor Replaced overridable virtual methods with passing name to constructor. Now individual plugins will not be allowed to set their own plugin type name. :)	46	explicit Plugin(std::string in_name, std::string in_type_name);
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	47	virtual ~Plugin() {}
	48
1130.2.29 by Monty Taylor Removed runtime active flag from plugin::Plugin. Put a runtime enabled flag on CommandApplier and CommandReplicator - we can refactor this down into plugin::Plugin later if we need to.	49	void activate()
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	50	{
1130.2.24 by Monty Taylor Additional changes to command_log to work with how jay was using active/enable.	51	is_active= true;
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	52	}
	53
1130.2.29 by Monty Taylor Removed runtime active flag from plugin::Plugin. Put a runtime enabled flag on CommandApplier and CommandReplicator - we can refactor this down into plugin::Plugin later if we need to.	54	void deactivate()
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	55	{
1130.2.24 by Monty Taylor Additional changes to command_log to work with how jay was using active/enable.	56	is_active= false;
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	57	}
	58
1130.2.29 by Monty Taylor Removed runtime active flag from plugin::Plugin. Put a runtime enabled flag on CommandApplier and CommandReplicator - we can refactor this down into plugin::Plugin later if we need to.	59	bool isActive() const
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	60	{
1130.2.24 by Monty Taylor Additional changes to command_log to work with how jay was using active/enable.	61	return is_active;
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	62	}
	63
	64	const std::string &getName() const
	65	{
	66	return name;
	67	}
	68
1192.2.3 by Monty Taylor Renamed plugin::Handle to plugin::Module for clarity.	69	void setModule(Module *module_arg)
1130.2.2 by Monty Taylor Added support for the global list of plugin::Plugin objects to slot::Function	70	{
1192.2.3 by Monty Taylor Renamed plugin::Handle to plugin::Module for clarity.	71	module= module_arg;
1130.2.2 by Monty Taylor Added support for the global list of plugin::Plugin objects to slot::Function	72	}
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	73
1192.2.5 by Monty Taylor Replaced overridable virtual methods with passing name to constructor. Now individual plugins will not be allowed to set their own plugin type name. :)	74	const std::string& getTypeName() const
1192.2.1 by Monty Taylor Added the MODULES table.	75	{
1192.2.5 by Monty Taylor Replaced overridable virtual methods with passing name to constructor. Now individual plugins will not be allowed to set their own plugin type name. :)	76	return type_name;
1192.2.1 by Monty Taylor Added the MODULES table.	77	}
	78
	79	const std::string& getModuleName() const;
1130.2.1 by Monty Taylor Introduced plugin::Plugin class. Made Function use it.	80	};
	81	} /* end namespace plugin */
	82	} /* end namespace drizzled */
	83
	84	#endif /* DRIZZLED_PLUGIN_PLUGIN_H */