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 #ifndef _UNO_MAPPING_H_ 24*b1cdbd2cSJim Jagielski #define _UNO_MAPPING_H_ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski #include <sal/types.h> 27*b1cdbd2cSJim Jagielski #include <rtl/ustring.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 struct _typelib_InterfaceTypeDescription; 36*b1cdbd2cSJim Jagielski struct _uno_Mapping; 37*b1cdbd2cSJim Jagielski struct _uno_Environment; 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski /** 40*b1cdbd2cSJim Jagielski Function pointer declaration to acquire a UNO mapping. 41*b1cdbd2cSJim Jagielski */ 42*b1cdbd2cSJim Jagielski typedef void (SAL_CALL * uno_AcquireMappingFunc)(struct _uno_Mapping *); 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski /** 45*b1cdbd2cSJim Jagielski Function pointer declaration to release a UNO mapping. 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielski typedef void (SAL_CALL * uno_ReleaseMappingFunc)(struct _uno_Mapping *); 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** Function pointer declaration to map an interface from one environment to another. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @param pMapping mapping 52*b1cdbd2cSJim Jagielski @param ppOut [inout] destination interface; existing interfaces are released 53*b1cdbd2cSJim Jagielski @param pInterface source interface 54*b1cdbd2cSJim Jagielski @param pInterfaceTypeDescr type description of the interface 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski typedef void (SAL_CALL * uno_MapInterfaceFunc)( 57*b1cdbd2cSJim Jagielski struct _uno_Mapping * pMapping, 58*b1cdbd2cSJim Jagielski void ** ppOut, void * pInterface, 59*b1cdbd2cSJim Jagielski struct _typelib_InterfaceTypeDescription * pInterfaceTypeDescr ); 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski #if defined( SAL_W32) 63*b1cdbd2cSJim Jagielski #pragma pack(push, 8) 64*b1cdbd2cSJim Jagielski #elif defined(SAL_OS2) 65*b1cdbd2cSJim Jagielski #pragma pack(push, 8) 66*b1cdbd2cSJim Jagielski #endif 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** This is the binary specification of a mapping. 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski typedef struct _uno_Mapping 71*b1cdbd2cSJim Jagielski { 72*b1cdbd2cSJim Jagielski /** Acquires mapping 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski uno_AcquireMappingFunc acquire; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** Releases mapping. The last release may unload bridges. 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski uno_ReleaseMappingFunc release; 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski /** mapping function 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski uno_MapInterfaceFunc mapInterface; 83*b1cdbd2cSJim Jagielski } uno_Mapping; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski #if defined( SAL_W32) || defined(SAL_OS2) 86*b1cdbd2cSJim Jagielski #pragma pack(pop) 87*b1cdbd2cSJim Jagielski #endif 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** Gets an interface mapping from one environment to another. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @param ppMapping [inout] mapping; existing mapping will be released 92*b1cdbd2cSJim Jagielski @param pFrom source environment 93*b1cdbd2cSJim Jagielski @param pTo destination environment 94*b1cdbd2cSJim Jagielski (interfaces resulting in mapInterface() call can be used 95*b1cdbd2cSJim Jagielski in this language environment) 96*b1cdbd2cSJim Jagielski @param pAddPurpose additional purpose of mapping (e.g., protocolling); defaults to 0 (none) 97*b1cdbd2cSJim Jagielski */ 98*b1cdbd2cSJim Jagielski void SAL_CALL uno_getMapping( 99*b1cdbd2cSJim Jagielski struct _uno_Mapping ** ppMapping, 100*b1cdbd2cSJim Jagielski struct _uno_Environment * pFrom, 101*b1cdbd2cSJim Jagielski struct _uno_Environment * pTo, 102*b1cdbd2cSJim Jagielski rtl_uString * pAddPurpose ) 103*b1cdbd2cSJim Jagielski SAL_THROW_EXTERN_C(); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /** Callback function pointer declaration to get a mapping. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @param ppMapping inout mapping 108*b1cdbd2cSJim Jagielski @param pFrom source environment 109*b1cdbd2cSJim Jagielski @param pTo destination environment 110*b1cdbd2cSJim Jagielski @param pAddPurpose additional purpose 111*b1cdbd2cSJim Jagielski */ 112*b1cdbd2cSJim Jagielski typedef void (SAL_CALL * uno_getMappingFunc)( 113*b1cdbd2cSJim Jagielski struct _uno_Mapping ** ppMapping, 114*b1cdbd2cSJim Jagielski struct _uno_Environment * pFrom, 115*b1cdbd2cSJim Jagielski struct _uno_Environment * pTo, 116*b1cdbd2cSJim Jagielski rtl_uString * pAddPurpose ); 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski /** Registers a callback being called each time a mapping is demanded. 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski @param pCallback callback function 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski void SAL_CALL uno_registerMappingCallback( 123*b1cdbd2cSJim Jagielski uno_getMappingFunc pCallback ) 124*b1cdbd2cSJim Jagielski SAL_THROW_EXTERN_C(); 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski /** Revokes a mapping callback registration. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @param pCallback callback function 129*b1cdbd2cSJim Jagielski */ 130*b1cdbd2cSJim Jagielski void SAL_CALL uno_revokeMappingCallback( 131*b1cdbd2cSJim Jagielski uno_getMappingFunc pCallback ) 132*b1cdbd2cSJim Jagielski SAL_THROW_EXTERN_C(); 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski /** Function pointer declaration to free a mapping. 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski @param pMapping mapping to be freed 137*b1cdbd2cSJim Jagielski */ 138*b1cdbd2cSJim Jagielski typedef void (SAL_CALL * uno_freeMappingFunc)( struct _uno_Mapping * pMapping ); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski /** Registers a mapping. A mapping registers itself on first acquire and revokes itself on last 141*b1cdbd2cSJim Jagielski release. The given freeMapping function is called by the runtime to cleanup any resources. 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski @param ppMapping inout mapping to be registered 144*b1cdbd2cSJim Jagielski @param freeMapping called by runtime to delete mapping 145*b1cdbd2cSJim Jagielski @param pFrom source environment 146*b1cdbd2cSJim Jagielski @param pTo destination environment 147*b1cdbd2cSJim Jagielski @param pAddPurpose additional purpose string; defaults to 0 148*b1cdbd2cSJim Jagielski */ 149*b1cdbd2cSJim Jagielski void SAL_CALL uno_registerMapping( 150*b1cdbd2cSJim Jagielski struct _uno_Mapping ** ppMapping, uno_freeMappingFunc freeMapping, 151*b1cdbd2cSJim Jagielski struct _uno_Environment * pFrom, struct _uno_Environment * pTo, rtl_uString * pAddPurpose ) 152*b1cdbd2cSJim Jagielski SAL_THROW_EXTERN_C(); 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski /** Revokes a mapping. A mapping registers itself on first acquire and revokes itself on last 155*b1cdbd2cSJim Jagielski release. 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski @param pMapping mapping to be revoked 158*b1cdbd2cSJim Jagielski */ 159*b1cdbd2cSJim Jagielski void SAL_CALL uno_revokeMapping( 160*b1cdbd2cSJim Jagielski struct _uno_Mapping * pMapping ) 161*b1cdbd2cSJim Jagielski SAL_THROW_EXTERN_C(); 162*b1cdbd2cSJim Jagielski 163*b1cdbd2cSJim Jagielski /** Gets an interface mapping from one language environment to another by corresponding environment 164*b1cdbd2cSJim Jagielski type names. 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski @param ppMapping [inout] mapping; existing mapping will be released 167*b1cdbd2cSJim Jagielski @param pFrom source environment type name 168*b1cdbd2cSJim Jagielski @param pTo destination environment type name 169*b1cdbd2cSJim Jagielski (interfaces resulting in mapInterface() call can be used 170*b1cdbd2cSJim Jagielski in this language environment) 171*b1cdbd2cSJim Jagielski @param pAddPurpose additional purpose of mapping (e.g., protocolling); defaults to 0 (none) 172*b1cdbd2cSJim Jagielski */ 173*b1cdbd2cSJim Jagielski void SAL_CALL uno_getMappingByName( 174*b1cdbd2cSJim Jagielski struct _uno_Mapping ** ppMapping, 175*b1cdbd2cSJim Jagielski rtl_uString * pFrom, 176*b1cdbd2cSJim Jagielski rtl_uString * pTo, 177*b1cdbd2cSJim Jagielski rtl_uString * pAddPurpose ) 178*b1cdbd2cSJim Jagielski SAL_THROW_EXTERN_C(); 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski /* symbol exported by each language binding library */ 181*b1cdbd2cSJim Jagielski #define UNO_EXT_GETMAPPING "uno_ext_getMapping" 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski /** Function pointer declaration to get a mapping from a loaded bridge. Bridges export a function 184*b1cdbd2cSJim Jagielski called uno_ext_getMapping() of this signature. 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski @param ppMapping [inout] mapping; existing mapping will be released 187*b1cdbd2cSJim Jagielski @pFrom source environment 188*b1cdbd2cSJim Jagielski @pTo destination environment 189*b1cdbd2cSJim Jagielski */ 190*b1cdbd2cSJim Jagielski typedef void (SAL_CALL * uno_ext_getMappingFunc)( 191*b1cdbd2cSJim Jagielski struct _uno_Mapping ** ppMapping, 192*b1cdbd2cSJim Jagielski struct _uno_Environment * pFrom, 193*b1cdbd2cSJim Jagielski struct _uno_Environment * pTo ); 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski #ifdef __cplusplus 196*b1cdbd2cSJim Jagielski } 197*b1cdbd2cSJim Jagielski #endif 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski #endif 200