LibreOffice LibreOffice 4.4 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

Sequence.h
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_H
20 #define INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_H
21
22 #include <typelib/typedescription.h>
23 #include <uno/sequence2.h>
24 #include <com/sun/star/uno/Type.h>
25 #include <rtl/alloc.h>
26
27 #include <new>
28
29 namespace rtl
30 {
31 class ByteSequence;
32 }
33
34 namespace com
35 {
36 namespace sun
37 {
38 namespace star
39 {
40 namespace uno
41 {
42
50 template< class E >
51 class SAL_WARN_UNUSED Sequence
52 {
55 uno_Sequence * _pSequence;
56
57 public:
59
60 // these are here to force memory de/allocation to sal lib.
61 inline static void * SAL_CALL operator new ( ::size_t nSize )
62 { return ::rtl_allocateMemory( nSize ); }
63 inline static void SAL_CALL operator delete ( void * pMem )
64 { ::rtl_freeMemory( pMem ); }
65 inline static void * SAL_CALL operator new ( ::size_t, void * pMem )
66 { return pMem; }
67 inline static void SAL_CALL operator delete ( void *, void * )
68 {}
69
73 static typelib_TypeDescriptionReference * s_pType;
74
76
79 typedef E ElementType;
80
83 inline Sequence();
84
89 inline Sequence( const Sequence< E > & rSeq );
90
97 inline Sequence( uno_Sequence * pSequence, __sal_NoAcquire dummy );
98
104 inline Sequence( const E * pElements, sal_Int32 len );
105
110 inline explicit Sequence( sal_Int32 len );
111
115 inline ~Sequence();
116
123 inline Sequence< E > & SAL_CALL operator = ( const Sequence< E > & rSeq );
124
129 inline sal_Int32 SAL_CALL getLength() const
130 { return _pSequence->nElements; }
131
137 inline bool SAL_CALL hasElements() const
138 { return (_pSequence->nElements > 0); }
139
146 inline const E * SAL_CALL getConstArray() const
147 { return reinterpret_cast< const E * >( _pSequence->elements ); }
148
158 inline E * SAL_CALL getArray();
159
165 inline E * begin();
166
172 inline E const * begin() const;
173
179 inline E * end();
180
186 inline E const * end() const;
187
198 inline E & SAL_CALL operator [] ( sal_Int32 nIndex );
199
206 inline const E & SAL_CALL operator [] ( sal_Int32 nIndex ) const;
207
213 inline bool SAL_CALL operator == ( const Sequence< E > & rSeq ) const;
214
220 inline bool SAL_CALL operator != ( const Sequence< E > & rSeq ) const;
221
232 inline void SAL_CALL realloc( sal_Int32 nSize );
233
238 inline uno_Sequence * SAL_CALL get() const
239 { return _pSequence; }
240 };
241
242 // Find uses of illegal Sequence<bool> (instead of Sequence<sal_Bool>) during
243 // compilation:
244 template<> class Sequence<bool> {
245 Sequence(Sequence<bool> const &) SAL_DELETED_FUNCTION;
246 };
247
253 inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence(
254 const ::rtl::ByteSequence & rByteSequence );
255
256 }
257 }
258 }
259 }
260
271 template< class E >
272 inline const ::com::sun::star::uno::Type &
273 SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< E > * );
274
285 template< class E >
286 inline const ::com::sun::star::uno::Type &
287 SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType );
288
296 inline const ::com::sun::star::uno::Type &
297 SAL_CALL getCharSequenceCppuType();
298
299 #endif
300
301 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::uno::operator==
bool operator==(const Any &rAny, const C &value)
Template equality operator: compares set value of left side any to right side value.
Definition: Any.hxx:563
typedescription.h
getCppuType
const ::com::sun::star::uno::Type & getCppuType(const ::com::sun::star::uno::Sequence< E > *)
Gets the meta type of IDL sequence.
com
Definition: types.h:375
getCharSequenceCppuType
const ::com::sun::star::uno::Type & getCharSequenceCppuType()
Gets the meta type of IDL sequence< char >.
Definition: Sequence.hxx:264
alloc.h
__sal_NoAcquire
__sal_NoAcquire
Definition: types.h:368
rtl_freeMemory
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
rtl
Definition: bootstrap.hxx:24
com::sun::star::uno::Sequence< bool >
Definition: Sequence.h:244
com::sun::star::uno::Sequence::hasElements
bool hasElements() const
Tests whether the sequence has elements, i.e.
Definition: Sequence.h:137
_typelib_TypeDescriptionReference
Holds a weak reference to a type description.
Definition: typedescription.h:40
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:250
SAL_DELETED_FUNCTION
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:394
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:185
com::sun::star::uno::operator!=
bool operator!=(const Any &rAny, const C &value)
Template unequality operator: compares set value of left side any to right side value.
Definition: Any.hxx:574
_sal_Sequence
This is the binary specification of a SAL sequence.
Definition: types.h:329
com::sun::star::uno::Sequence
Template C++ class representing an IDL sequence.
Definition: unotype.hxx:33
com::sun::star::uno::Sequence::ElementType
E ElementType
typedefs the element type of the sequence
Definition: Sequence.h:79
sequence2.h
com::sun::star::uno::Sequence::getConstArray
const E * getConstArray() const
Gets a pointer to elements array for reading.
Definition: Sequence.h:146
Type.h
rtl_allocateMemory
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
com::sun::star::uno::Sequence::Sequence
Sequence()
Default constructor: Creates an empty sequence.
Definition: Sequence.hxx:48
com::sun::star::uno::Sequence::getLength
sal_Int32 getLength() const
Gets length of the sequence.
Definition: Sequence.h:129
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:588