plugin.h

Go to the documentation of this file.

/**********************************************************************
 *
 * Verball Model Storage Library, Common Information Model Library 
 * for integration of Intelligent Services.
 * Copyright (C) 2005 Nikita Vinokurov, Orgway LLC.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; 
 * version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 
 * Boston, MA  02110-1301  USA
 *
 * $Id: plugin.h,v 1.25 2006/12/23 20:30:24 yagel Exp $
 **********************************************************************/


#ifndef _PLUGIN_H_
#define _PLUGIN_H_

#include "msint.h"
#include "stmt/simplelist.h"
#include "stmt/statement.h"


#if defined(_WIN32) || defined(__declspec)

#define PLUGIN_STORAGE_TYPE __declspec(dllexport)
#else
#define PLUGIN_STORAGE_TYPE extern
#endif

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


typedef struct _MSPlugin MSPlugin;
typedef struct _MSInstance MSInstance;
typedef struct _MSInterface MSInterface;
typedef struct _StmtList StmtList;
typedef struct _PluginFunc PluginFunc;

typedef enum {
    PLUGIN_TYPE_SETRULE,
    PLUGIN_TYPE_GETRULE,
    PLUGIN_TYPE_GETGENRULE,
    PLUGIN_TYPE_GETFILRULE,
    PLUGIN_TYPE_IFUNCTION,
    PLUGIN_TYPE_BEFORESETRULE,
    PLUGIN_TYPE_AFTERSETRULE,
    PLUGIN_TYPE_GETPOSTRULE,
    PLUGIN_TYPE_AFTERRESTORERULE,

} PluginFuncType;   


typedef enum {
    PLUGIN_RESP_CONTINUE,
    PLUGIN_RESP_STOP,
    PLUGIN_RESP_BLOCK,

} PluginResp;

typedef struct _PluginArg {

    ModelStorage *msi;
    MSTxn *txn;
    const Statement *mask;
    Statement *stmt;
    Statement *result;
    void *private_data;

    void *data;

} PluginArg;


struct _PluginFunc {
    MSPlugin *plugin;
    PluginFuncType type; 
    union {
        int (*BeforeSet)     (PluginArg * arg, PluginResp *resp);
        int (*AfterSet)      (PluginArg * arg, PluginResp *resp);
        int (*GetGenerate)   (PluginArg * arg, PluginResp *resp);
        int (*GetFilter)     (PluginArg * arg, PluginResp *resp);
        int (*GetPost)       (PluginArg * arg, PluginResp *resp);
        int (*AfterRestore)  (Statement *stmt, void *private_data);
    };
    int prio; 
    int enabled; 
};


struct _MSInterface {
    int (*ms_set_statement)    (MSInstance *msi, Statement *s);
    int (*ms_get_statements)   (MSInstance *msi, Statement *mask, StmtList *result);
    int (*ms_get_statements_ex)(MSInstance *msi, Statement *mask, StmtList *result, struct _PluginFunc *exclude);
    int (*ms_set_statement_ex) (MSInstance *msi, Statement *mask, StmtList *result, struct _PluginFunc *exclude);
    int (*ms_txn_begin)        (MSInstance *msi);
    int (*ms_txn_commit)       (MSInstance *msi);
    int (*ms_txn_rollback)     (MSInstance *msi); 

};


struct _MSPlugin {

    int (*axioms)(Statement **axioms, void *private_data);

    int (*post_init)(ModelStorageEnv *env, void *private_data);
    
    int (*get_functions)(PluginFunc **funcs, int *count);
    
    int (*cleanup)( void **private_data );

    int (*dump)(FILE *stream, void *private_data);

    int (*restore)(unsigned int magic, FILE *stream, void **private_data);
    

    int prio;
    unsigned int magic;
    const char *name;
    const char *description;
    const char *vendor;
    const char *version;
    const char *id;
    void *private_data;
    int vital; 
    int _enabled;


};


PLUGIN_STORAGE_TYPE MSPlugin plug_initialize(void);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif //_PLUGIN_H_

---