switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / SafeIterator.cci
1 // $Id$
2 //
3 // Copyright (C) 2008
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27
28 /** \file
29     \brief SafeIterator inline non-template implementation */
30
31 //#include "SafeIterator.ih"
32
33 // Custom includes
34
35 #define prefix_ inline
36 //-/////////////////////////////////////////////////////////////////////////////////////////////////
37
38 //-/////////////////////////////////////////////////////////////////////////////////////////////////
39 // senf::safe_data_iterator
40
41 prefix_ senf::safe_data_iterator::safe_data_iterator()
42     : data_(0), i_(0)
43 {}
44
45 prefix_  senf::safe_data_iterator::safe_data_iterator(PacketData & data)
46     : data_(&data), i_(0)
47 {}
48
49 prefix_ senf::safe_data_iterator::safe_data_iterator(PacketData & data, PacketData::iterator i)
50     : data_(&data), i_(std::distance(data.begin(),i))
51 {}
52
53 prefix_  senf::safe_data_iterator::safe_data_iterator(PacketParserBase const & parser)
54     : data_(&parser.data()), i_(std::distance(data_->begin(),parser.i()))
55 {}
56
57 prefix_ senf::PacketData::iterator senf::safe_data_iterator::i()
58     const
59 {
60     SENF_ASSERT(data_, "Use/dereferencing of empty safe_data_iterator");
61     return boost::next(data_->begin(),i_);
62 }
63
64 prefix_ senf::safe_data_iterator & senf::safe_data_iterator::operator=(PacketData::iterator i)
65 {
66     SENF_ASSERT(data_, "Use/dereferencing of empty safe_data_iterator");
67     i_ = std::distance(data_->begin(),i);
68     return *this;
69 }
70
71 prefix_ senf::safe_data_iterator &
72 senf::safe_data_iterator::operator=(PacketParserBase const & parser)
73 {
74     data_ = &parser.data();
75     i_ = std::distance(data_->begin(),parser.i());
76     return *this;
77 }
78
79 prefix_ senf::safe_data_iterator::operator senf::PacketData::iterator()
80     const
81 {
82     return i();
83 }
84
85 prefix_ bool senf::safe_data_iterator::boolean_test()
86     const
87 {
88     return data_;
89 }
90
91 prefix_ senf::PacketData & senf::safe_data_iterator::data()
92     const
93 {
94     SENF_ASSERT(data_, "Use/dereferencing of empty safe_data_iterator");
95     return *data_;
96 }
97
98 prefix_ senf::safe_data_iterator::value_type & senf::safe_data_iterator::dereference()
99     const
100 {
101     return *i();
102 }
103
104 prefix_ bool senf::safe_data_iterator::equal(safe_data_iterator const & other)
105     const
106 {
107     SENF_ASSERT(data_ == other.data_, "Comparing iterators of two different containers is invalid");
108     return i_ == other.i_;
109 }
110
111 prefix_ senf::safe_data_iterator::difference_type
112 senf::safe_data_iterator::distance_to(safe_data_iterator const & other)
113     const
114 {
115     SENF_ASSERT(data_ == other.data_, "Comparing iterators of two different containers is invalid");
116     return other.i_ - i_;
117 }
118
119 prefix_ void senf::safe_data_iterator::increment()
120 {
121     ++i_;
122 }
123
124 prefix_ void senf::safe_data_iterator::decrement()
125 {
126     SENF_ASSERT(i_>0, "Decrementing iterator before beginning of container" );
127     --i_;
128 }
129
130 prefix_ void senf::safe_data_iterator::advance(difference_type n)
131 {
132     SENF_ASSERT( -n < difference_type(i_), "Moving iterator to before beginning of container" );
133     i_ += n;
134 }
135
136 //-/////////////////////////////////////////////////////////////////////////////////////////////////
137 #undef prefix_
138
139 \f
140 // Local Variables:
141 // mode: c++
142 // fill-column: 100
143 // comment-column: 40
144 // c-file-style: "senf"
145 // indent-tabs-mode: nil
146 // ispell-local-dictionary: "american"
147 // compile-command: "scons -u test"
148 // End: