1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_REGISTRY_SOURCE_REFLREAD_HXX
#define INCLUDED_REGISTRY_SOURCE_REFLREAD_HXX
#include <registry/refltype.hxx>
#include <registry/regtype.h>
#include <rtl/ustring.hxx>
/// Implememetation handle
typedef void* TypeReaderImpl;
/****************************************************************************
C-Api
*****************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif
/** specifies a collection of function pointers which represents the complete registry type reader C-API.
This funtions pointers are used by the C++ wrapper to call the C-API.
*/
struct RegistryTypeReader_Api
{
TypeReaderImpl (TYPEREG_CALLTYPE *createEntry) (const sal_uInt8*, sal_uInt32, bool);
void (TYPEREG_CALLTYPE *acquire) (TypeReaderImpl);
void (TYPEREG_CALLTYPE *release) (TypeReaderImpl);
sal_uInt16 (TYPEREG_CALLTYPE *getMinorVersion) (TypeReaderImpl);
sal_uInt16 (TYPEREG_CALLTYPE *getMajorVersion) (TypeReaderImpl);
RTTypeClass (TYPEREG_CALLTYPE *getTypeClass) (TypeReaderImpl);
void (TYPEREG_CALLTYPE *getUik) (TypeReaderImpl, RTUik*);
void (TYPEREG_CALLTYPE *getDoku) (TypeReaderImpl, rtl_uString**);
void (TYPEREG_CALLTYPE *getFileName) (TypeReaderImpl, rtl_uString**);
void (TYPEREG_CALLTYPE *getTypeName) (TypeReaderImpl, rtl_uString**);
void (TYPEREG_CALLTYPE *getSuperTypeName) (TypeReaderImpl, rtl_uString**);
sal_uInt32 (TYPEREG_CALLTYPE *getFieldCount) (TypeReaderImpl);
void (TYPEREG_CALLTYPE *getFieldName) (TypeReaderImpl, rtl_uString**, sal_uInt16);
void (TYPEREG_CALLTYPE *getFieldType) (TypeReaderImpl, rtl_uString**, sal_uInt16);
RTFieldAccess (TYPEREG_CALLTYPE *getFieldAccess) (TypeReaderImpl, sal_uInt16);
RTValueType (TYPEREG_CALLTYPE *getFieldConstValue) (TypeReaderImpl, sal_uInt16, RTConstValueUnion*);
void (TYPEREG_CALLTYPE *getFieldDoku) (TypeReaderImpl, rtl_uString**, sal_uInt16);
void (TYPEREG_CALLTYPE *getFieldFileName) (TypeReaderImpl, rtl_uString**, sal_uInt16);
sal_uInt32 (TYPEREG_CALLTYPE *getMethodCount) (TypeReaderImpl);
void (TYPEREG_CALLTYPE *getMethodName) (TypeReaderImpl, rtl_uString**, sal_uInt16);
sal_uInt32 (TYPEREG_CALLTYPE *getMethodParamCount) (TypeReaderImpl, sal_uInt16);
void (TYPEREG_CALLTYPE *getMethodParamType) (TypeReaderImpl, rtl_uString**, sal_uInt16, sal_uInt16);
void (TYPEREG_CALLTYPE *getMethodParamName) (TypeReaderImpl, rtl_uString**, sal_uInt16, sal_uInt16);
RTParamMode (TYPEREG_CALLTYPE *getMethodParamMode) (TypeReaderImpl, sal_uInt16, sal_uInt16);
sal_uInt32 (TYPEREG_CALLTYPE *getMethodExcCount) (TypeReaderImpl, sal_uInt16);
void (TYPEREG_CALLTYPE *getMethodExcType) (TypeReaderImpl, rtl_uString**, sal_uInt16, sal_uInt16);
void (TYPEREG_CALLTYPE *getMethodReturnType) (TypeReaderImpl, rtl_uString**, sal_uInt16);
RTMethodMode (TYPEREG_CALLTYPE *getMethodMode) (TypeReaderImpl, sal_uInt16);
void (TYPEREG_CALLTYPE *getMethodDoku) (TypeReaderImpl, rtl_uString**, sal_uInt16);
sal_uInt32 (TYPEREG_CALLTYPE *getReferenceCount) (TypeReaderImpl);
void (TYPEREG_CALLTYPE *getReferenceName) (TypeReaderImpl, rtl_uString**, sal_uInt16);
RTReferenceType (TYPEREG_CALLTYPE *getReferenceType) (TypeReaderImpl, sal_uInt16);
void (TYPEREG_CALLTYPE *getReferenceDoku) (TypeReaderImpl, rtl_uString**, sal_uInt16);
RTFieldAccess (TYPEREG_CALLTYPE *getReferenceAccess) (TypeReaderImpl, sal_uInt16);
};
/** the API initialization function.
*/
RegistryTypeReader_Api* TYPEREG_CALLTYPE initRegistryTypeReader_Api();
#ifdef __cplusplus
}
#endif
/** RegistryTypeReades reads a binary type blob.
This class provides the necessary functions to read type information
for all kinds of types of a type blob.
The class is inline and use a C-Api.
@deprecated
use typereg::Reader instead
*/
class RegistryTypeReader
{
public:
/** Constructor.
@param buffer points to the binary data block.
@param bufferLen specifies the size of the binary data block.
@param copyData specifies if the data block should be copied.
The block can be copied to ensure that the data
is valid for the lifetime of this instance.
*/
inline RegistryTypeReader(const sal_uInt8* buffer,
sal_uInt32 bufferLen,
bool copyData);
/// Copy constructcor
inline RegistryTypeReader(const RegistryTypeReader& toCopy);
/// Destructor. The Destructor frees the data block if the copyData flag was TRUE.
inline ~RegistryTypeReader();
/// Assign operator
inline RegistryTypeReader& operator == (const RegistryTypeReader& toAssign);
/** returns the typeclass of the type represented by this blob.
This function will always return the type class without the internal
RT_TYPE_PUBLISHED flag set.
*/
inline RTTypeClass getTypeClass() const;
/** returns the full qualified name of the type.
*/
inline rtl::OUString getTypeName() const;
/** returns the full qualified name of the supertype.
*/
inline rtl::OUString getSuperTypeName() const;
/** returns the number of fields (attributes/properties, enum values or number
of constants in a module).
*/
inline sal_uInt32 getFieldCount() const;
/** returns the name of the field specified by index.
*/
inline rtl::OUString getFieldName( sal_uInt16 index ) const;
/** returns the full qualified name of the field specified by index.
*/
inline rtl::OUString getFieldType( sal_uInt16 index ) const;
/** returns the access mode of the field specified by index.
*/
inline RTFieldAccess getFieldAccess( sal_uInt16 index ) const;
/** returns the value of the field specified by index.
This function returns the value of an enum value or of a constant.
*/
inline RTConstValue getFieldConstValue( sal_uInt16 index ) const;
/** returns the documentation string for the field specified by index.
Each field of a type can have their own documentation.
*/
inline rtl::OUString getFieldDoku( sal_uInt16 index ) const;
/** returns the IDL filename of the field specified by index.
The IDL filename of a field can differ from the filename of the ype itself
because modules and also constants can be defined in different IDL files.
*/
inline rtl::OUString getFieldFileName( sal_uInt16 index ) const;
protected:
/// stores the registry type reader Api.
const RegistryTypeReader_Api* m_pApi;
/// stores the handle of an implementation class
TypeReaderImpl m_hImpl;
};
inline RegistryTypeReader::RegistryTypeReader(const sal_uInt8* buffer,
sal_uInt32 bufferLen,
bool copyData)
: m_pApi(initRegistryTypeReader_Api())
, m_hImpl(NULL)
{
m_hImpl = m_pApi->createEntry(buffer, bufferLen, copyData);
}
inline RegistryTypeReader::RegistryTypeReader(const RegistryTypeReader& toCopy)
: m_pApi(toCopy.m_pApi)
, m_hImpl(toCopy.m_hImpl)
{ m_pApi->acquire(m_hImpl); }
inline RegistryTypeReader::~RegistryTypeReader()
{ m_pApi->release(m_hImpl); }
inline RegistryTypeReader& RegistryTypeReader::operator == (const RegistryTypeReader& toAssign)
{
if (m_hImpl != toAssign.m_hImpl)
{
m_pApi->release(m_hImpl);
m_hImpl = toAssign.m_hImpl;
m_pApi->acquire(m_hImpl);
}
return *this;
}
inline RTTypeClass RegistryTypeReader::getTypeClass() const
{ return m_pApi->getTypeClass(m_hImpl); }
inline rtl::OUString RegistryTypeReader::getTypeName() const
{
rtl::OUString sRet;
m_pApi->getTypeName(m_hImpl, &sRet.pData);
return sRet;
}
inline rtl::OUString RegistryTypeReader::getSuperTypeName() const
{
rtl::OUString sRet;
m_pApi->getSuperTypeName(m_hImpl, &sRet.pData);
return sRet;
}
inline sal_uInt32 RegistryTypeReader::getFieldCount() const
{ return m_pApi->getFieldCount(m_hImpl); }
inline rtl::OUString RegistryTypeReader::getFieldName( sal_uInt16 index ) const
{
rtl::OUString sRet;
m_pApi->getFieldName(m_hImpl, &sRet.pData, index);
return sRet;
}
inline rtl::OUString RegistryTypeReader::getFieldType( sal_uInt16 index ) const
{
rtl::OUString sRet;
m_pApi->getFieldType(m_hImpl, &sRet.pData, index);
return sRet;
}
inline RTFieldAccess RegistryTypeReader::getFieldAccess( sal_uInt16 index ) const
{ return m_pApi->getFieldAccess(m_hImpl, index); }
inline RTConstValue RegistryTypeReader::getFieldConstValue( sal_uInt16 index ) const
{
RTConstValue ret;
ret.m_type = m_pApi->getFieldConstValue(m_hImpl, index, &ret.m_value);
return ret;
}
inline rtl::OUString RegistryTypeReader::getFieldDoku( sal_uInt16 index ) const
{
rtl::OUString sRet;
m_pApi->getFieldDoku(m_hImpl, &sRet.pData, index);
return sRet;
}
inline rtl::OUString RegistryTypeReader::getFieldFileName( sal_uInt16 index ) const
{
rtl::OUString sRet;
m_pApi->getFieldFileName(m_hImpl, &sRet.pData, index);
return sRet;
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
