0f2a8846 |
1 | /* -*-c-*- |
2 | * |
8656dc50 |
3 | * $Id: url.h,v 1.4 2004/04/08 01:36:13 mdw Exp $ |
0f2a8846 |
4 | * |
5 | * Parsing and construction of url-encoded name/value pairs |
6 | * |
7 | * (c) 1999 Straylight/Edgeware |
8 | */ |
9 | |
10 | /*----- Licensing notice --------------------------------------------------* |
11 | * |
12 | * This file is part of the mLib utilities library. |
13 | * |
14 | * mLib is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU Library General Public License as |
16 | * published by the Free Software Foundation; either version 2 of the |
17 | * License, or (at your option) any later version. |
18 | * |
19 | * mLib is distributed in the hope that it will be useful, |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
22 | * GNU Library General Public License for more details. |
23 | * |
24 | * You should have received a copy of the GNU Library General Public |
25 | * License along with mLib; if not, write to the Free |
26 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
27 | * MA 02111-1307, USA. |
28 | */ |
29 | |
c6e0eaf0 |
30 | #ifndef MLIB_URL_H |
31 | #define MLIB_URL_H |
0f2a8846 |
32 | |
33 | #ifdef __cplusplus |
34 | extern "C" { |
35 | #endif |
36 | |
37 | /*----- Header files ------------------------------------------------------*/ |
38 | |
c6e0eaf0 |
39 | #ifndef MLIB_DSTR_H |
0f2a8846 |
40 | # include "dstr.h" |
41 | #endif |
42 | |
43 | /*----- Data structures ---------------------------------------------------*/ |
44 | |
45 | typedef struct url_ectx { |
46 | unsigned f; |
47 | } url_ectx; |
48 | |
393cf1d9 |
49 | #define URLF_SEP 1u |
0f2a8846 |
50 | |
51 | typedef struct url_dctx { |
52 | const char *p; |
53 | } url_dctx; |
54 | |
55 | /*----- Functions provided ------------------------------------------------*/ |
56 | |
57 | /* --- @url_initenc@ --- * |
58 | * |
59 | * Arguments: @url_ectx *ctx@ = pointer to context block |
60 | * |
61 | * Returns: --- |
62 | * |
63 | * Use: Initializes a URL encoding context. |
64 | */ |
65 | |
66 | extern void url_initenc(url_ectx */*ctx*/); |
67 | |
68 | /* --- @url_enc@ --- * |
69 | * |
70 | * Arguments: @url_ectx *ctx@ = pointer to encoding context |
71 | * @dstr *d@ = pointer to output string |
72 | * @const char *name@ = pointer to name |
73 | * @const char *value@ = pointer to value |
74 | * |
75 | * Returns: --- |
76 | * |
77 | * Use: Writes an assignment between @name@ and @value@ to the |
78 | * output string, encoding the values properly. |
79 | */ |
80 | |
81 | extern void url_enc(url_ectx */*ctx*/, dstr */*d*/, |
82 | const char */*name*/, const char */*value*/); |
83 | |
84 | /* --- @url_initdec@ --- * |
85 | * |
86 | * Arguments: @url_dctx *ctx@ = pointer to context block |
87 | * @const char *p@ = string to read data from |
88 | * |
89 | * Returns: --- |
90 | * |
91 | * Use: Initializes a URL decoding context. |
92 | */ |
93 | |
94 | extern void url_initdec(url_dctx */*ctx*/, const char */*p*/); |
95 | |
96 | /* --- @url_dec@ --- * |
97 | * |
98 | * Arguments: @url_dctx *ctx@ = pointer to decode context |
99 | * @dstr *n@ = pointer to output string for name |
100 | * @dstr *v@ = pointer to output string for value |
101 | * |
102 | * Returns: Nonzero if it read something, zero if there's nothing left |
103 | * |
104 | * Use: Decodes the next name/value pair from a urlencoded string. |
105 | */ |
106 | |
107 | extern int url_dec(url_dctx */*ctx*/, dstr */*n*/, dstr */*v*/); |
108 | |
109 | /*----- That's all, folks -------------------------------------------------*/ |
110 | |
111 | #ifdef __cplusplus |
112 | } |
113 | #endif |
114 | |
115 | #endif |