1 /* 2 Copyright(C) 2009-2017 Brazil 3 Copyright(C) 2019-2021 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_SYNTAX_SORT_KEYS = 0x100; 34 /* Deprecated since Groonga 11.0.2. Use GRN_EXPR_SYNTAX_SORT_KEYS instead. */ 35 enum GRN_EXPR_SYNTAX_GROUP_KEYS = .GRN_EXPR_SYNTAX_SORT_KEYS; 36 enum GRN_EXPR_SYNTAX_OPTIONS = 0x200; 37 enum GRN_EXPR_ALLOW_PRAGMA = 0x02; 38 enum GRN_EXPR_ALLOW_COLUMN = 0x04; 39 enum GRN_EXPR_ALLOW_UPDATE = 0x08; 40 enum GRN_EXPR_ALLOW_LEADING_NOT = 0x10; 41 enum GRN_EXPR_QUERY_NO_SYNTAX_ERROR = 0x80; 42 43 //GRN_API 44 groonga_d.groonga.grn_obj* grn_expr_create(groonga_d.groonga.grn_ctx* ctx, const (char)* name, uint name_size); 45 46 //GRN_API 47 groonga_d.groonga.grn_rc grn_expr_close(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 48 49 //GRN_API 50 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); 51 52 //GRN_API 53 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); 54 55 //GRN_API 56 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); 57 58 //GRN_API 59 groonga_d.groonga.grn_rc grn_expr_clear_vars(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 60 61 //GRN_API 62 void grn_expr_take_obj(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* obj); 63 64 //GRN_API 65 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); 66 67 //GRN_API 68 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); 69 70 //GRN_API 71 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); 72 73 /* Deprecated since Groonga 11.0.1. Use grn_expr_append_const_int32() instead. */ 74 //GRN_API 75 deprecated 76 groonga_d.groonga.grn_obj* grn_expr_append_const_int(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, int value, groonga_d.groonga.grn_operator op, int nargs); 77 78 //GRN_API 79 groonga_d.groonga.grn_obj* grn_expr_append_const_int32(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, int value, groonga_d.groonga.grn_operator op, int nargs); 80 81 //GRN_API 82 groonga_d.groonga.grn_obj* grn_expr_append_const_float32(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, float value, groonga_d.groonga.grn_operator op, int nargs); 83 84 //GRN_API 85 groonga_d.groonga.grn_obj* grn_expr_append_const_float(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, double value, groonga_d.groonga.grn_operator op, int nargs); 86 87 //GRN_API 88 groonga_d.groonga.grn_obj* grn_expr_append_const_bool(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_bool value, groonga_d.groonga.grn_operator op, int nargs); 89 90 //GRN_API 91 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); 92 93 //GRN_API 94 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); 95 96 //GRN_API 97 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); 98 99 //GRN_API 100 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); 101 102 //GRN_API 103 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); 104 105 //GRN_API 106 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); 107 108 //GRN_API 109 groonga_d.groonga.grn_rc grn_expr_compile(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 110 111 //GRN_API 112 groonga_d.groonga.grn_obj* grn_expr_rewrite(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 113 114 //GRN_API 115 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); 116 117 //GRN_API 118 groonga_d.groonga.grn_obj* grn_expr_exec(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, int nargs); 119 120 //GRN_API 121 groonga_d.groonga.grn_obj* grn_expr_alloc(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_id domain, ubyte flags); 122 123 /+ 124 #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; } 125 +/ 126 127 //GRN_API 128 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); 129 130 //GRN_API 131 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); 132 133 //GRN_API 134 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); 135 136 //GRN_API 137 uint grn_expr_estimate_size(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 138 139 140 //GRN_API 141 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); 142 143 //GRN_API 144 const (char)* grn_expr_get_query_log_tag_prefix(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 145 146 //GRN_API 147 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); 148 149 //GRN_API 150 groonga_d.groonga.grn_obj* grn_expr_get_parent(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 151 152 //GRN_API 153 groonga_d.groonga.grn_rc grn_expr_set_condition(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr, groonga_d.groonga.grn_obj* condition); 154 155 //GRN_API 156 groonga_d.groonga.grn_obj* grn_expr_get_condition(groonga_d.groonga.grn_ctx* ctx, groonga_d.groonga.grn_obj* expr); 157