summaryrefslogtreecommitdiff
path: root/neon/src/ne_uri.h
blob: 61b965999b3a4865103d2c50a31ef29ae8cb03f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/* 
   HTTP URI handling
   Copyright (C) 1999-2002, Joe Orton <joe@manyfish.co.uk>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
   
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
   MA 02111-1307, USA

*/

#ifndef NE_URI_H
#define NE_URI_H

#include "ne_defs.h"

BEGIN_NEON_DECLS

/* Un-escapes a path. Returns malloc-allocated path on success, or
 * NULL on an invalid %<HEX><HEX> sequence. */
char *ne_path_unescape(const char *uri)
	/*@*/;

/* Escapes the a path segment: returns malloc-allocated string on
 * success, or NULL on malloc failure.  */
char *ne_path_escape(const char *abs_path)
	/*@*/;

/* Returns malloc-allocated parent of path, or NULL if path has no
 * parent (such as "/"). */
char *ne_path_parent(const char *path)
	/*@*/;

/* Returns strcmp-like value giving comparison between p1 and p2,
 * ignoring trailing-slashes. */
int ne_path_compare(const char *p1, const char *p2)
	/*@*/;

/* Returns non-zero if child is a child of parent */
int ne_path_childof(const char *parent, const char *child)
	/*@*/;

/* Returns non-zero if path has a trailing slash character */
int ne_path_has_trailing_slash(const char *path)
	/*@*/;

/* Return the default port for the given scheme, or 0 if none is
 * known. */
unsigned int ne_uri_defaultport(const char *scheme)
	/*@*/;

typedef struct {
    char *scheme;
    char *host;
    unsigned int port;
    char *path;
    char *authinfo;
} ne_uri;

/* Parse absoluteURI 'uri' and place parsed segments in *parsed.
 * Returns zero on success, non-zero on parse error. Fields of *parsed
 * are malloc'ed, structure should be free'd with uri_free on
 * successful return.  Any unspecified URI fields are set to NULL or 0
 * appropriately in *parsed. */
int ne_uri_parse(const char *uri, /*@out@*/ ne_uri *parsed)
	/*@modifies parsed @*/;

/* Turns a URI structure back into a string.  String is
 * malloc-allocated, and must be free'd by the caller. */
char *ne_uri_unparse(const ne_uri *uri)
	/*@*/;

/* Compares URIs u1 and u2, returns non-zero if they are found to be
 * non-equal.  The sign of the return value is <0 if 'u1' is less than
 * 'u2', or >0 if 'u2' is greater than 'u1'. */
int ne_uri_cmp(const ne_uri *u1, const ne_uri *u2)
	/*@*/;

/* Free URI object. */
void ne_uri_free(ne_uri *parsed)
	/*@modifies parsed @*/;

END_NEON_DECLS

#endif /* NE_URI_H */