// $Id$
//
// Copyright (C) 2007
// Fraunhofer Institute for Open Communication Systems (FOKUS)
//
// 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
//
// 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.
//
// 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 inline template implementation */

//#include "Packet.ih"

// Custom includes
#include <senf/Utils/Exception.hh>

#define prefix_ inline
//-/////////////////////////////////////////////////////////////////////////////////////////////////

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::Packet

// conversion constructors

template <class PacketType>
prefix_ senf::Packet::Packet(ConcretePacket<PacketType> const & packet)
    : packet_(packet.ptr())
{}

// interpreter chain access

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::parseNextAs()
    const
{
    return OtherPacket(ptr()->parseNextAs<typename OtherPacket::type>());
}

template <class OtherPacket>
prefix_ bool senf::Packet::is()
    const
{
    // ensure that the template class is included in the corresponding object file when linking:
    { static typename PacketInterpreter<typename OtherPacket::type>::factory_t _ (
            PacketInterpreter<typename OtherPacket::type>::factory()); (void) _;}
    return valid() && typeId() == typeIdValue<OtherPacket>();
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::as()
    const
{
    if (!is<OtherPacket>())
        throw WrapException<std::bad_cast>(std::bad_cast())
            << ": called packet::as() with wrong PacketType: "
            << (valid() ? typeId().prettyName() : "invalid packet")
            << " != " << prettyName(typeid(OtherPacket));
    return OtherPacket(ptr()->as<typename OtherPacket::type>());
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::as(NoThrow_t)
    const
{
    SENF_ASSERT( is<OtherPacket>(), "Bad cast, called packet::as(nothrow) with wrong PacketType");
    return OtherPacket(ptr()->as<typename OtherPacket::type>());
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::next()
    const
{
    return next().as<OtherPacket>();
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::next(NoThrow_t)
    const
{
    Packet p (next(nothrow));
    return p && p.is<OtherPacket>() ?
            OtherPacket(p.ptr()->as<typename OtherPacket::type>()) : OtherPacket();
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::find()
    const
{
    OtherPacket p (find<OtherPacket>(nothrow));
    if (!p) throw InvalidPacketChainException();
    return p;
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::prev()
    const
{
    return prev().as<OtherPacket>();
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::prev(NoThrow_t)
    const
{
    Packet p (prev(nothrow));
    return p && p.is<OtherPacket>() ?
            OtherPacket(p.ptr()->as<typename OtherPacket::type>()) : OtherPacket();
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::rfind()
    const
{
    OtherPacket p (rfind<OtherPacket>(nothrow));
    if (!p) throw InvalidPacketChainException();
    return p;
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::last()
    const
{
    return last().as<OtherPacket>();
}

template <class OtherPacket>
prefix_ OtherPacket senf::Packet::first()
    const
{
    return first().as<OtherPacket>();
}

template <class Other>
prefix_ void senf::Packet::finalizeTo()
{
    Packet p (find<Other>(nothrow));
    ptr()->finalizeTo(p ? p.ptr() : last().ptr());
}

template <class Annotation>
prefix_ Annotation & senf::Packet::annotation()
{
    return ptr()->annotation<Annotation>();
}

template <class Annotation>
prefix_ Annotation const & senf::Packet::annotation()
    const
{
    return ptr()->annotation<Annotation>();
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::ConcretePacket<PacketType>

// structors and default members

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>::ConcretePacket()
{}

template <class PacketType>
prefix_ typename senf::ConcretePacket<PacketType>::factory_t
senf::ConcretePacket<PacketType>::factory()
{
    return interpreter::factory();
}

// Create completely new packet

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::create()
{
    return ConcretePacket(interpreter::create());
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::create(senf::NoInit_t)
{
    return ConcretePacket(interpreter::create(senf::noinit));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::create(size_type size)
{
    return ConcretePacket(interpreter::create(size));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::create(size_type size, senf::NoInit_t)
{
    return ConcretePacket(interpreter::create(size,senf::noinit));
}

#ifndef DOXYGEN

template <class PacketType>
template <class ForwardReadableRange>
prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
create(ForwardReadableRange const & range,
       typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
{
    return ConcretePacket(interpreter::create(range));
}

#endif

// Create packet as new packet after a given packet

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createAfter(Packet const & packet)
{
    return ConcretePacket(interpreter::createAfter(packet.ptr()));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createAfter(Packet const & packet, senf::NoInit_t)
{
    return ConcretePacket(interpreter::createAfter(packet.ptr(),senf::noinit));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createAfter(Packet const & packet, size_type size)
{
    return ConcretePacket(interpreter::createAfter(packet.ptr(), size));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createAfter(Packet const & packet, size_type size,
                                              senf::NoInit_t)
{
    return ConcretePacket(interpreter::createAfter(packet.ptr(), size, senf::noinit));
}

#ifndef DOXYGEN

template <class PacketType>
template <class ForwardReadableRange>
prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
createAfter(Packet const & packet, ForwardReadableRange const & range,
            typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
{
    return ConcretePacket(interpreter::createAfter(packet.ptr(), range));
}

#endif

// Create packet as new packet (header) before a given packet

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createBefore(Packet const & packet)
{
    return ConcretePacket(interpreter::createBefore(packet.ptr()));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createBefore(Packet const & packet, senf::NoInit_t)
{
    return ConcretePacket(interpreter::createBefore(packet.ptr(), senf::noinit));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createInsertBefore(Packet const & packet)
{
    return ConcretePacket(interpreter::createInsertBefore(packet.ptr()));
}

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::createInsertBefore(Packet const & packet, senf::NoInit_t)
{
    return ConcretePacket(interpreter::createInsertBefore(packet.ptr(), senf::noinit));
}

// Create a clone of the current packet

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>
senf::ConcretePacket<PacketType>::clone()
    const
{
    return ConcretePacket(ptr()->clone());
}

// Field access

template <class PacketType>
prefix_ typename senf::ConcretePacket<PacketType>::Parser
senf::ConcretePacket<PacketType>::parser()
    const
{
    return ptr()->fields();
}

template <class PacketType>
prefix_ typename senf::ConcretePacket<PacketType>::ParserProxy
senf::ConcretePacket<PacketType>::operator->()
    const
{
    return ParserProxy(parser());
}

template <class PacketType>
prefix_ senf::Packet senf::ConcretePacket<PacketType>::next(NoThrow_t)
    const
{
    PacketInterpreterBase::ptr p (Packet::ptr()->next());
    if (p) return Packet(p);
    PacketInterpreterBase::optional_range r (type::nextPacketRange(*this));
    return (r && ! r->empty()) ? Packet(getNext(r)) : Packet();
}

// private members

template <class PacketType>
prefix_ senf::ConcretePacket<PacketType>::ConcretePacket(typename interpreter::ptr const & packet_)
    : Packet(packet_)
{}

template <class PacketType>
prefix_ typename senf::ConcretePacket<PacketType>::interpreter * senf::ConcretePacket<PacketType>::ptr()
    const
{
    return static_cast< PacketInterpreter<PacketType> *>( Packet::ptr().get());
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#undef prefix_


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: