1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_uno_Enterable_h 25*b1cdbd2cSJim Jagielski #define INCLUDED_uno_Enterable_h 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "uno/environment.h" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #ifdef __cplusplus 31*b1cdbd2cSJim Jagielski extern "C" 32*b1cdbd2cSJim Jagielski { 33*b1cdbd2cSJim Jagielski #endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski /** Generic function type declaration for entering an Environment. 37*b1cdbd2cSJim Jagielski (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack) 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski @param context 40*b1cdbd2cSJim Jagielski @since UDK 3.2.7 41*b1cdbd2cSJim Jagielski */ 42*b1cdbd2cSJim Jagielski typedef void uno_Enterable_enter (void * context); 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski /** Generic function type declaration for levaing an Environment. 46*b1cdbd2cSJim Jagielski (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack) 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski @param context 49*b1cdbd2cSJim Jagielski @since UDK 3.2.7 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski typedef void uno_Enterable_leave (void * context); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** Generic function type declaration for calling into an Environment. 55*b1cdbd2cSJim Jagielski (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack) 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @param context 58*b1cdbd2cSJim Jagielski @param pCallee the function to be called 59*b1cdbd2cSJim Jagielski @param pParam the parameter pointer to be passed to the function 60*b1cdbd2cSJim Jagielski @since UDK 3.2.7 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski typedef void uno_Enterable_callInto_v(void * context, uno_EnvCallee * pCallee, va_list * pParam); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** Generic function type declaration for calling out of an Environment. 66*b1cdbd2cSJim Jagielski (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack) 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param context 69*b1cdbd2cSJim Jagielski @param pCallee the function to be called 70*b1cdbd2cSJim Jagielski @param pParam the parameter pointer to be passed to the function 71*b1cdbd2cSJim Jagielski @since UDK 3.2.7 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski typedef void uno_Enterable_callOut_v (void * context, uno_EnvCallee * pCallee, va_list * pParam); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** Generic function type declaration for checking if calling on managed object is 77*b1cdbd2cSJim Jagielski valid. 78*b1cdbd2cSJim Jagielski (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack) 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @param context 81*b1cdbd2cSJim Jagielski @param ppReason the reason, in case calling is not valid 82*b1cdbd2cSJim Jagielski @return 0 == calling is not valid, 1 == calling is valid 83*b1cdbd2cSJim Jagielski @since UDK 3.2.7 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielski typedef int uno_Enterable_isValid_v (void * context, rtl_uString ** ppReason); 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** A struct pReserved needs to point to, if implementing a purpose environment. 89*b1cdbd2cSJim Jagielski (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack) 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @since UDK 3.2.7 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski typedef struct 94*b1cdbd2cSJim Jagielski { 95*b1cdbd2cSJim Jagielski uno_Enterable_enter * m_enter; 96*b1cdbd2cSJim Jagielski uno_Enterable_leave * m_leave; 97*b1cdbd2cSJim Jagielski uno_Enterable_callInto_v * m_callInto_v; 98*b1cdbd2cSJim Jagielski uno_Enterable_callOut_v * m_callOut_v; 99*b1cdbd2cSJim Jagielski uno_Enterable_isValid_v * m_isValid; 100*b1cdbd2cSJim Jagielski } 101*b1cdbd2cSJim Jagielski uno_Enterable; 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski #ifdef __cplusplus 105*b1cdbd2cSJim Jagielski } 106*b1cdbd2cSJim Jagielski #endif 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski #endif 109