X-Git-Url: http://sjero.net/git/?p=wget;a=blobdiff_plain;f=src%2Fwget.h;h=ba4ea21ea46858f2c3e1907b5640c69494bafc60;hp=2cfa7aa84de539a031d33ca1877a83715cf8dd05;hb=8624553a31b148f9051cc11725bc01d9760fa07b;hpb=6633b74930870ffb148c46129c738af78082d934 diff --git a/src/wget.h b/src/wget.h index 2cfa7aa8..ba4ea21e 100644 --- a/src/wget.h +++ b/src/wget.h @@ -1,6 +1,7 @@ /* Miscellaneous declarations. - Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, - 2004, 2005, 2006, 2007 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. @@ -17,15 +18,16 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Wget. If not, see . -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. */ +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,29 +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 +#if defined HAVE_LIBSSL || defined HAVE_LIBSSL32 || 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) -# define ngettext(sing, plur, num) ((num) == 1 ? (sing) : (plur)) -#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 @@ -70,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: @@ -85,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. */ @@ -148,7 +160,7 @@ so, delete this exception statement from your version. */ #else /* Fall back to using long, which is always available and in most cases large enough. */ -typedef long off_t; + typedef long wgint; # define SIZEOF_WGINT SIZEOF_LONG #endif @@ -201,11 +213,19 @@ typedef double SUM_SIZE_INT; #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: @@ -222,7 +242,7 @@ typedef double SUM_SIZE_INT; /* 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 @@ -234,24 +254,24 @@ typedef double SUM_SIZE_INT; /* Copy the data delimited with BEG and END to alloca-allocated storage, and zero-terminate it. Arguments are evaluated only once, in the order BEG, END, PLACE. */ -#define BOUNDED_TO_ALLOCA(beg, end, place) do { \ - const char *BTA_beg = (beg); \ - int BTA_len = (end) - BTA_beg; \ - char **BTA_dest = &(place); \ - *BTA_dest = alloca (BTA_len + 1); \ - memcpy (*BTA_dest, BTA_beg, BTA_len); \ - (*BTA_dest)[BTA_len] = '\0'; \ +#define BOUNDED_TO_ALLOCA(beg, end, place) do { \ + const char *BTA_beg = (beg); \ + int BTA_len = (end) - BTA_beg; \ + char **BTA_dest = &(place); \ + *BTA_dest = alloca (BTA_len + 1); \ + memcpy (*BTA_dest, BTA_beg, BTA_len); \ + (*BTA_dest)[BTA_len] = '\0'; \ } while (0) /* Return non-zero if string bounded between BEG and END is equal to STRING_LITERAL. The comparison is case-sensitive. */ -#define BOUNDED_EQUAL(beg, end, string_literal) \ - ((end) - (beg) == sizeof (string_literal) - 1 \ +#define BOUNDED_EQUAL(beg, end, string_literal) \ + ((end) - (beg) == sizeof (string_literal) - 1 \ && !memcmp (beg, string_literal, sizeof (string_literal) - 1)) /* The same as above, except the comparison is case-insensitive. */ -#define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \ - ((end) - (beg) == sizeof (string_literal) - 1 \ +#define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \ + ((end) - (beg) == sizeof (string_literal) - 1 \ && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1)) /* Like ptr=strdup(str), but allocates the space for PTR on the stack. @@ -260,11 +280,11 @@ typedef double SUM_SIZE_INT; The problem is that some compilers can't handle alloca() being an argument to a function. */ -#define STRDUP_ALLOCA(ptr, str) do { \ - char **SA_dest = &(ptr); \ - const char *SA_src = (str); \ - *SA_dest = (char *)alloca (strlen (SA_src) + 1); \ - strcpy (*SA_dest, SA_src); \ +#define STRDUP_ALLOCA(ptr, str) do { \ + char **SA_dest = &(ptr); \ + const char *SA_src = (str); \ + *SA_dest = (char *)alloca (strlen (SA_src) + 1); \ + strcpy (*SA_dest, SA_src); \ } while (0) /* Generally useful if you want to avoid arbitrary size limits but @@ -275,17 +295,17 @@ typedef double SUM_SIZE_INT; NEEDED_SIZE objects. The reallocing is done by doubling, which ensures constant amortized time per element. */ -#define DO_REALLOC(basevar, sizevar, needed_size, type) do { \ - long DR_needed_size = (needed_size); \ - long DR_newsize = 0; \ - while ((sizevar) < (DR_needed_size)) { \ - DR_newsize = sizevar << 1; \ - if (DR_newsize < 16) \ - DR_newsize = 16; \ - (sizevar) = DR_newsize; \ - } \ - if (DR_newsize) \ - basevar = xrealloc (basevar, DR_newsize * sizeof (type)); \ +#define DO_REALLOC(basevar, sizevar, needed_size, type) do { \ + long DR_needed_size = (needed_size); \ + long DR_newsize = 0; \ + while ((sizevar) < (DR_needed_size)) { \ + DR_newsize = sizevar << 1; \ + if (DR_newsize < 16) \ + DR_newsize = 16; \ + (sizevar) = DR_newsize; \ + } \ + if (DR_newsize) \ + basevar = xrealloc (basevar, DR_newsize * sizeof (type)); \ } while (0) /* Used to print pointers (usually for debugging). Print pointers @@ -294,18 +314,23 @@ typedef double SUM_SIZE_INT; 0-pad the address.) */ #define PTR_FORMAT(p) (int) (2 * sizeof (void *)), (unsigned long) (p) +/* Find the maximum buffer length needed to print an integer of type `x' + in base 10. 24082 / 10000 = 8*log_{10}(2). */ +#define MAX_INT_TO_STRING_LEN(x) ((sizeof(x) * 24082 / 10000) + 2) + extern const char *exec_name; /* Document type ("dt") flags */ enum { - TEXTHTML = 0x0001, /* document is of type text/html + TEXTHTML = 0x0001, /* document is of type text/html or application/xhtml+xml */ - RETROKF = 0x0002, /* retrieval was OK */ - 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 */ + RETROKF = 0x0002, /* retrieval was OK */ + 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 */ + TEXTCSS = 0x0040 /* document is of type text/css */ }; /* Universal error type -- used almost everywhere. Error reporting of @@ -315,21 +340,56 @@ typedef enum { /* 0 */ NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR, - CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR, CONCLOSED, + CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM /* ! */, + CONPORTERR /* ! */, CONCLOSED /* ! */, /* 10 */ FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR, - FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR, FTPREXC, + FTPNSFOD, FTPRETROK /* ! */, FTPUNKNOWNTYPE, FTPRERR, FTPREXC /* ! */, /* 20 */ - FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, FOPENERR, - FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF, + FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, FOPENERR, + FOPEN_EXCL_ERR, FWRITEERR, HOK /* ! */, HLEXC /* ! */, HEOF, /* 30 */ - HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE, - FTPINVPASV, FTPNOPASV, CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, + HERR, RETROK, RECLEVELEXC, FTPACCDENIED /* ! */, WRONGCODE, + FTPINVPASV, FTPNOPASV, CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, /* 40 */ - READERR, TRYLIMEXC, URLBADPATTERN, FILEBADFILE, RANGEERR, - RETRBADPATTERN, RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, + READERR, TRYLIMEXC, URLBADPATTERN /* ! */, FILEBADFILE /* ! */, RANGEERR, + RETRBADPATTERN, RETNOTSUP /* ! */, ROBOTSOK /* ! */, NOROBOTS /* ! */, + PROXERR, /* 50 */ - AUTHFAILED, QUOTEXC, WRITEFAILED, SSLINITFAILED + AUTHFAILED, QUOTEXC, WRITEFAILED, SSLINITFAILED, VERIFCERTERR, + UNLINKERR, NEWLOCATION_KEEP_POST, CLOSEFAILED, ATTRMISSING, UNKNOWNATTR, + + WARC_ERR, WARC_TMP_FOPENERR, WARC_TMP_FWRITEERR } 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 */