LibreOffice: uno/mapping.h Source File

LibreOffice LibreOffice 7.1 SDK C/C++ API Reference

mapping.h
Go to the documentation of this file.
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#ifndef INCLUDED_UNO_MAPPING_H
20#define INCLUDED_UNO_MAPPING_H
21
22#include "cppu/cppudllapi.h"
23#include "rtl/ustring.h"
24
25
26#ifdef __cplusplus
27extern "C"
28{
29#endif
30
31struct _typelib_InterfaceTypeDescription;
32struct _uno_Mapping;
33struct _uno_Environment;
34
38 typedef void (SAL_CALL * uno_AcquireMappingFunc)(struct _uno_Mapping *);
39
43 typedef void (SAL_CALL * uno_ReleaseMappingFunc)(struct _uno_Mapping *);
44
52 typedef void (SAL_CALL * uno_MapInterfaceFunc)(
53 struct _uno_Mapping * pMapping,
54 void ** ppOut, void * pInterface,
55 struct _typelib_InterfaceTypeDescription * pInterfaceTypeDescr );
56
57
58#if defined( _WIN32)
59#pragma pack(push, 8)
60#endif
61
64 typedef struct SAL_DLLPUBLIC_RTTI _uno_Mapping
65{
68 uno_AcquireMappingFunc acquire;
69
72 uno_ReleaseMappingFunc release;
73
76 uno_MapInterfaceFunc mapInterface;
77} uno_Mapping;
78
79#if defined( _WIN32)
80#pragma pack(pop)
81#endif
82
92 CPPU_DLLPUBLIC void SAL_CALL uno_getMapping(
93 struct _uno_Mapping ** ppMapping,
94 struct _uno_Environment * pFrom,
95 struct _uno_Environment * pTo,
96 rtl_uString * pAddPurpose )
97 SAL_THROW_EXTERN_C();
98
106 typedef void (SAL_CALL * uno_getMappingFunc)(
107 struct _uno_Mapping ** ppMapping,
108 struct _uno_Environment * pFrom,
109 struct _uno_Environment * pTo,
110 rtl_uString * pAddPurpose );
111
116 CPPU_DLLPUBLIC void SAL_CALL uno_registerMappingCallback(
117 uno_getMappingFunc pCallback )
118 SAL_THROW_EXTERN_C();
119
124 CPPU_DLLPUBLIC void SAL_CALL uno_revokeMappingCallback(
125 uno_getMappingFunc pCallback )
126 SAL_THROW_EXTERN_C();
127
132 typedef void (SAL_CALL * uno_freeMappingFunc)( struct _uno_Mapping * pMapping );
133
143 CPPU_DLLPUBLIC void SAL_CALL uno_registerMapping(
144 struct _uno_Mapping ** ppMapping, uno_freeMappingFunc freeMapping,
145 struct _uno_Environment * pFrom, struct _uno_Environment * pTo, rtl_uString * pAddPurpose )
146 SAL_THROW_EXTERN_C();
147
153 CPPU_DLLPUBLIC void SAL_CALL uno_revokeMapping(
154 struct _uno_Mapping * pMapping )
155 SAL_THROW_EXTERN_C();
156
167 CPPU_DLLPUBLIC void SAL_CALL uno_getMappingByName(
168 struct _uno_Mapping ** ppMapping,
169 rtl_uString * pFrom,
170 rtl_uString * pTo,
171 rtl_uString * pAddPurpose )
172 SAL_THROW_EXTERN_C();
173
174/* symbol exported by each language binding library */
175#define UNO_EXT_GETMAPPING "uno_ext_getMapping"
176
184 typedef void (SAL_CALL * uno_ext_getMappingFunc)(
185 struct _uno_Mapping ** ppMapping,
186 struct _uno_Environment * pFrom,
187 struct _uno_Environment * pTo );
188
189#ifdef DISABLE_DYNLOADING
190/* Static linking, this is the uno_ext_getMapping function in the C++/UNO bridge */
191void SAL_CALL CPPU_ENV_uno_ext_getMapping(
192 struct _uno_Mapping ** ppMapping,
193 struct _uno_Environment * pFrom,
194 struct _uno_Environment * pTo )
195 SAL_THROW_EXTERN_C();
196
197/* This is the uno_ext_getMapping function in the Java/UNO bridge */
198void SAL_CALL java_uno_ext_getMapping(
199 struct _uno_Mapping ** ppMapping,
200 struct _uno_Environment * pFrom,
201 struct _uno_Environment * pTo )
202 SAL_THROW_EXTERN_C();
203
204#endif
205
206#ifdef __cplusplus
207}
208#endif
209
210#endif
211
212/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_THROW_EXTERN_C
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:324
ustring.h
uno_getMapping
CPPU_DLLPUBLIC void uno_getMapping(struct _uno_Mapping **ppMapping, struct _uno_Environment *pFrom, struct _uno_Environment *pTo, rtl_uString *pAddPurpose) SAL_THROW_EXTERN_C()
Gets an interface mapping from one environment to another.
uno_getMappingByName
CPPU_DLLPUBLIC void uno_getMappingByName(struct _uno_Mapping **ppMapping, rtl_uString *pFrom, rtl_uString *pTo, rtl_uString *pAddPurpose) SAL_THROW_EXTERN_C()
Gets an interface mapping from one language environment to another by corresponding environment type ...
uno_ReleaseMappingFunc
void(* uno_ReleaseMappingFunc)(struct _uno_Mapping *)
Function pointer declaration to release a UNO mapping.
Definition: mapping.h:43
uno_revokeMappingCallback
CPPU_DLLPUBLIC void uno_revokeMappingCallback(uno_getMappingFunc pCallback) SAL_THROW_EXTERN_C()
Revokes a mapping callback registration.
uno_revokeMapping
CPPU_DLLPUBLIC void uno_revokeMapping(struct _uno_Mapping *pMapping) SAL_THROW_EXTERN_C()
Revokes a mapping.
uno_MapInterfaceFunc
void(* uno_MapInterfaceFunc)(struct _uno_Mapping *pMapping, void **ppOut, void *pInterface, struct _typelib_InterfaceTypeDescription *pInterfaceTypeDescr)
Function pointer declaration to map an interface from one environment to another.
Definition: mapping.h:52
uno_Mapping
struct SAL_DLLPUBLIC_RTTI _uno_Mapping uno_Mapping
This is the binary specification of a mapping.
uno_AcquireMappingFunc
void(* uno_AcquireMappingFunc)(struct _uno_Mapping *)
Function pointer declaration to acquire a UNO mapping.
Definition: mapping.h:38
uno_ext_getMappingFunc
void(* uno_ext_getMappingFunc)(struct _uno_Mapping **ppMapping, struct _uno_Environment *pFrom, struct _uno_Environment *pTo)
Function pointer declaration to get a mapping from a loaded bridge.
Definition: mapping.h:184
uno_registerMapping
CPPU_DLLPUBLIC void uno_registerMapping(struct _uno_Mapping **ppMapping, uno_freeMappingFunc freeMapping, struct _uno_Environment *pFrom, struct _uno_Environment *pTo, rtl_uString *pAddPurpose) SAL_THROW_EXTERN_C()
Registers a mapping.
uno_freeMappingFunc
void(* uno_freeMappingFunc)(struct _uno_Mapping *pMapping)
Function pointer declaration to free a mapping.
Definition: mapping.h:132
uno_registerMappingCallback
CPPU_DLLPUBLIC void uno_registerMappingCallback(uno_getMappingFunc pCallback) SAL_THROW_EXTERN_C()
Registers a callback being called each time a mapping is demanded.
uno_getMappingFunc
void(* uno_getMappingFunc)(struct _uno_Mapping **ppMapping, struct _uno_Environment *pFrom, struct _uno_Environment *pTo, rtl_uString *pAddPurpose)
Callback function pointer declaration to get a mapping.
Definition: mapping.h:106
cppudllapi.h
CPPU_DLLPUBLIC
#define CPPU_DLLPUBLIC
Definition: cppudllapi.h:10
_typelib_InterfaceTypeDescription
Type description of an interface.
Definition: typedescription.h:371
_uno_Environment
The binary specification of a UNO environment.
Definition: environment.h:42
_uno_Mapping
This is the binary specification of a mapping.
Definition: mapping.h:65
_uno_Mapping::release
uno_ReleaseMappingFunc release
Releases mapping.
Definition: mapping.h:72
_uno_Mapping::mapInterface
uno_MapInterfaceFunc mapInterface
mapping function
Definition: mapping.h:76
_uno_Mapping::acquire
uno_AcquireMappingFunc acquire
Acquires mapping.
Definition: mapping.h:68