Extended Install section -- needs fixing by packagers
[privoxy.git] / vc_config_winthreads.h
1 #ifndef CONFIG_H_INCLUDED
2 #define CONFIG_H_INCLUDED
3 /*********************************************************************
4  *
5  * File        :  $Source: /cvsroot/ijbswa/current/config.h.win32threads.win,v $
6  *
7  * Purpose     :  This file should be the first thing included in every
8  *                .c file.  (Before even system headers).  It contains 
9  *                #define statements for various features.  It was
10  *                introduced because the compile command line started
11  *                getting ludicrously long with feature defines.
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: config.h.win32threads.win,v $
40  *    Revision 1.14  2002/03/26 22:29:54  swa
41  *    we have a new homepage!
42  *
43  *    Revision 1.13  2002/03/24 17:08:12  jongfoster
44  *    Version number bump
45  *
46  *    Revision 1.12  2002/03/24 13:25:43  swa
47  *    name change related issues
48  *
49  *    Revision 1.11  2002/03/16 14:27:22  jongfoster
50  *    Ignoring a very common warning.
51  *
52  *    Revision 1.10  2002/03/13 00:28:32  jongfoster
53  *    Hiding all the warnings generated by #include<windows.h>
54  *
55  *    Revision 1.9  2001/11/30 21:35:54  jongfoster
56  *    Bumping version number to 2.9.10
57  *
58  *    Revision 1.8  2001/10/23 21:24:09  jongfoster
59  *    Support for FEATURE_CGI_EDIT_ACTIONS
60  *
61  *    Revision 1.7  2001/10/07 15:33:14  oes
62  *    Removed FEATURE_DENY_GZIP
63  *    Bumped up version number
64  *
65  *    Revision 1.6  2001/09/16 16:59:34  jongfoster
66  *    Bugfix - couldn't build resources with previous version.
67  *
68  *    Revision 1.5  2001/09/16 16:19:02  jongfoster
69  *    New version based on latest configure.in and acconfig.h
70  *
71  *    Revision 1.9  2001/07/30 22:16:07  jongfoster
72  *    Tidying up #defines:
73  *    - All feature #defines are now of the form FEATURE_xxx
74  *    - Permanently turned off WIN_GUI_EDIT
75  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
76  *
77  *    Revision 1.8  2001/07/25 19:16:27  oes
78  *    Bumping version number to 2.9.8
79  *
80  *    Revision 1.7  2001/07/21 18:00:07  jongfoster
81  *    Bumping version number to 2.9.7
82  *
83  *    Revision 1.6  2001/07/15 20:08:40  jongfoster
84  *    New build files for VC++ which provide the option of POSIX
85  *    or Win32 threads.
86  *
87  *    Revision 1.5  2001/07/15 18:00:46  jongfoster
88  *    Renaming STATIC to STATIC_PCRE.
89  *    Replacing this file with one built by "configure" from
90  *    "config.h.in", for consistency.
91  *
92  *    Revision 1.6  2001/07/15 17:54:29  jongfoster
93  *    Renaming #define STATIC to STATIC_PCRE
94  *    Adding new #define FEATURE_PTHREAD that will be used to enable
95  *    POSIX threads support.
96  *
97  *    Revision 1.5  2001/07/13 13:48:37  oes
98  *     - (Fix:) Copied CODE_STATUS #define from config.h.in
99  *     - split REGEX #define into REGEX_GNU and REGEX_PCRE
100  *       and removed PCRE.
101  *       (REGEX = REGEX_GNU || REGEX_PCRE per project.h)
102  *     - Moved STATIC (for pcre) here from Makefile.in
103  *     - Introduced STATIC_PCRS #define to allow for dynaimc linking with
104  *       libpcrs
105  *     - Removed PCRS #define, since pcrs is now needed for CGI anyway
106  *
107  *    Revision 1.4  2001/05/29 09:50:24  jongfoster
108  *    Unified blocklist/imagelist/permissionslist.
109  *    File format is still under discussion, but the internal changes
110  *    are (mostly) done.
111  *
112  *    Also modified interceptor behaviour:
113  *    - We now intercept all URLs beginning with one of the following
114  *      prefixes (and *only* these prefixes):
115  *        * http://i.j.b/
116  *        * http://ijbswa.sf.net/config/
117  *        * http://ijbswa.sourceforge.net/config/
118  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
119  *    - Internal changes so that intercepted and fast redirect pages
120  *      are not replaced with an image.
121  *    - Interceptors now have the option to send a binary page direct
122  *      to the client. (i.e. ijb-send-banner uses this)
123  *    - Implemented show-url-info interceptor.  (Which is why I needed
124  *      the above interceptors changes - a typical URL is
125  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
126  *      The previous mechanism would not have intercepted that, and
127  *      if it had been intercepted then it then it would have replaced
128  *      it with an image.)
129  *
130  *    Revision 1.3  2001/05/26 01:26:34  jongfoster
131  *    New #define, WIN_GUI_EDIT, enables the (embryonic) Win32 GUI editor.
132  *    This #define cannot be set from ./configure - there's no point, it
133  *    doesn't work yet.  See feature request # 425722
134  *
135  *    Revision 1.2  2001/05/22 17:43:35  oes
136  *
137  *    - Enabled filtering banners by size rather than URL
138  *      by adding patterns that replace all standard banner
139  *      sizes with the "Junkbuster" gif to the re_filterfile
140  *
141  *    - Enabled filtering WebBugs by providing a pattern
142  *      which kills all 1x1 images
143  *
144  *    - Added support for PCRE_UNGREEDY behaviour to pcrs,
145  *      which is selected by the (nonstandard and therefore
146  *      capital) letter 'U' in the option string.
147  *      It causes the quantifiers to be ungreedy by default.
148  *      Appending a ? turns back to greedy (!).
149  *
150  *    - Added a new interceptor ijb-send-banner, which
151  *      sends back the "Junkbuster" gif. Without imagelist or
152  *      MSIE detection support, or if tinygif = 1, or the
153  *      URL isn't recognized as an imageurl, a lame HTML
154  *      explanation is sent instead.
155  *
156  *    - Added new feature, which permits blocking remote
157  *      script redirects and firing back a local redirect
158  *      to the browser.
159  *      The feature is conditionally compiled, i.e. it
160  *      can be disabled with --disable-fast-redirects,
161  *      plus it must be activated by a "fast-redirects"
162  *      line in the config file, has its own log level
163  *      and of course wants to be displayed by show-proxy-args
164  *      Note: Boy, all the #ifdefs in 1001 locations and
165  *      all the fumbling with configure.in and acconfig.h
166  *      were *way* more work than the feature itself :-(
167  *
168  *    - Because a generic redirect template was needed for
169  *      this, tinygif = 3 now uses the same.
170  *
171  *    - Moved GIFs, and other static HTTP response templates
172  *      to project.h
173  *
174  *    - Many minor fixes
175  *
176  *    - Removed some >400 CRs again (Jon, you really worked
177  *      a lot! ;-)
178  *
179  *    Revision 1.1.1.1  2001/05/15 13:58:45  oes
180  *    Initial import of version 2.9.3 source tree
181  *
182  *
183  *********************************************************************/
184 \f
185
186 /*
187  * Version number - Major (X._._)
188  */
189 #define VERSION_MAJOR 2
190
191 /*
192  * Version number - Minor (_.X._)
193  */
194 #define VERSION_MINOR 9
195
196 /*
197  * Version number - Point (_._.X)
198  */
199 #define VERSION_POINT 13
200
201 /*
202  * Version number, as a string
203  */
204 #define VERSION "2.9.13"
205
206 /*
207  * Status of the code: alpha, beta or stable
208  */
209 #define CODE_STATUS "beta"
210
211 /*
212  * Regular expression matching for URLs.  (Highly recommended).
213  * If neither of these are defined then you can ony use prefix matching.
214  * Don't bother to change this here! Use configure instead.
215  */
216 /* #define REGEX_GNU 1 */
217 #define REGEX_PCRE 1
218
219 /* 
220  * Should pcre be statically built in instead of linkling with libpcre?
221  * (This is determined by configure depending on the availiability of
222  * libpcre and user preferences). The name is ugly, but pcre needs it.
223  * Don't bother to change this here! Use configure instead.
224  */
225 #define STATIC_PCRE 1
226
227 /* 
228  * Should pcrs be statically built in instead of linkling with libpcrs?
229  * (This is determined by configure depending on the availiability of
230  * libpcrs and user preferences).
231  * Don't bother to change this here! Use configure instead.
232  */
233 #define STATIC_PCRS 1
234
235 /*
236  * Allows the use of an ACL to control access to the proxy by IP address.
237  */
238 #define FEATURE_ACL 1
239
240 /*
241  * Enables the web-based configuration (actionsfile) editor.  If you
242  * have a shared proxy, you might want to turn this off.
243  */
244 #define FEATURE_CGI_EDIT_ACTIONS 1
245
246 /*
247  * Allows the use of jar files to capture cookies.
248  */
249 #define FEATURE_COOKIE_JAR 1
250
251 /*
252  * Locally redirect remote script-redirect URLs
253  */
254 #define FEATURE_FAST_REDIRECTS 1
255
256 /*
257  * Bypass filtering for 1 page only
258  */
259 #define FEATURE_FORCE_LOAD 1
260
261 /*
262  * Allow blocking using images as well as HTML.
263  * If you do not define this then everything is blocked as HTML.
264  *
265  * Note that this is required if you want to use FEATURE_IMAGE_DETECT_MSIE.
266  */
267 #define FEATURE_IMAGE_BLOCKING 1
268
269 /*
270  * Detect image requests automatically for MSIE.  Will fall back to
271  * other image-detection methods (i.e. "+image" permission) for other
272  * browsers.
273  *
274  * You must also define FEATURE_IMAGE_BLOCKING to use this feature.
275  *
276  * It detects the following header pair as an image request:
277  *
278  * User-Agent: Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)
279  * Accept: * / *
280  *
281  * And the following as a HTML request:
282  *
283  * User-Agent: Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)
284  * Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, * / *
285  *
286  * And no, I haven't got that backwards - IE is being wierd.
287  *
288  * Known limitations: 
289  * 1) If you press shift-reload on a blocked HTML page, you get
290  *    the image "blocked" page, not the HTML "blocked" page.
291  * 2) Once an image "blocked" page has been sent, viewing it 
292  *    in it's own browser window *should* bring up the HTML
293  *    "blocked" page, but it doesn't.  You need to clear the 
294  *    browser cache to get the HTML version again.
295  *
296  * These limitations are due to IE making inconsistent choices
297  * about which "Accept:" header to send.
298  */
299 #define FEATURE_IMAGE_DETECT_MSIE 1
300
301 /*
302  * Kills JavaScript popups - window.open, onunload, etc.
303  */
304 #define FEATURE_KILL_POPUPS 1
305
306 /*
307  * Use POSIX threads instead of native threads.
308  */
309 /* #define FEATURE_PTHREAD 1 */
310
311 /*
312  * Enables statistics function.
313  */
314 #define FEATURE_STATISTICS 1
315
316 /*
317  * Allow JunkBuster to be "disabled" so it is just a normal non-blocking
318  * non-anonymizing proxy.  This is useful if you're trying to access a
319  * blocked or broken site - just change the setting in the config file,
320  * or use the handy "Disable" menu option in the Windows GUI.
321  */
322 #define FEATURE_TOGGLE 1
323
324 /*
325  * Allows the use of trust files.
326  */
327 #define FEATURE_TRUST 1
328
329
330 /****************************************************************************
331  * The following values are correct for MS VC++97.
332  * You should normally not change them.
333  ***************************************************************************/
334
335
336 /*
337  * Defined on Solaris only.  Makes the system libraries thread safe.
338  */
339 /* #define _REENTRANT 1 */
340
341 /*
342  * Defined on Solaris only.  Without this, many important functions are not
343  * defined in the system headers.
344  */
345 /* #define __EXTENSIONS__ 1 */
346
347 /*
348  * Defined always.
349  * FIXME: Don't know what it does or why we need it.
350  * (presumably something to do with MultiThreading?)
351  */
352 #define __MT__ 1
353
354
355 /* Define if you have the `bcopy' function. */
356 /* #define HAVE_BCOPY 1 */
357
358 /* Define if you have the <inttypes.h> header file. */
359 /* #define HAVE_INTTYPES_H 1 */
360
361 /* Define if you have the `memmove' function. */
362 #define HAVE_MEMMOVE 1
363
364 /* Define if you have the <memory.h> header file. */
365 #define HAVE_MEMORY_H 1
366
367 /* Define if you have the <stdint.h> header file. */
368 /* #define HAVE_STDINT_H 1 */
369
370 /* Define if you have the <stdlib.h> header file. */
371 #define HAVE_STDLIB_H 1
372
373 /* Define if you have the `strerror' function. */
374 #define HAVE_STRERROR 1
375
376 /* Define if you have the <strings.h> header file. */
377 /* #define HAVE_STRINGS_H 1 */
378
379 /* Define if you have the <string.h> header file. */
380 #define HAVE_STRING_H 1
381
382 /* Define if you have the <sys/stat.h> header file. */
383 #define HAVE_SYS_STAT_H 1
384
385 /* Define if you have the <sys/types.h> header file. */
386 #define HAVE_SYS_TYPES_H 1
387
388 /* Define if you have the <unistd.h> header file. */
389 /* #define HAVE_UNISTD_H 1 */
390
391 /* The size of a `char *', as computed by sizeof. */
392 #define SIZEOF_CHAR_P 4
393
394 /* The size of a `int', as computed by sizeof. */
395 #define SIZEOF_INT 4
396
397 /* The size of a `long', as computed by sizeof. */
398 #define SIZEOF_LONG 4
399
400 /* The size of a `long long', as computed by sizeof. */
401 /* #define SIZEOF_LONG_LONG ---not supported--- */
402
403 /* The size of a `size_t', as computed by sizeof. */
404 #define SIZEOF_SIZE_T 4
405
406 /* Define if you have the ANSI C header files. */
407 #define STDC_HEADERS 1
408
409 /* Define to empty if `const' does not conform to ANSI C. */
410 /* #define const */
411
412 /* Define to `unsigned' if <sys/types.h> does not define. */
413 /* #define size_t unsigned */
414
415 /*
416  * Defined always.
417  * FIXME: Don't know what it does or why we need it.
418  * (presumably something to do with ANSI Standard C?)
419  */
420 /* Don't define for MS VC++ or you don't get strdup() declared.
421 #ifndef __STDC__
422 #define __STDC__ 1
423 #endif
424 */
425
426 /*
427  * Need to set up this define only for the Pthreads library for
428  * Win32, available from http://sources.redhat.com/pthreads-win32/
429  */
430 #if defined(FEATURE_PTHREAD) && defined(_WIN32)
431 #define __CLEANUP_C
432 #endif /* defined(FEATURE_PTHREAD) && defined(_WIN32) */
433
434 /*
435  * BEOS does not currently support POSIX threads.
436  * This *should* be detected by ./configure, but let's be sure.
437  */
438 #if defined(FEATURE_PTHREAD) && defined(__BEOS__)
439 #error BEOS does not support pthread - please run ./configure again with "--disable-pthread"
440
441 #endif /* defined(FEATURE_PTHREAD) && defined(__BEOS__) */
442
443
444 #if (!defined(_MSC_VER)) && (!defined(RC_INVOKED))
445 #error This file is only intended for MS VC++ on Win32.  For other compilers, please run configure.
446 #endif /* (!defined(_MSC_VER)) && (!defined(RC_INVOKED)) */
447
448 #pragma warning ( disable: 4100 4115 4201 4214 4244 4514 )
449
450 /*
451  * C4100 : unreferenced formal parameter
452  * Very common, not a bug
453  * 
454  * C4115 : named type definition in parentheses
455  * #include <windows.h> causes a warning about one of these.
456  *
457  * C4201 : nonstandard extension used : nameless struct/union
458  * Endemic in <windows.h>
459  *
460  * C4214 nonstandard extension used : bit field types other than int
461  * Endemic in <windows.h>
462  *
463  * C4244 conversion from 'int' to 'char', possible loss of data
464  * Should really fix this one.  Throughout the JB code.
465  *
466  * C4514 unreferenced inline/local function has been removed
467  * Caused by #include <windows.h>
468  */
469
470
471 #endif /* CONFIG_H_INCLUDED */
472