writer.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
 
#include <unistd.h>
 
#include <interface99.h>
#include <slice99.h>
 
#include <compy/priv/compiler_attrs.h>
 
#define Compy_Writer_IFACE                                                     \
                                                                               \
    /*                                                                         \
     * 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)
 
interface99(Compy_Writer);
 
#define COMPY_WRITE_SLICES(w, ...)                                             \
    compy_write_slices(                                                        \
        w, SLICE99_ARRAY_LEN((const CharSlice99[])__VA_ARGS__),                \
        (const CharSlice99[])__VA_ARGS__)
 
ssize_t compy_write_slices(
    Compy_Writer w, size_t len,
    const CharSlice99 data[restrict static len]) COMPY_PRIV_MUST_USE;
 
Compy_Writer compy_fd_writer(int *fd) COMPY_PRIV_MUST_USE;
 
Compy_Writer compy_file_writer(FILE *stream) COMPY_PRIV_MUST_USE;
 
Compy_Writer compy_string_writer(char *buffer) COMPY_PRIV_MUST_USE;