cpluff.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 * C-Pluff, a plug-in framework for C
 * Copyright 2007 Johannes Lehtinen
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *-----------------------------------------------------------------------*/

#ifndef CPLUFF_H_
#define CPLUFF_H_

#include <cpluffdef.h>

#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus*/


/* ------------------------------------------------------------------------
 * Defines
 * ----------------------------------------------------------------------*/

#ifndef CP_C_API
#define CP_C_API CP_IMPORT
#endif



#define CP_SP_UPGRADE 0x01

#define CP_SP_STOP_ALL_ON_UPGRADE 0x02

#define CP_SP_STOP_ALL_ON_INSTALL 0x04

#define CP_SP_RESTART_ACTIVE 0x08

/* ------------------------------------------------------------------------
 * Data types
 * ----------------------------------------------------------------------*/

/* Enumerations */

enum cp_status_t {

        CP_OK = 0,

        CP_ERR_RESOURCE,

        CP_ERR_UNKNOWN,

        CP_ERR_IO,

        CP_ERR_MALFORMED,

        CP_ERR_CONFLICT,

        CP_ERR_DEPENDENCY,

        CP_ERR_RUNTIME
        
};

enum cp_plugin_state_t {

        CP_PLUGIN_UNINSTALLED,
        
        CP_PLUGIN_INSTALLED,
        
        CP_PLUGIN_RESOLVED,
        
        CP_PLUGIN_STARTING,
        
        CP_PLUGIN_STOPPING,
        
        CP_PLUGIN_ACTIVE
        
};

enum cp_log_severity_t {

        CP_LOG_DEBUG,
        
        CP_LOG_INFO,
        
        CP_LOG_WARNING,
        
        CP_LOG_ERROR
        
};

/* Typedefs */

 
typedef struct cp_context_t cp_context_t;


typedef struct cp_plugin_info_t cp_plugin_info_t;

typedef struct cp_plugin_import_t cp_plugin_import_t;

typedef struct cp_ext_point_t cp_ext_point_t;

typedef struct cp_extension_t cp_extension_t;

typedef struct cp_cfg_element_t cp_cfg_element_t;

typedef struct cp_plugin_runtime_t cp_plugin_runtime_t;

typedef enum cp_status_t cp_status_t;

typedef enum cp_plugin_state_t cp_plugin_state_t;

typedef enum cp_log_severity_t cp_log_severity_t;


typedef void (*cp_plugin_listener_func_t)(const char *plugin_id, cp_plugin_state_t old_state, cp_plugin_state_t new_state, void *user_data);

typedef void (*cp_logger_func_t)(cp_log_severity_t severity, const char *msg, const char *apid, void *user_data);

typedef void (*cp_fatal_error_func_t)(const char *msg);

typedef int (*cp_run_func_t)(void *plugin_data);

/* Data structures */

struct cp_plugin_info_t {
        
        char *identifier;
        
        char *name;
        
        char *version;
        
        char *provider_name;
        
        char *plugin_path;
        
        char *abi_bw_compatibility;
        
        char *api_bw_compatibility;
        
        char *req_cpluff_version;
        
        unsigned int num_imports;
        
        cp_plugin_import_t *imports;

    char *runtime_lib_name;
    
    char *runtime_funcs_symbol;
    
        unsigned int num_ext_points;
        
        cp_ext_point_t *ext_points;
        
        unsigned int num_extensions;
        
        cp_extension_t *extensions;

};

struct cp_plugin_import_t {
        
        char *plugin_id;
        
        char *version;
        
        int optional;
};

struct cp_ext_point_t {

        cp_plugin_info_t *plugin;
        
        char *local_id;
        
        char *identifier;

        char *name;
        
        char *schema_path;
};

struct cp_extension_t {

        cp_plugin_info_t *plugin;
        
        char *ext_point_id;
        
        char *local_id;

    char *identifier;
         
        char *name;
        
        cp_cfg_element_t *configuration;
};

struct cp_cfg_element_t {
        
        char *name;

        unsigned int num_atts;
        
        char **atts;
        
        char *value;
        
        cp_cfg_element_t *parent;
        
        unsigned int index;
        
        unsigned int num_children;

        cp_cfg_element_t *children;
};

struct cp_plugin_runtime_t {

        void *(*create)(cp_context_t *ctx);

        int (*start)(void *data);
        
        void (*stop)(void *data);

        void (*destroy)(void *data);

};

/* ------------------------------------------------------------------------
 * Function declarations
 * ----------------------------------------------------------------------*/


CP_C_API const char *cp_get_version(void) CP_GCC_PURE;

CP_C_API const char *cp_get_host_type(void) CP_GCC_PURE;


CP_C_API void cp_set_fatal_error_handler(cp_fatal_error_func_t error_handler);

CP_C_API cp_status_t cp_init(void);

CP_C_API void cp_destroy(void);


CP_C_API cp_context_t * cp_create_context(cp_status_t *status);

CP_C_API void cp_destroy_context(cp_context_t *ctx) CP_GCC_NONNULL(1);

CP_C_API cp_status_t cp_register_pcollection(cp_context_t *ctx, const char *dir) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_unregister_pcollection(cp_context_t *ctx, const char *dir) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_unregister_pcollections(cp_context_t *ctx) CP_GCC_NONNULL(1);


CP_C_API cp_status_t cp_register_logger(cp_context_t *ctx, cp_logger_func_t logger, void *user_data, cp_log_severity_t min_severity) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_unregister_logger(cp_context_t *ctx, cp_logger_func_t logger) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_log(cp_context_t *ctx, cp_log_severity_t severity, const char *msg) CP_GCC_NONNULL(1, 3);

CP_C_API int cp_is_logged(cp_context_t *ctx, cp_log_severity_t severity) CP_GCC_NONNULL(1);


CP_C_API cp_plugin_info_t * cp_load_plugin_descriptor(cp_context_t *ctx, const char *path, cp_status_t *status) CP_GCC_NONNULL(1, 2);

CP_C_API cp_status_t cp_install_plugin(cp_context_t *ctx, cp_plugin_info_t *pi) CP_GCC_NONNULL(1, 2);

CP_C_API cp_status_t cp_scan_plugins(cp_context_t *ctx, int flags) CP_GCC_NONNULL(1);

CP_C_API cp_status_t cp_start_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);

CP_C_API cp_status_t cp_stop_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_stop_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);

CP_C_API cp_status_t cp_uninstall_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_uninstall_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);


CP_C_API cp_plugin_info_t * cp_get_plugin_info(cp_context_t *ctx, const char *id, cp_status_t *status) CP_GCC_NONNULL(1);

CP_C_API cp_plugin_info_t ** cp_get_plugins_info(cp_context_t *ctx, cp_status_t *status, int *num) CP_GCC_NONNULL(1);

CP_C_API cp_ext_point_t ** cp_get_ext_points_info(cp_context_t *ctx, cp_status_t *status, int *num) CP_GCC_NONNULL(1);

CP_C_API cp_extension_t ** cp_get_extensions_info(cp_context_t *ctx, const char *extpt_id, cp_status_t *status, int *num) CP_GCC_NONNULL(1);

CP_C_API void cp_release_info(cp_context_t *ctx, void *info) CP_GCC_NONNULL(1, 2);

CP_C_API cp_plugin_state_t cp_get_plugin_state(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);

CP_C_API cp_status_t cp_register_plistener(cp_context_t *ctx, cp_plugin_listener_func_t listener, void *user_data) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_unregister_plistener(cp_context_t *ctx, cp_plugin_listener_func_t listener) CP_GCC_NONNULL(1, 2);

CP_C_API cp_cfg_element_t * cp_lookup_cfg_element(cp_cfg_element_t *base, const char *path) CP_GCC_PURE CP_GCC_NONNULL(1, 2);

CP_C_API char * cp_lookup_cfg_value(cp_cfg_element_t *base, const char *path) CP_GCC_PURE CP_GCC_NONNULL(1, 2);


CP_C_API cp_status_t cp_run_function(cp_context_t *ctx, cp_run_func_t runfunc) CP_GCC_NONNULL(1, 2);

CP_C_API void cp_run_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);

CP_C_API int cp_run_plugins_step(cp_context_t *ctx) CP_GCC_NONNULL(1);

CP_C_API void cp_set_context_args(cp_context_t *ctx, char **argv) CP_GCC_NONNULL(1, 2);

CP_C_API char **cp_get_context_args(cp_context_t *ctx, int *argc) CP_GCC_NONNULL(1);


CP_C_API cp_status_t cp_define_symbol(cp_context_t *ctx, const char *name, void *ptr) CP_GCC_NONNULL(1, 2, 3);

CP_C_API void *cp_resolve_symbol(cp_context_t *ctx, const char *id, const char *name, cp_status_t *status) CP_GCC_NONNULL(1, 2, 3);

CP_C_API void cp_release_symbol(cp_context_t *ctx, const void *ptr) CP_GCC_NONNULL(1, 2);

#ifdef __cplusplus
}
#endif /*__cplusplus*/

#endif /*CPLUFF_H_*/

---

C-Pluff, a plug-in framework for C
Copyright 2007 Johannes Lehtinen

Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by  1.5.1