2.9.11 version. more input for docs.
[privoxy.git] / miscutil.h
1 #ifndef MISCUTIL_H_INCLUDED
2 #define MISCUTIL_H_INCLUDED
3 #define MISCUTIL_H_VERSION "$Id: miscutil.h,v 1.15 2001/12/30 14:07:32 steudten Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.h,v $
7  *
8  * Purpose     :  zalloc, hash_string, safe_strerror, strcmpic,
9  *                strncmpic, and MinGW32 strdup functions.  These are
10  *                each too small to deserve their own file but don't 
11  *                really fit in any other file.
12  *
13  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
14  *                IJBSWA team.  http://ijbswa.sourceforge.net
15  *
16  *                Based on the Internet Junkbuster originally written
17  *                by and Copyright (C) 1997 Anonymous Coders and 
18  *                Junkbusters Corporation.  http://www.junkbusters.com
19  *
20  *                This program is free software; you can redistribute it 
21  *                and/or modify it under the terms of the GNU General
22  *                Public License as published by the Free Software
23  *                Foundation; either version 2 of the License, or (at
24  *                your option) any later version.
25  *
26  *                This program is distributed in the hope that it will
27  *                be useful, but WITHOUT ANY WARRANTY; without even the
28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
29  *                PARTICULAR PURPOSE.  See the GNU General Public
30  *                License for more details.
31  *
32  *                The GNU General Public License should be included with
33  *                this file.  If not, you can view it at
34  *                http://www.gnu.org/copyleft/gpl.html
35  *                or write to the Free Software Foundation, Inc., 59
36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
37  *
38  * Revisions   :
39  *    $Log: miscutil.h,v $
40  *    Revision 1.15  2001/12/30 14:07:32  steudten
41  *    - Add signal handling (unix)
42  *    - Add SIGHUP handler (unix)
43  *    - Add creation of pidfile (unix)
44  *    - Add action 'top' in rc file (RH)
45  *    - Add entry 'SIGNALS' to manpage
46  *    - Add exit message to logfile (unix)
47  *
48  *    Revision 1.14  2001/11/05 21:43:48  steudten
49  *    Add global var 'basedir' for unix os.
50  *
51  *    Revision 1.13  2001/10/29 03:48:10  david__schmidt
52  *    OS/2 native needed a snprintf() routine.  Added one to miscutil, brackedted
53  *    by and __OS2__ ifdef.
54  *
55  *    Revision 1.12  2001/10/23 21:27:50  jongfoster
56  *    Standardising error codes in string_append
57  *    make_path() no longer adds '\\' if the dir already ends in '\\' (this
58  *    is just copying a UNIX-specific fix to the Windows-specific part)
59  *
60  *    Revision 1.11  2001/10/14 22:02:57  jongfoster
61  *    New function string_append() which is like strsav(), but running
62  *    out of memory isn't automatically FATAL.
63  *
64  *    Revision 1.10  2001/09/20 13:34:09  steudten
65  *
66  *    change long to int for prototype hash_string()
67  *
68  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
69  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
70  *    ANSI C rules.
71  *
72  *    Revision 1.8  2001/06/29 13:32:14  oes
73  *    Removed logentry from cancelled commit
74  *
75  *    Revision 1.7  2001/06/05 22:32:01  jongfoster
76  *    New function make_path() to splice directory and file names together.
77  *
78  *    Revision 1.6  2001/06/03 19:12:30  oes
79  *    introduced bindup()
80  *
81  *    Revision 1.5  2001/06/01 10:31:51  oes
82  *    Added character class matching to trivimatch; renamed to simplematch
83  *
84  *    Revision 1.4  2001/05/31 17:32:31  oes
85  *
86  *     - Enhanced domain part globbing with infix and prefix asterisk
87  *       matching and optional unanchored operation
88  *
89  *    Revision 1.3  2001/05/29 23:10:09  oes
90  *
91  *
92  *     - Introduced chomp()
93  *     - Moved strsav() from showargs to miscutil
94  *
95  *    Revision 1.2  2001/05/29 09:50:24  jongfoster
96  *    Unified blocklist/imagelist/permissionslist.
97  *    File format is still under discussion, but the internal changes
98  *    are (mostly) done.
99  *
100  *    Also modified interceptor behaviour:
101  *    - We now intercept all URLs beginning with one of the following
102  *      prefixes (and *only* these prefixes):
103  *        * http://i.j.b/
104  *        * http://ijbswa.sf.net/config/
105  *        * http://ijbswa.sourceforge.net/config/
106  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
107  *    - Internal changes so that intercepted and fast redirect pages
108  *      are not replaced with an image.
109  *    - Interceptors now have the option to send a binary page direct
110  *      to the client. (i.e. ijb-send-banner uses this)
111  *    - Implemented show-url-info interceptor.  (Which is why I needed
112  *      the above interceptors changes - a typical URL is
113  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
114  *      The previous mechanism would not have intercepted that, and
115  *      if it had been intercepted then it then it would have replaced
116  *      it with an image.)
117  *
118  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
119  *    Initial import of version 2.9.3 source tree
120  *
121  *
122  *********************************************************************/
123 \f
124
125 #include "project.h"
126
127 #if defined(__cplusplus)
128 extern "C" {
129 #endif
130
131 extern const char *basedir;
132 extern void *zalloc(int size);
133
134 #if defined(unix)
135 extern void writePidFile( void );
136 extern void deletePidFile( void );
137 #endif /* unix */
138
139 extern unsigned int hash_string(const char* s);
140
141 extern char *safe_strerror(int err);
142
143 extern int strcmpic(const char *s1, const char *s2);
144 extern int strncmpic(const char *s1, const char *s2, size_t n);
145
146 extern char *strsav(char *old, const char *text_to_append);
147 extern jb_err string_append(char **target_string, const char *text_to_append);
148 extern jb_err string_join  (char **target_string,       char *text_to_append);
149
150 extern char *chomp(char *string);
151 extern int simplematch(char *pattern, char *text);
152
153 extern char *bindup(const char *string, int n);
154
155 extern char *make_path(const char * dir, const char * file);
156
157 #ifdef __MINGW32__
158 extern char *strdup(const char *s);
159 #endif /* def __MINGW32__ */
160
161 #ifdef __OS2__
162 extern int snprintf(char *, size_t, const char *, /*args*/ ...);
163 #endif /* def __OS2__ */
164
165 /* Revision control strings from this header and associated .c file */
166 extern const char miscutil_rcs[];
167 extern const char miscutil_h_rcs[];
168
169 #if defined(__cplusplus)
170 }
171 #endif
172
173 #endif /* ndef MISCUTIL_H_INCLUDED */
174
175 /*
176   Local Variables:
177   tab-width: 3
178   end:
179 */