/home/dcp1990/prog/fakedbfs/include/fakedbfs/fficl.h File Reference

fakedbfs ficl bindings. More...

#include <fakedbfs/types.h>
#include <ficl.h>

Go to the source code of this file.

Classes
struct	_ficlplug
Functions
int	fdbfs_ficl_init (fdbfs_t *f)
	Initialise ficl subsystem.
void	fdbfs_ficl_destroy (fdbfs_t *f)
	Destroy ficl subsystem.
int	fdbfs_ficl_addwords (fdbfs_t *f, ficlDictionary *dict)
	Add words to ficl system dictionary.
int	fdbfs_ficl_p_check_file (ficlplug_t *fpl, const char *filename, char **errmsg)
	Check plugin for file compatibility using ficl subsystem.
int	fdbfs_ficl_p_init (ficlplug_t *fpl, char **errmsg)
	Initialise ficl plugin.
int	fdbfs_ficl_p_shutdown (ficlplug_t *fpl, char **errmsg)
	Shutdown ficl plugin.
fields_t *	fdbfs_ficl_p_extract_from_file (ficlplug_t *fpl, const char *filename, char **errmsg)
	Extract metedata using ficl plugin.
Plugin *	fdbfs_ficl_load_ficlplugin (fdbfs_t *f, const char *plugfile)
	Load ficlplugin and return a Plugin object.

---

Detailed Description

fakedbfs ficl bindings.

---

Function Documentation

int fdbfs_ficl_addwords (  fdbfs_t *  f, ficlDictionary *  dict )

Add words to ficl system dictionary. Parameters: f  Instance of fakedbfs. dict  Dictionary to add to. Returns: 0 on error.

void fdbfs_ficl_destroy (  fdbfs_t *  f  )

Destroy ficl subsystem. Parameters: f  Instance of fakedbfs.

int fdbfs_ficl_init (  fdbfs_t *  f  )

Initialise ficl subsystem. Creates a new ficlSystem. Parameters: f  Instance of fakedbfs. Returns: 0 on error.

struct Plugin* fdbfs_ficl_load_ficlplugin (  fdbfs_t *  f, const char *  plugfile )

Load ficlplugin and return a Plugin object. Parses the ficl plugin in the specified filename. Parameters: f  Fakedbfs instance. plugfile  Filename to parse. Returns: Plugin object describing the plugin, or NULL on error.

int fdbfs_ficl_p_check_file (  ficlplug_t *  fpl, const char *  filename, char **  errmsg )

Check plugin for file compatibility using ficl subsystem. Ficl analogue to (struct Plugin).check_file(). Parameters: fpl  ficlplug_t object to operate on. filename  Filename to check. errmsg  Pointer to char* that will be set to error message on error. Return values: -1  Error occured. Examine and free *errmsg. 0  Doesn't match. 1  Matches...this plugin is compatibile with this file.

fields_t* fdbfs_ficl_p_extract_from_file (  ficlplug_t *  fpl, const char *  filename, char **  errmsg )

Extract metedata using ficl plugin. Analogous to (struct Plugin).extract_from_file(). Parameters: fpl  ficlplug_t object to operate on. filename  Filename to extract from. errmsg  Pointer to char* that will be set to error message on error. Returns: List of fields_t for the specified file, or NULL on error (examine and free *errmsg).

int fdbfs_ficl_p_init (  ficlplug_t *  fpl, char **  errmsg )

Initialise ficl plugin. The usefulness of this is questionable, but... Parameters: fpl  ficlplug_t object to operate on. errmsg  Pointer to char* that will be set to error message on error. Returns: 0 on error (examine and free *errmsg).

int fdbfs_ficl_p_shutdown (  ficlplug_t *  fpl, char **  errmsg )

Shutdown ficl plugin. Analogous to (struct Plugin).shutdown(). Parameters: fpl  ficlplug_t to operate on. errmsg  Pointer to char* that will be set to error message on error. Returns: 0 on error (examine and free *errmsg).

---