Mercurial > code

annotate cpp/join/join.hpp @ 621:ca5912ad2909

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Misc: massive refactoring, closes #717
author David Demelier <markand@malikania.fr>
date Fri, 20 Oct 2017 12:36:51 +0200
parents modules/join/join.hpp@266f32919d0a
children b327391f6a62
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
615
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * join.hpp -- join lists into a string
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
617
266f32919d0a Misc: update copyright headers, closes #686
David Demelier <markand@malikania.fr>
parents: 615
diff changeset
4 * Copyright (c) 2013-2017 David Demelier <markand@malikania.fr>
615
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 /**
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 * \file join.hpp
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 * \brief Join function
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 */
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 /**
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 * Join values by a separator and return a string.
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 *
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 * \param first the first iterator
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 * \param last the last iterator
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 * \param delim the optional delimiter
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * \return the string
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 */
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 template <typename InputIt, typename DelimType = char>
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 std::string join(InputIt first, InputIt last, DelimType delim = ':')
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 {
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 std::ostringstream oss;
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 if (first != last) {
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 oss << *first;
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 while (++first != last)
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 oss << delim << *first;
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 }
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 return oss.str();
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 }
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 /**
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * Convenient overload.
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 *
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * \param list the initializer list
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * \param delim the delimiter
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 * \return the string
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 */
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 template <typename T, typename DelimType = char>
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 inline std::string join(std::initializer_list<T> list, DelimType delim = ':')
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 {
e8661a550a12 Join: dedicate new module directory, #684
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 return join(list.begin(), list.end(), delim);
617
266f32919d0a Misc: update copyright headers, closes #686
David Demelier <markand@malikania.fr>
parents: 615
diff changeset
58 }