Return to tmpl.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / http / servlet

Annotation of embedaddon/libpdel/http/servlet/tmpl.h, revision 1.1.1.1

1.1       misho       1: 
                      2: /*
                      3:  * Copyright (c) 2001-2002 Packet Design, LLC.
                      4:  * All rights reserved.
                      5:  * 
                      6:  * Subject to the following obligations and disclaimer of warranty,
                      7:  * use and redistribution of this software, in source or object code
                      8:  * forms, with or without modifications are expressly permitted by
                      9:  * Packet Design; provided, however, that:
                     10:  * 
                     11:  *    (i)  Any and all reproductions of the source or object code
                     12:  *         must include the copyright notice above and the following
                     13:  *         disclaimer of warranties; and
                     14:  *    (ii) No rights are granted, in any manner or form, to use
                     15:  *         Packet Design trademarks, including the mark "PACKET DESIGN"
                     16:  *         on advertising, endorsements, or otherwise except as such
                     17:  *         appears in the above copyright notice or in the software.
                     18:  * 
                     19:  * THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
                     20:  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
                     21:  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
                     22:  * THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
                     23:  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
                     24:  * OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
                     25:  * OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
                     26:  * OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
                     27:  * RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
                     28:  * LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
                     29:  * OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
                     30:  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
                     31:  * DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
                     32:  * USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
                     33:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
                     34:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
                     35:  * THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
                     36:  * THE POSSIBILITY OF SUCH DAMAGE.
                     37:  *
                     38:  * Author: Archie Cobbs <archie@freebsd.org>
                     39:  */
                     40: 
                     41: #ifndef _PDEL_HTTP_SERVLET_TMPL_H_
                     42: #define _PDEL_HTTP_SERVLET_TMPL_H_
                     43: 
                     44: /* Info required for this servlet */
                     45: 
                     46: typedef void   http_servlet_tmpl_free_t(void *arg);
                     47: 
                     48: struct http_servlet_tmpl_tinfo {
                     49:        int                     flags;          /* flags for tmpl_execute() */
                     50:        const char              *mtype;         /* tmpl string memory type */
                     51:        tmpl_handler_t          *handler;       /* tmpl user function handler */
                     52:        tmpl_errfmtr_t          *errfmtr;       /* tmpl error formatter */
                     53:        void                    *arg;           /* opaque argument */
                     54:        http_servlet_tmpl_free_t *freer;        /* destructor for 'arg' */
                     55: };
                     56: 
                     57: struct http_servlet_tmpl_info {
                     58:        const char              *path;          /* pathname of template file */
                     59:        const char              *mime_type;     /* default output mime type */
                     60:        const char              *mime_encoding; /* default output mime enc. */
                     61:        http_logger_t           *logger;        /* http error logger */
                     62:        struct http_servlet_tmpl_tinfo tinfo;   /* template info */
                     63: };
                     64: 
                     65: /* Argument that gets passed to template function handler */
                     66: struct http_servlet_tmpl_arg {
                     67:        void                            *arg;   /* arg from 'tinfo' */
                     68:        struct http_request             *req;   /* http request */
                     69:        struct http_response            *resp;  /* http response */
                     70: };
                     71: 
                     72: __BEGIN_DECLS
                     73: 
                     74: /*
                     75:  * Create a new template servlet.
                     76:  */
                     77: extern struct  http_servlet *http_servlet_tmpl_create(
                     78:                        struct http_servlet_tmpl_info *info);
                     79: 
                     80: /*
                     81:  * Built-in template user functions.
                     82:  */
                     83: extern tmpl_handler_t  http_servlet_tmpl_func_query;
                     84: extern tmpl_handler_t  http_servlet_tmpl_func_query_exists;
                     85: extern tmpl_handler_t  http_servlet_tmpl_func_query_string;
                     86: extern tmpl_handler_t  http_servlet_tmpl_func_get_header;
                     87: extern tmpl_handler_t  http_servlet_tmpl_func_set_header;
                     88: extern tmpl_handler_t  http_servlet_tmpl_func_remove_header;
                     89: extern tmpl_handler_t  http_servlet_tmpl_func_redirect;
                     90: extern tmpl_handler_t  http_servlet_tmpl_func_unbuffer;
                     91: 
                     92: /*
                     93:  * Internal use only.
                     94:  */
                     95: extern int     _http_servlet_tmpl_copy_tinfo(
                     96:                        struct http_servlet_tmpl_tinfo *dst,
                     97:                        const struct http_servlet_tmpl_tinfo *src);
                     98: extern void    _http_servlet_tmpl_free_tinfo(
                     99:                        struct http_servlet_tmpl_tinfo *tinfo);
                    100: 
                    101: __END_DECLS
                    102: 
                    103: #endif /* _PDEL_HTTP_SERVLET_TMPL_H_ */