/usr/include/gwenhywfar4/gwenhywfar/plugindescr.h is in libgwenhywfar-core-dev 4.15.3-5+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | /***************************************************************************
$RCSfile$
-------------------
cvs : $Id$
begin : Fri Sep 12 2003
copyright : (C) 2003 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* *
* 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; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* 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., 59 Temple Place, Suite 330, Boston, *
* MA 02111-1307 USA *
* *
***************************************************************************/
#ifndef GWENHYWFAR_PLUGINDESCR_H
#define GWENHYWFAR_PLUGINDESCR_H
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/misc.h>
#include <gwenhywfar/misc2.h>
#include <gwenhywfar/xml.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct GWEN_PLUGIN_DESCRIPTION GWEN_PLUGIN_DESCRIPTION;
GWEN_LIST_FUNCTION_LIB_DEFS(GWEN_PLUGIN_DESCRIPTION, GWEN_PluginDescription, GWENHYWFAR_API)
GWEN_LIST2_FUNCTION_LIB_DEFS(GWEN_PLUGIN_DESCRIPTION, GWEN_PluginDescription, GWENHYWFAR_API)
/* Do not terminate these lines with semicolon because they are
macros, not functions, and ISO C89 does not allow a semicolon
there. */
GWENHYWFAR_API
void GWEN_PluginDescription_List2_freeAll(GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl);
GWENHYWFAR_API
GWEN_PLUGIN_DESCRIPTION_LIST2 *GWEN_LoadPluginDescrs(const char *path);
/**
* 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 @ref GWEN_I18N_SetLocale.
* @param path folder to search for XML files
* @param type plugin type (property "type" of tag "plugin")
* @param pdl plugin descriptions list2 to load descriptions to
*/
GWENHYWFAR_API
int GWEN_LoadPluginDescrsByType(const char *path,
const char *type,
GWEN_PLUGIN_DESCRIPTION_LIST2 *pdl);
GWENHYWFAR_API
void GWEN_PluginDescription_free(GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
GWEN_PLUGIN_DESCRIPTION*
GWEN_PluginDescription_dup(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
void GWEN_PluginDescription_Attach(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.
*/
GWENHYWFAR_API
GWEN_XMLNODE*
GWEN_PluginDescription_GetXmlNode(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char *GWEN_PluginDescription_GetPath(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
void GWEN_PluginDescription_SetPath(GWEN_PLUGIN_DESCRIPTION *pd,
const char *s);
GWENHYWFAR_API
const char *GWEN_PluginDescription_GetName(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char *GWEN_PluginDescription_GetType(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char*
GWEN_PluginDescription_GetShortDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char*
GWEN_PluginDescription_GetAuthor(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char*
GWEN_PluginDescription_GetVersion(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char*
GWEN_PluginDescription_GetLongDescr(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
const char*
GWEN_PluginDescription_GetFileName(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
void GWEN_PluginDescription_SetFileName(GWEN_PLUGIN_DESCRIPTION *pd,
const char *s);
#ifndef NO_DEPRECATED_SYMBOLS
/**
* <p>
* Seeks for a long description with the given format and the currently
* selected locale and appends it to the data in the given buffer.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently supported format is "html".
* </p>
* @return 0 if ok, !=0 on error
* @param pd plugin description
* @param s name of the format (e.g. <i>html</i>)
* @param buf buffer to append the description to
*/
GWENHYWFAR_API DEPRECATED
int
GWEN_PluginDescription_GetLongDescrByFormat(const GWEN_PLUGIN_DESCRIPTION *pd,
const char *s,
GWEN_BUFFER *buf);
#endif // ifndef NO_DEPRECATED_SYMBOLS
GWENHYWFAR_API
int GWEN_PluginDescription_IsActive(const GWEN_PLUGIN_DESCRIPTION *pd);
GWENHYWFAR_API
void GWEN_PluginDescription_SetIsActive(GWEN_PLUGIN_DESCRIPTION *pd, int i);
#ifdef __cplusplus
}
#endif
#endif /* GWENHYWFAR_PLUGINDESCR_H */
|