include/registry/writer.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 #ifndef INCLUDED_REGISTRY_WRITER_H
  21 #define INCLUDED_REGISTRY_WRITER_H
  22
  23 #include <registry/regdllapi.h>
  24 #include <registry/types.hxx>
  25 #include <registry/version.h>
  26
  27 #include <rtl/ustring.h>
  28 #include <sal/types.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /**
  35    Creates a type writer working on a binary blob that represents a UNOIDL type.
  36
  37    <p>Operations on a returned handle are not multi-thread&ndash;safe.</p>
  38
  39    @param version the version of the created type writer; must not be negative
  40
  41    @param documentation the documentation; must not be null
  42
  43    @param fileName the file name; must not be null (deprecated, use an empty string)
  44
  45    @param typeClass the type class of the created type writer
  46
  47    @param published whether the created type writer is published; for a type
  48    class that cannot be published, this should be false
  49
  50    @param typeName the type name of the created type writer; must not be null
  51
  52    @param superTypeCount the number of super types of the created type writer
  53
  54    @param fieldCount the number of fields of the created type writer
  55
  56    @param methodCount the number of methods of the created type writer
  57
  58    @param referenceCount the number of references of the created type writer
  59
  60    @return a handle on the type writer; if an out-of-memory condition occurs,
  61    null is returned, and no type writer is created
  62
  63    @since UDK 3.2.0
  64  */
  65 REG_DLLPUBLIC void * typereg_writer_create(
  66     typereg_Version version, rtl_uString const * documentation,
  67     rtl_uString const * fileName, RTTypeClass typeClass, sal_Bool published,
  68     rtl_uString const * typeName, sal_uInt16 superTypeCount,
  69     sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount)
  70     SAL_THROW_EXTERN_C();
  71
  72 /**
  73    Destroys a type writer.
  74
  75    @param handle a handle on a type writer obtained from a call to
  76    <code>typereg_writer_create</code>; must not be null
  77
  78    @since UDK 3.2.0
  79  */
  80 REG_DLLPUBLIC void typereg_writer_destroy(void * handle) SAL_THROW_EXTERN_C();
  81
  82 /**
  83    Sets the type name of a super type of a type writer.
  84
  85    @param handle a handle on a type writer; must not be null
  86
  87    @param index a valid index into the range of super types of the given type
  88    writer
  89
  90    @param typeName the super type name; must not be null
  91
  92    @return false iff an out-of-memory condition occurred, in which case the type
  93    writer is not modified
  94
  95    @since UDK 3.2.0
  96  */
  97 REG_DLLPUBLIC sal_Bool typereg_writer_setSuperTypeName(
  98     void const * handle, sal_uInt16 index, rtl_uString const * typeName)
  99         SAL_THROW_EXTERN_C();
 100
 101 /**
 102    Sets the data of a field of a type writer.
 103
 104    @param handle a handle on a type writer; must not be null
 105
 106    @param index a valid index into the range of fields of the given type writer
 107
 108    @param documentation the documentation of the field; must not be null
 109
 110    @param fileName the file name of the field; must not be null (deprecated, use an empty string)
 111
 112    @param flags the flags of the field
 113
 114    @param name the name of the field; must not be null
 115
 116    @param typeName the type name of the field; must not be null
 117
 118    @param valueType the type of the value of the field
 119
 120    @param valueValue the value of the value of the field
 121
 122    @return false iff an out-of-memory condition occurred, in which case the type
 123    writer is not modified
 124
 125    @since UDK 3.2.0
 126  */
 127 REG_DLLPUBLIC sal_Bool typereg_writer_setFieldData(
 128     void * handle, sal_uInt16 index, rtl_uString const * documentation,
 129     rtl_uString const * fileName, RTFieldAccess flags, rtl_uString const * name,
 130     rtl_uString const * typeName, RTValueType valueType,
 131     RTConstValueUnion valueValue)
 132     SAL_THROW_EXTERN_C();
 133
 134 /**
 135    Sets the data of a method of a type writer.
 136
 137    @param handle a handle on a type writer; must not be null
 138
 139    @param index a valid index into the range of methods of the given type writer
 140
 141    @param documentation the documentation of the method; must not be null
 142
 143    @param flags the flags of the method
 144
 145    @param name the name of the method; must not be null
 146
 147    @param returnTypeName the return type name of the method; must not be null
 148
 149    @param parameterCount the number of parameters of the method
 150
 151    @param exceptionCount the number of exceptions of the method
 152
 153    @return false iff an out-of-memory condition occurred, in which case the type
 154    writer is not modified
 155
 156    @since UDK 3.2.0
 157  */
 158 REG_DLLPUBLIC sal_Bool typereg_writer_setMethodData(
 159     void * handle, sal_uInt16 index, rtl_uString const * documentation,
 160     RTMethodMode flags, rtl_uString const * name,
 161     rtl_uString const * returnTypeName, sal_uInt16 parameterCount,
 162     sal_uInt16 exceptionCount)
 163     SAL_THROW_EXTERN_C();
 164
 165 /**
 166    Sets the data of a parameter of a method of a type writer.
 167
 168    @param handle a handle on a type writer; must not be null
 169
 170    @param methodIndex a valid index into the range of methods of the given type
 171    writer
 172
 173    @param parameterIndex a valid index into the range of parameters of the given
 174    method
 175
 176    @param flags the flags of the parameter
 177
 178    @param name the name of the parameter; must not be null
 179
 180    @param typeName the type name of the parameter; must not be null
 181
 182    @return false iff an out-of-memory condition occurred, in which case the type
 183    writer is not modified
 184
 185    @since UDK 3.2.0
 186  */
 187 REG_DLLPUBLIC sal_Bool typereg_writer_setMethodParameterData(
 188     void const * handle, sal_uInt16 methodIndex, sal_uInt16 parameterIndex,
 189     RTParamMode flags, rtl_uString const * name, rtl_uString const * typeName)
 190     SAL_THROW_EXTERN_C();
 191
 192 /**
 193    Sets an exception type name of a method of a type writer.
 194
 195    @param handle a handle on a type writer; must not be null
 196
 197    @param methodIndex a valid index into the range of methods of the given type
 198    writer
 199
 200    @param exceptionIndex a valid index into the range of exceptions of the given
 201    method
 202
 203    @param typeName the exception type name; must not be null
 204
 205    @return false iff an out-of-memory condition occurred, in which case the type
 206    writer is not modified
 207
 208    @since UDK 3.2.0
 209  */
 210 REG_DLLPUBLIC sal_Bool typereg_writer_setMethodExceptionTypeName(
 211     void const * handle, sal_uInt16 methodIndex, sal_uInt16 exceptionIndex,
 212     rtl_uString const * typeName)
 213     SAL_THROW_EXTERN_C();
 214
 215 /**
 216    Sets the data of a reference of a type writer.
 217
 218    @param handle a handle on a type writer; must not be null
 219
 220    @param index a valid index into the range of references of the given type
 221    writer
 222
 223    @param documentation the documentation of the reference; must not be null
 224
 225    @param sort the sort of the reference
 226
 227    @param flags the flags of the reference
 228
 229    @param typeName the type name of the reference; must not be null
 230
 231    @return false iff an out-of-memory condition occurred, in which case the type
 232    writer is not modified
 233
 234    @since UDK 3.2.0
 235  */
 236 REG_DLLPUBLIC sal_Bool typereg_writer_setReferenceData(
 237     void * handle, sal_uInt16 index, rtl_uString const * documentation,
 238     RTReferenceType sort, RTFieldAccess flags, rtl_uString const * typeName)
 239     SAL_THROW_EXTERN_C();
 240
 241 /**
 242    Returns the blob of a type writer.
 243
 244    @param handle a handle on a type writer; must not be null
 245
 246    @param size an out-parameter obtaining the size of the blob; must not be null
 247
 248    @return a (byte-aligned) pointer to the blob; the returned pointer and the
 249    returned <code>size</code> remain valid until the next function is called on
 250    the given type writer; if an out-of-memory condition occurs, null is returned
 251    and <code>size</code> is not modified
 252  */
 253 REG_DLLPUBLIC void const * typereg_writer_getBlob(void * handle, sal_uInt32 * size)
 254     SAL_THROW_EXTERN_C();
 255
 256 #ifdef __cplusplus
 257 }
 258 #endif
 259
 260 #endif
 261
 262 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */