Return to tmpl.h CVS log

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

libpdel

/*
 * Copyright (c) 2001-2002 Packet Design, LLC.
 * All rights reserved.
 * 
 * Subject to the following obligations and disclaimer of warranty,
 * use and redistribution of this software, in source or object code
 * forms, with or without modifications are expressly permitted by
 * Packet Design; provided, however, that:
 * 
 *    (i)  Any and all reproductions of the source or object code
 *         must include the copyright notice above and the following
 *         disclaimer of warranties; and
 *    (ii) No rights are granted, in any manner or form, to use
 *         Packet Design trademarks, including the mark "PACKET DESIGN"
 *         on advertising, endorsements, or otherwise except as such
 *         appears in the above copyright notice or in the software.
 * 
 * THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
 * THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
 * OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
 * OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
 * OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
 * RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
 * LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
 * OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
 * DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
 * USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Author: Archie Cobbs <archie@freebsd.org>
 */

#ifndef _PDEL_HTTP_SERVLET_TMPL_H_
#define _PDEL_HTTP_SERVLET_TMPL_H_

/* Info required for this servlet */

typedef void	http_servlet_tmpl_free_t(void *arg);

struct http_servlet_tmpl_tinfo {
	int			flags;		/* flags for tmpl_execute() */
	const char		*mtype;		/* tmpl string memory type */
	tmpl_handler_t		*handler;	/* tmpl user function handler */
	tmpl_errfmtr_t		*errfmtr;	/* tmpl error formatter */
	void			*arg;		/* opaque argument */
	http_servlet_tmpl_free_t *freer;	/* destructor for 'arg' */
};

struct http_servlet_tmpl_info {
	const char		*path;		/* pathname of template file */
	const char		*mime_type;	/* default output mime type */
	const char		*mime_encoding;	/* default output mime enc. */
	http_logger_t		*logger;	/* http error logger */
	struct http_servlet_tmpl_tinfo tinfo;	/* template info */
};

/* Argument that gets passed to template function handler */
struct http_servlet_tmpl_arg {
	void				*arg;	/* arg from 'tinfo' */
	struct http_request		*req;	/* http request */
	struct http_response		*resp;	/* http response */
};

__BEGIN_DECLS

/*
 * Create a new template servlet.
 */
extern struct	http_servlet *http_servlet_tmpl_create(
			struct http_servlet_tmpl_info *info);

/*
 * Built-in template user functions.
 */
extern tmpl_handler_t	http_servlet_tmpl_func_query;
extern tmpl_handler_t	http_servlet_tmpl_func_query_exists;
extern tmpl_handler_t	http_servlet_tmpl_func_query_string;
extern tmpl_handler_t	http_servlet_tmpl_func_get_header;
extern tmpl_handler_t	http_servlet_tmpl_func_set_header;
extern tmpl_handler_t	http_servlet_tmpl_func_remove_header;
extern tmpl_handler_t	http_servlet_tmpl_func_redirect;
extern tmpl_handler_t	http_servlet_tmpl_func_unbuffer;

/*
 * Internal use only.
 */
extern int	_http_servlet_tmpl_copy_tinfo(
			struct http_servlet_tmpl_tinfo *dst,
			const struct http_servlet_tmpl_tinfo *src);
extern void	_http_servlet_tmpl_free_tinfo(
			struct http_servlet_tmpl_tinfo *tinfo);

__END_DECLS

#endif	/* _PDEL_HTTP_SERVLET_TMPL_H_ */