gcc const fix, converted linefeeds
[shibboleth/cpp-xmltooling.git] / xmltooling / PluginManager.h
index 5f248e0..f882891 100644 (file)
-/*\r
- *  Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file xmltooling/PluginManager.h\r
- * \r
- * Plugin management template\r
- */\r
-\r
-#ifndef __xmltooling_plugin_h__\r
-#define __xmltooling_plugin_h__\r
-\r
-#include <xmltooling/base.h>\r
-#include <xmltooling/exceptions.h>\r
-\r
-#include <map>\r
-#include <string>\r
-\r
-#if defined (_MSC_VER)\r
-    #pragma warning( push )\r
-    #pragma warning( disable : 4250 4251 )\r
-#endif\r
-\r
-namespace xmltooling {\r
-\r
-    /**\r
-     * Template for management/access to plugins constructed based on a string type\r
-     * and arbitrary parameters.\r
-     * \r
-     * @param T         class of plugin to manage\r
-     * @param Params    parameters for plugin construction\r
-     */\r
-    template <class T, typename Params> class PluginManager\r
-    {\r
-    public:\r
-        PluginManager() {}\r
-        ~PluginManager() {}\r
-\r
-        /** Factory function for plugin. */\r
-        typedef T* Factory(const Params&);\r
-\r
-        /**\r
-         * Registers the factory for a given type.\r
-         * \r
-         * @param type      the name of the plugin type\r
-         * @param factory   the factory function for the plugin type\r
-         */\r
-        void registerFactory(const std::string& type, typename PluginManager::Factory* factory) {\r
-            if (!type.empty() && factory)\r
-                m_map[type]=factory;\r
-        }\r
-\r
-        /**\r
-         * Unregisters the factory for a given type.\r
-         * \r
-         * @param type  the name of the plugin type\r
-         */\r
-        void deregisterFactory(const std::string& type) {\r
-            if (!type.empty())\r
-                m_map.erase(type);\r
-        }\r
-\r
-        /**\r
-         * Unregisters all registered factories.\r
-         */\r
-        void deregisterFactories() {\r
-            m_map.clear();\r
-        }\r
-\r
-        /**\r
-         * Builds a new instance of a plugin of a given type, configuring it\r
-         * with the supplied parameters.\r
-         * \r
-         * @param type  the name of the plugin type\r
-         * @param p     parameters to configure plugin\r
-         * @return      the constructed plugin  \r
-         */\r
-        T* newPlugin(const std::string& type, const Params& p) {\r
-            typename std::map<std::string, typename PluginManager::Factory*>::const_iterator i=m_map.find(type);\r
-            if (i==m_map.end())\r
-                throw UnknownExtensionException("Unable to build plugin of type '$1'",params(1,type.c_str()));\r
-            return i->second(p);\r
-        }\r
-        \r
-    private:\r
-        std::map<std::string, typename PluginManager::Factory*> m_map;\r
-    };\r
-\r
-};\r
-\r
-#if defined (_MSC_VER)\r
-    #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_plugin_h__ */\r
+/*
+ *  Copyright 2001-2006 Internet2
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file xmltooling/PluginManager.h
+ * 
+ * Plugin management template
+ */
+
+#ifndef __xmltooling_plugin_h__
+#define __xmltooling_plugin_h__
+
+#include <xmltooling/base.h>
+#include <xmltooling/exceptions.h>
+
+#include <map>
+#include <string>
+
+#if defined (_MSC_VER)
+    #pragma warning( push )
+    #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+    /**
+     * Template for management/access to plugins constructed based on a string type
+     * and arbitrary parameters.
+     * 
+     * @param T         class of plugin to manage
+     * @param Params    parameters for plugin construction
+     */
+    template <class T, typename Params> class PluginManager
+    {
+    public:
+        PluginManager() {}
+        ~PluginManager() {}
+
+        /** Factory function for plugin. */
+        typedef T* Factory(const Params&);
+
+        /**
+         * Registers the factory for a given type.
+         * 
+         * @param type      the name of the plugin type
+         * @param factory   the factory function for the plugin type
+         */
+        void registerFactory(const std::string& type, typename PluginManager::Factory* factory) {
+            if (!type.empty() && factory)
+                m_map[type]=factory;
+        }
+
+        /**
+         * Unregisters the factory for a given type.
+         * 
+         * @param type  the name of the plugin type
+         */
+        void deregisterFactory(const std::string& type) {
+            if (!type.empty())
+                m_map.erase(type);
+        }
+
+        /**
+         * Unregisters all registered factories.
+         */
+        void deregisterFactories() {
+            m_map.clear();
+        }
+
+        /**
+         * Builds a new instance of a plugin of a given type, configuring it
+         * with the supplied parameters.
+         * 
+         * @param type  the name of the plugin type
+         * @param p     parameters to configure plugin
+         * @return      the constructed plugin  
+         */
+        T* newPlugin(const std::string& type, const Params& p) {
+            typename std::map<std::string, typename PluginManager::Factory*>::const_iterator i=m_map.find(type);
+            if (i==m_map.end())
+                throw UnknownExtensionException("Unable to build plugin of type '$1'",params(1,type.c_str()));
+            return i->second(p);
+        }
+        
+    private:
+        std::map<std::string, typename PluginManager::Factory*> m_map;
+    };
+
+};
+
+#if defined (_MSC_VER)
+    #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_plugin_h__ */