1 /*
2   Copyright(C) 2009-2017 Brazil
3   Copyright(C) 2019 Sutou Kouhei <kou@clear-code.com>
4 
5   This library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9 
10   This library is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   Lesser General Public License for more details.
14 
15   You should have received a copy of the GNU Lesser General Public
16   License along with this library; if not, write to the Free Software
17   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18 */
19 module groonga_d.expr;
20 
21 
22 private static import groonga_d.groonga;
23 
24 extern(C):
25 nothrow @nogc:
26 
27 alias grn_expr_flags = uint;
28 
29 enum GRN_EXPR_SYNTAX_QUERY = 0x00;
30 enum GRN_EXPR_SYNTAX_SCRIPT = 0x01;
31 enum GRN_EXPR_SYNTAX_OUTPUT_COLUMNS = 0x20;
32 enum GRN_EXPR_SYNTAX_ADJUSTER = 0x40;
33 enum GRN_EXPR_ALLOW_PRAGMA = 0x02;
34 enum GRN_EXPR_ALLOW_COLUMN = 0x04;
35 enum GRN_EXPR_ALLOW_UPDATE = 0x08;
36 enum GRN_EXPR_ALLOW_LEADING_NOT = 0x10;
37 enum GRN_EXPR_QUERY_NO_SYNTAX_ERROR = 0x80;
38 
39 //GRN_API
40 groonga_d.groonga.grn_obj* grn_expr_create(groonga_d.groonga.grn_ctx* ctx, const (char)* name, uint name_size);
41 
42 //GRN_API
43 groonga_d.groonga.grn_rc grn_expr_close(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);
44 
45 //GRN_API
46 groonga_d.groonga.grn_obj* grn_expr_add_var(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, const (char)* name, uint name_size);
47 
48 //GRN_API
49 groonga_d.groonga.grn_obj* grn_expr_get_var(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, const (char)* name, uint name_size);
50 
51 //GRN_API
52 groonga_d.groonga.grn_obj* grn_expr_get_var_by_offset(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, uint offset);
53 
54 //GRN_API
55 groonga_d.groonga.grn_rc grn_expr_clear_vars(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);
56 
57 //GRN_API
58 void grn_expr_take_obj(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* obj);
59 
60 //GRN_API
61 groonga_d.groonga.grn_obj* grn_expr_append_obj(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* obj, groonga_d.groonga.grn_operator op, int nargs);
62 
63 //GRN_API
64 groonga_d.groonga.grn_obj* grn_expr_append_const(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* obj, groonga_d.groonga.grn_operator op, int nargs);
65 
66 //GRN_API
67 groonga_d.groonga.grn_obj* grn_expr_append_const_str(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, const (char)* str, uint str_size, groonga_d.groonga.grn_operator op, int nargs);
68 
69 //GRN_API
70 groonga_d.groonga.grn_obj* grn_expr_append_const_int(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, int i, groonga_d.groonga.grn_operator op, int nargs);
71 
72 //GRN_API
73 groonga_d.groonga.grn_obj* grn_expr_append_const_bool(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, ubyte value, groonga_d.groonga.grn_operator op, int nargs);
74 
75 //GRN_API
76 groonga_d.groonga.grn_rc grn_expr_append_op(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_operator op, int nargs);
77 
78 //GRN_API
79 groonga_d.groonga.grn_rc grn_expr_get_keywords(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* keywords);
80 
81 //GRN_API
82 groonga_d.groonga.grn_rc grn_expr_syntax_escape(groonga_d.groonga.grn_ctx* ctx, const (char)* query, int query_size, const (char)* target_characters, char escape_character, groonga_d.groonga.grn_obj* escaped_query);
83 
84 //GRN_API
85 groonga_d.groonga.grn_rc grn_expr_syntax_escape_query(groonga_d.groonga.grn_ctx* ctx, const (char)* query, int query_size, groonga_d.groonga.grn_obj* escaped_query);
86 
87 //GRN_API
88 groonga_d.groonga.grn_rc grn_expr_syntax_expand_query(groonga_d.groonga.grn_ctx* ctx, const (char)* query, int query_size, grn_expr_flags flags, groonga_d.groonga.grn_obj* expander, groonga_d.groonga.grn_obj* expanded_query);
89 
90 //GRN_API
91 groonga_d.groonga.grn_rc grn_expr_syntax_expand_query_by_table(groonga_d.groonga.grn_ctx* ctx, const (char)* query, int query_size, grn_expr_flags flags, groonga_d.groonga.grn_obj* term_column, groonga_d.groonga.grn_obj* expanded_term_column, groonga_d.groonga.grn_obj* expanded_query);
92 
93 //GRN_API
94 groonga_d.groonga.grn_rc grn_expr_compile(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);
95 
96 //GRN_API
97 groonga_d.groonga.grn_obj* grn_expr_rewrite(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);
98 
99 //GRN_API
100 groonga_d.groonga.grn_rc grn_expr_dump_plan(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* buffer);
101 
102 //GRN_API
103 groonga_d.groonga.grn_obj* grn_expr_exec(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, int nargs);
104 
105 //GRN_API
106 groonga_d.groonga.grn_obj* grn_expr_alloc(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, uint domain, ubyte flags);
107 
108 /+
109 #define GRN_EXPR_CREATE_FOR_QUERY(ctx, table, expr, var) if (((expr) = grn_expr_create((ctx), null, 0)) && ((var) = grn_expr_add_var((ctx), (expr), null, 0))) { groonga_d.groonga.GRN_RECORD_INIT((var), 0, grn_obj_id((ctx), (table))); } else { (var) = null; }
110 +/
111 
112 //GRN_API
113 groonga_d.groonga.grn_rc grn_expr_parse(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, const (char)* str, uint str_size, groonga_d.groonga.grn_obj* default_column, groonga_d.groonga.grn_operator default_mode, groonga_d.groonga.grn_operator default_op, grn_expr_flags flags);
114 
115 //GRN_API
116 groonga_d.groonga.grn_obj* grn_expr_snip(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, int flags, uint width, uint max_results, uint n_tags, const (char)** opentags, uint* opentag_lens, const (char)** closetags, uint* closetag_lens, groonga_d.groonga.grn_snip_mapping* mapping);
117 
118 //GRN_API
119 groonga_d.groonga.grn_rc grn_expr_snip_add_conditions(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* snip, uint n_tags, const (char)** opentags, uint* opentag_lens, const (char)** closetags, uint* closetag_lens);
120 
121 //GRN_API
122 uint grn_expr_estimate_size(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);
123 
124 
125 //GRN_API
126 groonga_d.groonga.grn_rc grn_expr_set_query_log_tag_prefix(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, const (char)* prefix, int prefix_len);
127 
128 //GRN_API
129 const (char)* grn_expr_get_query_log_tag_prefix(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);
130 
131 //GRN_API
132 groonga_d.groonga.grn_rc grn_expr_set_parent(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* parent);
133 
134 //GRN_API
135 groonga_d.groonga.grn_obj* grn_expr_get_parent(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr);