ob_plugin_ftparser.h

浏览该文件的文档.

/*
 * Copyright (c) 2023 OceanBase
 * OceanBase is licensed under Mulan PubL v2.
 * You can use this software according to the terms and conditions of the Mulan PubL v2.
 * You may obtain a copy of Mulan PubL v2 at:
 *          http://license.coscl.org.cn/MulanPubL-2.0
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PubL v2 for more details.
 */
 
#pragma once
 
#include "oceanbase/ob_plugin.h"
#include "oceanbase/ob_plugin_charset_info.h"
 
#define OBP_FTPARSER_INTERFACE_VERSION OBP_MAKE_VERSION(0, 1, 0)
 
#define OBP_FTPARSER_INTERFACE_VERSION_0_2_0 OBP_MAKE_VERSION(0, 2, 0)
 
#define OBP_FTPARSER_INTERFACE_VERSION_CURRENT OBP_FTPARSER_INTERFACE_VERSION_0_2_0
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef ObPluginDatum ObPluginFTParserParamPtr;
 
enum ObPluginFTPaserAddWordFlag
{
  OBP_FTPARSER_AWF_NONE           = 0LL,
 
  OBP_FTPARSER_AWF_MIN_MAX_WORD   = 1LL << 0,
 
  OBP_FTPARSER_AWF_STOPWORD       = 1LL << 1,
 
  OBP_FTPARSER_AWF_CASEDOWN       = 1LL << 2,
 
  OBP_FTPARSER_AWF_GROUPBY_WORD   = 1LL << 3,
};
 
struct OBP_PUBLIC_API ObPluginFTParser
{
  int (*init)(ObPluginParamPtr param);
 
  int (*deinit)(ObPluginParamPtr param);
 
  int (*scan_begin)(ObPluginFTParserParamPtr param);   
  int (*scan_end)(ObPluginFTParserParamPtr param);     
  int (*next_token)(ObPluginFTParserParamPtr param, char **word, int64_t *word_len, int64_t *char_cnt, int64_t *word_freq);
 
  int (*get_add_word_flag)(uint64_t *flag);
 
  int (*check_if_charset_supported)(ObPluginCharsetInfoPtr cs);
};
 
OBP_PUBLIC_API uint64_t obp_ftparser_parser_version(ObPluginFTParserParamPtr param);
 
OBP_PUBLIC_API const char * obp_ftparser_fulltext(ObPluginFTParserParamPtr param);
 
OBP_PUBLIC_API int64_t obp_ftparser_fulltext_length(ObPluginFTParserParamPtr param);
 
OBP_PUBLIC_API ObPluginCharsetInfoPtr obp_ftparser_charset_info(ObPluginFTParserParamPtr param);
 
OBP_PUBLIC_API ObPluginParamPtr obp_ftparser_plugin_param(ObPluginFTParserParamPtr param);
 
OBP_PUBLIC_API ObPluginDatum obp_ftparser_user_data(ObPluginFTParserParamPtr param);
 
OBP_PUBLIC_API void obp_ftparser_set_user_data(ObPluginFTParserParamPtr param, ObPluginDatum user_data);
 
OBP_PUBLIC_API int obp_register_plugin_ftparser(ObPluginParamPtr param,
                                                const char *name,
                                                ObPluginVersion version,
                                                ObPluginFTParser *ftparser,
                                                int64_t ftparser_sizeof,
                                                const char *description);
 
#define OBP_REGISTER_FTPARSER(param, name, descriptor, description)    \
  obp_register_plugin_ftparser(param,                                  \
                               name,                                   \
                               OBP_FTPARSER_INTERFACE_VERSION_CURRENT, \
                               &descriptor,                            \
                               (int64_t)sizeof(descriptor),            \
                               description);
 
#ifdef __cplusplus
} // extern "C"
#endif