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