sjero.net Git - wget/blob - src/wget.h

   1 /* Miscellaneous declarations.
   2    Copyright (C) 1995, 1996, 1997, 1998, 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Wget.
   5
   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.
  10
  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.
  15
  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.
  19
  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.  */
  29
  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.  */
  34
  35 #ifndef WGET_H
  36 #define WGET_H
  37
  38 /* Disable assertions when debug support is not compiled in. */
  39 #ifndef ENABLE_DEBUG
  40 # define NDEBUG
  41 #endif
  42
  43 #ifndef PARAMS
  44 # if PROTOTYPES
  45 #  define PARAMS(args) args
  46 # else
  47 #  define PARAMS(args) ()
  48 # endif
  49 #endif
  50
  51 /* `gettext (FOO)' is long to write, so we use `_(FOO)'.  If NLS is
  52    unavailable, _(STRING) simply returns STRING.  */
  53 #ifdef HAVE_NLS
  54 # define _(string) gettext (string)
  55 # ifdef HAVE_LIBINTL_H
  56 #  include <libintl.h>
  57 # endif /* HAVE_LIBINTL_H */
  58 #else  /* not HAVE_NLS */
  59 # define _(string) (string)
  60 #endif /* not HAVE_NLS */
  61
  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
  72
  73 /* I18N NOTE: You will notice that none of the DEBUGP messages are
  74    marked as translatable.  This is intentional, for a few reasons:
  75
  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.
  79
  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
  82    gain.
  83
  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!  */
  87
  88
  89 /* Include these, so random files need not include them.  */
  90 #include "sysdep.h"
  91 #include "options.h"
  92 /* locale independent replacement for ctype.h */
  93 #include "safe-ctype.h"
  94
  95 #define DO_NOTHING do {} while (0)
  96
  97 /* Print X if debugging is enabled; a no-op otherwise.  */
  98 #ifdef ENABLE_DEBUG
  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 */
 103
 104 /* Everything uses this, so include them here directly.  */
 105 #include "xmalloc.h"
 106
 107 /* Likewise for logging functions.  */
 108 #include "log.h"
 109 \f
 110 /* Useful macros used across the code: */
 111
 112 /* The number of elements in an array.  For example:
 113    static char a[] = "foo";     -- countof(a) == 4 (note terminating \0)
 114    int a[5] = {1, 2};           -- countof(a) == 5
 115    char *a[] = {                -- countof(a) == 3
 116      "foo", "bar", "baz"
 117    }; */
 118 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
 119
 120 /* Zero out a value.  */
 121 #define xzero(x) memset (&(x), '\0', sizeof (x))
 122
 123 /* Convert an ASCII hex digit to the corresponding number between 0
 124    and 15.  H should be a hexadecimal digit that satisfies isxdigit;
 125    otherwise, the result is undefined.  */
 126 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
 127 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
 128
 129 /* The reverse of the above: convert a number in the [0, 16) range to
 130    the ASCII representation of the corresponding hexadecimal digit.
 131    `+ 0' is there so you can't accidentally use it as an lvalue.  */
 132 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
 133 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
 134
 135 /* Copy the data delimited with BEG and END to alloca-allocated
 136    storage, and zero-terminate it.  Arguments are evaluated only once,
 137    in the order BEG, END, PLACE.  */
 138 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
 139   const char *BTA_beg = (beg);                  \
 140   int BTA_len = (end) - BTA_beg;                \
 141   char **BTA_dest = &(place);                   \
 142   *BTA_dest = alloca (BTA_len + 1);             \
 143   memcpy (*BTA_dest, BTA_beg, BTA_len);         \
 144   (*BTA_dest)[BTA_len] = '\0';                  \
 145 } while (0)
 146
 147 /* Return non-zero if string bounded between BEG and END is equal to
 148    STRING_LITERAL.  The comparison is case-sensitive.  */
 149 #define BOUNDED_EQUAL(beg, end, string_literal)                         \
 150   ((end) - (beg) == sizeof (string_literal) - 1                         \
 151    && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
 152
 153 /* The same as above, except the comparison is case-insensitive. */
 154 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal)                 \
 155   ((end) - (beg) == sizeof (string_literal) - 1                         \
 156    && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
 157
 158 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
 159    This cannot be an expression because this is not portable:
 160      #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
 161    The problem is that some compilers can't handle alloca() being an
 162    argument to a function.  */
 163
 164 #define STRDUP_ALLOCA(ptr, str) do {                    \
 165   char **SA_dest = &(ptr);                              \
 166   const char *SA_src = (str);                           \
 167   *SA_dest = (char *)alloca (strlen (SA_src) + 1);      \
 168   strcpy (*SA_dest, SA_src);                            \
 169 } while (0)
 170
 171 /* Generally useful if you want to avoid arbitrary size limits but
 172    don't need a full dynamic array.  Assumes that BASEVAR points to a
 173    malloced array of TYPE objects (or possibly a NULL pointer, if
 174    SIZEVAR is 0), with the total size stored in SIZEVAR.  This macro
 175    will realloc BASEVAR as necessary so that it can hold at least
 176    NEEDED_SIZE objects.  The reallocing is done by doubling, which
 177    ensures constant amortized time per element.  */
 178
 179 #define DO_REALLOC(basevar, sizevar, needed_size, type) do {            \
 180   long DR_needed_size = (needed_size);                                  \
 181   long DR_newsize = 0;                                                  \
 182   while ((sizevar) < (DR_needed_size)) {                                \
 183     DR_newsize = sizevar << 1;                                          \
 184     if (DR_newsize < 16)                                                \
 185       DR_newsize = 16;                                                  \
 186     (sizevar) = DR_newsize;                                             \
 187   }                                                                     \
 188   if (DR_newsize)                                                       \
 189     basevar = (type *)xrealloc (basevar, DR_newsize * sizeof (type));   \
 190 } while (0)
 191
 192 extern const char *exec_name;
 193 \f
 194 /* Document type ("dt") flags */
 195 enum
 196 {
 197   TEXTHTML             = 0x0001,        /* document is of type text/html
 198                                            or application/xhtml+xml */
 199   RETROKF              = 0x0002,        /* retrieval was OK */
 200   HEAD_ONLY            = 0x0004,        /* only send the HEAD request */
 201   SEND_NOCACHE         = 0x0008,        /* send Pragma: no-cache directive */
 202   ACCEPTRANGES         = 0x0010,        /* Accept-ranges header was found */
 203   ADDED_HTML_EXTENSION = 0x0020         /* added ".html" extension due to -E */
 204 };
 205
 206 /* Universal error type -- used almost everywhere.  Error reporting of
 207    this detail is not generally used or needed and should be
 208    simplified.  */
 209 typedef enum
 210 {
 211   NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
 212   CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
 213   BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK,
 214   CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR,
 215   FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
 216   FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
 217   FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
 218   HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
 219   FTPINVPASV, FTPNOPASV,
 220   CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
 221   URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
 222   RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
 223   QUOTEXC, WRITEFAILED,
 224   SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE
 225 } uerr_t;
 226
 227 /* In case old systems don't have EAFNOSUPPORT, which we use below. */
 228 #ifndef EAFNOSUPPORT
 229 # define EAFNOSUPPORT EINVAL
 230 #endif
 231
 232 #define CONNECT_ERROR(err) ((   (err) == EAFNOSUPPORT           \
 233                              || (err) == EINVAL                 \
 234                              || ((err) == ECONNREFUSED          \
 235                                  && !opt.retry_connrefused))    \
 236                             ? CONIMPOSSIBLE : CONERROR)
 237
 238 #endif /* WGET_H */