include/msgbuf.h

   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 #ifndef CHARYBDIS__MSGBUF_H
  23 #define CHARYBDIS__MSGBUF_H
  24
  25 #define MAXPARA         (15)
  26
  27 /* a key-value structure for each message tag. */
  28 struct MsgTag {
  29         const char *key;                /* the key of the tag (must be set) */
  30         const char *value;              /* the value of the tag or NULL */
  31         unsigned int capmask;           /* the capability mask this tag belongs to (used only when sending) */
  32 };
  33
  34 struct MsgBuf {
  35         size_t n_tags;                  /* the number of tags in the MsgBuf */
  36         struct MsgTag tags[MAXPARA];    /* the tags themselves, upto MAXPARA tags available */
  37
  38         const char *origin;             /* the origin of the message (or NULL) */
  39         const char *target;             /* the target of the message (either NULL, or custom defined) */
  40         const char *cmd;                /* the cmd/verb of the message (either NULL, or para[0]) */
  41
  42         size_t n_para;                  /* the number of parameters (always at least 1 if a full message) */
  43         const char *para[MAXPARA];      /* parameters vector (starting with cmd as para[0]) */
  44 };
  45
  46 /*
  47  * parse a message into a MsgBuf.
  48  * returns 0 on success, 1 on error.
  49  */
  50 int msgbuf_parse(struct MsgBuf *msgbuf, char *line);
  51
  52 /*
  53  * unparse a pure MsgBuf into a buffer.
  54  * if origin is NULL, me.name will be used.
  55  * cmd may not be NULL.
  56  * returns 0 on success, 1 on error.
  57  */
  58 int msgbuf_unparse(char *buf, size_t buflen, const struct MsgBuf *msgbuf, unsigned int capmask);
  59
  60 /*
  61  * unparse a MsgBuf header plus payload into a buffer.
  62  * if origin is NULL, me.name will be used.
  63  * cmd may not be NULL.
  64  * returns 0 on success, 1 on error.
  65  */
  66 int msgbuf_unparse_fmt(char *buf, size_t buflen, const struct MsgBuf *head, unsigned int capmask, const char *fmt, ...) AFP(5, 6);
  67 int msgbuf_vunparse_fmt(char *buf, size_t buflen, const struct MsgBuf *head, unsigned int capmask, const char *fmt, va_list va);
  68
  69 void msgbuf_unparse_prefix(char *buf, size_t *buflen, const struct MsgBuf *msgbuf, unsigned int capmask);
  70
  71 static inline void
  72 msgbuf_init(struct MsgBuf *msgbuf)
  73 {
  74         memset(msgbuf, 0, sizeof(*msgbuf));
  75 }
  76
  77 static inline void
  78 msgbuf_append_tag(struct MsgBuf *msgbuf, const char *key, const char *value, unsigned int capmask)
  79 {
  80         if (msgbuf->n_tags < MAXPARA) {
  81                 msgbuf->tags[msgbuf->n_tags].key = key;
  82                 msgbuf->tags[msgbuf->n_tags].value = value;
  83                 msgbuf->tags[msgbuf->n_tags].capmask = capmask;
  84                 msgbuf->n_tags++;
  85         }
  86 }
  87
  88 #endif