mod_include

Collaboration diagram for mod_include:

Data Structures
struct	include_ctx_t

Macros
#define	SSI_VALUE_DECODED   1
#define	SSI_VALUE_RAW   0
#define	SSI_EXPAND_LEAVE_NAME   1
#define	SSI_EXPAND_DROP_NAME   0
#define	SSI_CREATE_ERROR_BUCKET(ctx, f, bb)
#define	SSI_FLAG_PRINTING   (1<<0) /* Printing conditional lines. */
#define	SSI_FLAG_COND_TRUE   (1<<1) /* Conditional eval'd to true. */
#define	SSI_FLAG_SIZE_IN_BYTES   (1<<2) /* Sizes displayed in bytes. */
#define	SSI_FLAG_NO_EXEC   (1<<3) /* No Exec in current context. */
#define	SSI_FLAG_SIZE_ABBREV   (~(SSI_FLAG_SIZE_IN_BYTES))
#define	SSI_FLAG_CLEAR_PRINT_COND
#define	SSI_FLAG_CLEAR_PRINTING   (~(SSI_FLAG_PRINTING))

Typedefs
typedef apr_status_t()	include_handler_fn_t(include_ctx_t *, ap_filter_t *, apr_bucket_brigade *)

Functions
void	ap_ssi_get_tag_and_value (include_ctx_t *ctx, char **tag, char **tag_val, int dodecode)
char *	ap_ssi_parse_string (include_ctx_t *ctx, const char *in, char *out, apr_size_t length, int leave_name)
void	ap_register_include_handler (char *tag, include_handler_fn_t *func)

Detailed Description

Macro Definition Documentation

SSI_CREATE_ERROR_BUCKET

#define SSI_CREATE_ERROR_BUCKET	(		ctx,
			f,
			bb
	)

Value:

    APR_BRIGADE_INSERT_TAIL((bb), \
    apr_bucket_pool_create(apr_pstrdup((ctx)->pool, (ctx)->error_str),    \
                           strlen((ctx)->error_str), (ctx)->pool,         \
                           (f)->c->bucket_alloc))

SSI_EXPAND_DROP_NAME

#define SSI_EXPAND_DROP_NAME   0

SSI_EXPAND_LEAVE_NAME

#define SSI_EXPAND_LEAVE_NAME   1

SSI_FLAG_CLEAR_PRINT_COND

#define SSI_FLAG_CLEAR_PRINT_COND

Value:

                                     (~((SSI_FLAG_PRINTING) | \
                                     (SSI_FLAG_COND_TRUE)))

SSI_FLAG_CLEAR_PRINTING

#define SSI_FLAG_CLEAR_PRINTING   (~(SSI_FLAG_PRINTING))

SSI_FLAG_COND_TRUE

#define SSI_FLAG_COND_TRUE   (1<<1) /* Conditional eval'd to true. */

SSI_FLAG_NO_EXEC

#define SSI_FLAG_NO_EXEC   (1<<3) /* No Exec in current context. */

SSI_FLAG_PRINTING

#define SSI_FLAG_PRINTING   (1<<0) /* Printing conditional lines. */

SSI_FLAG_SIZE_ABBREV

#define SSI_FLAG_SIZE_ABBREV   (~(SSI_FLAG_SIZE_IN_BYTES))

SSI_FLAG_SIZE_IN_BYTES

#define SSI_FLAG_SIZE_IN_BYTES   (1<<2) /* Sizes displayed in bytes. */

SSI_VALUE_DECODED

#define SSI_VALUE_DECODED   1

SSI_VALUE_RAW

#define SSI_VALUE_RAW   0

Typedef Documentation

include_handler_fn_t

typedef apr_status_t() include_handler_fn_t(include_ctx_t *, ap_filter_t *, apr_bucket_brigade *)

Function Documentation

ap_register_include_handler()

void ap_register_include_handler	(	char *	tag,
		include_handler_fn_t *	func
	)

ap_ssi_get_tag_and_value()

void ap_ssi_get_tag_and_value	(	include_ctx_t *	ctx,
		char **	tag,
		char **	tag_val,
		int	dodecode
	)

ap_ssi_parse_string()

char* ap_ssi_parse_string	(	include_ctx_t *	ctx,
		const char *	in,
		char *	out,
		apr_size_t	length,
		int	leave_name
	)