SafeIterator.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Packets_SafeIterator_
#define HH_SENF_Packets_SafeIterator_ 1

#ifndef HH_SENF_Packets_Packets_
#error "Don't include 'SafeIterator.hh' directly, include 'Packets.hh'"
#endif

// Custom includes
#include <boost/iterator/iterator_facade.hpp>
#include <senf/Utils/safe_bool.hh>

#include "SafeIterator.ih"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    class PacketParserBase;


    class safe_data_iterator
        : public boost::iterator_facade< safe_data_iterator,
                                         PacketData::value_type,
                                         boost::random_access_traversal_tag >,
          public senf::detail::packet::safe_data_iterator_base<PacketData::iterator>
    {
        typedef senf::detail::packet::safe_data_iterator_base<PacketData::iterator> Base;
    public:
        typedef PacketData::size_type size_type;

        safe_data_iterator(); 
        explicit safe_data_iterator(PacketData & data);
        safe_data_iterator(PacketData & data, PacketData::iterator i);
        explicit safe_data_iterator(PacketParserBase const & parser);

        safe_data_iterator & operator=(PacketData::iterator i); 

        safe_data_iterator & operator=(PacketParserBase const & parser);

        PacketData & data() const;      

    private:
        friend class boost::iterator_core_access;

        // iterator_facade interface

        value_type & dereference() const;
        bool equal(safe_data_iterator const & other) const;
        difference_type distance_to(safe_data_iterator const & other) const;
        void increment();
        void decrement();
        void advance(difference_type n);
    };

    template <class Parser>
    class SafePacketParserWrapper
        : public safe_bool< SafePacketParserWrapper<Parser> >
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        //-////////////////////////////////////////////////////////////////////////
        //\{

        // default copy constructor
        // default copy assignment
        // default destructor
        SafePacketParserWrapper();             

        // conversion constructors
        SafePacketParserWrapper(Parser parser); 

        SafePacketParserWrapper & operator=(Parser parser); 

        //\}
        //-////////////////////////////////////////////////////////////////////////

        Parser & operator*() const;       

        Parser * operator->() const; 

        bool boolean_test() const;      

    protected:

    private:
        mutable boost::optional<Parser> parser_;
        senf::safe_data_iterator i_;
    };

}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#endif
#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_SafeIterator_i_)
#define HH_SENF_Packets_SafeIterator_i_
#include "SafeIterator.cci"
//#include "SafeIterator.ct"
#include "SafeIterator.cti"
#endif

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