writer.h File Reference

The writer interface. More...

#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include <unistd.h>
#include <interface99.h>
#include <slice99.h>
#include <compy/priv/compiler_attrs.h>

Include dependency graph for writer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	Compy_Writer_IFACE
	The user-supplied data writer interface.
#define	COMPY_WRITE_SLICES(w, ...)
	The same as compy_write_slices but calculates an array length from variadic arguments (the syntactically separated items of the array).

Functions
	interface99 (Compy_Writer)
	Defines the Compy_Writer interface.
ssize_t	compy_write_slices (Compy_Writer w, size_t len, const CharSlice99 data[restrict static len]) COMPY_PRIV_MUST_USE
	Sequentially writes all items in data to w.
Compy_Writer	compy_fd_writer (int *fd) COMPY_PRIV_MUST_USE
	A writer that invokes write on a provided file descriptor.
Compy_Writer	compy_file_writer (FILE *stream) COMPY_PRIV_MUST_USE
	A writer that invokes fwrite on a provided file pointer.
Compy_Writer	compy_string_writer (char *buffer) COMPY_PRIV_MUST_USE
	A writer that invokes strncat on a provided buffer.

Detailed Description

The writer interface.

Macro Definition Documentation

COMPY_WRITE_SLICES

#define COMPY_WRITE_SLICES	(		w,
			...
	)

Value:

    compy_write_slices(                                                        \
        w, SLICE99_ARRAY_LEN((const CharSlice99[])__VA_ARGS__),                \
        (const CharSlice99[])__VA_ARGS__)

The same as compy_write_slices but calculates an array length from variadic arguments (the syntactically separated items of the array).

Compy_Writer_IFACE

#define Compy_Writer_IFACE

Value:

                                                                               \
    /*                                                                         \
     * Writes @p data into itself.                                             \
     *                                                                         \
     * @param[in] data The slice of character data to write.                   \
     *                                                                         \
     * @return The number of bytes written or a negative value on error.       \
     */                                                                        \
    vfunc99(ssize_t, write, VSelf99, CharSlice99 data)                         \
                                                                               \
    /*                                                                         \
     * Lock writer to prevent race conditions on TCP interleaved channels      \
     */                                                                        \
    vfunc99(void, lock, VSelf99)                                               \
                                                                               \
    /*                                                                         \
     * Unlock writer locked by `lock`                                          \
     */                                                                        \
    vfunc99(void, unlock, VSelf99)                                             \
                                                                               \
    /*                                                                         \
     * Get current size of output buffer                                       \
     */                                                                        \
    vfunc99(size_t, filled, VSelf99)                                           \
                                                                               \
    /*                                                                         \
     * Writes a formatted string into itself.                                  \
     *                                                                         \
     * @param[in] fmt The `printf`-like format string.                         \
     *                                                                         \
     * @return The number of bytes written or a negative value on error.       \
     */                                                                        \
    vfunc99(int, writef, VSelf99, const char *restrict fmt, ...)               \
                                                                               \
    /*                                                                         \
     * The same as `printf` but accepts `va_list`.                             \
     */                                                                        \
    vfunc99(int, vwritef, VSelf99, const char *restrict fmt, va_list ap)

The user-supplied data writer interface.

Function Documentation

compy_fd_writer()

Compy_Writer compy_fd_writer

(

int *

fd

)

A writer that invokes write on a provided file descriptor.

Precondition

fd != NULL

compy_file_writer()

Compy_Writer compy_file_writer

(

FILE *

stream

)

A writer that invokes fwrite on a provided file pointer.

Precondition

stream != NULL

compy_string_writer()

Compy_Writer compy_string_writer

(

char *

buffer

)

A writer that invokes strncat on a provided buffer.

Precondition

buffer shall be capable of holding all characters that will be written into it.

compy_write_slices()

ssize_t compy_write_slices	(	Compy_Writer	w,
		size_t	len,
		const CharSlice99	data[restrict static len]
	)

Sequentially writes all items in data to w.

Parameters

[in]	w	The writer to be provided with data.
[in]	len	The number of items in data.
[in]	data	The data array which will be written to w, one-by-one.

Returns

The number of bytes written or a negative value on error.

Precondition

w.self && w.vptr

interface99()

interface99

(

Compy_Writer

)

Defines the Compy_Writer interface.

See Interface99 for the macro usage.