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