nugu_plugin.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NUGU_PLUGIN_H__
#define __NUGU_PLUGIN_H__
 
#include <nugu.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NUGU_PLUGIN_PRIORITY_HIGH 10
 
#define NUGU_PLUGIN_PRIORITY_DEFAULT 100
 
#define NUGU_PLUGIN_PRIORITY_LOW 900
 
#define NUGU_PLUGIN_SYMBOL "nugu_plugin_define_desc"
 
#ifdef NUGU_PLUGIN_BUILTIN
#define NUGU_PLUGIN_DEFINE(p_name, p_prio, p_ver, p_load, p_unload, p_init)    \
        NUGU_API_EXPORT struct nugu_plugin_desc _builtin_plugin_##p_name = {   \
                .name = #p_name,                                               \
                .priority = p_prio,                                            \
                .version = p_ver,                                              \
                .load = p_load,                                                \
                .unload = p_unload,                                            \
                .init = p_init                                                 \
        }
#else
#define NUGU_PLUGIN_DEFINE(p_name, p_prio, p_ver, p_load, p_unload, p_init)    \
        NUGU_API_EXPORT struct nugu_plugin_desc nugu_plugin_define_desc = {    \
                .name = #p_name,                                               \
                .priority = p_prio,                                            \
                .version = p_ver,                                              \
                .load = p_load,                                                \
                .unload = p_unload,                                            \
                .init = p_init                                                 \
        }
#endif
 
typedef struct _plugin NuguPlugin;
 
struct nugu_plugin_desc {
        const char *name;
 
        unsigned int priority;
 
        const char *version;
 
        int (*load)(void);
 
        void (*unload)(NuguPlugin *p);
 
        int (*init)(NuguPlugin *p);
};
 
NUGU_API NuguPlugin *nugu_plugin_new(struct nugu_plugin_desc *desc);
 
NUGU_API NuguPlugin *nugu_plugin_new_from_file(const char *filepath);
 
NUGU_API void nugu_plugin_free(NuguPlugin *p);
 
NUGU_API int nugu_plugin_add(NuguPlugin *p);
 
NUGU_API int nugu_plugin_remove(NuguPlugin *p);
 
NUGU_API NuguPlugin *nugu_plugin_find(const char *name);
 
NUGU_API int nugu_plugin_set_data(NuguPlugin *p, void *data);
 
NUGU_API void *nugu_plugin_get_data(NuguPlugin *p);
 
NUGU_API void *nugu_plugin_get_symbol(NuguPlugin *p, const char *symbol_name);
 
NUGU_API const struct nugu_plugin_desc *
nugu_plugin_get_description(NuguPlugin *p);
 
NUGU_API int nugu_plugin_load_directory(const char *dirpath);
 
NUGU_API int nugu_plugin_load_builtin(void);
 
NUGU_API int nugu_plugin_initialize(void);
 
NUGU_API void nugu_plugin_deinitialize(void);
 
#ifdef __cplusplus
}
#endif
 
#endif