LibreOffice LibreOffice 25.2 SDK C/C++ API Reference

Sequence.hxx
Go to the documentation of this file.
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/*
21 * This file is part of LibreOffice published API.
22 */
23#ifndef INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_HXX
24#define INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_HXX
25
26#include "sal/config.h"
27
28#include <cassert>
29#include <cstddef>
30#if defined LIBO_INTERNAL_ONLY
31# include <type_traits>
32# include <ostream>
33# include <utility>
34#endif
35
36#include "osl/interlck.h"
37#include "com/sun/star/uno/Sequence.h"
38#include "typelib/typedescription.h"
39#include "uno/data.h"
40#include "com/sun/star/uno/genfunc.hxx"
41#include "cppu/unotype.hxx"
42
43 namespace com
44{
45 namespace sun
46{
47 namespace star
48{
49 namespace uno
50{
51
53 template< class E >
54 typelib_TypeDescriptionReference * Sequence< E >::s_pType = NULL;
56
57 template< class E >
58 inline Sequence< E >::Sequence()
59{
60 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
61 ::uno_type_sequence_construct(
62 &_pSequence, rType.getTypeLibType(),
63 NULL, 0, cpp_acquire );
64 // no bad_alloc, because empty sequence is statically allocated in cppu
65}
66
67 template< class E >
68 inline Sequence< E >::Sequence( const Sequence & rSeq )
69{
70 osl_atomic_increment( &rSeq._pSequence->nRefCount );
71 _pSequence = rSeq._pSequence;
72}
73
74 template< class E >
75 inline Sequence< E >::Sequence(
76 uno_Sequence * pSequence, __sal_NoAcquire )
77 : _pSequence( pSequence )
78{
79}
80
81 template< class E >
82 inline Sequence< E >::Sequence( const E * pElements, sal_Int32 len )
83{
84 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
85
86 bool success =
87 ::uno_type_sequence_construct(
88 &_pSequence, rType.getTypeLibType(),
89 const_cast< E * >( pElements ), len, cpp_acquire );
90 if (! success)
91 throw ::std::bad_alloc();
92}
93
94 template< class E >
95 inline Sequence< E >::Sequence( sal_Int32 len )
96{
97 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
98 bool success =
99 ::uno_type_sequence_construct(
100 &_pSequence, rType.getTypeLibType(),
101 NULL, len, cpp_acquire );
102 if (! success)
103 throw ::std::bad_alloc();
104}
105
106#if defined LIBO_INTERNAL_ONLY
107 template<typename E> Sequence<E>::Sequence(std::initializer_list<E> init) {
108 if (!uno_type_sequence_construct(
109 &_pSequence, cppu::getTypeFavourUnsigned(this).getTypeLibType(),
110 const_cast<E *>(init.begin()), init.size(), cpp_acquire))
111 {
112 throw std::bad_alloc();
113 }
114}
115#endif
116
117 template< class E >
118 inline Sequence< E >::~Sequence()
119{
120 if (osl_atomic_decrement( &_pSequence->nRefCount ) == 0)
121 {
122 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
123 uno_type_sequence_destroy(
124 _pSequence, rType.getTypeLibType(), cpp_release );
125 }
126}
127
128 template< class E >
129 inline Sequence< E > & Sequence< E >::operator = ( const Sequence & rSeq )
130{
131 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
132 ::uno_type_sequence_assign(
133 &_pSequence, rSeq._pSequence, rType.getTypeLibType(), cpp_release );
134 return *this;
135}
136
137#if defined LIBO_INTERNAL_ONLY
138 template<typename E> Sequence<E> & Sequence<E>::operator =(Sequence && other) {
139 std::swap(_pSequence, other._pSequence);
140 return *this;
141}
142#endif
143
144 template< class E >
145 inline bool Sequence< E >::operator == ( const Sequence & rSeq ) const
146{
147 if (_pSequence == rSeq._pSequence)
148 return true;
149 if (_pSequence->nElements != rSeq._pSequence->nElements)
150 return false;
151 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
152 return ::uno_type_equalData(
153 const_cast< Sequence * >( this ), rType.getTypeLibType(),
154 const_cast< Sequence * >( &rSeq ), rType.getTypeLibType(),
155 cpp_queryInterface,
156 cpp_release );
157}
158
159 template< class E >
160 inline bool Sequence< E >::operator != ( const Sequence & rSeq ) const
161{
162 return (! operator == ( rSeq ));
163}
164
165 template< class E >
166 inline E * Sequence< E >::getArray()
167{
168 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
169 bool success =
170 ::uno_type_sequence_reference2One(
171 &_pSequence, rType.getTypeLibType(),
172 cpp_acquire, cpp_release );
173 if (! success)
174 throw ::std::bad_alloc();
175 return reinterpret_cast< E * >( _pSequence->elements );
176}
177
178#if !defined LIBO_INTERNAL_ONLY
179 template<class E> E * Sequence<E>::begin() { return getArray(); }
180#endif
181
182 template<class E> E const * Sequence<E>::begin() const
183{ return getConstArray(); }
184
185#if !defined LIBO_INTERNAL_ONLY
186 template<class E> E * Sequence<E>::end() { return begin() + getLength(); }
187#endif
188
189 template<class E> E const * Sequence<E>::end() const
190{ return begin() + getLength(); }
191
192#if !defined LIBO_INTERNAL_ONLY
193 template< class E >
194 inline E & Sequence< E >::operator [] ( sal_Int32 nIndex )
195{
196 // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
197 assert(nIndex >= 0 && static_cast<sal_uInt32>(nIndex) < static_cast<sal_uInt32>(getLength()));
198 return getArray()[ nIndex ];
199}
200#endif
201
202 template< class E >
203 inline const E & Sequence< E >::operator [] ( sal_Int32 nIndex ) const
204{
205 // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
206 assert(nIndex >= 0 && static_cast<sal_uInt32>(nIndex) < static_cast<sal_uInt32>(getLength()));
207 return reinterpret_cast< const E * >( _pSequence->elements )[ nIndex ];
208}
209
210 template< class E >
211 inline void Sequence< E >::realloc( sal_Int32 nSize )
212{
213 const Type & rType = ::cppu::getTypeFavourUnsigned( this );
214 bool success =
215 ::uno_type_sequence_realloc(
216 &_pSequence, rType.getTypeLibType(), nSize,
217 cpp_acquire, cpp_release );
218 if (!success)
219 throw ::std::bad_alloc();
220}
221
222#if defined LIBO_INTERNAL_ONLY
223 template <class E> inline void Sequence<E>::swap(Sequence& other)
224{
225 std::swap(_pSequence, other._pSequence);
226}
227#endif
228
229inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence(
230 const ::rtl::ByteSequence & rByteSequence )
231{
232 return * reinterpret_cast< const ::com::sun::star::uno::Sequence< sal_Int8 > * >( &rByteSequence );
233}
234
235#if defined LIBO_INTERNAL_ONLY
236
238
239 namespace uno_detail {
240
241 template< typename value_t, typename charT, typename traits >
242 void sequence_output_elems( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen, std::true_type )
243{
244 // for integral types, use hex notation
245 auto const flags = os.setf(std::ios_base::hex);
246 for(sal_Int32 i=0; i<nLen-1; ++i)
247 os << "0x" << *pAry++ << ", ";
248 if( nLen > 1 )
249 os << "0x" << *pAry++;
250 os.setf(flags);
251}
252
253 template< typename value_t, typename charT, typename traits >
254 void sequence_output_elems( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen, std::false_type )
255{
256 // every other type: rely on their own ostream operator<<
257 for(sal_Int32 i=0; i<nLen-1; ++i)
258 os << *pAry++ << ", ";
259 if( nLen > 1 )
260 os << *pAry++;
261}
262
263 template< typename value_t, typename charT, typename traits >
264 void sequence_output_bytes( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen )
265{
266 // special case bytes - ostream operator<< outputs those as char
267 // values, but we need raw ints here
268 auto const flags = os.setf(std::ios_base::hex);
269 for(sal_Int32 i=0; i<nLen-1; ++i)
270 os << "0x" << (0xFF & +*pAry++) << ", ";
271 if( nLen > 1 )
272 os << "0x" << (0xFF & +*pAry++);
273 os.setf(flags);
274}
275
276}
277
284 template< typename value_t, typename charT, typename traits >
285 inline std::basic_ostream<charT, traits> &operator<<(std::basic_ostream<charT, traits> &os, css::uno::Sequence<value_t> const& v)
286{
287 const value_t *pAry = v.getConstArray();
288 sal_Int32 nLen = v.getLength();
289 if constexpr (std::is_same<sal_Int8, value_t>::value) {
290 uno_detail::sequence_output_bytes(os, pAry, nLen);
291 } else {
292 uno_detail::sequence_output_elems(os, pAry, nLen, std::is_integral<value_t>());
293 }
294 return os;
295}
296
297 template <class E> inline auto asNonConstRange(css::uno::Sequence<E>& s)
298{
299 // Two iterators [begin, end] representing the non-const range of the Sequence.
300 // It only calls Sequence::getArray once, to avoid the second COW overhead when
301 // Sequence::begin() and Sequence::end() are called in pairs.
302 // Inheriting from pair allows to use std::tie to unpack the two iterators.
303 struct SequenceRange : public std::pair<E*, E*>
304 {
305 SequenceRange(E* ptr, sal_Int32 len) : std::pair<E*, E*>(ptr, ptr + len) {}
306 // These allow to pass it as range-expression to range-based for loops
307 E* begin() { return std::pair<E*, E*>::first; }
308 E* end() { return std::pair<E*, E*>::second; }
309 E& operator[](sal_Int32 i) { assert(i >= 0 && i < end() - begin()); return begin()[i]; }
310 };
311 return SequenceRange(s.getLength() ? s.getArray() : nullptr, s.getLength());
312};
313
315
316#endif
317
318}
319}
320}
321}
322
323 namespace cppu {
324
325 template< typename T > inline ::com::sun::star::uno::Type const &
326 getTypeFavourUnsigned(
327 SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
328{
329 if (::com::sun::star::uno::Sequence< T >::s_pType == NULL) {
330 ::typelib_static_sequence_type_init(
331 &::com::sun::star::uno::Sequence< T >::s_pType,
332 (::cppu::getTypeFavourUnsigned(
333 static_cast<
334 typename ::com::sun::star::uno::Sequence< T >::ElementType * >(
335 NULL)).
336 getTypeLibType()));
337 }
338 return detail::getTypeFromTypeDescriptionReference(
339 &::com::sun::star::uno::Sequence< T >::s_pType);
340}
341
342 template< typename T > inline ::com::sun::star::uno::Type const &
343 getTypeFavourChar(
344 SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
345{
346 //TODO On certain platforms with weak memory models, the following code can
347 // result in some threads observing that td points to garbage:
348 static typelib_TypeDescriptionReference * td = NULL;
349 if (td == NULL) {
350 ::typelib_static_sequence_type_init(
351 &td,
352 (::cppu::getTypeFavourChar(
353 static_cast<
354 typename ::com::sun::star::uno::Sequence< T >::ElementType * >(
355 NULL)).
356 getTypeLibType()));
357 }
358 return detail::getTypeFromTypeDescriptionReference(&td);
359}
360
361}
362
363// generic sequence template
364 template< class E >
365 inline const ::com::sun::star::uno::Type &
366SAL_CALL getCppuType(
367 SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Sequence< E > * )
368{
369 return ::cppu::getTypeFavourUnsigned(
370 static_cast< ::com::sun::star::uno::Sequence< E > * >(0));
371}
372
373// generic sequence template for given element type (e.g. C++ arrays)
374 template< class E >
375 inline const ::com::sun::star::uno::Type &
376SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType )
377{
378 if (! ::com::sun::star::uno::Sequence< E >::s_pType)
379 {
380 ::typelib_static_sequence_type_init(
381 & ::com::sun::star::uno::Sequence< E >::s_pType,
382 rElementType.getTypeLibType() );
383 }
384 return * reinterpret_cast< const ::com::sun::star::uno::Type * >(
385 & ::com::sun::star::uno::Sequence< E >::s_pType );
386}
387
388// char sequence
389 inline const ::com::sun::star::uno::Type &
390SAL_CALL getCharSequenceCppuType()
391{
392 static typelib_TypeDescriptionReference * s_pType_com_sun_star_uno_Sequence_Char = NULL;
393 if (! s_pType_com_sun_star_uno_Sequence_Char)
394 {
395 const ::com::sun::star::uno::Type & rElementType = cppu::UnoType<cppu::UnoCharType>::get();
396 ::typelib_static_sequence_type_init(
397 & s_pType_com_sun_star_uno_Sequence_Char,
398 rElementType.getTypeLibType() );
399 }
400 return * reinterpret_cast< const ::com::sun::star::uno::Type * >(
401 & s_pType_com_sun_star_uno_Sequence_Char );
402}
403
404#endif
405
406/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
config.h
__sal_NoAcquire
__sal_NoAcquire
Definition: types.h:371
SAL_UNUSED_PARAMETER
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:592
interlck.h
typedescription.h
typelib_static_sequence_type_init
CPPU_DLLPUBLIC void typelib_static_sequence_type_init(typelib_TypeDescriptionReference **ppRef, typelib_TypeDescriptionReference *pElementType) SAL_THROW_EXTERN_C()
Inits static sequence type reference.
typelib_TypeDescriptionReference
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
data.h
uno_type_equalData
CPPU_DLLPUBLIC sal_Bool uno_type_equalData(void *pVal1, struct _typelib_TypeDescriptionReference *pVal1Type, void *pVal2, struct _typelib_TypeDescriptionReference *pVal2Type, uno_QueryInterfaceFunc queryInterface, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
Tests if two values are equal.
uno_type_sequence_realloc
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_realloc(uno_Sequence **ppSequence, struct _typelib_TypeDescriptionReference *pType, sal_Int32 nSize, uno_AcquireFunc acquire, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
Reallocates length of a sequence.
uno_type_sequence_reference2One
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_reference2One(uno_Sequence **ppSequence, struct _typelib_TypeDescriptionReference *pType, uno_AcquireFunc acquire, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
Assures that the reference count of the given sequence is one.
uno_type_sequence_destroy
CPPU_DLLPUBLIC void uno_type_sequence_destroy(uno_Sequence *sequence, struct _typelib_TypeDescriptionReference *type, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
Destroy a sequence whose reference count has dropped to zero.
uno_type_sequence_construct
CPPU_DLLPUBLIC sal_Bool uno_type_sequence_construct(uno_Sequence **ppSequence, struct _typelib_TypeDescriptionReference *pType, void *pElements, sal_Int32 len, uno_AcquireFunc acquire) SAL_THROW_EXTERN_C()
Constructs a new sequence with given elements.
uno_type_sequence_assign
CPPU_DLLPUBLIC void uno_type_sequence_assign(uno_Sequence **ppDest, uno_Sequence *pSource, struct _typelib_TypeDescriptionReference *pType, uno_ReleaseFunc release) SAL_THROW_EXTERN_C()
Assigns a sequence.
unotype.hxx
genfunc.hxx
Sequence.h
getCharSequenceCppuType
const ::com::sun::star::uno::Type & getCharSequenceCppuType()
Gets the meta type of IDL sequence< char >.
Definition: Sequence.hxx:390
getCppuSequenceType
const ::com::sun::star::uno::Type & getCppuSequenceType(const ::com::sun::star::uno::Type &rElementType)
Gets the meta type of IDL sequence.
Definition: Sequence.hxx:376
getCppuType
const ::com::sun::star::uno::Type & getCppuType(SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Sequence< E > *)
Definition: Sequence.hxx:366
com
Definition: types.h:377
com::sun::star::uno::toUnoSequence
inline ::com::sun::star::uno::Sequence< sal_Int8 > toUnoSequence(const ::rtl::ByteSequence &rByteSequence)
Creates a UNO byte sequence from a SAL byte sequence.
Definition: Sequence.hxx:229
com::sun::star::uno::operator<<
std::basic_ostream< charT, traits > & operator<<(std::basic_ostream< charT, traits > &o, Any const &any)
Support for Any in std::ostream (and thus in CPPUNIT_ASSERT or SAL_INFO macros, for example).
Definition: Any.hxx:708
com::sun::star::uno::cpp_release
void cpp_release(void *pCppI)
Function to release a C++ interface.
Definition: genfunc.hxx:50
com::sun::star::uno::cpp_queryInterface
void * cpp_queryInterface(void *pCppI, typelib_TypeDescriptionReference *pType)
Function to query for a C++ interface.
Definition: genfunc.hxx:55
com::sun::star::uno::cpp_acquire
void cpp_acquire(void *pCppI)
Function to acquire a C++ interface.
Definition: genfunc.hxx:45
cppu
Definition: Enterable.hxx:31
cppu::getTypeFavourUnsigned
css::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER T const *)
A working replacement for getCppuType (see there).
Definition: unotype.hxx:324
cppu::getTypeFavourChar
::com::sun::star::uno::Type const & getTypeFavourChar(SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:343
cppu::getTypeFavourUnsigned
::com::sun::star::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:326
cppu::detail::getTypeFromTypeDescriptionReference
css::uno::Type const & getTypeFromTypeDescriptionReference(::typelib_TypeDescriptionReference *const *tdr)
Definition: unotype.hxx:105
_sal_Sequence
This is the binary specification of a SAL sequence.
Definition: types.h:322
_sal_Sequence::nRefCount
sal_Int32 nRefCount
reference count of sequence
Definition: types.h:325
_sal_Sequence::nElements
sal_Int32 nElements
element count
Definition: types.h:328
com::sun::star::uno::Sequence
Template C++ class representing an IDL sequence.
Definition: Sequence.h:61
com::sun::star::uno::Sequence::~Sequence
~Sequence()
Destructor: Releases sequence handle.
Definition: Sequence.hxx:118
com::sun::star::uno::Sequence::operator==
bool operator==(const Sequence &rSeq) const
Equality operator: Compares two sequences.
Definition: Sequence.hxx:145
com::sun::star::uno::Sequence::begin
E * begin()
This function allows to use Sequence in standard algorithms, like std::find and others.
Definition: Sequence.hxx:179
com::sun::star::uno::Sequence::operator[]
E & operator[](sal_Int32 nIndex)
Non-const index operator: Obtains a reference to element indexed at given position.
Definition: Sequence.hxx:194
com::sun::star::uno::Sequence::end
E * end()
This function allows to use Sequence in standard algorithms, like std::find and others.
Definition: Sequence.hxx:186
com::sun::star::uno::Sequence::getArray
E * getArray()
Gets a pointer to elements array for reading and writing.
Definition: Sequence.hxx:166
com::sun::star::uno::Sequence::operator!=
bool operator!=(const Sequence &rSeq) const
Inequality operator: Compares two sequences.
Definition: Sequence.hxx:160
com::sun::star::uno::Sequence::Sequence
Sequence()
Default constructor: Creates an empty sequence.
Definition: Sequence.hxx:58
com::sun::star::uno::Sequence::operator=
Sequence & operator=(const Sequence &rSeq)
Assignment operator: Acquires given sequence handle and releases previously set handle.
Definition: Sequence.hxx:129
com::sun::star::uno::Sequence::realloc
void realloc(sal_Int32 nSize)
Reallocates sequence to new length.
Definition: Sequence.hxx:211
cppu::UnoType::get
static css::uno::Type const & get()
Definition: unotype.hxx:292
com::sun::star::uno::Type
C++ class representing an IDL meta type.
Definition: Type.h:59
com::sun::star::uno::Type::getTypeLibType
typelib_TypeDescriptionReference * getTypeLibType() const
Gets the C typelib type description reference pointer.
Definition: Type.h:162