1 /* Miscellaneous declarations.
2 Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
4 This file is part of Wget.
6 This program 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 This program 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 this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* This file contains some declarations that don't fit anywhere else.
21 It also contains some useful includes, like the obnoxious TIME_H
28 # define NDEBUG /* To kill off assertions */
29 #endif /* not DEBUG */
33 # define PARAMS(args) args
35 # define PARAMS(args) ()
39 /* `gettext (FOO)' is long to write, so we use `_(FOO)'. If NLS is
40 unavailable, _(STRING) simply returns STRING. */
42 # define _(string) gettext (string)
43 # ifdef HAVE_LIBINTL_H
45 # endif /* HAVE_LIBINTL_H */
46 #else /* not HAVE_NLS */
47 # define _(string) string
48 #endif /* not HAVE_NLS */
50 /* I18N NOTE: You will notice that none of the DEBUG messages are
51 marked as translatable. This is intentional, for a few reasons:
53 1) The debug messages are not meant for the users to look at, but
54 for the developers; as such, they should be considered more like
55 source comments than real program output.
57 2) The messages are numerous, and yet they are random and frivolous
58 ("double yuck!" and such). There would be a lot of work with no
61 3) Finally, the debug messages are meant to be a clue for me to
62 debug problems with Wget. If I get them in a language I don't
63 understand, debugging will become a new challenge of its own! :-) */
66 /* Include these, so random files need not include them. */
69 /* locale independent replacement for ctype.h */
70 #include "safe-ctype.h"
72 #define DO_NOTHING do {} while (0)
74 /* Print X if debugging is enabled; a no-op otherwise. */
76 # define DEBUGP(x) do { if (opt.debug) { debug_logprintf x; } } while (0)
78 # define DEBUGP(x) DO_NOTHING
79 #endif /* not DEBUG */
81 /* Make gcc check for the format of logmsg() and debug_logmsg(). */
83 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
84 #else /* not __GNUC__ */
85 # define GCC_FORMAT_ATTR(a, b)
86 #endif /* not __GNUC__ */
88 /* These are from log.c, but they are used everywhere, so we declare
90 enum log_options { LOG_VERBOSE, LOG_NOTQUIET, LOG_NONVERBOSE, LOG_ALWAYS };
93 void logprintf PARAMS ((enum log_options, const char *, ...))
94 GCC_FORMAT_ATTR (2, 3);
95 void debug_logprintf PARAMS ((const char *, ...)) GCC_FORMAT_ATTR (1, 2);
96 #else /* not HAVE_STDARG_H */
98 void debug_logprintf ();
99 #endif /* not HAVE_STDARG_H */
100 void logputs PARAMS ((enum log_options, const char *));
102 /* Defined in `utils.c', but used literally everywhere. */
105 #define xmalloc xmalloc_real
106 #define xrealloc xrealloc_real
107 #define xstrdup xstrdup_real
110 void *xmalloc_real PARAMS ((size_t));
111 void *xrealloc_real PARAMS ((void *, size_t));
112 char *xstrdup_real PARAMS ((const char *));
114 #else /* DEBUG_MALLOC */
116 #define xmalloc(s) xmalloc_debug (s, __FILE__, __LINE__)
117 #define xfree(p) xfree_debug (p, __FILE__, __LINE__)
118 #define xrealloc(p, s) xrealloc_debug (p, s, __FILE__, __LINE__)
119 #define xstrdup(p) xstrdup_debug (p, __FILE__, __LINE__)
121 void *xmalloc_debug PARAMS ((size_t, const char *, int));
122 void xfree_debug PARAMS ((void *, const char *, int));
123 void *xrealloc_debug PARAMS ((void *, size_t, const char *, int));
124 char *xstrdup_debug PARAMS ((const char *, const char *, int));
126 #endif /* DEBUG_MALLOC */
128 /* #### Find a better place for this. */
129 /* The log file to which Wget writes to after HUP. */
130 #define DEFAULT_LOGFILE "wget-log"
132 #define MD5_HASHLEN 16
134 /* Useful macros used across the code: */
136 /* Is the string a hpyhen-only? */
137 #define HYPHENP(x) (*(x) == '-' && !*((x) + 1))
139 /* The smaller value of the two. */
140 #define MINVAL(x, y) ((x) < (y) ? (x) : (y))
142 /* ASCII char -> HEX digit */
143 #define ASC2HEXD(x) (((x) >= '0' && (x) <= '9') ? \
144 ((x) - '0') : (TOUPPER(x) - 'A' + 10))
146 /* HEX digit -> ASCII char */
147 #define HEXD2ASC(x) (((x) < 10) ? ((x) + '0') : ((x) - 10 + 'A'))
149 #define ARRAY_SIZE(array) (sizeof (array) / sizeof (*(array)))
151 /* Note that this much more elegant definition cannot be used:
153 #define STRDUP_ALLOCA(str) (strcpy ((char *)alloca (strlen (str) + 1), str))
155 This is because some compilers don't handle alloca() as argument to
156 function correctly. Gcc under Intel has been reported to offend in
159 #define STRDUP_ALLOCA(ptr, str) do { \
160 (ptr) = (char *)alloca (strlen (str) + 1); \
164 #define ALLOCA_ARRAY(type, len) ((type *) alloca ((len) * sizeof (type)))
166 #define XREALLOC_ARRAY(ptr, type, len) \
167 ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
169 /* Generally useful if you want to avoid arbitrary size limits but
170 don't need a full dynamic array. Assumes that BASEVAR points to a
171 malloced array of TYPE objects (or possibly a NULL pointer, if
172 SIZEVAR is 0), with the total size stored in SIZEVAR. This macro
173 will realloc BASEVAR as necessary so that it can hold at least
174 NEEDED_SIZE objects. The reallocing is done by doubling, which
175 ensures constant amortized time per element. */
176 #define DO_REALLOC(basevar, sizevar, needed_size, type) do \
178 /* Avoid side-effectualness. */ \
179 long do_realloc_needed_size = (needed_size); \
180 long do_realloc_newsize = 0; \
181 while ((sizevar) < (do_realloc_needed_size)) { \
182 do_realloc_newsize = 2*(sizevar); \
183 if (do_realloc_newsize < 32) \
184 do_realloc_newsize = 32; \
185 (sizevar) = do_realloc_newsize; \
187 if (do_realloc_newsize) \
188 XREALLOC_ARRAY (basevar, type, do_realloc_newsize); \
191 /* Use this for small stack-allocated memory chunks that might grow.
192 The initial array is created using alloca(), and this macro
193 requests it to grow. If the needed size is larger than the array,
194 this macro will use malloc to allocate it to new size, and copy the
195 old contents. After that, successive invocations behave just like
197 #define DO_REALLOC_FROM_ALLOCA(basevar, sizevar, needed_size, allocap, type) do \
199 /* Avoid side-effectualness. */ \
200 long do_realloc_needed_size = (needed_size); \
201 long do_realloc_newsize = 0; \
202 while ((sizevar) < (do_realloc_needed_size)) { \
203 do_realloc_newsize = 2*(sizevar); \
204 if (do_realloc_newsize < 16) \
205 do_realloc_newsize = 16; \
206 (sizevar) = do_realloc_newsize; \
208 if (do_realloc_newsize) \
211 XREALLOC_ARRAY (basevar, type, do_realloc_newsize); \
214 void *drfa_new_basevar = xmalloc (do_realloc_newsize); \
215 memcpy (drfa_new_basevar, basevar, sizevar); \
216 (basevar) = drfa_new_basevar; \
222 /* Free FOO if it is non-NULL. */
223 #define FREE_MAYBE(foo) do { if (foo) xfree (foo); } while (0)
225 /* #### Hack: OPTIONS_DEFINED_HERE is defined in main.c. */
226 /* [Is this weird hack really necessary on any compilers? No ANSI C compiler
227 should complain about "extern const char *exec_name;" followed by
228 "const char *exec_name;". Are we doing this for K&R compilers, or...??
229 -- Dan Harkless <wget@harkless.org>] */
230 #ifndef OPTIONS_DEFINED_HERE
231 extern const char *exec_name;
235 /* Document type ("dt") flags */
238 TEXTHTML = 0x0001, /* document is of type text/html */
239 RETROKF = 0x0002, /* retrieval was OK */
240 HEAD_ONLY = 0x0004, /* only send the HEAD request */
241 SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */
242 ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */
243 ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */
246 /* Universal error type -- used almost everywhere.
247 This is, of course, utter crock. */
250 NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
251 CONREFUSED, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
252 BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK,
253 CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR,
254 FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
255 FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLHTTPS,
256 URLOK, URLHTTP, URLFTP, URLFILE, URLUNKNOWN, URLBADPORT,
257 URLBADHOST, FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
258 HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
259 FTPINVPASV, FTPNOPASV,
260 CONTNOTSUPPORTED, RETRFINISHED, READERR, TRYLIMEXC,
261 URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
262 RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
263 QUOTEXC, WRITEFAILED,
264 SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE
267 typedef unsigned char boolean;
275 /* So we can say strcmp(a, b) == EQ rather than strcmp(a, b) == 0 or
276 the really awful !strcmp(a, b). */
279 /* For most options, 0 means no limits, but with -p in the picture, that causes
280 a problem on the maximum recursion depth variable. To retain backwards
281 compatibility we allow users to consider "0" to be synonymous with "inf" for
282 -l, but internally infinite recursion is specified by -1 and 0 means to only
283 retrieve the requisites of a single document. */
284 #define INFINITE_RECURSION -1