Extended Install section -- needs fixing by packagers
[privoxy.git] / urlmatch.h
1 #ifndef URLMATCH_H_INCLUDED
2 #define URLMATCH_H_INCLUDED
3 #define URLMATCH_H_VERSION "$Id: urlmatch.h,v 1.2 2002/03/24 13:25:43 swa Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/urlmatch.h,v $
7  *
8  * Purpose     :  Declares functions to match URLs against URL
9  *                patterns.
10  *
11  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
12  *                Privoxy team. http://www.privoxy.org/
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and 
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
18  *                This program is free software; you can redistribute it 
19  *                and/or modify it under the terms of the GNU General
20  *                Public License as published by the Free Software
21  *                Foundation; either version 2 of the License, or (at
22  *                your option) any later version.
23  *
24  *                This program is distributed in the hope that it will
25  *                be useful, but WITHOUT ANY WARRANTY; without even the
26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
27  *                PARTICULAR PURPOSE.  See the GNU General Public
28  *                License for more details.
29  *
30  *                The GNU General Public License should be included with
31  *                this file.  If not, you can view it at
32  *                http://www.gnu.org/copyleft/gpl.html
33  *                or write to the Free Software Foundation, Inc., 59
34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
35  *
36  * Revisions   :
37  *    $Log: urlmatch.h,v $
38  *    Revision 1.2  2002/03/24 13:25:43  swa
39  *    name change related issues
40  *
41  *    Revision 1.1  2002/01/17 20:53:46  jongfoster
42  *    Moving all our URL and URL pattern parsing code to the same file - it
43  *    was scattered around in filters.c, loaders.c and parsers.c.
44  *
45  *    Providing a single, simple url_match(pattern,url) function - rather than
46  *    the 3-line match routine which was repeated all over the place.
47  *
48  *    Renaming free_url to free_url_spec, since it frees a struct url_spec.
49  *
50  *    Providing parse_http_url() so that URLs can be parsed without faking a
51  *    HTTP request line for parse_http_request() or repeating the parsing
52  *    code (both of which were techniques that were actually in use).
53  *
54  *    Standardizing that struct http_request is used to represent a URL, and
55  *    struct url_spec is used to represent a URL pattern.  (Before, URLs were
56  *    represented as seperate variables and a partially-filled-in url_spec).
57  *
58  *
59  *********************************************************************/
60 \f
61
62 #include "project.h"
63
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67
68 extern void free_http_request(struct http_request *http);
69 extern jb_err parse_http_request(const char *req,
70                                  struct http_request *http,
71                                  struct client_state *csp);
72 extern jb_err parse_http_url(const char * url,
73                              struct http_request *http,
74                              struct client_state *csp);
75
76 extern int url_match(const struct url_spec *pattern,
77                      const struct http_request *url);
78
79 extern jb_err create_url_spec(struct url_spec * url, const char * buf);
80 extern void free_url_spec(struct url_spec *url);
81
82
83 /* Revision control strings from this header and associated .c file */
84 extern const char urlmatch_rcs[];
85 extern const char urlmatch_h_rcs[];
86
87 #ifdef __cplusplus
88 } /* extern "C" */
89 #endif
90
91 #endif /* ndef URLMATCH_H_INCLUDED */
92
93 /*
94   Local Variables:
95   tab-width: 3
96   end:
97 */