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