/* Formatting library for C++ Copyright (c) 2012 - 2016, Victor Zverovich All rights reserved. For the license information refer to format.h. */ #ifndef FMT_PRINTF_H_ #define FMT_PRINTF_H_ #include // std::fill_n #include // std::numeric_limits #include "fmt/ostream.h" namespace fmt { namespace internal { // Checks if a value fits in int - used to avoid warnings about comparing // signed and unsigned integers. template struct IntChecker { template static bool fits_in_int(T value) { unsigned max = std::numeric_limits::max(); return value <= max; } static bool fits_in_int(bool) { return true; } }; template <> struct IntChecker { template static bool fits_in_int(T value) { return value >= std::numeric_limits::min() && value <= std::numeric_limits::max(); } static bool fits_in_int(int) { return true; } }; class PrecisionHandler { public: template typename std::enable_if::value, int>::type operator()(T value) { if (!IntChecker::is_signed>::fits_in_int(value)) FMT_THROW(format_error("number is too big")); return static_cast(value); } template typename std::enable_if::value, int>::type operator()(T) { FMT_THROW(format_error("precision is not integer")); return 0; } }; // An argument visitor that returns true iff arg is a zero integer. class IsZeroInt { public: template typename std::enable_if::value, bool>::type operator()(T value) { return value == 0; } template typename std::enable_if::value, bool>::type operator()(T value) { return false; } }; template struct is_same { enum { value = 0 }; }; template struct is_same { enum { value = 1 }; }; template class ArgConverter { private: format_arg &arg_; wchar_t type_; public: ArgConverter(format_arg &arg, wchar_t type) : arg_(arg), type_(type) {} void operator()(bool value) { if (type_ != 's') operator()(value); } template typename std::enable_if::value>::type operator()(U value) { bool is_signed = type_ == 'd' || type_ == 'i'; typedef typename internal::Conditional< is_same::value, U, T>::type TargetType; if (sizeof(TargetType) <= sizeof(int)) { // Extra casts are used to silence warnings. if (is_signed) { arg_.type = format_arg::INT; arg_.int_value = static_cast(static_cast(value)); } else { arg_.type = format_arg::UINT; typedef typename internal::MakeUnsigned::Type Unsigned; arg_.uint_value = static_cast(static_cast(value)); } } else { if (is_signed) { arg_.type = format_arg::LONG_LONG; // glibc's printf doesn't sign extend arguments of smaller types: // std::printf("%lld", -42); // prints "4294967254" // but we don't have to do the same because it's a UB. arg_.long_long_value = static_cast(value); } else { arg_.type = format_arg::ULONG_LONG; arg_.ulong_long_value = static_cast::Type>(value); } } } template typename std::enable_if::value>::type operator()(U value) { // No coversion needed for non-integral types. } }; // Converts an integer argument to T for printf, if T is an integral type. // If T is void, the argument is converted to corresponding signed or unsigned // type depending on the type specifier: 'd' and 'i' - signed, other - // unsigned). template void convert_arg(format_arg &arg, wchar_t type) { visit(ArgConverter(arg, type), arg); } // Converts an integer argument to char for printf. class CharConverter { private: format_arg &arg_; FMT_DISALLOW_COPY_AND_ASSIGN(CharConverter); public: explicit CharConverter(format_arg &arg) : arg_(arg) {} template typename std::enable_if::value>::type operator()(T value) { arg_.type = format_arg::CHAR; arg_.int_value = static_cast(value); } template typename std::enable_if::value>::type operator()(T value) { // No coversion needed for non-integral types. } }; // Checks if an argument is a valid printf width specifier and sets // left alignment if it is negative. class WidthHandler { private: FormatSpec &spec_; FMT_DISALLOW_COPY_AND_ASSIGN(WidthHandler); public: explicit WidthHandler(FormatSpec &spec) : spec_(spec) {} template typename std::enable_if::value, unsigned>::type operator()(T value) { typedef typename internal::IntTraits::MainType UnsignedType; UnsignedType width = static_cast(value); if (internal::is_negative(value)) { spec_.align_ = ALIGN_LEFT; width = 0 - width; } unsigned int_max = std::numeric_limits::max(); if (width > int_max) FMT_THROW(format_error("number is too big")); return static_cast(width); } template typename std::enable_if::value, unsigned>::type operator()(T value) { FMT_THROW(format_error("width is not integer")); return 0; } }; } // namespace internal /** \rst The ``printf`` argument formatter. \endrst */ template class PrintfArgFormatter : public internal::ArgFormatterBase { private: void write_null_pointer() { this->spec().type_ = 0; this->write("(nil)"); } typedef internal::ArgFormatterBase Base; public: /** \rst Constructs an argument formatter object. *writer* is a reference to the output writer and *spec* contains format specifier information for standard argument types. \endrst */ PrintfArgFormatter(BasicWriter &writer, FormatSpec &spec) : internal::ArgFormatterBase(writer, spec) {} using Base::operator(); /** Formats an argument of type ``bool``. */ void operator()(bool value) { FormatSpec &fmt_spec = this->spec(); if (fmt_spec.type_ != 's') return (*this)(value ? 1 : 0); fmt_spec.type_ = 0; this->write(value); } /** Formats a character. */ void operator()(wchar_t value) { const FormatSpec &fmt_spec = this->spec(); BasicWriter &w = this->writer(); if (fmt_spec.type_ && fmt_spec.type_ != 'c') w.write_int(value, fmt_spec); typedef typename BasicWriter::CharPtr CharPtr; CharPtr out = CharPtr(); if (fmt_spec.width_ > 1) { Char fill = ' '; out = w.grow_buffer(fmt_spec.width_); if (fmt_spec.align_ != ALIGN_LEFT) { std::fill_n(out, fmt_spec.width_ - 1, fill); out += fmt_spec.width_ - 1; } else { std::fill_n(out + 1, fmt_spec.width_ - 1, fill); } } else { out = w.grow_buffer(1); } *out = static_cast(value); } /** Formats a null-terminated C string. */ void operator()(const char *value) { if (value) Base::operator()(value); else if (this->spec().type_ == 'p') write_null_pointer(); else this->write("(null)"); } /** Formats a pointer. */ void operator()(const void *value) { if (value) return Base::operator()(value); this->spec().type_ = 0; write_null_pointer(); } /** Formats an argument of a custom (user-defined) type. */ void operator()(format_arg::CustomValue c) { const Char format_str[] = {'}', '\0'}; auto args = basic_format_args>(); basic_format_context ctx(format_str, args); c.format(&this->writer(), c.value, &ctx); } }; /** This template formats data and writes the output to a writer. */ template > class printf_context : private internal::format_context_base< Char, printf_context> { public: /** The character type for the output. */ typedef Char char_type; private: typedef internal::format_context_base Base; void parse_flags(FormatSpec &spec, const Char *&s); // Returns the argument with specified index or, if arg_index is equal // to the maximum unsigned value, the next argument. format_arg get_arg( const Char *s, unsigned arg_index = (std::numeric_limits::max)()); // Parses argument index, flags and width and returns the argument index. unsigned parse_header(const Char *&s, FormatSpec &spec); public: /** \rst Constructs a ``printf_context`` object. References to the arguments and the writer are stored in the context object so make sure they have appropriate lifetimes. \endrst */ explicit printf_context(BasicCStringRef format_str, basic_format_args args) : Base(format_str.c_str(), args) {} /** Formats stored arguments and writes the output to the writer. */ FMT_API void format(BasicWriter &writer); }; template void printf_context::parse_flags(FormatSpec &spec, const Char *&s) { for (;;) { switch (*s++) { case '-': spec.align_ = ALIGN_LEFT; break; case '+': spec.flags_ |= SIGN_FLAG | PLUS_FLAG; break; case '0': spec.fill_ = '0'; break; case ' ': spec.flags_ |= SIGN_FLAG; break; case '#': spec.flags_ |= HASH_FLAG; break; default: --s; return; } } } template format_arg printf_context::get_arg(const Char *s, unsigned arg_index) { (void)s; const char *error = 0; format_arg arg = arg_index == std::numeric_limits::max() ? this->next_arg(error) : Base::get_arg(arg_index - 1, error); if (error) FMT_THROW(format_error(!*s ? "invalid format string" : error)); return arg; } template unsigned printf_context::parse_header( const Char *&s, FormatSpec &spec) { unsigned arg_index = std::numeric_limits::max(); Char c = *s; if (c >= '0' && c <= '9') { // Parse an argument index (if followed by '$') or a width possibly // preceded with '0' flag(s). unsigned value = internal::parse_nonnegative_int(s); if (*s == '$') { // value is an argument index ++s; arg_index = value; } else { if (c == '0') spec.fill_ = '0'; if (value != 0) { // Nonzero value means that we parsed width and don't need to // parse it or flags again, so return now. spec.width_ = value; return arg_index; } } } parse_flags(spec, s); // Parse width. if (*s >= '0' && *s <= '9') { spec.width_ = internal::parse_nonnegative_int(s); } else if (*s == '*') { ++s; spec.width_ = visit(internal::WidthHandler(spec), get_arg(s)); } return arg_index; } template void printf_context::format(BasicWriter &writer) { const Char *start = this->ptr(); const Char *s = start; while (*s) { Char c = *s++; if (c != '%') continue; if (*s == c) { internal::write(writer, start, s); start = ++s; continue; } internal::write(writer, start, s - 1); FormatSpec spec; spec.align_ = ALIGN_RIGHT; // Parse argument index, flags and width. unsigned arg_index = parse_header(s, spec); // Parse precision. if (*s == '.') { ++s; if ('0' <= *s && *s <= '9') { spec.precision_ = static_cast(internal::parse_nonnegative_int(s)); } else if (*s == '*') { ++s; spec.precision_ = visit(internal::PrecisionHandler(), get_arg(s)); } } format_arg arg = get_arg(s, arg_index); if (spec.flag(HASH_FLAG) && visit(internal::IsZeroInt(), arg)) spec.flags_ &= ~internal::to_unsigned(HASH_FLAG); if (spec.fill_ == '0') { if (arg.type <= format_arg::LAST_NUMERIC_TYPE) spec.align_ = ALIGN_NUMERIC; else spec.fill_ = ' '; // Ignore '0' flag for non-numeric types. } // Parse length and convert the argument to the required type. using internal::convert_arg; switch (*s++) { case 'h': if (*s == 'h') convert_arg(arg, *++s); else convert_arg(arg, *s); break; case 'l': if (*s == 'l') convert_arg(arg, *++s); else convert_arg(arg, *s); break; case 'j': convert_arg(arg, *s); break; case 'z': convert_arg(arg, *s); break; case 't': convert_arg(arg, *s); break; case 'L': // printf produces garbage when 'L' is omitted for long double, no // need to do the same. break; default: --s; convert_arg(arg, *s); } // Parse type. if (!*s) FMT_THROW(format_error("invalid format string")); spec.type_ = static_cast(*s++); if (arg.type <= format_arg::LAST_INTEGER_TYPE) { // Normalize type. switch (spec.type_) { case 'i': case 'u': spec.type_ = 'd'; break; case 'c': // TODO: handle wchar_t visit(internal::CharConverter(arg), arg); break; } } start = s; // Format argument. visit(AF(writer, spec), arg); } internal::write(writer, start, s); } // Formats a value. template void format_value(BasicWriter &w, const T &value, printf_context& ctx) { internal::MemoryBuffer buffer; w << internal::format_value(buffer, value); } template void printf(BasicWriter &w, BasicCStringRef format, basic_format_args> args) { printf_context(format, args).format(w); } inline std::string vsprintf(CStringRef format, basic_format_args> args) { MemoryWriter w; printf(w, format, args); return w.str(); } /** \rst Formats arguments and returns the result as a string. **Example**:: std::string message = fmt::sprintf("The answer is %d", 42); \endrst */ template inline std::string sprintf(CStringRef format_str, const Args & ... args) { return vsprintf(format_str, make_xformat_args>(args...)); } inline std::wstring vsprintf(WCStringRef format, basic_format_args> args) { WMemoryWriter w; printf(w, format, args); return w.str(); } template inline std::wstring sprintf(WCStringRef format_str, const Args & ... args) { auto vargs = make_xformat_args>(args...); return vsprintf(format_str, vargs); } FMT_API int vfprintf(std::FILE *f, CStringRef format, basic_format_args> args); /** \rst Prints formatted data to the file *f*. **Example**:: fmt::fprintf(stderr, "Don't %s!", "panic"); \endrst */ template inline int fprintf(std::FILE *f, CStringRef format_str, const Args & ... args) { auto vargs = make_xformat_args>(args...); return vfprintf(f, format_str, vargs); } inline int vprintf(CStringRef format, basic_format_args> args) { return vfprintf(stdout, format, args); } /** \rst Prints formatted data to ``stdout``. **Example**:: fmt::printf("Elapsed time: %.2f seconds", 1.23); \endrst */ template inline int printf(CStringRef format_str, const Args & ... args) { return vprintf(format_str, make_xformat_args>(args...)); } inline int vfprintf(std::ostream &os, CStringRef format_str, basic_format_args> args) { MemoryWriter w; printf(w, format_str, args); internal::write(os, w); return static_cast(w.size()); } /** \rst Prints formatted data to the stream *os*. **Example**:: fprintf(cerr, "Don't %s!", "panic"); \endrst */ template inline int fprintf(std::ostream &os, CStringRef format_str, const Args & ... args) { auto vargs = make_xformat_args>(args...); return vfprintf(os, format_str, vargs); } } // namespace fmt #endif // FMT_PRINTF_H_