home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / iplugin_factory.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  3.0 KB  |  91 lines
  1. #ifndef K3DSDK_IPLUGIN_FACTORY_H
  2. #define K3DSDK_IPLUGIN_FACTORY_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2004, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \brief Declares iplugin_factory, an abstract factory interface for plugin objects
  25.     \author Tim Shead (tshead@k-3d.com)
  26. */
  27.  
  28. #include "iunknown.h"
  29. #include "uuid.h"
  30.  
  31. #include <iosfwd>
  32. #include <map>
  33. #include <string>
  34. #include <typeinfo>
  35. #include <vector>
  36.  
  37. namespace k3d
  38. {
  39.  
  40. /// Abstract factory interface for plugin objects
  41. class iplugin_factory :
  42.     public virtual iunknown
  43. {
  44. public:
  45.     /// Marks a plugin "stable", "experimental", or "deprecated", typically used to provide appropriate warnings in the UI
  46.     typedef enum
  47.     {
  48.         STABLE,
  49.         EXPERIMENTAL,
  50.         DEPRECATED
  51.     } quality_t;
  52.  
  53.     /// Defines a collection of "categories" used to group plugins within the UI
  54.     typedef std::vector<std::string> categories_t;
  55.     /// Defines a collection of interfaces implemented by the underlying plugin instance
  56.     typedef std::vector<const std::type_info*> interfaces_t;
  57.     /// Defines an arbitrary collection of name-value pair metadata describing the underlying plugin instance
  58.     typedef std::map<std::string, std::string> metadata_t;
  59.  
  60.     /// Returns a guaranteed-unique factory ID
  61.     virtual const k3d::uuid& factory_id() = 0;
  62.     /// Returns the internal name for a plugin
  63.     virtual const std::string name() = 0;
  64.     /// Returns a short, human-readable description of the plugin
  65.     virtual const std::string short_description() = 0;
  66.     /// Returns a default category for ordering this plugin within the UI
  67.     virtual const categories_t& categories() = 0;
  68.     /// Returns the plugin quality (stable or experimental)
  69.     virtual quality_t quality() = 0;
  70.     /// Returns true iff a plugin implements the requested interface
  71.     virtual bool implements(const std::type_info& InterfaceType) = 0;
  72.     /// Returns the set of interfaces implemented by the plugin 
  73.     virtual const interfaces_t interfaces() = 0;
  74.     /// Returns metadata describing the plugin
  75.     virtual metadata_t metadata() = 0;
  76.  
  77. protected:
  78.     iplugin_factory() {}
  79.     iplugin_factory(const iplugin_factory&) {}
  80.     iplugin_factory& operator = (const iplugin_factory&) { return *this; }
  81.     virtual ~iplugin_factory() {}
  82. };
  83.  
  84. std::ostream& operator<<(std::ostream&, const iplugin_factory::quality_t&);
  85. std::istream& operator>>(std::istream&, iplugin_factory::quality_t&);
  86.  
  87. } // namespace k3d
  88.  
  89. #endif // !K3DSDK_IPLUGIN_FACTORY_H
  90.  
  91.