Rename privoxy.1 to privoxy.8
[privoxy.git] / miscutil.h
index 8135d73..7c5f7df 100644 (file)
@@ -1,23 +1,22 @@
 #ifndef MISCUTIL_H_INCLUDED
 #define MISCUTIL_H_INCLUDED
-#define MISCUTIL_H_VERSION "$Id: miscutil.h,v 1.25 2007/01/18 15:03:20 fabiankeil Exp $"
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.h,v $
  *
- * Purpose     :  zalloc, hash_string, safe_strerror, strcmpic,
- *                strncmpic, and MinGW32 strdup functions.  These are
- *                each too small to deserve their own file but don't 
- *                really fit in any other file.
+ * Purpose     :  zalloc, hash_string, strcmpic, strncmpic, and
+ *                MinGW32 strdup functions.  These are each too small
+ *                to deserve their own file but don't really fit in
+ *                any other file.
  *
- * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
- *                Privoxy team. http://www.privoxy.org/
+ * Copyright   :  Written by and Copyright (C) 2001-2011 the
+ *                Privoxy team. https://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
- *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                by and Copyright (C) 1997 Anonymous Coders and
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
- *                This program is free software; you can redistribute it 
+ *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at
  *                or write to the Free Software Foundation, Inc., 59
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
- * Revisions   :
- *    $Log: miscutil.h,v $
- *    Revision 1.25  2007/01/18 15:03:20  fabiankeil
- *    Don't include replacement timegm() if
- *    putenv() or tzset() isn't available.
- *
- *    Revision 1.24  2006/08/17 17:15:10  fabiankeil
- *    - Back to timegm() using GnuPG's replacement if necessary.
- *      Using mktime() and localtime() could add a on hour offset if
- *      the randomize factor was big enough to lead to a summer/wintertime
- *      switch.
- *
- *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
- *
- *    - Moved randomization code into pick_from_range().
- *
- *    - Changed parse_header_time definition.
- *      time_t isn't guaranteed to be signed and
- *      if it isn't, -1 isn't available as error code.
- *      Changed some variable types in client_if_modified_since()
- *      because of the same reason.
- *
- *    Revision 1.23  2006/07/18 14:48:47  david__schmidt
- *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
- *    with what was really the latest development (the v_3_0_branch branch)
- *
- *    Revision 1.21  2002/04/26 12:55:38  oes
- *    New function string_toupper
- *
- *    Revision 1.20  2002/03/26 22:29:55  swa
- *    we have a new homepage!
- *
- *    Revision 1.19  2002/03/24 13:25:43  swa
- *    name change related issues
- *
- *    Revision 1.18  2002/03/07 03:46:17  oes
- *    Fixed compiler warnings
- *
- *    Revision 1.17  2002/03/04 18:28:32  oes
- *    Deleted deletePidFile, played syleguide police
- *
- *    Revision 1.16  2002/01/21 00:53:36  jongfoster
- *    Adding string_join()
- *
- *    Revision 1.15  2001/12/30 14:07:32  steudten
- *    - Add signal handling (unix)
- *    - Add SIGHUP handler (unix)
- *    - Add creation of pidfile (unix)
- *    - Add action 'top' in rc file (RH)
- *    - Add entry 'SIGNALS' to manpage
- *    - Add exit message to logfile (unix)
- *
- *    Revision 1.14  2001/11/05 21:43:48  steudten
- *    Add global var 'basedir' for unix os.
- *
- *    Revision 1.13  2001/10/29 03:48:10  david__schmidt
- *    OS/2 native needed a snprintf() routine.  Added one to miscutil, brackedted
- *    by and __OS2__ ifdef.
- *
- *    Revision 1.12  2001/10/23 21:27:50  jongfoster
- *    Standardising error codes in string_append
- *    make_path() no longer adds '\\' if the dir already ends in '\\' (this
- *    is just copying a UNIX-specific fix to the Windows-specific part)
- *
- *    Revision 1.11  2001/10/14 22:02:57  jongfoster
- *    New function string_append() which is like strsav(), but running
- *    out of memory isn't automatically FATAL.
- *
- *    Revision 1.10  2001/09/20 13:34:09  steudten
- *
- *    change long to int for prototype hash_string()
- *
- *    Revision 1.9  2001/07/29 18:43:08  jongfoster
- *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
- *    ANSI C rules.
- *
- *    Revision 1.8  2001/06/29 13:32:14  oes
- *    Removed logentry from cancelled commit
- *
- *    Revision 1.7  2001/06/05 22:32:01  jongfoster
- *    New function make_path() to splice directory and file names together.
- *
- *    Revision 1.6  2001/06/03 19:12:30  oes
- *    introduced bindup()
- *
- *    Revision 1.5  2001/06/01 10:31:51  oes
- *    Added character class matching to trivimatch; renamed to simplematch
- *
- *    Revision 1.4  2001/05/31 17:32:31  oes
- *
- *     - Enhanced domain part globbing with infix and prefix asterisk
- *       matching and optional unanchored operation
- *
- *    Revision 1.3  2001/05/29 23:10:09  oes
- *
- *
- *     - Introduced chomp()
- *     - Moved strsav() from showargs to miscutil
- *
- *    Revision 1.2  2001/05/29 09:50:24  jongfoster
- *    Unified blocklist/imagelist/permissionslist.
- *    File format is still under discussion, but the internal changes
- *    are (mostly) done.
- *
- *    Also modified interceptor behaviour:
- *    - We now intercept all URLs beginning with one of the following
- *      prefixes (and *only* these prefixes):
- *        * http://i.j.b/
- *        * http://ijbswa.sf.net/config/
- *        * http://ijbswa.sourceforge.net/config/
- *    - New interceptors "home page" - go to http://i.j.b/ to see it.
- *    - Internal changes so that intercepted and fast redirect pages
- *      are not replaced with an image.
- *    - Interceptors now have the option to send a binary page direct
- *      to the client. (i.e. ijb-send-banner uses this)
- *    - Implemented show-url-info interceptor.  (Which is why I needed
- *      the above interceptors changes - a typical URL is
- *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
- *      The previous mechanism would not have intercepted that, and
- *      if it had been intercepted then it then it would have replaced
- *      it with an image.)
- *
- *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
- *    Initial import of version 2.9.3 source tree
- *
- *
  *********************************************************************/
-\f
+
 
 #include "project.h"
 
@@ -172,53 +45,51 @@ extern "C" {
 
 extern const char *basedir;
 extern void *zalloc(size_t size);
+extern void *zalloc_or_die(size_t size);
+extern char *strdup_or_die(const char *str);
+extern void *malloc_or_die(size_t buffer_size);
 
 #if defined(unix)
-extern void write_pid_file(void);
+extern void write_pid_file(const char *pid_file);
 #endif /* unix */
 
 extern unsigned int hash_string(const char* s);
 
-extern char *safe_strerror(int err);
-
 extern int strcmpic(const char *s1, const char *s2);
 extern int strncmpic(const char *s1, const char *s2, size_t n);
 
-extern char *strsav(char *old, const char *text_to_append);
 extern jb_err string_append(char **target_string, const char *text_to_append);
 extern jb_err string_join  (char **target_string,       char *text_to_append);
-
 extern char *string_toupper(const char *string);
-extern char *chomp(char *string);
-extern int simplematch(char *pattern, char *text);
+extern char *string_tolower(const char *string);
+extern void string_move(char *dst, char *src);
 
+extern char *chomp(char *string);
 extern char *bindup(const char *string, size_t len);
 
 extern char *make_path(const char * dir, const char * file);
 
 long int pick_from_range(long int range);
 
-#ifdef __MINGW32__
-extern char *strdup(const char *s);
-#endif /* def __MINGW32__ */
-
-#ifdef __OS2__
-extern int snprintf(char *, size_t, const char *, /*args*/ ...);
-#endif /* def __OS2__ */
-
 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
 time_t timegm(struct tm *tm);
 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
 
-#if !defined(HAVE_STRLCPY)
 /* Here's looking at you, Ulrich. */
-#define strlcpy(dst, src, size) (size_t)snprintf((dst), (size), "%s", (src))
+#if !defined(HAVE_STRLCPY)
+size_t privoxy_strlcpy(char *destination, const char *source, size_t size);
+#define strlcpy privoxy_strlcpy
+#define USE_PRIVOXY_STRLCPY 1
 #define HAVE_STRLCPY 1
 #endif /* ndef HAVE_STRLCPY*/
 
-/* Revision control strings from this header and associated .c file */
-extern const char miscutil_rcs[];
-extern const char miscutil_h_rcs[];
+#ifndef HAVE_STRLCAT
+size_t privoxy_strlcat(char *destination, const char *source, size_t size);
+#define strlcat privoxy_strlcat
+#endif /* ndef HAVE_STRLCAT */
+
+extern int privoxy_millisleep(unsigned milliseconds);
+extern struct tm *privoxy_gmtime_r(const time_t *time_spec, struct tm *result);
 
 #if defined(__cplusplus)
 }