4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief PacketImpl public header */
26 #ifndef HH_SENF_Packets_PacketImpl_
27 #define HH_SENF_Packets_PacketImpl_ 1
32 #include <boost/utility.hpp>
33 #include <boost/type_traits/is_base_of.hpp>
34 #include <boost/type_traits/has_trivial_constructor.hpp>
35 #include <boost/type_traits/has_trivial_destructor.hpp>
36 #include <boost/static_assert.hpp>
37 #include "../Utils/pool_alloc_mixin.hh"
38 #include "PacketTypes.hh"
39 #include "../Utils/singleton.hh"
41 //#include "PacketImpl.mpp"
42 ///////////////////////////////hh.p////////////////////////////////////////
46 /** \brief Marker base-class for complex annotations
48 This class is used as a base class to mark an annotation type as complex. A complex
49 annotation will have it's constructor/destructor called. Non-complex annotations will not
50 have their constructor called, they will be zero initialized. The destructor of non-complex
51 annotations is never called.
53 An annotation must be marked as complex if it is not <a
54 href="http://en.wikipedia.org/wiki/Plain_Old_Data_Structures">POD</a>. Simplified, an
55 annotation must be marked as ComplexAnnotation, if
57 \li it has a (user defined) constructor or destructor
58 \li it has any data members which have (user defined) constructors or destructors
60 \see \ref packet_usage_annotation
62 struct ComplexAnnotation {};
68 virtual ~AnnotationP();
71 template <class Annotation>
75 Annotation annotation;
78 union AnnotationEntry {
83 struct AnnotationIndexerBase
85 static unsigned maxAnnotations;
86 static std::vector<bool> & small();
89 template <class Annotation>
90 struct AnnotationIndexer
91 : public senf::singleton< AnnotationIndexer<Annotation> >,
92 public AnnotationIndexerBase
96 static unsigned index();
97 static bool const Complex = boost::is_base_of<ComplexAnnotation, Annotation>::value;
98 static bool const Small = (sizeof(Annotation) <= sizeof(AnnotationEntry) && ! Complex);
100 # ifdef BOOST_HAS_TYPE_TRAITS_INTRINSICS
102 BOOST_STATIC_ASSERT(( (boost::has_trivial_constructor<Annotation>::value
103 && boost::has_trivial_destructor<Annotation>::value)
109 template <class Annotation, bool Small = AnnotationIndexer<Annotation>::Small>
112 static Annotation & get(AnnotationEntry & e);
115 template <class Annotation>
116 struct GetAnnotation<Annotation, true>
118 static Annotation & get(AnnotationEntry & e);
121 /** \brief Internal: Packet data storage
125 This is the class holding the packet data and the interpreter chain. All manipulations of
126 the packet data are performed via the interface exported here. This is very important, since
127 PacketImpl will update the interpreters (that is the vector indices stored therein) whenever
131 : boost::noncopyable,
132 public pool_alloc_mixin<PacketImpl>
135 typedef senf::detail::packet::byte byte;
136 typedef senf::detail::packet::raw_container raw_container;
137 typedef senf::detail::packet::size_type size_type;
138 typedef senf::detail::packet::difference_type difference_type;
139 typedef senf::detail::packet::interpreter_list interpreter_list;
140 typedef senf::detail::packet::iterator iterator;
141 typedef senf::detail::packet::const_iterator const_iterator;
142 typedef senf::detail::packet::refcount_t refcount_t;
147 PacketImpl(size_type size, byte initValue);
148 template <class InputIterator>
149 PacketImpl(InputIterator b, InputIterator e);
152 // rerference/memory management
154 void add_ref(refcount_t n=1);
155 void release(refcount_t n=1);
156 refcount_t refcount() const;
160 PacketInterpreterBase * first();
161 PacketInterpreterBase * last();
163 PacketInterpreterBase * next(PacketInterpreterBase * p);
164 PacketInterpreterBase * prev(PacketInterpreterBase * p);
166 void appendInterpreter (PacketInterpreterBase * p);
167 void prependInterpreter (PacketInterpreterBase * p);
168 void truncateInterpreters (PacketInterpreterBase * p);
169 void truncateInterpretersBackwards (PacketInterpreterBase * p);
177 void insert(PacketData * self, iterator pos, byte v);
178 void insert(PacketData * self, iterator pos, size_type n, byte v);
179 template <class ForwardIterator>
180 void insert(PacketData * self, iterator pos, ForwardIterator f, ForwardIterator l);
182 void erase(PacketData * self, iterator pos);
183 void erase(PacketData * self, iterator first, iterator last);
184 void clear(PacketData * self);
186 void reserve(size_type n);
187 size_type capacity() const;
190 template <class Annotation>
191 Annotation & annotation();
193 /** \brief Internal: Keep PacketImpl instance alive
197 The Guard will keep the PacketImpl instance alive during a members execution time
198 It the refcount should drop to 0, PacketImpl will be deleted after the member
199 has completed executing.
202 Guard(PacketImpl * impl);
208 refcount_t refcount_;
210 interpreter_list interpreters_;
212 typedef std::vector<AnnotationEntry> Annotations;
213 Annotations annotations_;
215 void eraseInterpreters(interpreter_list::iterator b, interpreter_list::iterator e);
216 void updateIterators(PacketData * self, difference_type pos, difference_type n);
221 ///////////////////////////////hh.e////////////////////////////////////////
223 #if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketImpl_i_)
224 #define HH_SENF_Packets_PacketImpl_i_
225 #include "PacketImpl.cci"
226 //#include "PacketImpl.ct"
227 #include "PacketImpl.cti"
234 // c-file-style: "senf"
235 // indent-tabs-mode: nil
236 // ispell-local-dictionary: "american"
237 // compile-command: "scons -u test"
238 // comment-column: 40