1 /* Miscellaneous declarations.
2 Copyright (C) 1995, 1996, 1997, 1998, 2003 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
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 /* `gettext (FOO)' is long to write, so we use `_(FOO)'. If NLS is
44 unavailable, _(STRING) simply returns STRING. */
46 # define _(string) gettext (string)
47 # ifdef HAVE_LIBINTL_H
49 # else /* not HAVE_LIBINTL_H */
50 const char *gettext ();
51 # endif /* not HAVE_LIBINTL_H */
52 #else /* not HAVE_NLS */
53 # define _(string) (string)
54 #endif /* not HAVE_NLS */
56 /* A pseudo function call that serves as a marker for the automated
57 extraction of messages, but does not call gettext(). The run-time
58 translation is done at a different place in the code. The purpose
59 of the N_("...") call is to make the message snarfer aware that the
60 "..." string needs to be translated. STRING should be a string
61 literal. Concatenated strings and other string expressions won't
62 work. The macro's expansion is not parenthesized, so that it is
63 suitable as initializer for static 'char[]' or 'const char[]'
64 variables. -- explanation partly taken from GNU make. */
65 #define N_(string) string
67 /* I18N NOTE: You will notice that none of the DEBUGP messages are
68 marked as translatable. This is intentional, for a few reasons:
70 1) The debug messages are not meant for the users to look at, but
71 for the developers; as such, they should be considered more like
72 source comments than real program output.
74 2) The messages are numerous, and yet they are random and frivolous
75 ("double yuck!" and such). There would be a lot of work with no
78 3) Finally, the debug messages are meant to be a clue for me to
79 debug problems with Wget. If I get them in a language I don't
80 understand, debugging will become a new challenge of its own! */
83 /* Include these, so random files need not include them. */
85 /* locale independent replacement for ctype.h */
86 #include "safe-ctype.h"
88 /* Conditionalize the use of GCC's __attribute__((format)) and
89 __builtin_expect features using macros. */
91 #if defined(__GNUC__) && __GNUC__ >= 3
92 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
93 # define LIKELY(exp) __builtin_expect (!!(exp), 1)
94 # define UNLIKELY(exp) __builtin_expect ((exp), 0)
96 # define GCC_FORMAT_ATTR(a, b)
97 # define LIKELY(exp) (exp)
98 # define UNLIKELY(exp) (exp)
101 /* Execute the following statement if debugging is both enabled at
102 compile-time and requested at run-time; a no-op otherwise. */
105 # define IF_DEBUG if (UNLIKELY (opt.debug))
107 # define IF_DEBUG if (0)
110 /* Print ARGS if debugging is enabled and requested, otherwise do
111 nothing. This must be called with an extra level of parentheses
112 because it's not possible to pass a variable number of arguments to
113 a macro (in portable C89). ARGS are like arguments to printf. */
115 #define DEBUGP(args) do { IF_DEBUG { debug_logprintf args; } } while (0)
117 /* Define an integer type that works for file sizes, content lengths,
118 and such. Normally we could just use off_t, but off_t is always
119 32-bit on Windows. */
123 # define SIZEOF_WGINT SIZEOF_OFF_T
126 /* Define a strtol/strtoll clone that works with wgint. */
127 #ifndef str_to_wgint /* mswindows.h defines its own alias */
128 # if SIZEOF_WGINT == SIZEOF_LONG
129 # define str_to_wgint strtol
130 # define WGINT_MAX LONG_MAX
132 # define str_to_wgint strtoll
133 # define WGINT_MAX LLONG_MAX
137 /* Now define a large integral type useful for storing sizes of *sums*
138 of downloads, such as the value of the --quota option. This should
139 be a type able to hold 2G+ values even on systems without large
140 file support. (It is useful to limit Wget's download quota to say
141 10G even if a single file cannot be that large.)
143 To make sure we get the largest size possible, we use `double' on
144 systems without a 64-bit integral type. (Since it is used in very
145 few places in Wget, this is acceptable.) */
147 #if SIZEOF_WGINT >= 8
148 /* just use wgint, which we already know how to print */
149 typedef wgint SUM_SIZE_INT;
150 # define with_thousand_seps_sum with_thousand_seps
152 /* On systems without LFS, use double, which buys us integers up to 2^53. */
153 typedef double SUM_SIZE_INT;
158 /* Everything uses this, so include them here directly. */
161 /* Likewise for logging functions. */
164 /* Useful macros used across the code: */
166 /* The number of elements in an array. For example:
167 static char a[] = "foo"; -- countof(a) == 4 (note terminating \0)
168 int a[5] = {1, 2}; -- countof(a) == 5
169 char *a[] = { -- countof(a) == 3
172 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
174 /* Zero out a value. */
175 #define xzero(x) memset (&(x), '\0', sizeof (x))
177 /* Convert an ASCII hex digit to the corresponding number between 0
178 and 15. H should be a hexadecimal digit that satisfies isxdigit;
179 otherwise, the result is undefined. */
180 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
181 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
183 /* The reverse of the above: convert a number in the [0, 16) range to
184 the ASCII representation of the corresponding hexadecimal digit.
185 `+ 0' is there so you can't accidentally use it as an lvalue. */
186 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
187 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
189 /* Copy the data delimited with BEG and END to alloca-allocated
190 storage, and zero-terminate it. Arguments are evaluated only once,
191 in the order BEG, END, PLACE. */
192 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
193 const char *BTA_beg = (beg); \
194 int BTA_len = (end) - BTA_beg; \
195 char **BTA_dest = &(place); \
196 *BTA_dest = alloca (BTA_len + 1); \
197 memcpy (*BTA_dest, BTA_beg, BTA_len); \
198 (*BTA_dest)[BTA_len] = '\0'; \
201 /* Return non-zero if string bounded between BEG and END is equal to
202 STRING_LITERAL. The comparison is case-sensitive. */
203 #define BOUNDED_EQUAL(beg, end, string_literal) \
204 ((end) - (beg) == sizeof (string_literal) - 1 \
205 && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
207 /* The same as above, except the comparison is case-insensitive. */
208 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \
209 ((end) - (beg) == sizeof (string_literal) - 1 \
210 && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
212 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
213 This cannot be an expression because this is not portable:
214 #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
215 The problem is that some compilers can't handle alloca() being an
216 argument to a function. */
218 #define STRDUP_ALLOCA(ptr, str) do { \
219 char **SA_dest = &(ptr); \
220 const char *SA_src = (str); \
221 *SA_dest = (char *)alloca (strlen (SA_src) + 1); \
222 strcpy (*SA_dest, SA_src); \
225 /* Generally useful if you want to avoid arbitrary size limits but
226 don't need a full dynamic array. Assumes that BASEVAR points to a
227 malloced array of TYPE objects (or possibly a NULL pointer, if
228 SIZEVAR is 0), with the total size stored in SIZEVAR. This macro
229 will realloc BASEVAR as necessary so that it can hold at least
230 NEEDED_SIZE objects. The reallocing is done by doubling, which
231 ensures constant amortized time per element. */
233 #define DO_REALLOC(basevar, sizevar, needed_size, type) do { \
234 long DR_needed_size = (needed_size); \
235 long DR_newsize = 0; \
236 while ((sizevar) < (DR_needed_size)) { \
237 DR_newsize = sizevar << 1; \
238 if (DR_newsize < 16) \
240 (sizevar) = DR_newsize; \
243 basevar = xrealloc (basevar, DR_newsize * sizeof (type)); \
246 /* Used to print pointers (usually for debugging). Print pointers
247 using printf ("%0*lx", PTR_FORMAT (p)). (%p is too unpredictable;
248 some implementations prepend 0x, while some don't, and most don't
249 0-pad the address.) */
250 #define PTR_FORMAT(p) 2 * sizeof (void *), (unsigned long) (p)
252 extern const char *exec_name;
254 /* Document type ("dt") flags */
257 TEXTHTML = 0x0001, /* document is of type text/html
258 or application/xhtml+xml */
259 RETROKF = 0x0002, /* retrieval was OK */
260 HEAD_ONLY = 0x0004, /* only send the HEAD request */
261 SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */
262 ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */
263 ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */
266 /* Universal error type -- used almost everywhere. Error reporting of
267 this detail is not generally used or needed and should be
271 NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
272 CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
273 CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR,
274 FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
275 FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
276 FOPENERR, FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF,
277 HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
278 FTPINVPASV, FTPNOPASV,
279 CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
280 URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
281 RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
282 QUOTEXC, WRITEFAILED, SSLINITFAILED