mgebuffer.h

Go to the documentation of this file.

/* **********************************************************************
 *                                  *
 * Changelog                                *
 *                                  *
 * Date     Author  Version Description             *
 *                                  *
 * 24/10/2017   MG  1.0.1   This ChangeLog introduced.      *
 * 04/11/2017   MG  1.0.2   Add Doxygen commenting.         *
 * 09/11/2017   MG  1.0.3   Add SPDX license tag.           *
 * 02/01/2018   MG  1.0.4   Move to new source directory structure. *
 * 04/08/2018   MG  1.0.5   Improve offset field name to proc_next. *
 *              Improve index field name to next_free.  *
 *              Convert proc_next and next_free to  *
 *              size_t.                 *
 * 06/09/2018   MG  1.0.6   Add an mgebuffer initialisation macro.  *
 * 09/09/2018   MG  1.0.7   Move default buffer size macro to   *
 *              internal header file as it should not   *
 *              be part of the API.         *
 * 25/05/2019   MG  1.0.8   Correct source buffer offset type to    *
 *              unsigned.               *
 * 08/06/2019   MG  1.0.9   clang-format coding style changes.  *
 *                                  *
 ************************************************************************
 */

#ifndef MGEBUFFER_H
#define MGEBUFFER_H

#include <portability.h>
#include <sys/types.h>

BEGIN_C_DECLS

struct mgebuffer {
    char *buffer;     
    size_t size;      
    size_t proc_next; 
    size_t next_free; 
};

#define MGEBUFFER_INIT                                                    \
    {                                                                 \
        .buffer = NULL, .size = 0, .proc_next = 0, .next_free = 0 \
    }

struct mgebuffer *concat_buf(const char *s_buf, const size_t s_buf_os,
                 struct mgebuffer *m_buf);

struct mgebuffer *trim_buf(struct mgebuffer *msg_buf);

void print_buf(struct mgebuffer *m_buf);

END_C_DECLS

#endif /* ndef MGEBUFFER_H */