chiark / gitweb /
examples/disorder.init.in: Read settings from `/etc/default/disorder'.
[disorder] / lib / kvp.h
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2004, 2005, 2007, 2008 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 3 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,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU 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, see <http://www.gnu.org/licenses/>.
17  */
18 /** @file lib/kvp.h
19  * @brief Linked list of key-value pairs
20  */
21
22 #ifndef KVP_H
23 #define KVP_H
24
25 struct dynstr;
26 struct sink;
27
28 /** @brief Linked list of key-value pairs */
29 struct kvp {
30   /** @brief Next entry */
31   struct kvp *next;
32
33   /** @brief Name
34    *
35    * Might not be unique.  Must not be null.
36    */
37   const char *name;
38
39   /** @brief Value
40    *
41    * Must not be null.
42    */
43   const char *value;
44 };
45
46 struct kvp *kvp_urldecode(const char *ptr, size_t n);
47 /* url-decode [ptr,ptr+n) */
48
49 char *kvp_urlencode(const struct kvp *kvp, size_t *np);
50 /* url-encode @kvp@ into a null-terminated string.  If @np@ is not
51  * null return the length thru it. */
52
53 int kvp_set(struct kvp **kvpp, const char *name, const char *value);
54 /* set @name@ to @value@.  If @value@ is 0, remove @name@.
55  * Returns 1 if we made a real change, else 0. */
56
57 const char *kvp_get(const struct kvp *kvp, const char *name);
58 /* Get the value of @name@ */
59
60 int urldecode(struct sink *sink, const char *ptr, size_t n);
61 /* url-decode the @n@ bytes at @ptr@, writing the results to @s@.
62  * Return 0 on success, -1 on error. */
63
64 int urlencode(struct sink *sink, const char *s, size_t n);
65 /* url-encode the @n@ bytes at @s@, writing to @sink@.  Return 0 on
66  * success, -1 on error.  */
67
68 char *urlencodestring(const char *s);
69 /* return the url-encoded form of @s@ */
70
71 char *urldecodestring(const char *s, size_t ns);
72 struct kvp *kvp_make(const char *key, ...);
73
74 void kvp_free(struct kvp *k);
75
76 #endif /* KVP_H */
77
78 /*
79 Local Variables:
80 c-basic-offset:2
81 comment-column:40
82 End:
83 */