ob_plugin.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_base.h"
#include "oceanbase/ob_plugin_errno.h"
#include "oceanbase/ob_plugin_log.h"
#include "oceanbase/ob_plugin_allocator.h"
 
/* @{ */
 
#define OBP_AUTHOR_OCEANBASE "OceanBase Corporation"
 
#define OBP_PLUGIN_API_VERSION OBP_MAKE_VERSION(0, 1, 0)
#define OBP_PLUGIN_API_VERSION_CURRENT OBP_PLUGIN_API_VERSION
 
#ifdef OBP_DYNAMIC_PLUGIN
#define OBP_DECLARE_PLUGIN_(name)                                                                       \
  OBP_PLUGIN_EXPORT const char *OBP_DYNAMIC_PLUGIN_NAME_VAR = OBP_STRINGIZE(name);                      \
  OBP_PLUGIN_EXPORT int64_t OBP_DYNAMIC_PLUGIN_API_VERSION_VAR = OBP_PLUGIN_API_VERSION_CURRENT;        \
  OBP_PLUGIN_EXPORT const char *OBP_DYNAMIC_PLUGIN_BUILD_REVISION_VAR = OBP_BUILD_REVISION;             \
  OBP_PLUGIN_EXPORT const char *OBP_DYNAMIC_PLUGIN_BUILD_BRANCH_VAR = OBP_BUILD_BRANCH;                 \
  OBP_PLUGIN_EXPORT const char *OBP_DYNAMIC_PLUGIN_BUILD_DATE_VAR = OBP_BUILD_DATE;                     \
  OBP_PLUGIN_EXPORT const char *OBP_DYNAMIC_PLUGIN_BUILD_TIME_VAR = OBP_BUILD_TIME;                     \
  OBP_PLUGIN_EXPORT int64_t OBP_DYNAMIC_PLUGIN_SIZEOF_VAR = sizeof(struct _ObPlugin);                   \
  OBP_PLUGIN_EXPORT ObPlugin OBP_DYNAMIC_PLUGIN_PLUGIN_VAR =
 
#else /* OBP_DYNAMIC_PLUGIN */
 
#define OBP_DECLARE_PLUGIN_(name)                                         \
  OBP_PLUGIN_EXPORT ObPlugin OBP_BUILTIN_PLUGIN_VAR(name) =
 
#endif /* OBP_DYNAMIC_PLUGIN */
 
#define OBP_DECLARE_PLUGIN(name) \
  OBP_DECLARE_PLUGIN_(name)
 
#define OBP_DECLARE_PLUGIN_END
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef ObPluginDatum ObPluginParamPtr;
 
enum OBP_PUBLIC_API ObPluginType
{
  OBP_PLUGIN_TYPE_INVALID = 0,
  OBP_PLUGIN_TYPE_FT_PARSER,   
  OBP_PLUGIN_TYPE_EXTERNAL,    
  OBP_PLUGIN_TYPE_MAX,         
};
 
#define OBP_LICENSE_GPL           "GPL"
#define OBP_LICENSE_BSD           "BSD"
#define OBP_LICENSE_MIT           "MIT"
#define OBP_LICENSE_APACHE_V2     "Apache 2.0"
#define OBP_LICENSE_MULAN_PUBL_V2 "Mulan PubL v2"
#define OBP_LICENSE_MULAN_PSL_V2  "Mulan PSL v2"
 
typedef uint64_t ObPluginVersion;
 
#define OBP_MAKE_VERSION(major, minor, patch) \
  ((major) * OBP_VERSION_FIELD_NUMBER * OBP_VERSION_FIELD_NUMBER + (minor) * OBP_VERSION_FIELD_NUMBER + (patch))
 
struct OBP_PUBLIC_API _ObPlugin
{
  const char *        author;
  ObPluginVersion     version;      
  const char *        license;      
  int (*init) (ObPluginParamPtr param);
 
  int (*deinit)(ObPluginParamPtr param);
};
 
typedef struct _ObPlugin ObPlugin;
 
OBP_PUBLIC_API ObPlugin *obp_param_plugin(ObPluginParamPtr param);
 
OBP_PUBLIC_API ObPluginDatum obp_param_plugin_user_data(ObPluginParamPtr param);
 
OBP_PUBLIC_API void obp_param_set_plugin_user_data(ObPluginParamPtr param, ObPluginDatum plugin_spec);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
/* @} */