const_child_iterator.hpp revision 169691 
1// -*- C++ -*-
2
3// Copyright (C) 2005, 2006 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library.  This library is free
6// software; you can redistribute it and/or modify it under the terms
7// of the GNU General Public License as published by the Free Software
8// Foundation; either version 2, or (at your option) any later
9// version.
10
11// This library is distributed in the hope that it will be useful, but
12// WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14// General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this library; see the file COPYING.  If not, write to
18// the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
19// MA 02111-1307, USA.
20
21// As a special exception, you may use this file as part of a free
22// software library without restriction.  Specifically, if other files
23// instantiate templates or use macros or inline functions from this
24// file, or you compile this file and link it with other files to
25// produce an executable, this file does not by itself cause the
26// resulting executable to be covered by the GNU General Public
27// License.  This exception does not however invalidate any other
28// reasons why the executable file might be covered by the GNU General
29// Public License.
30
31// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
32
33// Permission to use, copy, modify, sell, and distribute this software
34// is hereby granted without fee, provided that the above copyright
35// notice appears in all copies, and that both that copyright notice
36// and this permission notice appear in supporting documentation. None
37// of the above authors, nor IBM Haifa Research Laboratories, make any
38// representation about the suitability of this software for any
39// purpose. It is provided "as is" without express or implied
40// warranty.
41
42/**
43 * @file const_child_iterator.hpp
44 * Contains a const_iterator for a patricia tree.
45 */
46
47struct const_iterator
48{
49public:
50  typedef std::forward_iterator_tag iterator_category;
51
52  typedef typename Allocator::difference_type difference_type;
53
54  typedef node_pointer value_type;
55
56  typedef node_pointer_pointer pointer;
57
58  typedef node_pointer_reference reference;
59
60public:
61  inline
62  const_iterator(node_pointer_pointer p_p_cur = NULL,
63		 node_pointer_pointer p_p_end = NULL)
64  : m_p_p_cur(p_p_cur), m_p_p_end(p_p_end)
65  { }
66
67  inline bool
68  operator==(const const_iterator& other) const
69  { return m_p_p_cur == other.m_p_p_cur; }
70
71  inline bool
72  operator!=(const const_iterator& other) const
73  { return m_p_p_cur != other.m_p_p_cur; }
74
75  inline const_iterator&
76  operator++()
77  {
78    do
79      ++m_p_p_cur;
80    while (m_p_p_cur != m_p_p_end&& * m_p_p_cur == NULL);
81    return *this;
82  }
83
84  inline const_iterator
85  operator++(int)
86  {
87    const_iterator ret_it(*this);
88    operator++();
89    return ret_it;
90  }
91
92  const node_pointer_pointer
93  operator->() const
94  {
95    _GLIBCXX_DEBUG_ONLY(assert_referencible();)
96    return (m_p_p_cur);
97  }
98
99  const_node_pointer
100  operator*() const
101  {
102    _GLIBCXX_DEBUG_ONLY(assert_referencible();)
103    return (*m_p_p_cur);
104  }
105
106protected:
107#ifdef _GLIBCXX_DEBUG
108  void
109  assert_referencible() const
110  { _GLIBCXX_DEBUG_ASSERT(m_p_p_cur != m_p_p_end&& * m_p_p_cur != NULL); }
111#endif
112
113public:
114  node_pointer_pointer m_p_p_cur;
115  node_pointer_pointer m_p_p_end;
116};
117
118