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

   1 /* Declarations for utils.c.
   2    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   3    2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Wget.
   6
   7 GNU Wget is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Wget is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Wget.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 Additional permission under GNU GPL version 3 section 7
  21
  22 If you modify this program, or any covered work, by linking or
  23 combining it with the OpenSSL project's OpenSSL library (or a
  24 modified version of that library), containing parts covered by the
  25 terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
  26 grants you additional permission to convey the resulting work.
  27 Corresponding Source for a non-source form of such a combination
  28 shall include the source code for the parts of OpenSSL used as well
  29 as that of the covered work.  */
  30
  31 #ifndef UTILS_H
  32 #define UTILS_H
  33
  34 /* Constant is using when we don`t know attempted size exactly */
  35 #define UNKNOWN_ATTEMPTED_SIZE -3
  36
  37 /* Macros that interface to malloc, but know about type sizes, and
  38    cast the result to the appropriate type.  The casts are not
  39    necessary in standard C, but Wget performs them anyway for the sake
  40    of pre-standard environments and possibly C++.  */
  41
  42 #define xnew(type) (xmalloc (sizeof (type)))
  43 #define xnew0(type) (xcalloc (1, sizeof (type)))
  44 #define xnew_array(type, len) (xmalloc ((len) * sizeof (type)))
  45 #define xnew0_array(type, len) (xcalloc ((len), sizeof (type)))
  46
  47 #define alloca_array(type, size) ((type *) alloca ((size) * sizeof (type)))
  48
  49 #define xfree free
  50 /* Free P if it is non-NULL.  C requires free() to behaves this way by
  51    default, but Wget's code is historically careful not to pass NULL
  52    to free.  This allows us to assert p!=NULL in xfree to check
  53    additional errors.  (But we currently don't do that!)  */
  54 #define xfree_null(p) if (!(p)) ; else xfree (p)
  55
  56 struct hash_table;
  57
  58 struct file_memory {
  59   char *content;
  60   long length;
  61   int mmap_p;
  62 };
  63
  64 #define HYPHENP(x) (*(x) == '-' && !*((x) + 1))
  65
  66 char *time_str (time_t);
  67 char *datetime_str (time_t);
  68
  69 #ifdef DEBUG_MALLOC
  70 void print_malloc_debug_stats ();
  71 #endif
  72
  73 char *xstrdup_lower (const char *);
  74
  75 char *strdupdelim (const char *, const char *);
  76 char **sepstring (const char *);
  77 bool subdir_p (const char *, const char *);
  78 void fork_to_background (void);
  79
  80 char *aprintf (const char *, ...) GCC_FORMAT_ATTR (1, 2);
  81 char *concat_strings (const char *, ...);
  82
  83 void touch (const char *, time_t);
  84 int remove_link (const char *);
  85 bool file_exists_p (const char *);
  86 bool file_non_directory_p (const char *);
  87 wgint file_size (const char *);
  88 int make_directory (const char *);
  89 char *unique_name (const char *, bool);
  90 FILE *unique_create (const char *, bool, char **);
  91 FILE *fopen_excl (const char *, bool);
  92 char *file_merge (const char *, const char *);
  93
  94 int fnmatch_nocase (const char *, const char *, int);
  95 bool acceptable (const char *);
  96 bool accdir (const char *s);
  97 char *suffix (const char *s);
  98 bool match_tail (const char *, const char *, bool);
  99 bool has_wildcards_p (const char *);
 100
 101 bool has_html_suffix_p (const char *);
 102
 103 char *read_whole_line (FILE *);
 104 struct file_memory *read_file (const char *);
 105 void read_file_free (struct file_memory *);
 106
 107 void free_vec (char **);
 108 char **merge_vecs (char **, char **);
 109 char **vec_append (char **, const char *);
 110
 111 void string_set_add (struct hash_table *, const char *);
 112 int string_set_contains (struct hash_table *, const char *);
 113 void string_set_to_array (struct hash_table *, char **);
 114 void string_set_free (struct hash_table *);
 115 void free_keys_and_values (struct hash_table *);
 116
 117 const char *with_thousand_seps (wgint);
 118
 119 /* human_readable must be able to accept wgint and SUM_SIZE_INT
 120    arguments.  On machines where wgint is 32-bit, declare it to accept
 121    double.  */
 122 #if SIZEOF_WGINT >= 8
 123 # define HR_NUMTYPE wgint
 124 #else
 125 # define HR_NUMTYPE double
 126 #endif
 127 char *human_readable (HR_NUMTYPE);
 128
 129
 130 int numdigit (wgint);
 131 char *number_to_string (char *, wgint);
 132 char *number_to_static_string (wgint);
 133
 134 int determine_screen_width (void);
 135 int random_number (int);
 136 double random_float (void);
 137
 138 bool run_with_timeout (double, void (*) (void *), void *);
 139 void xsleep (double);
 140
 141 /* How many bytes it will take to store LEN bytes in base64.  */
 142 #define BASE64_LENGTH(len) (4 * (((len) + 2) / 3))
 143
 144 int base64_encode (const void *, int, char *);
 145 int base64_decode (const char *, void *);
 146
 147 void stable_sort (void *, size_t, size_t, int (*) (const void *, const void *));
 148
 149 const char *print_decimal (double);
 150
 151 #endif /* UTILS_H */