1 /* Miscellaneous declarations.
2 Copyright (C) 1995, 1996, 1997, 1998 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 some declarations that don't fit anywhere else.
31 It also contains some useful includes, like the obnoxious TIME_H
38 # define NDEBUG /* To kill off assertions */
39 #endif /* not DEBUG */
41 /* Define this if you want primitive but extensive malloc debugging.
42 It will make Wget extremely slow, so only do it in development
48 # define PARAMS(args) args
50 # define PARAMS(args) ()
54 /* `gettext (FOO)' is long to write, so we use `_(FOO)'. If NLS is
55 unavailable, _(STRING) simply returns STRING. */
57 # define _(string) gettext (string)
58 # ifdef HAVE_LIBINTL_H
60 # endif /* HAVE_LIBINTL_H */
61 #else /* not HAVE_NLS */
62 # define _(string) string
63 #endif /* not HAVE_NLS */
65 /* No-op version of gettext, used for constant strings. */
66 #define N_(string) (string)
68 /* I18N NOTE: You will notice that none of the DEBUG messages are
69 marked as translatable. This is intentional, for a few reasons:
71 1) The debug messages are not meant for the users to look at, but
72 for the developers; as such, they should be considered more like
73 source comments than real program output.
75 2) The messages are numerous, and yet they are random and frivolous
76 ("double yuck!" and such). There would be a lot of work with no
79 3) Finally, the debug messages are meant to be a clue for me to
80 debug problems with Wget. If I get them in a language I don't
81 understand, debugging will become a new challenge of its own! */
84 /* Include these, so random files need not include them. */
87 /* locale independent replacement for ctype.h */
88 #include "safe-ctype.h"
90 #define DO_NOTHING do {} while (0)
92 /* Print X if debugging is enabled; a no-op otherwise. */
94 # define DEBUGP(x) do { if (opt.debug) { debug_logprintf x; } } while (0)
96 # define DEBUGP(x) DO_NOTHING
97 #endif /* not DEBUG */
99 /* Make gcc check for the format of logmsg() and debug_logmsg(). */
101 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
102 #else /* not __GNUC__ */
103 # define GCC_FORMAT_ATTR(a, b)
104 #endif /* not __GNUC__ */
106 /* These are from log.c, but they are used everywhere, so we declare
108 enum log_options { LOG_VERBOSE, LOG_NOTQUIET, LOG_NONVERBOSE, LOG_ALWAYS };
111 void logprintf PARAMS ((enum log_options, const char *, ...))
112 GCC_FORMAT_ATTR (2, 3);
113 void debug_logprintf PARAMS ((const char *, ...)) GCC_FORMAT_ATTR (1, 2);
114 #else /* not HAVE_STDARG_H */
116 void debug_logprintf ();
117 #endif /* not HAVE_STDARG_H */
118 void logputs PARAMS ((enum log_options, const char *));
119 void logflush PARAMS ((void));
120 void log_set_flush PARAMS ((int));
121 int log_set_save_context PARAMS ((int));
123 /* Defined in `utils.c', but used literally everywhere. */
126 #define xmalloc xmalloc_real
127 #define xrealloc xrealloc_real
128 #define xstrdup xstrdup_real
131 void *xmalloc_real PARAMS ((size_t));
132 void *xrealloc_real PARAMS ((void *, size_t));
133 char *xstrdup_real PARAMS ((const char *));
135 #else /* DEBUG_MALLOC */
137 #define xmalloc(s) xmalloc_debug (s, __FILE__, __LINE__)
138 #define xfree(p) xfree_debug (p, __FILE__, __LINE__)
139 #define xrealloc(p, s) xrealloc_debug (p, s, __FILE__, __LINE__)
140 #define xstrdup(p) xstrdup_debug (p, __FILE__, __LINE__)
142 void *xmalloc_debug PARAMS ((size_t, const char *, int));
143 void xfree_debug PARAMS ((void *, const char *, int));
144 void *xrealloc_debug PARAMS ((void *, size_t, const char *, int));
145 char *xstrdup_debug PARAMS ((const char *, const char *, int));
147 #endif /* DEBUG_MALLOC */
149 /* #### Find a better place for this. */
150 /* The log file to which Wget writes to after HUP. */
151 #define DEFAULT_LOGFILE "wget-log"
153 #define MD5_HASHLEN 16
155 /* Useful macros used across the code: */
157 /* Is the string a hpyhen-only? */
158 #define HYPHENP(x) (*(x) == '-' && !*((x) + 1))
160 /* The smaller value of the two. */
161 #define MINVAL(x, y) ((x) < (y) ? (x) : (y))
163 /* Convert an ASCII hex digit to the corresponding number between 0
164 and 15. X should be a hexadecimal digit that satisfies isxdigit;
165 otherwise, the result is undefined. */
166 #define XDIGIT_TO_NUM(x) ((x) < 'A' ? (x) - '0' : TOUPPER (x) - 'A' + 10)
168 /* Convert a sequence of ASCII hex digits X and Y to a number betewen
169 0 and 255. Uses XDIGIT_TO_NUM for conversion of individual
171 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
173 /* The reverse of the above: convert a number in the [0, 16) range to
174 its ASCII representation in hex. The A-F characters are in upper
176 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x])
178 /* Like XNUM_TO_DIGIT, but generates lower-case characters. */
179 #define XNUM_TO_digit(x) ("0123456789abcdef"[x])
181 /* Returns the number of elements in an array with fixed
182 initialization. For example:
184 static char a[] = "foo"; -- countof(a) == 4 (for terminating \0)
186 int a[5] = {1, 2}; -- countof(a) == 5
188 char *a[] = { -- countof(a) == 3
191 #define countof(array) (sizeof (array) / sizeof (*(array)))
193 #define alloca_array(type, size) ((type *) alloca ((size) * sizeof (type)))
195 /* Copy the data delimited with BEG and END to alloca-allocated
196 storage, and zero-terminate it. Arguments are evaluated only once,
197 in the order BEG, END, PLACE. */
198 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
199 const char *BTA_beg = (beg); \
200 int BTA_len = (end) - BTA_beg; \
201 char **BTA_dest = &(place); \
202 *BTA_dest = alloca (BTA_len + 1); \
203 memcpy (*BTA_dest, BTA_beg, BTA_len); \
204 (*BTA_dest)[BTA_len] = '\0'; \
207 /* Return non-zero if string bounded between BEG and END is equal to
208 STRING_LITERAL. The comparison is case-sensitive. */
209 #define BOUNDED_EQUAL(beg, end, string_literal) \
210 ((end) - (beg) == sizeof (string_literal) - 1 \
211 && !memcmp ((beg), (string_literal), \
212 sizeof (string_literal) - 1))
214 /* The same as above, except the comparison is case-insensitive. */
215 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \
216 ((end) - (beg) == sizeof (string_literal) - 1 \
217 && !strncasecmp ((beg), (string_literal), \
218 sizeof (string_literal) - 1))
220 /* Note that this much more elegant definition cannot be used:
222 #define STRDUP_ALLOCA(str) (strcpy ((char *)alloca (strlen (str) + 1), str))
224 This is because some compilers don't handle alloca() as argument to
225 function correctly. Gcc under Intel has been reported to offend in
228 #define STRDUP_ALLOCA(ptr, str) do { \
229 (ptr) = (char *)alloca (strlen (str) + 1); \
230 strcpy ((ptr), (str)); \
233 /* Generally useful if you want to avoid arbitrary size limits but
234 don't need a full dynamic array. Assumes that BASEVAR points to a
235 malloced array of TYPE objects (or possibly a NULL pointer, if
236 SIZEVAR is 0), with the total size stored in SIZEVAR. This macro
237 will realloc BASEVAR as necessary so that it can hold at least
238 NEEDED_SIZE objects. The reallocing is done by doubling, which
239 ensures constant amortized time per element. */
240 #define DO_REALLOC(basevar, sizevar, needed_size, type) do \
242 /* Avoid side-effectualness. */ \
243 long do_realloc_needed_size = (needed_size); \
244 long do_realloc_newsize = 0; \
245 while ((sizevar) < (do_realloc_needed_size)) { \
246 do_realloc_newsize = 2*(sizevar); \
247 if (do_realloc_newsize < 32) \
248 do_realloc_newsize = 32; \
249 (sizevar) = do_realloc_newsize; \
251 if (do_realloc_newsize) \
252 basevar = (type *)xrealloc (basevar, do_realloc_newsize * sizeof (type)); \
255 /* Free FOO if it is non-NULL. */
256 #define FREE_MAYBE(foo) do { if (foo) xfree (foo); } while (0)
258 extern const char *exec_name;
260 /* Document type ("dt") flags */
263 TEXTHTML = 0x0001, /* document is of type text/html
264 or application/xhtml+xml */
265 RETROKF = 0x0002, /* retrieval was OK */
266 HEAD_ONLY = 0x0004, /* only send the HEAD request */
267 SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */
268 ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */
269 ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */
272 /* Universal error type -- used almost everywhere. Error reporting of
273 this detail is not generally used or needed and should be
277 NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
278 CONREFUSED, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
279 BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK,
280 CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR,
281 FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
282 FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
283 FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
284 HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
285 FTPINVPASV, FTPNOPASV,
286 CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
287 URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
288 RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
289 QUOTEXC, WRITEFAILED,
290 SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE
293 typedef unsigned char boolean;
301 /* So we can say strcmp(a, b) == EQ rather than strcmp(a, b) == 0 or
302 the really awful !strcmp(a, b). */
305 /* For most options, 0 means no limits, but with -p in the picture, that causes
306 a problem on the maximum recursion depth variable. To retain backwards
307 compatibility we allow users to consider "0" to be synonymous with "inf" for
308 -l, but internally infinite recursion is specified by -1 and 0 means to only
309 retrieve the requisites of a single document. */
310 #define INFINITE_RECURSION -1
312 #define CONNECT_ERROR(x) ((x) == ECONNREFUSED && !opt.retry_connrefused \
313 ? CONREFUSED : CONERROR)