basic_printf_context< OutputIt, Char, ArgFormatter > Class Template Reference

#include <printf.h>

Inheritance diagram for basic_printf_context< OutputIt, Char, ArgFormatter >:

Classes
struct	formatter_type

Public Types
typedef Char	char_type
Public Types inherited from internal::context_base< OutputIt, basic_printf_context< OutputIt, Char, ArgFormatter >, Char >
typedef OutputIt	iterator

Public Member Functions
	basic_printf_context (OutputIt out, basic_string_view< char_type > format_str, basic_format_args< basic_printf_context > args)
void	format ()
Public Member Functions inherited from internal::context_base< OutputIt, basic_printf_context< OutputIt, Char, ArgFormatter >, Char >
basic_parse_context< char_type > &	parse_context ()
basic_format_args< basic_printf_context< OutputIt, Char, ArgFormatter > >	args () const
basic_format_arg< basic_printf_context< OutputIt, Char, ArgFormatter > >	arg (unsigned id) const
internal::error_handler	error_handler ()
void	on_error (const char *message)
iterator	out ()
iterator	begin ()
void	advance_to (iterator it)
locale_ref	locale ()

Private Types
typedef internal::context_base< OutputIt, basic_printf_context, Char >	base
typedef base::format_arg	format_arg
typedef basic_format_specs< char_type >	format_specs
typedef internal::null_terminating_iterator< char_type >	iterator

Private Member Functions
void	parse_flags (format_specs &spec, iterator &it)
format_arg	get_arg (iterator it, unsigned arg_index=(std::numeric_limits< unsigned >::max)())
unsigned	parse_header (iterator &it, format_specs &spec)

Additional Inherited Members
Protected Types inherited from internal::context_base< OutputIt, basic_printf_context< OutputIt, Char, ArgFormatter >, Char >
typedef Char	char_type
typedef basic_format_arg< basic_printf_context< OutputIt, Char, ArgFormatter > >	format_arg
Protected Member Functions inherited from internal::context_base< OutputIt, basic_printf_context< OutputIt, Char, ArgFormatter >, Char >
	context_base (OutputIt out, basic_string_view< char_type > format_str, basic_format_args< basic_printf_context< OutputIt, Char, ArgFormatter > > ctx_args, locale_ref loc=locale_ref())
format_arg	do_get_arg (unsigned arg_id)
format_arg	get_arg (unsigned arg_id)

Detailed Description

template<typename OutputIt, typename Char, typename ArgFormatter>
class basic_printf_context< OutputIt, Char, ArgFormatter >

This template formats data and writes the output to a writer.

Definition at line 336 of file printf.h.

Member Typedef Documentation

template<typename OutputIt, typename Char, typename ArgFormatter>

typedef internal::context_base<OutputIt, basic_printf_context, Char> basic_printf_context< OutputIt, Char, ArgFormatter >::base

private

Definition at line 485 of file printf.h.

template<typename OutputIt, typename Char, typename ArgFormatter>

typedef Char basic_printf_context< OutputIt, Char, ArgFormatter >::char_type

The character type for the output.

Definition at line 479 of file printf.h.

template<typename OutputIt, typename Char, typename ArgFormatter>

typedef base::format_arg basic_printf_context< OutputIt, Char, ArgFormatter >::format_arg

private

Definition at line 486 of file printf.h.

template<typename OutputIt, typename Char, typename ArgFormatter>

typedef basic_format_specs<char_type> basic_printf_context< OutputIt, Char, ArgFormatter >::format_specs

private

Definition at line 487 of file printf.h.

template<typename OutputIt, typename Char, typename ArgFormatter>

typedef internal::null_terminating_iterator<char_type> basic_printf_context< OutputIt, Char, ArgFormatter >::iterator

private

Definition at line 488 of file printf.h.

Constructor & Destructor Documentation

template<typename OutputIt, typename Char, typename ArgFormatter>

basic_printf_context< OutputIt, Char, ArgFormatter >::basic_printf_context ( OutputIt  out, basic_string_view< char_type >  format_str, basic_format_args< basic_printf_context< OutputIt, Char, ArgFormatter > >  args  )

inline

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.

Definition at line 509 of file printf.h.

    : base(out, format_str, args) {}

Member Function Documentation

template<typename OutputIt , typename Char , typename AF >

void basic_printf_context< OutputIt, Char, AF >::format

(

)

Formats stored arguments and writes the output to the range.

Definition at line 596 of file printf.h.

                                                      {
  auto &buffer = internal::get_container(this->out());
  auto start = iterator(this->parse_context());
  auto it = start;
  using internal::pointer_from;
  while (*it) {
    char_type c = *it++;
    if (c != '%') continue;
    if (*it == c) {
      buffer.append(pointer_from(start), pointer_from(it));
      start = ++it;
      continue;
    }
    buffer.append(pointer_from(start), pointer_from(it) - 1);

    format_specs spec;
    spec.align_ = ALIGN_RIGHT;

    // Parse argument index, flags and width.
    unsigned arg_index = parse_header(it, spec);

    // Parse precision.
    if (*it == '.') {
      ++it;
      if ('0' <= *it && *it <= '9') {
        internal::error_handler eh;
        spec.precision = static_cast<int>(parse_nonnegative_int(it, eh));
      } else if (*it == '*') {
        ++it;
        spec.precision =
            visit_format_arg(internal::printf_precision_handler(), get_arg(it));
      } else {
        spec.precision = 0;
      }
    }

    format_arg arg = get_arg(it, arg_index);
    if (spec.has(HASH_FLAG) && visit_format_arg(internal::is_zero_int(), arg))
      spec.flags = static_cast<uint_least8_t>(spec.flags & (~internal::to_unsigned<int>(HASH_FLAG)));
    if (spec.fill_ == '0') {
      if (arg.is_arithmetic())
        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 (*it++) {
    case 'h':
      if (*it == 'h')
        convert_arg<signed char>(arg, *++it);
      else
        convert_arg<short>(arg, *it);
      break;
    case 'l':
      if (*it == 'l')
        convert_arg<long long>(arg, *++it);
      else
        convert_arg<long>(arg, *it);
      break;
    case 'j':
      convert_arg<intmax_t>(arg, *it);
      break;
    case 'z':
      convert_arg<std::size_t>(arg, *it);
      break;
    case 't':
      convert_arg<std::ptrdiff_t>(arg, *it);
      break;
    case 'L':
      // printf produces garbage when 'L' is omitted for long double, no
      // need to do the same.
      break;
    default:
      --it;
      convert_arg<void>(arg, *it);
    }

    // Parse type.
    if (!*it)
      FMT_THROW(format_error("invalid format string"));
    spec.type = static_cast<char>(*it++);
    if (arg.is_integral()) {
      // Normalize type.
      switch (spec.type) {
      case 'i': case 'u':
        spec.type = 'd';
        break;
      case 'c':
        // TODO: handle wchar_t better?
        visit_format_arg(
              internal::char_converter<basic_printf_context>(arg), arg);
        break;
      }
    }

    start = it;

    // Format argument.
    visit_format_arg(AF(buffer, spec, *this), arg);
  }
  buffer.append(pointer_from(start), pointer_from(it));
}

template<typename OutputIt , typename Char , typename AF >

basic_printf_context< OutputIt, Char, AF >::format_arg basic_printf_context< OutputIt, Char, AF >::get_arg ( iterator  it, unsigned  arg_index = (std::numeric_limits<unsigned>::max)()  )

private

Definition at line 550 of file printf.h.

                                     {
  (void)it;
  if (arg_index == std::numeric_limits<unsigned>::max())
    return this->do_get_arg(this->parse_context().next_arg_id());
  return base::get_arg(arg_index - 1);
}

template<typename OutputIt , typename Char , typename AF >

void basic_printf_context< OutputIt, Char, AF >::parse_flags ( format_specs &  spec, iterator &  it  )

private

Definition at line 522 of file printf.h.

                                      {
  for (;;) {
    switch (*it++) {
      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:
        --it;
        return;
    }
  }
}

template<typename OutputIt , typename Char , typename AF >

unsigned basic_printf_context< OutputIt, Char, AF >::parse_header ( iterator &  it, format_specs &  spec  )

private

Definition at line 559 of file printf.h.

                                    {
  unsigned arg_index = std::numeric_limits<unsigned>::max();
  char_type c = *it;
  if (c >= '0' && c <= '9') {
    // Parse an argument index (if followed by '$') or a width possibly
    // preceded with '0' flag(s).
    internal::error_handler eh;
    unsigned value = parse_nonnegative_int(it, eh);
    if (*it == '$') {  // value is an argument index
      ++it;
      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, it);
  // Parse width.
  if (*it >= '0' && *it <= '9') {
    internal::error_handler eh;
    spec.width_ = parse_nonnegative_int(it, eh);
  } else if (*it == '*') {
    ++it;
    spec.width_ = visit_format_arg(
          internal::printf_width_handler<char_type>(spec), get_arg(it));
  }
  return arg_index;
}

---

The documentation for this class was generated from the following file:

• wire-cell-build/util/inc/spdlog/fmt/bundled/printf.h