]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * charybdis - an advanced ircd. | |
3 | * Copyright (c) 2016 William Pitcock <nenolod@dereferenced.org>. | |
4 | * | |
5 | * Permission to use, copy, modify, and/or distribute this software for any | |
6 | * purpose with or without fee is hereby granted, provided that the above | |
7 | * copyright notice and this permission notice is present in all copies. | |
8 | * | |
9 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
10 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
11 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
12 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, | |
13 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
14 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
15 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
16 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
17 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
18 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
19 | * POSSIBILITY OF SUCH DAMAGE. | |
20 | */ | |
21 | ||
22 | #include "s_assert.h" | |
23 | ||
24 | #ifndef CHARYBDIS__MSGBUF_H | |
25 | #define CHARYBDIS__MSGBUF_H | |
26 | ||
27 | #define MAXPARA (15) | |
28 | ||
29 | /* a key-value structure for each message tag. */ | |
30 | struct MsgTag { | |
31 | const char *key; /* the key of the tag (must be set) */ | |
32 | const char *value; /* the value of the tag or NULL */ | |
33 | unsigned int capmask; /* the capability mask this tag belongs to (used only when sending) */ | |
34 | }; | |
35 | ||
36 | struct MsgBuf { | |
37 | size_t n_tags; /* the number of tags in the MsgBuf */ | |
38 | struct MsgTag tags[MAXPARA]; /* the tags themselves, upto MAXPARA tags available */ | |
39 | ||
40 | const char *origin; /* the origin of the message (or NULL) */ | |
41 | const char *target; /* the target of the message (either NULL, or custom defined) */ | |
42 | const char *cmd; /* the cmd/verb of the message (either NULL, or para[0]) */ | |
43 | ||
44 | size_t parselen; /* the length of the message */ | |
45 | size_t n_para; /* the number of parameters (always at least 1 if a full message) */ | |
46 | const char *para[MAXPARA]; /* parameters vector (starting with cmd as para[0]) */ | |
47 | }; | |
48 | ||
49 | /* | |
50 | * parse a message into a MsgBuf. | |
51 | * returns 0 on success, 1 on error. | |
52 | */ | |
53 | int msgbuf_parse(struct MsgBuf *msgbuf, char *line); | |
54 | ||
55 | /* | |
56 | * unparse a pure MsgBuf into a buffer. | |
57 | * if origin is NULL, me.name will be used. | |
58 | * cmd may not be NULL. | |
59 | * returns 0 on success, 1 on error. | |
60 | */ | |
61 | int msgbuf_unparse(char *buf, size_t buflen, struct MsgBuf *msgbuf, unsigned int capmask); | |
62 | ||
63 | /* | |
64 | * unparse a MsgBuf header plus payload into a buffer. | |
65 | * if origin is NULL, me.name will be used. | |
66 | * cmd may not be NULL. | |
67 | * returns 0 on success, 1 on error. | |
68 | */ | |
69 | int msgbuf_unparse_fmt(char *buf, size_t buflen, struct MsgBuf *head, unsigned int capmask, const char *fmt, ...) AFP(5, 6); | |
70 | int msgbuf_vunparse_fmt(char *buf, size_t buflen, struct MsgBuf *head, unsigned int capmask, const char *fmt, va_list va); | |
71 | ||
72 | void msgbuf_unparse_prefix(char *buf, size_t buflen, struct MsgBuf *msgbuf, unsigned int capmask); | |
73 | ||
74 | static inline void | |
75 | msgbuf_init(struct MsgBuf *msgbuf) | |
76 | { | |
77 | memset(msgbuf, 0, sizeof(*msgbuf)); | |
78 | } | |
79 | ||
80 | static inline void | |
81 | msgbuf_append_tag(struct MsgBuf *msgbuf, const char *key, const char *value, unsigned int capmask) | |
82 | { | |
83 | s_assert(msgbuf->n_tags < MAXPARA); | |
84 | ||
85 | msgbuf->tags[msgbuf->n_tags].key = key; | |
86 | msgbuf->tags[msgbuf->n_tags].value = value; | |
87 | msgbuf->tags[msgbuf->n_tags].capmask = capmask; | |
88 | msgbuf->n_tags++; | |
89 | } | |
90 | ||
91 | static inline void | |
92 | msgbuf_append_para(struct MsgBuf *msgbuf, const char *para) | |
93 | { | |
94 | s_assert(msgbuf->n_para < MAXPARA); | |
95 | ||
96 | msgbuf->para[msgbuf->n_para] = para; | |
97 | msgbuf->n_para++; | |
98 | } | |
99 | ||
100 | #endif |