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