mgemessage.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 comments.           *
 * 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   Change mgemessage.offset to next_free   *
 *              and make it size_t.         *
 *              Change mgemessage.complete to bool. *
 * 06/09/2018   MG  1.0.6   Add mgemessage struct initialiser.  *
 * 09/09/2018   MG  1.0.7   Move default message size macro to  *
 *              internal header file as it should not   *
 *              be part of the API.         *
 * 31/05/2019   MG  1.0.8   Use standard GNU ifdeffery around use   *
 *              of AC_HEADER_STDBOOL.           *
 * 08/06/2019   MG  1.0.9   clang-format coding style changes.  *
 * 19/07/2020   MG  1.0.10  Remove get_msg() declaration, remove it *
 *              from API.               *
 *              Remove deconstruct_msg() declaration,   *
 *              remove it from API.         *
 * 16/04/2021   MG  1.0.11  Add print_def_msg_values() prototype.   *
 * 03/12/2021   MG  1.0.12  Tighten SPDX tag.           *
 *                                  *
 ************************************************************************
 */
 
#ifndef MGEMESSAGE_H
#define MGEMESSAGE_H
 
#include <portability.h>
#include <sys/types.h>
 
/* Standard GNU AC_HEADER_STDBOOL ifdeffery. */
#ifdef HAVE_STDBOOL_H
    #include <stdbool.h>
#else
    #ifndef HAVE__BOOL
        #ifdef __cplusplus /* clang-format off */
            typedef bool _Bool; /* clang-format on */
        #else
            #define _Bool signed char
        #endif
    #endif
    #define bool _Bool
    #define false 0
    #define true 1
    #define __bool_true_false_are_defined 1
#endif
 
#include <mgebuffer.h>
 
BEGIN_C_DECLS
 
struct mgemessage {
    char *message;    
    size_t size;      
    size_t next_free; 
    bool complete;    
    char terminator;  
    char separator;   
    int argc;     
    char **argv;      
};
 
#define MGEMESSAGE_INIT(a, b)                                                  \
    {                                                                      \
        .message = NULL, .size = 0, .next_free = 0, .complete = false, \
        .terminator = a, .separator = b, .argc = 0, .argv = NULL       \
    }
 
struct mgemessage *pull_msg(struct mgebuffer *buf, struct mgemessage *msg);
 
void clear_msg(struct mgemessage *msg, const char terminator,
           const char separator);
 
void print_msg(struct mgemessage *msg);
 
void print_def_msg_values(void);
 
END_C_DECLS
 
#endif /* ndef MGEMESSAGE_H */