fmt Namespace Reference

Namespaces
	internal

Classes
struct	AlignSpec
struct	AlignTypeSpec
class	ArgList
class	BasicArrayWriter
class	BasicCStringRef
class	BasicFormatter
class	BasicMemoryWriter
class	BasicStringRef
class	BasicWriter
class	Buffer
class	BufferedFile
struct	EmptySpec
class	ErrorCode
class	File
class	FormatError
class	FormatInt
struct	FormatSpec
class	IntFormatSpec
class	StrFormatSpec
class	SystemError
struct	TypeSpec
struct	WidthSpec

Typedefs
typedef BasicWriter< char >	Writer
typedef BasicWriter< wchar_t >	WWriter
typedef BasicStringRef< char >	StringRef
typedef BasicStringRef< wchar_t >	WStringRef
typedef BasicCStringRef< char >	CStringRef
typedef BasicCStringRef< wchar_t >	WCStringRef
typedef BasicMemoryWriter< char >	MemoryWriter
typedef BasicMemoryWriter < wchar_t >	WMemoryWriter
typedef BasicArrayWriter< char >	ArrayWriter
typedef BasicArrayWriter< wchar_t >	WArrayWriter

Enumerations
enum	Alignment {   ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER,   ALIGN_NUMERIC }
enum	{   SIGN_FLAG = 1, PLUS_FLAG = 2, MINUS_FLAG = 4, HASH_FLAG = 8,   CHAR_FLAG = 0x10 }
enum	Color {   BLACK, RED, GREEN, YELLOW,   BLUE, MAGENTA, CYAN, WHITE }

Functions
template<typename Char , typename T >
void	format (BasicFormatter< Char > &f, const Char *&format_str, const T &value)
IntFormatSpec< int, TypeSpec<'b'> >	bin (int value)
IntFormatSpec< int, TypeSpec<'o'> >	oct (int value)
IntFormatSpec< int, TypeSpec<'x'> >	hex (int value)
IntFormatSpec< int, TypeSpec<'X'> >	hexu (int value)
template<char TYPE_CODE, typename Char >
IntFormatSpec< int, AlignTypeSpec< TYPE_CODE > , Char >	pad (int value, unsigned width, Char fill= ' ')
template<typename Char >
StrFormatSpec< Char >	pad (const Char *str, unsigned width, Char fill= ' ')
StrFormatSpec< wchar_t >	pad (const wchar_t *str, unsigned width, char fill= ' ')
FMT_API void	report_system_error (int error_code, StringRef message) FMT_NOEXCEPT
FMT_API void	print_colored (Color c, CStringRef format, ArgList args)
std::string	format (CStringRef format_str, ArgList args)
std::wstring	format (WCStringRef format_str, ArgList args)
FMT_API void	print (std::FILE *f, CStringRef format_str, ArgList args)
FMT_API void	print (CStringRef format_str, ArgList args)
template<typename Char >
void	printf (BasicWriter< Char > &w, BasicCStringRef< Char > format, ArgList args)
std::string	sprintf (CStringRef format, ArgList args)
std::wstring	sprintf (WCStringRef format, ArgList args)
FMT_API int	fprintf (std::FILE *f, CStringRef format, ArgList args)
int	printf (CStringRef format, ArgList args)
template<typename T >
void	format_decimal (char *&buffer, T value)
template<typename T >
internal::NamedArg< char >	arg (StringRef name, const T &arg)
template<typename T >
internal::NamedArg< wchar_t >	arg (WStringRef name, const T &arg)
template<typename Char >
void	arg (StringRef, const internal::NamedArg< Char > &) FMT_DELETED_OR_UNDEFINED
template<typename Char >
void	arg (WStringRef, const internal::NamedArg< Char > &) FMT_DELETED_OR_UNDEFINED
FMT_API void	print (std::ostream &os, CStringRef format_str, ArgList args)
FMT_API int	fprintf (std::ostream &os, CStringRef format_str, ArgList args)
long	getpagesize ()

Variables
FMT_GCC_EXTENSION typedef long long	LongLong
FMT_GCC_EXTENSION typedef unsigned long long	ULongLong

Typedef Documentation

typedef BasicArrayWriter<char> fmt::ArrayWriter

typedef BasicCStringRef<char> fmt::CStringRef

typedef BasicMemoryWriter<char> fmt::MemoryWriter

typedef BasicStringRef<char> fmt::StringRef

typedef BasicArrayWriter<wchar_t> fmt::WArrayWriter

typedef BasicCStringRef<wchar_t> fmt::WCStringRef

typedef BasicMemoryWriter<wchar_t> fmt::WMemoryWriter

typedef BasicWriter<char> fmt::Writer

typedef BasicStringRef<wchar_t> fmt::WStringRef

typedef BasicWriter<wchar_t> fmt::WWriter

Enumeration Type Documentation

anonymous enum

Enumerator
SIGN_FLAG
PLUS_FLAG
MINUS_FLAG
HASH_FLAG
CHAR_FLAG

 {
 SIGN_FLAG = 1, PLUS_FLAG = 2, MINUS_FLAG = 4, HASH_FLAG = 8,
 CHAR_FLAG = 0x10 // Argument has char type - used in error reporting.
};

enum fmt::Alignment

Enumerator
ALIGN_DEFAULT
ALIGN_LEFT
ALIGN_RIGHT
ALIGN_CENTER
ALIGN_NUMERIC

 {
 ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_NUMERIC
};

enum fmt::Color

Enumerator
BLACK
RED
GREEN
YELLOW
BLUE
MAGENTA
CYAN
WHITE

{ BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE };

Function Documentation

template<typename T >

internal::NamedArg<char> fmt::arg ( StringRef  name, const T &  arg  )

inline

Returns a named argument for formatting functions.

Example**::

print("Elapsed time: {s:.2f} seconds", arg("s", 1.23));

 {
 return internal::NamedArg<char>(name, arg);
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

internal::NamedArg<wchar_t> fmt::arg ( WStringRef  name, const T &  arg  )

inline

 {
 return internal::NamedArg<wchar_t>(name, arg);
}

Here is the call graph for this function:

template<typename Char >

void fmt::arg	(	StringRef	,
		const internal::NamedArg< Char > &
	)

template<typename Char >

void fmt::arg	(	WStringRef	,
		const internal::NamedArg< Char > &
	)

Here is the caller graph for this function:

IntFormatSpec<int, TypeSpec<'b'> > fmt::bin

(

int

value

)

Returns an integer format specifier to format the value in base 2.

template<typename Char , typename T >

void fmt::format	(	BasicFormatter< Char > &	f,
		const Char *&	format_str,
		const T &	value
	)

 {
 internal::MemoryBuffer<Char, internal::INLINE_BUFFER_SIZE> buffer;

 internal::FormatBuf<Char> format_buf(buffer);
 std::basic_ostream<Char> output(&format_buf);
 output << value;

 BasicStringRef<Char> str(&buffer[0], format_buf.size());
 typedef internal::MakeArg< BasicFormatter<Char> > MakeArg;
 format_str = f.format(format_str, MakeArg(str));
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string fmt::format ( CStringRef  format_str, ArgList  args  )

inline

Formats arguments and returns the result as a string.

Example**::

std::string message = format("The answer is {}", 42);

 {
 MemoryWriter w;
 w.write(format_str, args);
 return w.str();
}

Here is the call graph for this function:

std::wstring fmt::format ( WCStringRef  format_str, ArgList  args  )

inline

 {
 WMemoryWriter w;
 w.write(format_str, args);
 return w.str();
}

Here is the call graph for this function:

template<typename T >

void fmt::format_decimal ( char *&  buffer, T  value  )

inline

 {
 typedef typename internal::IntTraits<T>::MainType MainType;
 MainType abs_value = static_cast<MainType>(value);
 if (internal::is_negative(value)) {
 *buffer++ = '-';
 abs_value = 0 - abs_value;
 }
 if (abs_value < 100) {
 if (abs_value < 10) {
 *buffer++ = static_cast<char>('0' + abs_value);
 return;
 }
 unsigned index = static_cast<unsigned>(abs_value * 2);
 *buffer++ = internal::Data::DIGITS[index];
 *buffer++ = internal::Data::DIGITS[index + 1];
 return;
 }
 unsigned num_digits = internal::count_digits(abs_value);
 internal::format_decimal(buffer, abs_value, num_digits);
 buffer += num_digits;
}

Here is the call graph for this function:

Here is the caller graph for this function:

FMT_API int fmt::fprintf	(	std::FILE *	f,
		CStringRef	format,
		ArgList	args
	)

Prints formatted data to the file f.

Example**::

fmt::fprintf(stderr, "Don't %s!", "panic");

Here is the caller graph for this function:

FMT_API int fmt::fprintf	(	std::ostream &	os,
		CStringRef	format_str,
		ArgList	args
	)

Prints formatted data to the stream os.

Example**::

fprintf(cerr, "Don't %s!", "panic");

Here is the caller graph for this function:

long fmt::getpagesize

(

)

IntFormatSpec<int, TypeSpec<'x'> > fmt::hex

(

int

value

)

Returns an integer format specifier to format the value in base 16 using lower-case letters for the digits above 9.

Here is the caller graph for this function:

IntFormatSpec<int, TypeSpec<'X'> > fmt::hexu

(

int

value

)

Returns an integer formatter format specifier to format in base 16 using upper-case letters for the digits above 9.

IntFormatSpec<int, TypeSpec<'o'> > fmt::oct

(

int

value

)

Returns an integer format specifier to format the value in base 8.

template<char TYPE_CODE, typename Char >

IntFormatSpec<int, AlignTypeSpec<TYPE_CODE>, Char> fmt::pad	(	int	value,
		unsigned	width,
		Char	fill = ' '
	)

Returns an integer format specifier to pad the formatted argument with the fill character to the specified width using the default (right) numeric alignment.

Example**::

MemoryWriter out; out << pad(hex(0xcafe), 8, '0'); out.str() == "0000cafe"

Here is the caller graph for this function:

template<typename Char >

StrFormatSpec<Char> fmt::pad ( const Char *  str, unsigned  width, Char  fill = ' '  )

inline

Returns a string formatter that pads the formatted argument with the fill character to the specified width using the default (left) string alignment.

Example**::

std::string s = str(MemoryWriter() << pad("abc", 8)); s == "abc "

 {
 return StrFormatSpec<Char>(str, width, fill);
}

StrFormatSpec<wchar_t> fmt::pad ( const wchar_t *  str, unsigned  width, char  fill = ' '  )

inline

 {
 return StrFormatSpec<wchar_t>(str, width, fill);
}

FMT_API void fmt::print	(	std::FILE *	f,
		CStringRef	format_str,
		ArgList	args
	)

Prints formatted data to the file f.

Example**::

print(stderr, "Don't {}!", "panic");

Here is the caller graph for this function:

FMT_API void fmt::print	(	CStringRef	format_str,
		ArgList	args
	)

Prints formatted data to stdout.

Example**::

print("Elapsed time: {0:.2f} seconds", 1.23);

FMT_API void fmt::print	(	std::ostream &	os,
		CStringRef	format_str,
		ArgList	args
	)

Prints formatted data to the stream os.

Example**::

print(cerr, "Don't {}!", "panic");

FMT_API void fmt::print_colored	(	Color	c,
		CStringRef	format,
		ArgList	args
	)

Formats a string and prints it to stdout using ANSI escape sequences to specify color (experimental). Example: print_colored(fmt::RED, "Elapsed time: {0:.2f} seconds", 1.23);

template<typename Char >

void fmt::printf	(	BasicWriter< Char > &	w,
		BasicCStringRef< Char >	format,
		ArgList	args
	)

 {
 internal::PrintfFormatter<Char>(args).format(w, format);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int fmt::printf ( CStringRef  format, ArgList  args  )

inline

Prints formatted data to stdout.

Example**::

fmt::printf("Elapsed time: %.2f seconds", 1.23);

 {
 return fprintf(stdout, format, args);
}

Here is the call graph for this function:

Here is the caller graph for this function:

FMT_API void fmt::report_system_error	(	int	error_code,
		StringRef	message
	)

std::string fmt::sprintf ( CStringRef  format, ArgList  args  )

inline

Formats arguments and returns the result as a string.

Example**::

std::string message = fmt::sprintf("The answer is %d", 42);

 {
 MemoryWriter w;
 printf(w, format, args);
 return w.str();
}

Here is the call graph for this function:

std::wstring fmt::sprintf ( WCStringRef  format, ArgList  args  )

inline

 {
 WMemoryWriter w;
 printf(w, format, args);
 return w.str();
}

Here is the call graph for this function:

Variable Documentation

FMT_GCC_EXTENSION typedef long long fmt::LongLong

FMT_GCC_EXTENSION typedef unsigned long long fmt::ULongLong