LibreOffice Module registry (master) 1
|
A type reader working on a binary blob that represents a UNOIDL type. More...
#include <reader.hxx>
Public Member Functions | |
Reader (void const *buffer, sal_uInt32 length) | |
Creates a type reader. More... | |
Reader (Reader const &other) | |
Shares a type reader between two Reader instances. More... | |
~Reader () | |
Destroys this Reader instance. More... | |
Reader & | operator= (Reader const &other) |
Replaces the underlying type reader. More... | |
bool | isValid () const |
Returns whether this type reader is valid. More... | |
typereg_Version | getVersion () const |
Returns the binary blob version of this type reader. More... | |
OUString | getDocumentation () const |
Returns the documentation of this type reader. More... | |
OUString | getFileName () const |
Returns the file name of this type reader. More... | |
RTTypeClass | getTypeClass () const |
Returns the type class of this type reader. More... | |
bool | isPublished () const |
Returns whether this type reader is published. More... | |
OUString | getTypeName () const |
Returns the type name of this type reader. More... | |
sal_uInt16 | getSuperTypeCount () const |
Returns the number of super types of this type reader. More... | |
OUString | getSuperTypeName (sal_uInt16 index) const |
Returns the type name of a super type of this type reader. More... | |
sal_uInt16 | getFieldCount () const |
Returns the number of fields of this type reader. More... | |
OUString | getFieldDocumentation (sal_uInt16 index) const |
Returns the documentation of a field of this type reader. More... | |
OUString | getFieldFileName (sal_uInt16 index) const |
Returns the file name of a field of this type reader. More... | |
RTFieldAccess | getFieldFlags (sal_uInt16 index) const |
Returns the flags of a field of this type reader. More... | |
OUString | getFieldName (sal_uInt16 index) const |
Returns the name of a field of this type reader. More... | |
OUString | getFieldTypeName (sal_uInt16 index) const |
Returns the type name of a field of this type reader. More... | |
RTConstValue | getFieldValue (sal_uInt16 index) const |
Returns the value of a field of this type reader. More... | |
sal_uInt16 | getMethodCount () const |
Returns the number of methods of this type reader. More... | |
OUString | getMethodDocumentation (sal_uInt16 index) const |
Returns the documentation of a method of this type reader. More... | |
RTMethodMode | getMethodFlags (sal_uInt16 index) const |
Returns the flags of a method of this type reader. More... | |
OUString | getMethodName (sal_uInt16 index) const |
Returns the name of a method of this type reader. More... | |
OUString | getMethodReturnTypeName (sal_uInt16 index) const |
Returns the return type name of a method of this type reader. More... | |
sal_uInt16 | getMethodParameterCount (sal_uInt16 index) const |
Returns the number of parameters of a method of this type reader. More... | |
RTParamMode | getMethodParameterFlags (sal_uInt16 methodIndex, sal_uInt16 parameterIndex) const |
Returns the flags of a parameter of a method of this type reader. More... | |
OUString | getMethodParameterName (sal_uInt16 methodIndex, sal_uInt16 parameterIndex) const |
Returns the name of a parameter of a method of this type reader. More... | |
OUString | getMethodParameterTypeName (sal_uInt16 methodIndex, sal_uInt16 parameterIndex) const |
Returns the type name of a parameter of a method of this type reader. More... | |
sal_uInt16 | getMethodExceptionCount (sal_uInt16 index) const |
Returns the number of exceptions of a method of this type reader. More... | |
OUString | getMethodExceptionTypeName (sal_uInt16 methodIndex, sal_uInt16 exceptionIndex) const |
Returns the type name of an exception of a method of this type reader. More... | |
sal_uInt16 | getReferenceCount () const |
Returns the number of references of this type reader. More... | |
OUString | getReferenceDocumentation (sal_uInt16 index) const |
Returns the documentation of a reference of this type reader. More... | |
RTFieldAccess | getReferenceFlags (sal_uInt16 index) const |
Returns the flags of a reference of this type reader. More... | |
RTReferenceType | getReferenceSort (sal_uInt16 index) const |
Returns the sort of a reference of this type reader. More... | |
OUString | getReferenceTypeName (sal_uInt16 index) const |
Returns the type name of a reference of this type reader. More... | |
Private Attributes | |
void * | m_handle |
A type reader working on a binary blob that represents a UNOIDL type.
Instances of this class are not multi-thread–safe.
Definition at line 42 of file reader.hxx.
|
inline |
Creates a type reader.
If the given binary blob is malformed, or of a version larger than maxVersion
, the created type reader is flagged as invalid.
buffer | the binary blob representing the type; must point to at least length bytes, and need only be byte-aligned |
length | the size in bytes of the binary blob representing the type |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 58 of file reader.hxx.
References length, m_handle, and typereg_reader_create().
|
inline |
Shares a type reader between two Reader
instances.
other | another Reader instance |
Definition at line 71 of file reader.hxx.
References m_handle, and typereg_reader_acquire().
|
inline |
Destroys this Reader
instance.
The underlying type reader is only destroyed if this instance was its last user.
Definition at line 81 of file reader.hxx.
References m_handle, and typereg_reader_release().
|
inline |
Returns the documentation of this type reader.
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 126 of file reader.hxx.
References m_handle, and typereg_reader_getDocumentation().
|
inline |
Returns the number of fields of this type reader.
Definition at line 229 of file reader.hxx.
References m_handle, and typereg_reader_getFieldCount().
|
inline |
Returns the documentation of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 242 of file reader.hxx.
References index, m_handle, and typereg_reader_getFieldDocumentation().
|
inline |
Returns the file name of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 261 of file reader.hxx.
References index, m_handle, and typereg_reader_getFieldFileName().
|
inline |
Returns the flags of a field of this type reader.
index | a valid index into the range of fields of this type reader |
Definition at line 277 of file reader.hxx.
References index, m_handle, and typereg_reader_getFieldFlags().
|
inline |
Returns the name of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 290 of file reader.hxx.
References index, m_handle, and typereg_reader_getFieldName().
|
inline |
Returns the type name of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 308 of file reader.hxx.
References index, m_handle, and typereg_reader_getFieldTypeName().
|
inline |
Returns the value of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 326 of file reader.hxx.
References index, m_handle, typereg_reader_getFieldValue(), and v.
|
inline |
Returns the file name of this type reader.
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 144 of file reader.hxx.
References m_handle, and typereg_reader_getFileName().
|
inline |
Returns the number of methods of this type reader.
Definition at line 342 of file reader.hxx.
References m_handle, and typereg_reader_getMethodCount().
|
inline |
Returns the documentation of a method of this type reader.
index | a valid index into the range of methods of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 355 of file reader.hxx.
References index, m_handle, and typereg_reader_getMethodDocumentation().
|
inline |
Returns the number of exceptions of a method of this type reader.
index | a valid index into the range of methods of this type reader |
Definition at line 497 of file reader.hxx.
References index, m_handle, and typereg_reader_getMethodExceptionCount().
|
inline |
Returns the type name of an exception of a method of this type reader.
methodIndex | a valid index into the range of methods of this type reader |
exceptionIndex | a valid index into the range of exceptions of the given method |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 514 of file reader.hxx.
References m_handle, and typereg_reader_getMethodExceptionTypeName().
|
inline |
Returns the flags of a method of this type reader.
index | a valid index into the range of methods of this type reader |
Definition at line 371 of file reader.hxx.
References index, m_handle, and typereg_reader_getMethodFlags().
|
inline |
Returns the name of a method of this type reader.
index | a valid index into the range of methods of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 384 of file reader.hxx.
References index, m_handle, and typereg_reader_getMethodName().
|
inline |
Returns the number of parameters of a method of this type reader.
index | a valid index into the range of methods of this type reader |
Definition at line 418 of file reader.hxx.
References index, m_handle, and typereg_reader_getMethodParameterCount().
|
inline |
Returns the flags of a parameter of a method of this type reader.
methodIndex | a valid index into the range of methods of this type reader |
parameterIndex | a valid index into the range of parameters of the given method |
Definition at line 433 of file reader.hxx.
References m_handle, and typereg_reader_getMethodParameterFlags().
|
inline |
Returns the name of a parameter of a method of this type reader.
methodIndex | a valid index into the range of methods of this type reader |
parameterIndex | a valid index into the range of parameters of the given method |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 453 of file reader.hxx.
References m_handle, and typereg_reader_getMethodParameterName().
|
inline |
Returns the type name of a parameter of a method of this type reader.
methodIndex | a valid index into the range of methods of this type reader |
parameterIndex | a valid index into the range of parameters of the given method |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 478 of file reader.hxx.
References m_handle, and typereg_reader_getMethodParameterTypeName().
|
inline |
Returns the return type name of a method of this type reader.
index | a valid index into the range of methods of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 402 of file reader.hxx.
References index, m_handle, and typereg_reader_getMethodReturnTypeName().
|
inline |
Returns the number of references of this type reader.
Definition at line 532 of file reader.hxx.
References m_handle, and typereg_reader_getReferenceCount().
|
inline |
Returns the documentation of a reference of this type reader.
index | a valid index into the range of references of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 546 of file reader.hxx.
References index, m_handle, and typereg_reader_getReferenceDocumentation().
|
inline |
Returns the flags of a reference of this type reader.
index | a valid index into the range of references of this type reader |
Definition at line 563 of file reader.hxx.
References index, m_handle, and typereg_reader_getReferenceFlags().
|
inline |
Returns the sort of a reference of this type reader.
index | a valid index into the range of references of this type reader |
Definition at line 575 of file reader.hxx.
References index, m_handle, and typereg_reader_getReferenceSort().
|
inline |
Returns the type name of a reference of this type reader.
index | a valid index into the range of references of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 589 of file reader.hxx.
References index, m_handle, and typereg_reader_getReferenceTypeName().
|
inline |
Returns the number of super types of this type reader.
Definition at line 200 of file reader.hxx.
References m_handle, and typereg_reader_getSuperTypeCount().
|
inline |
Returns the type name of a super type of this type reader.
index | a valid index into the range of super types of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 214 of file reader.hxx.
References index, m_handle, and typereg_reader_getSuperTypeName().
|
inline |
Returns the type class of this type reader.
This function will always return the type class without the internal RT_TYPE_PUBLISHED
flag set. Use isPublished
to determine whether this type reader is published.
RT_TYPE_INVALID
is returned Definition at line 163 of file reader.hxx.
References m_handle, and typereg_reader_getTypeClass().
|
inline |
Returns the type name of this type reader.
std::bad_alloc | is raised if an out-of-memory condition occurs |
Definition at line 185 of file reader.hxx.
References m_handle, and typereg_reader_getTypeName().
|
inline |
Returns the binary blob version of this type reader.
TYPEREG_VERSION_0
is returned Definition at line 114 of file reader.hxx.
References m_handle, and typereg_reader_getVersion().
|
inline |
Returns whether this type reader is published.
false
is returned Definition at line 173 of file reader.hxx.
References m_handle, and typereg_reader_isPublished().
|
inline |
Returns whether this type reader is valid.
Definition at line 103 of file reader.hxx.
References m_handle.
Replaces the underlying type reader.
other | any Reader instance |
Reader
instance Definition at line 92 of file reader.hxx.
References m_handle.
|
private |
Definition at line 599 of file reader.hxx.
Referenced by getDocumentation(), getFieldCount(), getFieldDocumentation(), getFieldFileName(), getFieldFlags(), getFieldName(), getFieldTypeName(), getFieldValue(), getFileName(), getMethodCount(), getMethodDocumentation(), getMethodExceptionCount(), getMethodExceptionTypeName(), getMethodFlags(), getMethodName(), getMethodParameterCount(), getMethodParameterFlags(), getMethodParameterName(), getMethodParameterTypeName(), getMethodReturnTypeName(), getReferenceCount(), getReferenceDocumentation(), getReferenceFlags(), getReferenceSort(), getReferenceTypeName(), getSuperTypeCount(), getSuperTypeName(), getTypeClass(), getTypeName(), getVersion(), isPublished(), isValid(), operator=(), Reader(), and ~Reader().