summaryrefslogtreecommitdiff
path: root/cppu/inc/uno/environment.h
diff options
context:
space:
mode:
Diffstat (limited to 'cppu/inc/uno/environment.h')
-rw-r--r--cppu/inc/uno/environment.h184
1 files changed, 92 insertions, 92 deletions
diff --git a/cppu/inc/uno/environment.h b/cppu/inc/uno/environment.h
index 4a02c46abc28..e362ce7a6e88 100644
--- a/cppu/inc/uno/environment.h
+++ b/cppu/inc/uno/environment.h
@@ -2,7 +2,7 @@
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
+ *
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
@@ -53,69 +53,69 @@ typedef struct _uno_Environment
{
/** reserved for future use (0 if not used)
*/
- void * pReserved;
-
+ void * pReserved;
+
/** type name of environment
*/
- rtl_uString * pTypeName;
-
+ rtl_uString * pTypeName;
+
/** free context pointer to be used for specific classes of environments (e.g., a jvm pointer)
*/
- void * pContext;
-
+ void * pContext;
+
/** pointer to extended environment (interface registration functionality), if supported
*/
struct _uno_ExtEnvironment * pExtEnv;
-
+
/** Acquires this environment.
-
+
@param pEnv this environment
*/
void (SAL_CALL * acquire)( struct _uno_Environment * pEnv );
-
+
/** Releases this environment; last release of environment will revoke the environment from
runtime.
-
+
@param pEnv this environment
*/
void (SAL_CALL * release)( struct _uno_Environment * pEnv );
-
+
/** Acquires this environment weakly. You can only harden a weakly held environment if it
is still acquired hard (acquire()).
-
+
@param pEnv this environment
*/
void (SAL_CALL * acquireWeak)( struct _uno_Environment * pEnv );
-
+
/** Releases this environment weakly in correspondence to acquireWeak().
-
+
@param pEnv this environment
*/
void (SAL_CALL * releaseWeak)( struct _uno_Environment * pEnv );
-
+
/** Makes hard reference out of weak referenced environment. You can only harden a weakly
held environment if it is still acquired hard (acquire()).
-
+
@param ppHardEnv inout hard referenced environment (has to be released via release())
@param pEnv environment (may be weak referenced)
*/
void (SAL_CALL * harden)(
struct _uno_Environment ** ppHardEnv,
struct _uno_Environment * pEnv );
-
+
/** Call this function to EXPLICITLY dispose this environment (e.g., release all
interfaces). You may want to call this function before shutting down due to a runtime error.
-
+
@param pEnv this environment
*/
void (SAL_CALL * dispose)( struct _uno_Environment * pEnv );
-
+
/* ===== the following part will be late initialized by a matching bridge ===== *
- * ===== and is NOT for public use. ===== */
-
+ * ===== and is NOT for public use. ===== */
+
/** CALLBACK function pointer: Disposing callback function pointer that can be set to get
signalled before the environment is destroyed.
-
+
@param pEnv environment that is being disposed
*/
void (SAL_CALL * environmentDisposing)( struct _uno_Environment * pEnv );
@@ -126,14 +126,14 @@ typedef struct _uno_Environment
Any proxy object must register itself on first acquire() call and revoke itself on last
release() call. This can happen several times because the environment caches proxy objects
until the environment explicitly frees the proxy object calling this function.
-
+
@param pEnv environment
@param pProxy proxy pointer
*/
typedef void (SAL_CALL * uno_freeProxyFunc)( struct _uno_ExtEnvironment * pEnv, void * pProxy );
/** Generic function pointer declaration to allocate memory. Used with getRegisteredInterfaces().
-
+
@param nBytes amount of memory in bytes
@return pointer to allocated memory
*/
@@ -146,28 +146,28 @@ typedef struct _uno_ExtEnvironment
/** inherits all members of an uno_Environment
*/
uno_Environment aBase;
-
+
/** Registers an interface of this environment.
-
- @param pEnv this environment
- @param ppInterface inout parameter of interface to be registered
- @param pOId object id of interface
- @param pTypeDescr type description of interface
+
+ @param pEnv this environment
+ @param ppInterface inout parameter of interface to be registered
+ @param pOId object id of interface
+ @param pTypeDescr type description of interface
*/
void (SAL_CALL * registerInterface)(
struct _uno_ExtEnvironment * pEnv,
void ** ppInterface,
rtl_uString * pOId,
struct _typelib_InterfaceTypeDescription * pTypeDescr );
-
+
/** Registers a proxy interface of this environment that can be reanimated and is freed
explicitly by this environment.
-
- @param pEnv this environment
- @param ppInterface inout parameter of interface to be registered
- @param freeProxy function to free proxy object
- @param pOId object id of interface
- @param pTypeDescr type description of interface
+
+ @param pEnv this environment
+ @param ppInterface inout parameter of interface to be registered
+ @param freeProxy function to free proxy object
+ @param pOId object id of interface
+ @param pTypeDescr type description of interface
*/
void (SAL_CALL * registerProxyInterface)(
struct _uno_ExtEnvironment * pEnv,
@@ -175,48 +175,48 @@ typedef struct _uno_ExtEnvironment
uno_freeProxyFunc freeProxy,
rtl_uString * pOId,
struct _typelib_InterfaceTypeDescription * pTypeDescr );
-
+
/** Revokes an interface from this environment. You have to revoke any interface that has
been registered via this method.
-
- @param pEnv this environment
- @param pInterface interface to be revoked
+
+ @param pEnv this environment
+ @param pInterface interface to be revoked
*/
void (SAL_CALL * revokeInterface)(
struct _uno_ExtEnvironment * pEnv,
void * pInterface );
-
+
/** Provides the object id of a given interface.
-
- @param ppOut inout oid
- @param pInterface interface of object
+
+ @param ppOut inout oid
+ @param pInterface interface of object
*/
void (SAL_CALL * getObjectIdentifier)(
struct _uno_ExtEnvironment * pEnv,
rtl_uString ** ppOId,
void * pInterface );
-
+
/** Retrieves an interface identified by its object id and type from this environment.
Interfaces are retrieved in the same order as they are registered.
-
- @param pEnv this environment
- @param ppInterface inout parameter for the registered interface; (0) if none was found
- @param pOId object id of interface to be retrieved
- @param pTypeDescr type description of interface to be retrieved
+
+ @param pEnv this environment
+ @param ppInterface inout parameter for the registered interface; (0) if none was found
+ @param pOId object id of interface to be retrieved
+ @param pTypeDescr type description of interface to be retrieved
*/
void (SAL_CALL * getRegisteredInterface)(
struct _uno_ExtEnvironment * pEnv,
void ** ppInterface,
rtl_uString * pOId,
struct _typelib_InterfaceTypeDescription * pTypeDescr );
-
+
/** Returns all currently registered interfaces of this environment. The memory block
allocated might be slightly larger than (*pnLen * sizeof(void *)).
-
- @param pEnv this environment
+
+ @param pEnv this environment
@param pppInterfaces out param; pointer to array of interface pointers
- @param pnLen out param; length of array
- @param memAlloc function for allocating memory that is passed back
+ @param pnLen out param; length of array
+ @param memAlloc function for allocating memory that is passed back
*/
void (SAL_CALL * getRegisteredInterfaces)(
struct _uno_ExtEnvironment * pEnv,
@@ -227,33 +227,33 @@ typedef struct _uno_ExtEnvironment
/* ===== the following part will be late initialized by a matching bridge ===== */
/** Computes an object id of the given interface; is called by the environment implementation.
-
- @param pEnv corresponding environment
- @param ppOId out param: computed id
- @param pInterface an interface
+
+ @param pEnv corresponding environment
+ @param ppOId out param: computed id
+ @param pInterface an interface
*/
void (SAL_CALL * computeObjectIdentifier)(
struct _uno_ExtEnvironment * pEnv,
rtl_uString ** ppOId, void * pInterface );
-
+
/** Function to acquire an interface.
-
- @param pEnv corresponding environment
- @param pInterface an interface
+
+ @param pEnv corresponding environment
+ @param pInterface an interface
*/
void (SAL_CALL * acquireInterface)(
struct _uno_ExtEnvironment * pEnv,
void * pInterface );
-
+
/** Function to release an interface.
-
- @param pEnv corresponding environment
- @param pInterface an interface
+
+ @param pEnv corresponding environment
+ @param pInterface an interface
*/
void (SAL_CALL * releaseInterface)(
struct _uno_ExtEnvironment * pEnv,
void * pInterface );
-
+
} uno_ExtEnvironment;
#if defined( SAL_W32) || defined(SAL_OS2)
@@ -262,7 +262,7 @@ typedef struct _uno_ExtEnvironment
/** Function exported by some bridge library providing acquireInterface(), releaseInterface();
may set a disposing callback.
-
+
@param pEnv environment to be initialized
*/
typedef void (SAL_CALL * uno_initEnvironmentFunc)( uno_Environment * pEnv );
@@ -270,10 +270,10 @@ typedef void (SAL_CALL * uno_initEnvironmentFunc)( uno_Environment * pEnv );
/** Gets a specific environment. If the specified environment does not exist, then a default one
is created and registered. The environment revokes itself on last release() call.
-
- @param ppEnv inout parameter of environment; given environment will be released
- @param pEnvDcp descriptor of environment
- @param pContext some context pointer (e.g., to distinguish java vm; set 0 if not needed)
+
+ @param ppEnv inout parameter of environment; given environment will be released
+ @param pEnvDcp descriptor of environment
+ @param pContext some context pointer (e.g., to distinguish java vm; set 0 if not needed)
*/
void SAL_CALL uno_getEnvironment(
uno_Environment ** ppEnv, rtl_uString * pEnvDcp, void * pContext )
@@ -281,10 +281,10 @@ void SAL_CALL uno_getEnvironment(
/** Gets all specified environments. Caller has to release returned environments and free allocated
memory.
-
- @param pppEnvs out param; pointer to array of environments
- @param pnLen out param; length of array
- @param memAlloc function for allocating memory that is passed back
+
+ @param pppEnvs out param; pointer to array of environments
+ @param pnLen out param; length of array
+ @param memAlloc function for allocating memory that is passed back
@param pEnvDcp descriptor of environments; 0 defaults to all
*/
void SAL_CALL uno_getRegisteredEnvironments(
@@ -293,29 +293,29 @@ void SAL_CALL uno_getRegisteredEnvironments(
SAL_THROW_EXTERN_C();
/** Creates an environment. The new environment is anonymous (NOT publicly registered/ accessible).
-
- @param ppEnv out parameter of environment; given environment will be released
+
+ @param ppEnv out parameter of environment; given environment will be released
@param pEnvDcp descriptor of environment
- @param pContext context pointer (e.g., to distinguish java vm); set 0 if not needed
+ @param pContext context pointer (e.g., to distinguish java vm); set 0 if not needed
*/
void SAL_CALL uno_createEnvironment(
uno_Environment ** ppEnv, rtl_uString * pEnvDcp, void * pContext )
SAL_THROW_EXTERN_C();
/** Dumps out environment information, i.e. registered interfaces.
-
- @param stream output stream (FILE *)
- @param pEnv environment to be dumped
- @param pFilter if not null, filters output
+
+ @param stream output stream (FILE *)
+ @param pEnv environment to be dumped
+ @param pFilter if not null, filters output
*/
void SAL_CALL uno_dumpEnvironment(
void * stream, uno_Environment * pEnv, const sal_Char * pFilter )
SAL_THROW_EXTERN_C();
/** Dumps out environment information, i.e. registered interfaces.
-
- @param stream output stream (FILE *)
+
+ @param stream output stream (FILE *)
@param pEnvDcp descritpro of environment to be dumped
- @param pFilter if not null, filters output
+ @param pFilter if not null, filters output
*/
void SAL_CALL uno_dumpEnvironmentByName(
void * stream, rtl_uString * pEnvDcp, const sal_Char * pFilter )
@@ -327,7 +327,7 @@ void SAL_CALL uno_dumpEnvironmentByName(
In case no Environment has explicitly been entered, a purpose free
default environment gets returned (e.g. the "uno" or "gcc3" Environment).
- @param ppEnv inout parameter; a given environment will be released
+ @param ppEnv inout parameter; a given environment will be released
@param pTypeName the optional type of the environment, falls back to "uno"
@since UDK 3.2.7
*/
@@ -348,7 +348,7 @@ typedef void SAL_CALL uno_EnvCallee(va_list * pParam);
void SAL_CALL uno_Environment_invoke_v(uno_Environment * pEnv, uno_EnvCallee * pCallee, va_list * pParam)
SAL_THROW_EXTERN_C();
-/** Invoke the passed function in the given environment.
+/** Invoke the passed function in the given environment.
@param pEnv the target environment
@param pCallee the function to call
@@ -358,7 +358,7 @@ void SAL_CALL uno_Environment_invoke_v(uno_Environment * pEnv, uno_EnvCallee * p
void SAL_CALL uno_Environment_invoke (uno_Environment * pEnv, uno_EnvCallee * pCallee, ...)
SAL_THROW_EXTERN_C();
-/** Enter an environment explicitly.
+/** Enter an environment explicitly.
@param pEnv the environment to enter; NULL leaves all environments
@since UDK 3.2.7
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-25 13:40:38 +0000