chiark / gitweb /
Fix mis-merged trackdb_open().
[disorder] / lib / kvp.h
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
5aff007d 3 * Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
460b9539 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
460b9539 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
460b9539 8 * (at your option) any later version.
e7eb3a27
RK
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 *
460b9539 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 17 */
132a5a4a
RK
18/** @file lib/kvp.h
19 * @brief Linked list of key-value pairs
20 */
460b9539 21
22#ifndef KVP_H
23#define KVP_H
24
25struct dynstr;
26struct sink;
27
031e275e 28/** @brief Linked list of key-value pairs */
460b9539 29struct kvp {
031e275e
RK
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;
460b9539 44};
45
46struct kvp *kvp_urldecode(const char *ptr, size_t n);
47/* url-decode [ptr,ptr+n) */
48
49char *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
53int 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
57const char *kvp_get(const struct kvp *kvp, const char *name);
58/* Get the value of @name@ */
59
60int 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
64int 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
36bde473 68char *urlencodestring(const char *s);
460b9539 69/* return the url-encoded form of @s@ */
70
36bde473 71char *urldecodestring(const char *s, size_t ns);
b5b7e0bf 72struct kvp *kvp_make(const char *key, ...);
b12be54a 73
460b9539 74#endif /* KVP_H */
75
76/*
77Local Variables:
78c-basic-offset:2
79comment-column:40
80End:
81*/