]> Git Repo - VerusCoin.git/blame - src/tinyformat.h
Build fix
[VerusCoin.git] / src / tinyformat.h
CommitLineData
b77dfdc9
WL
1// tinyformat.h
2// Copyright (C) 2011, Chris Foster [chris42f (at) gmail (d0t) com]
3//
4// Boost Software License - Version 1.0
5//
6// Permission is hereby granted, free of charge, to any person or organization
7// obtaining a copy of the software and accompanying documentation covered by
8// this license (the "Software") to use, reproduce, display, distribute,
9// execute, and transmit the Software, and to prepare derivative works of the
10// Software, and to permit third-parties to whom the Software is furnished to
11// do so, all subject to the following:
12//
13// The copyright notices in the Software and this entire statement, including
14// the above license grant, this restriction and the following disclaimer,
15// must be included in all copies of the Software, in whole or in part, and
16// all derivative works of the Software, unless such copies or derivative
17// works are solely in the form of machine-executable object code generated by
18// a source language processor.
19//
20// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
23// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
24// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
25// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26// DEALINGS IN THE SOFTWARE.
27
28//------------------------------------------------------------------------------
29// Tinyformat: A minimal type safe printf replacement
30//
31// tinyformat.h is a type safe printf replacement library in a single C++
32// header file. Design goals include:
33//
34// * Type safety and extensibility for user defined types.
35// * C99 printf() compatibility, to the extent possible using std::ostream
36// * Simplicity and minimalism. A single header file to include and distribute
37// with your projects.
38// * Augment rather than replace the standard stream formatting mechanism
39// * C++98 support, with optional C++11 niceties
40//
41//
42// Main interface example usage
43// ----------------------------
44//
45// To print a date to std::cout:
46//
47// std::string weekday = "Wednesday";
48// const char* month = "July";
49// size_t day = 27;
50// long hour = 14;
51// int min = 44;
52//
53// tfm::printf("%s, %s %d, %.2d:%.2d\n", weekday, month, day, hour, min);
54//
55// The strange types here emphasize the type safety of the interface; it is
56// possible to print a std::string using the "%s" conversion, and a
57// size_t using the "%d" conversion. A similar result could be achieved
58// using either of the tfm::format() functions. One prints on a user provided
59// stream:
60//
61// tfm::format(std::cerr, "%s, %s %d, %.2d:%.2d\n",
62// weekday, month, day, hour, min);
63//
64// The other returns a std::string:
65//
66// std::string date = tfm::format("%s, %s %d, %.2d:%.2d\n",
67// weekday, month, day, hour, min);
68// std::cout << date;
69//
c5b9bd9c
DH
70// These are the three primary interface functions. There is also a
71// convenience function printfln() which appends a newline to the usual result
72// of printf() for super simple logging.
b77dfdc9
WL
73//
74//
75// User defined format functions
76// -----------------------------
77//
78// Simulating variadic templates in C++98 is pretty painful since it requires
79// writing out the same function for each desired number of arguments. To make
80// this bearable tinyformat comes with a set of macros which are used
81// internally to generate the API, but which may also be used in user code.
82//
83// The three macros TINYFORMAT_ARGTYPES(n), TINYFORMAT_VARARGS(n) and
84// TINYFORMAT_PASSARGS(n) will generate a list of n argument types,
85// type/name pairs and argument names respectively when called with an integer
86// n between 1 and 16. We can use these to define a macro which generates the
87// desired user defined function with n arguments. To generate all 16 user
88// defined function bodies, use the macro TINYFORMAT_FOREACH_ARGNUM. For an
89// example, see the implementation of printf() at the end of the source file.
90//
c5b9bd9c
DH
91// Sometimes it's useful to be able to pass a list of format arguments through
92// to a non-template function. The FormatList class is provided as a way to do
93// this by storing the argument list in a type-opaque way. Continuing the
94// example from above, we construct a FormatList using makeFormatList():
95//
96// FormatListRef formatList = tfm::makeFormatList(weekday, month, day, hour, min);
97//
98// The format list can now be passed into any non-template function and used
99// via a call to the vformat() function:
100//
101// tfm::vformat(std::cout, "%s, %s %d, %.2d:%.2d\n", formatList);
102//
b77dfdc9
WL
103//
104// Additional API information
105// --------------------------
106//
107// Error handling: Define TINYFORMAT_ERROR to customize the error handling for
108// format strings which are unsupported or have the wrong number of format
109// specifiers (calls assert() by default).
110//
111// User defined types: Uses operator<< for user defined types by default.
112// Overload formatValue() for more control.
113
114
115#ifndef TINYFORMAT_H_INCLUDED
116#define TINYFORMAT_H_INCLUDED
117
118namespace tinyformat {}
119//------------------------------------------------------------------------------
120// Config section. Customize to your liking!
121
122// Namespace alias to encourage brevity
123namespace tfm = tinyformat;
124
125// Error handling; calls assert() by default.
1b8fd35a 126#define TINYFORMAT_ERROR(reasonString) throw std::runtime_error(reasonString)
b77dfdc9
WL
127
128// Define for C++11 variadic templates which make the code shorter & more
129// general. If you don't define this, C++11 support is autodetected below.
130// #define TINYFORMAT_USE_VARIADIC_TEMPLATES
131
132
133//------------------------------------------------------------------------------
134// Implementation details.
c5b9bd9c 135#include <algorithm>
b77dfdc9
WL
136#include <cassert>
137#include <iostream>
138#include <sstream>
6e5fd003 139#include <stdexcept>
b77dfdc9
WL
140
141#ifndef TINYFORMAT_ERROR
142# define TINYFORMAT_ERROR(reason) assert(0 && reason)
143#endif
144
145#if !defined(TINYFORMAT_USE_VARIADIC_TEMPLATES) && !defined(TINYFORMAT_NO_VARIADIC_TEMPLATES)
146# ifdef __GXX_EXPERIMENTAL_CXX0X__
147# define TINYFORMAT_USE_VARIADIC_TEMPLATES
148# endif
149#endif
150
b77dfdc9
WL
151#if defined(__GLIBCXX__) && __GLIBCXX__ < 20080201
152// std::showpos is broken on old libstdc++ as provided with OSX. See
153// http://gcc.gnu.org/ml/libstdc++/2007-11/msg00075.html
154# define TINYFORMAT_OLD_LIBSTDCPLUSPLUS_WORKAROUND
155#endif
156
c5b9bd9c 157#ifdef __APPLE__
c938fb1f 158// Workaround macOS linker warning: Xcode uses different default symbol
c5b9bd9c
DH
159// visibilities for static libs vs executables (see issue #25)
160# define TINYFORMAT_HIDDEN __attribute__((visibility("hidden")))
161#else
162# define TINYFORMAT_HIDDEN
163#endif
164
b77dfdc9
WL
165namespace tinyformat {
166
167//------------------------------------------------------------------------------
168namespace detail {
169
170// Test whether type T1 is convertible to type T2
171template <typename T1, typename T2>
172struct is_convertible
173{
174 private:
175 // two types of different size
176 struct fail { char dummy[2]; };
177 struct succeed { char dummy; };
178 // Try to convert a T1 to a T2 by plugging into tryConvert
179 static fail tryConvert(...);
180 static succeed tryConvert(const T2&);
181 static const T1& makeT1();
182 public:
183# ifdef _MSC_VER
184 // Disable spurious loss of precision warnings in tryConvert(makeT1())
185# pragma warning(push)
186# pragma warning(disable:4244)
187# pragma warning(disable:4267)
188# endif
189 // Standard trick: the (...) version of tryConvert will be chosen from
190 // the overload set only if the version taking a T2 doesn't match.
191 // Then we compare the sizes of the return types to check which
192 // function matched. Very neat, in a disgusting kind of way :)
193 static const bool value =
194 sizeof(tryConvert(makeT1())) == sizeof(succeed);
195# ifdef _MSC_VER
196# pragma warning(pop)
197# endif
198};
199
200
201// Detect when a type is not a wchar_t string
202template<typename T> struct is_wchar { typedef int tinyformat_wchar_is_not_supported; };
203template<> struct is_wchar<wchar_t*> {};
204template<> struct is_wchar<const wchar_t*> {};
205template<int n> struct is_wchar<const wchar_t[n]> {};
206template<int n> struct is_wchar<wchar_t[n]> {};
207
208
209// Format the value by casting to type fmtT. This default implementation
210// should never be called.
211template<typename T, typename fmtT, bool convertible = is_convertible<T, fmtT>::value>
212struct formatValueAsType
213{
214 static void invoke(std::ostream& /*out*/, const T& /*value*/) { assert(0); }
215};
216// Specialized version for types that can actually be converted to fmtT, as
217// indicated by the "convertible" template parameter.
218template<typename T, typename fmtT>
219struct formatValueAsType<T,fmtT,true>
220{
221 static void invoke(std::ostream& out, const T& value)
222 { out << static_cast<fmtT>(value); }
223};
224
225#ifdef TINYFORMAT_OLD_LIBSTDCPLUSPLUS_WORKAROUND
226template<typename T, bool convertible = is_convertible<T, int>::value>
227struct formatZeroIntegerWorkaround
228{
229 static bool invoke(std::ostream& /**/, const T& /**/) { return false; }
230};
231template<typename T>
232struct formatZeroIntegerWorkaround<T,true>
233{
234 static bool invoke(std::ostream& out, const T& value)
235 {
236 if (static_cast<int>(value) == 0 && out.flags() & std::ios::showpos)
237 {
238 out << "+0";
239 return true;
240 }
241 return false;
242 }
243};
244#endif // TINYFORMAT_OLD_LIBSTDCPLUSPLUS_WORKAROUND
245
246// Convert an arbitrary type to integer. The version with convertible=false
247// throws an error.
248template<typename T, bool convertible = is_convertible<T,int>::value>
249struct convertToInt
250{
251 static int invoke(const T& /*value*/)
252 {
253 TINYFORMAT_ERROR("tinyformat: Cannot convert from argument type to "
254 "integer for use as variable width or precision");
255 return 0;
256 }
257};
258// Specialization for convertToInt when conversion is possible
259template<typename T>
260struct convertToInt<T,true>
261{
262 static int invoke(const T& value) { return static_cast<int>(value); }
263};
264
c5b9bd9c
DH
265// Format at most ntrunc characters to the given stream.
266template<typename T>
267inline void formatTruncated(std::ostream& out, const T& value, int ntrunc)
268{
269 std::ostringstream tmp;
270 tmp << value;
271 std::string result = tmp.str();
272 out.write(result.c_str(), (std::min)(ntrunc, static_cast<int>(result.size())));
273}
274#define TINYFORMAT_DEFINE_FORMAT_TRUNCATED_CSTR(type) \
275inline void formatTruncated(std::ostream& out, type* value, int ntrunc) \
276{ \
277 std::streamsize len = 0; \
278 while(len < ntrunc && value[len] != 0) \
279 ++len; \
280 out.write(value, len); \
281}
282// Overload for const char* and char*. Could overload for signed & unsigned
283// char too, but these are technically unneeded for printf compatibility.
284TINYFORMAT_DEFINE_FORMAT_TRUNCATED_CSTR(const char)
285TINYFORMAT_DEFINE_FORMAT_TRUNCATED_CSTR(char)
286#undef TINYFORMAT_DEFINE_FORMAT_TRUNCATED_CSTR
287
b77dfdc9
WL
288} // namespace detail
289
290
291//------------------------------------------------------------------------------
292// Variable formatting functions. May be overridden for user-defined types if
293// desired.
294
295
c5b9bd9c
DH
296/// Format a value into a stream, delegating to operator<< by default.
297///
298/// Users may override this for their own types. When this function is called,
299/// the stream flags will have been modified according to the format string.
300/// The format specification is provided in the range [fmtBegin, fmtEnd). For
301/// truncating conversions, ntrunc is set to the desired maximum number of
302/// characters, for example "%.7s" calls formatValue with ntrunc = 7.
303///
304/// By default, formatValue() uses the usual stream insertion operator
305/// operator<< to format the type T, with special cases for the %c and %p
306/// conversions.
b77dfdc9
WL
307template<typename T>
308inline void formatValue(std::ostream& out, const char* /*fmtBegin*/,
c5b9bd9c 309 const char* fmtEnd, int ntrunc, const T& value)
b77dfdc9
WL
310{
311#ifndef TINYFORMAT_ALLOW_WCHAR_STRINGS
312 // Since we don't support printing of wchar_t using "%ls", make it fail at
313 // compile time in preference to printing as a void* at runtime.
314 typedef typename detail::is_wchar<T>::tinyformat_wchar_is_not_supported DummyType;
315 (void) DummyType(); // avoid unused type warning with gcc-4.8
316#endif
317 // The mess here is to support the %c and %p conversions: if these
318 // conversions are active we try to convert the type to a char or const
319 // void* respectively and format that instead of the value itself. For the
320 // %p conversion it's important to avoid dereferencing the pointer, which
321 // could otherwise lead to a crash when printing a dangling (const char*).
322 const bool canConvertToChar = detail::is_convertible<T,char>::value;
323 const bool canConvertToVoidPtr = detail::is_convertible<T, const void*>::value;
324 if(canConvertToChar && *(fmtEnd-1) == 'c')
325 detail::formatValueAsType<T, char>::invoke(out, value);
326 else if(canConvertToVoidPtr && *(fmtEnd-1) == 'p')
327 detail::formatValueAsType<T, const void*>::invoke(out, value);
328#ifdef TINYFORMAT_OLD_LIBSTDCPLUSPLUS_WORKAROUND
329 else if(detail::formatZeroIntegerWorkaround<T>::invoke(out, value)) /**/;
330#endif
c5b9bd9c
DH
331 else if(ntrunc >= 0)
332 {
333 // Take care not to overread C strings in truncating conversions like
334 // "%.4s" where at most 4 characters may be read.
335 detail::formatTruncated(out, value, ntrunc);
336 }
b77dfdc9
WL
337 else
338 out << value;
339}
340
341
342// Overloaded version for char types to support printing as an integer
343#define TINYFORMAT_DEFINE_FORMATVALUE_CHAR(charType) \
344inline void formatValue(std::ostream& out, const char* /*fmtBegin*/, \
c5b9bd9c 345 const char* fmtEnd, int /**/, charType value) \
b77dfdc9
WL
346{ \
347 switch(*(fmtEnd-1)) \
348 { \
349 case 'u': case 'd': case 'i': case 'o': case 'X': case 'x': \
350 out << static_cast<int>(value); break; \
351 default: \
352 out << value; break; \
353 } \
354}
355// per 3.9.1: char, signed char and unsigned char are all distinct types
356TINYFORMAT_DEFINE_FORMATVALUE_CHAR(char)
357TINYFORMAT_DEFINE_FORMATVALUE_CHAR(signed char)
358TINYFORMAT_DEFINE_FORMATVALUE_CHAR(unsigned char)
359#undef TINYFORMAT_DEFINE_FORMATVALUE_CHAR
360
361
362//------------------------------------------------------------------------------
363// Tools for emulating variadic templates in C++98. The basic idea here is
364// stolen from the boost preprocessor metaprogramming library and cut down to
365// be just general enough for what we need.
366
367#define TINYFORMAT_ARGTYPES(n) TINYFORMAT_ARGTYPES_ ## n
368#define TINYFORMAT_VARARGS(n) TINYFORMAT_VARARGS_ ## n
369#define TINYFORMAT_PASSARGS(n) TINYFORMAT_PASSARGS_ ## n
370#define TINYFORMAT_PASSARGS_TAIL(n) TINYFORMAT_PASSARGS_TAIL_ ## n
371
372// To keep it as transparent as possible, the macros below have been generated
373// using python via the excellent cog.py code generation script. This avoids
374// the need for a bunch of complex (but more general) preprocessor tricks as
375// used in boost.preprocessor.
376//
377// To rerun the code generation in place, use `cog.py -r tinyformat.h`
378// (see http://nedbatchelder.com/code/cog). Alternatively you can just create
379// extra versions by hand.
380
381/*[[[cog
382maxParams = 16
383
384def makeCommaSepLists(lineTemplate, elemTemplate, startInd=1):
385 for j in range(startInd,maxParams+1):
386 list = ', '.join([elemTemplate % {'i':i} for i in range(startInd,j+1)])
387 cog.outl(lineTemplate % {'j':j, 'list':list})
388
389makeCommaSepLists('#define TINYFORMAT_ARGTYPES_%(j)d %(list)s',
390 'class T%(i)d')
391
392cog.outl()
393makeCommaSepLists('#define TINYFORMAT_VARARGS_%(j)d %(list)s',
394 'const T%(i)d& v%(i)d')
395
396cog.outl()
397makeCommaSepLists('#define TINYFORMAT_PASSARGS_%(j)d %(list)s', 'v%(i)d')
398
399cog.outl()
400cog.outl('#define TINYFORMAT_PASSARGS_TAIL_1')
401makeCommaSepLists('#define TINYFORMAT_PASSARGS_TAIL_%(j)d , %(list)s',
402 'v%(i)d', startInd = 2)
403
404cog.outl()
405cog.outl('#define TINYFORMAT_FOREACH_ARGNUM(m) \\\n ' +
406 ' '.join(['m(%d)' % (j,) for j in range(1,maxParams+1)]))
407]]]*/
408#define TINYFORMAT_ARGTYPES_1 class T1
409#define TINYFORMAT_ARGTYPES_2 class T1, class T2
410#define TINYFORMAT_ARGTYPES_3 class T1, class T2, class T3
411#define TINYFORMAT_ARGTYPES_4 class T1, class T2, class T3, class T4
412#define TINYFORMAT_ARGTYPES_5 class T1, class T2, class T3, class T4, class T5
413#define TINYFORMAT_ARGTYPES_6 class T1, class T2, class T3, class T4, class T5, class T6
414#define TINYFORMAT_ARGTYPES_7 class T1, class T2, class T3, class T4, class T5, class T6, class T7
415#define TINYFORMAT_ARGTYPES_8 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8
416#define TINYFORMAT_ARGTYPES_9 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9
417#define TINYFORMAT_ARGTYPES_10 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10
418#define TINYFORMAT_ARGTYPES_11 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10, class T11
419#define TINYFORMAT_ARGTYPES_12 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10, class T11, class T12
420#define TINYFORMAT_ARGTYPES_13 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10, class T11, class T12, class T13
421#define TINYFORMAT_ARGTYPES_14 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10, class T11, class T12, class T13, class T14
422#define TINYFORMAT_ARGTYPES_15 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10, class T11, class T12, class T13, class T14, class T15
423#define TINYFORMAT_ARGTYPES_16 class T1, class T2, class T3, class T4, class T5, class T6, class T7, class T8, class T9, class T10, class T11, class T12, class T13, class T14, class T15, class T16
424
425#define TINYFORMAT_VARARGS_1 const T1& v1
426#define TINYFORMAT_VARARGS_2 const T1& v1, const T2& v2
427#define TINYFORMAT_VARARGS_3 const T1& v1, const T2& v2, const T3& v3
428#define TINYFORMAT_VARARGS_4 const T1& v1, const T2& v2, const T3& v3, const T4& v4
429#define TINYFORMAT_VARARGS_5 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5
430#define TINYFORMAT_VARARGS_6 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6
431#define TINYFORMAT_VARARGS_7 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7
432#define TINYFORMAT_VARARGS_8 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8
433#define TINYFORMAT_VARARGS_9 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9
434#define TINYFORMAT_VARARGS_10 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10
435#define TINYFORMAT_VARARGS_11 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10, const T11& v11
436#define TINYFORMAT_VARARGS_12 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10, const T11& v11, const T12& v12
437#define TINYFORMAT_VARARGS_13 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10, const T11& v11, const T12& v12, const T13& v13
438#define TINYFORMAT_VARARGS_14 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10, const T11& v11, const T12& v12, const T13& v13, const T14& v14
439#define TINYFORMAT_VARARGS_15 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10, const T11& v11, const T12& v12, const T13& v13, const T14& v14, const T15& v15
440#define TINYFORMAT_VARARGS_16 const T1& v1, const T2& v2, const T3& v3, const T4& v4, const T5& v5, const T6& v6, const T7& v7, const T8& v8, const T9& v9, const T10& v10, const T11& v11, const T12& v12, const T13& v13, const T14& v14, const T15& v15, const T16& v16
441
442#define TINYFORMAT_PASSARGS_1 v1
443#define TINYFORMAT_PASSARGS_2 v1, v2
444#define TINYFORMAT_PASSARGS_3 v1, v2, v3
445#define TINYFORMAT_PASSARGS_4 v1, v2, v3, v4
446#define TINYFORMAT_PASSARGS_5 v1, v2, v3, v4, v5
447#define TINYFORMAT_PASSARGS_6 v1, v2, v3, v4, v5, v6
448#define TINYFORMAT_PASSARGS_7 v1, v2, v3, v4, v5, v6, v7
449#define TINYFORMAT_PASSARGS_8 v1, v2, v3, v4, v5, v6, v7, v8
450#define TINYFORMAT_PASSARGS_9 v1, v2, v3, v4, v5, v6, v7, v8, v9
451#define TINYFORMAT_PASSARGS_10 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10
452#define TINYFORMAT_PASSARGS_11 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11
453#define TINYFORMAT_PASSARGS_12 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12
454#define TINYFORMAT_PASSARGS_13 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13
455#define TINYFORMAT_PASSARGS_14 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14
456#define TINYFORMAT_PASSARGS_15 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15
457#define TINYFORMAT_PASSARGS_16 v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16
458
459#define TINYFORMAT_PASSARGS_TAIL_1
460#define TINYFORMAT_PASSARGS_TAIL_2 , v2
461#define TINYFORMAT_PASSARGS_TAIL_3 , v2, v3
462#define TINYFORMAT_PASSARGS_TAIL_4 , v2, v3, v4
463#define TINYFORMAT_PASSARGS_TAIL_5 , v2, v3, v4, v5
464#define TINYFORMAT_PASSARGS_TAIL_6 , v2, v3, v4, v5, v6
465#define TINYFORMAT_PASSARGS_TAIL_7 , v2, v3, v4, v5, v6, v7
466#define TINYFORMAT_PASSARGS_TAIL_8 , v2, v3, v4, v5, v6, v7, v8
467#define TINYFORMAT_PASSARGS_TAIL_9 , v2, v3, v4, v5, v6, v7, v8, v9
468#define TINYFORMAT_PASSARGS_TAIL_10 , v2, v3, v4, v5, v6, v7, v8, v9, v10
469#define TINYFORMAT_PASSARGS_TAIL_11 , v2, v3, v4, v5, v6, v7, v8, v9, v10, v11
470#define TINYFORMAT_PASSARGS_TAIL_12 , v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12
471#define TINYFORMAT_PASSARGS_TAIL_13 , v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13
472#define TINYFORMAT_PASSARGS_TAIL_14 , v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14
473#define TINYFORMAT_PASSARGS_TAIL_15 , v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15
474#define TINYFORMAT_PASSARGS_TAIL_16 , v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16
475
476#define TINYFORMAT_FOREACH_ARGNUM(m) \
477 m(1) m(2) m(3) m(4) m(5) m(6) m(7) m(8) m(9) m(10) m(11) m(12) m(13) m(14) m(15) m(16)
478//[[[end]]]
479
480
481
482namespace detail {
483
c5b9bd9c
DH
484// Type-opaque holder for an argument to format(), with associated actions on
485// the type held as explicit function pointers. This allows FormatArg's for
486// each argument to be allocated as a homogenous array inside FormatList
487// whereas a naive implementation based on inheritance does not.
488class FormatArg
b77dfdc9
WL
489{
490 public:
c5b9bd9c
DH
491 FormatArg() {}
492
493 template<typename T>
494 FormatArg(const T& value)
495 : m_value(static_cast<const void*>(&value)),
496 m_formatImpl(&formatImpl<T>),
497 m_toIntImpl(&toIntImpl<T>)
b77dfdc9
WL
498 { }
499
c5b9bd9c
DH
500 void format(std::ostream& out, const char* fmtBegin,
501 const char* fmtEnd, int ntrunc) const
b77dfdc9 502 {
945f015d 503/*
b77dfdc9 504 // It would be nice if we could do this from the destructor, but we
429dabb5 505 // can't if TINYFORMAT_ERROR is used to throw an exception!
b77dfdc9
WL
506 m_fmt = printFormatStringLiteral(m_out, m_fmt);
507 if(*m_fmt != '\0')
508 TINYFORMAT_ERROR("tinyformat: Too many conversion specifiers in format string");
30853e4a 509=======*/
c5b9bd9c 510 m_formatImpl(out, fmtBegin, fmtEnd, ntrunc, m_value);
b77dfdc9
WL
511 }
512
c5b9bd9c 513 int toInt() const
b77dfdc9 514 {
c5b9bd9c 515 return m_toIntImpl(m_value);
b77dfdc9
WL
516 }
517
b77dfdc9 518 private:
c5b9bd9c
DH
519 template<typename T>
520 TINYFORMAT_HIDDEN static void formatImpl(std::ostream& out, const char* fmtBegin,
521 const char* fmtEnd, int ntrunc, const void* value)
b77dfdc9 522 {
c5b9bd9c 523 formatValue(out, fmtBegin, fmtEnd, ntrunc, *static_cast<const T*>(value));
b77dfdc9
WL
524 }
525
b77dfdc9 526 template<typename T>
c5b9bd9c 527 TINYFORMAT_HIDDEN static int toIntImpl(const void* value)
b77dfdc9 528 {
c5b9bd9c 529 return convertToInt<T>::invoke(*static_cast<const T*>(value));
b77dfdc9
WL
530 }
531
c5b9bd9c
DH
532 const void* m_value;
533 void (*m_formatImpl)(std::ostream& out, const char* fmtBegin,
534 const char* fmtEnd, int ntrunc, const void* value);
535 int (*m_toIntImpl)(const void* value);
b77dfdc9
WL
536};
537
538
c5b9bd9c
DH
539// Parse and return an integer from the string c, as atoi()
540// On return, c is set to one past the end of the integer.
541inline int parseIntAndAdvance(const char*& c)
b77dfdc9 542{
c5b9bd9c
DH
543 int i = 0;
544 for(;*c >= '0' && *c <= '9'; ++c)
545 i = 10*i + (*c - '0');
546 return i;
547}
b77dfdc9 548
c5b9bd9c
DH
549// Print literal part of format string and return next format spec
550// position.
551//
552// Skips over any occurrences of '%%', printing a literal '%' to the
553// output. The position of the first % character of the next
554// nontrivial format spec is returned, or the end of string.
555inline const char* printFormatStringLiteral(std::ostream& out, const char* fmt)
556{
557 const char* c = fmt;
558 for(;; ++c)
b77dfdc9 559 {
c5b9bd9c 560 switch(*c)
b77dfdc9 561 {
c5b9bd9c
DH
562 case '\0':
563 out.write(fmt, c - fmt);
564 return c;
565 case '%':
566 out.write(fmt, c - fmt);
567 if(*(c+1) != '%')
568 return c;
569 // for "%%", tack trailing % onto next literal section.
570 fmt = ++c;
571 break;
572 default:
573 break;
b77dfdc9 574 }
b77dfdc9 575 }
b77dfdc9
WL
576}
577
578
579// Parse a format string and set the stream state accordingly.
580//
581// The format mini-language recognized here is meant to be the one from C99,
582// with the form "%[flags][width][.precision][length]type".
583//
584// Formatting options which can't be natively represented using the ostream
c5b9bd9c
DH
585// state are returned in spacePadPositive (for space padded positive numbers)
586// and ntrunc (for truncating conversions). argIndex is incremented if
c938fb1f 587// necessary to pull out variable width and precision. The function returns a
c5b9bd9c
DH
588// pointer to the character after the end of the current format spec.
589inline const char* streamStateFromFormat(std::ostream& out, bool& spacePadPositive,
590 int& ntrunc, const char* fmtStart,
591 const detail::FormatArg* formatters,
592 int& argIndex, int numFormatters)
b77dfdc9
WL
593{
594 if(*fmtStart != '%')
595 {
596 TINYFORMAT_ERROR("tinyformat: Not enough conversion specifiers in format string");
597 return fmtStart;
598 }
599 // Reset stream state to defaults.
600 out.width(0);
601 out.precision(6);
602 out.fill(' ');
603 // Reset most flags; ignore irrelevant unitbuf & skipws.
604 out.unsetf(std::ios::adjustfield | std::ios::basefield |
605 std::ios::floatfield | std::ios::showbase | std::ios::boolalpha |
606 std::ios::showpoint | std::ios::showpos | std::ios::uppercase);
b77dfdc9
WL
607 bool precisionSet = false;
608 bool widthSet = false;
c5b9bd9c 609 int widthExtra = 0;
b77dfdc9
WL
610 const char* c = fmtStart + 1;
611 // 1) Parse flags
612 for(;; ++c)
613 {
614 switch(*c)
615 {
616 case '#':
617 out.setf(std::ios::showpoint | std::ios::showbase);
618 continue;
619 case '0':
620 // overridden by left alignment ('-' flag)
621 if(!(out.flags() & std::ios::left))
622 {
623 // Use internal padding so that numeric values are
624 // formatted correctly, eg -00010 rather than 000-10
625 out.fill('0');
626 out.setf(std::ios::internal, std::ios::adjustfield);
627 }
628 continue;
629 case '-':
630 out.fill(' ');
631 out.setf(std::ios::left, std::ios::adjustfield);
632 continue;
633 case ' ':
634 // overridden by show positive sign, '+' flag.
635 if(!(out.flags() & std::ios::showpos))
c5b9bd9c 636 spacePadPositive = true;
b77dfdc9
WL
637 continue;
638 case '+':
639 out.setf(std::ios::showpos);
c5b9bd9c
DH
640 spacePadPositive = false;
641 widthExtra = 1;
b77dfdc9 642 continue;
c5b9bd9c
DH
643 default:
644 break;
b77dfdc9
WL
645 }
646 break;
647 }
648 // 2) Parse width
649 if(*c >= '0' && *c <= '9')
650 {
651 widthSet = true;
652 out.width(parseIntAndAdvance(c));
653 }
654 if(*c == '*')
655 {
656 widthSet = true;
c5b9bd9c
DH
657 int width = 0;
658 if(argIndex < numFormatters)
659 width = formatters[argIndex++].toInt();
660 else
661 TINYFORMAT_ERROR("tinyformat: Not enough arguments to read variable width");
662 if(width < 0)
b77dfdc9
WL
663 {
664 // negative widths correspond to '-' flag set
665 out.fill(' ');
666 out.setf(std::ios::left, std::ios::adjustfield);
c5b9bd9c 667 width = -width;
b77dfdc9 668 }
c5b9bd9c 669 out.width(width);
b77dfdc9
WL
670 ++c;
671 }
672 // 3) Parse precision
673 if(*c == '.')
674 {
675 ++c;
676 int precision = 0;
677 if(*c == '*')
678 {
679 ++c;
c5b9bd9c
DH
680 if(argIndex < numFormatters)
681 precision = formatters[argIndex++].toInt();
682 else
683 TINYFORMAT_ERROR("tinyformat: Not enough arguments to read variable precision");
b77dfdc9
WL
684 }
685 else
686 {
687 if(*c >= '0' && *c <= '9')
688 precision = parseIntAndAdvance(c);
689 else if(*c == '-') // negative precisions ignored, treated as zero.
690 parseIntAndAdvance(++c);
691 }
692 out.precision(precision);
693 precisionSet = true;
694 }
695 // 4) Ignore any C99 length modifier
696 while(*c == 'l' || *c == 'h' || *c == 'L' ||
697 *c == 'j' || *c == 'z' || *c == 't')
698 ++c;
699 // 5) We're up to the conversion specifier character.
700 // Set stream flags based on conversion specifier (thanks to the
701 // boost::format class for forging the way here).
702 bool intConversion = false;
703 switch(*c)
704 {
705 case 'u': case 'd': case 'i':
706 out.setf(std::ios::dec, std::ios::basefield);
707 intConversion = true;
708 break;
709 case 'o':
710 out.setf(std::ios::oct, std::ios::basefield);
711 intConversion = true;
712 break;
713 case 'X':
714 out.setf(std::ios::uppercase);
715 case 'x': case 'p':
716 out.setf(std::ios::hex, std::ios::basefield);
717 intConversion = true;
718 break;
719 case 'E':
720 out.setf(std::ios::uppercase);
721 case 'e':
722 out.setf(std::ios::scientific, std::ios::floatfield);
723 out.setf(std::ios::dec, std::ios::basefield);
724 break;
725 case 'F':
726 out.setf(std::ios::uppercase);
727 case 'f':
728 out.setf(std::ios::fixed, std::ios::floatfield);
729 break;
730 case 'G':
731 out.setf(std::ios::uppercase);
732 case 'g':
733 out.setf(std::ios::dec, std::ios::basefield);
734 // As in boost::format, let stream decide float format.
735 out.flags(out.flags() & ~std::ios::floatfield);
736 break;
737 case 'a': case 'A':
738 TINYFORMAT_ERROR("tinyformat: the %a and %A conversion specs "
739 "are not supported");
740 break;
741 case 'c':
742 // Handled as special case inside formatValue()
743 break;
744 case 's':
745 if(precisionSet)
c5b9bd9c 746 ntrunc = static_cast<int>(out.precision());
b77dfdc9
WL
747 // Make %s print booleans as "true" and "false"
748 out.setf(std::ios::boolalpha);
749 break;
750 case 'n':
751 // Not supported - will cause problems!
752 TINYFORMAT_ERROR("tinyformat: %n conversion spec not supported");
753 break;
754 case '\0':
755 TINYFORMAT_ERROR("tinyformat: Conversion spec incorrectly "
756 "terminated by end of string");
757 return c;
c5b9bd9c
DH
758 default:
759 break;
b77dfdc9
WL
760 }
761 if(intConversion && precisionSet && !widthSet)
762 {
763 // "precision" for integers gives the minimum number of digits (to be
764 // padded with zeros on the left). This isn't really supported by the
765 // iostreams, but we can approximately simulate it with the width if
766 // the width isn't otherwise used.
c5b9bd9c 767 out.width(out.precision() + widthExtra);
b77dfdc9
WL
768 out.setf(std::ios::internal, std::ios::adjustfield);
769 out.fill('0');
770 }
771 return c+1;
772}
773
774
b77dfdc9 775//------------------------------------------------------------------------------
c5b9bd9c
DH
776inline void formatImpl(std::ostream& out, const char* fmt,
777 const detail::FormatArg* formatters,
778 int numFormatters)
b77dfdc9 779{
c5b9bd9c
DH
780 // Saved stream state
781 std::streamsize origWidth = out.width();
782 std::streamsize origPrecision = out.precision();
783 std::ios::fmtflags origFlags = out.flags();
784 char origFill = out.fill();
785
786 for (int argIndex = 0; argIndex < numFormatters; ++argIndex)
787 {
788 // Parse the format string
789 fmt = printFormatStringLiteral(out, fmt);
790 bool spacePadPositive = false;
791 int ntrunc = -1;
792 const char* fmtEnd = streamStateFromFormat(out, spacePadPositive, ntrunc, fmt,
793 formatters, argIndex, numFormatters);
794 if (argIndex >= numFormatters)
795 {
796 // Check args remain after reading any variable width/precision
797 TINYFORMAT_ERROR("tinyformat: Not enough format arguments");
798 return;
799 }
800 const FormatArg& arg = formatters[argIndex];
801 // Format the arg into the stream.
802 if(!spacePadPositive)
803 arg.format(out, fmt, fmtEnd, ntrunc);
804 else
805 {
806 // The following is a special case with no direct correspondence
807 // between stream formatting and the printf() behaviour. Simulate
808 // it crudely by formatting into a temporary string stream and
809 // munging the resulting string.
810 std::ostringstream tmpStream;
811 tmpStream.copyfmt(out);
812 tmpStream.setf(std::ios::showpos);
813 arg.format(tmpStream, fmt, fmtEnd, ntrunc);
814 std::string result = tmpStream.str(); // allocates... yuck.
815 for(size_t i = 0, iend = result.size(); i < iend; ++i)
816 if(result[i] == '+') result[i] = ' ';
817 out << result;
818 }
819 fmt = fmtEnd;
820 }
821
822 // Print remaining part of format string.
823 fmt = printFormatStringLiteral(out, fmt);
44b72fe4 824 if(*fmt != '\0' && 0 ) // disabled due to complaints
c5b9bd9c
DH
825 TINYFORMAT_ERROR("tinyformat: Too many conversion specifiers in format string");
826
827 // Restore stream state
828 out.width(origWidth);
829 out.precision(origPrecision);
830 out.flags(origFlags);
831 out.fill(origFill);
b77dfdc9
WL
832}
833
c5b9bd9c
DH
834} // namespace detail
835
836
837/// List of template arguments format(), held in a type-opaque way.
838///
839/// A const reference to FormatList (typedef'd as FormatListRef) may be
840/// conveniently used to pass arguments to non-template functions: All type
841/// information has been stripped from the arguments, leaving just enough of a
842/// common interface to perform formatting as required.
843class FormatList
b77dfdc9 844{
c5b9bd9c
DH
845 public:
846 FormatList(detail::FormatArg* formatters, int N)
847 : m_formatters(formatters), m_N(N) { }
b77dfdc9 848
c5b9bd9c
DH
849 friend void vformat(std::ostream& out, const char* fmt,
850 const FormatList& list);
b77dfdc9 851
c5b9bd9c
DH
852 private:
853 const detail::FormatArg* m_formatters;
854 int m_N;
855};
856
857/// Reference to type-opaque format list for passing to vformat()
858typedef const FormatList& FormatListRef;
859
860
861namespace detail {
862
863// Format list subclass with fixed storage to avoid dynamic allocation
864template<int N>
865class FormatListN : public FormatList
b77dfdc9 866{
c5b9bd9c
DH
867 public:
868#ifdef TINYFORMAT_USE_VARIADIC_TEMPLATES
869 template<typename... Args>
870 FormatListN(const Args&... args)
871 : FormatList(&m_formatterStore[0], N),
872 m_formatterStore { FormatArg(args)... }
873 { static_assert(sizeof...(args) == N, "Number of args must be N"); }
874#else // C++98 version
875 void init(int) {}
876# define TINYFORMAT_MAKE_FORMATLIST_CONSTRUCTOR(n) \
877 \
878 template<TINYFORMAT_ARGTYPES(n)> \
879 FormatListN(TINYFORMAT_VARARGS(n)) \
880 : FormatList(&m_formatterStore[0], n) \
881 { assert(n == N); init(0, TINYFORMAT_PASSARGS(n)); } \
882 \
883 template<TINYFORMAT_ARGTYPES(n)> \
884 void init(int i, TINYFORMAT_VARARGS(n)) \
885 { \
886 m_formatterStore[i] = FormatArg(v1); \
887 init(i+1 TINYFORMAT_PASSARGS_TAIL(n)); \
888 }
b77dfdc9 889
c5b9bd9c
DH
890 TINYFORMAT_FOREACH_ARGNUM(TINYFORMAT_MAKE_FORMATLIST_CONSTRUCTOR)
891# undef TINYFORMAT_MAKE_FORMATLIST_CONSTRUCTOR
892#endif
b77dfdc9 893
c5b9bd9c
DH
894 private:
895 FormatArg m_formatterStore[N];
896};
b77dfdc9 897
c5b9bd9c
DH
898// Special 0-arg version - MSVC says zero-sized C array in struct is nonstandard
899template<> class FormatListN<0> : public FormatList
900{
901 public: FormatListN() : FormatList(0, 0) {}
902};
b77dfdc9
WL
903
904} // namespace detail
905
906
907//------------------------------------------------------------------------------
c5b9bd9c 908// Primary API functions
b77dfdc9
WL
909
910#ifdef TINYFORMAT_USE_VARIADIC_TEMPLATES
911
c5b9bd9c
DH
912/// Make type-agnostic format list from list of template arguments.
913///
914/// The exact return type of this function is an implementation detail and
915/// shouldn't be relied upon. Instead it should be stored as a FormatListRef:
916///
917/// FormatListRef formatList = makeFormatList( /*...*/ );
918template<typename... Args>
919detail::FormatListN<sizeof...(Args)> makeFormatList(const Args&... args)
b77dfdc9 920{
c5b9bd9c 921 return detail::FormatListN<sizeof...(args)>(args...);
b77dfdc9
WL
922}
923
c5b9bd9c
DH
924#else // C++98 version
925
926inline detail::FormatListN<0> makeFormatList()
927{
928 return detail::FormatListN<0>();
929}
930#define TINYFORMAT_MAKE_MAKEFORMATLIST(n) \
931template<TINYFORMAT_ARGTYPES(n)> \
932detail::FormatListN<n> makeFormatList(TINYFORMAT_VARARGS(n)) \
933{ \
934 return detail::FormatListN<n>(TINYFORMAT_PASSARGS(n)); \
935}
936TINYFORMAT_FOREACH_ARGNUM(TINYFORMAT_MAKE_MAKEFORMATLIST)
937#undef TINYFORMAT_MAKE_MAKEFORMATLIST
938
939#endif
940
941/// Format list of arguments to the stream according to the given format string.
942///
943/// The name vformat() is chosen for the semantic similarity to vprintf(): the
944/// list of format arguments is held in a single function argument.
945inline void vformat(std::ostream& out, const char* fmt, FormatListRef list)
946{
947 detail::formatImpl(out, fmt, list.m_formatters, list.m_N);
948}
949
950
951#ifdef TINYFORMAT_USE_VARIADIC_TEMPLATES
952
953/// Format list of arguments to the stream according to given format string.
954template<typename... Args>
955void format(std::ostream& out, const char* fmt, const Args&... args)
956{
957 vformat(out, fmt, makeFormatList(args...));
958}
959
960/// Format list of arguments according to the given format string and return
961/// the result as a string.
962template<typename... Args>
963std::string format(const char* fmt, const Args&... args)
b77dfdc9
WL
964{
965 std::ostringstream oss;
c5b9bd9c 966 format(oss, fmt, args...);
b77dfdc9
WL
967 return oss.str();
968}
969
c5b9bd9c
DH
970/// Format list of arguments to std::cout, according to the given format string
971template<typename... Args>
972void printf(const char* fmt, const Args&... args)
973{
974 format(std::cout, fmt, args...);
975}
976
977template<typename... Args>
978void printfln(const char* fmt, const Args&... args)
979{
980 format(std::cout, fmt, args...);
981 std::cout << '\n';
982}
983
984#else // C++98 version
985
986inline void format(std::ostream& out, const char* fmt)
987{
988 vformat(out, fmt, makeFormatList());
989}
990
991inline std::string format(const char* fmt)
b77dfdc9
WL
992{
993 std::ostringstream oss;
c5b9bd9c 994 format(oss, fmt);
b77dfdc9
WL
995 return oss.str();
996}
997
c5b9bd9c 998inline void printf(const char* fmt)
b77dfdc9 999{
c5b9bd9c 1000 format(std::cout, fmt);
b77dfdc9
WL
1001}
1002
c5b9bd9c
DH
1003inline void printfln(const char* fmt)
1004{
1005 format(std::cout, fmt);
1006 std::cout << '\n';
1007}
b77dfdc9 1008
b77dfdc9
WL
1009#define TINYFORMAT_MAKE_FORMAT_FUNCS(n) \
1010 \
1011template<TINYFORMAT_ARGTYPES(n)> \
1012void format(std::ostream& out, const char* fmt, TINYFORMAT_VARARGS(n)) \
1013{ \
c5b9bd9c 1014 vformat(out, fmt, makeFormatList(TINYFORMAT_PASSARGS(n))); \
b77dfdc9
WL
1015} \
1016 \
1017template<TINYFORMAT_ARGTYPES(n)> \
1018std::string format(const char* fmt, TINYFORMAT_VARARGS(n)) \
1019{ \
1020 std::ostringstream oss; \
c5b9bd9c 1021 format(oss, fmt, TINYFORMAT_PASSARGS(n)); \
b77dfdc9
WL
1022 return oss.str(); \
1023} \
1024 \
1025template<TINYFORMAT_ARGTYPES(n)> \
c5b9bd9c 1026void printf(const char* fmt, TINYFORMAT_VARARGS(n)) \
b77dfdc9 1027{ \
c5b9bd9c 1028 format(std::cout, fmt, TINYFORMAT_PASSARGS(n)); \
b77dfdc9
WL
1029} \
1030 \
1031template<TINYFORMAT_ARGTYPES(n)> \
c5b9bd9c 1032void printfln(const char* fmt, TINYFORMAT_VARARGS(n)) \
b77dfdc9 1033{ \
c5b9bd9c
DH
1034 format(std::cout, fmt, TINYFORMAT_PASSARGS(n)); \
1035 std::cout << '\n'; \
b77dfdc9
WL
1036}
1037
1038TINYFORMAT_FOREACH_ARGNUM(TINYFORMAT_MAKE_FORMAT_FUNCS)
1039#undef TINYFORMAT_MAKE_FORMAT_FUNCS
b77dfdc9 1040
c5b9bd9c 1041#endif
b77dfdc9 1042
c5b9bd9c
DH
1043// Added for Bitcoin Core
1044template<typename... Args>
1045std::string format(const std::string &fmt, const Args&... args)
1046{
1047 std::ostringstream oss;
1048 format(oss, fmt.c_str(), args...);
1049 return oss.str();
1050}
b77dfdc9
WL
1051
1052} // namespace tinyformat
1053
9b6d4c5c
WL
1054#define strprintf tfm::format
1055
b77dfdc9 1056#endif // TINYFORMAT_H_INCLUDED
This page took 0.465075 seconds and 4 git commands to generate.