/*
 * File: z-form.h
 * Purpose: Low level text formatting
 */

#ifndef INCLUDED_Z_FORM_H
#define INCLUDED_Z_FORM_H

/*
 * This file provides functions very similar to "sprintf()", but which
 * not only parse some additional "format sequences", but also enforce
 * bounds checking, and allow repeated "appends" to the same buffer.
 *
 * See "z-form.c" for more detailed information about the routines,
 * including a list of the legal "format sequences".
 *
 * This file makes use of both "z-util.c" and "z-virt.c"
 */

/**** Available Functions ****/

/*
 * Format arguments into given bounded-length buffer
 */
extern size_t vstrnfmt(char *buf, size_t max, const char *fmt, va_list vp);

/*
 * Simple interface to "vstrnfmt()"
 */
extern size_t strnfmt(char *buf, size_t max, const char *fmt, ...);

/*
 * Format arguments into a static resizing buffer
 */
extern char *vformat(const char *fmt, va_list vp);

/*
 * Free the memory allocated for the format buffer
 */
extern void vformat_kill(void);

/*
 * Append a formatted string to another string
 */
extern void strnfcat(char *str, size_t max, size_t *end, const char *fmt, ...);

/*
 * Simple interface to "vformat()"
 */
extern char *format(const char *fmt, ...);

/*
 * Vararg interface to "plog()", using "format()"
 */
extern void plog_fmt(const char *fmt, ...);

/*
 * Vararg interface to "quit()", using "format()"
 */
extern void quit_fmt(const char *fmt, ...);

#endif /* INCLUDED_Z_FORM_H */
