Main Page | Data Structures | File List | Data Fields | Globals

plugins_macros.h File Reference

#include "cuf-global.h"

Go to the source code of this file.

Defines

#define ptnstr
#define plugin_register()
#define PLUGIN_STRUCT
#define PLUGIN_FUNC_INFO
#define PLUGIN_STD
#define PCAddBool(n, d, def)
#define PCAddChar(n, d, def)
#define PCAddNum(n, d, t, min, max, s, def)
#define PCAddString(n, d, def)
#define PCAddEnum(n, d, l, def)
#define pcdg(n, t)
#define pcdgs(n)   ((char *)plugin_config_data_get (PLUGIN_CONFS_NUM, PLUGIN_CONFS, n))


Detailed Description

Helping macros for plugins.

Please see the example plugin for exact use of these macros.


Define Documentation

#define PCAddBool n,
d,
def   ) 
 

Parameters:
n The name of the configuration option.
d The description of the configuration option.
def The default setting.
Description:
A simplifyed macro for adding a boolean configuration option.

#define PCAddChar n,
d,
def   ) 
 

Parameters:
n The name of the configuration option.
d The description of the configuration option.
def The default setting.
Description:
A simplifyed macro for adding a character configuration option.

#define PCAddEnum n,
d,
l,
def   ) 
 

Parameters:
n The name of the configuration option.
d The description of the configuration option.
l A comma seprated list of allowed options.
def The default setting.
Description:
A simplifyed macro for adding a enumerated list configuration option.
Note:
This option must be strings.

#define PCAddNum n,
d,
t,
min,
max,
s,
def   ) 
 

Parameters:
n The name of the configuration option.
d The description of the configuration option.
t The data type, same as the PConf<*> types with out the 'PConf'.
min The minimum allowed value.
max The maximum allowed value.
s The stepping value.
def The default setting.
Description:
A simplifyed macro for adding a number configuration option.

#define PCAddString n,
d,
def   ) 
 

Parameters:
n The name of the configuration option.
d The description of the configuration option.
def The default setting.
Description:
A simplifyed macro for adding a string configuration option.

#define pcdg n,
 ) 
 

Parameters:
n The name of the configuration option.
t The expected data type.
Description:
For use in the plugin source its self. A reduced way to get the configuration data.
See also:
plugin_config_data_get

#define pcdgs  )     ((char *)plugin_config_data_get (PLUGIN_CONFS_NUM, PLUGIN_CONFS, n))
 

Data get specificly for strings

#define PLUGIN_FUNC_INFO
 

Description:
Plugin info function helping macro. Use inside the plugin code its self.

 
#define plugin_register  ) 
 

Description:
This calls the function plugin_register_type with the correct information.

You must first define PLUGIN_TYPE_NAME and PLUGIN_TYPE_DESC.

#define PLUGIN_STD
 

Description:
Plugin standard calls helping macro. Use inside the plugin code its self.

#define PLUGIN_STRUCT
 

Description:
Plugin structure helping macro. Use inside the plugin code its self.

#define ptnstr
 

Description:
This simplifies using the plugin type name as a string.

You must first define PLUGIN_TYPE_NAME.


Generated on Fri Jun 4 18:35:20 2004 for cuf by doxygen 1.3.6