chiark - git - mdw - disorder/blob - lib/kvp.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004, 2005 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20
  21 #ifndef KVP_H
  22 #define KVP_H
  23
  24 struct dynstr;
  25 struct sink;
  26
  27 struct kvp {
  28   struct kvp *next;                     /* next entry */
  29   const char *name;                     /* name */
  30   const char *value;                    /* value */
  31 };
  32
  33 struct kvp *kvp_urldecode(const char *ptr, size_t n);
  34 /* url-decode [ptr,ptr+n) */
  35
  36 char *kvp_urlencode(const struct kvp *kvp, size_t *np);
  37 /* url-encode @kvp@ into a null-terminated string.  If @np@ is not
  38  * null return the length thru it. */
  39
  40 int kvp_set(struct kvp **kvpp, const char *name, const char *value);
  41 /* set @name@ to @value@.  If @value@ is 0, remove @name@.
  42  * Returns 1 if we made a real change, else 0. */
  43
  44 const char *kvp_get(const struct kvp *kvp, const char *name);
  45 /* Get the value of @name@ */
  46
  47 int urldecode(struct sink *sink, const char *ptr, size_t n);
  48 /* url-decode the @n@ bytes at @ptr@, writing the results to @s@.
  49  * Return 0 on success, -1 on error. */
  50
  51 int urlencode(struct sink *sink, const char *s, size_t n);
  52 /* url-encode the @n@ bytes at @s@, writing to @sink@.  Return 0 on
  53  * success, -1 on error.  */
  54
  55 const char *urlencodestring(const char *s);
  56 /* return the url-encoded form of @s@ */
  57
  58 #endif /* KVP_H */
  59
  60 /*
  61 Local Variables:
  62 c-basic-offset:2
  63 comment-column:40
  64 End:
  65 */