annotate src/http/ngx_http_variables.h @ 3325:42c16d8bddbe

regex named captures
author Igor Sysoev <igor@sysoev.ru>
date Mon, 16 Nov 2009 12:19:02 +0000
parents f267d23868fc
children fe08c14530e9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
1
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
2 /*
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
3 * Copyright (C) Igor Sysoev
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
4 */
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
5
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
6
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
7 #ifndef _NGX_HTTP_VARIABLES_H_INCLUDED_
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
8 #define _NGX_HTTP_VARIABLES_H_INCLUDED_
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
9
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
10
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
11 #include <ngx_config.h>
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
12 #include <ngx_core.h>
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
13 #include <ngx_http.h>
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
14
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
15
1310
33d6c994a0b2 Sun Studio on sparc uses different bit order
Igor Sysoev <igor@sysoev.ru>
parents: 1162
diff changeset
16 typedef ngx_variable_value_t ngx_http_variable_value_t;
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
17
2008
66dc85397a90 escape 0x00-0x1f, ", and \ in access log variables
Igor Sysoev <igor@sysoev.ru>
parents: 1565
diff changeset
18 #define ngx_http_variable(v) { sizeof(v) - 1, 1, 0, 0, 0, (u_char *) v }
573
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
19
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
20 typedef struct ngx_http_variable_s ngx_http_variable_t;
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
21
637
e60fe4cf1d4e nginx-0.3.40-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 635
diff changeset
22 typedef void (*ngx_http_set_variable_pt) (ngx_http_request_t *r,
e60fe4cf1d4e nginx-0.3.40-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 635
diff changeset
23 ngx_http_variable_value_t *v, uintptr_t data);
573
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
24 typedef ngx_int_t (*ngx_http_get_variable_pt) (ngx_http_request_t *r,
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
25 ngx_http_variable_value_t *v, uintptr_t data);
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
26
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
27
1565
4c43e25d11ea fix English grammar
Igor Sysoev <igor@sysoev.ru>
parents: 1310
diff changeset
28 #define NGX_HTTP_VAR_CHANGEABLE 1
4c43e25d11ea fix English grammar
Igor Sysoev <igor@sysoev.ru>
parents: 1310
diff changeset
29 #define NGX_HTTP_VAR_NOCACHEABLE 2
4c43e25d11ea fix English grammar
Igor Sysoev <igor@sysoev.ru>
parents: 1310
diff changeset
30 #define NGX_HTTP_VAR_INDEXED 4
4c43e25d11ea fix English grammar
Igor Sysoev <igor@sysoev.ru>
parents: 1310
diff changeset
31 #define NGX_HTTP_VAR_NOHASH 8
509
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
32
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
33
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
34 struct ngx_http_variable_s {
573
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
35 ngx_str_t name; /* must be first to build the hash */
637
e60fe4cf1d4e nginx-0.3.40-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 635
diff changeset
36 ngx_http_set_variable_pt set_handler;
e60fe4cf1d4e nginx-0.3.40-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 635
diff changeset
37 ngx_http_get_variable_pt get_handler;
573
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
38 uintptr_t data;
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
39 ngx_uint_t flags;
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
40 ngx_uint_t index;
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
41 };
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
42
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
43
3325
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
44 typedef struct {
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
45 ngx_uint_t capture;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
46 ngx_int_t index;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
47 } ngx_http_regex_variable_t;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
48
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
49
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
50 typedef struct {
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
51 ngx_regex_t *regex;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
52 ngx_uint_t ncaptures;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
53 ngx_http_regex_variable_t *variables;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
54 ngx_uint_t nvariables;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
55 ngx_str_t name;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
56 } ngx_http_regex_t;
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
57
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
58
501
d4ea69372b94 nginx-0.1.25-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 499
diff changeset
59 ngx_http_variable_t *ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name,
509
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
60 ngx_uint_t flags);
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
61 ngx_int_t ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name);
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
62 ngx_http_variable_value_t *ngx_http_get_indexed_variable(ngx_http_request_t *r,
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
63 ngx_uint_t index);
573
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
64 ngx_http_variable_value_t *ngx_http_get_flushed_variable(ngx_http_request_t *r,
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
65 ngx_uint_t index);
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
66
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
67 ngx_http_variable_value_t *ngx_http_get_variable(ngx_http_request_t *r,
635
18268abd340c nginx-0.3.39-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 611
diff changeset
68 ngx_str_t *name, ngx_uint_t key, ngx_uint_t nowarn);
509
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
69
1162
f59d15404269 $upstream_http_... variables
Igor Sysoev <igor@sysoev.ru>
parents: 637
diff changeset
70 ngx_int_t ngx_http_variable_unknown_header(ngx_http_variable_value_t *v,
f59d15404269 $upstream_http_... variables
Igor Sysoev <igor@sysoev.ru>
parents: 637
diff changeset
71 ngx_str_t *var, ngx_list_part_t *part, size_t prefix);
f59d15404269 $upstream_http_... variables
Igor Sysoev <igor@sysoev.ru>
parents: 637
diff changeset
72
f59d15404269 $upstream_http_... variables
Igor Sysoev <igor@sysoev.ru>
parents: 637
diff changeset
73
573
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
74 #define ngx_http_clear_variable(r, index) r->variables0[index].text.data = NULL;
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
75
58475592100c nginx-0.3.8-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 533
diff changeset
76
3325
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
77 ngx_http_regex_t *ngx_http_regex_compile(ngx_conf_t *cf,
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
78 ngx_regex_compile_t *rc);
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
79 ngx_int_t ngx_http_regex_exec(ngx_http_request_t *r, ngx_http_regex_t *re,
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
80 ngx_str_t *s);
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
81
42c16d8bddbe regex named captures
Igor Sysoev <igor@sysoev.ru>
parents: 2333
diff changeset
82
509
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
83 ngx_int_t ngx_http_variables_add_core_vars(ngx_conf_t *cf);
9b8c906f6e63 nginx-0.1.29-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 501
diff changeset
84 ngx_int_t ngx_http_variables_init_vars(ngx_conf_t *cf);
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
85
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
86
2333
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
87 typedef struct {
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
88 ngx_rbtree_node_t node;
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
89 size_t len;
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
90 ngx_http_variable_value_t *value;
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
91 } ngx_http_variable_value_node_t;
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
92
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
93
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
94 void ngx_http_variable_value_rbtree_insert(ngx_rbtree_node_t *temp,
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
95 ngx_rbtree_node_t *node, ngx_rbtree_node_t *sentinel);
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
96 ngx_http_variable_value_t *ngx_http_variable_value_lookup(ngx_rbtree_t *rbtree,
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
97 ngx_str_t *name, uint32_t hash);
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
98
f267d23868fc variable value rbtree support
Igor Sysoev <igor@sysoev.ru>
parents: 2233
diff changeset
99
577
4d9ea73a627a nginx-0.3.10-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 573
diff changeset
100 extern ngx_http_variable_value_t ngx_http_variable_null_value;
4d9ea73a627a nginx-0.3.10-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 573
diff changeset
101 extern ngx_http_variable_value_t ngx_http_variable_true_value;
4d9ea73a627a nginx-0.3.10-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 573
diff changeset
102
4d9ea73a627a nginx-0.3.10-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents: 573
diff changeset
103
499
64d9afb209da nginx-0.1.24-RELEASE import
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
104 #endif /* _NGX_HTTP_VARIABLES_H_INCLUDED_ */