_MSPlugin Struct Reference

The struct, each plugin should fill. More...

#include <plugin.h>

Data Fields
int	_enabled
int(*	axioms )(Statement **axioms, void *private_data)
	Function that should return initial axioms needed for the plugin.
int(*	cleanup )(void **private_data)
	Ask plugin to clean up its data.
const char *	description
	plugin description
int(*	dump )(FILE *stream, void *private_data)
	Ask plugin to dump its state.
int(*	get_functions )(PluginFunc **funcs, int *count)
	Returns function list, exported by this plugin.
const char *	id
	plugin node id
unsigned int	magic
const char *	name
	plugin name
int(*	post_init )(ModelStorageEnv *env, void *private_data)
	Optional function calld after initializing of env.
int	prio
	Plugin priority of execution For user-level plugins priority range from 0 to 10000 should be used.
void *	private_data
int(*	restore )(unsigned int magic, FILE *stream, void **private_data)
	Ask plugin to restore its state.
const char *	vendor
	plugin vendor
const char *	version
	plugin version
int	vital
	If non-zero, the plugin is threated as unpluggable.

---

Detailed Description

The struct, each plugin should fill.

This struct should be filled by plugin and returned in plug_initialize() function.

---

Field Documentation

int _MSPlugin::_enabled

int(* _MSPlugin::axioms)(Statement **axioms, void *private_data)

Function that should return initial axioms needed for the plugin. Called once just after plugin initialization.

int(* _MSPlugin::cleanup)(void **private_data)

Ask plugin to clean up its data. Called before plugin unloading.

const char* _MSPlugin::description

plugin description

int(* _MSPlugin::dump)(FILE *stream, void *private_data)

Ask plugin to dump its state.

int(* _MSPlugin::get_functions)(PluginFunc **funcs, int *count)

Returns function list, exported by this plugin.

const char* _MSPlugin::id

plugin node id

unsigned int _MSPlugin::magic

const char* _MSPlugin::name

plugin name

int(* _MSPlugin::post_init)(ModelStorageEnv *env, void *private_data)

Optional function calld after initializing of env.

int _MSPlugin::prio

Plugin priority of execution For user-level plugins priority range from 0 to 10000 should be used. priorities with values < 0 and > 10000 are system.

void* _MSPlugin::private_data

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

Ask plugin to restore its state. Plugin must check for correct magic before restoring. Returns zero if magic not coincide, negative for error and positive for success;

const char* _MSPlugin::vendor

plugin vendor

const char* _MSPlugin::version

plugin version

int _MSPlugin::vital

If non-zero, the plugin is threated as unpluggable.

---

The documentation for this struct was generated from the following file:

• plugin.h

---