include/uno/mapping.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23 #ifndef INCLUDED_UNO_MAPPING_H
  24 #define INCLUDED_UNO_MAPPING_H
  25
  26 #include "cppu/cppudllapi.h"
  27 #include "rtl/ustring.h"
  28
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #endif
  34
  35 struct _typelib_InterfaceTypeDescription;
  36 struct _uno_Mapping;
  37 struct _uno_Environment;
  38
  39 /**
  40    Function pointer declaration to acquire a UNO mapping.
  41 */
  42 typedef void (SAL_CALL * uno_AcquireMappingFunc)(struct _uno_Mapping *);
  43
  44 /**
  45    Function pointer declaration to release a UNO mapping.
  46 */
  47 typedef void (SAL_CALL * uno_ReleaseMappingFunc)(struct _uno_Mapping *);
  48
  49 /** Function pointer declaration to map an interface from one environment to another.
  50
  51     @param pMapping         mapping
  52     @param ppOut            [inout] destination interface; existing interfaces are released
  53     @param pInterface       source interface
  54     @param pInterfaceTypeDescr type description of the interface
  55 */
  56 typedef void (SAL_CALL * uno_MapInterfaceFunc)(
  57     struct _uno_Mapping * pMapping,
  58     void ** ppOut, void * pInterface,
  59     struct _typelib_InterfaceTypeDescription * pInterfaceTypeDescr );
  60
  61
  62 #if defined( _WIN32)
  63 #pragma pack(push, 8)
  64 #endif
  65
  66 /** This is the binary specification of a mapping.
  67 */
  68 typedef struct SAL_DLLPUBLIC_RTTI _uno_Mapping
  69 {
  70     /** Acquires mapping
  71     */
  72     uno_AcquireMappingFunc acquire;
  73
  74     /** Releases mapping. The last release may unload bridges.
  75     */
  76     uno_ReleaseMappingFunc release;
  77
  78     /** mapping function
  79     */
  80     uno_MapInterfaceFunc mapInterface;
  81 } uno_Mapping;
  82
  83 #if defined( _WIN32)
  84 #pragma pack(pop)
  85 #endif
  86
  87 /** Gets an interface mapping from one environment to another.
  88
  89     @param ppMapping    [inout] mapping; existing mapping will be released
  90     @param pFrom        source environment
  91     @param pTo          destination environment
  92                         (interfaces resulting in mapInterface() call can be used
  93                         in this language environment)
  94     @param pAddPurpose  additional purpose of mapping (e.g., protocolling); defaults to 0 (none)
  95 */
  96 CPPU_DLLPUBLIC void SAL_CALL uno_getMapping(
  97     struct _uno_Mapping ** ppMapping,
  98     struct _uno_Environment * pFrom,
  99     struct _uno_Environment * pTo,
 100     rtl_uString * pAddPurpose )
 101     SAL_THROW_EXTERN_C();
 102
 103 /** Callback function pointer declaration to get a mapping.
 104
 105     @param ppMapping    inout mapping
 106     @param pFrom        source environment
 107     @param pTo          destination environment
 108     @param pAddPurpose  additional purpose
 109 */
 110 typedef void (SAL_CALL * uno_getMappingFunc)(
 111     struct _uno_Mapping ** ppMapping,
 112     struct _uno_Environment * pFrom,
 113     struct _uno_Environment * pTo,
 114     rtl_uString * pAddPurpose );
 115
 116 /** Registers a callback being called each time a mapping is demanded.
 117
 118     @param pCallback    callback function
 119 */
 120 CPPU_DLLPUBLIC void SAL_CALL uno_registerMappingCallback(
 121     uno_getMappingFunc pCallback )
 122     SAL_THROW_EXTERN_C();
 123
 124 /** Revokes a mapping callback registration.
 125
 126     @param pCallback    callback function
 127 */
 128 CPPU_DLLPUBLIC void SAL_CALL uno_revokeMappingCallback(
 129     uno_getMappingFunc pCallback )
 130     SAL_THROW_EXTERN_C();
 131
 132 /** Function pointer declaration to free a mapping.
 133
 134     @param pMapping     mapping to be freed
 135 */
 136 typedef void (SAL_CALL * uno_freeMappingFunc)( struct _uno_Mapping * pMapping );
 137
 138 /** Registers a mapping. A mapping registers itself on first acquire and revokes itself on last
 139     release. The given freeMapping function is called by the runtime to cleanup any resources.
 140
 141     @param ppMapping    inout mapping to be registered
 142     @param freeMapping  called by runtime to delete mapping
 143     @param pFrom        source environment
 144     @param pTo          destination environment
 145     @param pAddPurpose  additional purpose string; defaults to 0
 146 */
 147 CPPU_DLLPUBLIC void SAL_CALL uno_registerMapping(
 148     struct _uno_Mapping ** ppMapping, uno_freeMappingFunc freeMapping,
 149     struct _uno_Environment * pFrom, struct _uno_Environment * pTo, rtl_uString * pAddPurpose )
 150     SAL_THROW_EXTERN_C();
 151
 152 /** Revokes a mapping. A mapping registers itself on first acquire and revokes itself on last
 153     release.
 154
 155     @param pMapping     mapping to be revoked
 156 */
 157 CPPU_DLLPUBLIC void SAL_CALL uno_revokeMapping(
 158     struct _uno_Mapping * pMapping )
 159     SAL_THROW_EXTERN_C();
 160
 161 /** Gets an interface mapping from one language environment to another by corresponding environment
 162     type names.
 163
 164     @param ppMapping    [inout] mapping; existing mapping will be released
 165     @param pFrom        source environment type name
 166     @param pTo          destination environment type name
 167                         (interfaces resulting in mapInterface() call can be used
 168                         in this language environment)
 169     @param pAddPurpose  additional purpose of mapping (e.g., protocolling); defaults to 0 (none)
 170 */
 171 CPPU_DLLPUBLIC void SAL_CALL uno_getMappingByName(
 172     struct _uno_Mapping ** ppMapping,
 173     rtl_uString * pFrom,
 174     rtl_uString * pTo,
 175     rtl_uString * pAddPurpose )
 176     SAL_THROW_EXTERN_C();
 177
 178 /* symbol exported by each language binding library */
 179 #define UNO_EXT_GETMAPPING "uno_ext_getMapping"
 180
 181 /** Function pointer declaration to get a mapping from a loaded bridge. Bridges export a function
 182     called uno_ext_getMapping() of this signature.
 183
 184     @param[in,out] ppMapping  mapping; existing mapping will be released
 185     @param[in] pFrom              source environment
 186     @param[in] pTo                destination environment
 187 */
 188 typedef void (SAL_CALL * uno_ext_getMappingFunc)(
 189     struct _uno_Mapping ** ppMapping,
 190     struct _uno_Environment * pFrom,
 191     struct _uno_Environment * pTo );
 192
 193 #ifdef DISABLE_DYNLOADING
 194 /* Static linking, this is the uno_ext_getMapping function in the C++/UNO bridge */
 195 void SAL_CALL CPPU_ENV_uno_ext_getMapping(
 196     struct _uno_Mapping ** ppMapping,
 197     struct _uno_Environment * pFrom,
 198     struct _uno_Environment * pTo )
 199     SAL_THROW_EXTERN_C();
 200
 201 /* This is the uno_ext_getMapping function in the Java/UNO bridge */
 202 void SAL_CALL java_uno_ext_getMapping(
 203     struct _uno_Mapping ** ppMapping,
 204     struct _uno_Environment * pFrom,
 205     struct _uno_Environment * pTo )
 206     SAL_THROW_EXTERN_C();
 207
 208 #endif
 209
 210 #ifdef __cplusplus
 211 }
 212 #endif
 213
 214 #endif
 215
 216 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */