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 /* `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 /* Print X if debugging is enabled; a no-op otherwise.  */
 102
 103 #ifdef ENABLE_DEBUG
 104 # define DEBUGP(x) do if (UNLIKELY (opt.debug)) {debug_logprintf x;} while (0)
 105 #else  /* not ENABLE_DEBUG */
 106 # define DEBUGP(x) do {} while (0)
 107 #endif /* not ENABLE_DEBUG */
 108
 109 /* Define an integer type that works for file sizes, content lengths,
 110    and such.  Normally we could just use off_t, but off_t is always
 111    32-bit on Windows.  */
 112
 113 #ifndef WINDOWS
 114 typedef off_t wgint;
 115 # define SIZEOF_WGINT SIZEOF_OFF_T
 116 #endif
 117
 118 /* Define a strtol/strtoll clone that works with wgint.  */
 119 #ifndef str_to_wgint            /* mswindows.h defines its own alias */
 120 # if SIZEOF_WGINT == SIZEOF_LONG
 121 #  define str_to_wgint strtol
 122 #  define WGINT_MAX LONG_MAX
 123 # else
 124 #  define str_to_wgint strtoll
 125 #  define WGINT_MAX LLONG_MAX
 126 # endif
 127 #endif
 128
 129 #include "options.h"
 130
 131 /* Everything uses this, so include them here directly.  */
 132 #include "xmalloc.h"
 133
 134 /* Likewise for logging functions.  */
 135 #include "log.h"
 136 \f
 137 /* Useful macros used across the code: */
 138
 139 /* The number of elements in an array.  For example:
 140    static char a[] = "foo";     -- countof(a) == 4 (note terminating \0)
 141    int a[5] = {1, 2};           -- countof(a) == 5
 142    char *a[] = {                -- countof(a) == 3
 143      "foo", "bar", "baz"
 144    }; */
 145 #define countof(array) (sizeof (array) / sizeof ((array)[0]))
 146
 147 /* Zero out a value.  */
 148 #define xzero(x) memset (&(x), '\0', sizeof (x))
 149
 150 /* Convert an ASCII hex digit to the corresponding number between 0
 151    and 15.  H should be a hexadecimal digit that satisfies isxdigit;
 152    otherwise, the result is undefined.  */
 153 #define XDIGIT_TO_NUM(h) ((h) < 'A' ? (h) - '0' : TOUPPER (h) - 'A' + 10)
 154 #define X2DIGITS_TO_NUM(h1, h2) ((XDIGIT_TO_NUM (h1) << 4) + XDIGIT_TO_NUM (h2))
 155
 156 /* The reverse of the above: convert a number in the [0, 16) range to
 157    the ASCII representation of the corresponding hexadecimal digit.
 158    `+ 0' is there so you can't accidentally use it as an lvalue.  */
 159 #define XNUM_TO_DIGIT(x) ("0123456789ABCDEF"[x] + 0)
 160 #define XNUM_TO_digit(x) ("0123456789abcdef"[x] + 0)
 161
 162 /* Copy the data delimited with BEG and END to alloca-allocated
 163    storage, and zero-terminate it.  Arguments are evaluated only once,
 164    in the order BEG, END, PLACE.  */
 165 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
 166   const char *BTA_beg = (beg);                  \
 167   int BTA_len = (end) - BTA_beg;                \
 168   char **BTA_dest = &(place);                   \
 169   *BTA_dest = alloca (BTA_len + 1);             \
 170   memcpy (*BTA_dest, BTA_beg, BTA_len);         \
 171   (*BTA_dest)[BTA_len] = '\0';                  \
 172 } while (0)
 173
 174 /* Return non-zero if string bounded between BEG and END is equal to
 175    STRING_LITERAL.  The comparison is case-sensitive.  */
 176 #define BOUNDED_EQUAL(beg, end, string_literal)                         \
 177   ((end) - (beg) == sizeof (string_literal) - 1                         \
 178    && !memcmp (beg, string_literal, sizeof (string_literal) - 1))
 179
 180 /* The same as above, except the comparison is case-insensitive. */
 181 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal)                 \
 182   ((end) - (beg) == sizeof (string_literal) - 1                         \
 183    && !strncasecmp (beg, string_literal, sizeof (string_literal) - 1))
 184
 185 /* Like ptr=strdup(str), but allocates the space for PTR on the stack.
 186    This cannot be an expression because this is not portable:
 187      #define STRDUP_ALLOCA(str) (strcpy (alloca (strlen (str) + 1), str))
 188    The problem is that some compilers can't handle alloca() being an
 189    argument to a function.  */
 190
 191 #define STRDUP_ALLOCA(ptr, str) do {                    \
 192   char **SA_dest = &(ptr);                              \
 193   const char *SA_src = (str);                           \
 194   *SA_dest = (char *)alloca (strlen (SA_src) + 1);      \
 195   strcpy (*SA_dest, SA_src);                            \
 196 } while (0)
 197
 198 /* Generally useful if you want to avoid arbitrary size limits but
 199    don't need a full dynamic array.  Assumes that BASEVAR points to a
 200    malloced array of TYPE objects (or possibly a NULL pointer, if
 201    SIZEVAR is 0), with the total size stored in SIZEVAR.  This macro
 202    will realloc BASEVAR as necessary so that it can hold at least
 203    NEEDED_SIZE objects.  The reallocing is done by doubling, which
 204    ensures constant amortized time per element.  */
 205
 206 #define DO_REALLOC(basevar, sizevar, needed_size, type) do {            \
 207   long DR_needed_size = (needed_size);                                  \
 208   long DR_newsize = 0;                                                  \
 209   while ((sizevar) < (DR_needed_size)) {                                \
 210     DR_newsize = sizevar << 1;                                          \
 211     if (DR_newsize < 16)                                                \
 212       DR_newsize = 16;                                                  \
 213     (sizevar) = DR_newsize;                                             \
 214   }                                                                     \
 215   if (DR_newsize)                                                       \
 216     basevar = xrealloc (basevar, DR_newsize * sizeof (type));           \
 217 } while (0)
 218
 219 /* Used to print pointers (usually for debugging).  Print pointers
 220    using printf ("%0*lx", PTR_FORMAT (p)).  (%p is too unpredictable;
 221    some implementations prepend 0x, while some don't, and most don't
 222    0-pad the address.)  */
 223 #define PTR_FORMAT(p) 2 * sizeof (void *), (unsigned long) (p)
 224
 225 extern const char *exec_name;
 226 \f
 227 /* Document type ("dt") flags */
 228 enum
 229 {
 230   TEXTHTML             = 0x0001,        /* document is of type text/html
 231                                            or application/xhtml+xml */
 232   RETROKF              = 0x0002,        /* retrieval was OK */
 233   HEAD_ONLY            = 0x0004,        /* only send the HEAD request */
 234   SEND_NOCACHE         = 0x0008,        /* send Pragma: no-cache directive */
 235   ACCEPTRANGES         = 0x0010,        /* Accept-ranges header was found */
 236   ADDED_HTML_EXTENSION = 0x0020         /* added ".html" extension due to -E */
 237 };
 238
 239 /* Universal error type -- used almost everywhere.  Error reporting of
 240    this detail is not generally used or needed and should be
 241    simplified.  */
 242 typedef enum
 243 {
 244   NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
 245   CONIMPOSSIBLE, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
 246   CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR, FTPSYSERR,
 247   FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
 248   FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
 249   FOPENERR, FOPEN_EXCL_ERR, FWRITEERR, HOK, HLEXC, HEOF,
 250   HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
 251   FTPINVPASV, FTPNOPASV,
 252   CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
 253   URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
 254   RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
 255   QUOTEXC, WRITEFAILED, SSLINITFAILED
 256 } uerr_t;
 257
 258 #endif /* WGET_H */