LibreOffice
LibreOffice 7.3 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"
39 #include "uno/data.h"
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 >
59 {
60  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
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 >
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 =
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 =
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) {
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 >
119 {
120  if (osl_atomic_decrement( &_pSequence->nRefCount ) == 0)
121  {
122  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
124  _pSequence, rType.getTypeLibType(), cpp_release );
125  }
126 }
127 
128 template< class E >
130 {
131  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
133  &_pSequence, rSeq._pSequence, rType.getTypeLibType(), cpp_release );
134  return *this;
135 }
136 
137 template< class E >
138 inline bool Sequence< E >::operator == ( const Sequence & rSeq ) const
139 {
140  if (_pSequence == rSeq._pSequence)
141  return true;
142  if (_pSequence->nElements != rSeq._pSequence->nElements)
143  return false;
144  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
146  const_cast< Sequence * >( this ), rType.getTypeLibType(),
147  const_cast< Sequence * >( &rSeq ), rType.getTypeLibType(),
149  cpp_release );
150 }
151 
152 template< class E >
153 inline bool Sequence< E >::operator != ( const Sequence & rSeq ) const
154 {
155  return (! operator == ( rSeq ));
156 }
157 
158 template< class E >
160 {
161  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
162  bool success =
164  &_pSequence, rType.getTypeLibType(),
166  if (! success)
167  throw ::std::bad_alloc();
168  return reinterpret_cast< E * >( _pSequence->elements );
169 }
170 
171 #if !defined LIBO_INTERNAL_ONLY
172 template<class E> E * Sequence<E>::begin() { return getArray(); }
173 #endif
174 
175 template<class E> E const * Sequence<E>::begin() const
176 { return getConstArray(); }
177 
178 #if !defined LIBO_INTERNAL_ONLY
179 template<class E> E * Sequence<E>::end() { return begin() + getLength(); }
180 #endif
181 
182 template<class E> E const * Sequence<E>::end() const
183 { return begin() + getLength(); }
184 
185 #if !defined LIBO_INTERNAL_ONLY
186 template< class E >
187 inline E & Sequence< E >::operator [] ( sal_Int32 nIndex )
188 {
189  // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
190  assert(nIndex >= 0 && static_cast<sal_uInt32>(nIndex) < static_cast<sal_uInt32>(getLength()));
191  return getArray()[ nIndex ];
192 }
193 #endif
194 
195 template< class E >
196 inline const E & Sequence< E >::operator [] ( sal_Int32 nIndex ) const
197 {
198  // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
199  assert(nIndex >= 0 && static_cast<sal_uInt32>(nIndex) < static_cast<sal_uInt32>(getLength()));
200  return reinterpret_cast< const E * >( _pSequence->elements )[ nIndex ];
201 }
202 
203 template< class E >
204 inline void Sequence< E >::realloc( sal_Int32 nSize )
205 {
206  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
207  bool success =
209  &_pSequence, rType.getTypeLibType(), nSize,
211  if (!success)
212  throw ::std::bad_alloc();
213 }
214 
215 #if defined LIBO_INTERNAL_ONLY
216 template <class E> inline void Sequence<E>::swap(Sequence& other)
217 {
218  std::swap(_pSequence, other._pSequence);
219 }
220 #endif
221 
222 inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence(
223  const ::rtl::ByteSequence & rByteSequence )
224 {
225  return * reinterpret_cast< const ::com::sun::star::uno::Sequence< sal_Int8 > * >( &rByteSequence );
226 }
227 
228 #if defined LIBO_INTERNAL_ONLY
229 
231 
232 namespace uno_detail {
233 
234 template< typename value_t, typename charT, typename traits >
235 void sequence_output_elems( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen, std::true_type )
236 {
237  // for integral types, use hex notation
238  auto const flags = os.setf(std::ios_base::hex);
239  for(sal_Int32 i=0; i<nLen-1; ++i)
240  os << "0x" << *pAry++ << ", ";
241  if( nLen > 1 )
242  os << "0x" << *pAry++;
243  os.setf(flags);
244 }
245 
246 template< typename value_t, typename charT, typename traits >
247 void sequence_output_elems( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen, std::false_type )
248 {
249  // every other type: rely on their own ostream operator<<
250  for(sal_Int32 i=0; i<nLen-1; ++i)
251  os << *pAry++ << ", ";
252  if( nLen > 1 )
253  os << *pAry++;
254 }
255 
256 template< typename value_t, typename charT, typename traits >
257 void sequence_output_bytes( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen )
258 {
259  // special case bytes - ostream operator<< outputs those as char
260  // values, but we need raw ints here
261  auto const flags = os.setf(std::ios_base::hex);
262  for(sal_Int32 i=0; i<nLen-1; ++i)
263  os << "0x" << (0xFF & +*pAry++) << ", ";
264  if( nLen > 1 )
265  os << "0x" << (0xFF & +*pAry++);
266  os.setf(flags);
267 }
268 
269 }
270 
277 template< typename value_t, typename charT, typename traits >
278 inline std::basic_ostream<charT, traits> &operator<<(std::basic_ostream<charT, traits> &os, css::uno::Sequence<value_t> const& v)
279 {
280  const value_t *pAry = v.getConstArray();
281  sal_Int32 nLen = v.getLength();
282  if constexpr (std::is_same<sal_Int8, value_t>::value) {
283  uno_detail::sequence_output_bytes(os, pAry, nLen);
284  } else {
285  uno_detail::sequence_output_elems(os, pAry, nLen, std::is_integral<value_t>());
286  }
287  return os;
288 }
289 
290 template <class E> inline auto asNonConstRange(css::uno::Sequence<E>& s)
291 {
292  // Two iterators [begin, end] representing the non-const range of the Sequence.
293  // It only calls Sequence::getArray once, to avoid the second COW overhead when
294  // Sequence::begin() and Sequence::end() are called in pairs.
295  // Inheriting from pair allows to use std::tie to unpack the two iterators.
296  struct SequenceRange : public std::pair<E*, E*>
297  {
298  SequenceRange(E* ptr, sal_Int32 len) : std::pair<E*, E*>(ptr, ptr + len) {}
299  // These allow to pass it as range-expression to range-based for loops
300  E* begin() { return std::pair<E*, E*>::first; }
301  E* end() { return std::pair<E*, E*>::second; }
302  E& operator[](sal_Int32 i) { assert(i >= 0 && i < end() - begin()); return begin()[i]; }
303  };
304  return SequenceRange(s.getLength() ? s.getArray() : nullptr, s.getLength());
305 };
306 
308 
309 #endif
310 
311 }
312 }
313 }
314 }
315 
316 namespace cppu {
317 
318 template< typename T > inline ::com::sun::star::uno::Type const &
320  SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
321 {
326  static_cast<
327  typename ::com::sun::star::uno::Sequence< T >::ElementType * >(
328  0)).
329  getTypeLibType()));
330  }
333 }
334 
335 template< typename T > inline ::com::sun::star::uno::Type const &
337  SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
338 {
339  //TODO On certain platforms with weak memory models, the following code can
340  // result in some threads observing that td points to garbage:
341  static typelib_TypeDescriptionReference * td = NULL;
342  if (td == NULL) {
344  &td,
346  static_cast<
347  typename ::com::sun::star::uno::Sequence< T >::ElementType * >(
348  0)).
349  getTypeLibType()));
350  }
352 }
353 
354 }
355 
356 // generic sequence template
357 template< class E >
358 inline const ::com::sun::star::uno::Type &
359 SAL_CALL getCppuType(
360  SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Sequence< E > * )
361 {
363  static_cast< ::com::sun::star::uno::Sequence< E > * >(0));
364 }
365 
366 // generic sequence template for given element type (e.g. C++ arrays)
367 template< class E >
368 inline const ::com::sun::star::uno::Type &
369 SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType )
370 {
372  {
375  rElementType.getTypeLibType() );
376  }
377  return * reinterpret_cast< const ::com::sun::star::uno::Type * >(
379 }
380 
381 // char sequence
382 inline const ::com::sun::star::uno::Type &
384 {
385  static typelib_TypeDescriptionReference * s_pType_com_sun_star_uno_Sequence_Char = NULL;
386  if (! s_pType_com_sun_star_uno_Sequence_Char)
387  {
388  const ::com::sun::star::uno::Type & rElementType = cppu::UnoType<cppu::UnoCharType>::get();
390  & s_pType_com_sun_star_uno_Sequence_Char,
391  rElementType.getTypeLibType() );
392  }
393  return * reinterpret_cast< const ::com::sun::star::uno::Type * >(
394  & s_pType_com_sun_star_uno_Sequence_Char );
395 }
396 
397 #endif
398 
399 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void cpp_release(void *pCppI)
Function to release a C++ interface.
Definition: genfunc.hxx:50
E * begin()
This function allows to use Sequence in standard algorithms, like std::find and others.
Definition: Sequence.hxx:172
~Sequence()
Destructor: Releases sequence handle.
Definition: Sequence.hxx:118
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.
static css::uno::Type const & get()
Definition: unotype.hxx:292
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.
Template C++ class representing an IDL sequence.
Definition: unotype.hxx:44
const ::com::sun::star::uno::Type & getCharSequenceCppuType()
Gets the meta type of IDL sequence< char >.
Definition: Sequence.hxx:383
const ::com::sun::star::uno::Type & getCppuType(SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Sequence< E > *)
Definition: Sequence.hxx:359
typelib_TypeDescriptionReference * getTypeLibType() const
Gets the C typelib type description reference pointer.
Definition: Type.h:162
This is the binary specification of a SAL sequence.
Definition: types.h:303
const ::com::sun::star::uno::Type & getCppuSequenceType(const ::com::sun::star::uno::Type &rElementType)
Gets the meta type of IDL sequence.
Definition: Sequence.hxx:369
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
void * cpp_queryInterface(void *pCppI, typelib_TypeDescriptionReference *pType)
Function to query for a C++ interface.
Definition: genfunc.hxx:55
void realloc(sal_Int32 nSize)
Reallocates sequence to new length.
Definition: Sequence.hxx:204
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:568
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.
bool operator==(const Sequence &rSeq) const
Equality operator: Compares two sequences.
Definition: Sequence.hxx:138
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.
::com::sun::star::uno::Type const & getTypeFavourChar(SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:336
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.
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.
Definition: types.h:359
css::uno::Type const & getTypeFromTypeDescriptionReference(::typelib_TypeDescriptionReference *const *tdr)
Definition: unotype.hxx:105
void cpp_acquire(void *pCppI)
Function to acquire a C++ interface.
Definition: genfunc.hxx:45
__sal_NoAcquire
Definition: types.h:352
sal_Int32 nRefCount
reference count of sequence
Definition: types.h:307
Definition: Enterable.hxx:30
sal_Int32 nElements
element count
Definition: types.h:310
CPPU_DLLPUBLIC void typelib_static_sequence_type_init(typelib_TypeDescriptionReference **ppRef, typelib_TypeDescriptionReference *pElementType) SAL_THROW_EXTERN_C()
Inits static sequence type reference.
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:222
Sequence()
Default constructor: Creates an empty sequence.
Definition: Sequence.hxx:58
::com::sun::star::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:319
E * getArray()
Gets a pointer to elements array for reading and writing.
Definition: Sequence.hxx:159
E * end()
This function allows to use Sequence in standard algorithms, like std::find and others.
Definition: Sequence.hxx:179
bool operator!=(const Sequence &rSeq) const
Inequality operator: Compares two sequences.
Definition: Sequence.hxx:153
E & operator[](sal_Int32 nIndex)
Non-const index operator: Obtains a reference to element indexed at given position.
Definition: Sequence.hxx:187
css::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER T const *)
A working replacement for getCppuType (see there).
Definition: unotype.hxx:324
C++ class representing an IDL meta type.
Definition: Type.h:58
Sequence & operator=(const Sequence &rSeq)
Assignment operator: Acquires given sequence handle and releases previously set handle.
Definition: Sequence.hxx:129