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
|
/* -*- 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_REFLWRIT_HXX
#define INCLUDED_REGISTRY_SOURCE_REFLWRIT_HXX
#include <registry/refltype.hxx>
#include <registry/regtype.h>
#include <rtl/ustring.hxx>
/// Implememetation handle
typedef void* TypeWriterImpl;
/****************************************************************************
C-Api
*****************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif
/** specifies a collection of function pointers which represents the complete registry type writer C-API.
This funtions pointers are used by the C++ wrapper to call the C-API.
*/
struct RegistryTypeWriter_Api
{
TypeWriterImpl (TYPEREG_CALLTYPE *createEntry) (RTTypeClass, rtl_uString*, rtl_uString*, sal_uInt16, sal_uInt16, sal_uInt16);
void (TYPEREG_CALLTYPE *acquire) (TypeWriterImpl);
void (TYPEREG_CALLTYPE *release) (TypeWriterImpl);
void (TYPEREG_CALLTYPE *setFieldData) (TypeWriterImpl, sal_uInt16, rtl_uString*, rtl_uString*, rtl_uString*, rtl_uString*, RTFieldAccess, RTValueType, RTConstValueUnion);
const sal_uInt8* (TYPEREG_CALLTYPE *getBlop) (TypeWriterImpl);
sal_uInt32 (TYPEREG_CALLTYPE *getBlopSize) (TypeWriterImpl);
};
/** the API initialization function.
*/
RegistryTypeWriter_Api* TYPEREG_CALLTYPE initRegistryTypeWriter_Api();
#ifdef __cplusplus
}
#endif
/** RegistryTypeWriter writes/creates a binary type blob.
This class provides the necessary functions to write type information
for all kinds of types into a blob.
The class is inline and use a C-Api.
@deprecated
use typereg::Writer instead
*/
class RegistryTypeWriter
{
public:
/** Constructor.
@param RTTypeClass specifies the type of the new blob.
@param typeName specifies the full qualified type name with '/' as separator.
@param superTypeName specifies the full qualified type name of the base type
with '/' as separator.
@param fieldCount specifies the number of fields (eg. number of attrbutes/properties,
enum values or constants).
@param methodCount specifies the number of methods.
@param referenceCount specifies the number of references (eg. number of supported interfaces,
exported services ...)
*/
inline RegistryTypeWriter(RTTypeClass RTTypeClass,
const rtl::OUString& typeName,
const rtl::OUString& superTypeName,
sal_uInt16 fieldCount,
sal_uInt16 methodCount,
sal_uInt16 referenceCount);
/// Copy constructcor
inline RegistryTypeWriter(const RegistryTypeWriter& toCopy);
/** Destructor. The Destructor frees the internal data block.
The pointer (returned by getBlop) will be set to NULL.
*/
inline ~RegistryTypeWriter();
/// Assign operator
inline RegistryTypeWriter& operator == (const RegistryTypeWriter& toAssign);
/** sets the data for a field member of a type blob.
@param index indicates the index of the field.
@param name specifies the name.
@param typeName specifies the full qualified typename.
@param doku specifies the documentation string of the field.
@param fileName specifies the name of the IDL file where the field is defined.
@param access specifies the access mode of the field.
@param constValue specifies the value of the field. The value is only interesting
for enum values or constants.
*/
inline void setFieldData( sal_uInt16 index,
const rtl::OUString& name,
const rtl::OUString& typeName,
const rtl::OUString& doku,
const rtl::OUString& fileName,
RTFieldAccess access,
const RTConstValue& constValue = RTConstValue());
/** returns a pointer to the new type blob.
The pointer will be invalid (NULL) if the instance of
the RegistryTypeWriter will be destroyed.
*/
inline const sal_uInt8* getBlop();
/** returns the size of the new type blob in bytes.
*/
inline sal_uInt32 getBlopSize();
protected:
/// stores the registry type writer Api.
const RegistryTypeWriter_Api* m_pApi;
/// stores the handle of an implementation class
TypeWriterImpl m_hImpl;
};
inline RegistryTypeWriter::RegistryTypeWriter(RTTypeClass RTTypeClass,
const rtl::OUString& typeName,
const rtl::OUString& superTypeName,
sal_uInt16 fieldCount,
sal_uInt16 methodCount,
sal_uInt16 referenceCount)
: m_pApi(initRegistryTypeWriter_Api())
, m_hImpl(NULL)
{
m_hImpl = m_pApi->createEntry(RTTypeClass,
typeName.pData,
superTypeName.pData,
fieldCount,
methodCount,
referenceCount);
}
inline RegistryTypeWriter::RegistryTypeWriter(const RegistryTypeWriter& toCopy)
: m_pApi(toCopy.m_pApi)
, m_hImpl(toCopy.m_hImpl)
{
m_pApi->acquire(m_hImpl);
}
inline RegistryTypeWriter::~RegistryTypeWriter()
{
m_pApi->release(m_hImpl);
}
inline RegistryTypeWriter& RegistryTypeWriter::operator == (const RegistryTypeWriter& 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 void RegistryTypeWriter::setFieldData( sal_uInt16 index,
const rtl::OUString& name,
const rtl::OUString& typeName,
const rtl::OUString& doku,
const rtl::OUString& fileName,
RTFieldAccess access,
const RTConstValue& constValue)
{
m_pApi->setFieldData(m_hImpl, index, name.pData, typeName.pData, doku.pData, fileName.pData, access, constValue.m_type, constValue.m_value);
}
inline const sal_uInt8* RegistryTypeWriter::getBlop()
{
return m_pApi->getBlop(m_hImpl);
}
inline sal_uInt32 RegistryTypeWriter::getBlopSize()
{
return m_pApi->getBlopSize(m_hImpl);
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
