ngx_nsoc_variables.h

/*
 * Copyright (C) Igor Sysoev
 * Copyright (C) Nginx, Inc.
 */

#ifndef _NGX_NSOC_VARIABLES_H_INCLUDED_
#define _NGX_NSOC_VARIABLES_H_INCLUDED_

#include <ngx_config.h>
#include <ngx_core.h>
#include "ngx_nsoc.h"

typedef ngx_variable_value_t ngx_nsoc_variable_value_t;

#define ngx_nsoc_variable(v)     { sizeof(v) - 1, 1, 0, 0, 0, (u_char *) v }

typedef struct ngx_nsoc_variable_s ngx_nsoc_variable_t;

typedef void (*ngx_nsoc_set_variable_pt)(ngx_nsoc_session_t *s,
        ngx_nsoc_variable_value_t *v, uintptr_t data);
typedef ngx_int_t (*ngx_nsoc_get_variable_pt)(
        ngx_nsoc_session_t *s, ngx_nsoc_variable_value_t *v,
        uintptr_t data);

#define NGX_NSOC_VAR_CHANGEABLE   1
#define NGX_NSOC_VAR_NOCACHEABLE  2
#define NGX_NSOC_VAR_INDEXED      4
#define NGX_NSOC_VAR_NOHASH       8
#define NGX_NSOC_VAR_WEAK         16
#define NGX_NSOC_VAR_PREFIX       32

struct ngx_nsoc_variable_s {
        ngx_str_t name; /* must be first to build the hash */
        ngx_nsoc_set_variable_pt set_handler;
        ngx_nsoc_get_variable_pt get_handler;
        uintptr_t data;
        ngx_uint_t flags;
        ngx_uint_t index;
};

ngx_nsoc_variable_t *ngx_nsoc_add_variable(ngx_conf_t *cf,
        ngx_str_t *name, ngx_uint_t flags);
ngx_int_t ngx_nsoc_get_variable_index(ngx_conf_t *cf, ngx_str_t *name);
ngx_nsoc_variable_value_t *ngx_nsoc_get_indexed_variable(
        ngx_nsoc_session_t *s, ngx_uint_t index);
ngx_nsoc_variable_value_t *ngx_nsoc_get_flushed_variable(
        ngx_nsoc_session_t *s, ngx_uint_t index);

ngx_nsoc_variable_value_t *ngx_nsoc_get_variable(
        ngx_nsoc_session_t *s, ngx_str_t *name, ngx_uint_t key);

#if (NGX_PCRE)

typedef struct {
        ngx_uint_t capture;
        ngx_int_t index;
} ngx_nsoc_regex_variable_t;

typedef struct {
        ngx_regex_t *regex;
        ngx_uint_t ncaptures;
        ngx_nsoc_regex_variable_t *variables;
        ngx_uint_t nvariables;
        ngx_str_t name;
} ngx_nsoc_regex_t;

typedef struct {
        ngx_nsoc_regex_t *regex;
        void *value;
} ngx_nsoc_map_regex_t;

ngx_nsoc_regex_t *ngx_nsoc_regex_compile(ngx_conf_t *cf,
        ngx_regex_compile_t *rc);
ngx_int_t ngx_nsoc_regex_exec(ngx_nsoc_session_t *s,
        ngx_nsoc_regex_t *re, ngx_str_t *str);

#endif

typedef struct {
        ngx_hash_combined_t hash;
#if (NGX_PCRE)
        ngx_nsoc_map_regex_t *regex;
        ngx_uint_t nregex;
#endif
} ngx_nsoc_map_t;

void *ngx_nsoc_map_find(ngx_nsoc_session_t *s,
        ngx_nsoc_map_t *map, ngx_str_t *match);

ngx_int_t ngx_nsoc_variables_add_core_vars(ngx_conf_t *cf);
ngx_int_t ngx_nsoc_variables_init_vars(ngx_conf_t *cf);

extern ngx_nsoc_variable_value_t ngx_nsoc_variable_null_value;
extern ngx_nsoc_variable_value_t ngx_nsoc_variable_true_value;

#endif /* _NGX_NSOC_VARIABLES_H_INCLUDED_ */