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

   1 /* Miscellaneous declarations.
   2    Copyright (C) 1996-2005 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 Foundation, Inc.,
  18 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 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 /* Is OpenSSL or GNUTLS available? */
  44 #if defined HAVE_LIBSSL || defined HAVE_LIBGNUTLS
  45 # define HAVE_SSL
  46 #endif
  47
  48 /* `gettext (FOO)' is long to write, so we use `_(FOO)'.  If NLS is
  49    unavailable, _(STRING) simply returns STRING.  */
  50 #ifdef HAVE_NLS
  51 # define _(string) gettext (string)
  52 # ifdef HAVE_LIBINTL_H
  53 #  include <libintl.h>
  54 # else  /* not HAVE_LIBINTL_H */
  55    const char *gettext ();
  56 # endif /* not HAVE_LIBINTL_H */
  57 #else  /* not HAVE_NLS */
  58 # define _(string) (string)
  59 #endif /* not HAVE_NLS */
  60
  61 /* A pseudo function call that serves as a marker for the automated
  62    extraction of messages, but does not call gettext().  The run-time
  63    translation is done at a different place in the code.  The purpose
  64    of the N_("...") call is to make the message snarfer aware that the
  65    "..." string needs to be translated.  STRING should be a string
  66    literal.  Concatenated strings and other string expressions won't
  67    work.  The macro's expansion is not parenthesized, so that it is
  68    suitable as initializer for static 'char[]' or 'const char[]'
  69    variables.  -- explanation partly taken from GNU make.  */
  70 #define N_(string) string
  71
  72 /* I18N NOTE: You will notice that none of the DEBUGP messages are
  73    marked as translatable.  This is intentional, for a few reasons:
  74
  75    1) The debug messages are not meant for the users to look at, but
  76    for the developers; as such, they should be considered more like
  77    source comments than real program output.
  78
  79    2) The messages are numerous, and yet they are random and frivolous
  80    ("double yuck!" and such).  There would be a lot of work with no
  81    gain.
  82
  83    3) Finally, the debug messages are meant to be a clue for me to
  84    debug problems with Wget.  If I get them in a language I don't
  85    understand, debugging will become a new challenge of its own!  */
  86
  87
  88 /* Include these, so random files need not include them.  */
  89 #include "sysdep.h"
  90 /* locale independent replacement for ctype.h */
  91 #include "safe-ctype.h"
  92
  93 /* Conditionalize the use of GCC's __attribute__((format)) and
  94    __builtin_expect features using macros.  */
  95
  96 #if defined(__GNUC__) && __GNUC__ >= 3
  97 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
  98 # define LIKELY(exp)   __builtin_expect (!!(exp), 1)
  99 # define UNLIKELY(exp) __builtin_expect ((exp), 0)
 100 #else
 101 # define GCC_FORMAT_ATTR(a, b)
 102 # define LIKELY(exp)   (exp)
 103 # define UNLIKELY(exp) (exp)
 104 #endif
 105
 106 /* Execute the following statement if debugging is both enabled at
 107    compile-time and requested at run-time; a no-op otherwise.  */
 108
 109 #ifdef ENABLE_DEBUG
 110 # define IF_DEBUG if (UNLIKELY (opt.debug))
 111 #else
 112 # define IF_DEBUG if (0)
 113 #endif
 114
 115 /* Print ARGS if debugging is enabled and requested, otherwise do
 116    nothing.  This must be called with an extra level of parentheses
 117    because it's not possible to pass a variable number of arguments to
 118    a macro (in portable C89).  ARGS are like arguments to printf.  */
 119
 120 #define DEBUGP(args) do { IF_DEBUG { debug_logprintf args; } } while (0)
 121
 122 /* Define an integer type that works for file sizes, content lengths,
 123    and such.  Normally we could just use off_t, but off_t is always
 124    32-bit on Windows.  */
 125
 126 #ifndef WINDOWS
 127 typedef off_t wgint;
 128 # define SIZEOF_WGINT SIZEOF_OFF_T
 129
 130 /* Pick the strtol-like function that will work with wgint.  */
 131 # if SIZEOF_WGINT == SIZEOF_LONG
 132 #  define str_to_wgint strtol
 133 #  define WGINT_MAX LONG_MAX
 134 # else
 135 #  define WGINT_MAX LLONG_MAX
 136 #  ifdef HAVE_STRTOLL
 137 #   define str_to_wgint strtoll
 138 #  elif defined HAVE_STRTOIMAX  /* HPUX 11.0 has strtoimax, but no strtoll */
 139 #   define str_to_wgint strtoimax
 140 #  else
 141 #   define str_to_wgint strtoll
 142 #   define NEED_STRTOLL
 143 #   define strtoll_type long long
 144 #  endif
 145 # endif
 146 #endif  /* not WINDOWS */
 147
 148 /* Declare our strtoll replacement. */
 149 #ifdef NEED_STRTOLL
 150 strtoll_type strtoll (const char *, char **, int);
 151 #endif
 152
 153 /* Now define a large numeric type useful for storing sizes of *sums*
 154    of downloads, such as the value of the --quota option.  This should
 155    be a type able to hold 2G+ values even on systems without large
 156    file support.  (It is useful to limit Wget's download quota to say
 157    10G even if a single file cannot be that large.)
 158
 159    To make sure we get the largest size possible, we use `double' on
 160    systems without a 64-bit integral type.  (Since it is used in very
 161    few places in Wget, this is acceptable.)  */
 162
 163 #if SIZEOF_WGINT >= 8
 164 /* just use wgint */
 165 typedef wgint SUM_SIZE_INT;
 166 #else
 167 /* On systems without LFS, use double, which buys us integers up to 2^53. */
 168 typedef double SUM_SIZE_INT;
 169 #endif
 170
 171 #include "options.h"
 172
 173 /* Everything uses this, so include them here directly.  */
 174 #include "xmalloc.h"
 175
 176 /* Likewise for logging functions.  */
 177 #include "log.h"
 178 \f
 179 /* Useful macros used across the code: */
 180
 181 /* The number of elements in an array.  For example:
 182    static char a[] = "foo";     -- countof(a) == 4 (note terminating \0)
 183    int a[5] = {1, 2};           -- countof(a) == 5
 184    char *a[] = {                -- countof(a) == 3
 185      "foo", "bar", "baz"
 186    }; */
 187 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
 188
 189 /* Zero out a value.  */
 190 #define xzero(x) memset (&(x), '\0', sizeof (x))
 191
 192 /* Convert an ASCII hex digit to the corresponding number between 0
 193    and 15.  H should be a hexadecimal digit that satisfies isxdigit;
 194    otherwise, the result is undefined.  */
 195 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
 196 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
 197
 198 /* The reverse of the above: convert a number in the [0, 16) range to
 199    the ASCII representation of the corresponding hexadecimal digit.
 200    `+ 0' is there so you can't accidentally use it as an lvalue.  */
 201 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
 202 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
 203
 204 /* Copy the data delimited with BEG and END to alloca-allocated
 205    storage, and zero-terminate it.  Arguments are evaluated only once,
 206    in the order BEG, END, PLACE.  */
 207 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
 208   const char *BTA_beg = (beg);                  \
 209   int BTA_len = (end) - BTA_beg;                \
 210   char **BTA_dest = &(place);                   \
 211   *BTA_dest = alloca (BTA_len + 1);             \
 212   memcpy (*BTA_dest, BTA_beg, BTA_len);         \
 213   (*BTA_dest)[BTA_len] = '\0';                  \
 214 } while (0)
 215
 216 /* Return non-zero if string bounded between BEG and END is equal to
 217    STRING_LITERAL.  The comparison is case-sensitive.  */
 218 #define BOUNDED_EQUAL(beg, end, string_literal)                         \
 219   ((end) - (beg) == sizeof (string_literal) - 1                         \
 220    && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
 221
 222 /* The same as above, except the comparison is case-insensitive. */
 223 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal)                 \
 224   ((end) - (beg) == sizeof (string_literal) - 1                         \
 225    && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
 226
 227 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
 228    This cannot be an expression because this is not portable:
 229      #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
 230    The problem is that some compilers can't handle alloca() being an
 231    argument to a function.  */
 232
 233 #define STRDUP_ALLOCA(ptr, str) do {                    \
 234   char **SA_dest = &(ptr);                              \
 235   const char *SA_src = (str);                           \
 236   *SA_dest = (char *)alloca (strlen (SA_src) + 1);      \
 237   strcpy (*SA_dest, SA_src);                            \
 238 } while (0)
 239
 240 /* Generally useful if you want to avoid arbitrary size limits but
 241    don't need a full dynamic array.  Assumes that BASEVAR points to a
 242    malloced array of TYPE objects (or possibly a NULL pointer, if
 243    SIZEVAR is 0), with the total size stored in SIZEVAR.  This macro
 244    will realloc BASEVAR as necessary so that it can hold at least
 245    NEEDED_SIZE objects.  The reallocing is done by doubling, which
 246    ensures constant amortized time per element.  */
 247
 248 #define DO_REALLOC(basevar, sizevar, needed_size, type) do {            \
 249   long DR_needed_size = (needed_size);                                  \
 250   long DR_newsize = 0;                                                  \
 251   while ((sizevar) < (DR_needed_size)) {                                \
 252     DR_newsize = sizevar << 1;                                          \
 253     if (DR_newsize < 16)                                                \
 254       DR_newsize = 16;                                                  \
 255     (sizevar) = DR_newsize;                                             \
 256   }                                                                     \
 257   if (DR_newsize)                                                       \
 258     basevar = xrealloc (basevar, DR_newsize * sizeof (type));           \
 259 } while (0)
 260
 261 /* Used to print pointers (usually for debugging).  Print pointers
 262    using printf ("0x%0*lx", PTR_FORMAT (p)).  (%p is too unpredictable;
 263    some implementations prepend 0x, while some don't, and most don't
 264    0-pad the address.)  */
 265 #define PTR_FORMAT(p) (int) (2 * sizeof (void *)), (unsigned long) (p)
 266
 267 extern const char *exec_name;
 268 \f
 269 /* Document type ("dt") flags */
 270 enum
 271 {
 272   TEXTHTML             = 0x0001,        /* document is of type text/html
 273                                            or application/xhtml+xml */
 274   RETROKF              = 0x0002,        /* retrieval was OK */
 275   HEAD_ONLY            = 0x0004,        /* only send the HEAD request */
 276   SEND_NOCACHE         = 0x0008,        /* send Pragma: no-cache directive */
 277   ACCEPTRANGES         = 0x0010,        /* Accept-ranges header was found */
 278   ADDED_HTML_EXTENSION = 0x0020         /* added ".html" extension due to -E */
 279 };
 280
 281 /* Universal error type -- used almost everywhere.  Error reporting of
 282    this detail is not generally used or needed and should be
 283    simplified.  */
 284 typedef enum
 285 {
 286   /*  0  */
 287   NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
 288   CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR, CONCLOSED,
 289   /* 10  */
 290   FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR,
 291   FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR, FTPREXC,
 292   /* 20  */
 293   FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR, FOPENERR,
 294   FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF,
 295   /* 30  */
 296   HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
 297   FTPINVPASV, FTPNOPASV, CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED,
 298   /* 40  */
 299   READERR, TRYLIMEXC, URLBADPATTERN, FILEBADFILE, RANGEERR,
 300   RETRBADPATTERN, RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR,
 301   /* 50  */
 302   AUTHFAILED, QUOTEXC, WRITEFAILED, SSLINITFAILED
 303 } uerr_t;
 304
 305 #endif /* WGET_H */