X-Git-Url: http://sjero.net/git/?a=blobdiff_plain;f=src%2Fwget.h;h=1ac6eccb0ebdbdd018ec82756d592f0a28e3e533;hb=50d143f3fefbcb343d4d1968d4f9d0d59178ce3f;hp=5dd71d21cde23a4ca4108a0dbd459ca63efe3cef;hpb=b3e2c0ff97765cc7a44d840d1eb94447a2ea125f;p=wget diff --git a/src/wget.h b/src/wget.h index 5dd71d21..1ac6eccb 100644 --- a/src/wget.h +++ b/src/wget.h @@ -1,32 +1,44 @@ /* Miscellaneous declarations. - Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc. + Copyright (C) 1995, 1996, 1997, 1998, 2003 Free Software Foundation, Inc. -This file is part of Wget. +This file is part of GNU Wget. -This program is free software; you can redistribute it and/or modify +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 (at your option) any later version. -This program is distributed in the hope that it will be useful, +GNU Wget 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 General Public License for more details. You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ - -/* This file contains some declarations that don't fit anywhere else. - It also contains some useful includes, like the obnoxious TIME_H - inclusion. */ +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. */ + +/* This file contains declarations that are universally useful and + those that don't fit elsewhere. It also includes sysdep.h which + includes some often-needed system includes, like the obnoxious + inclusion. */ #ifndef WGET_H #define WGET_H -#ifndef DEBUG -# define NDEBUG /* To kill off assertions */ -#endif /* not DEBUG */ +/* Disable assertions when debug support is not compiled in. */ +#ifndef ENABLE_DEBUG +# define NDEBUG +#endif #ifndef PARAMS # if PROTOTYPES @@ -44,10 +56,21 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ # include # endif /* HAVE_LIBINTL_H */ #else /* not HAVE_NLS */ -# define _(string) string +# define _(string) (string) #endif /* not HAVE_NLS */ -/* I18N NOTE: You will notice that none of the DEBUG messages are +/* A pseudo function call that serves as a marker for the automated + extraction of messages, but does not call gettext(). The run-time + translation is done at a different place in the code. The purpose + of the N_("...") call is to make the message snarfer aware that the + "..." string needs to be translated. STRING should be a string + literal. Concatenated strings and other string expressions won't + work. The macro's expansion is not parenthesized, so that it is + suitable as initializer for static 'char[]' or 'const char[]' + variables. -- explanation partly taken from GNU make. */ +#define N_(string) string + +/* I18N NOTE: You will notice that none of the DEBUGP messages are marked as translatable. This is intentional, for a few reasons: 1) The debug messages are not meant for the users to look at, but @@ -60,83 +83,114 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ 3) Finally, the debug messages are meant to be a clue for me to debug problems with Wget. If I get them in a language I don't - understand, debugging will become a new challenge of its own! :-) */ + understand, debugging will become a new challenge of its own! */ /* Include these, so random files need not include them. */ #include "sysdep.h" #include "options.h" +/* locale independent replacement for ctype.h */ +#include "safe-ctype.h" #define DO_NOTHING do {} while (0) /* Print X if debugging is enabled; a no-op otherwise. */ -#ifdef DEBUG -# define DEBUGP(x) do { debug_logprintf x; } while (0) -#else /* not DEBUG */ +#ifdef ENABLE_DEBUG +# define DEBUGP(x) do { if (opt.debug) { debug_logprintf x; } } while (0) +#else /* not ENABLE_DEBUG */ # define DEBUGP(x) DO_NOTHING -#endif /* not DEBUG */ +#endif /* not ENABLE_DEBUG */ -/* Make gcc check for the format of logmsg() and debug_logmsg(). */ #ifdef __GNUC__ # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b))) #else /* not __GNUC__ */ # define GCC_FORMAT_ATTR(a, b) #endif /* not __GNUC__ */ -/* These are from log.c, but they are used everywhere, so we declare - them here. */ -enum log_options { LOG_VERBOSE, LOG_NOTQUIET, LOG_NONVERBOSE, LOG_ALWAYS }; - -void logprintf PARAMS ((enum log_options, const char *, ...)) - GCC_FORMAT_ATTR (2, 3); -void debug_logprintf PARAMS ((const char *, ...)) GCC_FORMAT_ATTR (1, 2); -void logputs PARAMS ((enum log_options, const char *)); +/* Define an integer type that works for LFS. off_t would be perfect + for this, but off_t is always 32-bit under Windows. */ +#ifndef WINDOWS +typedef off_t wgint; +# define SIZEOF_WGINT SIZEOF_OFF_T +#endif -/* Defined in `utils.c', but used literally everywhere. */ -void *xmalloc PARAMS ((size_t)); -void *xrealloc PARAMS ((void *, size_t)); -char *xstrdup PARAMS ((const char *)); +/* 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 +# endif +#endif -/* #### Find a better place for this. */ -/* The log file to which Wget writes to after HUP. */ -#define DEFAULT_LOGFILE "wget-log" +/* Everything uses this, so include them here directly. */ +#include "xmalloc.h" -#define MD5_HASHLEN 16 +/* Likewise for logging functions. */ +#include "log.h" /* Useful macros used across the code: */ -/* Is the string a hpyhen-only? */ -#define HYPHENP(x) (*(x) == '-' && !*((x) + 1)) - -/* The smaller value of the two. */ -#define MINVAL(x, y) ((x) < (y) ? (x) : (y)) - -/* ASCII char -> HEX digit */ -#define ASC2HEXD(x) (((x) >= '0' && (x) <= '9') ? \ - ((x) - '0') : (TOUPPER(x) - 'A' + 10)) - -/* HEX digit -> ASCII char */ -#define HEXD2ASC(x) (((x) < 10) ? ((x) + '0') : ((x) - 10 + 'A')) - -#define ARRAY_SIZE(array) (sizeof (array) / sizeof (*(array))) - -/* Note that this much more elegant definition cannot be used: - - #define STRDUP_ALLOCA(str) (strcpy ((char *)alloca (strlen (str) + 1), str)) - - This is because some compilers don't handle alloca() as argument to - function correctly. Gcc under Intel has been reported to offend in - this case. */ - -#define STRDUP_ALLOCA(ptr, str) do { \ - (ptr) = (char *)alloca (strlen (str) + 1); \ - strcpy (ptr, str); \ +/* The number of elements in an array. For example: + static char a[] = "foo"; -- countof(a) == 4 (note terminating \0) + int a[5] = {1, 2}; -- countof(a) == 5 + char *a[] = { -- countof(a) == 3 + "foo", "bar", "baz" + }; */ +#define countof(array) (sizeof (array) / sizeof ((array)[0])) + +/* Zero out a value. */ +#define xzero(x) memset (&(x), '\0', sizeof (x)) + +/* 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 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 + the ASCII representation of the corresponding hexadecimal digit. + `+ 0' is there so you can't accidentally use it as an lvalue. */ +#define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0) +#define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0) + +/* 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'; \ } while (0) -#define ALLOCA_ARRAY(type, len) ((type *) alloca ((len) * sizeof (type))) - -#define XREALLOC_ARRAY(ptr, type, len) \ - ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type)))) +/* 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 \ + && !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 \ + && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1)) + +/* Like ptr=strdup(str), but allocates the space for PTR on the stack. + This cannot be an expression because this is not portable: + #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str)) + 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); \ +} while (0) /* Generally useful if you want to avoid arbitrary size limits but don't need a full dynamic array. Assumes that BASEVAR points to a @@ -145,110 +199,52 @@ char *xstrdup PARAMS ((const char *)); will realloc BASEVAR as necessary so that it can hold at least 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 \ -{ \ - /* Avoid side-effectualness. */ \ - long do_realloc_needed_size = (needed_size); \ - long do_realloc_newsize = 0; \ - while ((sizevar) < (do_realloc_needed_size)) { \ - do_realloc_newsize = 2*(sizevar); \ - if (do_realloc_newsize < 32) \ - do_realloc_newsize = 32; \ - (sizevar) = do_realloc_newsize; \ - } \ - if (do_realloc_newsize) \ - XREALLOC_ARRAY (basevar, type, do_realloc_newsize); \ -} while (0) -/* Use this for small stack-allocated memory chunks that might grow. - The initial array is created using alloca(), and this macro - requests it to grow. If the needed size is larger than the array, - this macro will use malloc to allocate it to new size, and copy the - old contents. After that, successive invocations behave just like - DO_REALLOC. */ -#define DO_REALLOC_FROM_ALLOCA(basevar, sizevar, needed_size, allocap, type) do \ -{ \ - /* Avoid side-effectualness. */ \ - long do_realloc_needed_size = (needed_size); \ - long do_realloc_newsize = 0; \ - while ((sizevar) < (do_realloc_needed_size)) { \ - do_realloc_newsize = 2*(sizevar); \ - if (do_realloc_newsize < 16) \ - do_realloc_newsize = 16; \ - (sizevar) = do_realloc_newsize; \ - } \ - if (do_realloc_newsize) \ - if (!allocap) \ - XREALLOC_ARRAY (basevar, type, do_realloc_newsize); \ - else \ - { \ - void *drfa_new_basevar = xmalloc (do_realloc_newsize); \ - memcpy (drfa_new_basevar, basevar, sizevar); \ - (basevar) = drfa_new_basevar; \ - allocap = 0; \ - } \ +#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 = (type *)xrealloc (basevar, DR_newsize * sizeof (type)); \ } while (0) -/* Free FOO if it is non-NULL. */ -#define FREE_MAYBE(foo) do { if (foo) free (foo); } while (0) - -/* #### Hack: OPTIONS_DEFINED_HERE is defined in main.c. */ -/* [Is this weird hack really necessary on any compilers? No ANSI C compiler - should complain about "extern const char *exec_name;" followed by - "const char *exec_name;". Are we doing this for K&R compilers, or...?? - -- Dan Harkless ] */ -#ifndef OPTIONS_DEFINED_HERE extern const char *exec_name; -#endif - /* 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 */ + ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */ }; -/* Universal error type -- used almost everywhere. - This is, of course, utter crock. */ +/* Universal error type -- used almost everywhere. Error reporting of + this detail is not generally used or needed and should be + simplified. */ typedef enum { - NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, - CONREFUSED, NEWLOCATION, NOTENOUGHMEM, CONPORTERR, - BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK, - CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, + NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR, + CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR, + CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR, FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR, - FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, - URLOK, URLHTTP, URLFTP, URLFILE, URLUNKNOWN, URLBADPORT, - URLBADHOST, FOPENERR, FWRITEERR, HOK, HLEXC, HEOF, + FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, + FOPENERR, FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF, HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE, FTPINVPASV, FTPNOPASV, - RETRFINISHED, READERR, TRYLIMEXC, URLBADPATTERN, - FILEBADFILE, RANGEERR, RETRBADPATTERN, RETNOTSUP, - ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED, QUOTEXC, WRITEFAILED + CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC, + URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN, + RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED, + QUOTEXC, WRITEFAILED, + SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE } uerr_t; -typedef unsigned char boolean; -#ifndef FALSE -#define FALSE 0 -#endif -#ifndef TRUE -#define TRUE 1 -#endif - -/* So we can say strcmp(a, b) == EQ rather than strcmp(a, b) == 0 or - the really awful !strcmp(a, b). */ -#define EQ 0 - -/* For most options, 0 means no limits, but with -p in the picture, that causes - a problem on the maximum recursion depth variable. To retain backwards - compatibility we allow users to consider "0" to be synonymous with "inf" for - -l, but internally infinite recursion is specified by -1 and 0 means to only - retrieve the requisites of a single document. */ -#define INFINITE_RECURSION -1 - #endif /* WGET_H */