switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / PacketRegistry.ih
index 24c9851..adf2f28 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2006
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.de>
 //
-// 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; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.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://senf.berlios.de/license.html
 //
-// 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.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// 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.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief PacketRegistry internal header */
 #define IH_SENF_Packets_PacketRegistry_ 1
 
 // Custom includes
-#include <ext/functional>
+#include <limits>
+#include <boost/multi_index_container.hpp>
+#include <boost/multi_index/ordered_index.hpp>
+#include <boost/multi_index/composite_key.hpp>
+#include <boost/multi_index/member.hpp>
+#include <boost/multi_index/mem_fun.hpp>
 #include <boost/intrusive_ptr.hpp>
-#include <boost/iterator/transform_iterator.hpp>
+#include <boost/utility.hpp> // for boost::noncopyable
 #include <senf/Utils/TypeIdValue.hh>
 
-///////////////////////////////ih.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
-
-    /** \brief Registry entry
-
-        Value returned by a registry lookup
-     */
-    struct PkReg_Entry
-        : public intrusive_refcount
-    {
-        virtual ~PkReg_Entry();
-        virtual Packet::factory_t factory() const = 0;
-                                        ///< Get factory of the registered packet type
-        virtual std::string name() const = 0;
-    };
-
 namespace detail {
 
-    /** \brief Internal: Registry entry implementation for a specific packet type
-
-        \internal
-     */
-    template <class PacketType>
-    struct PkReg_EntryImpl
-        : public PkReg_Entry
+    struct TypeInfoCompare
     {
-        virtual Packet::factory_t factory() const;
-        virtual std::string name() const;
+        bool operator()(std::type_info const & a, std::type_info const & b) const
+            { return a.before(b); }
     };
 
     /** \brief Internal: Registry implementation base-class and registry of registries
@@ -74,13 +64,16 @@ namespace detail {
         virtual ~PacketRegistryImplBase();
 
         static void dump(std::ostream & os);
+        static void clear();
 
     protected:
         typedef std::map<std::string, PacketRegistryImplBase*>  RegistryMap;
         static RegistryMap & registries();
 
     private:
-        virtual void v_dump(std::ostream & os) = 0;
+        virtual bool v_empty() const = 0;
+        virtual void v_dump(std::ostream & os) const = 0;
+        virtual void v_clear() = 0;
     };
 
     /** \brief Internal: Singleton class implementing the packet registry.
@@ -93,31 +86,77 @@ namespace detail {
     {
     public:
         typedef KeyType key_t;
-        typedef PkReg_Entry Entry;
+
+        struct Entry : public intrusive_refcount
+        {
+            typedef boost::intrusive_ptr<Entry> ptr;
+
+            Entry(KeyType const & key_, int priority_);
+            virtual ~Entry();
+
+            virtual Packet::factory_t factory() const = 0;
+
+            virtual std::string name() const = 0;
+            virtual std::type_info const & type() const = 0;
+
+            KeyType key;
+            int priority;
+        };
 
     private:
-        typedef boost::intrusive_ptr<Entry> Entry_ptr;
-        typedef std::map<key_t, Entry_ptr> PacketMap;
-        typedef std::map<senf::TypeIdValue, key_t> ReversePacketMap;
+        struct ByKey {};
+        struct ByType {};
+
+        struct RegistryIndices
+            : public boost::multi_index::indexed_by<
+                boost::multi_index::ordered_unique<
+                    boost::multi_index::tag<ByKey>,
+                    boost::multi_index::composite_key<
+                        Entry,
+                        boost::multi_index::member<Entry,KeyType,&Entry::key>,
+                        boost::multi_index::member<Entry,int,&Entry::priority> >,
+                    boost::multi_index::composite_key_compare<
+                        std::less<KeyType>,
+                        std::greater<int> > >,
+                boost::multi_index::ordered_unique<
+                    boost::multi_index::tag<ByType>,
+                    boost::multi_index::mem_fun<Entry const,std::type_info const &,&Entry::type>,
+                    TypeInfoCompare> >
+        {};
+
+        typedef boost::multi_index_container<typename Entry::ptr, RegistryIndices> Registry;
+
+        template <class PacketType>
+        struct EntryImpl : public Entry
+        {
+            EntryImpl(KeyType const & key, int priority);
+
+            virtual Packet::factory_t factory() const;
+            virtual std::string name() const;
+            virtual std::type_info const & type() const;
+        };
 
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-/////////////////////////////////////////////////////////////////////////////////////////
         // Types
 
-        typedef boost::transform_iterator< ::__gnu_cxx::select1st<typename PacketMap::value_type>,
-                                           typename PacketMap::const_iterator > iterator;
+        typedef typename Registry::template index<ByKey>::type::const_iterator iterator;
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-/////////////////////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         PacketRegistryImpl(std::string const & name);
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-/////////////////////////////////////////////////////////////////////////////////////////
+
+        template <class PacketType>
+        void registerPacket(key_t key, int priority=0);
 
         template <class PacketType>
-        void registerPacket(key_t key);
+        void unregisterPacket();
+        void unregisterPacket(key_t key, int priority=0);
 
         key_t key(senf::TypeIdValue const & type);
         boost::optional<key_t> key(senf::TypeIdValue const & type, bool);
@@ -131,15 +170,28 @@ namespace detail {
     protected:
 
     private:
-        virtual void v_dump(std::ostream & os);
+        virtual bool v_empty() const;
+        virtual void v_dump(std::ostream & os) const;
+        virtual void v_clear();
 
-        PacketMap registry_;
-        ReversePacketMap reverseRegistry_;
+        Registry registry_;
+    };
+
+    template <class KeyType, bool is_integral=std::numeric_limits<KeyType>::is_integer>
+    struct DumpKey
+    {
+        static void dump(KeyType const & v, std::ostream & os);
+    };
+
+    template <class KeyType>
+    struct DumpKey<KeyType, true>
+    {
+        static void dump(KeyType const & v, std::ostream & os);
     };
 
 }}
 
-///////////////////////////////ih.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #endif
 
 \f