Packets: not really a smart but efficient 'shortcut' for ConcretePacket::next() ...
[senf.git] / senf / Packets / PacketInterpreter.hh
index fa9ed46..cc49812 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2007
 // 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 PacketInterpreter public header */
@@ -37,7 +42,7 @@
 #include <senf/Utils/TypeIdValue.hh>
 
 //#include "PacketInterpreter.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
@@ -56,7 +61,7 @@ namespace senf {
           public intrusive_refcount_t<PacketInterpreterBase>
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // Types
 
         typedef senf::detail::packet::smart_pointer<
@@ -69,7 +74,7 @@ namespace senf {
         typedef senf::detail::packet::byte byte;
 
         typedef boost::iterator_range<iterator> range;
-        typedef boost::optional< boost::iterator_range<iterator> > optional_range;
+        typedef boost::optional<range> optional_range;
         typedef optional_range no_range;
 
         enum Append_t { Append };
@@ -116,14 +121,14 @@ namespace senf {
 
             // Parse next packet in chain
 
-            virtual ptr parseNext(ptr packet) const = 0;
+            virtual ptr parseNext(ptr packet, PacketInterpreterBase::optional_range const & range) const = 0;
         };
 
         typedef Factory const * factory_t;
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         // protected constructors
         // no copy
@@ -135,11 +140,11 @@ namespace senf {
 
         ptr clone();
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
 
         ///\name Interpreter chain access
-        ///@{
+        //\{
 
         ptr next();
         ptr prev();
@@ -147,32 +152,36 @@ namespace senf {
         ptr last();
 
         template <class Type> typename PacketInterpreter<Type>::ptr parseNextAs();
-                                       ptr                          parseNextAs(factory_t factory);
+                                       ptr                          parseNextAs(factory_t factory, PacketInterpreterBase::optional_range const & range);
         template <class Type>          bool                         is();
         template <class Type> typename PacketInterpreter<Type>::ptr as();
 
         ptr append(ptr packet);
 
-        ///@}
+        void reparse();
+
+        //\}
 
         ///\name Data access
-        ///@{
+        //\{
 
         using PacketData::valid;
         PacketData & data();
 
-        ///@}
+        //\}
 
         ///\name Annotations
-        ///@{
+        //\{
 
         template <class Annotation>
         Annotation & annotation();
 
-        ///@}
+        void clearAnnotations();
+
+        //\}
 
         ///\name Access to the abstract interface
-        ///@{
+        //\{
 
         optional_range nextPacketRange();
         void finalizeThis();
@@ -182,7 +191,7 @@ namespace senf {
         factory_t factory();
         factory_t nextPacketType();
 
-        ///@}
+        //\}
 
     protected:
         // protected structors
@@ -250,7 +259,7 @@ namespace senf {
           public pool_alloc_mixin< PacketInterpreter<PacketType> >
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // Types
 
         typedef typename senf::detail::packet::smart_pointer<
@@ -258,9 +267,9 @@ namespace senf {
         typedef PacketType type;
         typedef typename type::parser parser;
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         // private constructors
         // no copy
@@ -299,8 +308,8 @@ namespace senf {
 
         ptr clone();
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
 
         // Packet field access
 
@@ -351,6 +360,8 @@ namespace senf {
             Implements the abstract factory interface for \a PacketType
          */
         struct FactoryImpl : public Factory {
+            FactoryImpl() {}
+
             // Create completely new packet
 
             virtual PacketInterpreterBase::ptr create() const;
@@ -385,7 +396,7 @@ namespace senf {
 
             // Parse next packet in chain
 
-            virtual PacketInterpreterBase::ptr parseNext(PacketInterpreterBase::ptr packet)
+            virtual PacketInterpreterBase::ptr parseNext(PacketInterpreterBase::ptr packet, PacketInterpreterBase::optional_range const & range)
                 const;
         };
 
@@ -406,7 +417,7 @@ namespace senf {
 
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #endif
 #if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketInterpreter_i_)
 #define HH_SENF_Packets_PacketInterpreter_i_