paludis  Version 2.6.0
join.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2005, 2006, 2007, 2009 Ciaran McCreesh
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_PALUDIS_JOIN_HH
21 #define PALUDIS_GUARD_PALUDIS_JOIN_HH 1
22 
24 #include <iterator>
25 #include <string>
26 
27 /** \file
28  * Declarations for the join function.
29  *
30  * \ingroup g_strings
31  *
32  * \section Examples
33  *
34  * - None at this time.
35  */
36 
37 namespace paludis
38 {
39  /**
40  * Join together the items from i to end using joiner.
41  *
42  * \ingroup g_strings
43  */
44  template <typename I_, typename T_>
45  T_ join(I_ i, I_ end, const T_ & joiner)
46  {
47  T_ result;
48  if (i != end)
49  while (true)
50  {
51  result += stringify(*i);
52  if (++i == end)
53  break;
54  result += joiner;
55  }
56  return result;
57  }
58 
59  /**
60  * Join together the items from i to end using joiner, using
61  * a function other than stringify.
62  *
63  * \ingroup g_strings
64  */
65  template <typename I_, typename T_, typename F_>
66  T_ join(I_ i, I_ end, const T_ & joiner, const F_ & f)
67  {
68  T_ result;
69  if (i != end)
70  while (true)
71  {
72  result += (f)(*i);
73  if (++i == end)
74  break;
75  result += joiner;
76  }
77  return result;
78  }
79 
80  /**
81  * Convenience alternative join allowing a char * to be used for a
82  * string.
83  *
84  * \ingroup g_strings
85  */
86  template <typename I_>
87  std::string join(I_ begin, const I_ end, const char * const t)
88  {
89  return join(begin, end, std::string(t));
90  }
91 
92  /**
93  * Convenience alternative join allowing a char * to be used for a
94  * string, using a function other than stringify.
95  *
96  * \ingroup g_strings
97  */
98  template <typename I_, typename F_>
99  std::string join(I_ begin, const I_ end, const char * const t, const F_ & f)
100  {
101  return join(begin, end, std::string(t), f);
102  }
103 }
104 
105 #endif
Definition: about_metadata-fwd.hh:23
T_ join(I_ i, I_ end, const T_ &joiner)
Definition: join.hh:45
std::string stringify(const T_ &item)
Definition: stringify.hh:166