SPRuntme.h File Reference

#include "SPTypes.h"
#include "SPAdapts.h"
#include "SPFiles.h"
#include "SPPlugs.h"
#include "SPStrngs.h"
#include "SPSuites.h"
#include "SPHeaderBegin.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPHostProcs
	Callback procedures provided to PICA by the application. More...
struct	SPRuntimeSuite
	This suite allows you to obtain specific references to the PICA global lists and string pool. More...
struct	SPBasicFuncStruct
	Internal. More...
Defines
#define	kSPRuntimeSuite   "SP Runtime Suite"
#define	kSPRuntimeSuiteVersion5   5
#define	kSPRuntimeSuiteVersion6   6
#define	kSPRuntimeSuiteVersion   kSPRuntimeSuiteVersion6
Typedefs
typedef void *(*	SPAllocateProc )(size_t size, void *hostData)
	Internal.
typedef void(*	SPFreeProc )(void *block, void *hostData)
	Internal.
typedef void *(*	SPReallocateProc )(void *block, size_t newSize, void *hostData)
	Internal.
typedef void(*	SPStartupNotifyProc )(NotifyEvent event, void *notifyData, void *hostData)
	Called by an adapter to inform the application that a plug-in is being started up.
typedef void(*	SPShutdownNotifyProc )(NotifyEvent event, void *notifyData, void *hostData)
	Called by an adapter to inform the application that a plug-in is being shut down.
typedef void(*	SPAssertTrapProc )(const char *failMessage, void *hostData)
	Internal.
typedef void(*	SPThrowTrapProc )(SPErr error, void *hostData)
	Internal.
typedef void(*	SPDebugTrapProc )(const char *debugMessage, void *hostData)
	Internal.
typedef SPAPI SPErr(*	SPAllocateStringPoolProc )(SPStringPoolRef *pool)
	Internal.
typedef SPAPI SPErr(*	SPFreeStringPoolProc )(SPStringPoolRef stringPool)
	Internal.
typedef SPAPI SPErr(*	SPMakeWStringProc )(SPStringPoolRef stringPool, const char *string, const char **wString)
	Internal.
typedef SPAPI SPErr(*	SPGetHostAccessInfoProc )(SPPlatformAccessInfo *spHostAccessInfo)
	Internal.
typedef SPAPI SPBoolean(*	SPFilterEventProc )(NotifyEvent event, const void *eventData)
	Internal.
typedef SPAPI SPErr(*	SPAddPluginsProc )(void)
	Internal.
typedef SPAPI SPBoolean(*	SPOverrideStartupProc )(SPPluginRef currentPlugin)
	Internal.
typedef SPAPI SPErr(*	SPResolveLinkProc )(const char *shortcutFile, char *resolvedPath)
	Internal.
typedef SPAPI SPErr(*	SPResolveLinkProcW )(const wchar_t *shortcutFile, wchar_t *resolvedPath)
typedef SPAPI SPErr(*	SPWideCharToPlatform )(char *destination, size_t dstSizeBytes, const ai::uint16 *src, size_t srcWcharCount)
typedef SPAPI SPErr(*	SPPlatformToWideChar )(ai::uint16 *destination, size_t dstCharCount, const char *src, size_t srcSizeBytes)
typedef SPAPI SPErr(*	GetNativePluginAccessProc )(SPPluginRef plugin, SPAccessRef *access)
	Internal.
typedef SPAPI SPBoolean(*	MemoryIsCriticalProc )(void)
	Internal.
Enumerations
enum	NotifyEvent {   kAddFile, kAddPlugin, kSetMessage, kSuitesAvailable,   kError, kStartingupPlugin, kNoEvent = 0xffffffff }
	A notification event type, that an adapter passes to the SPStartupNotifyProc and SPShutdownNotifyProc when the associated plug-in is loaded or unloaded. More...
Functions
SPAPI SPErr	SPGetRuntimeStringPool (SPStringPoolRef *stringPool)
	Internal.
SPAPI SPErr	SPGetRuntimeSuiteList (SPSuiteListRef *suiteList)
	Internal.
SPAPI SPErr	SPGetRuntimeFileList (SPFileListRef *fileList)
	Internal.
SPAPI SPErr	SPGetRuntimePluginList (SPPluginListRef *pluginList)
	Internal.
SPAPI SPErr	SPGetRuntimeAdapterList (SPAdapterListRef *adapterList)
	Internal.
SPAPI SPErr	SPGetRuntimeHostProcs (SPHostProcs **hostProcs)
	Internal.
SPAPI SPErr	SPGetRuntimePluginsFolder (SPPlatformFileReference *pluginFolder)
	Internal.
SPAPI SPErr	SPSetRuntimePluginsFolder (SPPlatformFileReference *pluginFolder)
	Internal.
SPAPI SPErr	SPGetRuntimeHostFileRef (SPPlatformFileReference *hostFileSpec)
	Internal.
SPAPI SPErr	SPGetRuntimePluginsFolder_v5 (SPPlatformFileSpecification *pluginFolder)
	Internal.
SPAPI SPErr	SPGetRuntimeHostFileRef_v5 (SPPlatformFileSpecification *hostFileSpec)
	Internal.
void	SetUpBasicFuncs (SPBasicFuncStruct *inStruct)
	Internal.

---

Define Documentation

#define kSPRuntimeSuite   "SP Runtime Suite"

#define kSPRuntimeSuiteVersion   kSPRuntimeSuiteVersion6

#define kSPRuntimeSuiteVersion5   5

#define kSPRuntimeSuiteVersion6   6

---

Typedef Documentation

typedef SPAPI SPErr(* GetNativePluginAccessProc)(SPPluginRef plugin, SPAccessRef *access)

Internal.

typedef SPAPI SPBoolean(* MemoryIsCriticalProc)(void)

Internal.

typedef SPAPI SPErr(* SPAddPluginsProc)(void)

Internal.

typedef void*(* SPAllocateProc)(size_t size, void *hostData)

Internal.

typedef SPAPI SPErr(* SPAllocateStringPoolProc)(SPStringPoolRef *pool)

Internal.

typedef void(* SPAssertTrapProc)(const char *failMessage, void *hostData)

Internal.

typedef void(* SPDebugTrapProc)(const char *debugMessage, void *hostData)

Internal.

typedef SPAPI SPBoolean(* SPFilterEventProc)(NotifyEvent event, const void *eventData)

Internal.

typedef void(* SPFreeProc)(void *block, void *hostData)

Internal.

typedef SPAPI SPErr(* SPFreeStringPoolProc)(SPStringPoolRef stringPool)

Internal.

typedef SPAPI SPErr(* SPGetHostAccessInfoProc)(SPPlatformAccessInfo *spHostAccessInfo)

Internal.

typedef SPAPI SPErr(* SPMakeWStringProc)(SPStringPoolRef stringPool, const char *string, const char **wString)

Internal.

typedef SPAPI SPBoolean(* SPOverrideStartupProc)(SPPluginRef currentPlugin)

Internal.

typedef SPAPI SPErr(* SPPlatformToWideChar)(ai::uint16 *destination, size_t dstCharCount, const char *src, size_t srcSizeBytes)

typedef void*(* SPReallocateProc)(void *block, size_t newSize, void *hostData)

Internal.

typedef SPAPI SPErr(* SPResolveLinkProc)(const char *shortcutFile, char *resolvedPath)

Internal.

typedef SPAPI SPErr(* SPResolveLinkProcW)(const wchar_t *shortcutFile, wchar_t *resolvedPath)

typedef void(* SPShutdownNotifyProc)(NotifyEvent event, void *notifyData, void *hostData)

Called by an adapter to inform the application that a plug-in is being shut down.

The application uses this information to track the shut-down process.

Parameters:

	event	The notification event.
	notifyData	A pointer to plug-in-defined termination data.
	hostData	A pointer to application-defined termination data.

Returns:

Nothing.

typedef void(* SPStartupNotifyProc)(NotifyEvent event, void *notifyData, void *hostData)

Called by an adapter to inform the application that a plug-in is being started up.

The application uses this information to track the start-up process; for example, to display a list of plug-ins being loaded.

Parameters:

	event	The notification event constant that identifies which event occurred.
	notifyData	A pointer to plug-in-defined initialization data.
	hostData	A pointer to application-defined initialization data.

Returns:

Nothing.

typedef void(* SPThrowTrapProc)(SPErr error, void *hostData)

Internal.

typedef SPAPI SPErr(* SPWideCharToPlatform)(char *destination, size_t dstSizeBytes, const ai::uint16 *src, size_t srcWcharCount)

---

Enumeration Type Documentation

enum NotifyEvent

A notification event type, that an adapter passes to the SPStartupNotifyProc and SPShutdownNotifyProc when the associated plug-in is loaded or unloaded.

Enumerator:

kAddFile	Sent to the SPStartupNotifyProc after a file has been added as a plug-in. The notifyData value is the plug-in object, an SPPluginRef.
kAddPlugin	Sent to the SPStartupNotifyProc after a plug-in has been added. The notifyData value is the plug-in object, an SPPluginRef.
kSetMessage	Sent to the SPStartupNotifyProc to specify a general message for the application splash screen. The notifyData value is a pointer to a C string, char**.
kSuitesAvailable	Internal.
kError	Internal.
kStartingupPlugin	Sent to the SPStartupNotifyProc after the plug-in is started. The notifyData value is the plug-in object, an SPPluginRef.
kNoEvent	Internal.

---

Function Documentation

void SetUpBasicFuncs

(

SPBasicFuncStruct *

inStruct

)

Internal.

SPAPI SPErr SPGetRuntimeAdapterList

(

SPAdapterListRef *

adapterList

)

Internal.

SPAPI SPErr SPGetRuntimeFileList

(

SPFileListRef *

fileList

)

Internal.

SPAPI SPErr SPGetRuntimeHostFileRef

(

SPPlatformFileReference *

hostFileSpec

)

Internal.

SPAPI SPErr SPGetRuntimeHostFileRef_v5

(

SPPlatformFileSpecification *

hostFileSpec

)

Internal.

SPAPI SPErr SPGetRuntimeHostProcs

(

SPHostProcs **

hostProcs

)

Internal.

SPAPI SPErr SPGetRuntimePluginList

(

SPPluginListRef *

pluginList

)

Internal.

SPAPI SPErr SPGetRuntimePluginsFolder

(

SPPlatformFileReference *

pluginFolder

)

Internal.

SPAPI SPErr SPGetRuntimePluginsFolder_v5

(

SPPlatformFileSpecification *

pluginFolder

)

Internal.

SPAPI SPErr SPGetRuntimeStringPool

(

SPStringPoolRef *

stringPool

)

Internal.

SPAPI SPErr SPGetRuntimeSuiteList

(

SPSuiteListRef *

suiteList

)

Internal.

SPAPI SPErr SPSetRuntimePluginsFolder

(

SPPlatformFileReference *

pluginFolder

)

Internal.