From 9447e594586a6645a186614742303f98e4851227 Mon Sep 17 00:00:00 2001 From: "h.udo" Date: Thu, 20 Oct 2016 16:06:21 +0100 Subject: [c-pluff] Update to 0.1.4 --- lib/cpluff/doc/.htaccess | 12 + lib/cpluff/doc/download.en.html | 199 ++++++++ lib/cpluff/doc/listconfirm/alreadyon.en.php | 36 ++ lib/cpluff/doc/listconfirm/confirm.en.php | 38 ++ lib/cpluff/doc/listconfirm/invalid.en.php | 39 ++ lib/cpluff/doc/listconfirm/noton.en.php | 38 ++ .../doc/listconfirm/subscribed-announcement.en.php | 39 ++ .../listconfirm/unsubscribed-announcement.en.php | 36 ++ lib/cpluff/doc/lists.en.html | 111 +++++ lib/cpluff/doc/reference/c-api/annotated.html | 38 -- lib/cpluff/doc/reference/c-api/architecture.html | 34 -- lib/cpluff/doc/reference/c-api/architecture.png | Bin 23103 -> 0 bytes lib/cpluff/doc/reference/c-api/cMainProgram.html | 198 -------- .../doc/reference/c-api/cpluff_8h-source.html | 371 --------------- lib/cpluff/doc/reference/c-api/cpluff_8h.html | 279 ------------ lib/cpluff/doc/reference/c-api/cpluff_8h__incl.map | 2 - lib/cpluff/doc/reference/c-api/cpluff_8h__incl.md5 | 1 - lib/cpluff/doc/reference/c-api/cpluff_8h__incl.png | Bin 1410 -> 0 bytes .../doc/reference/c-api/cpluffdef_8h-source.html | 104 ----- lib/cpluff/doc/reference/c-api/cpluffdef_8h.html | 71 --- .../reference/c-api/cpluffdef_8h__dep__incl.map | 2 - .../reference/c-api/cpluffdef_8h__dep__incl.md5 | 1 - .../reference/c-api/cpluffdef_8h__dep__incl.png | Bin 1509 -> 0 bytes lib/cpluff/doc/reference/c-api/doxygen.css | 360 --------------- lib/cpluff/doc/reference/c-api/doxygen.png | Bin 1281 -> 0 bytes lib/cpluff/doc/reference/c-api/files.html | 34 -- lib/cpluff/doc/reference/c-api/functions.html | 155 ------- lib/cpluff/doc/reference/c-api/functions_vars.html | 155 ------- lib/cpluff/doc/reference/c-api/globals.html | 193 -------- lib/cpluff/doc/reference/c-api/globals_eval.html | 78 ---- lib/cpluff/doc/reference/c-api/globals_func.html | 129 ------ lib/cpluff/doc/reference/c-api/globals_type.html | 70 --- lib/cpluff/doc/reference/c-api/graph_legend.dot | 23 - lib/cpluff/doc/reference/c-api/graph_legend.html | 87 ---- lib/cpluff/doc/reference/c-api/graph_legend.png | Bin 8326 -> 0 bytes .../doc/reference/c-api/group__cDefines.html | 76 ---- .../c-api/group__cDefinesGCCAttributes.html | 83 ---- lib/cpluff/doc/reference/c-api/group__cEnums.html | 180 -------- lib/cpluff/doc/reference/c-api/group__cFuncs.html | 74 --- .../doc/reference/c-api/group__cFuncsContext.html | 215 --------- .../c-api/group__cFuncsFrameworkInfo.html | 91 ---- .../doc/reference/c-api/group__cFuncsInit.html | 123 ----- .../doc/reference/c-api/group__cFuncsLogging.html | 222 --------- .../doc/reference/c-api/group__cFuncsPlugin.html | 360 --------------- .../reference/c-api/group__cFuncsPluginExec.html | 228 ---------- .../reference/c-api/group__cFuncsPluginInfo.html | 498 --------------------- .../doc/reference/c-api/group__cFuncsSymbols.html | 186 -------- .../doc/reference/c-api/group__cScanFlags.html | 118 ----- .../doc/reference/c-api/group__cStructs.html | 52 --- .../doc/reference/c-api/group__cTypedefs.html | 49 -- .../doc/reference/c-api/group__cTypedefsFuncs.html | 149 ------ .../reference/c-api/group__cTypedefsOpaque.html | 58 --- .../reference/c-api/group__cTypedefsShorthand.html | 218 --------- .../reference/c-api/group__symbolVisibility.html | 104 ----- .../doc/reference/c-api/group__versionInfo.html | 98 ---- lib/cpluff/doc/reference/c-api/index.html | 37 -- .../doc/reference/c-api/inline_dotgraph_1.png | Bin 1662 -> 0 bytes lib/cpluff/doc/reference/c-api/modules.html | 53 --- lib/cpluff/doc/reference/c-api/pages.html | 33 -- lib/cpluff/doc/reference/c-api/plugin.html | 115 ----- .../reference/c-api/structcp__cfg__element__t.html | 206 --------- .../structcp__cfg__element__t__coll__graph.map | 1 - .../structcp__cfg__element__t__coll__graph.md5 | 1 - .../structcp__cfg__element__t__coll__graph.png | Bin 2129 -> 0 bytes .../reference/c-api/structcp__ext__point__t.html | 138 ------ .../c-api/structcp__ext__point__t__coll__graph.map | 5 - .../c-api/structcp__ext__point__t__coll__graph.md5 | 1 - .../c-api/structcp__ext__point__t__coll__graph.png | Bin 8833 -> 0 bytes .../reference/c-api/structcp__extension__t.html | 172 ------- .../c-api/structcp__extension__t__coll__graph.map | 5 - .../c-api/structcp__extension__t__coll__graph.md5 | 1 - .../c-api/structcp__extension__t__coll__graph.png | Bin 9671 -> 0 bytes .../c-api/structcp__plugin__import__t.html | 105 ----- .../reference/c-api/structcp__plugin__info__t.html | 372 --------------- .../structcp__plugin__info__t__coll__graph.map | 5 - .../structcp__plugin__info__t__coll__graph.md5 | 1 - .../structcp__plugin__info__t__coll__graph.png | Bin 8218 -> 0 bytes .../c-api/structcp__plugin__runtime__t.html | 172 ------- lib/cpluff/doc/reference/c-api/tab_b.gif | Bin 35 -> 0 bytes lib/cpluff/doc/reference/c-api/tab_l.gif | Bin 706 -> 0 bytes lib/cpluff/doc/reference/c-api/tab_r.gif | Bin 2585 -> 0 bytes lib/cpluff/doc/reference/c-api/tabs.css | 102 ----- lib/cpluff/doc/repository.en.html | 80 ++++ lib/cpluff/doc/robots.txt | 3 + 84 files changed, 631 insertions(+), 7092 deletions(-) create mode 100644 lib/cpluff/doc/.htaccess create mode 100644 lib/cpluff/doc/download.en.html create mode 100644 lib/cpluff/doc/listconfirm/alreadyon.en.php create mode 100644 lib/cpluff/doc/listconfirm/confirm.en.php create mode 100644 lib/cpluff/doc/listconfirm/invalid.en.php create mode 100644 lib/cpluff/doc/listconfirm/noton.en.php create mode 100644 lib/cpluff/doc/listconfirm/subscribed-announcement.en.php create mode 100644 lib/cpluff/doc/listconfirm/unsubscribed-announcement.en.php create mode 100644 lib/cpluff/doc/lists.en.html delete mode 100644 lib/cpluff/doc/reference/c-api/annotated.html delete mode 100644 lib/cpluff/doc/reference/c-api/architecture.html delete mode 100644 lib/cpluff/doc/reference/c-api/architecture.png delete mode 100644 lib/cpluff/doc/reference/c-api/cMainProgram.html delete mode 100644 lib/cpluff/doc/reference/c-api/cpluff_8h-source.html delete mode 100644 lib/cpluff/doc/reference/c-api/cpluff_8h.html delete mode 100644 lib/cpluff/doc/reference/c-api/cpluff_8h__incl.map delete mode 100644 lib/cpluff/doc/reference/c-api/cpluff_8h__incl.md5 delete mode 100644 lib/cpluff/doc/reference/c-api/cpluff_8h__incl.png delete mode 100644 lib/cpluff/doc/reference/c-api/cpluffdef_8h-source.html delete mode 100644 lib/cpluff/doc/reference/c-api/cpluffdef_8h.html delete mode 100644 lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.map delete mode 100644 lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.md5 delete mode 100644 lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.png delete mode 100644 lib/cpluff/doc/reference/c-api/doxygen.css delete mode 100644 lib/cpluff/doc/reference/c-api/doxygen.png delete mode 100644 lib/cpluff/doc/reference/c-api/files.html delete mode 100644 lib/cpluff/doc/reference/c-api/functions.html delete mode 100644 lib/cpluff/doc/reference/c-api/functions_vars.html delete mode 100644 lib/cpluff/doc/reference/c-api/globals.html delete mode 100644 lib/cpluff/doc/reference/c-api/globals_eval.html delete mode 100644 lib/cpluff/doc/reference/c-api/globals_func.html delete mode 100644 lib/cpluff/doc/reference/c-api/globals_type.html delete mode 100644 lib/cpluff/doc/reference/c-api/graph_legend.dot delete mode 100644 lib/cpluff/doc/reference/c-api/graph_legend.html delete mode 100644 lib/cpluff/doc/reference/c-api/graph_legend.png delete mode 100644 lib/cpluff/doc/reference/c-api/group__cDefines.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cDefinesGCCAttributes.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cEnums.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncs.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsContext.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsFrameworkInfo.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsInit.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsLogging.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsPlugin.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsPluginExec.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsPluginInfo.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cFuncsSymbols.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cScanFlags.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cStructs.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cTypedefs.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cTypedefsFuncs.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cTypedefsOpaque.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__cTypedefsShorthand.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__symbolVisibility.html delete mode 100644 lib/cpluff/doc/reference/c-api/group__versionInfo.html delete mode 100644 lib/cpluff/doc/reference/c-api/index.html delete mode 100644 lib/cpluff/doc/reference/c-api/inline_dotgraph_1.png delete mode 100644 lib/cpluff/doc/reference/c-api/modules.html delete mode 100644 lib/cpluff/doc/reference/c-api/pages.html delete mode 100644 lib/cpluff/doc/reference/c-api/plugin.html delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__cfg__element__t.html delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.map delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.md5 delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.png delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__ext__point__t.html delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.map delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.md5 delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.png delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__extension__t.html delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.map delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.md5 delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.png delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__plugin__import__t.html delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__plugin__info__t.html delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.map delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.md5 delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.png delete mode 100644 lib/cpluff/doc/reference/c-api/structcp__plugin__runtime__t.html delete mode 100644 lib/cpluff/doc/reference/c-api/tab_b.gif delete mode 100644 lib/cpluff/doc/reference/c-api/tab_l.gif delete mode 100644 lib/cpluff/doc/reference/c-api/tab_r.gif delete mode 100644 lib/cpluff/doc/reference/c-api/tabs.css create mode 100644 lib/cpluff/doc/repository.en.html create mode 100644 lib/cpluff/doc/robots.txt (limited to 'lib/cpluff/doc') diff --git a/lib/cpluff/doc/.htaccess b/lib/cpluff/doc/.htaccess new file mode 100644 index 0000000000..82d4d99531 --- /dev/null +++ b/lib/cpluff/doc/.htaccess @@ -0,0 +1,12 @@ +Options +MultiViews +DirectoryIndex index +AddType text/plain;charset=US-ASCII .asc +AddType text/plain;charset=US-ASCII .gpg +AddType text/html;charset=UTF-8 .html +AddType text/css .css +AddType image/vnd.microsoft.icon .ico +AddLanguage en .en +AddLanguage fi .fi +AddLanguage sv .sv +LanguagePriority en fi sv +ForceLanguagePriority Fallback diff --git a/lib/cpluff/doc/download.en.html b/lib/cpluff/doc/download.en.html new file mode 100644 index 0000000000..2d862c775b --- /dev/null +++ b/lib/cpluff/doc/download.en.html @@ -0,0 +1,199 @@ + + + + + + + + + + Download C-Pluff + + + +
+ +

Download C-Pluff

+ + + +

Source code distribution

+

+ You can download the source code distribution here. It is currently + known to compile on Linux with GCC and MinGW (for Windows + cross-compilation). +

+ +

+ The change log and + the roadmap are available separately. +

+ +

Precompiled binaries

+

+ Here are the binary distributions currently available. If you would + like to have precompiled binaries for some other platform, you can ask + for it on the users mailing list and we will see if that can be arranged. +

+ + +

Debian GNU/Linux

+

+ Precompiled binaries are currently available for the i386 architecture. + C-Pluff is divided into three separate binary packages and the + debianized source package: +

+
+ +
cpluff
+
the debianized source package
+ +
libcpluff0
+
the runtime library and locale data
+ +
cpluff-loader
+
C-Pluff Loader, a generic plug-in loader
+ +
libcpluff0-dev
+
the development library, header files, documentation, example + source code and C-Pluff Console
+ +
+

+ To be able to install the packages, add the following source + specification into /etc/apt/sources.list. +

+ 
+deb http://www.c-pluff.org/downloads/debian stable cpluff
+deb-src http://www.c-pluff.org/downloads/debian stable cpluff
+

+ You can replace "stable" with "testing", "sarge" or "etch". Currently + there is only one set of binaries which can be used with any of the + listed Debian releases (not tested with unstable or experimental). + The second line is needed only if you want to download the debianized + source package. +

+

+ Then run "aptitude update" as root and install selected packages using + "aptitude install <package>" (or the interactive user interface). + The source package is downloaded by running "apt-get source cpluff". +

+

+ APT checks signatures since Debian GNU/Linux 4.0 (Etch). + The C-Pluff distribution has been signed with + my + PGP key. + If you verify the key and choose to trust me as a software + provider (yeah, right ;), you can install the key as a + trusted APT key by downloading it and using the command + "apt-key add gpg_johannes_lehtinen.asc". +

+ +

MinGW cross-compilation on Debian GNU/Linux

+

+ Precompiled binaries are available also for MinGW cross-compilation + environment on Debian GNU/Linux. Binaries (and sources) for third + party dependencies are also provided. These can be used on Debian + GNU/Linux to cross-compile C-Pluff based applications for Windows. + The Windows binary distribution (see below) is based on these binaries. +

+
+ +
cpluff-mingw
+
C-Pluff runtime library, binaries and other material
+ +
cpluff-examples-mingw
+
C-Pluff example application binaries
+ +
expat-mingw
+
Expat XML parser library runtime library and headers
+ +
libltdl-mingw
+
GNU Libtool libltdl runtime library and headers
+ +
gettext-runtime-mingw
+
GNU Gettext runtime binaries and headers
+ +
+

+ To be able to install the packages, add the following source + specification into /etc/apt/sources.list. Notice, although these packages + are placed in the i386 section, they are actually architecture + independent as they target the host platform, i586-mingw32msvc. +

+ 
+deb http://www.c-pluff.org/downloads/debian stable cpluff 3rdparty
+deb-src http://www.c-pluff.org/downloads/debian stable cpluff 3rdparty
+ +

Microsoft Windows

+

+ These precompiled binaries are for Microsoft Windows. Download one or + more zip files and extract them to the same location. The following + describes the ZIP file naming conventions. +

+
+ +
cpluff-VERSION.zip
+
C-Pluff runtime library, binaries and other material together + with third party binary dependencies (this is a union of the following + two packages, so you only need this one or the next two packages)
+ +
cpluff-VERSION-only.zip
+
C-Pluff runtime library, binaries and other material
+ +
cpluff-VERSION-deps.zip
+
third party binary dependencies
+ +
cpluff-VERSION-examples.zip
+
C-Pluff example application binaries
+ +
+

+ Download selected packages here. +

+ + + + +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/listconfirm/alreadyon.en.php b/lib/cpluff/doc/listconfirm/alreadyon.en.php new file mode 100644 index 0000000000..3b1ea5147d --- /dev/null +++ b/lib/cpluff/doc/listconfirm/alreadyon.en.php @@ -0,0 +1,36 @@ +'; ?> + + + + + + + Already subscribed + + + +
+ +

Already subscribed

+ +

+ Your e-mail address + is already subscribed to the mailing list. If you have any problems + with C-Pluff mailing lists, please contact the mailing list administrator + at listmaster@c-pluff.org. +

+

+ Return to + the C-Pluff mailing list page. +

+ +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/listconfirm/confirm.en.php b/lib/cpluff/doc/listconfirm/confirm.en.php new file mode 100644 index 0000000000..d0879e5609 --- /dev/null +++ b/lib/cpluff/doc/listconfirm/confirm.en.php @@ -0,0 +1,38 @@ +'; ?> + + + + + + + Confirm subscription + + + +
+ +

Confirm subscription

+ +

+ Your subscription request has been processed successfully but your + mailing list subscription has not yet been activated. To complete your + subscription you have to visit the link included in the verification + e-mail that has just been sent to your e-mail address + . It might take + some time for the e-mail to arrive into your inbox. +

+

+ Return to + the C-Pluff mailing list page. +

+ +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/listconfirm/invalid.en.php b/lib/cpluff/doc/listconfirm/invalid.en.php new file mode 100644 index 0000000000..2c96d99db0 --- /dev/null +++ b/lib/cpluff/doc/listconfirm/invalid.en.php @@ -0,0 +1,39 @@ +'; ?> + + + + + + + Invalid e-mail address + + + +
+ +

Invalid e-mail address

+ +

+ The e-mail address you specified, + , + is invalid. Please check that you specified + a correct address and try again. If you have any problems + with C-Pluff mailing lists, you may contact the mailing list + administrator at + listmaster@c-pluff.org. +

+

+ Return to + the C-Pluff mailing list page. +

+ +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/listconfirm/noton.en.php b/lib/cpluff/doc/listconfirm/noton.en.php new file mode 100644 index 0000000000..836dca1d1e --- /dev/null +++ b/lib/cpluff/doc/listconfirm/noton.en.php @@ -0,0 +1,38 @@ +'; ?> + + + + + + + Not subscribed + + + +
+ +

Not subscribed

+ +

+ Your e-mail address + is not subscribed to the mailing list. Please check that you specified + a correct address and try again. If you have any problems + with C-Pluff mailing lists, you may contact the mailing list + administrator at + listmaster@c-pluff.org. +

+

+ Return to + the C-Pluff mailing list page. +

+ +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/listconfirm/subscribed-announcement.en.php b/lib/cpluff/doc/listconfirm/subscribed-announcement.en.php new file mode 100644 index 0000000000..8be148d6cb --- /dev/null +++ b/lib/cpluff/doc/listconfirm/subscribed-announcement.en.php @@ -0,0 +1,39 @@ +'; ?> + + + + + + + Subscription completed + + + +
+ +

Subscription completed

+ +

+ Welcome to the C-Pluff announcement mailing list! + You have successfully subscribed to the list and forthcoming + announcements will be delivered to your + e-mail address . +

+

+ You can unsubscribe from this mailing list at any time by visiting + the C-Pluff mailing list page. +

+

+ Now you may return to the main C-Pluff page. +

+ +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/listconfirm/unsubscribed-announcement.en.php b/lib/cpluff/doc/listconfirm/unsubscribed-announcement.en.php new file mode 100644 index 0000000000..5ac3d6eb77 --- /dev/null +++ b/lib/cpluff/doc/listconfirm/unsubscribed-announcement.en.php @@ -0,0 +1,36 @@ +'; ?> + + + + + + + Unsubscription completed + + + +
+ +

Unsubscription completed

+ +

+ You have successfully unsubscribed from the C-Pluff announcement mailing + list. Your e-mail address + + has been removed from the mailing list. +

+

+ Now you may return to the main C-Pluff page + or to the C-Pluff mailing list page. +

+ +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/lists.en.html b/lib/cpluff/doc/lists.en.html new file mode 100644 index 0000000000..d793dd1820 --- /dev/null +++ b/lib/cpluff/doc/lists.en.html @@ -0,0 +1,111 @@ + + + + + + + + + + C-Pluff mailing lists + + + +
+ +

C-Pluff mailing lists

+ + + +

+ The C-Pluff announcement list is a + one-way mailing list for announcing new C-Pluff releases and features. + If you want to be always up-to-date, it is a good idea to subscribe to + the announcement list. +

+

+ The C-Pluff users list is for discussion about the usage of + C-Pluff and for reporting problems. It is the right place for support + requests and discussion about how to use C-Pluff to create extensible + applications. +

+

+ The C-Pluff developers list is for discussion about C-Pluff + development. It is the right place for posting patches, discussing new + framework features and informing other developers about internal changes. + If you are interested in participating C-Pluff development, join the + developers list. +

+ +

Manage subscriptions

+ +

+ All subscriptions are verified by sending you an e-mail containing a link + you must visit to confirm the subscription. Discussion lists allow + unmoderated postings from list members only. Non-member postings + are moderated. List archives are restricted to members to prevent + bots from harvesting e-mail addresses. If you have any problems with + C-Pluff mailing lists, please contact the mailing list administrator at + listmaster@c-pluff.org. +

+ +

C-Pluff announcement list

+ +
+

+ + + + + + + + + + Your e-mail address:
+
+ + +

+
+ +

C-Pluff users list

+ +

+ You can manage your subscription and access list archive at + users mailing list info page. +

+ +

C-Pluff developers list

+ +

+ You can manage your subscription and access list archive at + developers mailing list info page. +

+ + + +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/reference/c-api/annotated.html b/lib/cpluff/doc/reference/c-api/annotated.html deleted file mode 100644 index 1f89dd40f7..0000000000 --- a/lib/cpluff/doc/reference/c-api/annotated.html +++ /dev/null @@ -1,38 +0,0 @@ - - -C-Pluff C API: Data Structures - - - - -
-
-
-
-

C-Pluff C API Data Structures

Here are the data structures with brief descriptions: - - - - - - -
cp_cfg_element_tA configuration element contains configuration information for an extension
cp_ext_point_tExtension point structure captures information about an extension point
cp_extension_tExtension structure captures information about an extension
cp_plugin_import_tInformation about plug-in import
cp_plugin_info_tPlug-in information structure captures information about a plug-in
cp_plugin_runtime_tContainer for plug-in runtime information
-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/architecture.html b/lib/cpluff/doc/reference/c-api/architecture.html deleted file mode 100644 index f895a89529..0000000000 --- a/lib/cpluff/doc/reference/c-api/architecture.html +++ /dev/null @@ -1,34 +0,0 @@ - - -C-Pluff C API: Plug-in architecture - - - - -
-
-

Plug-in architecture

-Overview

-The plug-in architecture supported by C-Pluff is presented in the following figure. There is a thin main program controlling the plug-in framework. The main program is responsible for initializing and setting up the plug-in environment. Most of the application logic is contained in plug-ins which are independent components and can be developed and distributed separately. Plug-ins integrate with each other by providing extension points and extensions. An extension point is a point into which other plug-ins can attach extensions. An extension can be just information, expressed in XML format, or the plug-in may also provide program logic as part of the plug-in runtime library. The framework provides services for accessing extensions and for managing plug-in dependencies.

-

-architecture.png -

C-Pluff plug-in architecture

-

-Extensions

-The idea behind extension points and extensions is that the extensibility is not limited only to few fixed plug-in types supported by the core application. Although the core plug-ins typically define the extension points for the core application logic, it is possible for any plug-in to specify additional extension points.

-For example, let us assume that we are developing an extensible text editor. One extension point defined by core editor plug-in could be auto-completion extension point. A plug-in providing basic Java source code support could provide an extension for auto-completing Java code. Now, while this extension could do basic auto-completion of plain Java code, it is customary that Java source code also includes embedded documentation, such as JavaDoc comments and tags, or annotations, such as XDoclet tags, as part of doc comments. Instead of trying to support all known tags and their semantics, the plug-in providing basic Java support could define another extension point for additional plug-ins that know how to perform auto-completion of different kind of tags in doc comments. This way the extensibility of the application is not limited to the extension points defined by the core application but the plug-ins can incrementally increase the extensibility of the application.

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/architecture.png b/lib/cpluff/doc/reference/c-api/architecture.png deleted file mode 100644 index fa7cf75b29..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/architecture.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/cMainProgram.html b/lib/cpluff/doc/reference/c-api/cMainProgram.html deleted file mode 100644 index 0e59dd3585..0000000000 --- a/lib/cpluff/doc/reference/c-api/cMainProgram.html +++ /dev/null @@ -1,198 +0,0 @@ - - -C-Pluff C API: Main program - - - - -
-
-

Main program

-Overview

-The main program is the part of executable that is located outside the plug-in framework. The main program is responsible for setting up the plug-in framework and for loading the desired set of plug-ins. The main program should preferably be very thin, a mere plug-in loader, because it can not fully participate in plug-in interaction. C-Pluff distribution provides a plug-in loader, cpluff-loader, which can be used as a generic main program for arbitrary plug-in collections.

-Responsibilities

-The main program has several responsibilities:

-

-

-Initializing the plug-in framework

-Plug-in framework, or the C-Pluff library, must be initialized before its services can be used. Initialization is not a thread-safe operation and should generally be done by the main program before any additional plug-in framework accessing threads are started. Initialization is done by calling cp_init. Additionally, the main program can use cp_set_fatal_error_handler to register a function that is called when a fatal error occurs. A fatal error is one that prevents the framework from continuing operation. For example, errors in operating system locking operations and a NULL pointer being passed as an argument which is expected to have a non-NULL value are fatal erors.

-Here is an example of possible initialization code.

-

 #include <locale.h>
- #include <cpluff.h>
-
- void handle_fatal_error(const char *msg) {
-
-   // ... log error, flush logs, send bug report, etc. ...
-
-   fprintf(stderr, "A fatal error occurred: %s\n", msg);
-   abort();
- }
-
- void initialize(void) {
-   cp_status_t status;
-
-   setlocale(LC_ALL, "");
-   cp_set_fatal_error_handler(handle_fatal_error);
-   status = cp_init();
-   if (status != CP_OK) {
-     // ... handle initialization failure ...
-   }
- }
-

-Creating a plug-in context

-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. From main program perspective, a plug-in context is a container for a set of plug-ins. A plug-in can interact with other plug-ins in the same container.

-An extensible application can have more than one plug-in container but usually one container should suffice. Due to the nature of C programs, plug-ins deployed to different containers are not very well insulated from each other. For example, global variables provided by a plug-in in one container are visible to all plug-ins in all containers. Also, by placing all plug-ins in the same container they can more efficiently share common base components which themselves might provide extensibility.

-A main program creates a plug-in context, to be used as a container for plugins, using cp_create_context.

-

 #include <cpluff.h>
-
- cp_context_t *ctx;
-
- void create_context(void) {
-   cp_status_t status;
-
-   ctx = cp_create_context(&status);
-   if (ctx == NULL) {
-     // ... handle initialization failure ...
-   }
- }
-

-Loading plug-ins

-An extensible application is made of plug-ins that can be added and removed dynamically. The plug-ins are loaded by the main program using the services provided by the framework. The framework provides couple of alternative ways of loading plug-ins.

-As a lowest level operation, the main program can load individual plug-ins from known locations using cp_load_plugin_descriptor and cp_install_plugin. Here is example code that loads a set of plug-ins from file system locations listed in a file.

-

 #include <stdio.h>
- #include <cpluff.h>
-
- extern cp_context_t *ctx;
- static const char pluginListFile[] = "/etc/example/plugins.list";
-
- void load_plugins(void) {
-   char plugindir[128];
-   FILE *lf;
-
-   // Open plug-in list file
-   lf = fopen(pluginListFile, "r");
-   if (lf == NULL) {
-     // ... handle loading failure ...
-   }
-
-   // Load each listed plug-in
-   while (fgets(plugindir, 128, lf) != NULL) {
-     cp_plugin_info_t *plugininfo;
-     cp_status_t status;
-     int i;
-
-     // Remove possible trailing newline from plug-in location
-     for (i = 0; plugindir[i + 1] != '\0'; i++);
-     if (plugindir[i] == '\n') {
-       plugindir[i] = '\0';
-     }
-
-     // Load plug-in descriptor
-     plugininfo = cp_load_plugin_descriptor(ctx, plugindir, &status);
-     if (pinfo == NULL) {
-       // ... handle loading failure ...
-     }
-
-     // Install plug-in descriptor
-     status = cp_install_plugin(ctx, plugininfo);
-     if (status != CP_OK) {
-       // ... handle loading failure ...
-     }
-
-     // Release plug-in descriptor information
-     cp_release_info(ctx, plugininfo);
-   }
-
-   // Close plug-in list file
-   fclose(lf);
- }
-

-Alternatively, the main program can register and load plug-in collections. A plug-in collection is a file system directory which includes individual plug-ins in subdirectories, one plug-in in each subdirectory. Plug-in collections can be registered with a plug-in context using cp_register_pcollection. Plug-ins of the collection can then be scanned and loaded using cp_scan_plugins. Here is example code loading plug-ins from a plug-in collection.

-

 #include <cpluff.h>
-
- extern cp_context_t *ctx;
- static const char pluginCollectionDir[] = "/etc/example/plugins";
-
- void load_plugins(void) {
-   cp_status_t status;
-
-   status = cp_register_pcollection(ctx, pluginCollectionDir);
-   if (status != CP_OK) {
-     // ... handle loading failure ...
-   }
-   status = cp_scan_plugins(ctx, 0);
-   if (status != CP_OK) {
-     // ... handle loading failure ...
-     // (notice that some plug-ins might have been loaded)
-   }
- }
-

-Controlling plug-in execution

-The main program controls plug-in execution by starting and stopping plug-ins and by executing run functions registered by plug-ins. Additionally, the main program can pass startup arguments to plug-ins.

-When plug-ins are installed they are not yet activated and their runtime library is not even loaded at that point. The main program typically activates plug-ins by starting a main plug-in responsible for user interface or core application logic. This plug-in then implicitly causes other plug-ins to be activated via dependencies and by dynamically resolving symbols provided by other plug-ins. Plug-ins recursively activate each other until all initially needed plug-ins have been started. Some plug-ins might be activated at a later time when their functionality is needed, for example due to user action.

-If a plug-in needs to perform background operations, that is operations executed outside the invocation of plug-in provided interface functions, then it can either start a new thread or it can register a run function. A run function is a function that is typically executed as part of the main loop by the main program.

-The following example code shows how a main program might initialize plug-in startup arguments using cp_set_context_args, start the core plug-in using cp_start_plugin and then execute plug-in run functions using cp_run_plugins.

-

 #include <cpluff.h>
-
- extern cp_context_t *ctx;
- static const char corePluginId[] = "org.example.core";
-
- void run_plugins(char *argv[]) {
-   cp_status_t status;
-
-   // Set plug-in startup arguments
-   cp_set_context_args(ctx, argv);
-
-   // Start the core plug-in, possibly activating other plug-ins as well
-   status = cp_start_plugin(ctx, corePluginId);
-   if (status != CP_OK) {
-     // ... handle startup failure ...
-   }
-
-   // Execute plug-ins until there is no more work to be done
-   cp_run_plugins(ctx);
- }
-
- int main(int argc, char *argv[]) {
-   // ... do initialization and load plug-ins ...
-
-   run_plugins(argv);
-
-   // ... do destruction ...
- }
-

-Alternatively, if the main program has some operations it must perform as part of the main loop, the call to cp_run_plugins can be replaced by code using cp_run_plugins_step like in the following example.

-

 void mainloop(void) {
-   int finished = 0;
-
-   while (!finished) {
-     // ... do main program specific operations ...
-
-     finished = !cp_run_plugins_step(ctx);
-   }
- }
-

-Changing plug-in configuration

-C-Pluff has been designed to allow dynamic changes to the plug-in configuration, that is plug-ins being added or removed without shutting down the application or the framework. It is the responsibility of the main program to manage such changes if the application is to support dynamic configuration changes.

-Adding plug-ins is straightforward because there is no need to consider dependencies of active plug-ins. For example, if one uses plug-in collections as introduced above then new plug-ins can be deployed under the plug-in collection directory while the application is running and the main program can load them incrementally by calling cp_scan_plugins again. This call might be activated by some user interface element, for example a plug-in manager component which just downloaded and installed new plug-ins as requested by the user. The flags CP_SP_STOP_ALL_ON_INSTALL and CP_SP_RESTART_ACTIVE orred together can be used to cause all active plug-ins to be restarted if they do not otherwise notice the extensions provided by new plug-ins.

-Upgrading plug-ins is almost as straightforward because the C-Pluff framework manages plug-in dependencies (assuming the plug-ins have declared their dependencies properly). The new version of a plug-in can be deployed under the plug-in collection directory in a new subdirectory parallel to the old version while the application is running. The main program can then call cp_scan_plugins with CP_SP_UPGRADE and CP_SP_RESTART_ACTIVE orred together. This will stop the old version of the upgraded plug-in (implicitly stopping all plug-ins that depend on it), unload the plug-in from the framework, install the new version of the plug-in and finally restart plug-ins that were active before the operation. The old version of the plug-in can now be removed from the plug-in collection. Again, CP_SP_STOP_ALL_ON_UPGRADE can be added to restart all active plug-ins.

-Deleting plug-ins must be done by first stopping and unloading the plug-in to be deleted using cp_uninstall_plugin. The the plug-in can be removed from the plug-in collection.

-Destroying the plug-in framework

-The plug-in framework can be destroyed and all resources released by calling cp_destroy as many times as cp_init has been called. This is not a thread-safe operation and should generally be done by the main program just before application exits. The destroy function stops and unloads all plug-ins and destroys all plug-in contexts before destroying the core framework.

-Individual plug-in contexts can be destroyed by calling cp_destroy_context. The destroy function stops and unloads all plug-ins before destroying the context itself.

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/cpluff_8h-source.html b/lib/cpluff/doc/reference/c-api/cpluff_8h-source.html deleted file mode 100644 index 8bf2c28911..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluff_8h-source.html +++ /dev/null @@ -1,371 +0,0 @@ - - -C-Pluff C API: cpluff.h Source File - - - - -
-
-
-
-

cpluff.h

Go to the documentation of this file.
00001 /*-------------------------------------------------------------------------
-00002  * C-Pluff, a plug-in framework for C
-00003  * Copyright 2007 Johannes Lehtinen
-00004  * 
-00005  * Permission is hereby granted, free of charge, to any person obtaining a
-00006  * copy of this software and associated documentation files (the "Software"),
-00007  * to deal in the Software without restriction, including without limitation
-00008  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
-00009  * and/or sell copies of the Software, and to permit persons to whom the
-00010  * Software is furnished to do so, subject to the following conditions:
-00011  *
-00012  * The above copyright notice and this permission notice shall be included
-00013  * in all copies or substantial portions of the Software.
-00014  *
-00015  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-00016  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-00017  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-00018  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-00019  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-00020  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-00021  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-00022  *-----------------------------------------------------------------------*/
-00023 
-00033 #ifndef CPLUFF_H_
-00034 #define CPLUFF_H_
-00035 
-00041 #include <cpluffdef.h>
-00042 
-00043 #ifdef __cplusplus
-00044 extern "C" {
-00045 #endif /*__cplusplus*/
-00046 
-00047 
-00048 /* ------------------------------------------------------------------------
-00049  * Defines
-00050  * ----------------------------------------------------------------------*/
-00051 
-00060 #ifndef CP_C_API
-00061 #define CP_C_API CP_IMPORT
-00062 #endif
-00063 
-00064 
-00073 
-00078 #define CP_SP_UPGRADE 0x01
-00079 
-00084 #define CP_SP_STOP_ALL_ON_UPGRADE 0x02
-00085 
-00091 #define CP_SP_STOP_ALL_ON_INSTALL 0x04
-00092 
-00097 #define CP_SP_RESTART_ACTIVE 0x08
-00098 
-00102 /* ------------------------------------------------------------------------
-00103  * Data types
-00104  * ----------------------------------------------------------------------*/
-00105 
-00122 /* Enumerations */
-00123 
-00133 enum cp_status_t {
-00134 
-00139         CP_OK = 0,
-00140 
-00142         CP_ERR_RESOURCE,
-00143 
-00145         CP_ERR_UNKNOWN,
-00146 
-00148         CP_ERR_IO,
-00149 
-00151         CP_ERR_MALFORMED,
-00152 
-00154         CP_ERR_CONFLICT,
-00155 
-00157         CP_ERR_DEPENDENCY,
-00158 
-00160         CP_ERR_RUNTIME
-00161         
-00162 };
-00163 
-00175 enum cp_plugin_state_t {
-00176 
-00181         CP_PLUGIN_UNINSTALLED,
-00182         
-00190         CP_PLUGIN_INSTALLED,
-00191         
-00202         CP_PLUGIN_RESOLVED,
-00203         
-00213         CP_PLUGIN_STARTING,
-00214         
-00224         CP_PLUGIN_STOPPING,
-00225         
-00230         CP_PLUGIN_ACTIVE
-00231         
-00232 };
-00233 
-00241 enum cp_log_severity_t {
-00242 
-00244         CP_LOG_DEBUG,
-00245         
-00247         CP_LOG_INFO,
-00248         
-00250         CP_LOG_WARNING,
-00251         
-00253         CP_LOG_ERROR
-00254         
-00255 };
-00256 
-00260 /* Typedefs */
-00261 
-00268  
-00281 typedef struct cp_context_t cp_context_t;
-00282 
-00291 
-00293 typedef struct cp_plugin_info_t cp_plugin_info_t;
-00294 
-00296 typedef struct cp_plugin_import_t cp_plugin_import_t;
-00297 
-00299 typedef struct cp_ext_point_t cp_ext_point_t;
-00300 
-00302 typedef struct cp_extension_t cp_extension_t;
-00303 
-00305 typedef struct cp_cfg_element_t cp_cfg_element_t;
-00306 
-00308 typedef struct cp_plugin_runtime_t cp_plugin_runtime_t;
-00309 
-00311 typedef enum cp_status_t cp_status_t;
-00312 
-00314 typedef enum cp_plugin_state_t cp_plugin_state_t;
-00315 
-00317 typedef enum cp_log_severity_t cp_log_severity_t;
-00318 
-00327 
-00344 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);
-00345 
-00358 typedef void (*cp_logger_func_t)(cp_log_severity_t severity, const char *msg, const char *apid, void *user_data);
-00359 
-00369 typedef void (*cp_fatal_error_func_t)(const char *msg);
-00370 
-00381 typedef int (*cp_run_func_t)(void *plugin_data);
-00382 
-00386 /* Data structures */
-00387 
-00396 struct cp_plugin_info_t {
-00397         
-00405         char *identifier;
-00406         
-00413         char *name;
-00414         
-00420         char *version;
-00421         
-00429         char *provider_name;
-00430         
-00438         char *plugin_path;
-00439         
-00451         char *abi_bw_compatibility;
-00452         
-00465         char *api_bw_compatibility;
-00466         
-00475         char *req_cpluff_version;
-00476         
-00478         unsigned int num_imports;
-00479         
-00484         cp_plugin_import_t *imports;
-00485 
-00493     char *runtime_lib_name;
-00494     
-00501     char *runtime_funcs_symbol;
-00502     
-00504         unsigned int num_ext_points;
-00505         
-00511         cp_ext_point_t *ext_points;
-00512         
-00514         unsigned int num_extensions;
-00515         
-00521         cp_extension_t *extensions;
-00522 
-00523 };
-00524 
-00530 struct cp_plugin_import_t {
-00531         
-00536         char *plugin_id;
-00537         
-00546         char *version;
-00547         
-00557         int optional;
-00558 };
-00559 
-00566 struct cp_ext_point_t {
-00567 
-00573         cp_plugin_info_t *plugin;
-00574         
-00580         char *local_id;
-00581         
-00587         char *identifier;
-00588 
-00595         char *name;
-00596         
-00603         char *schema_path;
-00604 };
-00605 
-00611 struct cp_extension_t {
-00612 
-00618         cp_plugin_info_t *plugin;
-00619         
-00625         char *ext_point_id;
-00626         
-00632         char *local_id;
-00633 
-00639     char *identifier;
-00640          
-00647         char *name;
-00648         
-00655         cp_cfg_element_t *configuration;
-00656 };
-00657 
-00667 struct cp_cfg_element_t {
-00668         
-00673         char *name;
-00674 
-00676         unsigned int num_atts;
-00677         
-00682         char **atts;
-00683         
-00689         char *value;
-00690         
-00692         cp_cfg_element_t *parent;
-00693         
-00695         unsigned int index;
-00696         
-00698         unsigned int num_children;
-00699 
-00704         cp_cfg_element_t *children;
-00705 };
-00706 
-00734 struct cp_plugin_runtime_t {
-00735 
-00753         void *(*create)(cp_context_t *ctx);
-00754 
-00775         int (*start)(void *data);
-00776         
-00800         void (*stop)(void *data);
-00801 
-00814         void (*destroy)(void *data);
-00815 
-00816 };
-00817 
-00821 /* ------------------------------------------------------------------------
-00822  * Function declarations
-00823  * ----------------------------------------------------------------------*/
-00824 
-00844 
-00851 CP_C_API const char *cp_get_version(void) CP_GCC_PURE;
-00852 
-00860 CP_C_API const char *cp_get_host_type(void) CP_GCC_PURE;
-00861 
-00874 
-00885 CP_C_API void cp_set_fatal_error_handler(cp_fatal_error_func_t error_handler);
-00886 
-00902 CP_C_API cp_status_t cp_init(void);
-00903 
-00914 CP_C_API void cp_destroy(void);
-00915 
-00933 
-00947 CP_C_API cp_context_t * cp_create_context(cp_status_t *status);
-00948 
-00956 CP_C_API void cp_destroy_context(cp_context_t *ctx) CP_GCC_NONNULL(1);
-00957 
-00970 CP_C_API cp_status_t cp_register_pcollection(cp_context_t *ctx, const char *dir) CP_GCC_NONNULL(1, 2);
-00971 
-00981 CP_C_API void cp_unregister_pcollection(cp_context_t *ctx, const char *dir) CP_GCC_NONNULL(1, 2);
-00982 
-00990 CP_C_API void cp_unregister_pcollections(cp_context_t *ctx) CP_GCC_NONNULL(1);
-00991 
-01004 
-01020 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);
-01021 
-01028 CP_C_API void cp_unregister_logger(cp_context_t *ctx, cp_logger_func_t logger) CP_GCC_NONNULL(1, 2);
-01029 
-01037 CP_C_API void cp_log(cp_context_t *ctx, cp_log_severity_t severity, const char *msg) CP_GCC_NONNULL(1, 3);
-01038 
-01046 CP_C_API int cp_is_logged(cp_context_t *ctx, cp_log_severity_t severity) CP_GCC_NONNULL(1);
-01047 
-01059 
-01076 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);
-01077 
-01094 CP_C_API cp_status_t cp_install_plugin(cp_context_t *ctx, cp_plugin_info_t *pi) CP_GCC_NONNULL(1, 2);
-01095 
-01119 CP_C_API cp_status_t cp_scan_plugins(cp_context_t *ctx, int flags) CP_GCC_NONNULL(1);
-01120 
-01133 CP_C_API cp_status_t cp_start_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
-01134 
-01147 CP_C_API cp_status_t cp_stop_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
-01148 
-01154 CP_C_API void cp_stop_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);
-01155 
-01164 CP_C_API cp_status_t cp_uninstall_plugin(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
-01165 
-01172 CP_C_API void cp_uninstall_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);
-01173 
-01186 
-01200 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);
-01201 
-01214 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);
-01215 
-01228 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);
-01229 
-01243 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);
-01244 
-01255 CP_C_API void cp_release_info(cp_context_t *ctx, void *info) CP_GCC_NONNULL(1, 2);
-01256 
-01265 CP_C_API cp_plugin_state_t cp_get_plugin_state(cp_context_t *ctx, const char *id) CP_GCC_NONNULL(1, 2);
-01266 
-01280 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);
-01281 
-01289 CP_C_API void cp_unregister_plistener(cp_context_t *ctx, cp_plugin_listener_func_t listener) CP_GCC_NONNULL(1, 2);
-01290 
-01304 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);
-01305 
-01322 CP_C_API char * cp_lookup_cfg_value(cp_cfg_element_t *base, const char *path) CP_GCC_PURE CP_GCC_NONNULL(1, 2);
-01323 
-01351 
-01365 CP_C_API cp_status_t cp_run_function(cp_context_t *ctx, cp_run_func_t runfunc) CP_GCC_NONNULL(1, 2);
-01366 
-01376 CP_C_API void cp_run_plugins(cp_context_t *ctx) CP_GCC_NONNULL(1);
-01377 
-01389 CP_C_API int cp_run_plugins_step(cp_context_t *ctx) CP_GCC_NONNULL(1);
-01390 
-01405 CP_C_API void cp_set_context_args(cp_context_t *ctx, char **argv) CP_GCC_NONNULL(1, 2);
-01406 
-01418 CP_C_API char **cp_get_context_args(cp_context_t *ctx, int *argc) CP_GCC_NONNULL(1);
-01419 
-01432 
-01445 CP_C_API cp_status_t cp_define_symbol(cp_context_t *ctx, const char *name, void *ptr) CP_GCC_NONNULL(1, 2, 3);
-01446 
-01477 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);
-01478 
-01488 CP_C_API void cp_release_symbol(cp_context_t *ctx, const void *ptr) CP_GCC_NONNULL(1, 2);
-01489 
-01493 #ifdef __cplusplus
-01494 }
-01495 #endif /*__cplusplus*/
-01496 
-01497 #endif /*CPLUFF_H_*/
-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/cpluff_8h.html b/lib/cpluff/doc/reference/c-api/cpluff_8h.html deleted file mode 100644 index b6bfb35f6c..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluff_8h.html +++ /dev/null @@ -1,279 +0,0 @@ - - -C-Pluff C API: cpluff.h File Reference - - - - -
-
-
-
-

cpluff.h File Reference

Detailed Description

-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. -

- -

-Include dependency graph for cpluff.h:

- - - - -

-Go to the source code of this file. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Data Structures

struct  cp_plugin_info_t
 Plug-in information structure captures information about a plug-in. More...
struct  cp_plugin_import_t
 Information about plug-in import. More...
struct  cp_ext_point_t
 Extension point structure captures information about an extension point. More...
struct  cp_extension_t
 Extension structure captures information about an extension. More...
struct  cp_cfg_element_t
 A configuration element contains configuration information for an extension. More...
struct  cp_plugin_runtime_t
 Container for plug-in runtime information. More...

Defines

#define CP_C_API
 Marks a symbol declaration to be part of the C-Pluff C API.
#define CP_SP_UPGRADE
 This flag enables upgrades of installed plug-ins by unloading the old version and installing the new version.
#define CP_SP_STOP_ALL_ON_UPGRADE
 This flag causes all plug-ins to be stopped before any plug-ins are to be upgraded.
#define CP_SP_STOP_ALL_ON_INSTALL
 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_RESTART_ACTIVE
 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).

Typedefs

typedef cp_context_t cp_context_t
 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.
typedef cp_plugin_info_t cp_plugin_info_t
 A type for cp_plugin_info_t structure.
typedef cp_plugin_import_t cp_plugin_import_t
 A type for cp_plugin_import_t structure.
typedef cp_ext_point_t cp_ext_point_t
 A type for cp_ext_point_t structure.
typedef cp_extension_t cp_extension_t
 A type for cp_extension_t structure.
typedef cp_cfg_element_t cp_cfg_element_t
 A type for cp_cfg_element_t structure.
typedef cp_plugin_runtime_t cp_plugin_runtime_t
 A type for cp_plugin_runtime_t structure.
typedef enum cp_status_t cp_status_t
 A type for cp_status_t enumeration.
typedef enum cp_plugin_state_t cp_plugin_state_t
 A type for cp_plugin_state_t enumeration.
typedef enum cp_log_severity_t cp_log_severity_t
 A type for cp_log_severity_t enumeration.
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 listener function called synchronously after a plugin state change.
typedef void(*) cp_logger_func_t (cp_log_severity_t severity, const char *msg, const char *apid, void *user_data)
 A logger function called to log selected plug-in framework messages.
typedef void(*) cp_fatal_error_func_t (const char *msg)
 A fatal error handler for handling unrecoverable errors.
typedef int(*) cp_run_func_t (void *plugin_data)
 A run function registered by a plug-in to perform work.

Enumerations

enum  cp_status_t {
-  CP_OK = 0, -CP_ERR_RESOURCE, -CP_ERR_UNKNOWN, -CP_ERR_IO, -
-  CP_ERR_MALFORMED, -CP_ERR_CONFLICT, -CP_ERR_DEPENDENCY, -CP_ERR_RUNTIME -
- }
 An enumeration of status codes returned by API functions. More...
enum  cp_plugin_state_t {
-  CP_PLUGIN_UNINSTALLED, -CP_PLUGIN_INSTALLED, -CP_PLUGIN_RESOLVED, -CP_PLUGIN_STARTING, -
-  CP_PLUGIN_STOPPING, -CP_PLUGIN_ACTIVE -
- }
 An enumeration of possible plug-in states. More...
enum  cp_log_severity_t { CP_LOG_DEBUG, -CP_LOG_INFO, -CP_LOG_WARNING, -CP_LOG_ERROR - }
 An enumeration of possible message severities for framework logging. More...

Functions

const char * cp_get_version (void)
 Returns the release version string of the linked in C-Pluff implementation.
const char * cp_get_host_type (void)
 Returns the canonical host type associated with the linked in C-Pluff implementation.
void cp_set_fatal_error_handler (cp_fatal_error_func_t error_handler)
 Sets the fatal error handler called on non-recoverable errors.
cp_status_t cp_init (void)
 Initializes the plug-in framework.
void cp_destroy (void)
 Destroys the plug-in framework and releases the resources used by it.
cp_context_t * cp_create_context (cp_status_t *status)
 Creates a new plug-in context which can be used as a container for plug-ins.
void cp_destroy_context (cp_context_t *ctx)
 Destroys the specified plug-in context and releases the associated resources.
cp_status_t cp_register_pcollection (cp_context_t *ctx, const char *dir)
 Registers a plug-in collection with a plug-in context.
void cp_unregister_pcollection (cp_context_t *ctx, const char *dir)
 Unregisters a previously registered plug-in collection from a plug-in context.
void cp_unregister_pcollections (cp_context_t *ctx)
 Unregisters all plug-in collections from a plug-in context.
cp_status_t cp_register_logger (cp_context_t *ctx, cp_logger_func_t logger, void *user_data, cp_log_severity_t min_severity)
 Registers a logger with a plug-in context or updates the settings of a registered logger.
void cp_unregister_logger (cp_context_t *ctx, cp_logger_func_t logger)
 Removes a logger registration.
void cp_log (cp_context_t *ctx, cp_log_severity_t severity, const char *msg)
 Emits a new log message.
int cp_is_logged (cp_context_t *ctx, cp_log_severity_t severity)
 Returns whether a message of the specified severity would get logged.
cp_plugin_info_t * cp_load_plugin_descriptor (cp_context_t *ctx, const char *path, cp_status_t *status)
 Loads a plug-in descriptor from the specified plug-in installation path and returns information about the plug-in.
cp_status_t cp_install_plugin (cp_context_t *ctx, cp_plugin_info_t *pi)
 Installs the plug-in described by the specified plug-in information structure to the specified plug-in context.
cp_status_t cp_scan_plugins (cp_context_t *ctx, int flags)
 Scans for plug-ins in the registered plug-in directories, installing new plug-ins and upgrading installed plug-ins.
cp_status_t cp_start_plugin (cp_context_t *ctx, const char *id)
 Starts a plug-in.
cp_status_t cp_stop_plugin (cp_context_t *ctx, const char *id)
 Stops a plug-in.
void cp_stop_plugins (cp_context_t *ctx)
 Stops all active plug-ins.
cp_status_t cp_uninstall_plugin (cp_context_t *ctx, const char *id)
 Uninstalls the specified plug-in.
void cp_uninstall_plugins (cp_context_t *ctx)
 Uninstalls all plug-ins.
cp_plugin_info_t * cp_get_plugin_info (cp_context_t *ctx, const char *id, cp_status_t *status)
 Returns static information about the specified plug-in.
cp_plugin_info_t ** cp_get_plugins_info (cp_context_t *ctx, cp_status_t *status, int *num)
 Returns static information about the installed plug-ins.
cp_ext_point_t ** cp_get_ext_points_info (cp_context_t *ctx, cp_status_t *status, int *num)
 Returns static information about the currently installed extension points.
cp_extension_t ** cp_get_extensions_info (cp_context_t *ctx, const char *extpt_id, cp_status_t *status, int *num)
 Returns static information about the currently installed extension points.
void cp_release_info (cp_context_t *ctx, void *info)
 Releases a previously obtained reference counted information object.
cp_plugin_state_t cp_get_plugin_state (cp_context_t *ctx, const char *id)
 Returns the current state of the specified plug-in.
cp_status_t cp_register_plistener (cp_context_t *ctx, cp_plugin_listener_func_t listener, void *user_data)
 Registers a plug-in listener with a plug-in context.
void cp_unregister_plistener (cp_context_t *ctx, cp_plugin_listener_func_t listener)
 Removes a plug-in listener from a plug-in context.
cp_cfg_element_t * cp_lookup_cfg_element (cp_cfg_element_t *base, const char *path)
 Traverses a configuration element tree and returns the specified element.
char * cp_lookup_cfg_value (cp_cfg_element_t *base, const char *path)
 Traverses a configuration element tree and returns the value of the specified element or attribute.
cp_status_t cp_run_function (cp_context_t *ctx, cp_run_func_t runfunc)
 Registers a new run function.
void cp_run_plugins (cp_context_t *ctx)
 Runs the started plug-ins as long as there is something to run.
int cp_run_plugins_step (cp_context_t *ctx)
 Runs one registered run function.
void cp_set_context_args (cp_context_t *ctx, char **argv)
 Sets startup arguments for the specified plug-in context.
char ** cp_get_context_args (cp_context_t *ctx, int *argc)
 Returns the startup arguments associated with the specified plug-in context.
cp_status_t cp_define_symbol (cp_context_t *ctx, const char *name, void *ptr)
 Defines a context specific symbol.
void * cp_resolve_symbol (cp_context_t *ctx, const char *id, const char *name, cp_status_t *status)
 Resolves a symbol provided by the specified plug-in.
void cp_release_symbol (cp_context_t *ctx, const void *ptr)
 Releases a previously obtained symbol.
-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.map b/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.map deleted file mode 100644 index 4bee628e49..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.map +++ /dev/null @@ -1,2 +0,0 @@ -base referer -rect $cpluffdef_8h.html 125,6 219,30 diff --git a/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.md5 b/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.md5 deleted file mode 100644 index 24eee11730..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -04e67764e8c4d7feea7212175ba9155c \ No newline at end of file diff --git a/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.png b/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.png deleted file mode 100644 index 53cd9ed97c..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/cpluff_8h__incl.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/cpluffdef_8h-source.html b/lib/cpluff/doc/reference/c-api/cpluffdef_8h-source.html deleted file mode 100644 index 4366326894..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluffdef_8h-source.html +++ /dev/null @@ -1,104 +0,0 @@ - - -C-Pluff C API: cpluffdef.h Source File - - - - -
-
-
-
-

cpluffdef.h

Go to the documentation of this file.
00001 /*-------------------------------------------------------------------------
-00002  * C-Pluff, a plug-in framework for C
-00003  * Copyright 2007 Johannes Lehtinen
-00004  * 
-00005  * Permission is hereby granted, free of charge, to any person obtaining a
-00006  * copy of this software and associated documentation files (the "Software"),
-00007  * to deal in the Software without restriction, including without limitation
-00008  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
-00009  * and/or sell copies of the Software, and to permit persons to whom the
-00010  * Software is furnished to do so, subject to the following conditions:
-00011  *
-00012  * The above copyright notice and this permission notice shall be included
-00013  * in all copies or substantial portions of the Software.
-00014  *
-00015  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-00016  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-00017  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-00018  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-00019  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-00020  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-00021  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-00022  *-----------------------------------------------------------------------*/
-00023 
-00030 #ifndef CPLUFFDEF_H_
-00031 #define CPLUFFDEF_H_
-00032 
-00033 
-00034 /* ------------------------------------------------------------------------
-00035  * Version information
-00036  * ----------------------------------------------------------------------*/
-00037 
-00047 
-00053 #define CP_VERSION "0.1.3"
-00054 
-00059 #define CP_VERSION_MAJOR 0
-00060 
-00065 #define CP_VERSION_MINOR 1
-00066 
-00070 /* ------------------------------------------------------------------------
-00071  * Symbol visibility
-00072  * ----------------------------------------------------------------------*/
-00073 
-00102 
-00137 #if defined(_WIN32)
-00138 #  define CP_EXPORT __declspec(dllexport)
-00139 #  define CP_IMPORT extern __declspec(dllimport)
-00140 #  define CP_HIDDEN
-00141 #elif defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
-00142 #  define CP_EXPORT
-00143 #  define CP_IMPORT extern
-00144 #  define CP_HIDDEN __attribute__ ((visibility ("hidden")))
-00145 #else
-00146 #  define CP_EXPORT
-00147 #  define CP_IMPORT extern
-00148 #  define CP_HIDDEN
-00149 #endif
-00150 
-00154 /* ------------------------------------------------------------------------
-00155  * GCC attributes
-00156  * ----------------------------------------------------------------------*/
-00157 
-00168 
-00187 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
-00188 #define CP_GCC_PURE __attribute__((pure))
-00189 #else
-00190 #define CP_GCC_PURE
-00191 #endif
-00192 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)
-00193 #define CP_GCC_NONNULL(...) __attribute__((nonnull (__VA_ARGS__)))
-00194 #else
-00195 #define CP_GCC_NONNULL(...)
-00196 #endif
-00197 
-00200 #endif /*CPLUFFDEF_H_*/
-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/cpluffdef_8h.html b/lib/cpluff/doc/reference/c-api/cpluffdef_8h.html deleted file mode 100644 index 9d26fa883d..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluffdef_8h.html +++ /dev/null @@ -1,71 +0,0 @@ - - -C-Pluff C API: cpluffdef.h File Reference - - - - -
-
-
-
-

cpluffdef.h File Reference

Detailed Description

-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. -

- -

-This graph shows which files directly or indirectly include this file:

- - - - -

-Go to the source code of this file. - - - - - - - - - - - - - - - - - - - - - - - - - - -

Defines

#define CP_VERSION
 The C-Pluff release version string.
#define CP_VERSION_MAJOR
 The major version number component of the release version.
#define CP_VERSION_MINOR
 The minor version number component of the release version.
#define CP_EXPORT
 Declares a symbol to be exported for inter-module usage.
#define CP_IMPORT
 Declares a symbol to be imported from another module.
#define CP_HIDDEN
 Declares a symbol hidden from other modules.
#define CP_GCC_PURE
 Declares a function as pure function having no side effects.
#define CP_GCC_NONNULL(...)
 Specifies that some pointer arguments to a function should have non-NULL values.
-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.map b/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.map deleted file mode 100644 index 59268dafc7..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.map +++ /dev/null @@ -1,2 +0,0 @@ -base referer -rect $cpluff_8h.html 147,6 219,30 diff --git a/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.md5 b/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.md5 deleted file mode 100644 index 8990b32302..0000000000 --- a/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.md5 +++ /dev/null @@ -1 +0,0 @@ -488c91cb6b7500f359b44534cf06d2ab \ No newline at end of file diff --git a/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.png b/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.png deleted file mode 100644 index 1c89835701..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/cpluffdef_8h__dep__incl.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/doxygen.css b/lib/cpluff/doc/reference/c-api/doxygen.css deleted file mode 100644 index 19941d4625..0000000000 --- a/lib/cpluff/doc/reference/c-api/doxygen.css +++ /dev/null @@ -1,360 +0,0 @@ -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { - font-family: Geneva, Arial, Helvetica, sans-serif; -} -BODY,TD { - font-size: 90%; -} -H1 { - text-align: center; - font-size: 160%; -} -H2 { - font-size: 120%; -} -H3 { - font-size: 100%; -} -CAPTION { font-weight: bold } -DIV.qindex { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; -} -DIV.nav { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; -} -DIV.navtab { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -TD.navtab { - font-size: 70%; -} -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; -} -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D -} -A.qindex:hover { - text-decoration: none; - background-color: #ddddff; -} -A.qindexHL { - text-decoration: none; - font-weight: bold; - background-color: #6666cc; - color: #ffffff; - border: 1px double #9295C2; -} -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; -} -A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } -A.el { text-decoration: none; font-weight: bold } -A.elRef { font-weight: bold } -A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} -A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} -A.codeRef:link { font-weight: normal; color: #0000FF} -A.codeRef:visited { font-weight: normal; color: #0000FF} -A:hover { text-decoration: none; background-color: #f2f2ff } -DL.el { margin-left: -1cm } -.fragment { - font-family: monospace, fixed; - font-size: 95%; -} -PRE.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; - margin-top: 4px; - margin-bottom: 4px; - margin-left: 2px; - margin-right: 8px; - padding-left: 6px; - padding-right: 6px; - padding-top: 4px; - padding-bottom: 4px; -} -DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } - -DIV.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; -} -DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } -BODY { - background: white; - color: black; - margin-right: 20px; - margin-left: 20px; -} -TD.indexkey { - background-color: #e8eef2; - font-weight: bold; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TD.indexvalue { - background-color: #e8eef2; - font-style: italic; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TR.memlist { - background-color: #f0f0f0; -} -P.formulaDsp { text-align: center; } -IMG.formulaDsp { } -IMG.formulaInl { vertical-align: middle; } -SPAN.keyword { color: #008000 } -SPAN.keywordtype { color: #604020 } -SPAN.keywordflow { color: #e08000 } -SPAN.comment { color: #800000 } -SPAN.preprocessor { color: #806020 } -SPAN.stringliteral { color: #002080 } -SPAN.charliteral { color: #008080 } -.mdescLeft { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.mdescRight { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.memItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplParams { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - color: #606060; - background-color: #FAFAFA; - font-size: 80%; -} -.search { color: #003399; - font-weight: bold; -} -FORM.search { - margin-bottom: 0px; - margin-top: 0px; -} -INPUT.search { font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -TD.tiny { font-size: 75%; -} -a { - color: #1A41A8; -} -a:visited { - color: #2A3798; -} -.dirtab { padding: 4px; - border-collapse: collapse; - border: 1px solid #84b0c7; -} -TH.dirtab { background: #e8eef2; - font-weight: bold; -} -HR { height: 1px; - border: none; - border-top: 1px solid black; -} - -/* Style for detailed member documentation */ -.memtemplate { - font-size: 80%; - color: #606060; - font-weight: normal; -} -.memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -.memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; -} -.memname { - white-space: nowrap; - font-weight: bold; -} -.memdoc{ - padding-left: 10px; -} -.memproto { - background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; - font-weight: bold; - -moz-border-radius: 8px 8px 8px 8px; -} -.paramkey { - text-align: right; -} -.paramtype { - white-space: nowrap; -} -.paramname { - color: #602020; - font-style: italic; - white-space: nowrap; -} -/* End Styling for detailed member documentation */ - -/* for the tree view */ -.ftvtree { - font-family: sans-serif; - margin:0.5em; -} -.directory { font-size: 9pt; font-weight: bold; } -.directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; } -.directory > h3 { margin-top: 0; } -.directory p { margin: 0px; white-space: nowrap; } -.directory div { display: none; margin: 0px; } -.directory img { vertical-align: -30%; } -P.footer { font-size: smaller; text-align: center; } -P.generated-by { font-size: smaller; font-style: italic; text-align: right; } diff --git a/lib/cpluff/doc/reference/c-api/doxygen.png b/lib/cpluff/doc/reference/c-api/doxygen.png deleted file mode 100644 index f0a274bbaf..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/doxygen.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/files.html b/lib/cpluff/doc/reference/c-api/files.html deleted file mode 100644 index 8866d86ed0..0000000000 --- a/lib/cpluff/doc/reference/c-api/files.html +++ /dev/null @@ -1,34 +0,0 @@ - - -C-Pluff C API: File Index - - - - -
-
-
-
-

C-Pluff C API File List

Here is a list of all documented files with brief descriptions: - - -
cpluff.h [code]C-Pluff C API header file
cpluffdef.h [code]Common defines shared by C-Pluff C and C++ APIs
-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/functions.html b/lib/cpluff/doc/reference/c-api/functions.html deleted file mode 100644 index 7c05490642..0000000000 --- a/lib/cpluff/doc/reference/c-api/functions.html +++ /dev/null @@ -1,155 +0,0 @@ - - -C-Pluff C API: Data Fields - - - - -
-
-
-
-
- -
-
- -
- -

-Here is a list of all documented struct and union fields with links to the struct/union documentation for each field: -

-

- a -

-

- c -

-

- d -

-

- e -

-

- i -

-

- l -

-

- n -

-

- o -

-

- p -

-

- r -

-

- s -

-

- v -

-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/functions_vars.html b/lib/cpluff/doc/reference/c-api/functions_vars.html deleted file mode 100644 index 139601988e..0000000000 --- a/lib/cpluff/doc/reference/c-api/functions_vars.html +++ /dev/null @@ -1,155 +0,0 @@ - - -C-Pluff C API: Data Fields - Variables - - - - -
-
-
-
-
- -
-
- -
- -

-  -

-

- a -

-

- c -

-

- d -

-

- e -

-

- i -

-

- l -

-

- n -

-

- o -

-

- p -

-

- r -

-

- s -

-

- v -

-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/globals.html b/lib/cpluff/doc/reference/c-api/globals.html deleted file mode 100644 index b63d23b30a..0000000000 --- a/lib/cpluff/doc/reference/c-api/globals.html +++ /dev/null @@ -1,193 +0,0 @@ - - -C-Pluff C API: Data Fields - - - - -
-
-
-
-
- -
-
- -
- -

-Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: -

-

- c -

-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/globals_eval.html b/lib/cpluff/doc/reference/c-api/globals_eval.html deleted file mode 100644 index 1422549ec4..0000000000 --- a/lib/cpluff/doc/reference/c-api/globals_eval.html +++ /dev/null @@ -1,78 +0,0 @@ - - -C-Pluff C API: Data Fields - - - - -
-
-
-
-
- -
-  -

-

-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/globals_func.html b/lib/cpluff/doc/reference/c-api/globals_func.html deleted file mode 100644 index be35cf26a8..0000000000 --- a/lib/cpluff/doc/reference/c-api/globals_func.html +++ /dev/null @@ -1,129 +0,0 @@ - - -C-Pluff C API: Data Fields - - - - -
-
-
-
-
- -
-
- -
- -

-  -

-

- c -

-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/globals_type.html b/lib/cpluff/doc/reference/c-api/globals_type.html deleted file mode 100644 index a6fe9ddb9e..0000000000 --- a/lib/cpluff/doc/reference/c-api/globals_type.html +++ /dev/null @@ -1,70 +0,0 @@ - - -C-Pluff C API: Data Fields - - - - -
-
-
-
-
- -
-  -

-

-
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/graph_legend.dot b/lib/cpluff/doc/reference/c-api/graph_legend.dot deleted file mode 100644 index ee8e8bc9fd..0000000000 --- a/lib/cpluff/doc/reference/c-api/graph_legend.dot +++ /dev/null @@ -1,23 +0,0 @@ -digraph G -{ - bgcolor="transparent"; - edge [fontname="FreeSans.ttf",fontsize=10,labelfontname="FreeSans.ttf",labelfontsize=10]; - node [fontname="FreeSans.ttf",fontsize=10,shape=record]; - Node9 [shape="box",label="Inherited",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",fillcolor="grey75",style="filled" fontcolor="black"]; - Node10 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans.ttf"]; - Node10 [shape="box",label="PublicBase",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="black",URL="$classPublicBase.html"]; - Node11 -> Node10 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans.ttf"]; - Node11 [shape="box",label="Truncated",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="red",URL="$classTruncated.html"]; - Node13 -> Node9 [dir=back,color="darkgreen",fontsize=10,style="solid",fontname="FreeSans.ttf"]; - Node13 [shape="box",label="ProtectedBase",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="black",URL="$classProtectedBase.html"]; - Node14 -> Node9 [dir=back,color="firebrick4",fontsize=10,style="solid",fontname="FreeSans.ttf"]; - Node14 [shape="box",label="PrivateBase",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="black",URL="$classPrivateBase.html"]; - Node15 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans.ttf"]; - Node15 [shape="box",label="Undocumented",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="grey75"]; - Node16 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="FreeSans.ttf"]; - Node16 [shape="box",label="Templ< int >",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="black",URL="$classTempl.html"]; - Node17 -> Node16 [dir=back,color="orange",fontsize=10,style="dashed",label="< int >",fontname="FreeSans.ttf"]; - Node17 [shape="box",label="Templ< T >",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="black",URL="$classTempl.html"]; - Node18 -> Node9 [dir=back,color="darkorchid3",fontsize=10,style="dashed",label="m_usedClass",fontname="FreeSans.ttf"]; - Node18 [shape="box",label="Used",fontsize=10,height=0.2,width=0.4,fontname="FreeSans.ttf",color="black",URL="$classUsed.html"]; -} diff --git a/lib/cpluff/doc/reference/c-api/graph_legend.html b/lib/cpluff/doc/reference/c-api/graph_legend.html deleted file mode 100644 index 94681d6679..0000000000 --- a/lib/cpluff/doc/reference/c-api/graph_legend.html +++ /dev/null @@ -1,87 +0,0 @@ - - -C-Pluff C API: Graph Legend - - - - -
-
-

Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

-Consider the following example: 

/*! Invisible class because of truncation */
-class Invisible { };
-
-/*! Truncated class, inheritance relation is hidden */
-class Truncated : public Invisible { };
-
-/* Class not documented with doxygen comments */
-class Undocumented { };
-
-/*! Class that is inherited using public inheritance */
-class PublicBase : public Truncated { };
-
-/*! A template class */
-template<class T> class Templ { };
-
-/*! Class that is inherited using protected inheritance */
-class ProtectedBase { };
-
-/*! Class that is inherited using private inheritance */
-class PrivateBase { };
-
-/*! Class that is used by the Inherited class */
-class Used { };
-
-/*! Super class that inherits a number of other classes */
-class Inherited : public PublicBase,
-                  protected ProtectedBase,
-                  private PrivateBase,
-                  public Undocumented
-                  public Templ<int>
-{
-  private:
-    Used *m_usedClass;
-};
-
If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 240 this will result in the following graph:

-

-graph_legend.png -
-

-The boxes in the above graph have the following meaning:

-The arrows have the following meaning: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/graph_legend.png b/lib/cpluff/doc/reference/c-api/graph_legend.png deleted file mode 100644 index db03000b3d..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/graph_legend.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/group__cDefines.html b/lib/cpluff/doc/reference/c-api/group__cDefines.html deleted file mode 100644 index 909596cdd7..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cDefines.html +++ /dev/null @@ -1,76 +0,0 @@ - - -C-Pluff C API: Defines - - - - -
-
-

Defines

Detailed Description

-Preprocessor defines. -

- -

- - - - - - - -

-

- - - -

-

- - - -

-

- - - -

-

- - - -

Modules

 Version information
 C-Pluff version information.
 Symbol visibility
 Macros for controlling inter-module symbol visibility and linkage.
 GCC attributes
 These macros conditionally define GCC attributes for declarations.
 Flags for plug-in scanning
 These constants can be orred together for the flags parameter of cp_scan_plugins.

Defines

#define CP_C_API
 Marks a symbol declaration to be part of the C-Pluff C API.
-

Define Documentation

- -
-
- - - - -
#define CP_C_API
-
-
- -

-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. -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cDefinesGCCAttributes.html b/lib/cpluff/doc/reference/c-api/group__cDefinesGCCAttributes.html deleted file mode 100644 index c5db977831..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cDefinesGCCAttributes.html +++ /dev/null @@ -1,83 +0,0 @@ - - -C-Pluff C API: GCC attributes - - - - -
-
-

GCC attributes
- -[Defines] -

Detailed Description

-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. -

- - - - - - - - - -

Defines

#define CP_GCC_PURE
 Declares a function as pure function having no side effects.
#define CP_GCC_NONNULL(...)
 Specifies that some pointer arguments to a function should have non-NULL values.
-

Define Documentation

- -
-
- - - - -
#define 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. -

-

- -

-
- - - - - - - - - -
#define 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. -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cEnums.html b/lib/cpluff/doc/reference/c-api/group__cEnums.html deleted file mode 100644 index 794ea2c37e..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cEnums.html +++ /dev/null @@ -1,180 +0,0 @@ - - -C-Pluff C API: Enumerations - - - - -
-
-

Enumerations

Detailed Description

-Constant value enumerations. -

- -

- - - - - - - - - - - - -

Enumerations

enum  cp_status_t {
-  CP_OK = 0, -CP_ERR_RESOURCE, -CP_ERR_UNKNOWN, -CP_ERR_IO, -
-  CP_ERR_MALFORMED, -CP_ERR_CONFLICT, -CP_ERR_DEPENDENCY, -CP_ERR_RUNTIME -
- }
 An enumeration of status codes returned by API functions. More...
enum  cp_plugin_state_t {
-  CP_PLUGIN_UNINSTALLED, -CP_PLUGIN_INSTALLED, -CP_PLUGIN_RESOLVED, -CP_PLUGIN_STARTING, -
-  CP_PLUGIN_STOPPING, -CP_PLUGIN_ACTIVE -
- }
 An enumeration of possible plug-in states. More...
enum  cp_log_severity_t { CP_LOG_DEBUG, -CP_LOG_INFO, -CP_LOG_WARNING, -CP_LOG_ERROR - }
 An enumeration of possible message severities for framework logging. More...
-

Enumeration Type Documentation

- -
-
- - - - -
enum cp_status_t
-
-
- -

-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.

Enumerator:
- - - - - - - - - -
CP_OK  -Operation was performed successfully (equals to zero).
CP_ERR_RESOURCE  -Not enough memory or other operating system resources available.
CP_ERR_UNKNOWN  -The specified object is unknown to the framework.
CP_ERR_IO  -An I/O error occurred.
CP_ERR_MALFORMED  -Malformed plug-in descriptor was encountered when loading a plug-in.
CP_ERR_CONFLICT  -Plug-in or symbol conflicts with another plug-in or symbol.
CP_ERR_DEPENDENCY  -Plug-in dependencies could not be satisfied.
CP_ERR_RUNTIME  -Plug-in runtime signaled an error.
-
- -
-

- -

-
- - - - -
enum cp_plugin_state_t
-
-
- -

-An enumeration of possible plug-in states. -

-Plug-in states are controlled by plug-in management functions. Plug-in states can be observed by registering a plug-in listener function or by calling cp_get_plugin_state.

-

See also:
cp_plugin_listener_t

-cp_get_plugin_state

-
Enumerator:
- - - - - - - -
CP_PLUGIN_UNINSTALLED  -Plug-in is not installed. -

-No plug-in information has been loaded.

CP_PLUGIN_INSTALLED  -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_RESOLVED  -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_STARTING  -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_STOPPING  -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_ACTIVE  -Plug-in has been successfully started and it has not yet been stopped.
-
- -
-

- -

-
- - - - -
enum cp_log_severity_t
-
-
- -

-An enumeration of possible message severities for framework logging. -

-These constants are used when passing a log message to a logger function and when registering a logger function.

Enumerator:
- - - - - -
CP_LOG_DEBUG  -Used for detailed debug messages.
CP_LOG_INFO  -Used for informational messages such as plug-in state changes.
CP_LOG_WARNING  -Used for messages warning about possible problems.
CP_LOG_ERROR  -Used for messages reporting errors.
-
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncs.html b/lib/cpluff/doc/reference/c-api/group__cFuncs.html deleted file mode 100644 index 126f874435..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncs.html +++ /dev/null @@ -1,74 +0,0 @@ - - -C-Pluff C API: Functions - - - - -
-
-

Functions

Detailed Description

-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 framework initialization functions are exceptions, they are not thread-safe. -

- - - - - - - -

-

- - - -

-

- - - -

-

- - - -

-

- - - -

-

- - - -

-

- - - -

-

- - - -

-


Modules

 Framework information
 These functions can be used to query runtime information about the linked in C-Pluff implementation.
 Framework initialization
 These functions are used for framework initialization.
 Plug-in context initialization
 These functions are used to manage plug-in contexts from the main program perspective.
 Logging
 These functions can be used to receive and emit log messages related to a particular plug-in context.
 Plug-in management
 These functions can be used to manage plug-ins.
 Plug-in and extension information
 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.
 Plug-in execution
 These functions support a plug-in controlled execution model.
 Dynamic symbols
 These functions can be used to dynamically access symbols exported by the plug-ins.
-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsContext.html b/lib/cpluff/doc/reference/c-api/group__cFuncsContext.html deleted file mode 100644 index 7987c385f7..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsContext.html +++ /dev/null @@ -1,215 +0,0 @@ - - -C-Pluff C API: Plug-in context initialization - - - - -
-
-

Plug-in context initialization
- -[Functions] -

Detailed Description

-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. -

- - - - - - - - - - - - - - - - - - -

Functions

cp_context_t * cp_create_context (cp_status_t *status)
 Creates a new plug-in context which can be used as a container for plug-ins.
void cp_destroy_context (cp_context_t *ctx)
 Destroys the specified plug-in context and releases the associated resources.
cp_status_t cp_register_pcollection (cp_context_t *ctx, const char *dir)
 Registers a plug-in collection with a plug-in context.
void cp_unregister_pcollection (cp_context_t *ctx, const char *dir)
 Unregisters a previously registered plug-in collection from a plug-in context.
void cp_unregister_pcollections (cp_context_t *ctx)
 Unregisters all plug-in collections from a plug-in context.
-

Function Documentation

- -
-
- - - - - - - - - -
cp_context_t* cp_create_context (cp_status_t *  status  ) 
-
-
- -

-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.

-

Parameters:
- - -
status pointer to the location where status code is to be stored, or NULL
-
-
Returns:
the newly created plugin context, or NULL on failure
- -
-

- -

-
- - - - - - - - - -
void cp_destroy_context (cp_context_t *  ctx  ) 
-
-
- -

-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.

-

Parameters:
- - -
ctx the context to be destroyed
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_register_pcollection (cp_context_t *  ctx,
const char *  dir 
)
-
-
- -

-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 CP_OK if the directory has already been registered. A plug-in collection can be unregistered using cp_unregister_pcollection or cp_unregister_pcollections.

-

Parameters:
- - - -
ctx the plug-in context
dir the directory
-
-
Returns:
CP_OK (zero) on success or CP_ERR_RESOURCE if insufficient memory
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void cp_unregister_pcollection (cp_context_t *  ctx,
const char *  dir 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
dir the previously registered directory
-
- -
-

- -

-
- - - - - - - - - -
void cp_unregister_pcollections (cp_context_t *  ctx  ) 
-
-
- -

-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.

-

Parameters:
- - -
ctx the plug-in context
-
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsFrameworkInfo.html b/lib/cpluff/doc/reference/c-api/group__cFuncsFrameworkInfo.html deleted file mode 100644 index bc06d16604..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsFrameworkInfo.html +++ /dev/null @@ -1,91 +0,0 @@ - - -C-Pluff C API: Framework information - - - - -
-
-

Framework information
- -[Functions] -

Detailed Description

-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. -

- - - - - - - - - -

Functions

const char * cp_get_version (void)
 Returns the release version string of the linked in C-Pluff implementation.
const char * cp_get_host_type (void)
 Returns the canonical host type associated with the linked in C-Pluff implementation.
-

Function Documentation

- -
-
- - - - - - - - - -
const char* cp_get_version (void   ) 
-
-
- -

-Returns the release version string of the linked in C-Pluff implementation. -

-

Returns:
the C-Pluff release version string
- -
-

- -

-
- - - - - - - - - -
const char* cp_get_host_type (void   ) 
-
-
- -

-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.

-

Returns:
the canonical host type
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsInit.html b/lib/cpluff/doc/reference/c-api/group__cFuncsInit.html deleted file mode 100644 index 830c5fdc91..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsInit.html +++ /dev/null @@ -1,123 +0,0 @@ - - -C-Pluff C API: Framework initialization - - - - -
-
-

Framework initialization
- -[Functions] -

Detailed Description

-These functions are used for framework initialization. -

-They are intended to be used by the main program. These functions are not thread safe. -

- - - - - - - - - - - - -

Functions

void cp_set_fatal_error_handler (cp_fatal_error_func_t error_handler)
 Sets the fatal error handler called on non-recoverable errors.
cp_status_t cp_init (void)
 Initializes the plug-in framework.
void cp_destroy (void)
 Destroys the plug-in framework and releases the resources used by it.
-

Function Documentation

- -
-
- - - - - - - - - -
void cp_set_fatal_error_handler (cp_fatal_error_func_t  error_handler  ) 
-
-
- -

-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.

-

Parameters:
- - -
error_handler the fatal error handler
-
- -
-

- -

-
- - - - - - - - - -
cp_status_t cp_init (void   ) 
-
-
- -

-Initializes the plug-in framework. -

-This function must be called by the main program before calling any other plug-in framework functions except 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

 setlocale(LC_ALL, "") 
-
before calling this function.

-

Returns:
CP_OK (zero) on success or error code on failure
- -
-

- -

-
- - - - - - - - - -
void cp_destroy (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. -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsLogging.html b/lib/cpluff/doc/reference/c-api/group__cFuncsLogging.html deleted file mode 100644 index 085fca8d32..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsLogging.html +++ /dev/null @@ -1,222 +0,0 @@ - - -C-Pluff C API: Logging - - - - -
-
-

Logging
- -[Functions] -

Detailed Description

-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. -

- - - - - - - - - - - - - - - -

Functions

cp_status_t cp_register_logger (cp_context_t *ctx, cp_logger_func_t logger, void *user_data, cp_log_severity_t min_severity)
 Registers a logger with a plug-in context or updates the settings of a registered logger.
void cp_unregister_logger (cp_context_t *ctx, cp_logger_func_t logger)
 Removes a logger registration.
void cp_log (cp_context_t *ctx, cp_log_severity_t severity, const char *msg)
 Emits a new log message.
int cp_is_logged (cp_context_t *ctx, cp_log_severity_t severity)
 Returns whether a message of the specified severity would get logged.
-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
cp_status_t cp_register_logger (cp_context_t *  ctx,
cp_logger_func_t  logger,
void *  user_data,
cp_log_severity_t  min_severity 
)
-
-
- -

-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.

-

Parameters:
- - - - - -
ctx the plug-in context to log
logger the logger function to be called
user_data the user data pointer passed to the logger
min_severity the minimum severity of messages passed to logger
-
-
Returns:
CP_OK (zero) on success or CP_ERR_RESOURCE if insufficient memory
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void cp_unregister_logger (cp_context_t *  ctx,
cp_logger_func_t  logger 
)
-
-
- -

-Removes a logger registration. -

-

Parameters:
- - - -
ctx the plug-in context
logger the logger function to be unregistered
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - - - - - - - -
void cp_log (cp_context_t *  ctx,
cp_log_severity_t  severity,
const char *  msg 
)
-
-
- -

-Emits a new log message. -

-

Parameters:
- - - - -
ctx the plug-in context
severity the severity of the event
msg the log message (possibly localized)
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
int cp_is_logged (cp_context_t *  ctx,
cp_log_severity_t  severity 
)
-
-
- -

-Returns whether a message of the specified severity would get logged. -

-

Parameters:
- - - -
ctx the plug-in context
severity the target logging severity
-
-
Returns:
whether a message of the specified severity would get logged
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsPlugin.html b/lib/cpluff/doc/reference/c-api/group__cFuncsPlugin.html deleted file mode 100644 index ecb62a077c..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsPlugin.html +++ /dev/null @@ -1,360 +0,0 @@ - - -C-Pluff C API: Plug-in management - - - - -
-
-

Plug-in management
- -[Functions] -

Detailed Description

-These functions can be used to manage plug-ins. -

-They are intended to be used by the main program. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

Functions

cp_plugin_info_t * cp_load_plugin_descriptor (cp_context_t *ctx, const char *path, cp_status_t *status)
 Loads a plug-in descriptor from the specified plug-in installation path and returns information about the plug-in.
cp_status_t cp_install_plugin (cp_context_t *ctx, cp_plugin_info_t *pi)
 Installs the plug-in described by the specified plug-in information structure to the specified plug-in context.
cp_status_t cp_scan_plugins (cp_context_t *ctx, int flags)
 Scans for plug-ins in the registered plug-in directories, installing new plug-ins and upgrading installed plug-ins.
cp_status_t cp_start_plugin (cp_context_t *ctx, const char *id)
 Starts a plug-in.
cp_status_t cp_stop_plugin (cp_context_t *ctx, const char *id)
 Stops a plug-in.
void cp_stop_plugins (cp_context_t *ctx)
 Stops all active plug-ins.
cp_status_t cp_uninstall_plugin (cp_context_t *ctx, const char *id)
 Uninstalls the specified plug-in.
void cp_uninstall_plugins (cp_context_t *ctx)
 Uninstalls all plug-ins.
-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
cp_plugin_info_t* cp_load_plugin_descriptor (cp_context_t *  ctx,
const char *  path,
cp_status_t *  status 
)
-
-
- -

-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.

-

Parameters:
- - - - -
ctx the plug-in context
path the installation path of the plug-in
status a pointer to the location where status code is to be stored, or NULL
-
-
Returns:
pointer to the information structure or NULL if error occurs
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_install_plugin (cp_context_t *  ctx,
cp_plugin_info_t *  pi 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
pi plug-in information structure
-
-
Returns:
CP_OK (zero) on success or an error code on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_scan_plugins (cp_context_t *  ctx,
int  flags 
)
-
-
- -

-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 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.

-

Parameters:
- - - -
ctx the plug-in context
flags the bitmask of flags
-
-
Returns:
CP_OK (zero) on success or an error code on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_start_plugin (cp_context_t *  ctx,
const char *  id 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
id identifier of the plug-in to be started
-
-
Returns:
CP_OK (zero) on success or an error code on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_stop_plugin (cp_context_t *  ctx,
const char *  id 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
id identifier of the plug-in to be stopped
-
-
Returns:
CP_OK (zero) on success or CP_ERR_UNKNOWN if unknown plug-in
- -
-

- -

-
- - - - - - - - - -
void cp_stop_plugins (cp_context_t *  ctx  ) 
-
-
- -

-Stops all active plug-ins. -

-

Parameters:
- - -
ctx the plug-in context
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_uninstall_plugin (cp_context_t *  ctx,
const char *  id 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
id identifier of the plug-in to be unloaded
-
-
Returns:
CP_OK (zero) on success or CP_ERR_UNKNOWN if unknown plug-in
- -
-

- -

-
- - - - - - - - - -
void cp_uninstall_plugins (cp_context_t *  ctx  ) 
-
-
- -

-Uninstalls all plug-ins. -

-All plug-ins are first stopped and then uninstalled.

-

Parameters:
- - -
ctx the plug-in context
-
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsPluginExec.html b/lib/cpluff/doc/reference/c-api/group__cFuncsPluginExec.html deleted file mode 100644 index 69a148e397..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsPluginExec.html +++ /dev/null @@ -1,228 +0,0 @@ - - -C-Pluff C API: Plug-in execution - - - - -
-
-

Plug-in execution
- -[Functions] -

Detailed Description

-These functions support a plug-in controlled execution model. -

-Started plug-ins can use cp_run_function to register 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. -

- - - - - - - - - - - - - - - - - - -

Functions

cp_status_t cp_run_function (cp_context_t *ctx, cp_run_func_t runfunc)
 Registers a new run function.
void cp_run_plugins (cp_context_t *ctx)
 Runs the started plug-ins as long as there is something to run.
int cp_run_plugins_step (cp_context_t *ctx)
 Runs one registered run function.
void cp_set_context_args (cp_context_t *ctx, char **argv)
 Sets startup arguments for the specified plug-in context.
char ** cp_get_context_args (cp_context_t *ctx, int *argc)
 Returns the startup arguments associated with the specified plug-in context.
-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - -
cp_status_t cp_run_function (cp_context_t *  ctx,
cp_run_func_t  runfunc 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context of the registering plug-in
runfunc the run function to be registered
-
-
Returns:
CP_OK (zero) on success or an error code on failure
- -
-

- -

-
- - - - - - - - - -
void cp_run_plugins (cp_context_t *  ctx  ) 
-
-
- -

-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.

-

Parameters:
- - -
ctx the plug-in context containing the plug-ins
-
- -
-

- -

-
- - - - - - - - - -
int cp_run_plugins_step (cp_context_t *  ctx  ) 
-
-
- -

-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.

-

Parameters:
- - -
ctx the plug-in context containing the plug-ins
-
-
Returns:
whether there are active run functions waiting to be run
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void cp_set_context_args (cp_context_t *  ctx,
char **  argv 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
argv a NULL-terminated array of arguments
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
char** cp_get_context_args (cp_context_t *  ctx,
int *  argc 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
argc a pointer to a location where the number of startup arguments is stored, or NULL for none
-
-
Returns:
an argument array terminated by NULL or NULL if not set
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsPluginInfo.html b/lib/cpluff/doc/reference/c-api/group__cFuncsPluginInfo.html deleted file mode 100644 index 13a900c59f..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsPluginInfo.html +++ /dev/null @@ -1,498 +0,0 @@ - - -C-Pluff C API: Plug-in and extension information - - - - -
-
-

Plug-in and extension information
- -[Functions] -

Detailed Description

-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. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Functions

cp_plugin_info_t * cp_get_plugin_info (cp_context_t *ctx, const char *id, cp_status_t *status)
 Returns static information about the specified plug-in.
cp_plugin_info_t ** cp_get_plugins_info (cp_context_t *ctx, cp_status_t *status, int *num)
 Returns static information about the installed plug-ins.
cp_ext_point_t ** cp_get_ext_points_info (cp_context_t *ctx, cp_status_t *status, int *num)
 Returns static information about the currently installed extension points.
cp_extension_t ** cp_get_extensions_info (cp_context_t *ctx, const char *extpt_id, cp_status_t *status, int *num)
 Returns static information about the currently installed extension points.
void cp_release_info (cp_context_t *ctx, void *info)
 Releases a previously obtained reference counted information object.
cp_plugin_state_t cp_get_plugin_state (cp_context_t *ctx, const char *id)
 Returns the current state of the specified plug-in.
cp_status_t cp_register_plistener (cp_context_t *ctx, cp_plugin_listener_func_t listener, void *user_data)
 Registers a plug-in listener with a plug-in context.
void cp_unregister_plistener (cp_context_t *ctx, cp_plugin_listener_func_t listener)
 Removes a plug-in listener from a plug-in context.
cp_cfg_element_t * cp_lookup_cfg_element (cp_cfg_element_t *base, const char *path)
 Traverses a configuration element tree and returns the specified element.
char * cp_lookup_cfg_value (cp_cfg_element_t *base, const char *path)
 Traverses a configuration element tree and returns the value of the specified element or attribute.
-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
cp_plugin_info_t* cp_get_plugin_info (cp_context_t *  ctx,
const char *  id,
cp_status_t *  status 
)
-
-
- -

-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.

-

Parameters:
- - - - -
ctx the plug-in context
id identifier of the plug-in to be examined or NULL for self
status a pointer to the location where status code is to be stored, or NULL
-
-
Returns:
pointer to the information structure or NULL on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - - - - - - - -
cp_plugin_info_t** cp_get_plugins_info (cp_context_t *  ctx,
cp_status_t *  status,
int *  num 
)
-
-
- -

-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.

-

Parameters:
- - - - -
ctx the plug-in context
status a pointer to the location where status code is to be stored, or NULL
num a pointer to the location where the number of returned plug-ins is stored, or NULL
-
-
Returns:
pointer to a NULL-terminated list of pointers to plug-in information or NULL on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - - - - - - - -
cp_ext_point_t** cp_get_ext_points_info (cp_context_t *  ctx,
cp_status_t *  status,
int *  num 
)
-
-
- -

-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.

-

Parameters:
- - - - -
ctx the plug-in context
status a pointer to the location where status code is to be stored, or NULL
num filled with the number of returned extension points, if non-NULL
-
-
Returns:
pointer to a NULL-terminated list of pointers to extension point information or NULL on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
cp_extension_t** cp_get_extensions_info (cp_context_t *  ctx,
const char *  extpt_id,
cp_status_t *  status,
int *  num 
)
-
-
- -

-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.

-

Parameters:
- - - - - -
ctx the plug-in context
extpt_id the extension point identifier or NULL for all extensions
status a pointer to the location where status code is to be stored, or NULL
num a pointer to the location where the number of returned extension points is to be stored, or NULL
-
-
Returns:
pointer to a NULL-terminated list of pointers to extension information or NULL on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void cp_release_info (cp_context_t *  ctx,
void *  info 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
info the information to be released
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_plugin_state_t cp_get_plugin_state (cp_context_t *  ctx,
const char *  id 
)
-
-
- -

-Returns the current state of the specified plug-in. -

-Returns CP_PLUGIN_UNINSTALLED if the specified plug-in identifier is unknown.

-

Parameters:
- - - -
ctx the plug-in context
id the plug-in identifier
-
-
Returns:
the current state of the plug-in
- -
-

- -

-
- - - - - - - - - - - - - - - - - - - - - - - - -
cp_status_t cp_register_plistener (cp_context_t *  ctx,
cp_plugin_listener_func_t  listener,
void *  user_data 
)
-
-
- -

-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.

-

Parameters:
- - - - -
ctx the plug-in context
listener the plug-in listener to be added
user_data user data pointer supplied to the listener
-
-
Returns:
CP_OK (zero) on success or CP_ERR_RESOURCE if out of resources
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void cp_unregister_plistener (cp_context_t *  ctx,
cp_plugin_listener_func_t  listener 
)
-
-
- -

-Removes a plug-in listener from a plug-in context. -

-Does nothing if the specified listener was not registered.

-

Parameters:
- - - -
ctx the plug-in context
listener the plug-in listener to be removed
-
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
cp_cfg_element_t* cp_lookup_cfg_element (cp_cfg_element_t *  base,
const char *  path 
)
-
-
- -

-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.

-

Parameters:
- - - -
base the base configuration element
path the path to the target element
-
-
Returns:
the target element or NULL if nonexisting
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
char* cp_lookup_cfg_value (cp_cfg_element_t *  base,
const char *  path 
)
-
-
- -

-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.

-

Parameters:
- - - -
base the base configuration element
path the path to the target element
-
-
Returns:
the value of the target element or attribute or NULL
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cFuncsSymbols.html b/lib/cpluff/doc/reference/c-api/group__cFuncsSymbols.html deleted file mode 100644 index 2f6d4958f9..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cFuncsSymbols.html +++ /dev/null @@ -1,186 +0,0 @@ - - -C-Pluff C API: Dynamic symbols - - - - -
-
-

Dynamic symbols
- -[Functions] -

Detailed Description

-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. -

- - - - - - - - - - - - -

Functions

cp_status_t cp_define_symbol (cp_context_t *ctx, const char *name, void *ptr)
 Defines a context specific symbol.
void * cp_resolve_symbol (cp_context_t *ctx, const char *id, const char *name, cp_status_t *status)
 Resolves a symbol provided by the specified plug-in.
void cp_release_symbol (cp_context_t *ctx, const void *ptr)
 Releases a previously obtained symbol.
-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
cp_status_t cp_define_symbol (cp_context_t *  ctx,
const char *  name,
void *  ptr 
)
-
-
- -

-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.

-

Parameters:
- - - - -
ctx the plug-in context
name the name of the symbol
ptr pointer value for the symbol
-
-
Returns:
CP_OK (zero) on success or a status code on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void* cp_resolve_symbol (cp_context_t *  ctx,
const char *  id,
const char *  name,
cp_status_t *  status 
)
-
-
- -

-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.

-

Parameters:
- - - - - -
ctx the plug-in context
id the identifier of the symbol defining plug-in
name the name of the symbol
status a pointer to the location where the status code is to be stored, or NULL
-
-
Returns:
the pointer associated with the symbol or NULL on failure
- -
-

- -

-
- - - - - - - - - - - - - - - - - - -
void cp_release_symbol (cp_context_t *  ctx,
const void *  ptr 
)
-
-
- -

-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.

-

Parameters:
- - - -
ctx the plug-in context
ptr the pointer associated with the symbol
-
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cScanFlags.html b/lib/cpluff/doc/reference/c-api/group__cScanFlags.html deleted file mode 100644 index 0bfff719de..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cScanFlags.html +++ /dev/null @@ -1,118 +0,0 @@ - - -C-Pluff C API: Flags for plug-in scanning - - - - -
-
-

Flags for plug-in scanning
- -[Defines] -

Detailed Description

-These constants can be orred together for the flags parameter of cp_scan_plugins. -

- -

- - - - - - - - - - - - - - - -

Defines

#define CP_SP_UPGRADE
 This flag enables upgrades of installed plug-ins by unloading the old version and installing the new version.
#define CP_SP_STOP_ALL_ON_UPGRADE
 This flag causes all plug-ins to be stopped before any plug-ins are to be upgraded.
#define CP_SP_STOP_ALL_ON_INSTALL
 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_RESTART_ACTIVE
 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 Documentation

- -
-
- - - - -
#define CP_SP_UPGRADE
-
-
- -

-This flag enables upgrades of installed plug-ins by unloading the old version and installing the new version. -

- -

-

- -

-
- - - - -
#define CP_SP_STOP_ALL_ON_UPGRADE
-
-
- -

-This flag causes all plug-ins to be stopped before any plug-ins are to be upgraded. -

- -

-

- -

-
- - - - -
#define CP_SP_STOP_ALL_ON_INSTALL
-
-
- -

-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_RESTART_ACTIVE
-
-
- -

-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). -

- -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cStructs.html b/lib/cpluff/doc/reference/c-api/group__cStructs.html deleted file mode 100644 index a41b91bb10..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cStructs.html +++ /dev/null @@ -1,52 +0,0 @@ - - -C-Pluff C API: Data structures - - - - -
-
-

Data structures

Detailed Description

-Data structure definitions. -

- -

- - - - - - - - - - - - - - - - - - - - - -

Data Structures

struct  cp_plugin_info_t
 Plug-in information structure captures information about a plug-in. More...
struct  cp_plugin_import_t
 Information about plug-in import. More...
struct  cp_ext_point_t
 Extension point structure captures information about an extension point. More...
struct  cp_extension_t
 Extension structure captures information about an extension. More...
struct  cp_cfg_element_t
 A configuration element contains configuration information for an extension. More...
struct  cp_plugin_runtime_t
 Container for plug-in runtime information. More...
-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cTypedefs.html b/lib/cpluff/doc/reference/c-api/group__cTypedefs.html deleted file mode 100644 index f5e389256a..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cTypedefs.html +++ /dev/null @@ -1,49 +0,0 @@ - - -C-Pluff C API: Typedefs - - - - -
-
-

Typedefs

Detailed Description

-Typedefs of various kind. -

- -

- - - - - - - -

-

- - - -

-

- - - -

-


Modules

 Opaque types
 Opaque data type definitions.
 Shorthand type names
 Shorthand type names for structs and enumerations.
 Callback function types
 Typedefs for client supplied callback functions.
-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cTypedefsFuncs.html b/lib/cpluff/doc/reference/c-api/group__cTypedefsFuncs.html deleted file mode 100644 index df55fe9986..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cTypedefsFuncs.html +++ /dev/null @@ -1,149 +0,0 @@ - - -C-Pluff C API: Callback function types - - - - -
-
-

Callback function types
- -[Typedefs] -

Detailed Description

-Typedefs for client supplied callback functions. -

- -

- - - - - - - - - - - - - - - -

Typedefs

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 listener function called synchronously after a plugin state change.
typedef void(*) cp_logger_func_t (cp_log_severity_t severity, const char *msg, const char *apid, void *user_data)
 A logger function called to log selected plug-in framework messages.
typedef void(*) cp_fatal_error_func_t (const char *msg)
 A fatal error handler for handling unrecoverable errors.
typedef int(*) cp_run_func_t (void *plugin_data)
 A run function registered by a plug-in to perform work.
-

Typedef Documentation

- -
-
- - - - -
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 listener function called synchronously after a plugin state change. -

-The function should return promptly. Library initialization, plug-in context management, plug-in management, listener registration (cp_register_plistener and cp_unregister_plistener) and dynamic symbol functions must not be called from within a plug-in listener invocation. Listener functions are registered using cp_register_plistener.

-

Parameters:
- - - - - -
plugin_id the plug-in identifier
old_state the old plug-in state
new_state the new plug-in state
user_data the user data pointer supplied at listener registration
-
- -
-

- -

-
- - - - -
typedef void(*) cp_logger_func_t(cp_log_severity_t severity, const char *msg, const char *apid, 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.

-

Parameters:
- - - - - -
severity the severity of the message
msg the message to be logged, possibly localized
apid the identifier of the activating plug-in or NULL for the main program
user_data the user data pointer given when the logger was registered
-
- -
-

- -

-
- - - - -
typedef void(*) cp_fatal_error_func_t(const char *msg)
-
-
- -

-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.

-

Parameters:
- - -
msg the possibly localized error message
-
- -
-

- -

-
- - - - -
typedef int(*) cp_run_func_t(void *plugin_data)
-
-
- -

-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 serial execution section.

-

Parameters:
- - -
plugin_data the plug-in instance data pointer
-
-
Returns:
non-zero if there is more work to be done or zero if finished
- -
-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cTypedefsOpaque.html b/lib/cpluff/doc/reference/c-api/group__cTypedefsOpaque.html deleted file mode 100644 index 9c8704aabf..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cTypedefsOpaque.html +++ /dev/null @@ -1,58 +0,0 @@ - - -C-Pluff C API: Opaque types - - - - -
-
-

Opaque types
- -[Typedefs] -

Detailed Description

-Opaque data type definitions. -

- -

- - - - - - -

Typedefs

typedef cp_context_t cp_context_t
 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.
-

Typedef Documentation

- -
-
- - - - -
typedef struct cp_context_t cp_context_t
-
-
- -

-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 cp_plugin_runtime_t::create. -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__cTypedefsShorthand.html b/lib/cpluff/doc/reference/c-api/group__cTypedefsShorthand.html deleted file mode 100644 index 460136ea21..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__cTypedefsShorthand.html +++ /dev/null @@ -1,218 +0,0 @@ - - -C-Pluff C API: Shorthand type names - - - - -
-
-

Shorthand type names
- -[Typedefs] -

Detailed Description

-Shorthand type names for structs and enumerations. -

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Typedefs

typedef cp_plugin_info_t cp_plugin_info_t
 A type for cp_plugin_info_t structure.
typedef cp_plugin_import_t cp_plugin_import_t
 A type for cp_plugin_import_t structure.
typedef cp_ext_point_t cp_ext_point_t
 A type for cp_ext_point_t structure.
typedef cp_extension_t cp_extension_t
 A type for cp_extension_t structure.
typedef cp_cfg_element_t cp_cfg_element_t
 A type for cp_cfg_element_t structure.
typedef cp_plugin_runtime_t cp_plugin_runtime_t
 A type for cp_plugin_runtime_t structure.
typedef enum cp_status_t cp_status_t
 A type for cp_status_t enumeration.
typedef enum cp_plugin_state_t cp_plugin_state_t
 A type for cp_plugin_state_t enumeration.
typedef enum cp_log_severity_t cp_log_severity_t
 A type for cp_log_severity_t enumeration.
-

Typedef Documentation

- -
-
- - - - -
typedef struct cp_plugin_info_t cp_plugin_info_t
-
-
- -

-A type for cp_plugin_info_t structure. -

- -

-

- -

-
- - - - -
typedef struct cp_plugin_import_t cp_plugin_import_t
-
-
- -

-A type for cp_plugin_import_t structure. -

- -

-

- -

-
- - - - -
typedef struct cp_ext_point_t cp_ext_point_t
-
-
- -

-A type for cp_ext_point_t structure. -

- -

-

- -

-
- - - - -
typedef struct cp_extension_t cp_extension_t
-
-
- -

-A type for cp_extension_t structure. -

- -

-

- -

-
- - - - -
typedef struct cp_cfg_element_t cp_cfg_element_t
-
-
- -

-A type for cp_cfg_element_t structure. -

- -

-

- -

-
- - - - -
typedef struct cp_plugin_runtime_t cp_plugin_runtime_t
-
-
- -

-A type for cp_plugin_runtime_t structure. -

- -

-

- -

-
- - - - -
typedef enum cp_status_t cp_status_t
-
-
- -

-A type for cp_status_t enumeration. -

- -

-

- -

-
- - - - -
typedef enum cp_plugin_state_t cp_plugin_state_t
-
-
- -

-A type for cp_plugin_state_t enumeration. -

- -

-

- -

-
- - - - -
typedef enum cp_log_severity_t cp_log_severity_t
-
-
- -

-A type for cp_log_severity_t enumeration. -

- -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__symbolVisibility.html b/lib/cpluff/doc/reference/c-api/group__symbolVisibility.html deleted file mode 100644 index b3c2941fc2..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__symbolVisibility.html +++ /dev/null @@ -1,104 +0,0 @@ - - -C-Pluff C API: Symbol visibility - - - - -
-
-

Symbol visibility
- -[Defines] -

Detailed Description

-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.

- 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 MY_API in the API header file as follows.

-

 #ifndef MY_API
- #  define MY_API CP_IMPORT
- #endif
-

-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 -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. -

- - - - - - - - - - - - -

Defines

#define CP_EXPORT
 Declares a symbol to be exported for inter-module usage.
#define CP_IMPORT
 Declares a symbol to be imported from another module.
#define CP_HIDDEN
 Declares a symbol hidden from other modules.
-

Define Documentation

- -
-
- - - - -
#define 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 the example of how to do this. -

-

- -

-
- - - - -
#define 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 the example of how to do this. -

-

- -

-
- - - - -
#define 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. -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/group__versionInfo.html b/lib/cpluff/doc/reference/c-api/group__versionInfo.html deleted file mode 100644 index 29a3b9f1ac..0000000000 --- a/lib/cpluff/doc/reference/c-api/group__versionInfo.html +++ /dev/null @@ -1,98 +0,0 @@ - - -C-Pluff C API: Version information - - - - -
-
-

Version information
- -[Defines] -

Detailed Description

-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. -

- - - - - - - - - - - - -

Defines

#define CP_VERSION
 The C-Pluff release version string.
#define CP_VERSION_MAJOR
 The major version number component of the release version.
#define CP_VERSION_MINOR
 The minor version number component of the release version.
-

Define Documentation

- -
-
- - - - -
#define CP_VERSION
-
-
- -

-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_MAJOR
-
-
- -

-The major version number component of the release version. -

-This is an integer. -

-

- -

-
- - - - -
#define CP_VERSION_MINOR
-
-
- -

-The minor version number component of the release version. -

-This is an integer. -

-

-

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/index.html b/lib/cpluff/doc/reference/c-api/index.html deleted file mode 100644 index 55d21c4db8..0000000000 --- a/lib/cpluff/doc/reference/c-api/index.html +++ /dev/null @@ -1,37 +0,0 @@ - - -C-Pluff C API: Main Page - - - - -
-
-

C-Pluff C API Documentation

-

-

0.1.3

This is reference documentation for the C-Pluff C API. C-Pluff is a plug-in framework for C programs. It has been strongly inspired by the Java plug-in framework in Eclipse. C-Pluff focuses on providing core services for plug-in interaction and plug-in management. It aims to be platform neutral and supports dynamic changes to plug-in configuration without stopping the whole application or framework. It does not yet provide special facilities for distribution such as signed plug-in packages or remote plug-in repositories but it is possible to build such features on top of the current framework.

-Here are links to main topics.

-

-

-

-

-For a "quick start guide" in developing C-Pluff based applications, see the example in the examples directory of the source distribution.

-The latest version of the framework implementation and documentation is available at C-Pluff web site.

-This documentation has been generated from the C-Pluff source code using Doxygen.

-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/inline_dotgraph_1.png b/lib/cpluff/doc/reference/c-api/inline_dotgraph_1.png deleted file mode 100644 index bd57e9abb5..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/inline_dotgraph_1.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/modules.html b/lib/cpluff/doc/reference/c-api/modules.html deleted file mode 100644 index 52727b82a4..0000000000 --- a/lib/cpluff/doc/reference/c-api/modules.html +++ /dev/null @@ -1,53 +0,0 @@ - - -C-Pluff C API: Module Index - - - - -
-
-

C-Pluff C API Modules

Here is a list of all modules: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/pages.html b/lib/cpluff/doc/reference/c-api/pages.html deleted file mode 100644 index c81c27434d..0000000000 --- a/lib/cpluff/doc/reference/c-api/pages.html +++ /dev/null @@ -1,33 +0,0 @@ - - -C-Pluff C API: Page Index - - - - -
-
-

C-Pluff C API Related Pages

Here is a list of all related documentation pages: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/plugin.html b/lib/cpluff/doc/reference/c-api/plugin.html deleted file mode 100644 index fbffb3bd5d..0000000000 --- a/lib/cpluff/doc/reference/c-api/plugin.html +++ /dev/null @@ -1,115 +0,0 @@ - - -C-Pluff C API: Plug-in - - - - -
-
-

Plug-in

-Overview

-Plug-in is the core element of an extensible application. The extensions and also the main application logic are implemented as plug-ins. Plug-ins can be developed, distributed and deployed independently, subject to inter-plugin dependencies. Deploying a new plug-in does not require recompilation or relinking if the operating system platform supports required dynamic linking facilities.

-Structure

-A plug-in includes the following structural elements.

-

-

-Plug-in descriptor

-A plug-in descriptor is an XML document describing a plug-in. It includes information about the contents of the plug-in, the features provided by the plug-in, plug-in version information and static dependencies of the plug-in. Most of the elements are optional. Most of the descriptor information described here is available to software via cp_plugin_info_t structure. The plug-in descriptor must be located in the plug-in directory as plugin.xml.

-The formal declaration of plug-in descriptor is available as XML Schema Definition in plugin.xsd located in the top level source directory. Currently there is no namespace associated with the plug-in descriptor. Here is an example of a plug-in descriptor. Click element name to jump into documentation for that element.

-

- <plugin id="org.c-pluff.example" name="Example Plug-in" version="0.3.2" provider-name="Johannes Lehtinen">
-     <backwards-compatibility abi="0.3" api="0.2.8"/>
-     <requires>
-         <c-pluff version="0.1"/>
-         <import plugin="org.c-pluff.util" version="0.2"/>
-         <import plugin="org.c-pluff.extra" optional="true"/> 
-     </requires>
-     <runtime library="libruntime" funcs="org_cpluff_example_funcs"/>
-     <extension-point id="editors" name="Text Editors" schema="editors_schema.xsd"/>
-     <extension-point id="url-families"/>
-     <extension point="org.c-pluff.util.archivers" id="tar" name="Tar Archiver Support">
-         <type random-access="false"/>
-         <exec bin="tar"/>
-     </extension>
-     <extension point="org.c-pluff.example.editors>
-         <editor name="Text Editor" runtime="org_cpluff_example_txteditor_runtime">
-             <file-types>
-                 <file-type mime-type="text/plain"/>
-             </file-types>
-         </editor>
-     </extension>
- </plugin>

-A descriptor can also be much simpler, depending on the plug-in. Here is an example of a minimal descriptor (of a useless plug-in).

-

- <plugin id="org.c-pluff.useless"/>

-plugin

-This is the top level element of the plug-in descriptor. It can have following attributes.

-

-

-This element can contain following elements.

-

-

-backwards-compatibility

-This element includes optional information about the backwards compatibility of this plug-in version. It can have following attributes.

-

-

-These apply to plug-ins that provide header files and runtime libraries. For example, a plug-in might export global functions to other plug-ins or it might provide an extension point where an extension installed by other plug-in must conform to data structures defined by the plug-in. Both attributes are optional.

-requires

-This element includes information about static plug-in dependencies. It can be omitted if there are no dependencies. It can contain following elements.

-

-

-c-pluff

-This element declares a version dependency on the C-Pluff implementation. It can be used to ensure that the plug-in is not loaded by incompatible C-Pluff version. It has the following attribute.

-

-

-import

-This element declares a static dependency on other plug-in. It must be used when a plug-in uses global symbols or data from other plug-in or when a plug-in uses an extension point defined by other plug-in or whenever some other plug-in needs to be there for the plug-in to work. The framework takes care of resolving and starting the dependencies whenever the plug-in is resolved or started.

-This element can have following attributes.

-

-

-runtime

-This element contains information about the plug-in runtime library. It is omitted if the plug-in does not have a runtime library but contains only data. It can have following attributes.

-

-

-extension-point

-This element defines an extension point provided by the plug-in. It can have following attributes.

-

-

-extension

-This element defines an extension installed into a specified extension point provided by the defining plug-in or some other plug-in. It can have following attributes.

-

-

-The extension element can contain XML elements specific to the associated extension point (conforming to the schema defined by the extension point).

-Plug-in runtime library

-A plug-in runtime library is an optional plug-in element. Plug-ins only supplying static data in form of XML data and files do not need a runtime library. However, a typical plug-in does provide program logic as well.

-The plug-in runtime library includes all program logic and program data provided by the plug-in. It is simply a shared library, or a dynamically linked library, which is linked in to the application when the plug-in is started. When plug-in is unloaded, the runtime library is unloaded as well. The framework has been designed to manage dependencies so that unloading of the runtime library does not cause problems, provided that plug-ins behave properly.

-A plug-in can expose functionality to other plug-ins either as exported global symbols that are directly resolved by other plug-ins or by supplying extensions. When other plug-ins are directly using exported symbols the plug-in acts just like any standard shared library. Nothing special there. The more interesting case is exposing functionality as extensions. Because the extension is registered at a specific extension point, the logic in other plug-ins can use the extension and the associated program logic even if they are not aware of the existence of the extension supplying plug-in.

-The extension points accepting program logic as extensions define a way to specify the name of the symbol pointing to the supplied logic. This is typically an attribute of an XML element contained in the extension definition. The plug-in supplying the extension can then export the program logic as a global symbol with arbitrary name and then place the name of the symbol in extension data. Alternatively, the plug-in can define a virtual symbol at runtime using cp_define_symbol. Other plug-ins that are using extensions registered at the extension point can then resolve the named symbol using cp_resolve_symbol at runtime. The framework automatically creates a dependency from the symbol using plug-in to the symbol supplying plug-in to prevent failures in case the symbol supplying plug-in is stopped or unloaded.

-Static plug-in data

-Plug-in can supply static data to other plug-ins using at least two different mechanisms. A plug-in can easily provide static XML data as part of extension elements. Additionally, a plug-in directory can contain files that may be accessed by other plug-ins. Currently the platform does not provide assistance in accessing data files provided by other plug-ins. However, a plug-in can locate the plug-in directory and thus any included data files by using plug-in path available in cp_plugin_info_t structure of the data providing plug-in.
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t.html b/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t.html deleted file mode 100644 index a9100ce488..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t.html +++ /dev/null @@ -1,206 +0,0 @@ - - -C-Pluff C API: cp_cfg_element_t Struct Reference - - - - -
-
-
-
-

cp_cfg_element_t Struct Reference
- -[Data structures] -

Collaboration diagram for cp_cfg_element_t:

Collaboration graph
-
[legend]

Detailed Description

-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 cp_extension_t::configuration and others are contained as children of parent elements. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

Data Fields

char * name
 The name of the configuration element.
unsigned int num_atts
 Number of attribute name, value pairs in the atts array.
char ** atts
 An array of pointers to alternating attribute names and values.
char * value
 An optional value of this configuration element.
cp_cfg_element_t * parent
 A pointer to the parent element or NULL if this is a root element.
unsigned int index
 The index of this element among its siblings (0-based).
unsigned int num_children
 Number of children in the children array.
cp_cfg_element_t * children
 An array of num_children childrens of this element.
-

Field Documentation

- -
-
- - - - -
char* name
-
-
- -

-The name of the configuration element. -

-This corresponds to the name of the element in a plug-in descriptor. -

-

- -

-
- - - - -
unsigned int num_atts
-
-
- -

-Number of attribute name, value pairs in the atts array. -

- -

-

- -

-
- - - - -
char** atts
-
-
- -

-An array of pointers to alternating attribute names and values. -

-Attribute values can be localized. -

-

- -

-
- - - - -
char* value
-
-
- -

-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. -

-

- -

-
- - - - -
cp_cfg_element_t* parent
-
-
- -

-A pointer to the parent element or NULL if this is a root element. -

- -

-

- -

-
- - - - -
unsigned int index
-
-
- -

-The index of this element among its siblings (0-based). -

- -

-

- -

-
- - - - -
unsigned int num_children
-
-
- -

-Number of children in the children array. -

- -

-

- -

-
- - - - -
cp_cfg_element_t* children
-
-
- -

-An array of num_children childrens of this element. -

-These correspond to child elements in a plug-in descriptor. -

-

-

The documentation for this struct was generated from the following file: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:56 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.map b/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.map deleted file mode 100644 index 5a14779e78..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.map +++ /dev/null @@ -1 +0,0 @@ -base referer diff --git a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.md5 b/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.md5 deleted file mode 100644 index ba6e2faf97..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -6cf610f8b63e37ec77f4116fd29fe98b \ No newline at end of file diff --git a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.png b/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.png deleted file mode 100644 index 6a6e2f453d..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t__coll__graph.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t.html b/lib/cpluff/doc/reference/c-api/structcp__ext__point__t.html deleted file mode 100644 index 9f35d2ba0b..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t.html +++ /dev/null @@ -1,138 +0,0 @@ - - -C-Pluff C API: cp_ext_point_t Struct Reference - - - - -
-
-
-
-

cp_ext_point_t Struct Reference
- -[Data structures] -

Collaboration diagram for cp_ext_point_t:

Collaboration graph
- - - - - - -
[legend]

Detailed Description

-Extension point structure captures information about an extension point. -

-Extension point structures are contained in cp_plugin_info_t::ext_points. -

- - - - - - - - - - - - - - - - - - - -

Data Fields

cp_plugin_info_t * plugin
 A pointer to plug-in information containing this extension point.
id attribute of an
The local identifier uniquely identifying the extension point within the host plug-in.

-This corresponds to the extension-point element in a plug-in descriptor.

-char * local_id
char * identifier
 The unique identifier of the extension point.
char * name
 An optional extension point name.
char * schema_path
 An optional path to the extension schema definition.
-

Field Documentation

- -
-
- - - - -
cp_plugin_info_t* plugin
-
-
- -

-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. -

-

- -

-
- - - - -
char* identifier
-
-
- -

-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* name
-
-
- -

-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 name attribute of an extension-point element in a plug-in descriptor. -

-

- -

-
- - - - -
char* schema_path
-
-
- -

-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 schema attribute of an extension-point element in a plug-in descriptor. -

-

-

The documentation for this struct was generated from the following file: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:56 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.map b/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.map deleted file mode 100644 index 9540ae3ad9..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.map +++ /dev/null @@ -1,5 +0,0 @@ -base referer -rect $structcp__plugin__info__t.html 92,99 223,123 -rect $structcp__extension__t.html 160,191 283,215 -rect $structcp__cfg__element__t.html 256,99 395,123 -rect $structcp__plugin__import__t.html 156,7 306,31 diff --git a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.md5 b/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.md5 deleted file mode 100644 index 6a473f0873..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -e53b6e2903a59356daa25c62913d18bc \ No newline at end of file diff --git a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.png b/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.png deleted file mode 100644 index 8dd2f29ee7..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/structcp__ext__point__t__coll__graph.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/structcp__extension__t.html b/lib/cpluff/doc/reference/c-api/structcp__extension__t.html deleted file mode 100644 index e61e6f8c96..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__extension__t.html +++ /dev/null @@ -1,172 +0,0 @@ - - -C-Pluff C API: cp_extension_t Struct Reference - - - - -
-
-
-
-

cp_extension_t Struct Reference
- -[Data structures] -

Collaboration diagram for cp_extension_t:

Collaboration graph
- - - - - - -
[legend]

Detailed Description

-Extension structure captures information about an extension. -

-Extension structures are contained in cp_plugin_info_t::extensions. -

- - - - - - - - - - - - - - - - - - - - - -

Data Fields

cp_plugin_info_t * plugin
 A pointer to plug-in information containing this extension.
char * ext_point_id
 The unique identifier of the extension point this extension is attached to.
char * local_id
 An optional local identifier uniquely identifying the extension within the host plug-in.
char * identifier
 An optional unique identifier of the extension.
char * name
 An optional extension name.
cp_cfg_element_t * configuration
 Extension configuration starting with the extension element.
-

Field Documentation

- -
-
- - - - -
cp_plugin_info_t* plugin
-
-
- -

-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. -

-

- -

-
- - - - -
char* ext_point_id
-
-
- -

-The unique identifier of the extension point this extension is attached to. -

-This corresponds to the point attribute of an extension element in a plug-in descriptor. -

-

- -

-
- - - - -
char* local_id
-
-
- -

-An optional local identifier uniquely identifying the extension within the host plug-in. -

-NULL if not available. This corresponds to the id attribute of an extension element in a plug-in descriptor. -

-

- -

-
- - - - -
char* identifier
-
-
- -

-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* name
-
-
- -

-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 name attribute of an extension element in a plug-in descriptor. -

-

- -

-
- - - - -
cp_cfg_element_t* configuration
-
-
- -

-Extension configuration starting with the extension element. -

-This includes extension configuration information as a tree of configuration elements. These correspond to the extension element and its contents in a plug-in descriptor. -

-

-

The documentation for this struct was generated from the following file: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:56 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.map b/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.map deleted file mode 100644 index 17b60a9d30..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.map +++ /dev/null @@ -1,5 +0,0 @@ -base referer -rect $structcp__plugin__info__t.html 98,196 228,220 -rect $structcp__ext__point__t.html 104,287 222,311 -rect $structcp__plugin__import__t.html 6,105 155,129 -rect $structcp__cfg__element__t.html 184,13 323,37 diff --git a/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.md5 b/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.md5 deleted file mode 100644 index 09c61b7406..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -2dbdb0a37fc7ad1ea026319c6f943390 \ No newline at end of file diff --git a/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.png b/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.png deleted file mode 100644 index 278fa0cb14..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/structcp__extension__t__coll__graph.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/structcp__plugin__import__t.html b/lib/cpluff/doc/reference/c-api/structcp__plugin__import__t.html deleted file mode 100644 index 3d547d3006..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__plugin__import__t.html +++ /dev/null @@ -1,105 +0,0 @@ - - -C-Pluff C API: cp_plugin_import_t Struct Reference - - - - -
-
-
-
-

cp_plugin_import_t Struct Reference
- -[Data structures] -

Detailed Description

-Information about plug-in import. -

-Plug-in import structures are contained in cp_plugin_info_t::imports. -

- - - - - - - - - - - - -

Data Fields

char * plugin_id
 The identifier of the imported plug-in.
char * version
 An optional version requirement.
int optional
 Is this import optional.
-

Field Documentation

- -
-
- - - - -
char* plugin_id
-
-
- -

-The identifier of the imported plug-in. -

-This corresponds to the plugin attribute of the import element in a plug-in descriptor. -

-

- -

-
- - - - -
char* version
-
-
- -

-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 if-version attribute of the import element in a plug-in descriptor. -

-

- -

-
- - - - -
int optional
-
-
- -

-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 optional attribute of the import element in a plug-in descriptor. -

-

-

The documentation for this struct was generated from the following file: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t.html b/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t.html deleted file mode 100644 index beab8abfea..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t.html +++ /dev/null @@ -1,372 +0,0 @@ - - -C-Pluff C API: cp_plugin_info_t Struct Reference - - - - -
-
-
-
-

cp_plugin_info_t Struct Reference
- -[Data structures] -

Collaboration diagram for cp_plugin_info_t:

Collaboration graph
- - - - - - -
[legend]

Detailed Description

-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 plugin element in a plug-in descriptor. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Data Fields

char * identifier
 The obligatory unique identifier of the plugin.
char * name
 An optional plug-in name.
char * version
 An optional release version string.
char * provider_name
 An optional provider name.
char * plugin_path
 Path of the plugin directory or NULL if not known.
char * abi_bw_compatibility
 Optional ABI compatibility information.
char * api_bw_compatibility
 Optional API compatibility information.
char * req_cpluff_version
 Optional C-Pluff version requirement.
unsigned int num_imports
 Number of import entries in the imports array.
cp_plugin_import_t * imports
 An array of num_imports import entries.
char * runtime_lib_name
 The base name of the plug-in runtime library, or NULL if none.
char * runtime_funcs_symbol
 The symbol pointing to the plug-in runtime function information or NULL if none.
unsigned int num_ext_points
 Number of extension points in ext_points array.
cp_ext_point_t * ext_points
 An array of num_ext_points extension points provided by this plug-in.
unsigned int num_extensions
 Number of extensions in extensions array.
cp_extension_t * extensions
 An array of num_extensions extensions provided by this plug-in.
-

Field Documentation

- -
-
- - - - -
char* identifier
-
-
- -

-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 id attribute of the plugin element in a plug-in descriptor. -

-

- -

-
- - - - -
char* name
-
-
- -

-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 name attribute of the plugin element in a plug-in descriptor. -

-

- -

-
- - - - -
char* version
-
-
- -

-An optional release version string. -

-NULL if not available. This corresponds to the version attribute of the plugin element in a plug-in descriptor. -

-

- -

-
- - - - -
char* provider_name
-
-
- -

-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 provider-name attribute of the plugin element in a plug-in descriptor. -

-

- -

-
- - - - -
char* plugin_path
-
-
- -

-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* abi_bw_compatibility
-
-
- -

-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 abi_bw_compatibility to version (inclusive) can use the current version of the plug-in binary. This describes binary or runtime compatibility. The value corresponds to the abi-compatibility attribute of the backwards-compatibility element in a plug-in descriptor. -

-

- -

-
- - - - -
char* api_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 api_bw_compatibility to 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 api-compatibility attribute of the backwards-compatibility element in a plug-in descriptor. -

-

- -

-
- - - - -
char* req_cpluff_version
-
-
- -

-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. -

-

- -

-
- - - - -
unsigned int num_imports
-
-
- -

-Number of import entries in the imports array. -

- -

-

- -

-
- - - - -
cp_plugin_import_t* imports
-
-
- -

-An array of num_imports import entries. -

-These correspond to import elements in a plug-in descriptor. -

-

- -

-
- - - - -
char* runtime_lib_name
-
-
- -

-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 library attribute of the runtime element in a plug-in descriptor. -

-

- -

-
- - - - -
char* runtime_funcs_symbol
-
-
- -

-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 cp_plugin_runtime_t structure. This corresponds to the funcs attribute of the runtime element in a plug-in descriptor. -

-

- -

-
- - - - -
unsigned int num_ext_points
-
-
- -

-Number of extension points in ext_points array. -

- -

-

- -

-
- - - - -
cp_ext_point_t* ext_points
-
-
- -

-An array of num_ext_points extension points provided by this plug-in. -

-These correspond to extension-point elements in a plug-in descriptor. -

-

- -

-
- - - - -
unsigned int num_extensions
-
-
- -

-Number of extensions in extensions array. -

- -

-

- -

-
- - - - -
cp_extension_t* extensions
-
-
- -

-An array of num_extensions extensions provided by this plug-in. -

-These correspond to extension elements in a plug-in descriptor. -

-

-

The documentation for this struct was generated from the following file: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.map b/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.map deleted file mode 100644 index 58077e827c..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.map +++ /dev/null @@ -1,5 +0,0 @@ -base referer -rect $structcp__extension__t.html 135,191 258,215 -rect $structcp__ext__point__t.html 351,191 468,215 -rect $structcp__cfg__element__t.html 6,99 144,123 -rect $structcp__plugin__import__t.html 268,7 418,31 diff --git a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.md5 b/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.md5 deleted file mode 100644 index 7977cfa34e..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -9b09efd75f5d4b8d95cce1190baf311a \ No newline at end of file diff --git a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.png b/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.png deleted file mode 100644 index dd483c5e61..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/structcp__plugin__info__t__coll__graph.png and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/structcp__plugin__runtime__t.html b/lib/cpluff/doc/reference/c-api/structcp__plugin__runtime__t.html deleted file mode 100644 index f031cb516f..0000000000 --- a/lib/cpluff/doc/reference/c-api/structcp__plugin__runtime__t.html +++ /dev/null @@ -1,172 +0,0 @@ - - -C-Pluff C API: cp_plugin_runtime_t Struct Reference - - - - -
-
-
-
-

cp_plugin_runtime_t Struct Reference
- -[Data structures] -

Detailed Description

-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 funcs attribute of the 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.

-

-inline_dotgraph_1 - - - - - - - - - - - - - -
- -

- - - - - - - - - - - - - - - -

Data Fields

void *(* create )(cp_context_t *ctx)
 An initialization function called to create a new plug-in runtime instance.
int(* start )(void *data)
 A start function called to start a plug-in instance.
void(* stop )(void *data)
 A stop function called to stop a plugin instance.
void(* destroy )(void *data)
 A destroy function called to destroy a plug-in instance.
-

Field Documentation

- -
-
- - - - -
void*(* create)(cp_context_t *ctx)
-
-
- -

-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.

-

Parameters:
- - -
ctx the plug-in context of the new plug-in instance
-
-
Returns:
an opaque pointer to plug-in instance data or NULL on failure
- -
-

- -

-
- - - - -
int(* start)(void *data)
-
-
- -

-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. Library initialization, plug-in context management and 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.

-

Parameters:
- - -
data an opaque pointer to plug-in instance data
-
-
Returns:
non-zero on success, or zero on failure
- -
-

- -

-
- - - - -
void(* stop)(void *data)
-
-
- -

-A stop function called to stop a plugin instance. -

-This function must cease all plug-in runtime activities. Library initialization, plug-in context management, 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.

-

Parameters:
- - -
data an opaque pointer to plug-in instance data
-
- -
-

- -

-
- - - - -
void(* destroy)(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.

-

Parameters:
- - -
data an opaque pointer to plug-in instance data
-
- -
-

-

The documentation for this struct was generated from the following file: -
-

-C-Pluff, a plug-in framework for C
-Copyright 2007 Johannes Lehtinen -

-

-Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by doxygen 1.5.1 -

- - diff --git a/lib/cpluff/doc/reference/c-api/tab_b.gif b/lib/cpluff/doc/reference/c-api/tab_b.gif deleted file mode 100644 index 0d623483ff..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/tab_b.gif and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/tab_l.gif b/lib/cpluff/doc/reference/c-api/tab_l.gif deleted file mode 100644 index 9b1e6337c9..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/tab_l.gif and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/tab_r.gif b/lib/cpluff/doc/reference/c-api/tab_r.gif deleted file mode 100644 index ce9dd9f533..0000000000 Binary files a/lib/cpluff/doc/reference/c-api/tab_r.gif and /dev/null differ diff --git a/lib/cpluff/doc/reference/c-api/tabs.css b/lib/cpluff/doc/reference/c-api/tabs.css deleted file mode 100644 index a61552a67a..0000000000 --- a/lib/cpluff/doc/reference/c-api/tabs.css +++ /dev/null @@ -1,102 +0,0 @@ -/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ - -DIV.tabs -{ - float : left; - width : 100%; - background : url("tab_b.gif") repeat-x bottom; - margin-bottom : 4px; -} - -DIV.tabs UL -{ - margin : 0px; - padding-left : 10px; - list-style : none; -} - -DIV.tabs LI, DIV.tabs FORM -{ - display : inline; - margin : 0px; - padding : 0px; -} - -DIV.tabs FORM -{ - float : right; -} - -DIV.tabs A -{ - float : left; - background : url("tab_r.gif") no-repeat right top; - border-bottom : 1px solid #84B0C7; - font-size : x-small; - font-weight : bold; - text-decoration : none; -} - -DIV.tabs A:hover -{ - background-position: 100% -150px; -} - -DIV.tabs A:link, DIV.tabs A:visited, -DIV.tabs A:active, DIV.tabs A:hover -{ - color: #1A419D; -} - -DIV.tabs SPAN -{ - float : left; - display : block; - background : url("tab_l.gif") no-repeat left top; - padding : 5px 9px; - white-space : nowrap; -} - -DIV.tabs INPUT -{ - float : right; - display : inline; - font-size : 1em; -} - -DIV.tabs TD -{ - font-size : x-small; - font-weight : bold; - text-decoration : none; -} - - - -/* Commented Backslash Hack hides rule from IE5-Mac \*/ -DIV.tabs SPAN {float : none;} -/* End IE5-Mac hack */ - -DIV.tabs A:hover SPAN -{ - background-position: 0% -150px; -} - -DIV.tabs LI#current A -{ - background-position: 100% -150px; - border-width : 0px; -} - -DIV.tabs LI#current SPAN -{ - background-position: 0% -150px; - padding-bottom : 6px; -} - -DIV.nav -{ - background : none; - border : none; - border-bottom : 1px solid #84B0C7; -} diff --git a/lib/cpluff/doc/repository.en.html b/lib/cpluff/doc/repository.en.html new file mode 100644 index 0000000000..e6ce13f60c --- /dev/null +++ b/lib/cpluff/doc/repository.en.html @@ -0,0 +1,80 @@ + + + + + + + + + + C-Pluff source code repository + + + +
+ +

C-Pluff source code repository

+ + + +

Repository

+

+ Subversion is a free + revision control system with many available free clients and tools. + C-Pluff source code, documentation and web site material is stored in a + Subversion repository. The repository with all the material and + history dating back to the origins of C-Pluff is available here. + This is a live repository being updated in real time as new changes + are committed. The source code in the trunk is work in progress. For + released versions, see the tag directory. +

+ +

Subversion DAV interface

+

+ The Subversion DAV interface for the repository can be accessed at + the following URL. +

+ 
+http://svn.c-pluff.org/repos/
+

+ This interface is intended for Subversion aware tools (see + the next section for a browsable interface). Check + the Wikipedia page for Subversion + for a list of available clients and other tools. +

+ +

Browsable interface and RSS feeds

+

+ A browsable interface is also available based on + WebSVN. This provides an easy + way to browse versioned material, change logs and differences between + versions. It also provides RSS feeds which can be used to subscribe to + source code changes. +

+ + + +

+ Copyright 2007 Johannes Lehtinen
+ Validation: + XHTML Basic 1.0, + CSS 2 +

+ +
+ + diff --git a/lib/cpluff/doc/robots.txt b/lib/cpluff/doc/robots.txt new file mode 100644 index 0000000000..24146adcd9 --- /dev/null +++ b/lib/cpluff/doc/robots.txt @@ -0,0 +1,3 @@ +User-agent: * +Disallow: /downloads/ +Disallow: /listconfirm/ -- cgit v1.2.3