Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mod_include.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
26 #ifndef _MOD_INCLUDE_H
27 #define _MOD_INCLUDE_H 1
28 
29 #include "apr_pools.h"
30 #include "apr_optional.h"
31 
32 /*
33  * Constants used for ap_ssi_get_tag_and_value's decode parameter
34  */
35 #define SSI_VALUE_DECODED 1
36 #define SSI_VALUE_RAW 0
37 
38 /*
39  * Constants used for ap_ssi_parse_string's leave_name parameter
40  */
41 #define SSI_EXPAND_LEAVE_NAME 1
42 #define SSI_EXPAND_DROP_NAME 0
43 
44 /*
45  * This macro creates a bucket which contains an error message and appends it
46  * to the current pass brigade
47  */
48 #define SSI_CREATE_ERROR_BUCKET(ctx, f, bb) APR_BRIGADE_INSERT_TAIL((bb), \
49  apr_bucket_pool_create(apr_pstrdup((ctx)->pool, (ctx)->error_str), \
50  strlen((ctx)->error_str), (ctx)->pool, \
51  (f)->c->bucket_alloc))
52 
53 /*
54  * These constants are used to set or clear flag bits.
55  */
56 #define SSI_FLAG_PRINTING (1<<0) /* Printing conditional lines. */
57 #define SSI_FLAG_COND_TRUE (1<<1) /* Conditional eval'd to true. */
58 #define SSI_FLAG_SIZE_IN_BYTES (1<<2) /* Sizes displayed in bytes. */
59 #define SSI_FLAG_NO_EXEC (1<<3) /* No Exec in current context. */
60 
61 #define SSI_FLAG_SIZE_ABBREV (~(SSI_FLAG_SIZE_IN_BYTES))
62 #define SSI_FLAG_CLEAR_PRINT_COND (~((SSI_FLAG_PRINTING) | \
63  (SSI_FLAG_COND_TRUE)))
64 #define SSI_FLAG_CLEAR_PRINTING (~(SSI_FLAG_PRINTING))
65 
66 /*
67  * The public SSI context structure
68  */
69 typedef struct {
70  /* permanent pool, use this for creating bucket data */
72 
73  /* temp pool; will be cleared after the execution of every directive */
75 
76  /* See the SSI_FLAG_XXXXX definitions. */
77  int flags;
78 
79  /* nesting of *invisible* ifs */
81 
82  /* if true, the current buffer will be passed down the filter chain before
83  * continuing with next input bucket and the variable will be reset to
84  * false.
85  */
86  int flush_now;
87 
88  /* argument counter (of the current directive) */
89  unsigned argc;
90 
91  /* currently configured error string */
92  const char *error_str;
93 
94  /* currently configured time format */
95  const char *time_str;
96 
97  /* the current request */
99 
100  /* pointer to internal (non-public) data, don't touch */
101  struct ssi_internal_ctx *intern;
102 
103 } include_ctx_t;
104 
107 
109  (include_ctx_t *ctx, char **tag, char **tag_val,
110  int dodecode));
111 
113  (include_ctx_t *ctx, const char *in, char *out,
114  apr_size_t length, int leave_name));
115 
117  (char *tag, include_handler_fn_t *func));
118 
119 #endif /* MOD_INCLUDE */
120 
void ap_ssi_get_tag_and_value(include_ctx_t *ctx, char **tag, char **tag_val, int dodecode)
size_t apr_size_t
Definition: apr.h:375
The representation of a filter chain.
Definition: util_filter.h:278
int if_nesting_level
Definition: mod_include.h:80
int flags
Definition: mod_include.h:77
Definition: apr_buckets.h:258
apr_status_t( include_handler_fn_t)(include_ctx_t *, ap_filter_t *, apr_bucket_brigade *)
Definition: mod_include.h:105
APR-UTIL registration of functions exported by modules.
Definition: mod_include.h:69
APR memory allocation.
const char * time_str
Definition: mod_include.h:95
const char * error_str
Definition: mod_include.h:92
apr_pool_t * dpool
Definition: mod_include.h:74
apr_pool_t * pool
Definition: mod_include.h:71
unsigned argc
Definition: mod_include.h:89
A structure that represents the current request.
Definition: httpd.h:810
void ap_register_include_handler(char *tag, include_handler_fn_t *func)
struct ssi_internal_ctx * intern
Definition: mod_include.h:101
struct apr_pool_t apr_pool_t
Definition: apr_pools.h:60
int apr_status_t
Definition: apr_errno.h:44
#define APR_DECLARE_OPTIONAL_FN(ret, name, args)
Definition: apr_optional.h:50
request_rec * r
Definition: mod_include.h:98
char * ap_ssi_parse_string(include_ctx_t *ctx, const char *in, char *out, apr_size_t length, int leave_name)
int flush_now
Definition: mod_include.h:86