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 Wget.
   5
   6 This program 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 This program 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 this program; if not, write to the Free Software
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 /* This file contains some declarations that don't fit anywhere else.
  21    It also contains some useful includes, like the obnoxious TIME_H
  22    inclusion.  */
  23
  24 #ifndef WGET_H
  25 #define WGET_H
  26
  27 #ifndef DEBUG
  28 # define NDEBUG /* To kill off assertions */
  29 #endif /* not DEBUG */
  30
  31 #ifndef PARAMS
  32 # if PROTOTYPES
  33 #  define PARAMS(args) args
  34 # else
  35 #  define PARAMS(args) ()
  36 # endif
  37 #endif
  38
  39 /* `gettext (FOO)' is long to write, so we use `_(FOO)'.  If NLS is
  40    unavailable, _(STRING) simply returns STRING.  */
  41 #ifdef HAVE_NLS
  42 # define _(string) gettext (string)
  43 # ifdef HAVE_LIBINTL_H
  44 #  include <libintl.h>
  45 # endif /* HAVE_LIBINTL_H */
  46 #else  /* not HAVE_NLS */
  47 # define _(string) string
  48 #endif /* not HAVE_NLS */
  49
  50 /* I18N NOTE: You will notice that none of the DEBUG messages are
  51    marked as translatable.  This is intentional, for a few reasons:
  52
  53    1) The debug messages are not meant for the users to look at, but
  54    for the developers; as such, they should be considered more like
  55    source comments than real program output.
  56
  57    2) The messages are numerous, and yet they are random and frivolous
  58    ("double yuck!" and such).  There would be a lot of work with no
  59    gain.
  60
  61    3) Finally, the debug messages are meant to be a clue for me to
  62    debug problems with Wget.  If I get them in a language I don't
  63    understand, debugging will become a new challenge of its own!  :-) */
  64
  65
  66 /* Include these, so random files need not include them.  */
  67 #include "sysdep.h"
  68 #include "options.h"
  69
  70 #define DO_NOTHING do {} while (0)
  71
  72 /* Print X if debugging is enabled; a no-op otherwise.  */
  73 #ifdef DEBUG
  74 # define DEBUGP(x) do { if (opt.debug) { debug_logprintf x; } } while (0)
  75 #else  /* not DEBUG */
  76 # define DEBUGP(x) DO_NOTHING
  77 #endif /* not DEBUG */
  78
  79 /* Make gcc check for the format of logmsg() and debug_logmsg().  */
  80 #ifdef __GNUC__
  81 # define GCC_FORMAT_ATTR(a, b) __attribute__ ((format (printf, a, b)))
  82 #else  /* not __GNUC__ */
  83 # define GCC_FORMAT_ATTR(a, b)
  84 #endif /* not __GNUC__ */
  85
  86 /* These are from log.c, but they are used everywhere, so we declare
  87    them here.  */
  88 enum log_options { LOG_VERBOSE, LOG_NOTQUIET, LOG_NONVERBOSE, LOG_ALWAYS };
  89
  90 #ifdef HAVE_STDARG_H
  91 void logprintf PARAMS ((enum log_options, const char *, ...))
  92      GCC_FORMAT_ATTR (2, 3);
  93 void debug_logprintf PARAMS ((const char *, ...)) GCC_FORMAT_ATTR (1, 2);
  94 #else  /* not HAVE_STDARG_H */
  95 void logprintf ();
  96 void debug_logprintf ();
  97 #endif /* not HAVE_STDARG_H */
  98 void logputs PARAMS ((enum log_options, const char *));
  99
 100 /* Defined in `utils.c', but used literally everywhere.  */
 101 #ifndef DEBUG_MALLOC
 102
 103 #define xmalloc  xmalloc_real
 104 #define xrealloc xrealloc_real
 105 #define xstrdup  xstrdup_real
 106 #define xfree    free
 107
 108 void *xmalloc_real PARAMS ((size_t));
 109 void *xrealloc_real PARAMS ((void *, size_t));
 110 char *xstrdup_real PARAMS ((const char *));
 111
 112 #else  /* DEBUG_MALLOC */
 113
 114 #define xmalloc(s)     xmalloc_debug (s, __FILE__, __LINE__)
 115 #define xfree(p)       xfree_debug (p, __FILE__, __LINE__)
 116 #define xrealloc(p, s) xrealloc_debug (p, s, __FILE__, __LINE__)
 117 #define xstrdup(p)     xstrdup_debug (p, __FILE__, __LINE__)
 118
 119 void *xmalloc_debug PARAMS ((size_t, const char *, int));
 120 void xfree_debug PARAMS ((void *, const char *, int));
 121 void *xrealloc_debug PARAMS ((void *, size_t, const char *, int));
 122 char *xstrdup_debug PARAMS ((const char *, const char *, int));
 123
 124 #endif /* DEBUG_MALLOC */
 125
 126 /* #### Find a better place for this.  */
 127 /* The log file to which Wget writes to after HUP.  */
 128 #define DEFAULT_LOGFILE "wget-log"
 129
 130 #define MD5_HASHLEN 16
 131 \f
 132 /* Useful macros used across the code: */
 133
 134 /* Is the string a hpyhen-only?  */
 135 #define HYPHENP(x) (*(x) == '-' && !*((x) + 1))
 136
 137 /* The smaller value of the two.  */
 138 #define MINVAL(x, y) ((x) < (y) ? (x) : (y))
 139
 140 /* ASCII char -> HEX digit */
 141 #define ASC2HEXD(x) (((x) >= '0' && (x) <= '9') ?               \
 142                      ((x) - '0') : (TOUPPER(x) - 'A' + 10))
 143
 144 /* HEX digit -> ASCII char */
 145 #define HEXD2ASC(x) (((x) < 10) ? ((x) + '0') : ((x) - 10 + 'A'))
 146
 147 #define ARRAY_SIZE(array) (sizeof (array) / sizeof (*(array)))
 148
 149 /* Note that this much more elegant definition cannot be used:
 150
 151    #define STRDUP_ALLOCA(str) (strcpy ((char *)alloca (strlen (str) + 1), str))
 152
 153    This is because some compilers don't handle alloca() as argument to
 154    function correctly.  Gcc under Intel has been reported to offend in
 155    this case.  */
 156
 157 #define STRDUP_ALLOCA(ptr, str) do {            \
 158   (ptr) = (char *)alloca (strlen (str) + 1);    \
 159   strcpy (ptr, str);                            \
 160 } while (0)
 161
 162 #define ALLOCA_ARRAY(type, len) ((type *) alloca ((len) * sizeof (type)))
 163
 164 #define XREALLOC_ARRAY(ptr, type, len)                                  \
 165      ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
 166
 167 /* Generally useful if you want to avoid arbitrary size limits but
 168    don't need a full dynamic array.  Assumes that BASEVAR points to a
 169    malloced array of TYPE objects (or possibly a NULL pointer, if
 170    SIZEVAR is 0), with the total size stored in SIZEVAR.  This macro
 171    will realloc BASEVAR as necessary so that it can hold at least
 172    NEEDED_SIZE objects.  The reallocing is done by doubling, which
 173    ensures constant amortized time per element.  */
 174 #define DO_REALLOC(basevar, sizevar, needed_size, type) do      \
 175 {                                                               \
 176   /* Avoid side-effectualness.  */                              \
 177   long do_realloc_needed_size = (needed_size);                  \
 178   long do_realloc_newsize = 0;                                  \
 179   while ((sizevar) < (do_realloc_needed_size)) {                \
 180     do_realloc_newsize = 2*(sizevar);                           \
 181     if (do_realloc_newsize < 32)                                \
 182       do_realloc_newsize = 32;                                  \
 183     (sizevar) = do_realloc_newsize;                             \
 184   }                                                             \
 185   if (do_realloc_newsize)                                       \
 186     XREALLOC_ARRAY (basevar, type, do_realloc_newsize);         \
 187 } while (0)
 188
 189 /* Use this for small stack-allocated memory chunks that might grow.
 190    The initial array is created using alloca(), and this macro
 191    requests it to grow.  If the needed size is larger than the array,
 192    this macro will use malloc to allocate it to new size, and copy the
 193    old contents.  After that, successive invocations behave just like
 194    DO_REALLOC.  */
 195 #define DO_REALLOC_FROM_ALLOCA(basevar, sizevar, needed_size, allocap, type) do \
 196 {                                                                               \
 197   /* Avoid side-effectualness.  */                                              \
 198   long do_realloc_needed_size = (needed_size);                                  \
 199   long do_realloc_newsize = 0;                                                  \
 200   while ((sizevar) < (do_realloc_needed_size)) {                                \
 201     do_realloc_newsize = 2*(sizevar);                                           \
 202     if (do_realloc_newsize < 16)                                                \
 203       do_realloc_newsize = 16;                                                  \
 204     (sizevar) = do_realloc_newsize;                                             \
 205   }                                                                             \
 206   if (do_realloc_newsize)                                                       \
 207     {                                                                           \
 208       if (!allocap)                                                             \
 209         XREALLOC_ARRAY (basevar, type, do_realloc_newsize);                     \
 210       else                                                                      \
 211         {                                                                       \
 212           void *drfa_new_basevar = xmalloc (do_realloc_newsize);                \
 213           memcpy (drfa_new_basevar, basevar, sizevar);                          \
 214           (basevar) = drfa_new_basevar;                                         \
 215           allocap = 0;                                                          \
 216         }                                                                       \
 217     }                                                                           \
 218 } while (0)
 219
 220 /* Free FOO if it is non-NULL.  */
 221 #define FREE_MAYBE(foo) do { if (foo) xfree (foo); } while (0)
 222
 223 /* #### Hack: OPTIONS_DEFINED_HERE is defined in main.c.  */
 224 /* [Is this weird hack really necessary on any compilers?  No ANSI C compiler
 225     should complain about "extern const char *exec_name;" followed by
 226     "const char *exec_name;".  Are we doing this for K&R compilers, or...??
 227     -- Dan Harkless <wget@harkless.org>] */
 228 #ifndef OPTIONS_DEFINED_HERE
 229 extern const char *exec_name;
 230 #endif
 231
 232 \f
 233 /* Document type ("dt") flags */
 234 enum
 235 {
 236   TEXTHTML             = 0x0001,        /* document is of type text/html */
 237   RETROKF              = 0x0002,        /* retrieval was OK */
 238   HEAD_ONLY            = 0x0004,        /* only send the HEAD request */
 239   SEND_NOCACHE         = 0x0008,        /* send Pragma: no-cache directive */
 240   ACCEPTRANGES         = 0x0010,        /* Accept-ranges header was found */
 241   ADDED_HTML_EXTENSION = 0x0020         /* added ".html" extension due to -E */
 242 };
 243
 244 /* Universal error type -- used almost everywhere.
 245    This is, of course, utter crock.  */
 246 typedef enum
 247 {
 248   NOCONERROR, HOSTERR, CONSOCKERR, CONERROR, CONSSLERR,
 249   CONREFUSED, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
 250   BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK,
 251   CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR,
 252   FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
 253   FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL, URLHTTPS,
 254   URLOK, URLHTTP, URLFTP, URLFILE, URLUNKNOWN, URLBADPORT,
 255   URLBADHOST, FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
 256   HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
 257   FTPINVPASV, FTPNOPASV,
 258   RETRFINISHED, READERR, TRYLIMEXC, URLBADPATTERN,
 259   FILEBADFILE, RANGEERR, RETRBADPATTERN, RETNOTSUP,
 260   ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED, QUOTEXC, WRITEFAILED,
 261   SSLERRCERTFILE,SSLERRCERTKEY,SSLERRCTXCREATE
 262 } uerr_t;
 263
 264 typedef unsigned char  boolean;
 265 #ifndef FALSE
 266 #define FALSE 0
 267 #endif
 268 #ifndef TRUE
 269 #define TRUE  1
 270 #endif
 271
 272 /* So we can say strcmp(a, b) == EQ rather than strcmp(a, b) == 0 or
 273    the really awful !strcmp(a, b). */
 274 #define EQ 0
 275
 276 /* For most options, 0 means no limits, but with -p in the picture, that causes
 277    a problem on the maximum recursion depth variable.  To retain backwards
 278    compatibility we allow users to consider "0" to be synonymous with "inf" for
 279    -l, but internally infinite recursion is specified by -1 and 0 means to only
 280    retrieve the requisites of a single document. */
 281 #define INFINITE_RECURSION -1
 282
 283 #endif /* WGET_H */