imap-arg.h revision c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#ifndef IMAP_ARG_H
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#define IMAP_ARG_H
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#include "array.h"
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen/* We use this macro to read atoms from input. It should probably contain
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen everything some day, but for now we can't handle some input otherwise:
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ']' is required for parsing section (FETCH BODY[])
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen '%', '*' and ']' are valid list-chars for LIST patterns
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen '\' is used in flags */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#define IS_ATOM_SPECIAL_INPUT(c) \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ((c) == '(' || (c) == ')' || (c) == '{' || \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen (c) == '"' || (c) <= 32 || (c) == 0x7f)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#define IS_ATOM_SPECIAL(c) \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen (IS_ATOM_SPECIAL_INPUT(c) || \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen (c) == ']' || (c) == '%' || (c) == '*' || (c) == '\\')
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenenum imap_arg_type {
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_NIL = 0,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_ATOM,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_STRING,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_LIST,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen /* literals are returned as IMAP_ARG_STRING by default */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_LITERAL,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_LITERAL_SIZE,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_LITERAL_SIZE_NONSYNC,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_EOL /* end of argument list */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen};
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo SirainenARRAY_DEFINE_TYPE(imap_arg_list, struct imap_arg);
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenstruct imap_arg {
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen enum imap_arg_type type;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen struct imap_arg *parent; /* always of type IMAP_ARG_LIST */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen union {
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen const char *str;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen uoff_t literal_size;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ARRAY_TYPE(imap_arg_list) list;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen } _data;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen};
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen/* RFC 3501's astring type */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#define IMAP_ARG_TYPE_IS_ASTRING(type) \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ((type) == IMAP_ARG_ATOM || \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen (type) == IMAP_ARG_STRING || \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen (type) == IMAP_ARG_LITERAL)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#define IMAP_ARG_IS_ASTRING(arg) \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen IMAP_ARG_TYPE_IS_ASTRING((arg)->type)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#define IMAP_ARG_IS_EOL(arg) \
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ((arg)->type == IMAP_ARG_EOL)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_atom(const struct imap_arg *arg, const char **str_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_quoted(const struct imap_arg *arg, const char **str_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_string(const struct imap_arg *arg, const char **str_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_astring(const struct imap_arg *arg, const char **str_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen/* str is set to NULL for NIL. */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_nstring(const struct imap_arg *arg, const char **str_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_literal_size(const struct imap_arg *arg, uoff_t *size_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_list(const struct imap_arg *arg,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen const struct imap_arg **list_r)
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_get_list_full(const struct imap_arg *arg,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen const struct imap_arg **list_r,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen unsigned int *list_count_r) ATTR_WARN_UNUSED_RESULT;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen/* Similar to above, but assumes that arg is already of correct type. */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenconst char *imap_arg_as_astring(const struct imap_arg *arg);
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenconst char *imap_arg_as_nstring(const struct imap_arg *arg);
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenuoff_t imap_arg_as_literal_size(const struct imap_arg *arg);
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenconst struct imap_arg *imap_arg_as_list(const struct imap_arg *arg);
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen/* Returns TRUE if arg is atom and case-insensitively matches str */
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainenbool imap_arg_atom_equals(const struct imap_arg *arg, const char *str);
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen#endif