Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
site_iterator_base.hh
1 // Copyright (C) 2008, 2009 EPITA Research and Development Laboratory
2 // (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef MLN_CORE_INTERNAL_SITE_ITERATOR_BASE_HH
28 # define MLN_CORE_INTERNAL_SITE_ITERATOR_BASE_HH
29 
33 
34 
35 # include <mln/core/concept/site_iterator.hh>
36 # include <mln/core/concept/pseudo_site.hh> // Use of if_possible::change_target.
37 
38 
39 
40 namespace mln
41 {
42 
43  namespace internal
44  {
45 
56  template <typename S, typename E>
57  struct site_iterator_base : Site_Iterator<E>,
58  proxy_impl< const mln_psite(S)&, E>
59  {
61  typedef S target;
62 
64  typedef mln_site(S) site;
65 
67  const mln_site(S)& to_site() const;
68 
69 
70  // Technical note:
71  //
72  // A conversion operator towards the site it designates is
73  // not required since it is inherited from 'proxy_impl'.
74  // Defining '::operator mln_site(S)() const' here can lead to
75  // ambiguities in very special cases since we inherit a couple
76  // of conversions (const and non-const)
77 
78 
80  const mln_psite(S)& subj_();
81 
83  const S*& target_();
84 
85  protected:
86 
87  site_iterator_base();
88 
90  const S* s_;
91 
92  private:
93 
94  typedef proxy_impl< const mln_psite(S)&, E> super_;
95  };
96 
97 
98 #ifndef MLN_INCLUDE_ONLY
99 
100  template <typename S, typename E>
101  inline
102  site_iterator_base<S, E>::site_iterator_base()
103  : s_(0)
104  {
105  }
106 
107  template <typename S, typename E>
108  inline
109  const mln_site(S)&
110  site_iterator_base<S, E>::to_site() const
111  {
112  mln_precondition(exact(*this).is_valid());
113  return this->get_subject();
114  }
115 
116  template <typename S, typename E>
117  inline
118  const mln_psite(S)&
119  site_iterator_base<S, E>::subj_()
120  {
121  return exact(this)->p_hook_();
122  }
123 
124  template <typename S, typename E>
125  inline
126  const S*&
127  site_iterator_base<S, E>::target_()
128  {
129  return s_;
130  }
131 
132 #endif // ! MLN_INCLUDE_ONLY
133 
134  } // end of namespace internal
135 
136 } // end of namespace mln
137 
138 
139 #endif // ! MLN_CORE_INTERNAL_SITE_ITERATOR_BASE_HH