switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / Packet.test.cc
index 119baa7..c714924 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 Packet unit tests */
 // Custom includes
 #include <sstream>
 #include <boost/static_assert.hpp>
+#include <boost/cstdint.hpp>
 #include "Packets.hh"
 
 #include <senf/Utils/auto_unit_test.hh>
 #include <boost/test/test_tools.hpp>
 
 #define prefix_
-///////////////////////////////cc.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace {
 
@@ -43,7 +49,7 @@ namespace {
         typedef unsigned key_t;
     };
 
-    struct FooPacketType 
+    struct FooPacketType
         : public senf::PacketTypeBase,
           public senf::PacketTypeMixin<FooPacketType>
     {
@@ -57,7 +63,7 @@ namespace {
         // mode. Otherwise, mixin::nextPacketRange() would query the parser for it's size to find
         // the header size. Since the parser is VoidPacketParser, the header size would therefore be
         // 0
-        static size_type initHeadSize() 
+        static size_type initHeadSize()
             { return initSize(); }
     };
     typedef senf::ConcretePacket<FooPacketType> FooPacket;
@@ -65,7 +71,7 @@ namespace {
     struct BarPacketParser : public senf::PacketParserBase
     {
 #       include SENF_FIXED_PARSER()
-        
+
         SENF_PARSER_FIELD( type,     senf::UInt16Parser );
         SENF_PARSER_FIELD( length,   senf::Int32Parser  );
         SENF_PARSER_FIELD( reserved, senf::UInt16Parser );
@@ -77,7 +83,7 @@ namespace {
         SENF_PARSER_FINALIZE(BarPacketParser);
     };
 
-    struct BarPacketType 
+    struct BarPacketType
         : public senf::PacketTypeBase,
           public senf::PacketTypeMixin<BarPacketType,RegTag>
     {
@@ -90,8 +96,8 @@ namespace {
         using mixin::init;
         static void dump(packet p, std::ostream & os) {
             os << "BarPacket:\n"
-               << "  type: " << p->type() << "\n"
-               << "  length: " << p->length() << "\n";
+               << senf::fieldName("type") << p->type() << "\n"
+               << senf::fieldName("length") << p->length() << "\n";
         }
         static void finalize(packet p) {
             if (p.next(senf::nothrow))
@@ -106,17 +112,17 @@ namespace {
     typedef BarPacketType::packet BarPacket;
 
     namespace reg {
-        senf::PacketRegistry<RegTag>::RegistrationProxy<FooPacket> registerFoo(1u);
-        senf::PacketRegistry<RegTag>::RegistrationProxy<BarPacket> registerBar(2u);
+        senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<FooPacket> registerFoo(1u);
+        senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<BarPacket> registerBar(2u);
     }
 
     struct IntAnnotation {
-        unsigned value;
+        boost::uint32_t value;
     };
 
     std::ostream & operator<<(std::ostream & os, IntAnnotation const & v)
     { os << v.value; return os; }
-    
+
     struct LargeAnnotation {
         char value[32];
     };
@@ -126,9 +132,12 @@ namespace {
 
     struct ComplexAnnotation : senf::ComplexAnnotation
     {
-        ComplexAnnotation() : s(), i() {}
+        ComplexAnnotation() : s("empty"), i(-1) {}
         std::string s;
-        int i;
+        boost::int32_t i;
+        // padding so the size does not depend on the platform ...
+        struct _ {std::string s;boost::int32_t i;};
+        char __ [32-sizeof(_)];
     };
 
     std::ostream & operator<<(std::ostream & os, ComplexAnnotation const & v)
@@ -152,12 +161,17 @@ namespace {
 
 SENF_AUTO_UNIT_TEST(packet)
 {
-    senf::Packet packet (FooPacket::create());    
+    BOOST_CHECK(! senf::Packet().is<BarPacket>() );
+    senf::Packet packet (FooPacket::create());
     BarPacket::createAfter(packet);
 
+    BOOST_CHECK_THROW( senf::Packet().as<BarPacket>(), senf::WrapException<std::bad_cast> );
+    BOOST_CHECK_THROW( packet.as<BarPacket>(), senf::WrapException<std::bad_cast> );
+
     BOOST_REQUIRE( packet );
     BOOST_CHECK( packet.next() );
     BOOST_CHECK( ! packet.next().next(senf::nothrow) );
+    BOOST_CHECK( ! packet.next().next(senf::nothrow).is<BarPacket>() );
     BOOST_CHECK( ! packet.prev(senf::nothrow) );
     BOOST_CHECK( packet.next().prev() == packet );
     SENF_CHECK_NOT_EQUAL( packet.next(), packet );
@@ -171,17 +185,28 @@ SENF_AUTO_UNIT_TEST(packet)
     BOOST_CHECK( packet.next().is<BarPacket>() );
     BOOST_CHECK( packet.first() == packet );
     BOOST_CHECK( packet.last() == packet.next() );
-    
+
+    BOOST_CHECK( ! packet.is_shared() );
+    {
+        senf::Packet p2 (packet);
+        BOOST_CHECK( packet.is_shared() );
+        BOOST_CHECK( p2.is_shared() );
+    }
+    BOOST_CHECK( ! packet.is_shared() );
+
     senf::Packet p2 (packet.next());
     BOOST_CHECK( p2 );
+    BOOST_CHECK( packet.is_shared() );
+    BOOST_CHECK( p2.is_shared() );
     packet.parseNextAs<FooPacket>();
     BOOST_CHECK_EQUAL( packet.size(), 12u );
     BOOST_CHECK_EQUAL( packet.next().size(), 8u );
     BOOST_CHECK( packet.next().is<FooPacket>() );
     BOOST_CHECK( ! p2 );
     BOOST_CHECK( packet.next().as<FooPacket>() );
-    
+
     p2 = packet.next().clone();
+    BOOST_CHECK( ! packet.is_shared() );
     BOOST_REQUIRE( p2 );
     packet.next().append( p2 );
     BOOST_REQUIRE( packet.next().next() );
@@ -193,19 +218,18 @@ SENF_AUTO_UNIT_TEST(packet)
     BOOST_CHECK_EQUAL( senf::PacketRegistry<RegTag>::key(packet), 1u );
     packet.next().parseNextAs( senf::PacketRegistry<RegTag>::lookup(2u).factory() );
     BOOST_CHECK( packet.next().next().is<BarPacket>() );
-    
+
     std::stringstream s;
     packet.dump(s);
-    BOOST_CHECK_EQUAL( s.str(), 
+    BOOST_CHECK_EQUAL( s.str(),
                        "Annotations:\n"
-                       "  (anonymous namespace)::ComplexAnnotation: no value\n"
-                       "  (anonymous namespace)::IntAnnotation: 0\n"
+                       "  (anonymous namespace)::IntAnnotation : 0\n"
                        "BarPacket:\n"
-                       "  type: 0\n"
-                       "  length: 0\n" );
-    
+                       "  type                    : 0\n"
+                       "  length                  : 0\n" );
+
     packet.finalizeAll();
-    BOOST_CHECK_EQUAL( packet.last().as<BarPacket>()->type(), 
+    BOOST_CHECK_EQUAL( packet.last().as<BarPacket>()->type(),
                        BarPacket::Parser::type_t::value_type(-1) );
     packet.last().append(FooPacket::create());
     packet.finalizeThis();
@@ -236,7 +260,7 @@ SENF_AUTO_UNIT_TEST(packet)
     BOOST_CHECK( packet.last().rfind<FooPacket>() == packet.last() );
     BOOST_CHECK( packet.next<BarPacket>() == packet.next() );
     BOOST_CHECK( packet.last().prev().prev<FooPacket>() == packet );
-    
+
     senf::DataPacket::createAfter(packet);
     BOOST_CHECK_THROW( packet.next().next().next().parseNextAs<BarPacket>(),
             senf::InvalidPacketChainException );
@@ -268,19 +292,34 @@ SENF_AUTO_UNIT_TEST(concretePacket)
     // No 'u' suffix here to check, that the disable_if works ...
     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,10).size(), 10u );
     BOOST_CHECK_EQUAL( packet.size(), 14u );
-    
+
     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,2u,senf::noinit).size(), 2u );
     BOOST_CHECK_EQUAL( packet.size(), 6u );
-    
+
     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,data).size(), 6u );
     BOOST_CHECK_EQUAL( packet.size(), 10u );
-    
+
     BOOST_CHECK_EQUAL( FooPacket::createBefore(packet).size(), 14u );
     BOOST_CHECK_EQUAL( packet.size(), 10u );
 
     BOOST_CHECK_EQUAL( FooPacket::createBefore(packet,senf::noinit).size(), 10u );
     BOOST_CHECK_EQUAL( packet.size(), 10u );
 
+    BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet).size(), 14u );
+    BOOST_CHECK_EQUAL( packet.size(), 10u );
+    BOOST_REQUIRE( packet.prev() );
+    BOOST_CHECK_EQUAL( packet.prev().size(), 14u );
+    BOOST_REQUIRE( packet.prev().prev() );
+    BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
+
+    BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet,senf::noinit).size(), 10u );
+    BOOST_CHECK_EQUAL( packet.size(), 10u );
+    BOOST_REQUIRE_NO_THROW( packet.prev().prev().prev() );
+    BOOST_CHECK_THROW( packet.prev().prev().prev().prev(), senf::InvalidPacketChainException );
+    BOOST_CHECK_EQUAL( packet.prev().size(), 10u );
+    BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
+    BOOST_CHECK_EQUAL( packet.prev().prev().prev().size(), 14u );
+
     SENF_CHECK_NOT_EQUAL( packet.clone(), packet );
     BOOST_CHECK_EQUAL( BarPacket::create()->reserved(), 0xA0A0u );
 }
@@ -292,16 +331,22 @@ SENF_AUTO_UNIT_TEST(packetAssign)
 
     bar2->type() << 0x2A2Bu;
     bar1.parser() << bar2;
-    
+
     BOOST_CHECK_EQUAL( bar1->type(), 0x2A2Bu );
 }
 
 SENF_AUTO_UNIT_TEST(packetAnnotation)
 {
+    typedef senf::detail::AnnotationRegistry Reg;
+
     senf::Packet packet (FooPacket::create());
     BarPacket::createAfter(packet);
 
     ComplexAnnotation & ca (packet.annotation<ComplexAnnotation>());
+
+    BOOST_CHECK_EQUAL( ca.s, "empty" );
+    BOOST_CHECK_EQUAL( ca.i, -1 );
+
     ca.s = "dead beef";
     ca.i = 0x12345678;
     SENF_CHECK_NO_THROW( packet.annotation<IntAnnotation>().value = 0xDEADBEEF );
@@ -312,10 +357,33 @@ SENF_AUTO_UNIT_TEST(packetAnnotation)
     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().s, "dead beef" );
     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().i, 0x12345678 );
 
-    BOOST_CHECK( senf::detail::AnnotationIndexer<IntAnnotation>::Small );
-    BOOST_CHECK( ! senf::detail::AnnotationIndexer<LargeAnnotation>::Small );
-    BOOST_CHECK( ! senf::detail::AnnotationIndexer<ComplexAnnotation>::Small );
-    BOOST_CHECK( ! senf::detail::AnnotationIndexer<ComplexEmptyAnnotation>::Small );
+    senf::Packet pClone (packet.clone());
+
+    p2.clearAnnotations();
+    BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().s, "empty" );
+    BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().i, -1 );
+    BOOST_CHECK_EQUAL( p2.annotation<IntAnnotation>().value, 0 );
+
+    BOOST_CHECK_EQUAL( pClone.annotation<IntAnnotation>().value, 0xDEADBEEFu );
+    BOOST_CHECK_EQUAL( pClone.annotation<ComplexAnnotation>().s, "dead beef" );
+    BOOST_CHECK_EQUAL( pClone.annotation<ComplexAnnotation>().i, 0x12345678 );
+
+    BOOST_CHECK( Reg::lookup<IntAnnotation>() >= 0 );
+    BOOST_CHECK( Reg::lookup<LargeAnnotation>() < 0 );
+    BOOST_CHECK( Reg::lookup<ComplexAnnotation>() < 0 );
+    BOOST_CHECK( Reg::lookup<ComplexEmptyAnnotation>() < 0 );
+
+    std::stringstream ss;
+    senf::dumpPacketAnnotationRegistry(ss);
+    BOOST_CHECK_EQUAL(
+        ss.str(),
+        "SENF_PACKET_ANNOTATION_SLOTS = 8\n"
+        "SENF_PACKET_ANNOTATION_SLOTSIZE = 16\n"
+        "TYPE                                                      FAST  COMPLEX   SIZE\n"
+        "(anonymous namespace)::ComplexAnnotation                  no    yes         32\n"
+        "(anonymous namespace)::ComplexEmptyAnnotation             no    yes          1\n"
+        "(anonymous namespace)::IntAnnotation                      yes   no           4\n"
+        "(anonymous namespace)::LargeAnnotation                    no    no          32\n" );
 }
 
 #ifdef COMPILE_CHECK
@@ -326,7 +394,7 @@ COMPILE_FAIL(invalidAnnotation)
 #   ifdef BOOST_HAS_TYPE_TRAITS_INTRINSICS
 
     senf::Packet packet (FooPacket::create());
-    (void) packet.annotation<InvalidAnnotation>();
+    senf::IGNORE( packet.annotation<InvalidAnnotation>() );
 
 #   else
 #   endif
@@ -338,7 +406,7 @@ COMPILE_FAIL(invalidAnnotation)
 
 #endif
 
-///////////////////////////////cc.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 
 \f