/usr/include/libreoffice/registry/reflwrit.hxx is in libreoffice-dev 1:3.5.7-0ubuntu13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _REGISTRY_REFLWRIT_HXX_
#define _REGISTRY_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 *setUik) (TypeWriterImpl, const RTUik*);
void (TYPEREG_CALLTYPE *setDoku) (TypeWriterImpl, rtl_uString*);
void (TYPEREG_CALLTYPE *setFileName) (TypeWriterImpl, rtl_uString*);
void (TYPEREG_CALLTYPE *setFieldData) (TypeWriterImpl, sal_uInt16, rtl_uString*, rtl_uString*, rtl_uString*, rtl_uString*, RTFieldAccess, RTValueType, RTConstValueUnion);
void (TYPEREG_CALLTYPE *setMethodData) (TypeWriterImpl, sal_uInt16, rtl_uString*, rtl_uString*, RTMethodMode, sal_uInt16, sal_uInt16, rtl_uString*);
void (TYPEREG_CALLTYPE *setParamData) (TypeWriterImpl, sal_uInt16, sal_uInt16, rtl_uString*, rtl_uString*, RTParamMode);
void (TYPEREG_CALLTYPE *setExcData) (TypeWriterImpl, sal_uInt16, sal_uInt16, rtl_uString*);
const sal_uInt8* (TYPEREG_CALLTYPE *getBlop) (TypeWriterImpl);
sal_uInt32 (TYPEREG_CALLTYPE *getBlopSize) (TypeWriterImpl);
void (TYPEREG_CALLTYPE *setReferenceData) (TypeWriterImpl, sal_uInt16, rtl_uString*, RTReferenceType, rtl_uString*, RTFieldAccess);
};
/** the API initialization function.
*/
RegistryTypeWriter_Api* TYPEREG_CALLTYPE initRegistryTypeWriter_Api(void);
#ifdef __cplusplus
}
#endif
/** RegistryTypeWriter writes/creates a binary type blob.
This class provides the necessary functions to write type informations
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);
/** @deprecated
sets the unique identifier for an interface type.
An earlier version of UNO used an unique identifier for interfaces. In the
current version of UNO this uik was eliminated and this function is
not longer used.
*/
inline void setUik(const RTUik& uik);
/** sets a documentation string for the type.
This documentation should be the same as the documentation which is provided
for this type in IDL.
*/
inline void setDoku(const ::rtl::OUString& doku);
/** sets the IDL filename where this type is defined.
*/
inline void setFileName(const ::rtl::OUString& fileName);
/** 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,
RTConstValue constValue = RTConstValue());
/** sets the data for a method.
@param index indicates the index of the method.
@param name specifies the name.
@param typeName specifies the full qualified return typename.
@param mode specifies the method mode.
@param paramCount specifies the number of parameters.
@param excCount specifies the number of exceptions.
@param doku specifies the documentation string of the field.
*/
inline void setMethodData(sal_uInt16 index,
const ::rtl::OUString& name,
const ::rtl::OUString& returnTypeName,
RTMethodMode mode,
sal_uInt16 paramCount,
sal_uInt16 excCount,
const ::rtl::OUString& doku);
/** sets the data for the specified parameter of a method.
@param index indicates the index of the method.
@param paramIndex specifies the index of the parameter.
@param type specifies the full qualified typename.
@param name specifies the name.
@param mode specifies the parameter mode.
*/
inline void setParamData(sal_uInt16 index,
sal_uInt16 paramIndex,
const ::rtl::OUString& type,
const ::rtl::OUString& name,
RTParamMode mode);
/** sets the data for the specified exception of a mehtod.
@param index indicates the index of the method.
@param excIndex specifies the index of the exception.
@param type specifies the full qualified typename of the exception.
*/
inline void setExcData(sal_uInt16 index,
sal_uInt16 excIndex,
const ::rtl::OUString& type);
/** 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();
/** sets the data for a reference member.
@param index indicates the index of the reference.
@param name specifies the name.
@param refType specifies the full qualified typename of the reference.
@param doku specifies the documentation string of the reference.
@param access specifies the access mode of the reference.
*/
inline void setReferenceData( sal_uInt16 index,
const ::rtl::OUString& name,
RTReferenceType refType,
const ::rtl::OUString& doku,
RTFieldAccess access = RT_ACCESS_INVALID);
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,
RTConstValue constValue)
{
m_pApi->setFieldData(m_hImpl, index, name.pData, typeName.pData, doku.pData, fileName.pData, access, constValue.m_type, constValue.m_value);
}
inline void RegistryTypeWriter::setMethodData(sal_uInt16 index,
const ::rtl::OUString& name,
const ::rtl::OUString& returnTypeName,
RTMethodMode mode,
sal_uInt16 paramCount,
sal_uInt16 excCount,
const ::rtl::OUString& doku)
{
m_pApi->setMethodData(m_hImpl, index, name.pData, returnTypeName.pData, mode, paramCount, excCount, doku.pData);
}
inline void RegistryTypeWriter::setUik(const RTUik& uik)
{
m_pApi->setUik(m_hImpl, &uik);
}
inline void RegistryTypeWriter::setDoku(const ::rtl::OUString& doku)
{
m_pApi->setDoku(m_hImpl, doku.pData);
}
inline void RegistryTypeWriter::setFileName(const ::rtl::OUString& doku)
{
m_pApi->setFileName(m_hImpl, doku.pData);
}
inline void RegistryTypeWriter::setParamData(sal_uInt16 index,
sal_uInt16 paramIndex,
const ::rtl::OUString& type,
const ::rtl::OUString& name,
RTParamMode mode)
{
m_pApi->setParamData(m_hImpl, index, paramIndex, type.pData, name.pData, mode);
}
inline void RegistryTypeWriter::setExcData(sal_uInt16 index,
sal_uInt16 excIndex,
const ::rtl::OUString& type)
{
m_pApi->setExcData(m_hImpl, index, excIndex, type.pData);
}
inline const sal_uInt8* RegistryTypeWriter::getBlop()
{
return m_pApi->getBlop(m_hImpl);
}
inline sal_uInt32 RegistryTypeWriter::getBlopSize()
{
return m_pApi->getBlopSize(m_hImpl);
}
inline void RegistryTypeWriter::setReferenceData( sal_uInt16 index,
const ::rtl::OUString& name,
RTReferenceType refType,
const ::rtl::OUString& doku,
RTFieldAccess access)
{
m_pApi->setReferenceData(m_hImpl, index, name.pData, refType, doku.pData, access);
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|