Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / miscutil.h
1 #ifndef MISCUTIL_H_INCLUDED
2 #define MISCUTIL_H_INCLUDED
3 #define MISCUTIL_H_VERSION "$Id: miscutil.h,v 1.21 2002/04/26 12:55:38 oes Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/Attic/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  *                Privoxy team. http://www.privoxy.org/
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.21  2002/04/26 12:55:38  oes
41  *    New function string_toupper
42  *
43  *    Revision 1.20  2002/03/26 22:29:55  swa
44  *    we have a new homepage!
45  *
46  *    Revision 1.19  2002/03/24 13:25:43  swa
47  *    name change related issues
48  *
49  *    Revision 1.18  2002/03/07 03:46:17  oes
50  *    Fixed compiler warnings
51  *
52  *    Revision 1.17  2002/03/04 18:28:32  oes
53  *    Deleted deletePidFile, played syleguide police
54  *
55  *    Revision 1.16  2002/01/21 00:53:36  jongfoster
56  *    Adding string_join()
57  *
58  *    Revision 1.15  2001/12/30 14:07:32  steudten
59  *    - Add signal handling (unix)
60  *    - Add SIGHUP handler (unix)
61  *    - Add creation of pidfile (unix)
62  *    - Add action 'top' in rc file (RH)
63  *    - Add entry 'SIGNALS' to manpage
64  *    - Add exit message to logfile (unix)
65  *
66  *    Revision 1.14  2001/11/05 21:43:48  steudten
67  *    Add global var 'basedir' for unix os.
68  *
69  *    Revision 1.13  2001/10/29 03:48:10  david__schmidt
70  *    OS/2 native needed a snprintf() routine.  Added one to miscutil, brackedted
71  *    by and __OS2__ ifdef.
72  *
73  *    Revision 1.12  2001/10/23 21:27:50  jongfoster
74  *    Standardising error codes in string_append
75  *    make_path() no longer adds '\\' if the dir already ends in '\\' (this
76  *    is just copying a UNIX-specific fix to the Windows-specific part)
77  *
78  *    Revision 1.11  2001/10/14 22:02:57  jongfoster
79  *    New function string_append() which is like strsav(), but running
80  *    out of memory isn't automatically FATAL.
81  *
82  *    Revision 1.10  2001/09/20 13:34:09  steudten
83  *
84  *    change long to int for prototype hash_string()
85  *
86  *    Revision 1.9  2001/07/29 18:43:08  jongfoster
87  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
88  *    ANSI C rules.
89  *
90  *    Revision 1.8  2001/06/29 13:32:14  oes
91  *    Removed logentry from cancelled commit
92  *
93  *    Revision 1.7  2001/06/05 22:32:01  jongfoster
94  *    New function make_path() to splice directory and file names together.
95  *
96  *    Revision 1.6  2001/06/03 19:12:30  oes
97  *    introduced bindup()
98  *
99  *    Revision 1.5  2001/06/01 10:31:51  oes
100  *    Added character class matching to trivimatch; renamed to simplematch
101  *
102  *    Revision 1.4  2001/05/31 17:32:31  oes
103  *
104  *     - Enhanced domain part globbing with infix and prefix asterisk
105  *       matching and optional unanchored operation
106  *
107  *    Revision 1.3  2001/05/29 23:10:09  oes
108  *
109  *
110  *     - Introduced chomp()
111  *     - Moved strsav() from showargs to miscutil
112  *
113  *    Revision 1.2  2001/05/29 09:50:24  jongfoster
114  *    Unified blocklist/imagelist/permissionslist.
115  *    File format is still under discussion, but the internal changes
116  *    are (mostly) done.
117  *
118  *    Also modified interceptor behaviour:
119  *    - We now intercept all URLs beginning with one of the following
120  *      prefixes (and *only* these prefixes):
121  *        * http://i.j.b/
122  *        * http://ijbswa.sf.net/config/
123  *        * http://ijbswa.sourceforge.net/config/
124  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
125  *    - Internal changes so that intercepted and fast redirect pages
126  *      are not replaced with an image.
127  *    - Interceptors now have the option to send a binary page direct
128  *      to the client. (i.e. ijb-send-banner uses this)
129  *    - Implemented show-url-info interceptor.  (Which is why I needed
130  *      the above interceptors changes - a typical URL is
131  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
132  *      The previous mechanism would not have intercepted that, and
133  *      if it had been intercepted then it then it would have replaced
134  *      it with an image.)
135  *
136  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
137  *    Initial import of version 2.9.3 source tree
138  *
139  *
140  *********************************************************************/
141 \f
142
143 #include "project.h"
144
145 #if defined(__cplusplus)
146 extern "C" {
147 #endif
148
149 extern const char *basedir;
150 extern void *zalloc(size_t size);
151
152 #if defined(unix)
153 extern void write_pid_file(void);
154 #endif /* unix */
155
156 extern unsigned int hash_string(const char* s);
157
158 extern char *safe_strerror(int err);
159
160 extern int strcmpic(const char *s1, const char *s2);
161 extern int strncmpic(const char *s1, const char *s2, size_t n);
162
163 extern char *strsav(char *old, const char *text_to_append);
164 extern jb_err string_append(char **target_string, const char *text_to_append);
165 extern jb_err string_join  (char **target_string,       char *text_to_append);
166
167 extern char *string_toupper(const char *string);
168 extern char *chomp(char *string);
169 extern int simplematch(char *pattern, char *text);
170
171 extern char *bindup(const char *string, size_t len);
172
173 extern char *make_path(const char * dir, const char * file);
174
175 #ifdef __MINGW32__
176 extern char *strdup(const char *s);
177 #endif /* def __MINGW32__ */
178
179 #ifdef __OS2__
180 extern int snprintf(char *, size_t, const char *, /*args*/ ...);
181 #endif /* def __OS2__ */
182
183 /* Revision control strings from this header and associated .c file */
184 extern const char miscutil_rcs[];
185 extern const char miscutil_h_rcs[];
186
187 #if defined(__cplusplus)
188 }
189 #endif
190
191 #endif /* ndef MISCUTIL_H_INCLUDED */
192
193 /*
194   Local Variables:
195   tab-width: 3
196   end:
197 */