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 { 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 void logprintf PARAMS ((enum log_options, const char *, ...))
  91      GCC_FORMAT_ATTR (2, 3);
  92 void debug_logprintf PARAMS ((const char *, ...)) GCC_FORMAT_ATTR (1, 2);
  93 void logputs PARAMS ((enum log_options, const char *));
  94
  95 /* Defined in `utils.c', but used literally everywhere.  */
  96 void *xmalloc PARAMS ((size_t));
  97 void *xrealloc PARAMS ((void *, size_t));
  98 char *xstrdup PARAMS ((const char *));
  99
 100 /* #### Find a better place for this.  */
 101 /* The log file to which Wget writes to after HUP.  */
 102 #define DEFAULT_LOGFILE "wget-log"
 103
 104 #define MD5_HASHLEN 16
 105 \f
 106 /* Useful macros used across the code: */
 107
 108 /* Is the string a hpyhen-only?  */
 109 #define HYPHENP(x) (*(x) == '-' && !*((x) + 1))
 110
 111 /* The smaller value of the two.  */
 112 #define MINVAL(x, y) ((x) < (y) ? (x) : (y))
 113
 114 /* ASCII char -> HEX digit */
 115 #define ASC2HEXD(x) (((x) >= '0' && (x) <= '9') ?               \
 116                      ((x) - '0') : (TOUPPER(x) - 'A' + 10))
 117
 118 /* HEX digit -> ASCII char */
 119 #define HEXD2ASC(x) (((x) < 10) ? ((x) + '0') : ((x) - 10 + 'A'))
 120
 121 #define ARRAY_SIZE(array) (sizeof (array) / sizeof (*(array)))
 122
 123 /* Note that this much more elegant definition cannot be used:
 124
 125    #define STRDUP_ALLOCA(str) (strcpy ((char *)alloca (strlen (str) + 1), str))
 126
 127    This is because some compilers don't handle alloca() as argument to
 128    function correctly.  Gcc under Intel has been reported to offend in
 129    this case.  */
 130
 131 #define STRDUP_ALLOCA(ptr, str) do {            \
 132   (ptr) = (char *)alloca (strlen (str) + 1);    \
 133   strcpy (ptr, str);                            \
 134 } while (0)
 135
 136 #define ALLOCA_ARRAY(type, len) ((type *) alloca ((len) * sizeof (type)))
 137
 138 #define XREALLOC_ARRAY(ptr, type, len)                                  \
 139      ((void) (ptr = (type *) xrealloc (ptr, (len) * sizeof (type))))
 140
 141 /* Generally useful if you want to avoid arbitrary size limits but
 142    don't need a full dynamic array.  Assumes that BASEVAR points to a
 143    malloced array of TYPE objects (or possibly a NULL pointer, if
 144    SIZEVAR is 0), with the total size stored in SIZEVAR.  This macro
 145    will realloc BASEVAR as necessary so that it can hold at least
 146    NEEDED_SIZE objects.  The reallocing is done by doubling, which
 147    ensures constant amortized time per element.  */
 148 #define DO_REALLOC(basevar, sizevar, needed_size, type) do      \
 149 {                                                               \
 150   /* Avoid side-effectualness.  */                              \
 151   long do_realloc_needed_size = (needed_size);                  \
 152   long do_realloc_newsize = 0;                                  \
 153   while ((sizevar) < (do_realloc_needed_size)) {                \
 154     do_realloc_newsize = 2*(sizevar);                           \
 155     if (do_realloc_newsize < 32)                                \
 156       do_realloc_newsize = 32;                                  \
 157     (sizevar) = do_realloc_newsize;                             \
 158   }                                                             \
 159   if (do_realloc_newsize)                                       \
 160     XREALLOC_ARRAY (basevar, type, do_realloc_newsize);         \
 161 } while (0)
 162
 163 /* Use this for small stack-allocated memory chunks that might grow.
 164    The initial array is created using alloca(), and this macro
 165    requests it to grow.  If the needed size is larger than the array,
 166    this macro will use malloc to allocate it to new size, and copy the
 167    old contents.  After that, successive invocations behave just like
 168    DO_REALLOC.  */
 169 #define DO_REALLOC_FROM_ALLOCA(basevar, sizevar, needed_size, allocap, type) do \
 170 {                                                                               \
 171   /* Avoid side-effectualness.  */                              \
 172   long do_realloc_needed_size = (needed_size);                  \
 173   long do_realloc_newsize = 0;                                  \
 174   while ((sizevar) < (do_realloc_needed_size)) {                \
 175     do_realloc_newsize = 2*(sizevar);                           \
 176     if (do_realloc_newsize < 16)                                \
 177       do_realloc_newsize = 16;                                  \
 178     (sizevar) = do_realloc_newsize;                             \
 179   }                                                             \
 180   if (do_realloc_newsize)                                       \
 181     if (!allocap)                                               \
 182       XREALLOC_ARRAY (basevar, type, do_realloc_newsize);       \
 183     else                                                        \
 184       {                                                         \
 185         void *drfa_new_basevar = xmalloc (do_realloc_newsize);  \
 186         memcpy (drfa_new_basevar, basevar, sizevar);            \
 187         (basevar) = drfa_new_basevar;                           \
 188         allocap = 0;                                            \
 189       }                                                         \
 190 } while (0)
 191
 192 /* Free FOO if it is non-NULL.  */
 193 #define FREE_MAYBE(foo) do { if (foo) free (foo); } while (0)
 194
 195 /* #### Hack: OPTIONS_DEFINED_HERE is defined in main.c.  */
 196 /* [Is this weird hack really necessary on any compilers?  No ANSI C compiler
 197     should complain about "extern const char *exec_name;" followed by
 198     "const char *exec_name;".  Are we doing this for K&R compilers, or...??
 199     -- Dan Harkless <dan-wget@dilvish.speed.net>] */
 200 #ifndef OPTIONS_DEFINED_HERE
 201 extern const char *exec_name;
 202 #endif
 203
 204 \f
 205 /* Document type ("dt") flags */
 206 enum
 207 {
 208   TEXTHTML             = 0x0001,        /* document is of type text/html */
 209   RETROKF              = 0x0002,        /* retrieval was OK */
 210   HEAD_ONLY            = 0x0004,        /* only send the HEAD request */
 211   SEND_NOCACHE         = 0x0008,        /* send Pragma: no-cache directive */
 212   ACCEPTRANGES         = 0x0010,        /* Accept-ranges header was found */
 213   ADDED_HTML_EXTENSION = 0x0020         /* added ".html" extension due to -E */
 214 };
 215
 216 /* Universal error type -- used almost everywhere.
 217    This is, of course, utter crock.  */
 218 typedef enum
 219 {
 220   NOCONERROR, HOSTERR, CONSOCKERR, CONERROR,
 221   CONREFUSED, NEWLOCATION, NOTENOUGHMEM, CONPORTERR,
 222   BINDERR, BINDOK, LISTENERR, ACCEPTERR, ACCEPTOK,
 223   CONCLOSED, FTPOK, FTPLOGINC, FTPLOGREFUSED, FTPPORTERR,
 224   FTPNSFOD, FTPRETROK, FTPUNKNOWNTYPE, FTPRERR,
 225   FTPREXC, FTPSRVERR, FTPRETRINT, FTPRESTFAIL,
 226   URLOK, URLHTTP, URLFTP, URLFILE, URLUNKNOWN, URLBADPORT,
 227   URLBADHOST, FOPENERR, FWRITEERR, HOK, HLEXC, HEOF,
 228   HERR, RETROK, RECLEVELEXC, FTPACCDENIED, WRONGCODE,
 229   FTPINVPASV, FTPNOPASV,
 230   RETRFINISHED, READERR, TRYLIMEXC, URLBADPATTERN,
 231   FILEBADFILE, RANGEERR, RETRBADPATTERN, RETNOTSUP,
 232   ROBOTSOK, NOROBOTS, PROXERR, AUTHFAILED, QUOTEXC, WRITEFAILED
 233 } uerr_t;
 234
 235 typedef unsigned char  boolean;
 236 #ifndef FALSE
 237 #define FALSE 0
 238 #endif
 239 #ifndef TRUE
 240 #define TRUE  1
 241 #endif
 242
 243 /* So we can say strcmp(a, b) == EQ rather than strcmp(a, b) == 0 or
 244    the really awful !strcmp(a, b). */
 245 #define EQ 0
 246
 247 /* For most options, 0 means no limits, but with -p in the picture, that causes
 248    a problem on the maximum recursion depth variable.  To retain backwards
 249    compatibility we allow users to consider "0" to be synonymous with "inf" for
 250    -l, but internally infinite recursion is specified by -1 and 0 means to only
 251    retrieve the requisites of a single document. */
 252 #define INFINITE_RECURSION -1
 253
 254 #endif /* WGET_H */