Revision: 28882
http://xbmc.svn.sourceforge.net/xbmc/?rev=28882&view=rev
Author: alcoheca
Date: 2010-03-26 23:40:48 +0000 (Fri, 26 Mar 2010)
Log Message:
-----------
Revert "remove old cpluff"
This reverts commit 5d0d88e6590a7b00d7d841e5cba9526ed2d84f23.
Added Paths:
-----------
trunk/xbmc/lib/cpluff-0.1.3/config.h
trunk/xbmc/lib/cpluff-0.1.3/examples/cpfile/cpfile
trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluff.h
trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluffdef.h
trunk/xbmc/lib/cpluff-0.1.3/libcpluff/docsrc/Doxyfile-impl
trunk/xbmc/lib/cpluff-0.1.3/libcpluff/docsrc/Doxyfile-ref
trunk/xbmc/lib/cpluff-0.1.3/libcpluff/pcontrol.c
trunk/xbmc/lib/cpluff-0.1.3/libcpluff/ploader.c
trunk/xbmc/lib/cpluff-0.1.3/libtool
trunk/xbmc/lib/cpluff-0.1.3/po/Makefile.in
trunk/xbmc/lib/cpluff-0.1.3/po/POTFILES
trunk/xbmc/lib/cpluff-0.1.3/stamp-h1
Added: trunk/xbmc/lib/cpluff-0.1.3/config.h
===================================================================
--- trunk/xbmc/lib/cpluff-0.1.3/config.h (rev 0)
+++ trunk/xbmc/lib/cpluff-0.1.3/config.h 2010-03-26 23:40:48 UTC (rev 28882)
@@ -0,0 +1,118 @@
+/* config.h. Generated from config.h.in by configure. */
+/* config.h.in. Generated from configure.ac by autoheader. */
+
+/* The earliest ABI compatible version or undefined */
+#define CP_ABI_COMPATIBILITY "0.1"
+
+/* File name separator character */
+#define CP_FNAMESEP_CHAR '/'
+
+/* File name separator string */
+#define CP_FNAMESEP_STR "/"
+
+/* Shared library extension */
+#define CP_SHREXT ".so"
+
+/* Multi-threading support type */
+#define CP_THREADS "Posix"
+
+/* Define to use GNU Libtool libltdl */
+/* #undef DLOPEN_LIBTOOL */
+
+/* Define to use Posix dlopen */
+#define DLOPEN_POSIX /**/
+
+/* Define to 1 if translation of program messages to the user's native
+ language is requested. */
+#define ENABLE_NLS 1
+
+/* Define to 1 if you have the MacOS X function CFLocaleCopyCurrent in the
+ CoreFoundation framework. */
+/* #undef HAVE_CFLOCALECOPYCURRENT */
+
+/* Define to 1 if you have the MacOS X function CFPreferencesCopyAppValue in
+ the CoreFoundation framework. */
+/* #undef HAVE_CFPREFERENCESCOPYAPPVALUE */
+
+/* Define if the GNU dcgettext() function is already present or preinstalled.
+ */
+#define HAVE_DCGETTEXT 1
+
+/* Define to 1 if you have the <dlfcn.h> header file. */
+#define HAVE_DLFCN_H 1
+
+/* Define if the GNU gettext() function is already present or preinstalled. */
+#define HAVE_GETTEXT 1
+
+/* Define if you have the iconv() function. */
+/* #undef HAVE_ICONV */
+
+/* Define to 1 if you have the <inttypes.h> header file. */
+#define HAVE_INTTYPES_H 1
+
+/* Define to 1 if you have the `lstat' function. */
+#define HAVE_LSTAT 1
+
+/* Define to 1 if you have the <memory.h> header file. */
+#define HAVE_MEMORY_H 1
+
+/* Define to 1 if you have the `stat' function. */
+#define HAVE_STAT 1
+
+/* Define to 1 if you have the <stdint.h> header file. */
+#define HAVE_STDINT_H 1
+
+/* Define to 1 if you have the <stdlib.h> header file. */
+#define HAVE_STDLIB_H 1
+
+/* Define to 1 if you have the <strings.h> header file. */
+#define HAVE_STRINGS_H 1
+
+/* Define to 1 if you have the <string.h> header file. */
+#define HAVE_STRING_H 1
+
+/* Define to 1 if you have the <sys/stat.h> header file. */
+#define HAVE_SYS_STAT_H 1
+
+/* Define to 1 if you have the <sys/types.h> header file. */
+#define HAVE_SYS_TYPES_H 1
+
+/* Define to 1 if you have the <unistd.h> header file. */
+#define HAVE_UNISTD_H 1
+
+/* Define to the sub-directory in which libtool stores uninstalled libraries.
+ */
+#define LT_OBJDIR ".libs/"
+
+/* Define to 1 if your C compiler doesn't accept -c and -o together. */
+/* #undef NO_MINUS_C_MINUS_O */
+
+/* Name of package */
+#define PACKAGE "cpluff"
+
+/* Define to the address where bug reports for this package should be sent. */
+#define PACKAGE_BUGREPORT "johannes.lehtinen@..."
+
+/* Define to the full name of this package. */
+#define PACKAGE_NAME "C-Pluff"
+
+/* Define to the full name and version of this package. */
+#define PACKAGE_STRING "C-Pluff 0.1.3"
+
+/* Define to the one symbol short name of this package. */
+#define PACKAGE_TARNAME "cpluff"
+
+/* Define to the home page for this package. */
+#define PACKAGE_URL ""
+
+/* Define to the version of this package. */
+#define PACKAGE_VERSION "0.1.3"
+
+/* Define to 1 if you have the ANSI C header files. */
+#define STDC_HEADERS 1
+
+/* Version number of package */
+#define VERSION "0.1.3"
+
+/* Define to empty if `const' does not conform to ANSI C. */
+/* #undef const */
Added: trunk/xbmc/lib/cpluff-0.1.3/examples/cpfile/cpfile
===================================================================
--- trunk/xbmc/lib/cpluff-0.1.3/examples/cpfile/cpfile (rev 0)
+++ trunk/xbmc/lib/cpluff-0.1.3/examples/cpfile/cpfile 2010-03-26 23:40:48 UTC (rev 28882)
@@ -0,0 +1,9 @@
+#! /bin/sh
+
+# Copyright 2007 Johannes Lehtinen
+# This script is free software; Johannes Lehtinen gives unlimited
+# permission to copy, distribute and modify it.
+
+prefix="/usr/local"
+exec_prefix="${prefix}"
+exec "${exec_prefix}/bin/cpluff-loader" -c "${exec_prefix}/lib/cpfile/plugins" -s org.c-pluff.examples.cpfile.core "$@"
Added: trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluff.h
===================================================================
--- trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluff.h (rev 0)
+++ trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluff.h 2010-03-26 23:40:48 UTC (rev 28882)
@@ -0,0 +1,1504 @@
+/*-------------------------------------------------------------------------
+ * C-Pluff, a plug-in framework for C
+ * Copyright 2007 Johannes Lehtinen
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *-----------------------------------------------------------------------*/
+
+/** @file
+ * C-Pluff C API header file.
+ * The elements declared here constitute the C-Pluff C API. To use the
+ * API include this file and link the main program and plug-in runtime
+ * libraries with the C-Pluff C library. In addition to local declarations,
+ * this file also includes cpluffdef.h header file for defines common to C
+ * and C++ API.
+ */
+
+#ifndef CPLUFF_H_
+#define CPLUFF_H_
+
+/**
+ * @defgroup cDefines Defines
+ * Preprocessor defines.
+ */
+
+#include "cpluffdef.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /*__cplusplus*/
+
+
+/* ------------------------------------------------------------------------
+ * Defines
+ * ----------------------------------------------------------------------*/
+
+/**
+ * @def CP_C_API
+ * @ingroup cDefines
+ *
+ * Marks a symbol declaration to be part of the C-Pluff C API.
+ * This macro declares the symbol to be imported from the C-Pluff library.
+ */
+
+#ifndef CP_C_API
+#define CP_C_API CP_IMPORT
+#endif
+
+
+/**
+ * @defgroup cScanFlags Flags for plug-in scanning
+ * @ingroup cDefines
+ *
+ * These constants can be orred together for the flags
+ * parameter of ::cp_scan_plugins.
+ */
+/*@{*/
+
+/**
+ * This flag enables upgrades of installed plug-ins by unloading
+ * the old version and installing the new version.
+ */
+#define CP_SP_UPGRADE 0x01
+
+/**
+ * This flag causes all plug-ins to be stopped before any
+ * plug-ins are to be upgraded.
+ */
+#define CP_SP_STOP_ALL_ON_UPGRADE 0x02
+
+/**
+ * This flag causes all plug-ins to be stopped before any
+ * plugins are to be installed (also if new version is to be installed
+ * as part of an upgrade).
+ */
+#define CP_SP_STOP_ALL_ON_INSTALL 0x04
+
+/**
+ * Setting this flag causes the currently active plug-ins to be restarted
+ * after all changes to the plug-ins have been made (if they were stopped).
+ */
+#define CP_SP_RESTART_ACTIVE 0x08
+
+/*@}*/
+
+
+/* ------------------------------------------------------------------------
+ * Data types
+ * ----------------------------------------------------------------------*/
+
+/**
+ * @defgroup cEnums Enumerations
+ * Constant value enumerations.
+ */
+
+/**
+ * @defgroup cTypedefs Typedefs
+ * Typedefs of various kind.
+ */
+
+/**
+ * @defgroup cStructs Data structures
+ * Data structure definitions.
+ */
+
+
+/* Enumerations */
+
+/**
+ * @ingroup cEnums
+ *
+ * An enumeration of status codes returned by API functions.
+ * Most of the interface functions return a status code. The returned
+ * status code either indicates successful completion of the operation
+ * or some specific kind of error. Some functions do not return a status
+ * code because they never fail.
+ */
+enum cp_status_t {
+
+ /**
+ * Operation was performed successfully (equals to zero).
+ * @showinitializer
+ */
+ CP_OK = 0,
+
+ /** Not enough memory or other operating system resources available */
+ CP_ERR_RESOURCE,
+
+ /** The specified object is unknown to the framework */
+ CP_ERR_UNKNOWN,
+
+ /** An I/O error occurred */
+ CP_ERR_IO,
+
+ /** Malformed plug-in descriptor was encountered when loading a plug-in */
+ CP_ERR_MALFORMED,
+
+ /** Plug-in or symbol conflicts with another plug-in or symbol. */
+ CP_ERR_CONFLICT,
+
+ /** Plug-in dependencies could not be satisfied. */
+ CP_ERR_DEPENDENCY,
+
+ /** Plug-in runtime signaled an error. */
+ CP_ERR_RUNTIME
+
+};
+
+/**
+ * @ingroup cEnums
+ * An enumeration of possible plug-in states. Plug-in states are controlled
+ * by @ref cFuncsPlugin "plug-in management functions". Plug-in states can be
+ * observed by @ref cp_register_plistener "registering" a
+ * @ref cp_plugin_listener_func_t "plug-in listener function"
+ * or by calling ::cp_get_plugin_state.
+ *
+ * @sa cp_plugin_listener_t
+ * @sa cp_get_plugin_state
+ */
+enum cp_plugin_state_t {
+
+ /**
+ * Plug-in is not installed. No plug-in information has been
+ * loaded.
+ */
+ CP_PLUGIN_UNINSTALLED,
+
+ /**
+ * Plug-in is installed. At this stage the plug-in information has
+ * been loaded but its dependencies to other plug-ins has not yet
+ * been resolved. The plug-in runtime has not been loaded yet.
+ * The extension points and extensions provided by the plug-in
+ * have been registered.
+ */
+ CP_PLUGIN_INSTALLED,
+
+ /**
+ * Plug-in dependencies have been resolved. At this stage it has
+ * been verified that the dependencies of the plug-in are satisfied
+ * and the plug-in runtime has been loaded but it is not active
+ * (it has not been started or it has been stopped).
+ * Plug-in is resolved when a dependent plug-in is being
+ * resolved or before the plug-in is started. Plug-in is put
+ * back to installed stage if its dependencies are being
+ * uninstalled.
+ */
+ CP_PLUGIN_RESOLVED,
+
+ /**
+ * Plug-in is starting. The plug-in has been resolved and the start
+ * function (if any) of the plug-in runtime is about to be called.
+ * A plug-in is started when explicitly requested by the main
+ * program or when a dependent plug-in is about to be started or when
+ * a dynamic symbol defined by the plug-in is being resolved. This state
+ * is omitted and the state changes directly from resolved to active
+ * if the plug-in runtime does not define a start function.
+ */
+ CP_PLUGIN_STARTING,
+
+ /**
+ * Plug-in is stopping. The stop function (if any) of the plug-in
+ * runtime is about to be called. A plug-in is stopped if the start
+ * function fails or when stopping is explicitly
+ * requested by the main program or when its dependencies are being
+ * stopped. This state is omitted and the state changes directly from
+ * active to resolved if the plug-in runtime does not define a stop
+ * function.
+ */
+ CP_PLUGIN_STOPPING,
+
+ /**
+ * Plug-in has been successfully started and it has not yet been
+ * stopped.
+ */
+ CP_PLUGIN_ACTIVE
+
+};
+
+/**
+ * @ingroup cEnums
+ * An enumeration of possible message severities for framework logging. These
+ * constants are used when passing a log message to a
+ * @ref cp_logger_func_t "logger function" and when
+ * @ref cp_register_logger "registering" a logger function.
+ */
+enum cp_log_severity_t {
+
+ /** Used for detailed debug messages */
+ CP_LOG_DEBUG,
+
+ /** Used for informational messages such as plug-in state changes */
+ CP_LOG_INFO,
+
+ /** Used for messages warning about possible problems */
+ CP_LOG_WARNING,
+
+ /** Used for messages reporting errors */
+ CP_LOG_ERROR
+
+};
+
+/*@}*/
+
+
+/* Typedefs */
+
+/**
+ * @defgroup cTypedefsOpaque Opaque types
+ * @ingroup cTypedefs
+ * Opaque data type definitions.
+ */
+/*@{*/
+
+/**
+ * A plug-in context represents the co-operation environment of a set of
+ * plug-ins from the perspective of a particular participating plug-in or
+ * the perspective of the main program. It is used as an opaque handle to
+ * the shared resources but the framework also uses the context to identify
+ * the plug-in or the main program invoking framework functions. Therefore
+ * a plug-in should not generally expose its context instance to other
+ * plug-ins or the main program and neither should the main program
+ * expose its context instance to plug-ins. The main program creates
+ * plug-in contexts using ::cp_create_context and plug-ins receive their
+ * plug-in contexts via @ref cp_plugin_runtime_t::create.
+ */
+typedef struct cp_context_t cp_context_t;
+
+/*@}*/
+
+ /**
+ * @defgroup cTypedefsShorthand Shorthand type names
+ * @ingroup cTypedefs
+ * Shorthand type names for structs and enumerations.
+ */
+/*@{*/
+
+/** A type for cp_plugin_info_t structure. */
+typedef struct cp_plugin_info_t cp_plugin_info_t;
+
+/** A type for cp_plugin_import_t structure. */
+typedef struct cp_plugin_import_t cp_plugin_import_t;
+
+/** A type for cp_ext_point_t structure. */
+typedef struct cp_ext_point_t cp_ext_point_t;
+
+/** A type for cp_extension_t structure. */
+typedef struct cp_extension_t cp_extension_t;
+
+/** A type for cp_cfg_element_t structure. */
+typedef struct cp_cfg_element_t cp_cfg_element_t;
+
+/** A type for cp_plugin_runtime_t structure. */
+typedef struct cp_plugin_runtime_t cp_plugin_runtime_t;
+
+/** A type for cp_status_t enumeration. */
+typedef enum cp_status_t cp_status_t;
+
+/** A type for cp_plugin_state_t enumeration. */
+typedef enum cp_plugin_state_t cp_plugin_state_t;
+
+/** A type for cp_log_severity_t enumeration. */
+typedef enum cp_log_severity_t cp_log_severity_t;
+
+/*@}*/
+
+/**
+ * @defgroup cTypedefsFuncs Callback function types
+ * @ingroup cTypedefs
+ * Typedefs for client supplied callback functions.
+ */
+/*@{*/
+
+/**
+ * A listener function called synchronously after a plugin state change.
+ * The function should return promptly.
+ * @ref cFuncsInit "Library initialization",
+ * @ref cFuncsContext "plug-in context management",
+ * @ref cFuncsPlugin "plug-in management",
+ * listener registration (::cp_register_plistener and ::cp_unregister_plistener)
+ * and @ref cFuncsSymbols "dynamic symbol" functions must not be called from
+ * within a plug-in listener invocation. Listener functions are registered
+ * using ::cp_register_plistener.
+ *
+ * @param plugin_id the plug-in identifier
+ * @param old_state the old plug-in state
+ * @param new_state the new plug-in state
+ * @param user_data the user data pointer supplied at listener registration
+ */
+typedef void (*cp_plugin_listener_func_t)(const char *plugin_id, cp_plugin_state_t old_state, cp_plugin_state_t new_state, void *user_data);
+
+/**
+ * A logger function called to log selected plug-in framework messages. The
+ * messages may be localized. Plug-in framework API functions must not
+ * be called from within a logger function invocation. In a multi-threaded
+ * environment logger function invocations are serialized by the framework.
+ * Logger functions are registered using ::cp_register_logger.
+ *
+ * @param severity the severity of the message
+ * @param msg the message to be logged, possibly localized
+ * @param apid the identifier of the activating plug-in or NULL for the main program
+ * @param user_data the user data pointer given when the logger was registered
+ */
+typedef void (*cp_logger_func_t)(cp_log_severity_t severity, const char *msg, const char *apid, void *user_data);
+
+/**
+ * A fatal error handler for handling unrecoverable errors. If the error
+ * handler returns then the framework aborts the program. Plug-in framework
+ * API functions must not be called from within a fatal error handler
+ * invocation. The fatal error handler function is set using
+ * ::cp_set_fatal_error_handler.
+ *
+ * @param msg the possibly localized error message
+ */
+typedef void (*cp_fatal_error_func_t)(const char *msg);
+
+/**
+ * A run function registered by a plug-in to perform work.
+ * The run function should perform a finite chunk of work and it should
+ * return a non-zero value if there is more work to be done. Run functions
+ * are registered using ::cp_run_function and the usage is discussed in
+ * more detail in the @ref cFuncsPluginExec "serial execution" section.
+ *
+ * @param plugin_data the plug-in instance data pointer
+ * @return non-zero if there is more work to be done or zero if finished
+ */
+typedef int (*cp_run_func_t)(void *plugin_data);
+
+/*@}*/
+
+
+/* Data structures */
+
+/**
+ * @ingroup cStructs
+ * Plug-in information structure captures information about a plug-in. This
+ * information can be loaded from a plug-in descriptor using
+ * ::cp_load_plugin_descriptor. Information about installed plug-ins can
+ * be obtained using ::cp_get_plugin_info and ::cp_get_plugins_info. This
+ * structure corresponds to the @a plugin element in a plug-in descriptor.
+ */
+struct cp_plugin_info_t {
+
+ /**
+ * The obligatory unique identifier of the plugin. A recommended way
+ * to generate identifiers is to use domain name service (DNS) prefixes
+ * (for example, org.cpluff.ExamplePlugin) to avoid naming conflicts. This
+ * corresponds to the @a id attribute of the @a plugin element in a plug-in
+ * descriptor.
+ */
+ char *identifier;
+
+ /**
+ * A mandatory summary of the addon's features.
+ * This corresponds to the @a summary attribute of the @a plugin element in
+ * a plug-in descriptor.
+ */
+ char *summary;
+
+ /**
+ * An optional plug-in name. NULL if not available. The plug-in name is
+ * intended only for display purposes and the value can be localized.
+ * This corresponds to the @a name attribute of the @a plugin element in
+ * a plug-in descriptor.
+ */
+ char *name;
+
+ /**
+ * An optional release version string. NULL if not available. This
+ * corresponds to the @a version attribute of the @a plugin element in
+ * a plug-in descriptor.
+ */
+ char *version;
+
+ /**
+ * An optional provider name. NULL if not available. This is the name of
+ * the author or the organization providing the plug-in. The
+ * provider name is intended only for display purposes and the value can
+ * be localized. This corresponds to the @a provider-name attribute of the
+ * @a plugin element in a plug-in descriptor.
+ */
+ char *provider_name;
+
+ /**
+ * Path of the plugin directory or NULL if not known. This is the
+ * (absolute or relative) path to the plug-in directory containing
+ * plug-in data and the plug-in runtime library. The value corresponds
+ * to the path specified to ::cp_load_plugin_descriptor when loading
+ * the plug-in.
+ */
+ char *plugin_path;
+
+ /**
+ * Optional ABI compatibility information. NULL if not available.
+ * This is the earliest version of the plug-in interface the current
+ * interface is backwards compatible with when it comes to the application
+ * binary interface (ABI) of the plug-in. That is, plug-in clients compiled against
+ * any plug-in interface version from @a abi_bw_compatibility to
+ * @ref version (inclusive) can use the current version of the plug-in
+ * binary. This describes binary or runtime compatibility.
+ * The value corresponds to the @a abi-compatibility
+ * attribute of the @a backwards-compatibility element in a plug-in descriptor.
+ */
+ char *abi_bw_compatibility;
+
+ /**
+ * Optional API compatibility information. NULL if not available.
+ * This is the earliest version of the plug-in interface the current
+ * interface is backwards compatible with when it comes to the
+ * application programming interface (API) of the plug-in. That is,
+ * plug-in clients written for any plug-in interface version from
+ * @a api_bw_compatibility to @ref version (inclusive) can be compiled
+ * against the current version of the plug-in API. This describes
+ * source or build time compatibility. The value corresponds to the
+ * @a api-compatibility attribute of the @a backwards-compatibility
+ * element in a plug-in descriptor.
+ */
+ char *api_bw_compatibility;
+
+ /**
+ * Optional C-Pluff version requirement. NULL if not available.
+ * This is the version of the C-Pluff implementation the plug-in was
+ * compiled against. It is used to determine the compatibility of
+ * the plug-in runtime and the linked in C-Pluff implementation. Any
+ * C-Pluff version that is backwards compatible on binary level with the
+ * specified version fulfills the requirement.
+ */
+ char *req_cpluff_version;
+
+ /** Number of import entries in the @ref imports array. */
+ unsigned int num_imports;
+
+ /**
+ * An array of @ref num_imports import entries. These correspond to
+ * @a import elements in a plug-in descriptor.
+ */
+ cp_plugin_import_t *imports;
+
+ /**
+ * The base name of the plug-in runtime library, or NULL if none.
+ * A platform specific prefix (for example, "lib") and an extension
+ * (for example, ".dll" or ".so") may be added to the base name.
+ * This corresponds to the @a library attribute of the
+ * @a runtime element in a plug-in descriptor.
+ */
+ char *runtime_lib_name;
+
+ /**
+ * The symbol pointing to the plug-in runtime function information or
+ * NULL if none. The symbol with this name should point to an instance of
+ * @ref cp_plugin_runtime_t structure. This corresponds to the
+ * @a funcs attribute of the @a runtime element in a plug-in descriptor.
+ */
+ char *runtime_funcs_symbol;
+
+ /** Number of extension points in @ref ext_points array. */
+ unsigned int num_ext_points;
+
+ /**
+ * An array of @ref num_ext_points extension points provided by this
+ * plug-in. These correspond to @a extension-point elements in a
+ * plug-in descriptor.
+ */
+ cp_ext_point_t *ext_points;
+
+ /** Number of extensions in @ref extensions array. */
+ unsigned int num_extensions;
+
+ /**
+ * An array of @ref num_extensions extensions provided by this
+ * plug-in. These correspond to @a extension elements in a plug-in
+ * descriptor.
+ */
+ cp_extension_t *extensions;
+
+};
+
+/**
+ * @ingroup cStructs
+ * Information about plug-in import. Plug-in import structures are
+ * contained in @ref cp_plugin_info_t::imports.
+ */
+struct cp_plugin_import_t {
+
+ /**
+ * The identifier of the imported plug-in. This corresponds to the
+ * @a plugin attribute of the @a import element in a plug-in descriptor.
+ */
+ char *plugin_id;
+
+ /**
+ * An optional version requirement. NULL if no version requirement.
+ * This is the version of the imported plug-in the importing plug-in was
+ * compiled against. Any version of the imported plug-in that is
+ * backwards compatible with this version fulfills the requirement.
+ * This corresponds to the @a if-version attribute of the @a import
+ * element in a plug-in descriptor.
+ */
+ char *version;
+
+ /**
+ * Is this import optional. 1 for optional and 0 for mandatory import.
+ * An optional import causes the imported plug-in to be started if it is
+ * available but does not stop the importing plug-in from starting if the
+ * imported plug-in is not available. If the imported plug-in is available
+ * but the API version conflicts with the API version requirement then the
+ * importing plug-in fails to start. This corresponds to the @a optional
+ * attribute of the @a import element in a plug-in descriptor.
+ */
+ int optional;
+};
+
+/**
+ * @ingroup cStructs
+ * Extension point structure captures information about an extension
+ * point. Extension point structures are contained in
+ * @ref cp_plugin_info_t::ext_points.
+ */
+struct cp_ext_point_t {
+
+ /**
+ * A pointer to plug-in information containing this extension point.
+ * This reverse pointer is provided to make it easy to get information
+ * about the plug-in which is hosting a particular extension point.
+ */
+ cp_plugin_info_t *plugin;
+
+ /**
+ * The local identifier uniquely identifying the extension point within the
+ * host plug-in. This corresponds to the @name id attribute of an
+ * @a extension-point element in a plug-in descriptor.
+ */
+ char *local_id;
+
+ /**
+ * The unique identifier of the extension point. This is automatically
+ * constructed by concatenating the identifier of the host plug-in and
+ * the local identifier of the extension point.
+ */
+ char *identifier;
+
+ /**
+ * An optional extension point name. NULL if not available. The extension
+ * point name is intended for display purposes only and the value can be
+ * localized. This corresponds to the @a name attribute of
+ * an @a extension-point element in a plug-in descriptor.
+ */
+ char *name;
+
+ /**
+ * An optional path to the extension schema definition.
+ * NULL if not available. The path is relative to the plug-in directory.
+ * This corresponds to the @a schema attribute
+ * of an @a extension-point element in a plug-in descriptor.
+ */
+ char *schema_path;
+};
+
+/**
+ * @ingroup cStructs
+ * Extension structure captures information about an extension. Extension
+ * structures are contained in @ref cp_plugin_info_t::extensions.
+ */
+struct cp_extension_t {
+
+ /**
+ * A pointer to plug-in information containing this extension.
+ * This reverse pointer is provided to make it easy to get information
+ * about the plug-in which is hosting a particular extension.
+ */
+ cp_plugin_info_t *plugin;
+
+ /**
+ * The unique identifier of the extension point this extension is
+ * attached to. This corresponds to the @a point attribute of an
+ * @a extension element in a plug-in descriptor.
+ */
+ char *ext_point_id;
+
+ /**
+ * An optional local identifier uniquely identifying the extension within
+ * the host plug-in. NULL if not available. This corresponds to the
+ * @a id attribute of an @a extension element in a plug-in descriptor.
+ */
+ char *local_id;
+
+ /**
+ * An optional unique identifier of the extension. NULL if not available.
+ * This is automatically constructed by concatenating the identifier
+ * of the host plug-in and the local identifier of the extension.
+ */
+ char *identifier;
+
+ /**
+ * An optional extension name. NULL if not available. The extension name
+ * is intended for display purposes only and the value can be localized.
+ * This corresponds to the @a name attribute
+ * of an @a extension element in a plug-in descriptor.
+ **/
+ char *name;
+
+ /**
+ * Extension configuration starting with the extension element.
+ * This includes extension configuration information as a tree of
+ * configuration elements. These correspond to the @a extension
+ * element and its contents in a plug-in descriptor.
+ */
+ cp_cfg_element_t *configuration;
+};
+
+/**
+ * @ingroup cStructs
+ * A configuration element contains configuration information for an
+ * extension. Utility functions ::cp_lookup_cfg_element and
+ * ::cp_lookup_cfg_value can be used for traversing the tree of
+ * configuration elements. Pointer to the root configuration element is
+ * stored at @ref cp_extension_t::configuration and others are contained as
+ * @ref cp_cfg_element_t::children "children" of parent elements.
+ */
+struct cp_cfg_element_t {
+
+ /**
+ * The name of the configuration element. This corresponds to the name of
+ * the element in a plug-in descriptor.
+ */
+ char *name;
+
+ /** Number of attribute name, value pairs in the @ref atts array. */
+ unsigned int num_atts;
+
+ /**
+ * An array of pointers to alternating attribute names and values.
+ * Attribute values can be localized.
+ */
+ char **atts;
+
+ /**
+ * An optional value of this configuration element. NULL if not available.
+ * The value can be localized. This corresponds to the
+ * text contents of the element in a plug-in descriptor.
+ */
+ char *value;
+
+ /** A pointer to the parent element or NULL if this is a root element. */
+ cp_cfg_element_t *parent;
+
+ /** The index of this element among its siblings (0-based). */
+ unsigned int index;
+
+ /** Number of children in the @ref children array. */
+ unsigned int num_children;
+
+ /**
+ * An array of @ref num_children childrens of this element. These
+ * correspond to child elements in a plug-in descriptor.
+ */
+ cp_cfg_element_t *children;
+};
+
+/**
+ * @ingroup cStructs
+ * Container for plug-in runtime information. A plug-in runtime defines a
+ * static instance of this structure to pass information to the plug-in
+ * framework. The plug-in framework then uses the information
+ * to create and control plug-in instances. The symbol pointing
+ * to the runtime information instance is named by the @a funcs
+ * attribute of the @a runtime element in a plug-in descriptor.
+ *
+ * The following graph displays how these functions are used to control the
+ * state of the plug-in instance.
+ *
+ * @dot
+ * digraph lifecycle {
+ * rankdir=LR;
+ * node [shape=ellipse, fontname=Helvetica, fontsize=10];
+ * edge [fontname=Helvetica, fontsize=10];
+ * none [label="no instance"];
+ * inactive [label="inactive"];
+ * active [label="active"];
+ * none -> inactive [label="create", URL="\ref create"];
+ * inactive -> active [label="start", URL="\ref start"];
+ * active -> inactive [label="stop", URL="\ref stop"];
+ * inactive -> none [label="destroy", URL="\ref destroy"];
+ * }
+ * @enddot
+ */
+struct cp_plugin_runtime_t {
+
+ /**
+ * An initialization function called to create a new plug-in
+ * runtime instance. The initialization function initializes and
+ * returns an opaque plug-in instance data pointer which is then
+ * passed on to other control functions. This data pointer should
+ * be used to access plug-in instance specific data. For example,
+ * the context reference must be stored as part of plug-in instance
+ * data if the plug-in runtime needs it. On failure, the function
+ * must return NULL.
+ *
+ * C-pluff API functions must not be called from within a create
+ * function invocation and symbols from imported plug-ins must not be
+ * used because they may not available yet.
+ *
+ * @param ctx the plug-in context of the new plug-in instance
+ * @return an opaque pointer to plug-in instance data or NULL on failure
+ */
+ void *(*create)(cp_context_t *ctx);
+
+ /**
+ * A start function called to start a plug-in instance.
+ * The start function must return zero (CP_OK) on success and non-zero
+ * on failure. If the start fails then the stop function (if any) is
+ * called to clean up plug-in state. @ref cFuncsInit "Library initialization",
+ * @ref cFuncsContext "plug-in context management" and
+ * @ref cFuncsPlugin "plug-in management" functions must not be
+ * called from within a start function invocation. The start function
+ * pointer can be NULL if the plug-in runtime does not have a start
+ * function.
+ *
+ * The start function implementation should set up plug-in and return
+ * promptly. If there is further work to be done then a plug-in can
+ * start a thread or register a run function using ::cp_run_function.
+ * Symbols from imported plug-ins are guaranteed to be available for
+ * the start function.
+ *
+ * @param data an opaque pointer to plug-in instance data
+ * @return non-zero on success, or zero on failure
+ */
+ int (*start)(void *data);
+
+ /**
+ * A stop function called to stop a plugin instance.
+ * This function must cease all plug-in runtime activities.
+ * @ref cFuncsInit "Library initialization",
+ * @ref cFuncsContext "plug-in context management",
+ * @ref cFuncsPlugin "plug-in management"
+ * functions, ::cp_run_function and ::cp_resolve_symbol must not be called
+ * from within a stop function invocation. The stop function pointer can
+ * be NULL if the plug-in runtime does not have a stop function.
+ * It is guaranteed that no run functions registered by the plug-in are
+ * called simultaneously or after the call to the stop function.
+ *
+ * The stop function should release any external resources hold by
+ * the plug-in. Dynamically resolved symbols are automatically released
+ * and dynamically defined symbols and registered run functions are
+ * automatically unregistered after the call to stop function.
+ * Resolved external symbols are still available for the stop function
+ * and symbols provided by the plug-in should remain available
+ * after the call to stop function (although functionality might be
+ * limited). Final cleanup can be safely done in the destroy function.
+ *
+ * @param data an opaque pointer to plug-in instance data
+ */
+ void (*stop)(void *data);
+
+ /**
+ * A destroy function called to destroy a plug-in instance.
+ * This function should release any plug-in instance data.
+ * The plug-in is stopped before this function is called.
+ * C-Pluff API functions must not be called from within a destroy
+ * function invocation and symbols from imported plug-ins must not be
+ * used because they may not be available anymore. Correspondingly,
+ * it is guaranteed that the symbols provided by the plug-in are not
+ * used by other plug-ins when destroy function has been called.
+ *
+ * @param data an opaque pointer to plug-in instance data
+ */
+ void (*destroy)(void *data);
+
+};
+
+/*@}*/
+
+
+/* ------------------------------------------------------------------------
+ * Function declarations
+ * ----------------------------------------------------------------------*/
+
+/**
+ * @defgroup cFuncs Functions
+ *
+ * C API functions. The C-Pluff C API functions and
+ * any data exposed by them are generally thread-safe if the library has been
+ * compiled with multi-threading support. The
+ * @ref cFuncsInit "framework initialization functions"
+ * are exceptions, they are not thread-safe.
+ */
+
+/**
+ * @defgroup cFuncsFrameworkInfo Framework information
+ * @ingroup cFuncs
+ *
+ * These functions can be used to query runtime information about the
+ * linked in C-Pluff implementation. They may be used by the main program or
+ * by a plug-in runtime.
+ */
+/*@{*/
+
+/**
+ * Returns the release version string of the linked in C-Pluff
+ * implementation.
+ *
+ * @return the C-Pluff release version string
+ */
+CP_C_API const char *cp_get_version(void) CP_GCC_PURE;
+
+/**
+ * Returns the canonical host type associated with the linked in C-Pluff implementation.
+ * A multi-platform installation manager could use this information to
+ * determine what plug-in versions to install.
+ *
+ * @return the canonical host type
+ */
+CP_C_API const char *cp_get_host_type(void) CP_GCC_PURE;
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsInit Framework initialization
+ * @ingroup cFuncs
+ *
+ * These functions are used for framework initialization.
+ * They are intended to be used by the main program. These functions are
+ * not thread safe.
+ */
+/*@{*/
+
+/**
+ * Sets the fatal error handler called on non-recoverable errors. The default
+ * error handler prints the error message out to standard error and aborts
+ * the program. If the user specified error handler returns then the framework
+ * will abort the program. Setting NULL error handler will restore the default
+ * handler. This function is not thread-safe and it should be called
+ * before initializing the framework to catch all fatal errors.
+ *
+ * @param error_handler the fatal error handler
+ */
+CP_C_API void cp_set_fatal_error_handler(cp_fatal_error_func_t error_handler);
+
+/**
+ * Initializes the plug-in framework. This function must be called
+ * by the main program before calling any other plug-in framework
+ * functions except @ref cFuncsFrameworkInfo "framework information" functions and
+ * ::cp_set_fatal_error_handler. This function may be
+ * called several times but it is not thread-safe. Library resources
+ * should be released by calling ::cp_destroy when the framework is
+ * not needed anymore.
+ *
+ * Additionally, to enable localization support, the main program should
+ * set the current locale using @code setlocale(LC_ALL, "") @endcode
+ * before calling this function.
+ *
+ * @return @ref CP_OK (zero) on success or error code on failure
+ */
+CP_C_API cp_status_t cp_init(void);
+
+/**
+ * Destroys the plug-in framework and releases the resources used by it.
+ * The plug-in framework is only destroyed after this function has
+ * been called as many times as ::cp_init. This function is not
+ * thread-safe. Plug-in framework functions other than ::cp_init,
+ * ::cp_get_framework_info and ::cp_set_fatal_error_handler
+ * must not be called after the plug-in framework has been destroyed.
+ * All contexts are destroyed and all data references returned by the
+ * framework become invalid.
+ */
+CP_C_API void cp_destroy(void);
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsContext Plug-in context initialization
+ * @ingroup cFuncs
+ *
+ * These functions are used to manage plug-in contexts from the main
+ * program perspective. They are not intended to be used by a plug-in runtime.
+ * From the main program perspective a plug-in context is a container for
+ * installed plug-ins. There can be several plug-in context instances if there
+ * are several independent sets of plug-ins. However, different plug-in
+ * contexts are not very isolated from each other in practice because the
+ * global symbols exported by a plug-in runtime in one context are visible to
+ * all plug-ins in all context instances.
+ */
+/*@{*/
+
+/**
+ * Creates a new plug-in context which can be used as a container for plug-ins.
+ * Plug-ins are loaded and installed into a specific context. The main
+ * program may have more than one plug-in context but the plug-ins that
+ * interact with each other should be placed in the same context. The
+ * resources associated with the context are released by calling
+ * ::cp_destroy_context when the context is not needed anymore. Remaining
+ * contexts are automatically destroyed when the plug-in framework is
+ * destroyed.
+ *
+ * @param status pointer to the location where status code is to be stored, or NULL
+ * @return the newly created plugin context, or NULL on failure
+ */
+CP_C_API cp_context_t * cp_create_context(cp_status_t *status);
+
+/**
+ * Destroys the specified plug-in context and releases the associated resources.
+ * Stops and uninstalls all plug-ins in the context. The context must not be
+ * accessed after calling this function.
+ *
+ * @param ctx the context to be destroyed
+ */
+CP_C_API void cp_destroy_context(cp_context_t *ctx) CP_GCC_NONNULL(1);
+
+/**
+ * Registers a plug-in collection with a plug-in context. A plug-in collection
+ * is a directory that has plug-ins as its immediate subdirectories. The
+ * plug-in context will scan the directory when ::cp_scan_plugins is called.
+ * Returns @ref CP_OK if the directory has already been registered. A plug-in
+ * collection can be unregistered using ::cp_unregister_pcollection or
+ * ::cp_unregister_pcollections.
+ *
+ * @param ctx the plug-in context
+ * @param dir the directory
+ * @return @ref CP_OK (zero) on success or @ref CP_ERR_RESOURCE if insufficient memory
+ */
+CP_C_API cp_status_t cp_register_pcollection(cp_context_t *ctx, const char *dir) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Unregisters a previously registered plug-in collection from a
+ * plug-in context. Plug-ins already loaded from the collection are not
+ * affected. Does nothing if the directory has not been registered.
+ * Plug-in collections can be registered using ::cp_register_pcollection.
+ *
+ * @param ctx the plug-in context
+ * @param dir the previously registered directory
+ */
+CP_C_API void cp_unregister_pcollection(cp_context_t *ctx, const char *dir) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Unregisters all plug-in collections from a plug-in context.
+ * Plug-ins already loaded are not affected. Plug-in collections can
+ * be registered using ::cp_register_pcollection.
+ *
+ * @param ctx the plug-in context
+ */
+CP_C_API void cp_unregister_pcollections(cp_context_t *ctx) CP_GCC_NONNULL(1);
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsLogging Logging
+ * @ingroup cFuncs
+ *
+ * These functions can be used to receive and emit log messages related
+ * to a particular plug-in context. They can be used by the main program
+ * or by a plug-in runtime.
+ */
+/*@{*/
+
+/**
+ * Registers a logger with a plug-in context or updates the settings of a
+ * registered logger. The logger will receive selected log messages.
+ * If the specified logger is not yet known, a new logger registration
+ * is made, otherwise the settings for the existing logger are updated.
+ * The logger can be unregistered using ::cp_unregister_logger and it is
+ * automatically unregistered when the registering plug-in is stopped or
+ * when the context is destroyed.
+ *
+ * @param ctx the plug-in context to log
+ * @param logger the logger function to be called
+ * @param user_data the user data pointer passed to the logger
+ * @param min_severity the minimum severity of messages passed to logger
+ * @return @ref CP_OK (zero) on success or @ref CP_ERR_RESOURCE if insufficient memory
+ */
+CP_C_API cp_status_t cp_register_logger(cp_context_t *ctx, cp_logger_func_t logger, void *user_data, cp_log_severity_t min_severity) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Removes a logger registration.
+ *
+ * @param ctx the plug-in context
+ * @param logger the logger function to be unregistered
+ */
+CP_C_API void cp_unregister_logger(cp_context_t *ctx, cp_logger_func_t logger) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Emits a new log message.
+ *
+ * @param ctx the plug-in context
+ * @param severity the severity of the event
+ * @param msg the log message (possibly localized)
+ */
+CP_C_API void cp_log(cp_context_t *ctx, cp_log_severity_t severity, const char *msg) CP_GCC_NONNULL(1, 3);
+
+/**
+ * Returns whether a message of the specified severity would get logged.
+ *
+ * @param ctx the plug-in context
+ * @param severity the target logging severity
+ * @return whether a message of the specified severity would get logged
+ */
+CP_C_API int cp_is_logged(cp_context_t *ctx, cp_log_severity_t severity) CP_GCC_NONNULL(1);
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsPlugin Plug-in management
+ * @ingroup cFuncs
+ *
+ * These functions can be used to manage plug-ins. They are intended to be
+ * used by the main program.
+ */
+/*@{*/
+
+/**
+ * Loads a plug-in descriptor from the specified plug-in installation
+ * path and returns information about the plug-in. The plug-in descriptor
+ * is validated during loading. Possible loading errors are reported via the
+ * specified plug-in context. The plug-in is not installed to the context.
+ * If operation fails or the descriptor
+ * is invalid then NULL is returned. The caller must release the returned
+ * information by calling ::cp_release_plugin_info when it does not
+ * need the information anymore, typically after installing the plug-in.
+ * The returned plug-in information must not be modified.
+ *
+ * @param ctx the plug-in context
+ * @param path the installation path of the plug-in
+ * @param status a pointer to the location where status code is to be stored, or NULL
+ * @return pointer to the information structure or NULL if error occurs
+ */
+CP_C_API cp_plugin_info_t * cp_load_plugin_descriptor(cp_context_t *ctx, const char *path, cp_status_t *status) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Installs the plug-in described by the specified plug-in information
+ * structure to the specified plug-in context. The plug-in information
+ * must have been loaded using ::cp_load_plugin_descriptor with the same
+ * plug-in context.
+ * The installation fails on #CP_ERR_CONFLICT if the context already
+ * has an installed plug-in with the same plug-in identifier. Installation
+ * also fails if the plug-in tries to install an extension point which
+ * conflicts with an already installed extension point.
+ * The plug-in information must not be modified but it is safe to call
+ * ::cp_release_plugin_info after the plug-in has been installed.
+ *
+ * @param ctx the plug-in context
+ * @param pi plug-in information structure
+ * @return @ref CP_OK (zero) on success or an error code on failure
+ */
+CP_C_API cp_status_t cp_install_plugin(cp_context_t *ctx, cp_plugin_info_t *pi) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Scans for plug-ins in the registered plug-in directories, installing
+ * new plug-ins and upgrading installed plug-ins. This function can be used to
+ * initially load the plug-ins and to later rescan for new plug-ins.
+ *
+ * When several versions of the same plug-in is available the most recent
+ * version will be installed. The upgrade behavior depends on the specified
+ * @ref cScanFlags "flags". If #CP_SP_UPGRADE is set then upgrades to installed plug-ins are
+ * allowed. The old version is unloaded and the new version installed instead.
+ * If #CP_SP_STOP_ALL_ON_UPGRADE is set then all active plug-ins are stopped
+ * if any plug-ins are to be upgraded. If #CP_SP_STOP_ALL_ON_INSTALL is set then
+ * all active plug-ins are stopped if any plug-ins are to be installed or
+ * upgraded. Finally, if #CP_SP_RESTART_ACTIVE is set all currently active
+ * plug-ins will be restarted after the changes (if they were stopped).
+ *
+ * When removing plug-in files from the plug-in directories, the
+ * plug-ins to be removed must be first unloaded. Therefore this function
+ * does not check for removed plug-ins.
+ *
+ * @param ctx the plug-in context
+ * @param flags the bitmask of flags
+ * @return @ref CP_OK (zero) on success or an error code on failure
+ */
+CP_C_API cp_status_t cp_scan_plugins(cp_context_t *ctx, int flags) CP_GCC_NONNULL(1);
+
+/**
+ * Starts a plug-in. Also starts any imported plug-ins. If the plug-in is
+ * already starting then
+ * this function blocks until the plug-in has started or failed to start.
+ * If the plug-in is already active then this function returns immediately.
+ * If the plug-in is stopping then this function blocks until the plug-in
+ * has stopped and then starts the plug-in.
+ *
+ * @param ctx the plug-in context
+ * @param id identifier of the plug-in to be started
+ * @return @ref CP_OK (zero) on success or an error code on failure
+ */
+CP_C_API cp_status_t cp_start_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Stops a plug-in. First stops any dependent plug-ins that are currently
+ * active. Then stops the specified plug-in. If the plug-in is already
+ * stopping then this function blocks until the plug-in has stopped. If the
+ * plug-in is already stopped then this function returns immediately. If the
+ * plug-in is starting then this function blocks until the plug-in has
+ * started (or failed to start) and then stops the plug-in.
+ *
+ * @param ctx the plug-in context
+ * @param id identifier of the plug-in to be stopped
+ * @return @ref CP_OK (zero) on success or @ref CP_ERR_UNKNOWN if unknown plug-in
+ */
+CP_C_API cp_status_t cp_stop_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Stops all active plug-ins.
+ *
+ * @param ctx the plug-in context
+ */
+CP_C_API void cp_stop_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);
+
+/**
+ * Uninstalls the specified plug-in. The plug-in is first stopped if it is active.
+ * Then uninstalls the plug-in and any dependent plug-ins.
+ *
+ * @param ctx the plug-in context
+ * @param id identifier of the plug-in to be unloaded
+ * @return @ref CP_OK (zero) on success or @ref CP_ERR_UNKNOWN if unknown plug-in
+ */
+CP_C_API cp_status_t cp_uninstall_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Uninstalls all plug-ins. All plug-ins are first stopped and then
+ * uninstalled.
+ *
+ * @param ctx the plug-in context
+ */
+CP_C_API void cp_uninstall_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsPluginInfo Plug-in and extension information
+ * @ingroup cFuncs
+ *
+ * These functions can be used to query information about the installed
+ * plug-ins, extension points and extensions or to listen for plug-in state
+ * changes. They may be used by the main program or by a plug-in runtime.
+ */
+/*@{*/
+
+/**
+ * Returns static information about the specified plug-in. The returned
+ * information must not be modified and the caller must
+ * release the information by calling ::cp_release_info when the
+ * information is not needed anymore. When a plug-in runtime calls this
+ * function it may pass NULL as the identifier to get information about the
+ * plug-in itself.
+ *
+ * @param ctx the plug-in context
+ * @param id identifier of the plug-in to be examined or NULL for self
+ * @param status a pointer to the location where status code is to be stored, or NULL
+ * @return pointer to the information structure or NULL on failure
+ */
+CP_C_API cp_plugin_info_t * cp_get_plugin_info(cp_context_t *ctx, const char *id, cp_status_t *status) CP_GCC_NONNULL(1);
+
+/**
+ * Returns static information about the installed plug-ins. The returned
+ * information must not be modified and the caller must
+ * release the information by calling ::cp_release_info when the
+ * information is not needed anymore.
+ *
+ * @param ctx the plug-in context
+ * @param status a pointer to the location where status code is to be stored, or NULL
+ * @param num a pointer to the location where the number of returned plug-ins is stored, or NULL
+ * @return pointer to a NULL-terminated list of pointers to plug-in information
+ * or NULL on failure
+ */
+CP_C_API cp_plugin_info_t ** cp_get_plugins_info(cp_context_t *ctx, cp_status_t *status, int *num) CP_GCC_NONNULL(1);
+
+/**
+ * Returns static information about the currently installed extension points.
+ * The returned information must not be modified and the caller must
+ * release the information by calling ::cp_release_info when the
+ * information is not needed anymore.
+ *
+ * @param ctx the plug-in context
+ * @param status a pointer to the location where status code is to be stored, or NULL
+ * @param num filled with the number of returned extension points, if non-NULL
+ * @return pointer to a NULL-terminated list of pointers to extension point
+ * information or NULL on failure
+ */
+CP_C_API cp_ext_point_t ** cp_get_ext_points_info(cp_context_t *ctx, cp_status_t *status, int *num) CP_GCC_NONNULL(1);
+
+/**
+ * Returns static information about the currently installed extension points.
+ * The returned information must not be modified and the caller must
+ * release the information by calling ::cp_release_info when the
+ * information is not needed anymore.
+ *
+ * @param ctx the plug-in context
+ * @param extpt_id the extension point identifier or NULL for all extensions
+ * @param status a pointer to the location where status code is to be stored, or NULL
+ * @param num a pointer to the location where the number of returned extension points is to be stored, or NULL
+ * @return pointer to a NULL-terminated list of pointers to extension
+ * information or NULL on failure
+ */
+CP_C_API cp_extension_t ** cp_get_extensions_info(cp_context_t *ctx, const char *extpt_id, cp_status_t *status, int *num) CP_GCC_NONNULL(1);
+
+/**
+ * Releases a previously obtained reference counted information object. The
+ * documentation for functions returning such information refers
+ * to this function. The information must not be accessed after it has
+ * been released. The framework uses reference counting to deallocate
+ * the information when it is not in use anymore.
+ *
+ * @param ctx the plug-in context
+ * @param info the information to be released
+ */
+CP_C_API void cp_release_info(cp_context_t *ctx, void *info) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Returns the current state of the specified plug-in. Returns
+ * #CP_PLUGIN_UNINSTALLED if the specified plug-in identifier is unknown.
+ *
+ * @param ctx the plug-in context
+ * @param id the plug-in identifier
+ * @return the current state of the plug-in
+ */
+CP_C_API cp_plugin_state_t cp_get_plugin_state(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Registers a plug-in listener with a plug-in context. The listener is called
+ * synchronously immediately after a plug-in state change. There can be several
+ * listeners registered with the same context. A plug-in listener can be
+ * unregistered using ::cp_unregister_plistener and it is automatically
+ * unregistered when the registering plug-in is stopped or when the context
+ * is destroyed.
+ *
+ * @param ctx the plug-in context
+ * @param listener the plug-in listener to be added
+ * @param user_data user data pointer supplied to the listener
+ * @return @ref CP_OK (zero) on success or @ref CP_ERR_RESOURCE if out of resources
+ */
+CP_C_API cp_status_t cp_register_plistener(cp_context_t *ctx, cp_plugin_listener_func_t listener, void *user_data) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Removes a plug-in listener from a plug-in context. Does nothing if the
+ * specified listener was not registered.
+ *
+ * @param ctx the plug-in context
+ * @param listener the plug-in listener to be removed
+ */
+CP_C_API void cp_unregister_plistener(cp_context_t *ctx, cp_plugin_listener_func_t listener) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Traverses a configuration element tree and returns the specified element.
+ * The target element is specified by a base element and a relative path from
+ * the base element to the target element. The path includes element names
+ * separated by slash '/'. Two dots ".." can be used to designate a parent
+ * element. Returns NULL if the specified element does not exist. If there are
+ * several subelements with the same name, this function chooses the first one
+ * when traversing the tree.
+ *
+ * @param base the base configuration element
+ * @param path the path to the target element
+ * @return the target element or NULL if nonexisting
+ */
+CP_C_API cp_cfg_element_t * cp_lookup_cfg_element(cp_cfg_element_t *base, const char *path) CP_GCC_PURE CP_GCC_NONNULL(1, 2);
+
+/**
+ * Traverses a configuration element tree and returns the value of the
+ * specified element or attribute. The target element or attribute is specified
+ * by a base element and a relative path from the base element to the target
+ * element or attributes. The path includes element names
+ * separated by slash '/'. Two dots ".." can be used to designate a parent
+ * element. The path may end with '@' followed by an attribute name
+ * to select an attribute. Returns NULL if the specified element or attribute
+ * does not exist or does not have a value. If there are several subelements
+ * with the same name, this function chooses the first one when traversing the
+ * tree.
+ *
+ * @param base the base configuration element
+ * @param path the path to the target element
+ * @return the value of the target element or attribute or NULL
+ */
+CP_C_API char * cp_lookup_cfg_value(cp_cfg_element_t *base, const char *path) CP_GCC_PURE CP_GCC_NONNULL(1, 2);
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsPluginExec Plug-in execution
+ * @ingroup cFuncs
+ *
+ * These functions support a plug-in controlled execution model. Started plug-ins can
+ * use ::cp_run_function to register @ref cp_run_func_t "a run function" which is called when the
+ * main program calls ::cp_run_plugins or ::cp_run_plugins_step. A run
+ * function should do a finite chunk of work and then return telling whether
+ * there is more work to be done. A run function is automatically unregistered
+ * when the plug-in is stopped. Run functions make it possible for plug-ins
+ * to control the flow of execution or they can be used as a coarse
+ * way of task switching if there is no multi-threading support.
+ *
+ * The C-Pluff distribution includes a generic main program, cpluff-loader,
+ * which only acts as a plug-in loader. It loads and starts up the
+ * specified plug-ins, passing any additional startup arguments to them and
+ * then just calls run functions of the plug-ins. This
+ * makes it is possible to put all the application specific logic in
+ * plug-ins. Application does not necessarily need a main program of its own.
+ *
+ * It is also safe, from framework perspective, to call these functions from
+ * multiple threads. Run functions may then be executed in parallel threads.
+ */
+/*@{*/
+
+/**
+ * Registers a new run function. The plug-in instance data pointer is given to
+ * the run function as a parameter. The run function must return zero if it has
+ * finished its work or non-zero if it should be called again later. The run
+ * function is unregistered when it returns zero. Plug-in framework functions
+ * stopping the registering plug-in must not be called from within a run
+ * function. This function does nothing if the specified run
+ * function is already registered for the calling plug-in instance.
+ *
+ * @param ctx the plug-in context of the registering plug-in
+ * @param runfunc the run function to be registered
+ * @return @ref CP_OK (zero) on success or an error code on failure
+ */
+CP_C_API cp_status_t cp_run_function(cp_context_t *ctx, cp_run_func_t runfunc) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Runs the started plug-ins as long as there is something to run.
+ * This function calls repeatedly run functions registered by started plug-ins
+ * until there are no more active run functions. This function is normally
+ * called by a thin main proram, a loader, which loads plug-ins, starts some
+ * plug-ins and then passes control over to the started plug-ins.
+ *
+ * @param ctx the plug-in context containing the plug-ins
+ */
+CP_C_API void cp_run_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);
+
+/**
+ * Runs one registered run function. This function calls one
+ * active run function registered by a started plug-in. When the run function
+ * returns this function also returns and passes control back to the main
+ * program. The return value can be used to determine whether there are any
+ * active run functions left. This function does nothing if there are no active
+ * registered run functions.
+ *
+ * @param ctx the plug-in context containing the plug-ins
+ * @return whether there are active run functions waiting to be run
+ */
+CP_C_API int cp_run_plugins_step(cp_context_t *ctx) CP_GCC_NONNULL(1);
+
+/**
+ * Sets startup arguments for the specified plug-in context. Like for usual
+ * C main functions, the first argument is expected to be the name of the
+ * program being executed or an empty string and the argument array should be
+ * terminated by NULL entry. If the main program is
+ * about to pass startup arguments to plug-ins it should call this function
+ * before starting any plug-ins in the context. The arguments are not copied
+ * and the caller is responsible for keeping the argument data available once
+ * the arguments have been set until the context is destroyed. Plug-ins can
+ * access the startup arguments using ::cp_get_context_args.
+ *
+ * @param ctx the plug-in context
+ * @param argv a NULL-terminated array of arguments
+ */
+CP_C_API void cp_set_context_args(cp_context_t *ctx, char **argv) CP_GCC_NONNULL(1, 2);
+
+/**
+ * Returns the startup arguments associated with the specified
+ * plug-in context. This function is intended to be used by a plug-in runtime.
+ * Startup arguments are set by the main program using ::cp_set_context_args.
+ * The returned argument count is zero and the array pointer is NULL if no
+ * arguments have been set.
+ *
+ * @param ctx the plug-in context
+ * @param argc a pointer to a location where the number of startup arguments is stored, or NULL for none
+ * @return an argument array terminated by NULL or NULL if not set
+ */
+CP_C_API char **cp_get_context_args(cp_context_t *ctx, int *argc) CP_GCC_NONNULL(1);
+
+/*@}*/
+
+
+/**
+ * @defgroup cFuncsSymbols Dynamic symbols
+ * @ingroup cFuncs
+ *
+ * These functions can be used to dynamically access symbols exported by the
+ * plug-ins. They are intended to be used by a plug-in runtime or by the main
+ * program.
+ */
+/*@{*/
+
+/**
+ * Defines a context specific symbol. If a plug-in has symbols which have
+ * a plug-in instance specific value then the plug-in should define those
+ * symbols when it is started. The defined symbols are cleared
+ * automatically when the plug-in instance is stopped. Symbols can not be
+ * redefined.
+ *
+ * @param ctx the plug-in context
+ * @param name the name of the symbol
+ * @param ptr pointer value for the symbol
+ * @return @ref CP_OK (zero) on success or a status code on failure
+ */
+CP_C_API cp_status_t cp_define_symbol(cp_context_t *ctx, const char *name, void *ptr) CP_GCC_NONNULL(1, 2, 3);
+
+/**
+ * Resolves a symbol provided by the specified plug-in. The plug-in is started
+ * automatically if it is not already active. The symbol may be context
+ * specific or global. The framework first looks for a context specific
+ * symbol and then falls back to resolving a global symbol exported by the
+ * plug-in runtime library. The symbol can be released using
+ * ::cp_release_symbol when it is not needed anymore. Pointers obtained from
+ * this function must not be passed on to other plug-ins or the main
+ * program.
+ *
+ * When a plug-in runtime calls this function the plug-in framework creates
+ * a dynamic dependency from the symbol using plug-in to the symbol
+ * defining plug-in. The symbol using plug-in is stopped automatically if the
+ * symbol defining plug-in is about to be stopped. If the symbol using plug-in
+ * does not explicitly release the symbol then it is automatically released
+ * after a call to the stop function. It is not safe to refer to a dynamically
+ * resolved symbol in the stop function except to release it using
+ * ::cp_release_symbol.
+ *
+ * When the main program calls this function it is the responsibility of the
+ * main program to always release the symbol before the symbol defining plug-in
+ * is stopped. It is a fatal error if the symbol is not released before the
+ * symbol defining plug-in is stopped.
+ *
+ * @param ctx the plug-in context
+ * @param id the identifier of the symbol defining plug-in
+ * @param name the name of the symbol
+ * @param status a pointer to the location where the status code is to be stored, or NULL
+ * @return the pointer associated with the symbol or NULL on failure
+ */
+CP_C_API void *cp_resolve_symbol(cp_context_t *ctx, const char *id, const char *name, cp_status_t *status) CP_GCC_NONNULL(1, 2, 3);
+
+/**
+ * Releases a previously obtained symbol. The pointer must not be used after
+ * the symbol has been released. The symbol is released
+ * only after as many calls to this function as there have been for
+ * ::cp_resolve_symbol for the same plug-in and symbol.
+ *
+ * @param ctx the plug-in context
+ * @param ptr the pointer associated with the symbol
+ */
+CP_C_API void cp_release_symbol(cp_context_t *ctx, const void *ptr) CP_GCC_NONNULL(1, 2);
+
+/*@}*/
+
+
+#ifdef __cplusplus
+}
+#endif /*__cplusplus*/
+
+#endif /*CPLUFF_H_*/
Added: trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluffdef.h
===================================================================
--- trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluffdef.h (rev 0)
+++ trunk/xbmc/lib/cpluff-0.1.3/libcpluff/cpluffdef.h 2010-03-26 23:40:48 UTC (rev 28882)
@@ -0,0 +1,200 @@
+/*-------------------------------------------------------------------------
+ * C-Pluff, a plug-in framework for C
+ * Copyright 2007 Johannes Lehtinen
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *-----------------------------------------------------------------------*/
+
+/** @file
+ * Common defines shared by C-Pluff C and C++ APIs.
+ * This file is automatically included by the top level C and C++
+ * API header files. There should be no need to include it explicitly.
+ */
+
+#ifndef CPLUFFDEF_H_
+#define CPLUFFDEF_H_
+
+
+/* ------------------------------------------------------------------------
+ * Version information
+ * ----------------------------------------------------------------------*/
+
+/**
+ * @defgroup versionInfo Version information
+ * @ingroup cDefines cxxDefines
+ *
+ * C-Pluff version information. Notice that this version information
+ * is static version information included in header files. The
+ * macros introduced here can be used for compile time checks.
+ */
+/*@{*/
+
+/**
+ * The C-Pluff release version string. This string identifies a specific
+ * version of the C-Pluff distribution. Compile time software compatibility
+ * checks should use #CP_VERSION_MAJOR and #CP_VERSION_MINOR instead.
+ */
+#define CP_VERSION "0.1.3"
+
+/**
+ * The major version number component of the release version. This is an
+ * integer.
+ */
+#define CP_VERSION_MAJOR 0
+
+/**
+ * The minor version number component of the release version. This is an
+ * integer.
+ */
+#define CP_VERSION_MINOR 1
+
+/*@}*/
+
+
+/* ------------------------------------------------------------------------
+ * Symbol visibility
+ * ----------------------------------------------------------------------*/
+
+/**
+ * @defgroup symbolVisibility Symbol visibility
+ * @ingroup cDefines cxxDefines
+ *
+ * Macros for controlling inter-module symbol visibility and linkage. These
+ * macros have platform specific values. #CP_EXPORT, #CP_IMPORT and #CP_HIDDEN
+ * can be reused by plug-in implementations for better portability. The
+ * complexity is mostly due to Windows DLL exports and imports.
+ *
+ * @anchor symbolVisibilityExample
+ * Each module should usually define its own macro to declare API symbols with
+ * #CP_EXPORT and #CP_IMPORT as necessary. For example, a mobule could define
+ * a macro @c MY_API in the API header file as follows.
+ *
+ * @code
+ * #ifndef MY_API
+ * # define MY_API CP_IMPORT
+ * #endif
+ * @endcode
+ *
+ * By default the API symbols would then be marked for import which is correct
+ * when client modules are including the API header file. When compiling the
+ * module itself the option @c -DMY_API=CP_EXPORT would be passed to the compiler to
+ * override the API header file and to mark the API symbols for export.
+ * The overriding definition could also be included in module source files or
+ * in an internal header file before including the API header file.
+ */
+/*@{*/
+
+/**
+ * @def CP_EXPORT
+ *
+ * Declares a symbol to be exported for inter-module usage. When compiling the
+ * module which defines the symbol this macro should be placed
+ * at the start of the symbol declaration to ensure that the symbol is exported
+ * to other modules. However, when compiling other modules the declaration of
+ * the symbol should start with #CP_IMPORT.
+ * See @ref symbolVisibilityExample "the example" of how to do this.
+ */
+
+/**
+ * @def CP_IMPORT
+ *
+ * Declares a symbol to be imported from another module. When compiling a
+ * module which uses the symbol this macro should be placed at the start of
+ * the symbol declaration to ensure that the symbol is imported from the
+ * defining module. However, when compiling the defining module the declaration
+ * of the symbol should start with #CP_EXPORT.
+ * See @ref symbolVisibilityExample "the example" of how to do this.
+ */
+
+/**
+ * @def CP_HIDDEN
+ *
+ * Declares a symbol hidden from other modules. This macro should be
+ * placed at the start of the symbol declaration to hide the symbol from other
+ * modules (if supported by the platform). This macro is not intended to be
+ * used with symbols declared as "static" which are already internal to the
+ * object file. Some platforms do not support hiding of symbols and therefore
+ * unique prefixes should be used for global symbols internal to the module
+ * even when they are declared using this macro.
+ */
+
+#if defined(_WIN32)
+# define CP_EXPORT __declspec(dllexport)
+# define CP_IMPORT extern __declspec(dllimport)
+# define CP_HIDDEN
+#elif defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
+# define CP_EXPORT
+# define CP_IMPORT extern
+# define CP_HIDDEN __attribute__ ((visibility ("hidden")))
+#else
+# define CP_EXPORT
+# define CP_IMPORT extern
+# define CP_HIDDEN
+#endif
+
+/*@}*/
+
+
+/* ------------------------------------------------------------------------
+ * GCC attributes
+ * ----------------------------------------------------------------------*/
+
+/**
+ * @defgroup cDefinesGCCAttributes GCC attributes
+ * @ingroup cDefines cxxDefines
+ *
+ * These macros conditionally define GCC attributes for declarations.
+ * They are used in C-Pluff API declarations to enable better optimization
+ * and error checking when using GCC. In non-GCC platforms they have
+ * empty values.
+ */
+/*@{*/
+
+/**
+ * @def CP_GCC_PURE
+ *
+ * Declares a function as pure function having no side effects.
+ * This attribute is supported in GCC since version 2.96.
+ * Such functions can be subject to common subexpression elimination
+ * and loop optimization.
+ */
+
+/**
+ * @def CP_GCC_NONNULL
+ *
+ * Specifies that some pointer arguments to a function should have
+ * non-NULL values. Takes a variable length list of argument indexes as
+ * arguments. This attribute is supported in GCC since version 3.3.
+ * It can be used for enhanced error checking and some optimizations.
+ */
+
+#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
+#define CP_GCC_PURE __attribute__((pure))
+#else
+#define CP_GCC_PURE
+#endif
+#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)
+#define CP_GCC_NONNULL(...) __attribute__((nonnull (__VA_ARGS__)))
+#else
+#define CP_GCC_NONNULL(...)
+#endif
+
+/*@}*/
+
+#endif /*CPLUFFDEF_H_*/
Added: trunk/xbmc/lib/cpluff-0.1.3/libcpluff/docsrc/Doxyfile-impl
===================================================================
--- trunk/xbmc/lib/cpluff-0.1.3/libcpluff/docsrc/Doxyfile-impl (rev 0)
+++ trunk/xbmc/lib/cpluff-0.1.3/libcpluff/docsrc/Doxyfile-impl 2010-03-26 23:40:48 UTC (rev 28882)
@@ -0,0 +1,1256 @@
+# Doxyfile 1.5.1
+
+# Copyright 2007 Johannes Lehtinen
+# This configuration file is free software; Johannes Lehtinen gives unlimited
+# permission to copy, distribute and modify it.
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = "C-Pluff C Implementation"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = "0.1.3 (API version @CP_CORE_API_CURRENT@)"
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
+# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
+# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
+# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# This tag can be used to specify the encoding used in the generated output.
+# The encoding is not always determined by the language that is chosen,
+# but also whether or not the output is meant for Windows or non-Windows users.
+# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
+# forces the Windows encoding (this is the default for the Windows binary),
+# whereas setting the tag to NO uses a Unix-style encoding (the default for
+# all platforms other than Windows).
+
+USE_WINDOWS_ENCODING = NO
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = YES
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like the Qt-style comments (thus requiring an
+# explicit @brief command for a brief description.
+
+JAVADOC_AUTOBRIEF = YES
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = YES
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for Java.
+# For instance, namespaces will be presented as packages, qualified scopes
+# will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
+# include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = YES
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = YES
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = NO
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from the
+# version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = .
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
+
+FILE_PATTERNS = *.c *.h
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES (the default)
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER = doxygen.footer
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET = doxygen.css
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
@@ Diff output truncated at 100000 characters. @@
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|