MGE General C Library - Full Internal Documentation  v1.7.4
Library of general C functions.
mge-message.h
Go to the documentation of this file.
1 
16 /* **********************************************************************
17  * *
18  * Changelog *
19  * *
20  * Date Author Version Description *
21  * *
22  * 24/10/2017 MG 1.0.1 This ChangeLog introduced. *
23  * 04/11/2017 MG 1.0.2 Add Doxygen comments. *
24  * 09/11/2017 MG 1.0.3 Add SPDX license tag. *
25  * 02/01/2018 MG 1.0.4 Move to new source directory structure. *
26  * 04/08/2018 MG 1.0.5 Change mgemessage.offset to next_free *
27  * and make it size_t. *
28  * Change mgemessage.complete to bool. *
29  * 06/09/2018 MG 1.0.6 Add mgemessage struct initialiser. *
30  * 09/09/2018 MG 1.0.7 Move default message size macro to *
31  * internal header file as it should not *
32  * be part of the API. *
33  * 31/05/2019 MG 1.0.8 Use standard GNU ifdeffery around use *
34  * of AC_HEADER_STDBOOL. *
35  * 08/06/2019 MG 1.0.9 clang-format coding style changes. *
36  * 19/07/2020 MG 1.0.10 Remove get_msg() declaration, remove it *
37  * from API. *
38  * Remove deconstruct_msg() declaration, *
39  * remove it from API. *
40  * 16/04/2021 MG 1.0.11 Add print_def_msg_values() prototype. *
41  * 03/12/2021 MG 1.0.12 Tighten SPDX tag. *
42  * 16/09/2022 MG 1.0.13 Rename of portability.h *
43  * Rename mgebuffer.h *
44  * Rename to standard format mge-message.h *
45  * Remove stdbool ifdeffery. *
46  * *
47  ************************************************************************
48  */
49 
50 #ifndef MGE_MESSAGE_H
51 #define MGE_MESSAGE_H
52 
53 #include <stdbool.h>
54 #include <sys/types.h>
55 
56 #include <libmgec/mge-buffer.h>
58 
60 
64 struct mgemessage {
65  char *message;
66  size_t size;
67  size_t next_free;
68  bool complete;
69  char terminator;
70  char separator;
71  int argc;
72  char **argv;
73 };
74 
78 #define MGEMESSAGE_INIT(a, b) \
79  { \
80  .message = NULL, .size = 0, .next_free = 0, .complete = false, \
81  .terminator = a, .separator = b, .argc = 0, .argv = NULL \
82  }
83 
84 struct mgemessage *pull_msg(struct mgebuffer *buf, struct mgemessage *msg);
85 
86 void clear_msg(struct mgemessage *msg, const char terminator,
87  const char separator);
88 
89 void print_msg(struct mgemessage *msg);
90 
91 void print_def_msg_values(void);
92 
94 
95 #endif /* ndef MGE_MESSAGE_H */
Header file for buffer processing.
void clear_msg(struct mgemessage *msg, const char terminator, const char separator)
Clear message struct.
Definition: message.c:270
struct mgemessage * pull_msg(struct mgebuffer *buf, struct mgemessage *msg)
Pull a message from a buffer object.
Definition: message.c:117
void print_def_msg_values(void)
Print default values to stdout, for debugging.
Definition: message.c:307
void print_msg(struct mgemessage *msg)
Print a message struct.
Definition: message.c:288
Header file to ease portability.
#define BEGIN_C_DECLS
BEGIN_C_DECLS should be used at the beginning of declarations so that C++ compilers don't mangle thei...
Definition: mge-portability.h:48
#define END_C_DECLS
Use END_C_DECLS at the end of C declarations.
Definition: mge-portability.h:52
A buffer object.
Definition: mge-buffer.h:57
Message object.
Definition: mge-message.h:64
size_t next_free
Next free message location.
Definition: mge-message.h:67
char * message
The message buffer.
Definition: mge-message.h:65
char terminator
Message delimmitter.
Definition: mge-message.h:69
char separator
Message element delimitter.
Definition: mge-message.h:70
size_t size
Size of message buffer.
Definition: mge-message.h:66
int argc
Number of arguments to the message.
Definition: mge-message.h:71
char ** argv
Message arguments.
Definition: mge-message.h:72
bool complete
Is message a complete message.
Definition: mge-message.h:68