xref: /freebsd/contrib/kyua/utils/format/formatter.ipp (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1// Copyright 2010 The Kyua Authors.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8// * Redistributions of source code must retain the above copyright
9//   notice, this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright
11//   notice, this list of conditions and the following disclaimer in the
12//   documentation and/or other materials provided with the distribution.
13// * Neither the name of Google Inc. nor the names of its contributors
14//   may be used to endorse or promote products derived from this software
15//   without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29#if !defined(UTILS_FORMAT_FORMATTER_IPP)
30#define UTILS_FORMAT_FORMATTER_IPP
31
32#include <ostream>
33
34#include "utils/format/formatter.hpp"
35
36namespace utils {
37namespace format {
38
39
40/// Replaces the first format placeholder in a formatter.
41///
42/// Constructs a new formatter object that has one less formatting placeholder,
43/// as this has been replaced by the provided argument.  Calling this operator
44/// N times, where N is the number of formatting placeholders, effectively
45/// formats the string.
46///
47/// \param arg The argument to use as replacement for the format placeholder.
48///
49/// \return A new formatter that has one less format placeholder.
50template< typename Type >
51inline formatter
52formatter::operator%(const Type& arg) const
53{
54    (*_oss) << arg;
55    return replace(_oss->str());
56}
57
58
59/// Inserts a formatter string into a stream.
60///
61/// \param os The output stream.
62/// \param f The formatter to process and inject into the stream.
63///
64/// \return The output stream os.
65inline std::ostream&
66operator<<(std::ostream& os, const formatter& f)
67{
68    return (os << f.str());
69}
70
71
72}  // namespace format
73}  // namespace utils
74
75
76#endif  // !defined(UTILS_FORMAT_FORMATTER_IPP)
77