X-Git-Url: http://sjero.net/git/?p=wget;a=blobdiff_plain;f=src%2Fwget.h;h=16269bf387d94286f98589cb3cf6b8a44ee5d594;hp=7b76f8d83834cbf550680d0101bddb45a8019607;hb=2f6aa1d7417df1dfc58597777686fbd77179b9fd;hpb=976cc5bfca3c360921bdb4cce38a225ce5a1bd46 diff --git a/src/wget.h b/src/wget.h index 7b76f8d8..16269bf3 100644 --- a/src/wget.h +++ b/src/wget.h @@ -1,11 +1,13 @@ /* Miscellaneous declarations. - Copyright (C) 1995, 1996, 1997, 1998, 2003 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 -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, @@ -14,18 +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 -along with Wget; if not, write to the Free Software -Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -In addition, as a special exception, the Free Software Foundation -gives permission to link the code of its release of Wget with the -OpenSSL project's "OpenSSL" library (or with modified versions of it -that use the same license as the "OpenSSL" library), and distribute -the linked executables. You must obey the GNU General Public License -in all respects for all of the code used other than "OpenSSL". If you -modify this file, you may extend this exception to your version of the -file, but you are not obligated to do so. If you do not wish to do -so, delete this exception statement from your version. */ +along with Wget. If not, see . + +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. */ /* This file contains declarations that are universally useful and those that don't fit elsewhere. It also includes sysdep.h which @@ -35,23 +37,29 @@ so, delete this exception statement from your version. */ #ifndef WGET_H #define WGET_H +#include "config.h" + +#if ((defined _WIN32 || defined __WIN32__) && !defined __CYGWIN__) +# define WINDOWS +#endif + +/* Include these, so random files need not include them. */ +#include "sysdep.h" + /* Disable assertions when debug support is not compiled in. */ #ifndef ENABLE_DEBUG # define NDEBUG #endif +/* Is OpenSSL or GNUTLS available? */ +#if defined HAVE_LIBSSL || defined HAVE_LIBGNUTLS +# define HAVE_SSL +#endif + /* `gettext (FOO)' is long to write, so we use `_(FOO)'. If NLS is unavailable, _(STRING) simply returns STRING. */ -#ifdef HAVE_NLS -# define _(string) gettext (string) -# ifdef HAVE_LIBINTL_H -# include -# else /* not HAVE_LIBINTL_H */ - const char *gettext (); -# endif /* not HAVE_LIBINTL_H */ -#else /* not HAVE_NLS */ -# define _(string) (string) -#endif /* not HAVE_NLS */ +#include "gettext.h" +#define _(string) gettext (string) /* A pseudo function call that serves as a marker for the automated extraction of messages, but does not call gettext(). The run-time @@ -64,6 +72,19 @@ so, delete this exception statement from your version. */ variables. -- explanation partly taken from GNU make. */ #define N_(string) string +#if ! ENABLE_NLS +# undef HAVE_WCHAR_H +# undef HAVE_WCWIDTH +# undef HAVE_MBTOWC +#endif /* not ENABLE_NLS */ + +#if HAVE_WCWIDTH && HAVE_MBTOWC +# define USE_NLS_PROGRESS_BAR 1 +#else +/* Just to be a little paranoid about it. */ +# undef USE_NLS_PROGRESS_BAR +#endif + /* I18N NOTE: You will notice that none of the DEBUGP messages are marked as translatable. This is intentional, for a few reasons: @@ -79,11 +100,8 @@ so, delete this exception statement from your version. */ debug problems with Wget. If I get them in a language I don't understand, debugging will become a new challenge of its own! */ - -/* Include these, so random files need not include them. */ -#include "sysdep.h" /* locale independent replacement for ctype.h */ -#include "safe-ctype.h" +#include "c-ctype.h" /* Conditionalize the use of GCC's __attribute__((format)) and __builtin_expect features using macros. */ @@ -107,36 +125,107 @@ so, delete this exception statement from your version. */ # define IF_DEBUG if (0) #endif -#define DEBUGP(x) do { IF_DEBUG { debug_logprintf x; } } while (0) - -/* Define an integer type that works for file sizes, content lengths, - and such. Normally we could just use off_t, but off_t is always - 32-bit on Windows. */ - -#ifndef WINDOWS -typedef off_t wgint; +/* Print ARGS if debugging is enabled and requested, otherwise do + nothing. This must be called with an extra level of parentheses + because it's not possible to pass a variable number of arguments to + a macro (in portable C89). ARGS are like arguments to printf. */ + +#define DEBUGP(args) do { IF_DEBUG { debug_logprintf args; } } while (0) + +/* Pick an integer type large enough for file sizes, content lengths, + and such. Because today's files can be very large, it should be a + signed integer at least 64 bits wide. This can't be typedeffed to + off_t because: a) off_t is always 32-bit on Windows, and b) we + don't necessarily want to tie having a 64-bit type for internal + calculations to having LFS support. */ + +#ifdef WINDOWS + /* nothing to do, see mswindows.h */ +#elif SIZEOF_LONG >= 8 + /* long is large enough, so use it. */ + typedef long wgint; +# define SIZEOF_WGINT SIZEOF_LONG +#elif SIZEOF_LONG_LONG >= 8 + /* long long is large enough and available, use that */ + typedef long long wgint; +# define SIZEOF_WGINT SIZEOF_LONG_LONG +#elif HAVE_INT64_T + typedef int64_t wgint; +# define SIZEOF_WGINT 8 +#elif SIZEOF_OFF_T >= 8 + /* In case off_t is typedeffed to a large non-standard type that our + tests don't find. */ + typedef off_t wgint; # define SIZEOF_WGINT SIZEOF_OFF_T +#else + /* Fall back to using long, which is always available and in most + cases large enough. */ + typedef long wgint; +# define SIZEOF_WGINT SIZEOF_LONG #endif -/* Define a strtol/strtoll clone that works with wgint. */ -#ifndef str_to_wgint /* mswindows.h defines its own alias */ -# if SIZEOF_WGINT == SIZEOF_LONG -# define str_to_wgint strtol -# define WGINT_MAX LONG_MAX -# else -# define str_to_wgint strtoll -# define WGINT_MAX LLONG_MAX +/* Pick a strtol-compatible function that will work with wgint. The + choices are strtol, strtoll, or our own implementation of strtoll + in cmpt.c, activated with NEED_STRTOLL. */ + +#ifdef WINDOWS + /* nothing to do, see mswindows.h */ +#elif SIZEOF_WGINT == SIZEOF_LONG +# define str_to_wgint strtol +#elif SIZEOF_WGINT == SIZEOF_LONG_LONG +# define str_to_wgint strtoll +# ifndef HAVE_STRTOLL +# define NEED_STRTOLL +# define strtoll_type long long # endif +#else + /* wgint has a strange size; synthesize strtoll and use it. */ +# define str_to_wgint strtoll +# define NEED_STRTOLL +# define strtoll_type wgint +#endif + +#define WGINT_MAX TYPE_MAXIMUM (wgint) + +/* Declare our strtoll replacement. */ +#ifdef NEED_STRTOLL +strtoll_type strtoll (const char *, char **, int); +#endif + +/* Now define a large numeric type useful for storing sizes of *sums* + of downloads, such as the value of the --quota option. This should + be a type able to hold 2G+ values even on systems without large + file support. (It is useful to limit Wget's download quota to say + 10G even if a single file cannot be that large.) + + To make sure we get the largest size possible, we use `double' on + systems without a 64-bit integral type. (Since it is used in very + few places in Wget, this is acceptable.) */ + +#if SIZEOF_WGINT >= 8 +/* just use wgint */ +typedef wgint SUM_SIZE_INT; +#else +/* On systems without LFS, use double, which buys us integers up to 2^53. */ +typedef double SUM_SIZE_INT; #endif #include "options.h" /* Everything uses this, so include them here directly. */ -#include "xmalloc.h" +#include +#include "xalloc.h" /* Likewise for logging functions. */ #include "log.h" - + +/* Likewise for quoting functions. */ +#include "quote.h" +#include "quotearg.h" + +/* Likewise for struct iri definition */ +#include "iri.h" + /* Useful macros used across the code: */ /* The number of elements in an array. For example: @@ -153,7 +242,7 @@ typedef off_t wgint; /* Convert an ASCII hex digit to the corresponding number between 0 and 15. H should be a hexadecimal digit that satisfies isxdigit; otherwise, the result is undefined. */ -#define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10) +#define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : c_toupper (h) - 'A' + 10) #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2)) /* The reverse of the above: convert a number in the [0, 16) range to @@ -220,10 +309,10 @@ typedef off_t wgint; } while (0) /* Used to print pointers (usually for debugging). Print pointers - using printf ("%0*lx", PTR_FORMAT (p)). (%p is too unpredictable; + using printf ("0x%0*lx", PTR_FORMAT (p)). (%p is too unpredictable; some implementations prepend 0x, while some don't, and most don't 0-pad the address.) */ -#define PTR_FORMAT(p) 2 * sizeof (void *), (unsigned long) (p) +#define PTR_FORMAT(p) (int) (2 * sizeof (void *)), (unsigned long) (p) extern const char *exec_name; @@ -236,7 +325,8 @@ enum HEAD_ONLY = 0x0004, /* only send the HEAD request */ SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */ ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */ - ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */ + ADDED_HTML_EXTENSION = 0x0020, /* added ".html" extension due to -E */ + TEXTCSS = 0x0040 /* document is of type text/css */ }; /* Universal error type -- used almost everywhere. Error reporting of @@ -244,18 +334,56 @@ enum simplified. */ typedef enum { + /* 0 */ NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR, - CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR, - CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR, - FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR, - FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, - FOPENERR, FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF, - HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE, - FTPINVPASV, FTPNOPASV, - CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC, - URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN, - RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED, - QUOTEXC, WRITEFAILED, SSLINITFAILED + CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM /* ! */, + CONPORTERR /* ! */, CONCLOSED /* ! */, + /* 10 */ + FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR, + FTPNSFOD, FTPRETROK /* ! */, FTPUNKNOWNTYPE, FTPRERR, FTPREXC /* ! */, + /* 20 */ + FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, FOPENERR, + FOPEN_EXCL_ERR, FWRITEERR, HOK /* ! */, HLEXC /* ! */, HEOF, + /* 30 */ + HERR, RETROK, RECLEVELEXC, FTPACCDENIED /* ! */, WRONGCODE, + FTPINVPASV, FTPNOPASV, CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, + /* 40 */ + READERR, TRYLIMEXC, URLBADPATTERN /* ! */, FILEBADFILE /* ! */, RANGEERR, + RETRBADPATTERN, RETNOTSUP /* ! */, ROBOTSOK /* ! */, NOROBOTS /* ! */, + PROXERR, + /* 50 */ + AUTHFAILED, QUOTEXC, WRITEFAILED, SSLINITFAILED, VERIFCERTERR, + UNLINKERR } uerr_t; +/* 2005-02-19 SMS. + Select an appropriate "orig" suffix and a separator character for + adding a unique suffix to a file name. + + A VMS ODS2 file system can not tolerate multiple dots. An ODS5 file + system can, but even there not all dots are equal, and heroic effort + would be needed to get ".html^.orig" rather than (the less desirable) + "^.html.orig". It's more satisfactory always to use "_orig" on VMS + (rather than including "vms.h", testing "ods5_dest", and acting + accordingly). + + Note that code in various places assumes that this string is five + characters long. +*/ +# ifdef __VMS +# define ORIG_SFX "_orig" +# else /* def __VMS */ +# define ORIG_SFX ".orig" +# endif /* def __VMS [else] */ + +/* ".NNN" unique-ifying suffix separator character for unique_name() in + url.c (and anywhere else). Note that on VMS, the file system's + version numbers solve the problem that unique_name() is designed to + handle, obviating this whole exercise. Other systems may specify a + character different from "." here, if desired. +*/ +# ifndef __VMS +# define UNIQ_SEP '.' +# endif /* ndef __VMS */ + #endif /* WGET_H */