]> sjero.net Git - wget/blob - src/url.h
[svn] Split off non-URL related stuff from url.c to convert.c.
[wget] / src / url.h
1 /* Declarations for url.c.
2    Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
3
4 This file is part of GNU Wget.
5
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables.  You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL".  If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so.  If you do not wish to do
28 so, delete this exception statement from your version.  */
29
30 #ifndef URL_H
31 #define URL_H
32
33 /* Default port definitions */
34 #define DEFAULT_HTTP_PORT 80
35 #define DEFAULT_FTP_PORT 21
36 #define DEFAULT_HTTPS_PORT 443
37
38 /* Note: the ordering here is related to the order of elements in
39    `supported_schemes' in url.c.  */
40
41 enum url_scheme {
42   SCHEME_HTTP,
43 #ifdef HAVE_SSL
44   SCHEME_HTTPS,
45 #endif
46   SCHEME_FTP,
47   SCHEME_INVALID
48 };
49
50 /* Structure containing info on a URL.  */
51 struct url
52 {
53   char *url;                    /* Original URL */
54   enum url_scheme scheme;       /* URL scheme */
55
56   char *host;                   /* Extracted hostname */
57   int port;                     /* Port number */
58
59   /* URL components (URL-quoted). */
60   char *path;
61   char *params;
62   char *query;
63   char *fragment;
64
65   /* Extracted path info (unquoted). */
66   char *dir;
67   char *file;
68
69   /* Username and password (unquoted). */
70   char *user;
71   char *passwd;
72 };
73
74 /* Function declarations */
75
76 char *url_escape PARAMS ((const char *));
77
78 struct url *url_parse PARAMS ((const char *, int *));
79 const char *url_error PARAMS ((int));
80 char *url_full_path PARAMS ((const struct url *));
81 void url_set_dir PARAMS ((struct url *, const char *));
82 void url_set_file PARAMS ((struct url *, const char *));
83 void url_free PARAMS ((struct url *));
84
85 enum url_scheme url_scheme PARAMS ((const char *));
86 int url_has_scheme PARAMS ((const char *));
87 int scheme_default_port PARAMS ((enum url_scheme));
88 void scheme_disable PARAMS ((enum url_scheme));
89
90 char *url_string PARAMS ((const struct url *, int));
91 char *url_file_name PARAMS ((const struct url *));
92
93 char *uri_merge PARAMS ((const char *, const char *));
94
95 int mkalldirs PARAMS ((const char *));
96
97 char *rewrite_shorthand_url PARAMS ((const char *));
98 int schemes_are_similar_p PARAMS ((enum url_scheme a, enum url_scheme b));
99
100 #endif /* URL_H */