sjero.net Git - wget/blob - src/wget.h

   1 /* Miscellaneous declarations.
   2    Copyright (C) 1995, 1996, 1997, 1998 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 some declarations that don't fit anywhere else.
  31    It also contains some useful includes, like the obnoxious TIME_H
  32    inclusion.  */
  33
  34 #ifndef WGET_H
  35 #define WGET_H
  36
  37 #ifndef DEBUG
  38 # define NDEBUG /* To kill off assertions */
  39 #endif /* not DEBUG */
  40
  41 /* Define this if you want primitive but extensive malloc debugging.
  42    It will make Wget extremely slow, so only do it in development
  43    builds.  */
  44 #undef DEBUG_MALLOC
  45
  46 #ifndef PARAMS
  47 # if PROTOTYPES
  48 #  define PARAMS(args) args
  49 # else
  50 #  define PARAMS(args) ()
  51 # endif
  52 #endif
  53
  54 /* `gettext (FOO)' is long to write, so we use `_(FOO)'.  If NLS is
  55    unavailable, _(STRING) simply returns STRING.  */
  56 #ifdef HAVE_NLS
  57 # define _(string) gettext (string)
  58 # ifdef HAVE_LIBINTL_H
  59 #  include <libintl.h>
  60 # endif /* HAVE_LIBINTL_H */
  61 #else  /* not HAVE_NLS */
  62 # define _(string) string
  63 #endif /* not HAVE_NLS */
  64
  65 /* I18N NOTE: You will notice that none of the DEBUG messages are
  66    marked as translatable.  This is intentional, for a few reasons:
  67
  68    1) The debug messages are not meant for the users to look at, but
  69    for the developers; as such, they should be considered more like
  70    source comments than real program output.
  71
  72    2) The messages are numerous, and yet they are random and frivolous
  73    ("double yuck!" and such).  There would be a lot of work with no
  74    gain.
  75
  76    3) Finally, the debug messages are meant to be a clue for me to
  77    debug problems with Wget.  If I get them in a language I don't
  78    understand, debugging will become a new challenge of its own!  */
  79
  80
  81 /* Include these, so random files need not include them.  */
  82 #include "sysdep.h"
  83 #include "options.h"
  84 /* locale independent replacement for ctype.h */
  85 #include "safe-ctype.h"
  86
  87 #define DO_NOTHING do {} while (0)
  88
  89 /* Print X if debugging is enabled; a no-op otherwise.  */
  90 #ifdef DEBUG
  91 # define DEBUGP(x) do { if (opt.debug) { debug_logprintf x; } } while (0)
  92 #else  /* not DEBUG */
  93 # define DEBUGP(x) DO_NOTHING
  94 #endif /* not DEBUG */
  95
  96 /* Make gcc check for the format of logmsg() and debug_logmsg().  */
  97 #ifdef __GNUC__
  98 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
  99 #else  /* not __GNUC__ */
 100 # define GCC_FORMAT_ATTR(a, b)
 101 #endif /* not __GNUC__ */
 102
 103 /* These are from log.c, but they are used everywhere, so we declare
 104    them here.  */
 105 enum log_options { LOG_VERBOSE, LOG_NOTQUIET, LOG_NONVERBOSE, LOG_ALWAYS };
 106
 107 #ifdef HAVE_STDARG_H
 108 void logprintf PARAMS ((enum log_options, const char *, ...))
 109      GCC_FORMAT_ATTR (2, 3);
 110 void debug_logprintf PARAMS ((const char *, ...)) GCC_FORMAT_ATTR (1, 2);
 111 #else  /* not HAVE_STDARG_H */
 112 void logprintf ();
 113 void debug_logprintf ();
 114 #endif /* not HAVE_STDARG_H */
 115 void logputs PARAMS ((enum log_options, const char *));
 116 void logflush PARAMS ((void));
 117 void log_set_flush PARAMS ((int));
 118 int log_set_save_context PARAMS ((int));
 119
 120 /* Defined in `utils.c', but used literally everywhere.  */
 121 #ifndef DEBUG_MALLOC
 122
 123 #define xmalloc  xmalloc_real
 124 #define xrealloc xrealloc_real
 125 #define xstrdup  xstrdup_real
 126 #define xfree    free
 127
 128 void *xmalloc_real PARAMS ((size_t));
 129 void *xrealloc_real PARAMS ((void *, size_t));
 130 char *xstrdup_real PARAMS ((const char *));
 131
 132 #else  /* DEBUG_MALLOC */
 133
 134 #define xmalloc(s)     xmalloc_debug (s, __FILE__, __LINE__)
 135 #define xfree(p)       xfree_debug (p, __FILE__, __LINE__)
 136 #define xrealloc(p, s) xrealloc_debug (p, s, __FILE__, __LINE__)
 137 #define xstrdup(p)     xstrdup_debug (p, __FILE__, __LINE__)
 138
 139 void *xmalloc_debug PARAMS ((size_t, const char *, int));
 140 void xfree_debug PARAMS ((void *, const char *, int));
 141 void *xrealloc_debug PARAMS ((void *, size_t, const char *, int));
 142 char *xstrdup_debug PARAMS ((const char *, const char *, int));
 143
 144 #endif /* DEBUG_MALLOC */
 145
 146 /* #### Find a better place for this.  */
 147 /* The log file to which Wget writes to after HUP.  */
 148 #define DEFAULT_LOGFILE "wget-log"
 149
 150 #define MD5_HASHLEN 16
 151 \f
 152 /* Useful macros used across the code: */
 153
 154 /* Is the string a hpyhen-only?  */
 155 #define HYPHENP(x) (*(x) == '-' && !*((x) + 1))
 156
 157 /* The smaller value of the two.  */
 158 #define MINVAL(x, y) ((x) < (y) ? (x) : (y))
 159
 160 /* Convert the ASCII character that represents a hexadecimal digit to
 161    the number in range [0, 16) that corresponds to the digit.  X
 162    should be between '0' and '9', or between 'A' and 'F', or between
 163    'a' and 'f'.  If X is not a hexadecimal digit character, the result
 164    is undefined.  */
 165 #define XCHAR_TO_XDIGIT(x)                                              \
 166   (((x) >= '0' && (x) <= '9') ? ((x) - '0') : (TOUPPER(x) - 'A' + 10))
 167
 168 /* The reverse of the above: convert a digit number in the [0, 16)
 169    range to an ASCII character.  The A-F characters are in upper
 170    case.  */
 171 #define XDIGIT_TO_XCHAR(x) ("0123456789ABCDEF"[x])
 172
 173 /* Like XDIGIT_TO_XCHAR, but generates lower-case characters. */
 174 #define XDIGIT_TO_xchar(x) ("0123456789abcdef"[x])
 175
 176 /* Returns the number of elements in an array with fixed
 177    initialization.  For example:
 178
 179    static char a[] = "foo";     -- countof(a) == 4 (for terminating \0)
 180
 181    int a[5] = {1, 2};           -- countof(a) == 5
 182
 183    char *a[3] = {               -- countof(a) == 3
 184      "foo", "bar", "baz"
 185    };
 186
 187    And, most importantly, it works when the compiler counts the array
 188    elements for you:
 189
 190    char *a[] = {                -- countof(a) == 4
 191      "foo", "bar", "baz", "qux"
 192    }  */
 193 #define countof(array) (sizeof (array) / sizeof (*(array)))
 194
 195 #define ARRAY_SIZE(array) countof (array)
 196
 197 /* Copy the data delimited with BEG and END to alloca-allocated
 198    storage, and zero-terminate it.  BEG and END are evaluated only
 199    once, in that order.  */
 200 #define BOUNDED_TO_ALLOCA(beg, end, place) do { \
 201   const char *DTA_beg = (beg);                  \
 202   int DTA_len = (end) - DTA_beg;                \
 203   place = alloca (DTA_len + 1);                 \
 204   memcpy (place, DTA_beg, DTA_len);             \
 205   place[DTA_len] = '\0';                        \
 206 } while (0)
 207
 208 /* Return non-zero if string bounded between BEG and END is equal to
 209    STRING_LITERAL.  The comparison is case-sensitive.  */
 210 #define BOUNDED_EQUAL(beg, end, string_literal) \
 211   ((end) - (beg) == sizeof (string_literal) - 1 \
 212    && !memcmp ((beg), (string_literal),         \
 213                sizeof (string_literal) - 1))
 214
 215 /* The same as above, except the comparison is case-insensitive. */
 216 #define BOUNDED_EQUAL_NO_CASE(beg, end, string_literal) \
 217   ((end) - (beg) == sizeof (string_literal) - 1         \
 218    && !strncasecmp ((beg), (string_literal),            \
 219                     sizeof (string_literal) - 1))
 220
 221 /* Note that this much more elegant definition cannot be used:
 222
 223    #define STRDUP_ALLOCA(str) (strcpy ((char *)alloca (strlen (str) + 1), str))
 224
 225    This is because some compilers don't handle alloca() as argument to
 226    function correctly.  Gcc under Intel has been reported to offend in
 227    this case.  */
 228
 229 #define STRDUP_ALLOCA(ptr, str) do {            \
 230   (ptr) = (char *)alloca (strlen (str) + 1);    \
 231   strcpy (ptr, str);                            \
 232 } while (0)
 233
 234 #define ALLOCA_ARRAY(type, len) ((type *) alloca ((len) * sizeof (type)))
 235
 236 #define XREALLOC_ARRAY(ptr, type, len)                                  \
 237      ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
 238
 239 /* Generally useful if you want to avoid arbitrary size limits but
 240    don't need a full dynamic array.  Assumes that BASEVAR points to a
 241    malloced array of TYPE objects (or possibly a NULL pointer, if
 242    SIZEVAR is 0), with the total size stored in SIZEVAR.  This macro
 243    will realloc BASEVAR as necessary so that it can hold at least
 244    NEEDED_SIZE objects.  The reallocing is done by doubling, which
 245    ensures constant amortized time per element.  */
 246 #define DO_REALLOC(basevar, sizevar, needed_size, type) do      \
 247 {                                                               \
 248   /* Avoid side-effectualness.  */                              \
 249   long do_realloc_needed_size = (needed_size);                  \
 250   long do_realloc_newsize = 0;                                  \
 251   while ((sizevar) < (do_realloc_needed_size)) {                \
 252     do_realloc_newsize = 2*(sizevar);                           \
 253     if (do_realloc_newsize < 32)                                \
 254       do_realloc_newsize = 32;                                  \
 255     (sizevar) = do_realloc_newsize;                             \
 256   }                                                             \
 257   if (do_realloc_newsize)                                       \
 258     XREALLOC_ARRAY (basevar, type, do_realloc_newsize);         \
 259 } while (0)
 260
 261 /* Use this for small stack-allocated memory chunks that might grow.
 262    The initial array is created using alloca(), and this macro
 263    requests it to grow.  If the needed size is larger than the array,
 264    this macro will use malloc to allocate it to new size, and copy the
 265    old contents.  After that, successive invocations behave just like
 266    DO_REALLOC.  */
 267 #define DO_REALLOC_FROM_ALLOCA(basevar, sizevar, needed_size, allocap, type) do \
 268 {                                                                               \
 269   /* Avoid side-effectualness.  */                                              \
 270   long do_realloc_needed_size = (needed_size);                                  \
 271   long do_realloc_newsize = (sizevar);                                          \
 272   while (do_realloc_newsize < do_realloc_needed_size) {                         \
 273     do_realloc_newsize <<= 1;                                                   \
 274     if (do_realloc_newsize < 16)                                                \
 275       do_realloc_newsize = 16;                                                  \
 276   }                                                                             \
 277   if (do_realloc_newsize != (sizevar))                                          \
 278     {                                                                           \
 279       if (!allocap)                                                             \
 280         XREALLOC_ARRAY (basevar, type, do_realloc_newsize);                     \
 281       else                                                                      \
 282         {                                                                       \
 283           void *drfa_new_basevar =                                              \
 284                 xmalloc (do_realloc_newsize * sizeof (type));                   \
 285           memcpy (drfa_new_basevar, basevar, (sizevar) * sizeof (type));        \
 286           (basevar) = drfa_new_basevar;                                         \
 287           allocap = 0;                                                          \
 288         }                                                                       \
 289       (sizevar) = do_realloc_newsize;                                           \
 290     }                                                                           \
 291 } while (0)
 292
 293 /* Free FOO if it is non-NULL.  */
 294 #define FREE_MAYBE(foo) do { if (foo) xfree (foo); } while (0)
 295
 296 extern const char *exec_name;
 297 \f
 298 /* Document type ("dt") flags */
 299 enum
 300 {
 301   TEXTHTML             = 0x0001,        /* document is of type text/html */
 302   RETROKF              = 0x0002,        /* retrieval was OK */
 303   HEAD_ONLY            = 0x0004,        /* only send the HEAD request */
 304   SEND_NOCACHE         = 0x0008,        /* send Pragma: no-cache directive */
 305   ACCEPTRANGES         = 0x0010,        /* Accept-ranges header was found */
 306   ADDED_HTML_EXTENSION = 0x0020         /* added ".html" extension due to -E */
 307 };
 308
 309 /* Universal error type -- used almost everywhere.
 310    This is, of course, utter crock.  */
 311 typedef enum
 312 {
 313   NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
 314   CONREFUSED, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
 315   BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK,
 316   CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR,
 317   FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
 318   FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLERROR,
 319   FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
 320   HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
 321   FTPINVPASV, FTPNOPASV,
 322   CONTNOTSUPPORTED, RETRUNNEEDED, RETRFINISHED, READERR, TRYLIMEXC,
 323   URLBADPATTERN, FILEBADFILE, RANGEERR, RETRBADPATTERN,
 324   RETNOTSUP, ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED,
 325   QUOTEXC, WRITEFAILED,
 326   SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE
 327 } uerr_t;
 328
 329 typedef unsigned char  boolean;
 330 #ifndef FALSE
 331 #define FALSE 0
 332 #endif
 333 #ifndef TRUE
 334 #define TRUE  1
 335 #endif
 336
 337 /* So we can say strcmp(a, b) == EQ rather than strcmp(a, b) == 0 or
 338    the really awful !strcmp(a, b). */
 339 #define EQ 0
 340
 341 /* For most options, 0 means no limits, but with -p in the picture, that causes
 342    a problem on the maximum recursion depth variable.  To retain backwards
 343    compatibility we allow users to consider "0" to be synonymous with "inf" for
 344    -l, but internally infinite recursion is specified by -1 and 0 means to only
 345    retrieve the requisites of a single document. */
 346 #define INFINITE_RECURSION -1
 347
 348 #define CONNECT_ERROR(x) ((x) == ECONNREFUSED && !opt.retry_connrefused \
 349                           ? CONREFUSED : CONERROR)
 350
 351 #endif /* WGET_H */