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. */
45 # define PARAMS(args) args
47 # define PARAMS(args) ()
51 /* `gettext (FOO)' is long to write, so we use `_(FOO)'. If NLS is
52 unavailable, _(STRING) simply returns STRING. */
54 # define _(string) gettext (string)
55 # ifdef HAVE_LIBINTL_H
57 # endif /* HAVE_LIBINTL_H */
58 #else /* not HAVE_NLS */
59 # define _(string) (string)
60 #endif /* not HAVE_NLS */
62 /* A pseudo function call that serves as a marker for the automated
63 extraction of messages, but does not call gettext(). The run-time
64 translation is done at a different place in the code. The purpose
65 of the N_("...") call is to make the message snarfer aware that the
66 "..." string needs to be translated. STRING should be a string
67 literal. Concatenated strings and other string expressions won't
68 work. The macro's expansion is not parenthesized, so that it is
69 suitable as initializer for static 'char[]' or 'const char[]'
70 variables. -- explanation partly taken from GNU make. */
71 #define N_(string) string
73 /* I18N NOTE: You will notice that none of the DEBUGP messages are
74 marked as translatable. This is intentional, for a few reasons:
76 1) The debug messages are not meant for the users to look at, but
77 for the developers; as such, they should be considered more like
78 source comments than real program output.
80 2) The messages are numerous, and yet they are random and frivolous
81 ("double yuck!" and such). There would be a lot of work with no
84 3) Finally, the debug messages are meant to be a clue for me to
85 debug problems with Wget. If I get them in a language I don't
86 understand, debugging will become a new challenge of its own! */
89 /* Include these, so random files need not include them. */
91 /* locale independent replacement for ctype.h */
92 #include "safe-ctype.h"
94 /* Conditionalize the use of GCC's __attribute__((format)) and
95 __builtin_expect features using macros. */
97 #if defined(__GNUC__) && __GNUC__ >= 3
98 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
99 # define LIKELY(exp) __builtin_expect (!!(exp), 1)
100 # define UNLIKELY(exp) __builtin_expect ((exp), 0)
102 # define GCC_FORMAT_ATTR(a, b)
103 # define LIKELY(exp) (exp)
104 # define UNLIKELY(exp) (exp)
107 /* Print X if debugging is enabled; a no-op otherwise. */
110 # define DEBUGP(x) do if (UNLIKELY (opt.debug)) {debug_logprintf x;} while (0)
111 #else /* not ENABLE_DEBUG */
112 # define DEBUGP(x) do {} while (0)
113 #endif /* not ENABLE_DEBUG */
115 /* Define an integer type that works for file sizes, content lengths,
116 and such. Normally we could just use off_t, but off_t is always
117 32-bit on Windows. */
121 # define SIZEOF_WGINT SIZEOF_OFF_T
124 /* Define a strtol/strtoll clone that works with wgint. */
125 #ifndef str_to_wgint /* mswindows.h defines its own alias */
126 # if SIZEOF_WGINT == SIZEOF_LONG
127 # define str_to_wgint strtol
128 # define WGINT_MAX LONG_MAX
130 # define str_to_wgint strtoll
131 # define WGINT_MAX LLONG_MAX
137 /* Everything uses this, so include them here directly. */
140 /* Likewise for logging functions. */
143 /* Useful macros used across the code: */
145 /* The number of elements in an array. For example:
146 static char a[] = "foo"; -- countof(a) == 4 (note terminating \0)
147 int a[5] = {1, 2}; -- countof(a) == 5
148 char *a[] = { -- countof(a) == 3
151 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
153 /* Zero out a value. */
154 #define xzero(x) memset (&(x), '\0', sizeof (x))
156 /* Convert an ASCII hex digit to the corresponding number between 0
157 and 15. H should be a hexadecimal digit that satisfies isxdigit;
158 otherwise, the result is undefined. */
159 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
160 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
162 /* The reverse of the above: convert a number in the [0, 16) range to
163 the ASCII representation of the corresponding hexadecimal digit.
164 `+ 0' is there so you can't accidentally use it as an lvalue. */
165 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
166 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
168 /* Copy the data delimited with BEG and END to alloca-allocated
169 storage, and zero-terminate it. Arguments are evaluated only once,
170 in the order BEG, END, PLACE. */
171 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
172 const char *BTA_beg = (beg); \
173 int BTA_len = (end) - BTA_beg; \
174 char **BTA_dest = &(place); \
175 *BTA_dest = alloca (BTA_len + 1); \
176 memcpy (*BTA_dest, BTA_beg, BTA_len); \
177 (*BTA_dest)[BTA_len] = '\0'; \
180 /* Return non-zero if string bounded between BEG and END is equal to
181 STRING_LITERAL. The comparison is case-sensitive. */
182 #define BOUNDED_EQUAL(beg, end, string_literal) \
183 ((end) - (beg) == sizeof (string_literal) - 1 \
184 && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
186 /* The same as above, except the comparison is case-insensitive. */
187 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \
188 ((end) - (beg) == sizeof (string_literal) - 1 \
189 && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
191 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
192 This cannot be an expression because this is not portable:
193 #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
194 The problem is that some compilers can't handle alloca() being an
195 argument to a function. */
197 #define STRDUP_ALLOCA(ptr, str) do { \
198 char **SA_dest = &(ptr); \
199 const char *SA_src = (str); \
200 *SA_dest = (char *)alloca (strlen (SA_src) + 1); \
201 strcpy (*SA_dest, SA_src); \
204 /* Generally useful if you want to avoid arbitrary size limits but
205 don't need a full dynamic array. Assumes that BASEVAR points to a
206 malloced array of TYPE objects (or possibly a NULL pointer, if
207 SIZEVAR is 0), with the total size stored in SIZEVAR. This macro
208 will realloc BASEVAR as necessary so that it can hold at least
209 NEEDED_SIZE objects. The reallocing is done by doubling, which
210 ensures constant amortized time per element. */
212 #define DO_REALLOC(basevar, sizevar, needed_size, type) do { \
213 long DR_needed_size = (needed_size); \
214 long DR_newsize = 0; \
215 while ((sizevar) < (DR_needed_size)) { \
216 DR_newsize = sizevar << 1; \
217 if (DR_newsize < 16) \
219 (sizevar) = DR_newsize; \
222 basevar = (type *)xrealloc (basevar, DR_newsize * sizeof (type)); \
225 extern const char *exec_name;
227 /* Document type ("dt") flags */
230 TEXTHTML = 0x0001, /* document is of type text/html
231 or application/xhtml+xml */
232 RETROKF = 0x0002, /* retrieval was OK */
233 HEAD_ONLY = 0x0004, /* only send the HEAD request */
234 SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */
235 ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */
236 ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */
239 /* Universal error type -- used almost everywhere. Error reporting of
240 this detail is not generally used or needed and should be
244 NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
245 CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
246 CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR,
247 FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
248 FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
249 FOPENERR, FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF,
250 HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
251 FTPINVPASV, FTPNOPASV,
252 CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
253 URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
254 RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
255 QUOTEXC, WRITEFAILED,
256 SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE