LibreOffice
LibreOffice 6.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 #ifndef INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_HXX
20 #define INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_HXX
21 
22 #include "sal/config.h"
23 
24 #include <cassert>
25 #include <cstddef>
26 #if defined LIBO_INTERNAL_ONLY
27 # include <type_traits>
28 # include <ostream>
29 #endif
30 
31 #include "osl/interlck.h"
34 #include "uno/data.h"
36 #include "cppu/unotype.hxx"
37 
38 namespace com
39 {
40 namespace sun
41 {
42 namespace star
43 {
44 namespace uno
45 {
46 
48 template< class E >
49 typelib_TypeDescriptionReference * Sequence< E >::s_pType = NULL;
51 
52 template< class E >
54 {
55  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
57  &_pSequence, rType.getTypeLibType(),
58  0, 0, cpp_acquire );
59  // no bad_alloc, because empty sequence is statically allocated in cppu
60 }
61 
62 template< class E >
63 inline Sequence< E >::Sequence( const Sequence & rSeq )
64 {
65  osl_atomic_increment( &rSeq._pSequence->nRefCount );
66  _pSequence = rSeq._pSequence;
67 }
68 
69 template< class E >
71  uno_Sequence * pSequence, __sal_NoAcquire )
72  : _pSequence( pSequence )
73 {
74 }
75 
76 template< class E >
77 inline Sequence< E >::Sequence( const E * pElements, sal_Int32 len )
78 {
79  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
80  bool success =
82  &_pSequence, rType.getTypeLibType(),
83  const_cast< E * >( pElements ), len, cpp_acquire );
84  if (! success)
85  throw ::std::bad_alloc();
86 }
87 
88 template< class E >
89 inline Sequence< E >::Sequence( sal_Int32 len )
90 {
91  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
92  bool success =
94  &_pSequence, rType.getTypeLibType(),
95  0, len, cpp_acquire );
96  if (! success)
97  throw ::std::bad_alloc();
98 }
99 
100 #if defined LIBO_INTERNAL_ONLY
101 template<typename E> Sequence<E>::Sequence(std::initializer_list<E> init) {
103  &_pSequence, cppu::getTypeFavourUnsigned(this).getTypeLibType(),
104  const_cast<E *>(init.begin()), init.size(), cpp_acquire))
105  {
106  throw std::bad_alloc();
107  }
108 }
109 #endif
110 
111 template< class E >
113 {
114  if (osl_atomic_decrement( &_pSequence->nRefCount ) == 0)
115  {
116  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
118  _pSequence, rType.getTypeLibType(), cpp_release );
119  }
120 }
121 
122 template< class E >
124 {
125  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
127  &_pSequence, rSeq._pSequence, rType.getTypeLibType(), cpp_release );
128  return *this;
129 }
130 
131 template< class E >
132 inline bool Sequence< E >::operator == ( const Sequence & rSeq ) const
133 {
134  if (_pSequence == rSeq._pSequence)
135  return true;
136  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
138  const_cast< Sequence * >( this ), rType.getTypeLibType(),
139  const_cast< Sequence * >( &rSeq ), rType.getTypeLibType(),
141  cpp_release );
142 }
143 
144 template< class E >
145 inline bool Sequence< E >::operator != ( const Sequence & rSeq ) const
146 {
147  return (! operator == ( rSeq ));
148 }
149 
150 template< class E >
152 {
153  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
154  bool success =
156  &_pSequence, rType.getTypeLibType(),
158  if (! success)
159  throw ::std::bad_alloc();
160  return reinterpret_cast< E * >( _pSequence->elements );
161 }
162 
163 template<class E> E * Sequence<E>::begin() { return getArray(); }
164 
165 template<class E> E const * Sequence<E>::begin() const
166 { return getConstArray(); }
167 
168 template<class E> E * Sequence<E>::end() { return begin() + getLength(); }
169 
170 template<class E> E const * Sequence<E>::end() const
171 { return begin() + getLength(); }
172 
173 template< class E >
174 inline E & Sequence< E >::operator [] ( sal_Int32 nIndex )
175 {
176  // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
177  assert(nIndex >= 0 && static_cast<sal_uInt32>(nIndex) < static_cast<sal_uInt32>(getLength()));
178  return getArray()[ nIndex ];
179 }
180 
181 template< class E >
182 inline const E & Sequence< E >::operator [] ( sal_Int32 nIndex ) const
183 {
184  // silence spurious -Werror=strict-overflow warnings from GCC 4.8.2
185  assert(nIndex >= 0 && static_cast<sal_uInt32>(nIndex) < static_cast<sal_uInt32>(getLength()));
186  return reinterpret_cast< const E * >( _pSequence->elements )[ nIndex ];
187 }
188 
189 template< class E >
190 inline void Sequence< E >::realloc( sal_Int32 nSize )
191 {
192  const Type & rType = ::cppu::getTypeFavourUnsigned( this );
193  bool success =
195  &_pSequence, rType.getTypeLibType(), nSize,
197  if (!success)
198  throw ::std::bad_alloc();
199 }
200 
201 inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence(
202  const ::rtl::ByteSequence & rByteSequence )
203 {
204  return * reinterpret_cast< const ::com::sun::star::uno::Sequence< sal_Int8 > * >( &rByteSequence );
205 }
206 
207 #if defined LIBO_INTERNAL_ONLY
208 
210 
211 namespace uno_detail {
212 
213 template< typename value_t, typename charT, typename traits >
214 void sequence_output_elems( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen, std::true_type )
215 {
216  // for integral types, use hex notation
217  auto const flags = os.setf(std::ios_base::hex);
218  for(sal_Int32 i=0; i<nLen-1; ++i)
219  os << "0x" << *pAry++ << ", ";
220  if( nLen > 1 )
221  os << "0x" << *pAry++;
222  os.setf(flags);
223 }
224 
225 template< typename value_t, typename charT, typename traits >
226 void sequence_output_elems( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen, std::false_type )
227 {
228  // every other type: rely on their own ostream operator<<
229  for(sal_Int32 i=0; i<nLen-1; ++i)
230  os << *pAry++ << ", ";
231  if( nLen > 1 )
232  os << *pAry++;
233 }
234 
235 template< typename value_t, typename charT, typename traits >
236 void sequence_output_bytes( std::basic_ostream<charT, traits> &os, const value_t *pAry, sal_Int32 nLen )
237 {
238  // special case bytes - ostream operator<< outputs those as char
239  // values, but we need raw ints here
240  auto const flags = os.setf(std::ios_base::hex);
241  for(sal_Int32 i=0; i<nLen-1; ++i)
242  os << "0x" << (0xFF & +*pAry++) << ", ";
243  if( nLen > 1 )
244  os << "0x" << (0xFF & +*pAry++);
245  os.setf(flags);
246 }
247 
248 template<class B>
249 struct negation : std::integral_constant<bool, !bool(B::value)> { };
250 
251 }
252 
259 template< typename value_t, typename charT, typename traits >
260 inline typename std::enable_if<uno_detail::negation<std::is_same<sal_Int8, value_t>>::value, std::basic_ostream<charT, traits>>::type &operator<<(std::basic_ostream<charT, traits> &os, css::uno::Sequence < value_t > &v)
261 {
262  const value_t *pAry = v.getConstArray();
263  sal_Int32 nLen = v.getLength();
264  uno_detail::sequence_output_elems(os, pAry, nLen, std::is_integral<value_t>());
265  return os;
266 }
267 
268 template< typename value_t, typename charT, typename traits >
269 inline typename std::enable_if<std::is_same<sal_Int8, value_t>::value, std::basic_ostream<charT, traits>>::type &operator<<(std::basic_ostream<charT, traits> &os, css::uno::Sequence < value_t > &v)
270 {
271  // specialisation for signed bytes
272  const sal_Int8 *pAry = v.getConstArray();
273  sal_Int32 nLen = v.getLength();
274  uno_detail::sequence_output_bytes(os, pAry, nLen);
275  return os;
276 }
277 
279 
280 #endif
281 
282 }
283 }
284 }
285 }
286 
287 namespace cppu {
288 
289 template< typename T > inline ::com::sun::star::uno::Type const &
291  SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
292 {
297  static_cast<
298  typename ::com::sun::star::uno::Sequence< T >::ElementType * >(
299  0)).
300  getTypeLibType()));
301  }
304 }
305 
306 template< typename T > inline ::com::sun::star::uno::Type const &
308  SAL_UNUSED_PARAMETER ::com::sun::star::uno::Sequence< T > const *)
309 {
310  //TODO On certain platforms with weak memory models, the following code can
311  // result in some threads observing that td points to garbage:
312  static typelib_TypeDescriptionReference * td = NULL;
313  if (td == NULL) {
315  &td,
317  static_cast<
318  typename ::com::sun::star::uno::Sequence< T >::ElementType * >(
319  0)).
320  getTypeLibType()));
321  }
323 }
324 
325 }
326 
327 // generic sequence template
328 template< class E >
329 inline const ::com::sun::star::uno::Type &
330 SAL_CALL getCppuType(
331  SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Sequence< E > * )
332 {
334  static_cast< ::com::sun::star::uno::Sequence< E > * >(0));
335 }
336 
337 // generic sequence template for given element type (e.g. C++ arrays)
338 template< class E >
339 inline const ::com::sun::star::uno::Type &
340 SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType )
341 {
343  {
346  rElementType.getTypeLibType() );
347  }
348  return * reinterpret_cast< const ::com::sun::star::uno::Type * >(
350 }
351 
352 // char sequence
353 inline const ::com::sun::star::uno::Type &
355 {
356  static typelib_TypeDescriptionReference * s_pType_com_sun_star_uno_Sequence_Char = NULL;
357  if (! s_pType_com_sun_star_uno_Sequence_Char)
358  {
359  const ::com::sun::star::uno::Type & rElementType = cppu::UnoType<cppu::UnoCharType>::get();
361  & s_pType_com_sun_star_uno_Sequence_Char,
362  rElementType.getTypeLibType() );
363  }
364  return * reinterpret_cast< const ::com::sun::star::uno::Type * >(
365  & s_pType_com_sun_star_uno_Sequence_Char );
366 }
367 
368 #endif
369 
370 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Sequence & operator=(const Sequence &rSeq)
Assignment operator: Acquires given sequence handle and releases previously set handle.
Definition: Sequence.hxx:123
E * begin()
This function allows to use Sequence in standard algorightms, like std::find and others.
Definition: Sequence.hxx:163
Definition: Enterable.hxx:26
bool operator!=(const Sequence &rSeq) const
Unequality operator: Compares two sequences.
Definition: Sequence.hxx:145
::com::sun::star::uno::Type const & getTypeFavourChar(SAL_UNUSED_PARAMETER::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:307
void * cpp_queryInterface(void *pCppI, typelib_TypeDescriptionReference *pType)
Function to query for a C++ interface.
Definition: genfunc.hxx:51
char elements[1]
elements array
Definition: types.h:331
css::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER T const *)
A working replacement for getCppuType (see there).
Definition: unotype.hxx:320
Definition: types.h:377
void cpp_release(void *pCppI)
Function to release a C++ interface.
Definition: genfunc.hxx:46
void realloc(sal_Int32 nSize)
Reallocates sequence to new length.
Definition: Sequence.hxx:190
typelib_TypeDescriptionReference * getTypeLibType() const
Gets the C typelib type description reference pointer.
Definition: Type.h:154
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:201
__sal_NoAcquire
Definition: types.h:370
#define SAL_UNUSED_PARAMETER
Annotate unused but required C++ function parameters.
Definition: types.h:583
const ::com::sun::star::uno::Type & getCppuSequenceType(const ::com::sun::star::uno::Type &rElementType)
Gets the meta type of IDL sequence.
Definition: Sequence.hxx:340
E & operator[](sal_Int32 nIndex)
Non-const index operator: Obtains a reference to element indexed at given position.
Definition: Sequence.hxx:174
C++ class representing an IDL meta type.
Definition: Type.h:54
Template C++ class representing an IDL sequence.
Definition: unotype.hxx:40
signed char sal_Int8
Definition: types.h:43
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.
bool operator==(const Sequence &rSeq) const
Equality operator: Compares two sequences.
Definition: Sequence.hxx:132
static css::uno::Type const & get()
Definition: unotype.hxx:288
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.
This is the binary specification of a SAL sequence.
Definition: types.h:321
sal_Int32 nRefCount
reference count of sequence
Definition: types.h:325
const E * getConstArray() const
Gets a pointer to elements array for reading.
Definition: Sequence.h:160
::com::sun::star::uno::Type const & getTypeFavourUnsigned(SAL_UNUSED_PARAMETER::com::sun::star::uno::Sequence< T > const *)
Definition: Sequence.hxx:290
CPPU_DLLPUBLIC void typelib_static_sequence_type_init(typelib_TypeDescriptionReference **ppRef, typelib_TypeDescriptionReference *pElementType) SAL_THROW_EXTERN_C()
Inits static sequence type reference.
~Sequence()
Destructor: Releases sequence handle.
Definition: Sequence.hxx:112
css::uno::Type const & getTypeFromTypeDescriptionReference(::typelib_TypeDescriptionReference *const *tdr)
Definition: unotype.hxx:101
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.
E * getArray()
Gets a pointer to elements array for reading and writing.
Definition: Sequence.hxx:151
void cpp_acquire(void *pCppI)
Function to acquire a C++ interface.
Definition: genfunc.hxx:41
struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference typelib_TypeDescriptionReference
Holds a weak reference to a type description.
Sequence()
Default constructor: Creates an empty sequence.
Definition: Sequence.hxx:53
E * end()
This function allows to use Sequence in standard algorightms, like std::find and others.
Definition: Sequence.hxx:168
sal_Int32 getLength() const
Gets length of the sequence.
Definition: Sequence.h:143
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.
const ::com::sun::star::uno::Type & getCppuType(SAL_UNUSED_PARAMETER const ::com::sun::star::uno::Sequence< E > *)
Definition: Sequence.hxx:330
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.
const ::com::sun::star::uno::Type & getCharSequenceCppuType()
Gets the meta type of IDL sequence< char >.
Definition: Sequence.hxx:354
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.