#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/misc.h>
#include <gwenhywfar/misc2.h>
#include <gwenhywfar/xml.h>

Include dependency graph for plugindescr.h:

Typedefs
typedef struct GWEN_PLUGIN_DESCRIPTION	GWEN_PLUGIN_DESCRIPTION

Functions
GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION_LIST2 *	GWEN_LoadPluginDescrs (const char *path)

GWENHYWFAR_API int	GWEN_LoadPluginDescrsByType (const char path, const char type, GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl)

GWENHYWFAR_API void	GWEN_PluginDescription_Attach (GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION *	GWEN_PluginDescription_dup (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API void	GWEN_PluginDescription_free (GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetAuthor (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetFileName (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetLongDescr (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API GWEN_DEPRECATED int	GWEN_PluginDescription_GetLongDescrByFormat (const GWEN_PLUGIN_DESCRIPTION pd, const char s, GWEN_BUFFER *buf)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetName (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetPath (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetShortDescr (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetType (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API const char *	GWEN_PluginDescription_GetVersion (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API GWEN_XMLNODE *	GWEN_PluginDescription_GetXmlNode (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API int	GWEN_PluginDescription_IsActive (const GWEN_PLUGIN_DESCRIPTION *pd)

GWENHYWFAR_API void	GWEN_PluginDescription_List2_freeAll (GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl)

GWENHYWFAR_API void	GWEN_PluginDescription_SetFileName (GWEN_PLUGIN_DESCRIPTION pd, const char s)

GWENHYWFAR_API void	GWEN_PluginDescription_SetIsActive (GWEN_PLUGIN_DESCRIPTION *pd, int i)

GWENHYWFAR_API void	GWEN_PluginDescription_SetPath (GWEN_PLUGIN_DESCRIPTION pd, const char s)

Typedef Documentation

◆ GWEN_PLUGIN_DESCRIPTION

typedef struct GWEN_PLUGIN_DESCRIPTION GWEN_PLUGIN_DESCRIPTION

Definition at line 41 of file plugindescr.h.

Function Documentation

◆ GWEN_LoadPluginDescrs()

GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION_LIST2 * GWEN_LoadPluginDescrs ( const char * path )

Definition at line 420 of file plugindescr.c.

References GWEN_LoadPluginDescrsByType(), GWEN_PluginDescription_List2_free(), GWEN_PluginDescription_List2_GetSize(), and GWEN_PluginDescription_List2_new().

Here is the call graph for this function:

◆ GWEN_LoadPluginDescrsByType()

GWENHYWFAR_API int GWEN_LoadPluginDescrsByType	(	const char *	path,
		const char *	type,
		GWEN_PLUGIN_DESCRIPTION_LIST2 *	pdl
	)

Loads a list of plugins descriptions. When parsing the description files entries for the current language will be selected. The current language can be set via GWEN_I18N_SetLocale.

Parameters

path	folder to search for XML files
type	plugin type (property "type" of tag "plugin")
pdl	plugin descriptions list2 to load descriptions to

Definition at line 452 of file plugindescr.c.

References DBG_DEBUG, DBG_ERROR, DBG_INFO, DBG_WARN, GWEN_Buffer_AppendByte(), GWEN_Buffer_AppendString(), GWEN_Buffer_Crop(), GWEN_Buffer_free(), GWEN_Buffer_GetStart(), GWEN_Buffer_GetUsedBytes(), GWEN_Buffer_new(), GWEN_Buffer_SetPos(), GWEN_DIR_SEPARATOR, GWEN_Directory_Close(), GWEN_Directory_free(), GWEN_Directory_new(), GWEN_Directory_Open(), GWEN_Directory_Read(), GWEN_I18N_GetCurrentLocaleList(), GWEN_LOGDOMAIN, GWEN_PluginDescription_List2_PushBack(), GWEN_PluginDescription_new(), GWEN_PluginDescription_SetFileName(), GWEN_PluginDescription_SetPath(), GWEN_StringList_FirstEntry(), GWEN_StringListEntry_Data(), GWEN_StringListEntry_Next(), GWEN_XML_FLAGS_DEFAULT, GWEN_XML_FLAGS_HANDLE_HEADERS, GWEN_XML_FLAGS_HANDLE_OPEN_HTMLTAGS, GWEN_XML_ReadFile(), GWEN_XMLNode_FindFirstTag(), GWEN_XMLNode_free(), GWEN_XMLNode_GetProperty(), GWEN_XMLNode_new(), and GWEN_XMLNodeTypeTag.

Referenced by GWEN_LoadPluginDescrs(), and GWEN_PluginManager_GetPluginDescrs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GWEN_PluginDescription_Attach()

GWENHYWFAR_API void GWEN_PluginDescription_Attach ( GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 134 of file plugindescr.c.

◆ GWEN_PluginDescription_dup()

GWENHYWFAR_API GWEN_PLUGIN_DESCRIPTION * GWEN_PluginDescription_dup ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 143 of file plugindescr.c.

References DBG_MEM_INC, GWEN_LIST_INIT, GWEN_NEW_OBJECT, and GWEN_XMLNode_dup().

Referenced by GWEN_Crypt_Token_PluginManager_GetPluginDescrs(), and GWEN_PluginManager_GetPluginDescr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GWEN_PluginDescription_free()

GWENHYWFAR_API void GWEN_PluginDescription_free ( GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 107 of file plugindescr.c.

References DBG_MEM_DEC, GWEN_FREE_OBJECT, GWEN_LIST_FINI, and GWEN_XMLNode_free().

Referenced by GWEN_PluginDescription_List2_freeAll_cb(), and GWEN_PluginDescription_new().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GWEN_PluginDescription_GetAuthor()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetAuthor ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 256 of file plugindescr.c.

◆ GWEN_PluginDescription_GetFileName()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetFileName ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 391 of file plugindescr.c.

◆ GWEN_PluginDescription_GetLongDescr()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetLongDescr ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 272 of file plugindescr.c.

References GWEN_I18N_Translate().

Here is the call graph for this function:

◆ GWEN_PluginDescription_GetLongDescrByFormat()

GWENHYWFAR_API GWEN_DEPRECATED int GWEN_PluginDescription_GetLongDescrByFormat	(	const GWEN_PLUGIN_DESCRIPTION *	pd,
		const char *	s,
		GWEN_BUFFER *	buf
	)

Seeks for a long description with the given format and the currently selected locale and appends it to the data in the given buffer.

The DESCR tag of the plugin description is expected to contain sub tags named TEXT with the property "FORMAT" describing the format and "LANG" containing the language of the element.

Currently supported format is "html".

Returns: 0 if ok, !=0 on error

Parameters

pd	plugin description
s	name of the format (e.g. html)
buf	buffer to append the description to

Definition at line 349 of file plugindescr.c.

References DBG_INFO, DBG_NOTICE, GWEN_I18N_GetCurrentLocaleList(), GWEN_LOGDOMAIN, GWEN_PluginDescription__GetLocalizedLongDescrByFormat(), GWEN_PluginDescription__GetLongDescrByFormat(), GWEN_StringList_FirstEntry(), GWEN_StringListEntry_Data(), and GWEN_StringListEntry_Next().

Here is the call graph for this function:

◆ GWEN_PluginDescription_GetName()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetName ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 232 of file plugindescr.c.

Referenced by GWEN_Crypt_Token_PluginManager_CheckToken(), and GWEN_PluginManager_GetPluginDescr().

Here is the caller graph for this function:

◆ GWEN_PluginDescription_GetPath()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetPath ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 211 of file plugindescr.c.

◆ GWEN_PluginDescription_GetShortDescr()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetShortDescr ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 248 of file plugindescr.c.

References GWEN_I18N_Translate().

Here is the call graph for this function:

◆ GWEN_PluginDescription_GetType()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetType ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 240 of file plugindescr.c.

◆ GWEN_PluginDescription_GetVersion()

GWENHYWFAR_API const char * GWEN_PluginDescription_GetVersion ( const GWEN_PLUGIN_DESCRIPTION * pd )

Definition at line 264 of file plugindescr.c.

◆ GWEN_PluginDescription_GetXmlNode()

GWENHYWFAR_API GWEN_XMLNODE * GWEN_PluginDescription_GetXmlNode ( const GWEN_PLUGIN_DESCRIPTION * pd )

Returns the XML node this description consists of (the "plugin" node). It may contain additional information used by programs. This function does not relinquish ownership of the returned pointer, so you MUST NOT free it. As soon as the description itself is destroyed this XML node will be, too. So you have to call GWEN_XMLNode_dup() if you want the XML node to survive the description.

Definition at line 412 of file plugindescr.c.

Referenced by GWEN_Crypt_Token_PluginManager_CheckToken(), and GWEN_Crypt_Token_PluginManager_GetPluginDescrs().

Here is the caller graph for this function: