1// (C) Copyright Gennadiy Rozental 2001.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at
4// http://www.boost.org/LICENSE_1_0.txt)
5
6// See http://www.boost.org/libs/test for the library home page.
7//
8// File : $RCSfile$
9//
10// Version : $Revision$
11//
12// Description : token iterator for string and range tokenization
13// ***************************************************************************
14
15#ifndef BOOST_TEST_UTILS_TOKEN_ITERATOR_HPP
16#define BOOST_TEST_UTILS_TOKEN_ITERATOR_HPP
17
18// Boost
19#include <boost/config.hpp>
20#include <boost/detail/workaround.hpp>
21
22#include <boost/iterator/iterator_categories.hpp>
23#include <boost/iterator/iterator_traits.hpp>
24
25#include <boost/test/utils/iterator/input_iterator_facade.hpp>
26#include <boost/test/utils/basic_cstring/basic_cstring.hpp>
27#include <boost/test/utils/named_params.hpp>
28#include <boost/test/utils/foreach.hpp>
29
30// STL
31#include <iosfwd>
32#include <cctype>
33
34#include <boost/test/detail/suppress_warnings.hpp>
35
36//____________________________________________________________________________//
37
38#ifdef BOOST_NO_STDC_NAMESPACE
39namespace std{ using ::ispunct; using ::isspace; }
40#endif
41
42namespace boost {
43namespace unit_test {
44namespace utils {
45
46// ************************************************************************** //
47// ************** ti_delimeter_type ************** //
48// ************************************************************************** //
49
50enum ti_delimeter_type {
51 dt_char, // character is delimeter if it among explicit list of some characters
52 dt_ispunct, // character is delimeter if it satisfies ispunct functor
53 dt_isspace, // character is delimeter if it satisfies isspace functor
54 dt_none // no character is delimeter
55};
56
57namespace ut_detail {
58
59// ************************************************************************** //
60// ************** default_char_compare ************** //
61// ************************************************************************** //
62
63template<typename CharT>
64class default_char_compare {
65public:
66 bool operator()( CharT c1, CharT c2 )
67 {
68#ifdef BOOST_CLASSIC_IOSTREAMS
69 return std::string_char_traits<CharT>::eq( c1, c2 );
70#else
71 return std::char_traits<CharT>::eq( c1, c2 );
72#endif
73 }
74};
75
76// ************************************************************************** //
77// ************** delim_policy ************** //
78// ************************************************************************** //
79
80template<typename CharT,typename CharCompare>
81class delim_policy {
82 typedef basic_cstring<CharT const> cstring;
83public:
84 // Constructor
85 explicit delim_policy( ti_delimeter_type type_ = dt_char, cstring delimeters_ = cstring() )
86 : m_type( type_ )
87 {
88 set_delimeters( delimeters_ );
89 }
90
91 void set_delimeters( ti_delimeter_type type_ ) { m_type = type_; }
92 void set_delimeters( cstring delimeters_ )
93 {
94 m_delimeters = delimeters_;
95
96 if( !m_delimeters.is_empty() )
97 m_type = dt_char;
98 }
99 void set_delimeters( nfp::nil ) {}
100 bool operator()( CharT c )
101 {
102 switch( m_type ) {
103 case dt_char: {
104 BOOST_TEST_FOREACH( CharT, delim, m_delimeters )
105 if( CharCompare()( delim, c ) )
106 return true;
107
108 return false;
109 }
110 case dt_ispunct:
111 return (std::ispunct)( c ) != 0;
112 case dt_isspace:
113 return (std::isspace)( c ) != 0;
114 case dt_none:
115 return false;
116 }
117
118 return false;
119 }
120
121private:
122 // Data members
123 cstring m_delimeters;
124 ti_delimeter_type m_type;
125};
126
127// ************************************************************************** //
128// ************** token_assigner ************** //
129// ************************************************************************** //
130
131template<typename TraversalTag>
132struct token_assigner {
133#if BOOST_WORKAROUND( BOOST_DINKUMWARE_STDLIB, < 306 )
134 template<typename Iterator, typename C, typename T>
135 static void assign( Iterator b, Iterator e, std::basic_string<C,T>& t )
136 { for( ; b != e; ++b ) t += *b; }
137
138 template<typename Iterator, typename C>
139 static void assign( Iterator b, Iterator e, basic_cstring<C>& t ) { t.assign( b, e ); }
140#else
141 template<typename Iterator, typename Token>
142 static void assign( Iterator b, Iterator e, Token& t ) { t.assign( b, e ); }
143#endif
144 template<typename Iterator, typename Token>
145 static void append_move( Iterator& b, Token& ) { ++b; }
146};
147
148//____________________________________________________________________________//
149
150template<>
151struct token_assigner<single_pass_traversal_tag> {
152 template<typename Iterator, typename Token>
153 static void assign( Iterator /*b*/, Iterator /*e*/, Token& /*t*/ ) {}
154
155 template<typename Iterator, typename Token>
156 static void append_move( Iterator& b, Token& t ) { t += *b; ++b; }
157};
158
159} // namespace ut_detail
160
161// ************************************************************************** //
162// ************** modifiers ************** //
163// ************************************************************************** //
164
165namespace {
166nfp::keyword<struct dropped_delimeters_t > dropped_delimeters;
167nfp::keyword<struct kept_delimeters_t > kept_delimeters;
168nfp::typed_keyword<bool,struct keep_empty_tokens_t > keep_empty_tokens;
169nfp::typed_keyword<std::size_t,struct max_tokens_t > max_tokens;
170}
171
172// ************************************************************************** //
173// ************** token_iterator_base ************** //
174// ************************************************************************** //
175
176template<typename Derived,
177 typename CharT,
178 typename CharCompare = ut_detail::default_char_compare<CharT>,
179 typename ValueType = basic_cstring<CharT const>,
180 typename Reference = basic_cstring<CharT const>,
181 typename Traversal = forward_traversal_tag>
182class token_iterator_base
183: public input_iterator_facade<Derived,ValueType,Reference,Traversal> {
184 typedef basic_cstring<CharT const> cstring;
185 typedef ut_detail::delim_policy<CharT,CharCompare> delim_policy;
186 typedef input_iterator_facade<Derived,ValueType,Reference,Traversal> base;
187
188protected:
189 // Constructor
190 explicit token_iterator_base()
191 : m_is_dropped( dt_isspace )
192 , m_is_kept( dt_ispunct )
193 , m_keep_empty_tokens( false )
194 , m_tokens_left( static_cast<std::size_t>(-1) )
195 , m_token_produced( false )
196 {
197 }
198
199 template<typename Modifier>
200 void
201 apply_modifier( Modifier const& m )
202 {
203 if( m.has( dropped_delimeters ) )
204 m_is_dropped.set_delimeters( m[dropped_delimeters] );
205
206 if( m.has( kept_delimeters ) )
207 m_is_kept.set_delimeters( m[kept_delimeters] );
208
209 if( m.has( keep_empty_tokens ) )
210 m_keep_empty_tokens = true;
211
212 nfp::opt_assign( m_tokens_left, m, max_tokens );
213 }
214
215 template<typename Iter>
216 bool get( Iter& begin, Iter end )
217 {
218 typedef ut_detail::token_assigner<BOOST_DEDUCED_TYPENAME iterator_traversal<Iter>::type> Assigner;
219 Iter check_point;
220
221 this->m_value.clear();
222
223 if( !m_keep_empty_tokens ) {
224 while( begin != end && m_is_dropped( *begin ) )
225 ++begin;
226
227 if( begin == end )
228 return false;
229
230 check_point = begin;
231
232 if( m_tokens_left == 1 )
233 while( begin != end )
234 Assigner::append_move( begin, this->m_value );
235 else if( m_is_kept( *begin ) )
236 Assigner::append_move( begin, this->m_value );
237 else
238 while( begin != end && !m_is_dropped( *begin ) && !m_is_kept( *begin ) )
239 Assigner::append_move( begin, this->m_value );
240
241 --m_tokens_left;
242 }
243 else { // m_keep_empty_tokens is true
244 check_point = begin;
245
246 if( begin == end ) {
247 if( m_token_produced )
248 return false;
249
250 m_token_produced = true;
251 }
252 if( m_is_kept( *begin ) ) {
253 if( m_token_produced )
254 Assigner::append_move( begin, this->m_value );
255
256 m_token_produced = !m_token_produced;
257 }
258 else if( !m_token_produced && m_is_dropped( *begin ) )
259 m_token_produced = true;
260 else {
261 if( m_is_dropped( *begin ) )
262 check_point = ++begin;
263
264 while( begin != end && !m_is_dropped( *begin ) && !m_is_kept( *begin ) )
265 Assigner::append_move( begin, this->m_value );
266
267 m_token_produced = true;
268 }
269 }
270
271 Assigner::assign( check_point, begin, this->m_value );
272
273 return true;
274 }
275
276private:
277 // Data members
278 delim_policy m_is_dropped;
279 delim_policy m_is_kept;
280 bool m_keep_empty_tokens;
281 std::size_t m_tokens_left;
282 bool m_token_produced;
283};
284
285// ************************************************************************** //
286// ************** basic_string_token_iterator ************** //
287// ************************************************************************** //
288
289template<typename CharT,
290 typename CharCompare = ut_detail::default_char_compare<CharT> >
291class basic_string_token_iterator
292: public token_iterator_base<basic_string_token_iterator<CharT,CharCompare>,CharT,CharCompare> {
293 typedef basic_cstring<CharT const> cstring;
294 typedef token_iterator_base<basic_string_token_iterator<CharT,CharCompare>,CharT,CharCompare> base;
295public:
296 explicit basic_string_token_iterator() {}
297 explicit basic_string_token_iterator( cstring src )
298 : m_src( src )
299 {
300 this->init();
301 }
302
303 template<typename Src, typename Modifier>
304 basic_string_token_iterator( Src src, Modifier const& m )
305 : m_src( src )
306 {
307 this->apply_modifier( m );
308
309 this->init();
310 }
311
312private:
313 friend class input_iterator_core_access;
314
315 // input iterator implementation
316 bool get()
317 {
318 typename cstring::iterator begin = m_src.begin();
319 bool res = base::get( begin, m_src.end() );
320
321 m_src.assign( begin, m_src.end() );
322
323 return res;
324 }
325
326 // Data members
327 cstring m_src;
328};
329
330typedef basic_string_token_iterator<char> string_token_iterator;
331typedef basic_string_token_iterator<wchar_t> wstring_token_iterator;
332
333// ************************************************************************** //
334// ************** range_token_iterator ************** //
335// ************************************************************************** //
336
337template<typename Iter,
338 typename CharCompare = ut_detail::default_char_compare<BOOST_DEDUCED_TYPENAME iterator_value<Iter>::type>,
339 typename ValueType = std::basic_string<BOOST_DEDUCED_TYPENAME iterator_value<Iter>::type>,
340 typename Reference = ValueType const&>
341class range_token_iterator
342: public token_iterator_base<range_token_iterator<Iter,CharCompare,ValueType,Reference>,
343 typename iterator_value<Iter>::type,CharCompare,ValueType,Reference> {
344 typedef basic_cstring<typename ValueType::value_type> cstring;
345 typedef token_iterator_base<range_token_iterator<Iter,CharCompare,ValueType,Reference>,
346 typename iterator_value<Iter>::type,CharCompare,ValueType,Reference> base;
347public:
348 explicit range_token_iterator() {}
349 explicit range_token_iterator( Iter begin, Iter end = Iter() )
350 : m_begin( begin ), m_end( end )
351 {
352 this->init();
353 }
354 range_token_iterator( range_token_iterator const& rhs )
355 : base( rhs )
356 {
357 if( this->m_valid ) {
358 m_begin = rhs.m_begin;
359 m_end = rhs.m_end;
360 }
361 }
362
363 template<typename Modifier>
364 range_token_iterator( Iter begin, Iter end, Modifier const& m )
365 : m_begin( begin ), m_end( end )
366 {
367 this->apply_modifier( m );
368
369 this->init();
370 }
371
372private:
373 friend class input_iterator_core_access;
374
375 // input iterator implementation
376 bool get()
377 {
378 return base::get( m_begin, m_end );
379 }
380
381 // Data members
382 Iter m_begin;
383 Iter m_end;
384};
385
386// ************************************************************************** //
387// ************** make_range_token_iterator ************** //
388// ************************************************************************** //
389
390template<typename Iter>
391inline range_token_iterator<Iter>
392make_range_token_iterator( Iter begin, Iter end = Iter() )
393{
394 return range_token_iterator<Iter>( begin, end );
395}
396
397//____________________________________________________________________________//
398
399template<typename Iter,typename Modifier>
400inline range_token_iterator<Iter>
401make_range_token_iterator( Iter begin, Iter end, Modifier const& m )
402{
403 return range_token_iterator<Iter>( begin, end, m );
404}
405
406//____________________________________________________________________________//
407
408} // namespace utils
409} // namespace unit_test
410} // namespace boost
411
412//____________________________________________________________________________//
413
414#include <boost/test/detail/enable_warnings.hpp>
415
416#endif // BOOST_TEST_UTILS_TOKEN_ITERATOR_HPP
417
418

source code of boost/boost/test/utils/iterator/token_iterator.hpp