Fix compiler warnings

[wget] / src / url.h

diff --git a/src/url.h b/src/url.h
index c28cd956f956bf0a6b8e334870df90c2257db442..6d18ed81f1f3c21d13e6af2131972136284b9af7 100644 (file)
--- a/src/url.h
+++ b/src/url.h
@@ -1,11 +1,13 @@
 /* Declarations for url.c.
 /* Declarations for url.c.

-   Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
+   Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+   2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation,
+   Inc.

 
 This file is part of GNU Wget.
 
 GNU Wget is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This file is part of GNU Wget.
 
 GNU Wget is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

-the Free Software Foundation; either version 2 of the License, or
+the Free Software Foundation; either version 3 of the License, or

 (at your option) any later version.
 
 GNU Wget is distributed in the hope that it will be useful,
 (at your option) any later version.
 
 GNU Wget is distributed in the hope that it will be useful,


@@ -14,8 +16,18 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License

-along with Wget; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+along with Wget.  If not, see <http://www.gnu.org/licenses/>.
+
+Additional permission under GNU GPL version 3 section 7
+
+If you modify this program, or any covered work, by linking or
+combining it with the OpenSSL project's OpenSSL library (or a
+modified version of that library), containing parts covered by the
+terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
+grants you additional permission to convey the resulting work.
+Corresponding Source for a non-source form of such a combination
+shall include the source code for the parts of OpenSSL used as well
+as that of the covered work.  */

 
 #ifndef URL_H
 #define URL_H
 
 #ifndef URL_H
 #define URL_H


@@ -25,104 +37,95 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define DEFAULT_FTP_PORT 21
 #define DEFAULT_HTTPS_PORT 443
 
 #define DEFAULT_FTP_PORT 21
 #define DEFAULT_HTTPS_PORT 443
 

-
-/* Structure containing info on a URL.  */
-struct urlinfo
-{
-  char *url;                   /* Unchanged URL */
-  uerr_t proto;                        /* URL protocol */
-  char *host;                  /* Extracted hostname */
-  unsigned short port;
-  char ftp_type;
-  char *path, *dir, *file, *qstring;   
-                                /* Path, dir, file, and query string
-                                  (properly decoded) */
-  char *user, *passwd;         /* Username and password */
-  struct urlinfo *proxy;       /* The exact string to pass to proxy
-                                  server */
-  char *referer;               /* The source from which the request
-                                  URI was obtained */
-  char *local;                 /* The local filename of the URL
-                                  document */
+/* This represents how many characters less than the OS max name length a file
+ * should be.  More precisely, a file name should be at most
+ * (NAME_MAX - CHOMP_BUFFER) characters in length.  This number was arrived at
+ * by adding the lengths of all possible strings that could be appended to a
+ * file name later in the code (e.g. ".orig", ".html", etc.).  This is
+ * hopefully plenty of extra characters, but I am not guaranteeing that a file
+ * name will be of the proper length by the time the code wants to open a
+ * file descriptor. */
+#define CHOMP_BUFFER 19
+
+/* The flags that allow clobbering the file (opening with "wb").
+   Defined here to avoid repetition later.  #### This will require
+   rework.  */
+#define ALLOW_CLOBBER (opt.noclobber || opt.always_rest || opt.timestamping \
+                  || opt.dirstruct || opt.output_document || opt.backups > 0)
+
+/* Specifies how, or whether, user auth information should be included
+ * in URLs regenerated from URL parse structures. */
+enum url_auth_mode {
+  URL_AUTH_SHOW,
+  URL_AUTH_HIDE_PASSWD,
+  URL_AUTH_HIDE

 };
 
 };
 

-enum convert_options {
-  CO_NOCONVERT = 0,            /* don't convert this URL */
-  CO_CONVERT_TO_RELATIVE,      /* convert to relative, e.g. to
-                                   "../../otherdir/foo.gif" */
-  CO_CONVERT_TO_COMPLETE       /* convert to absolute, e.g. to
-                                  "http://orighost/somedir/bar.jpg". */
-};
+/* Note: the ordering here is related to the order of elements in
+   `supported_schemes' in url.c.  */

 
 

-/* A structure that defines the whereabouts of a URL, i.e. its
-   position in an HTML document, etc.  */
+enum url_scheme {
+  SCHEME_HTTP,
+#ifdef HAVE_SSL
+  SCHEME_HTTPS,
+#endif
+  SCHEME_FTP,
+  SCHEME_INVALID
+};

 
 

-typedef struct _urlpos
+/* Structure containing info on a URL.  */
+struct url

 {
 {

-  char *url;                   /* linked URL, after it has been
-                                  merged with the base */
-  char *local_name;            /* Local file to which it was saved */
-
-  /* Information about the original link: */
-  int link_relative_p;         /* was the link relative? */
-  int link_complete_p;         /* was the link complete (with the
-                                   host name, etc.) */
-
-  /* Conversion requirements: */
-  enum convert_options convert;        /* is conversion required? */
-
-  /* URL's position in the buffer. */
-  int pos, size;
+  char *url;                   /* Original URL */
+  enum url_scheme scheme;      /* URL scheme */

 
 

-  struct _urlpos *next;                /* Next struct in list */
-} urlpos;
+  char *host;                  /* Extracted hostname */
+  int port;                    /* Port number */

 
 

-/* downloaded_file() takes a parameter of this type and returns this type. */
-typedef enum
-{
-  /* Return enumerators: */
-  FILE_NOT_ALREADY_DOWNLOADED = 0,
+  /* URL components (URL-quoted). */
+  char *path;
+  char *params;
+  char *query;
+  char *fragment;

 
 

-  /* Return / parameter enumerators: */
-  FILE_DOWNLOADED_NORMALLY,
-  FILE_DOWNLOADED_AND_HTML_EXTENSION_ADDED,
+  /* Extracted path info (unquoted). */
+  char *dir;
+  char *file;

 
 

-  /* Parameter enumerators: */
-  CHECK_FOR_FILE
-} downloaded_file_t;
+  /* Username and password (unquoted). */
+  char *user;
+  char *passwd;
+};

 
 /* Function declarations */
 
 
 /* Function declarations */
 

-char *encode_string PARAMS ((const char *));
-
-struct urlinfo *newurl PARAMS ((void));
-void freeurl PARAMS ((struct urlinfo *, int));
-uerr_t urlproto PARAMS ((const char *));
-int skip_proto PARAMS ((const char *));
-int has_proto PARAMS ((const char *));
-int skip_uname PARAMS ((const char *));
+char *url_escape (const char *);
+char *url_escape_unsafe_and_reserved (const char *);
+void url_unescape (char *);

 
 

-uerr_t parseurl PARAMS ((const char *, struct urlinfo *, int));
-char *str_url PARAMS ((const struct urlinfo *, int));
-int url_equal PARAMS ((const char *, const char *));
+struct url *url_parse (const char *, int *, struct iri *iri, bool percent_encode);
+char *url_error (const char *, int);
+char *url_full_path (const struct url *);
+void url_set_dir (struct url *, const char *);
+void url_set_file (struct url *, const char *);
+void url_free (struct url *);

 
 

-urlpos *get_urls_file PARAMS ((const char *));
-urlpos *get_urls_html PARAMS ((const char *, const char *, int, int *));
-void free_urlpos PARAMS ((urlpos *));
+enum url_scheme url_scheme (const char *);
+bool url_has_scheme (const char *);
+bool url_valid_scheme (const char *);
+int scheme_default_port (enum url_scheme);
+void scheme_disable (enum url_scheme);

 
 

-char *uri_merge PARAMS ((const char *, const char *));
+char *url_string (const struct url *, enum url_auth_mode);
+char *url_file_name (const struct url *, char *);

 
 

-void rotate_backups PARAMS ((const char *));
-int mkalldirs PARAMS ((const char *));
-char *url_filename PARAMS ((const struct urlinfo *));
-void opt_url PARAMS ((struct urlinfo *));
+char *uri_merge (const char *, const char *);

 
 

-char *getproxy PARAMS ((uerr_t));
-int no_proxy_match PARAMS ((const char *, const char **));
+int mkalldirs (const char *);

 
 

-void convert_links PARAMS ((const char *, urlpos *));
-urlpos *add_url PARAMS ((urlpos *, const char *, const char *));
+char *rewrite_shorthand_url (const char *);
+bool schemes_are_similar_p (enum url_scheme a, enum url_scheme b);

 
 

-downloaded_file_t downloaded_file PARAMS ((downloaded_file_t, const char *));
+bool are_urls_equal (const char *u1, const char *u2);

 
 #endif /* URL_H */
 
 #endif /* URL_H */