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. */
92 /* locale independent replacement for ctype.h */
93 #include "safe-ctype.h"
95 #define DO_NOTHING do {} while (0)
97 /* Print X if debugging is enabled; a no-op otherwise. */
99 # define DEBUGP(x) do { if (opt.debug) { debug_logprintf x; } } while (0)
100 #else /* not ENABLE_DEBUG */
101 # define DEBUGP(x) DO_NOTHING
102 #endif /* not ENABLE_DEBUG */
105 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
106 #else /* not __GNUC__ */
107 # define GCC_FORMAT_ATTR(a, b)
108 #endif /* not __GNUC__ */
110 /* Everything uses this, so include them here directly. */
113 /* Likewise for logging functions. */
116 /* Useful macros used across the code: */
118 /* The number of elements in an array. For example:
119 static char a[] = "foo"; -- countof(a) == 4 (note terminating \0)
120 int a[5] = {1, 2}; -- countof(a) == 5
121 char *a[] = { -- countof(a) == 3
124 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
126 /* Zero out a value. */
127 #define xzero(x) memset (&(x), '\0', sizeof (x))
129 /* Convert an ASCII hex digit to the corresponding number between 0
130 and 15. H should be a hexadecimal digit that satisfies isxdigit;
131 otherwise, the result is undefined. */
132 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
133 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
135 /* The reverse of the above: convert a number in the [0, 16) range to
136 the ASCII representation of the corresponding hexadecimal digit.
137 `+ 0' is there so you can't accidentally use it as an lvalue. */
138 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
139 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
141 /* Copy the data delimited with BEG and END to alloca-allocated
142 storage, and zero-terminate it. Arguments are evaluated only once,
143 in the order BEG, END, PLACE. */
144 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
145 const char *BTA_beg = (beg); \
146 int BTA_len = (end) - BTA_beg; \
147 char **BTA_dest = &(place); \
148 *BTA_dest = alloca (BTA_len + 1); \
149 memcpy (*BTA_dest, BTA_beg, BTA_len); \
150 (*BTA_dest)[BTA_len] = '\0'; \
153 /* Return non-zero if string bounded between BEG and END is equal to
154 STRING_LITERAL. The comparison is case-sensitive. */
155 #define BOUNDED_EQUAL(beg, end, string_literal) \
156 ((end) - (beg) == sizeof (string_literal) - 1 \
157 && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
159 /* The same as above, except the comparison is case-insensitive. */
160 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \
161 ((end) - (beg) == sizeof (string_literal) - 1 \
162 && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
164 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
165 This cannot be an expression because this is not portable:
166 #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
167 The problem is that some compilers can't handle alloca() being an
168 argument to a function. */
170 #define STRDUP_ALLOCA(ptr, str) do { \
171 char **SA_dest = &(ptr); \
172 const char *SA_src = (str); \
173 *SA_dest = (char *)alloca (strlen (SA_src) + 1); \
174 strcpy (*SA_dest, SA_src); \
177 /* Generally useful if you want to avoid arbitrary size limits but
178 don't need a full dynamic array. Assumes that BASEVAR points to a
179 malloced array of TYPE objects (or possibly a NULL pointer, if
180 SIZEVAR is 0), with the total size stored in SIZEVAR. This macro
181 will realloc BASEVAR as necessary so that it can hold at least
182 NEEDED_SIZE objects. The reallocing is done by doubling, which
183 ensures constant amortized time per element. */
185 #define DO_REALLOC(basevar, sizevar, needed_size, type) do { \
186 long DR_needed_size = (needed_size); \
187 long DR_newsize = 0; \
188 while ((sizevar) < (DR_needed_size)) { \
189 DR_newsize = sizevar << 1; \
190 if (DR_newsize < 16) \
192 (sizevar) = DR_newsize; \
195 basevar = (type *)xrealloc (basevar, DR_newsize * sizeof (type)); \
198 extern const char *exec_name;
200 /* Document type ("dt") flags */
203 TEXTHTML = 0x0001, /* document is of type text/html
204 or application/xhtml+xml */
205 RETROKF = 0x0002, /* retrieval was OK */
206 HEAD_ONLY = 0x0004, /* only send the HEAD request */
207 SEND_NOCACHE = 0x0008, /* send Pragma: no-cache directive */
208 ACCEPTRANGES = 0x0010, /* Accept-ranges header was found */
209 ADDED_HTML_EXTENSION = 0x0020 /* added ".html" extension due to -E */
212 /* Universal error type -- used almost everywhere. Error reporting of
213 this detail is not generally used or needed and should be
217 NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
218 CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
219 CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR,
220 FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
221 FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
222 FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
223 HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
224 FTPINVPASV, FTPNOPASV,
225 CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
226 URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
227 RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
228 QUOTEXC, WRITEFAILED,
229 SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE