Difference between revisions of "Uno/Binary/Spec/Environment Stack"

From Apache OpenOffice Wiki
< Uno‎ | Binary
Jump to: navigation, search
m (OpenOffice.org Wiki:Spec Uno Bin Environment Stacks moved to Uno/Binary/Spec/Environment Stack)
(Updated state.)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
author:  [[User:Kr|Kr]] <br>
+
Type: specification State: Evolving  Availability: URE 1.3
−
version: {{REVISIONID}} <br>
+
−
state:  draft          <br>
+
−
created: 08/10/2005    <br>
+
−
type:    specification  <br>
+
  
−
== Binary UNO ==
+
==Feature==
−
=== Stacked Environments ===
+
The [[Uno/Spec/Environment Stack|abstract Environment Stack]] for [[Uno/Binary|Binary Uno]].
  
−
; Feature
+
[[../Environment|environments]] can be:
−
: UNO Environments can be:
+
* entered or
−
:* entered or
+
* left, respectively
−
:* left, respectively
+
* invoked
−
:* invoked
+
by a thread. The currently entered [[../Environment|environment]] can be retrieved.
−
: by a thread. The current threads environment can be asked for.
+
 
    
 
    
−
: Multiple purpose environments can be entered/invoked at the same time.
+
Multiple [[Uno/Spec/Purpose Environment|purpose environments]] can be entered/invoked at the same time.
−
: Purposes of environment can be specified in any particular order:
+
Purposes of environment can be specified in any particular order, e.g.:
 +
<code>[cpp]
 +
"uno:A:B:C"
 +
</code>
 +
Where the order may be relevant, depending on the purpose environments.
  
−
: <code>"uno:A:B:C"</code>
+
==Rationale==
−
: Where the order may be relevant, depending on the purpose environments.
+
  
−
; Rationale :
+
==API==
 +
The prototype for a callee:
 +
<code>[cpp]
 +
typedef void SAL_CALL uno_EnvCallee(va_list);
 +
</code>
  
−
; API
+
The Enterable interface, to be optionally implemented by [[Uno/Spec/Purpose Environment|purpose environments]]:
−
: The Enterable interface, optionally be implemented by purp environments:
+
<code>[cpp]
−
: <code>typedef void uno_Enterable_enter    (void * context);</code>
+
typedef void uno_Enterable_enter    (void * context);
−
: <code>typedef void uno_Enterable_leave    (void * context);</code>
+
typedef void uno_Enterable_leave    (void * context);
−
: <code>typedef void uno_Enterable_callInto_v(void * context, uno_EnvCallee * pCallee, va_list param);</code>
+
typedef void uno_Enterable_callInto_v(void * context, uno_EnvCallee * pCallee, va_list param);
−
: <code>typedef void uno_Enterable_callOut_v (void * context, uno_EnvCallee * pCallee, va_list param);</code>
+
typedef void uno_Enterable_callOut_v (void * context, uno_EnvCallee * pCallee, va_list param);
−
: <code>typedef int  uno_Enterable_isValid_v (void * context, rtl_uString ** ppReason);</code>
+
typedef int  uno_Enterable_isValid_v (void * context, rtl_uString ** ppReason);
  
−
: <code>typedef struct</code>
+
typedef struct
−
: <code>{</code>
+
{
−
: <code>  uno_Enterable_enter      * m_enter;</code>
+
  uno_Enterable_enter      * m_enter;
−
: <code>  uno_Enterable_leave      * m_leave;</code>
+
  uno_Enterable_leave      * m_leave;
−
: <code>  uno_Enterable_callInto_v * m_callInto_v;</code>
+
  uno_Enterable_callInto_v * m_callInto_v;
−
: <code>  uno_Enterable_callOut_v  * m_callOut_v;</code>
+
  uno_Enterable_callOut_v  * m_callOut_v;
−
: <code>  uno_Enterable_isValid_v  * m_isValid;</code>
+
  uno_Enterable_isValid_v  * m_isValid;
−
: <code>}</code>
+
}
−
: <code>uno_Enterable;</code>
+
uno_Enterable;
 +
</code>
  
−
: The client API, which is thread affine:
+
The client API, which is [[Uno/Term/Thread Affine|thread-affine]]:
−
: <code>void SAL_CALL uno_getCurrentEnvironment(uno_Environment ** ppEnv, char const * pEnv_type) SAL_THROW_EXTERN_C();</code>
+
<code>[cpp]
−
: <code>typedef void uno_EnvCallee(va_list);</code>
+
void SAL_CALL uno_getCurrentEnvironment(uno_Environment ** ppEnv, char const * pEnv_type) SAL_THROW_EXTERN_C();
−
: <code>void SAL_CALL uno_Environment_invoke_v(uno_Environment * pEnv, uno_EnvCallee * pCallee, va_list param) SAL_THROW_EXTERN_C();</code>
+
void SAL_CALL uno_Environment_invoke_v (uno_Environment * pEnv, uno_EnvCallee * pCallee, va_list param) SAL_THROW_EXTERN_C();
−
: <code>void SAL_CALL uno_Environment_invoke (uno_Environment * pEnv, uno_EnvCallee * pCallee, ...)   SAL_THROW_EXTERN_C();</code>
+
void SAL_CALL uno_Environment_invoke   (uno_Environment * pEnv, uno_EnvCallee * pCallee, ...)   SAL_THROW_EXTERN_C();
−
: <code>void SAL_CALL uno_Environment_enter(uno_Environment * pEnv) SAL_THROW_EXTERN_C();</code>
+
void SAL_CALL uno_Environment_enter   (uno_Environment * pEnv) SAL_THROW_EXTERN_C();
−
: <code>int SAL_CALL uno_Environment_isValid(uno_Environment * pEnv, rtl_uString ** pReason)  SAL_THROW_EXTERN_C();</code>
+
int SAL_CALL uno_Environment_isValid (uno_Environment * pEnv, rtl_uString ** pReason)  SAL_THROW_EXTERN_C();
  
−
: <code>uno_Environment->pReserved == uno_Enterable *</code>
+
uno_Environment->pReserved == uno_Enterable *
 +
</code>
  
−
; Compatibility Issues: None.
 
  
−
; Dependencies: None.
+
[[Category:Spec]]
 +
[[Category:Draft]]
 +
[[Category:Uno]]
 +
[[Category:Uno:Binary]]

Latest revision as of 11:46, 22 May 2007

Type: specification State: Evolving Availability: URE 1.3

Feature

The abstract Environment Stack for Binary Uno.

environments can be:

  • entered or
  • left, respectively
  • invoked

by a thread. The currently entered environment can be retrieved.

Multiple purpose environments can be entered/invoked at the same time. Purposes of environment can be specified in any particular order, e.g.: [cpp] "uno:A:B:C" Where the order may be relevant, depending on the purpose environments.

Rationale

API

The prototype for a callee: [cpp] typedef void SAL_CALL uno_EnvCallee(va_list);

The Enterable interface, to be optionally implemented by purpose environments: [cpp] typedef void uno_Enterable_enter (void * context); typedef void uno_Enterable_leave (void * context); typedef void uno_Enterable_callInto_v(void * context, uno_EnvCallee * pCallee, va_list param); typedef void uno_Enterable_callOut_v (void * context, uno_EnvCallee * pCallee, va_list param); typedef int uno_Enterable_isValid_v (void * context, rtl_uString ** ppReason);

typedef struct { 

 uno_Enterable_enter      * m_enter;
 uno_Enterable_leave      * m_leave;
 uno_Enterable_callInto_v * m_callInto_v;
 uno_Enterable_callOut_v  * m_callOut_v;
 uno_Enterable_isValid_v  * m_isValid;

} uno_Enterable;

The client API, which is thread-affine: [cpp] void SAL_CALL uno_getCurrentEnvironment(uno_Environment ** ppEnv, char const * pEnv_type) SAL_THROW_EXTERN_C(); void SAL_CALL uno_Environment_invoke_v (uno_Environment * pEnv, uno_EnvCallee * pCallee, va_list param) SAL_THROW_EXTERN_C(); void SAL_CALL uno_Environment_invoke (uno_Environment * pEnv, uno_EnvCallee * pCallee, ...) SAL_THROW_EXTERN_C(); void SAL_CALL uno_Environment_enter (uno_Environment * pEnv) SAL_THROW_EXTERN_C(); int SAL_CALL uno_Environment_isValid (uno_Environment * pEnv, rtl_uString ** pReason) SAL_THROW_EXTERN_C();

uno_Environment->pReserved == uno_Enterable *

Retrieved from "https://wiki.openoffice.org/w/index.php?title=Uno/Binary/Spec/Environment_Stack&oldid=32858"
Personal tools