mulle-sprintf

🔢 An extensible sprintf function supporting stdarg and mulle-vararg

The extensibility is used in MulleObjCStandardFoundation to add object conversion (%@) and to print BOOL values as 'YES', 'NO' (%bd).

Supports non-standard UTF32 (%lS) and UTF16 (%hS) output. No more wchar_t pain.

mulle-sprintf can handle varargs and mulle_vararg style variable arguments.

Floating point conversion is done by mulle-dtoa, but fallback to C library FP can be used with NO_MULLE__DTOA.

Release Version	Release Notes	AI Documentation
	RELEASENOTES	DeepWiki for mulle-sprintf

API

File	Description
mulle_sprintf	The various sprintf like functions

Major stdlib-compatible functions

Function	Description
mulle_sprintf	sprintf replacement
mulle_snprintf	snprintf replacement
mulle_asprintf	asprintf replacement
mulle_buffer_sprintf	sprintf into mulle_buffer
mulle_allocator_asprintf	asprintf with custom allocator

Format characters

For more detailed information on each characte consult a sprintf man page.

Flag Characters

Character	Description
(SPC)	A blank should be left before a positive number.
0	The value should be zero padded.
#	The value should be converted to an "alternate form".
-	The converted value is to be left adjusted on the field boundary.
+	A sign (+ or -) should always be placed before a number.
'	Use thousands' grouping characters (UNUSED)
b	BOOL, print as YES or NO (for Objective-C)

Length modifier

Characters	Description
h	short (or utf16)
hh	char (or utf8)
j	intmax_t
l	long (or utf32)
ll	long long
L	long double (FP only)
q	int64.
t	ptrdiff_t
z	size_t

Conversion Specifiers (built in)

Integer

Character	Description
i	int as decimal
d	int as decimal
D	long int (compatibility)
u	unsigned int
o	int as octal
x	int as lowercase hex
U	unsigned long int (compatibility)
O	unsigned long int as octal (compatibility)
X	unsigned long int as hex (compatibility)

Used modifiers: all except L

Floating Point (FP)

Uppercase conversion specifiers output value such as 0e-20 or nan as uppercase 0E-20 or NAN.

Character	Description
a	double as hex [-]0xh.hhhhp+-d
e	double as [-]d.ddde+-dd
f	double as [-]ddd.ddd with lowercase for inf/nan
g	double in e or f
A	double as hex [-]0Xh.hhhhP+-d
E	double as [-]d.dddE+-dd
F	double as [-]d.ddde+-dd with uppercase for INF/NAN
G	double in E or F

Used modifiers: L.

The actual conversion is done with the C-library sprintf function. This is contrast with the other conversions, which are not using the C library. For portability across platforms -nan and -0.0 will not be printed with the leading minus sign.

Pointer / String / Other

Character	Description
c	single character
C	wide character (utf16 with h, utf32 with l)
n	return conversion
p	void * as hex with 0x prefix
s	char * as utf8 (alternate form #s: escaped for C String)
S	wide string (utf16 with h, utf32 with l, utf8 with hh)

Used modifiers: hl

Usage

mulle-sprintf provides stdlib-compatible functions that work out of the box:

char buf[ 32];

mulle_snprintf( buf, sizeof( buf), "%d", 1848);

char *str;

mulle_asprintf( &str, "%s %d", "VfL", 1848);
mulle_free( str);

mulle_buffer_do( buffer)
{
    mulle_buffer_sprintf( buffer, "%d", 1848);
}

You are here

Add

This project is a component of the mulle-core library. As such you usually will not add or install it individually, unless you specifically do not want to link against mulle-core.

Add as an individual component

Use mulle-sde to add mulle-sprintf to your project:

mulle-sde add github:mulle-core/mulle-sprintf

To only add the sources of mulle-sprintf with dependency sources use clib:

clib install --out src/mulle-core mulle-core/mulle-sprintf

Add -isystem src/mulle-core to your CFLAGS and compile all the sources that were downloaded with your project.

Install

Use mulle-sde to build and install mulle-sprintf and all dependencies:

mulle-sde install --prefix /usr/local \
   https://github.com/mulle-core/mulle-sprintf/archive/latest.tar.gz

Legacy Installation

Install the requirements:

Requirements	Description
mulle-buffer	↗️ A growable C char array and also a stream - on stack and heap
mulle-utf	🔤 UTF8-16-32 analysis and manipulation library
mulle-vararg	⏪ Access variable arguments in struct layout fashion in C
mulle-thread	🔠 Cross-platform thread/mutex/tss/atomic operations in C
mulle-dtostr	🧶 Double to string conversion

Download the latest tar or zip archive and unpack it.

Install mulle-sprintf into /usr/local with cmake:

PREFIX_DIR="/usr/local"
cmake -B build                               \
      -DMULLE_SDK_PATH="${PREFIX_DIR}"       \
      -DCMAKE_INSTALL_PREFIX="${PREFIX_DIR}" \
      -DCMAKE_PREFIX_PATH="${PREFIX_DIR}"    \
      -DCMAKE_BUILD_TYPE=Release &&
cmake --build build --config Release &&
cmake --install build --config Release

Author

Nat! for Mulle kybernetiK