Commit | Line | Data |
---|---|---|
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 |
7e4708e4 MW |
50 | #define URLF_STRICT 2u |
51 | #define URLF_LAX 4u | |
0f2a8846 | 52 | |
53 | typedef struct url_dctx { | |
54 | const char *p; | |
55 | } url_dctx; | |
56 | ||
57 | /*----- Functions provided ------------------------------------------------*/ | |
58 | ||
59 | /* --- @url_initenc@ --- * | |
60 | * | |
61 | * Arguments: @url_ectx *ctx@ = pointer to context block | |
62 | * | |
63 | * Returns: --- | |
64 | * | |
65 | * Use: Initializes a URL encoding context. | |
66 | */ | |
67 | ||
68 | extern void url_initenc(url_ectx */*ctx*/); | |
69 | ||
70 | /* --- @url_enc@ --- * | |
71 | * | |
72 | * Arguments: @url_ectx *ctx@ = pointer to encoding context | |
73 | * @dstr *d@ = pointer to output string | |
74 | * @const char *name@ = pointer to name | |
75 | * @const char *value@ = pointer to value | |
76 | * | |
77 | * Returns: --- | |
78 | * | |
79 | * Use: Writes an assignment between @name@ and @value@ to the | |
80 | * output string, encoding the values properly. | |
81 | */ | |
82 | ||
83 | extern void url_enc(url_ectx */*ctx*/, dstr */*d*/, | |
84 | const char */*name*/, const char */*value*/); | |
85 | ||
86 | /* --- @url_initdec@ --- * | |
87 | * | |
88 | * Arguments: @url_dctx *ctx@ = pointer to context block | |
89 | * @const char *p@ = string to read data from | |
90 | * | |
91 | * Returns: --- | |
92 | * | |
93 | * Use: Initializes a URL decoding context. | |
94 | */ | |
95 | ||
96 | extern void url_initdec(url_dctx */*ctx*/, const char */*p*/); | |
97 | ||
98 | /* --- @url_dec@ --- * | |
99 | * | |
100 | * Arguments: @url_dctx *ctx@ = pointer to decode context | |
101 | * @dstr *n@ = pointer to output string for name | |
102 | * @dstr *v@ = pointer to output string for value | |
103 | * | |
104 | * Returns: Nonzero if it read something, zero if there's nothing left | |
105 | * | |
106 | * Use: Decodes the next name/value pair from a urlencoded string. | |
107 | */ | |
108 | ||
109 | extern int url_dec(url_dctx */*ctx*/, dstr */*n*/, dstr */*v*/); | |
110 | ||
111 | /*----- That's all, folks -------------------------------------------------*/ | |
112 | ||
113 | #ifdef __cplusplus | |
114 | } | |
115 | #endif | |
116 | ||
117 | #endif |