1// Copyright 2010 Google Inc.
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/// \file utils/format/macros.hpp
30/// Convenience macros to simplify usage of the format library.
31///
32/// This file <em>must not be included from other header files</em>.
33
34#if !defined(UTILS_FORMAT_MACROS_HPP)
35#define UTILS_FORMAT_MACROS_HPP
36
37// We include the .ipp file instead of .hpp because, after all, macros.hpp
38// is provided purely for convenience and must not be included from other
39// header files.  Henceforth, we make things easier to the callers.
40#include "utils/format/formatter.ipp"
41
42
43/// Constructs a utils::format::formatter object with the given format string.
44///
45/// This macro is just a wrapper to make the construction of
46/// utils::format::formatter objects shorter, and thus to allow inlining these
47/// calls right in where formatted strings are required.  A typical usage would
48/// look like:
49///
50/// \code
51/// std::cout << F("%s %d\n") % my_str % my_int;
52/// \endcode
53///
54/// \param fmt The format string.
55#define F(fmt) utils::format::formatter(fmt)
56
57
58#endif  // !defined(UTILS_FORMAT_MACROS_HPP)
59