Completed proofreading the actions chapter
[privoxy.git] / parsers.h
index 843c2b5..837bac4 100644 (file)
--- a/parsers.h
+++ b/parsers.h
@@ -1,6 +1,6 @@
 #ifndef PARSERS_H_INCLUDED
 #define PARSERS_H_INCLUDED
-#define PARSERS_H_VERSION "$Id: parsers.h,v 1.11 2001/07/31 14:46:53 oes Exp $"
+#define PARSERS_H_VERSION "$Id: parsers.h,v 1.25 2002/03/26 22:29:55 swa Exp $"
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/parsers.h,v $
@@ -17,7 +17,7 @@
  *                   and `server_set_cookie'.
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and 
  *
  * Revisions   :
  *    $Log: parsers.h,v $
+ *    Revision 1.25  2002/03/26 22:29:55  swa
+ *    we have a new homepage!
+ *
+ *    Revision 1.24  2002/03/24 13:25:43  swa
+ *    name change related issues
+ *
+ *    Revision 1.23  2002/03/13 00:27:05  jongfoster
+ *    Killing warnings
+ *
+ *    Revision 1.22  2002/03/09 20:03:52  jongfoster
+ *    - Making various functions return int rather than size_t.
+ *      (Undoing a recent change).  Since size_t is unsigned on
+ *      Windows, functions like read_socket that return -1 on
+ *      error cannot return a size_t.
+ *
+ *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
+ *      crashes, and also frequently caused JB to jump to 100%
+ *      CPU and stay there.  (Because it thought it had just
+ *      read ((unsigned)-1) == 4Gb of data...)
+ *
+ *    - The signature of write_socket has changed, it now simply
+ *      returns success=0/failure=nonzero.
+ *
+ *    - Trying to get rid of a few warnings --with-debug on
+ *      Windows, I've introduced a new type "jb_socket".  This is
+ *      used for the socket file descriptors.  On Windows, this
+ *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
+ *      an int.  The error value can't be -1 any more, so it's
+ *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
+ *      Windows it maps to the #define INVALID_SOCKET.)
+ *
+ *    - The signature of bind_port has changed.
+ *
+ *    Revision 1.21  2002/03/07 03:46:17  oes
+ *    Fixed compiler warnings
+ *
+ *    Revision 1.20  2002/02/20 23:15:13  jongfoster
+ *    Parsing functions now handle out-of-memory gracefully by returning
+ *    an error code.
+ *
+ *    Revision 1.19  2002/01/17 21:03:47  jongfoster
+ *    Moving all our URL and URL pattern parsing code to urlmatch.c.
+ *
+ *    Revision 1.18  2001/10/26 17:40:23  oes
+ *    Introduced get_header_value()
+ *    Removed client_accept()
+ *
+ *    Revision 1.17  2001/10/13 12:47:32  joergs
+ *    Removed client_host, added client_host_adder
+ *
+ *    Revision 1.16  2001/10/07 18:50:16  oes
+ *    Added server_content_encoding, renamed server_transfer_encoding
+ *
+ *    Revision 1.15  2001/10/07 18:01:55  oes
+ *    Changed server_http11 to server_http
+ *
+ *    Revision 1.14  2001/10/07 15:45:48  oes
+ *    added client_accept_encoding, client_te, client_accept_encoding_adder
+ *
+ *    renamed content_type and content_length
+ *
+ *    fixed client_host and strclean prototypes
+ *
+ *    Revision 1.13  2001/09/29 12:56:03  joergs
+ *    IJB now changes HTTP/1.1 to HTTP/1.0 in requests and answers.
+ *
+ *    Revision 1.12  2001/09/13 23:05:50  jongfoster
+ *    Changing the string paramater to the header parsers a "const".
+ *
  *    Revision 1.11  2001/07/31 14:46:53  oes
  *    Added prototype for connection_close_adder
  *
@@ -106,46 +175,45 @@ extern "C" {
 extern const struct parsers client_patterns[];
 extern const struct parsers server_patterns[];
 
-extern void (* const add_client_headers[])(struct client_state *);
-extern void (* const add_server_headers[])(struct client_state *);
+extern const add_header_func_ptr add_client_headers[];
+extern const add_header_func_ptr add_server_headers[];
 
-extern int flush_socket(int fd, struct client_state *csp);
-extern int add_to_iob(struct client_state *csp, char *buf, int n);
+extern int flush_socket(jb_socket fd, struct client_state *csp);
+extern jb_err add_to_iob(struct client_state *csp, char *buf, int n);
 extern char *get_header(struct client_state *csp);
-
-extern char *sed(const struct parsers pats[], void (* const more_headers[])(struct client_state *), struct client_state *csp);
-
-extern void free_http_request(struct http_request *http);
-extern void parse_http_request(char *req, struct http_request *http, struct client_state *csp);
-
-extern char *crumble(const struct parsers *v, const char *s, struct client_state *csp);
-
-extern char *client_referrer(const struct parsers *v, const char *s, struct client_state *csp);
-extern char *client_uagent(const struct parsers *v, const char *s, struct client_state *csp);
-extern char *client_ua(const struct parsers *v, const char *s, struct client_state *csp);
-extern char *client_from(const struct parsers *v, const char *s, struct client_state *csp);
-extern char *client_send_cookie(const struct parsers *v, const char *s, struct client_state *csp);
-extern char *client_x_forwarded(const struct parsers *v, const char *s, struct client_state *csp);
-
-extern void client_cookie_adder(struct client_state *csp);
-extern void client_xtra_adder(struct client_state *csp);
-extern void connection_close_adder(struct client_state *csp); 
-extern void client_x_forwarded_adder(struct client_state *csp);
-
-extern char *server_set_cookie(const struct parsers *v, const char *s, struct client_state *csp);
-
-extern char *content_type(const struct parsers *v, const char *s, struct client_state *csp);
-extern char *content_length(const struct parsers *v, const char *s, struct client_state *csp);
+extern char *get_header_value(const struct list *header_list, const char *header_name);
+extern char *sed(const struct parsers pats[], const add_header_func_ptr more_headers[], struct client_state *csp);
+
+extern jb_err crumble                (struct client_state *csp, char **header);
+extern jb_err client_referrer        (struct client_state *csp, char **header);
+extern jb_err client_uagent          (struct client_state *csp, char **header);
+extern jb_err client_ua              (struct client_state *csp, char **header);
+extern jb_err client_from            (struct client_state *csp, char **header);
+extern jb_err client_send_cookie     (struct client_state *csp, char **header);
+extern jb_err client_x_forwarded     (struct client_state *csp, char **header);
+extern jb_err client_accept_encoding (struct client_state *csp, char **header);
+extern jb_err client_te              (struct client_state *csp, char **header);
+
+extern jb_err client_host_adder           (struct client_state *csp);
+extern jb_err client_cookie_adder         (struct client_state *csp);
+extern jb_err client_xtra_adder           (struct client_state *csp);
+extern jb_err client_accept_encoding_adder(struct client_state *csp);
+extern jb_err client_x_forwarded_adder    (struct client_state *csp);
+
+extern jb_err connection_close_adder      (struct client_state *csp); 
+
+extern jb_err server_set_cookie      (struct client_state *csp, char **header);
+extern jb_err server_content_type    (struct client_state *csp, char **header);
+extern jb_err server_content_length  (struct client_state *csp, char **header);
+extern jb_err server_content_md5     (struct client_state *csp, char **header);
+extern jb_err server_content_encoding(struct client_state *csp, char **header);
+extern jb_err server_transfer_coding (struct client_state *csp, char **header);
+extern jb_err server_http            (struct client_state *csp, char **header);
 
 #ifdef FEATURE_FORCE_LOAD
-char *client_host(const struct parsers *v, const char *s, struct client_state *csp);
-int strclean(const char *string, const char *substring);
+extern int strclean(const char *string, const char *substring);
 #endif /* def FEATURE_FORCE_LOAD */
 
-#if defined(FEATURE_IMAGE_DETECT_MSIE)
-extern char *client_accept(const struct parsers *v, const char *s, struct client_state *csp);
-#endif /* defined(FEATURE_IMAGE_DETECT_MSIE) */
-
 /* Revision control strings from this header and associated .c file */
 extern const char parsers_rcs[];
 extern const char parsers_h_rcs[];