1 /* Miscellaneous declarations.
2 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
3 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 This file is part of GNU Wget.
7 GNU Wget is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 GNU Wget is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Wget. If not, see <http://www.gnu.org/licenses/>.
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. */
30 /* This file contains declarations that are universally useful and
31 those that don't fit elsewhere. It also includes sysdep.h which
32 includes some often-needed system includes, like the obnoxious
33 <time.h> inclusion. */
38 /* Disable assertions when debug support is not compiled in. */
43 /* Is OpenSSL or GNUTLS available? */
44 #if defined HAVE_LIBSSL || defined HAVE_LIBGNUTLS
48 /* `gettext (FOO)' is long to write, so we use `_(FOO)'. If NLS is
49 unavailable, _(STRING) simply returns STRING. */
51 #define _(string) gettext (string)
53 /* A pseudo function call that serves as a marker for the automated
54 extraction of messages, but does not call gettext(). The run-time
55 translation is done at a different place in the code. The purpose
56 of the N_("...") call is to make the message snarfer aware that the
57 "..." string needs to be translated. STRING should be a string
58 literal. Concatenated strings and other string expressions won't
59 work. The macro's expansion is not parenthesized, so that it is
60 suitable as initializer for static 'char[]' or 'const char[]'
61 variables. -- explanation partly taken from GNU make. */
62 #define N_(string) string
64 /* I18N NOTE: You will notice that none of the DEBUGP messages are
65 marked as translatable. This is intentional, for a few reasons:
67 1) The debug messages are not meant for the users to look at, but
68 for the developers; as such, they should be considered more like
69 source comments than real program output.
71 2) The messages are numerous, and yet they are random and frivolous
72 ("double yuck!" and such). There would be a lot of work with no
75 3) Finally, the debug messages are meant to be a clue for me to
76 debug problems with Wget. If I get them in a language I don't
77 understand, debugging will become a new challenge of its own! */
80 /* Include these, so random files need not include them. */
82 /* locale independent replacement for ctype.h */
85 /* Conditionalize the use of GCC's __attribute__((format)) and
86 __builtin_expect features using macros. */
88 #if defined(__GNUC__) && __GNUC__ >= 3
89 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
90 # define LIKELY(exp) __builtin_expect (!!(exp), 1)
91 # define UNLIKELY(exp) __builtin_expect ((exp), 0)
93 # define GCC_FORMAT_ATTR(a, b)
94 # define LIKELY(exp) (exp)
95 # define UNLIKELY(exp) (exp)
98 /* Execute the following statement if debugging is both enabled at
99 compile-time and requested at run-time; a no-op otherwise. */
102 # define IF_DEBUG if (UNLIKELY (opt.debug))
104 # define IF_DEBUG if (0)
107 /* Print ARGS if debugging is enabled and requested, otherwise do
108 nothing. This must be called with an extra level of parentheses
109 because it's not possible to pass a variable number of arguments to
110 a macro (in portable C89). ARGS are like arguments to printf. */
112 #define DEBUGP(args) do { IF_DEBUG { debug_logprintf args; } } while (0)
114 /* Pick an integer type large enough for file sizes, content lengths,
115 and such. Because today's files can be very large, it should be a
116 signed integer at least 64 bits wide. This can't be typedeffed to
117 off_t because: a) off_t is always 32-bit on Windows, and b) we
118 don't necessarily want to tie having a 64-bit type for internal
119 calculations to having LFS support. */
122 /* nothing to do, see mswindows.h */
123 #elif SIZEOF_LONG >= 8
124 /* long is large enough, so use it. */
126 # define SIZEOF_WGINT SIZEOF_LONG
127 #elif SIZEOF_LONG_LONG >= 8
128 /* long long is large enough and available, use that */
129 typedef long long wgint;
130 # define SIZEOF_WGINT SIZEOF_LONG_LONG
132 typedef int64_t wgint;
133 # define SIZEOF_WGINT 8
134 #elif SIZEOF_OFF_T >= 8
135 /* In case off_t is typedeffed to a large non-standard type that our
138 # define SIZEOF_WGINT SIZEOF_OFF_T
140 /* Fall back to using long, which is always available and in most
141 cases large enough. */
143 # define SIZEOF_WGINT SIZEOF_LONG
146 /* Pick a strtol-compatible function that will work with wgint. The
147 choices are strtol, strtoll, or our own implementation of strtoll
148 in cmpt.c, activated with NEED_STRTOLL. */
151 /* nothing to do, see mswindows.h */
152 #elif SIZEOF_WGINT == SIZEOF_LONG
153 # define str_to_wgint strtol
154 #elif SIZEOF_WGINT == SIZEOF_LONG_LONG
155 # define str_to_wgint strtoll
156 # ifndef HAVE_STRTOLL
157 # define NEED_STRTOLL
158 # define strtoll_type long long
161 /* wgint has a strange size; synthesize strtoll and use it. */
162 # define str_to_wgint strtoll
163 # define NEED_STRTOLL
164 # define strtoll_type wgint
167 #define WGINT_MAX TYPE_MAXIMUM (wgint)
169 /* Declare our strtoll replacement. */
171 strtoll_type strtoll (const char *, char **, int);
174 /* Now define a large numeric type useful for storing sizes of *sums*
175 of downloads, such as the value of the --quota option. This should
176 be a type able to hold 2G+ values even on systems without large
177 file support. (It is useful to limit Wget's download quota to say
178 10G even if a single file cannot be that large.)
180 To make sure we get the largest size possible, we use `double' on
181 systems without a 64-bit integral type. (Since it is used in very
182 few places in Wget, this is acceptable.) */
184 #if SIZEOF_WGINT >= 8
186 typedef wgint SUM_SIZE_INT;
188 /* On systems without LFS, use double, which buys us integers up to 2^53. */
189 typedef double SUM_SIZE_INT;
194 /* Everything uses this, so include them here directly. */
197 /* Likewise for logging functions. */
200 /* Useful macros used across the code: */
202 /* The number of elements in an array. For example:
203 static char a[] = "foo"; -- countof(a) == 4 (note terminating \0)
204 int a[5] = {1, 2}; -- countof(a) == 5
205 char *a[] = { -- countof(a) == 3
208 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
210 /* Zero out a value. */
211 #define xzero(x) memset (&(x), '\0', sizeof (x))
213 /* Convert an ASCII hex digit to the corresponding number between 0
214 and 15. H should be a hexadecimal digit that satisfies isxdigit;
215 otherwise, the result is undefined. */
216 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
217 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
219 /* The reverse of the above: convert a number in the [0, 16) range to
220 the ASCII representation of the corresponding hexadecimal digit.
221 `+ 0' is there so you can't accidentally use it as an lvalue. */
222 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
223 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
225 /* Copy the data delimited with BEG and END to alloca-allocated
226 storage, and zero-terminate it. Arguments are evaluated only once,
227 in the order BEG, END, PLACE. */
228 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
229 const char *BTA_beg = (beg); \
230 int BTA_len = (end) - BTA_beg; \
231 char **BTA_dest = &(place); \
232 *BTA_dest = alloca (BTA_len + 1); \
233 memcpy (*BTA_dest, BTA_beg, BTA_len); \
234 (*BTA_dest)[BTA_len] = '\0'; \
237 /* Return non-zero if string bounded between BEG and END is equal to
238 STRING_LITERAL. The comparison is case-sensitive. */
239 #define BOUNDED_EQUAL(beg, end, string_literal) \
240 ((end) - (beg) == sizeof (string_literal) - 1 \
241 && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
243 /* The same as above, except the comparison is case-insensitive. */
244 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \
245 ((end) - (beg) == sizeof (string_literal) - 1 \
246 && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
248 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
249 This cannot be an expression because this is not portable:
250 #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
251 The problem is that some compilers can't handle alloca() being an
252 argument to a function. */
254 #define STRDUP_ALLOCA(ptr, str) do { \
255 char **SA_dest = &(ptr); \
256 const char *SA_src = (str); \
257 *SA_dest = (char *)alloca (strlen (SA_src) + 1); \
258 strcpy (*SA_dest, SA_src); \
261 /* Generally useful if you want to avoid arbitrary size limits but
262 don't need a full dynamic array. Assumes that BASEVAR points to a
263 malloced array of TYPE objects (or possibly a NULL pointer, if
264 SIZEVAR is 0), with the total size stored in SIZEVAR. This macro
265 will realloc BASEVAR as necessary so that it can hold at least
266 NEEDED_SIZE objects. The reallocing is done by doubling, which
267 ensures constant amortized time per element. */
269 #define DO_REALLOC(basevar, sizevar, needed_size, type) do { \
270 long DR_needed_size = (needed_size); \
271 long DR_newsize = 0; \
272 while ((sizevar) < (DR_needed_size)) { \
273 DR_newsize = sizevar << 1; \
274 if (DR_newsize < 16) \
276 (sizevar) = DR_newsize; \
279 basevar = xrealloc (basevar, DR_newsize * sizeof (type)); \
282 /* Used to print pointers (usually for debugging). Print pointers
283 using printf ("0x%0*lx", PTR_FORMAT (p)). (%p is too unpredictable;
284 some implementations prepend 0x, while some don't, and most don't
285 0-pad the address.) */
286 #define PTR_FORMAT(p) (int) (2 * sizeof (void *)), (unsigned long) (p)
288 extern const char *exec_name;
290 /* Document type ("dt") flags */
293 TEXTHTML = 0x0001, /* document is of type text/html
294 or application/xhtml+xml */
295 RETROKF = 0x0002, /* retrieval was OK */
296 HEAD_ONLY = 0x0004, /* only send the HEAD request */
297 SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */
298 ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */
299 ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */
302 /* Universal error type -- used almost everywhere. Error reporting of
303 this detail is not generally used or needed and should be
308 NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
309 CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR, CONCLOSED,
311 FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR,
312 FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR, FTPREXC,
314 FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, FOPENERR,
315 FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF,
317 HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
318 FTPINVPASV, FTPNOPASV, CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED,
320 READERR, TRYLIMEXC, URLBADPATTERN, FILEBADFILE, RANGEERR,
321 RETRBADPATTERN, RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR,
323 AUTHFAILED, QUOTEXC, WRITEFAILED, SSLINITFAILED