SPAdapts.h File Reference

#include "SPTypes.h"
#include "SPCaches.h"
#include "SPMData.h"
#include "SPProps.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPAdaptersMessage
	The message passed with all kSPAdaptersCaller calls. More...
struct	SPAdaptersSuite
	An adapter is an interface between the PICA plug-in manager and an individual plug-in. More...
Defines
#define	kSPAdaptersSuite   "SP Adapters Suite"
	SPAdapters suite name.
#define	kSPAdaptersSuiteVersion   3
	SPAdapters suite version.
#define	kSPAdaptersCaller   "SP Adapters"
	Caller for a plug-in adapter.
#define	kSPAdaptersStartupSelector   "Start up"
	Received by a plug-in with an adapter on application startup, after PICA completes its plug-in startup process.
#define	kSPAdaptersShutdownSelector   "Shut down"
	Received by a plug-in with an adapter on application shutdown, after PICA completes its plug-in shutdown process.
#define	kSPAdaptersDisposeInfoSelector   "Dispose info"
	Received by a plug-in with an adapter after a call to SPCachesSuite::SPFlushCaches(), for a final flush of any memory used for private data, including PICA lists and string pools.
#define	kSPAdaptersFlushSelector   "Flush"
	Received by a plug-in with an adapter when the application frees memory, to allow garbage collection.
#define	kSPAdaptersRegisterPluginsSelector   "Register plugins"
	Received by a plug-in after its initialization, to allow it to register its own adapter.
#define	kSPAdaptersLoadPluginSelector   "Load plugin"
	Received by a plug-in with an adapter before it is loaded, to allow the adapter to perform needed translations before the load occurs.
#define	kSPAdaptersReleasePluginSelector   "Release plugin"
	Received by a plug-in with an adapter before it is unloaded, to allow the adapter to perform needed translations before the unload occurs.
#define	kSPAdaptersSendMessageSelector   "Send message"
	Received by a plug-in with an adapter when the application needs to communicate with it.
#define	kSPAdaptersFindPropertySelector   "Find property"
#define	kSPAdaptersAboutSelector   "About"
#define	kSPAdaptersAcquireSuiteHostSelector   "Acquire Suite"
#define	kSPAdaptersReleaseSuiteHostSelector   "Release Suite"
#define	kSPRuntimeAdapterList   ((SPAdapterListRef)NULL)
	PICA global list of registered plug-in adapters.
Typedefs
typedef struct SPAdapter *	SPAdapterRef
	An opaque reference to an adapter object.
typedef struct SPAdapterList *	SPAdapterListRef
	A list of adapter objects.
typedef struct SPAdapterListIterator *	SPAdapterListIteratorRef
	An iterator object for examining an adapter list.
Functions
SPAPI SPErr	SPAllocateAdapterList (struct SPStringPool *stringPool, SPAdapterListRef *adapterList)
	Internal.
SPAPI SPErr	SPFreeAdapterList (SPAdapterListRef adapterList)
	Internal.
SPAPI SPErr	SPAddAdapter (SPAdapterListRef adapterList, struct SPPlugin *host, const char *name, ai::int32 version, SPAdapterRef *adapter)
	Internal.
SPAPI SPErr	SPFindAdapter (SPAdapterListRef adapterList, const char *name, SPAdapterRef *adapter)
	Internal.
SPAPI SPErr	SPNewAdapterListIterator (SPAdapterListRef adapterList, SPAdapterListIteratorRef *iter)
	Internal.
SPAPI SPErr	SPNextAdapter (SPAdapterListIteratorRef iter, SPAdapterRef *adapter)
	Internal.
SPAPI SPErr	SPDeleteAdapterListIterator (SPAdapterListIteratorRef iter)
	Internal.
SPAPI SPErr	SPGetAdapterHost (SPAdapterRef adapter, struct SPPlugin **plugin)
	Internal.
SPAPI SPErr	SPGetAdapterName (SPAdapterRef adapter, const char **name)
	Internal.
SPAPI SPErr	SPGetAdapterVersion (SPAdapterRef adapter, ai::int32 *version)
	Internal.

---

Define Documentation

#define kSPAdaptersAboutSelector   "About"

Deprecated:

Used internally.

#define kSPAdaptersAcquireSuiteHostSelector   "Acquire Suite"

Deprecated:

Used internally.

#define kSPAdaptersFindPropertySelector   "Find property"

Deprecated:

Used internally.

#define kSPAdaptersReleaseSuiteHostSelector   "Release Suite"

Deprecated:

Used internally.

#define kSPAdaptersSuite   "SP Adapters Suite"

SPAdapters suite name.

#define kSPAdaptersSuiteVersion   3

SPAdapters suite version.

#define kSPRuntimeAdapterList   ((SPAdapterListRef)NULL)

PICA global list of registered plug-in adapters.

See also:

SPAdaptersSuite::AddAdapter(), SPRuntimeSuite::GetRuntimeAdapterList().

---

Typedef Documentation

typedef struct SPAdapterListIterator* SPAdapterListIteratorRef

An iterator object for examining an adapter list.

See SPAdaptersSuite::NewAdapterListIterator().

typedef struct SPAdapterList* SPAdapterListRef

A list of adapter objects.

Create with SPAdaptersSuite::AllocateAdapterList(), or use the global list, kSPRuntimeAdapterList.

typedef struct SPAdapter* SPAdapterRef

An opaque reference to an adapter object.

Access using the SPAdaptersSuite.

---

Function Documentation

SPAPI SPErr SPAddAdapter	(	SPAdapterListRef	adapterList,
		struct SPPlugin *	host,
		const char *	name,
		ai::int32	version,
		SPAdapterRef *	adapter
	)

Internal.

SPAPI SPErr SPAllocateAdapterList	(	struct SPStringPool *	stringPool,
		SPAdapterListRef *	adapterList
	)

Internal.

SPAPI SPErr SPDeleteAdapterListIterator

(

SPAdapterListIteratorRef

iter

)

Internal.

SPAPI SPErr SPFindAdapter	(	SPAdapterListRef	adapterList,
		const char *	name,
		SPAdapterRef *	adapter
	)

Internal.

SPAPI SPErr SPFreeAdapterList

(

SPAdapterListRef

adapterList

)

Internal.

SPAPI SPErr SPGetAdapterHost	(	SPAdapterRef	adapter,
		struct SPPlugin **	plugin
	)

Internal.

SPAPI SPErr SPGetAdapterName	(	SPAdapterRef	adapter,
		const char **	name
	)

Internal.

SPAPI SPErr SPGetAdapterVersion	(	SPAdapterRef	adapter,
		ai::int32 *	version
	)

Internal.

SPAPI SPErr SPNewAdapterListIterator	(	SPAdapterListRef	adapterList,
		SPAdapterListIteratorRef *	iter
	)

Internal.

SPAPI SPErr SPNextAdapter	(	SPAdapterListIteratorRef	iter,
		SPAdapterRef *	adapter
	)

Internal.