1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef _COMPHELPER_SEQUENCEASVECTOR_HXX_
#define _COMPHELPER_SEQUENCEASVECTOR_HXX_
//_______________________________________________
// includes
#include <vector>
#include <algorithm>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/beans/IllegalTypeException.hpp>
//_______________________________________________
// namespace
namespace comphelper{
//_______________________________________________
// definitions
/** @short Implements a stl vector on top of any
uno sequence.
@descr That provides the possibility to modify
sequences very easy ...
Of course this can be usefull only, if
count of modifications is high, so copying
of the sequence make sense!
*/
template< class TElementType >
class SequenceAsVector : public ::std::vector< TElementType >
{
//-------------------------------------------
// types
public:
//---------------------------------------
/** @short When inheriting from a template using typename is generally required when using
types from the base! */
typedef typename ::std::vector< TElementType >::const_iterator const_iterator;
//---------------------------------------
/** @short When inheriting from a template using typename is generally required when using
types from the base! */
typedef typename ::std::vector< TElementType >::iterator iterator;
//-------------------------------------------
// interface
public:
//---------------------------------------
/** @short default ctor, to create an empty list.
*/
SequenceAsVector()
{}
//---------------------------------------
/** @short default dtor
*/
~SequenceAsVector()
{}
//---------------------------------------
/** @short creates a new vector with the given length.
@param nLength
the number of elements for the new vector.
*/
explicit SequenceAsVector(sal_Int32 nLength) :
::std::vector< TElementType >( static_cast< size_t >( nLength ) )
{
}
//---------------------------------------
/** @short creates a new deque from the given uno sequence.
@param lSource
contains the new items for this deque.
*/
SequenceAsVector(const ::com::sun::star::uno::Sequence< TElementType >& lSource)
{
(*this) << lSource;
}
//---------------------------------------
/** @short creates a new instance from the given Any, which
of course must contain a valid sequence using the
right element type for every item.
@attention If the given Any is an empty one
(if its set to VOID), no exception
is thrown. In such case this instance will
be created as an empty one too!
@param aSource
this any must contain a suitable sequence. :-)
@throw A <type scope="com::sun::star::beans">IllegalTypeException</type>
if an unsupported element inside this Any
is given. An empty Any reset this instance!
*/
SequenceAsVector(const ::com::sun::star::uno::Any& aSource)
{
(*this) << aSource;
}
//---------------------------------------
/** @short fill this instance from the given uno sequence.
@param lSource
contains the new items for this deque.
*/
void operator<<(const ::com::sun::star::uno::Sequence< TElementType >& lSource)
{
this->clear();
sal_Int32 c = lSource.getLength();
const TElementType* pSource = lSource.getConstArray();
for (sal_Int32 i=0; i<c; ++i)
this->push_back(pSource[i]);
}
//---------------------------------------
/** @short fill this instance from the given Any, which
of course must contain a valid sequence using the
right element type for every item.
@attention If the given Any is an empty one
(if its set to VOID), no exception
is thrown. In such case this instance will
be created as an empty one too!
@param aSource
this any must contain a suitable sequence. :-)
@throw A <type scope="com::sun::star::beans">IllegalTypeException</type>
if an unsupported element inside this Any
is given. An empty Any reset this instance!
*/
void operator<<(const ::com::sun::star::uno::Any& aSource)
{
// An empty Any reset this instance!
if (!aSource.hasValue())
{
this->clear();
return;
}
::com::sun::star::uno::Sequence< TElementType > lSource;
if (!(aSource >>= lSource))
throw ::com::sun::star::beans::IllegalTypeException(
::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM("SequenceAsVector operator<<(Any) was called with an unsupported Any type.")),
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >());
(*this) << lSource;
}
//---------------------------------------
/** @short converts this instance to an uno sequence.
@param lDestination
target sequence for converting.
*/
void operator>>(::com::sun::star::uno::Sequence< TElementType >& lDestination) const
{
sal_Int32 c = (sal_Int32)this->size();
lDestination.realloc(c);
TElementType* pDestination = lDestination.getArray();
sal_Int32 i = 0;
for (typename std::vector<TElementType>::const_iterator pThis = this->begin();
pThis != this->end() ;
++pThis )
{
pDestination[i] = *pThis;
++i;
}
}
//---------------------------------------
/** @short converts this instance to an uno any
which contains a suitable sequence
of items of this stl struct.
@param aDestination
target any for converting.
*/
void operator>>(::com::sun::star::uno::Any& aDestination) const
{
sal_Int32 c = (sal_Int32)this->size();
::com::sun::star::uno::Sequence< TElementType > lDestination(c);
TElementType* pDestination = lDestination.getArray();
sal_Int32 i = 0;
for (typename std::vector<TElementType>::const_iterator pThis = this->begin();
pThis != this->end() ;
++pThis )
{
pDestination[i] = *pThis;
++i;
}
aDestination <<= lDestination;
}
//---------------------------------------
/** @short converts this deque to a suitable uno
sequence which contains all items.
@attention It return a const sequence to prevent
the outside code against using of this
return value as [in/]out parameter for
direct function calls!
Of course it can be casted to non const
... but then its a problem of the outside
code :-)
@return A (const!) sequence, which contains all items of
this deque.
*/
const ::com::sun::star::uno::Sequence< TElementType > getAsConstList() const
{
::com::sun::star::uno::Sequence< TElementType > lDestination;
(*this) >> lDestination;
return lDestination;
}
};
} // namespace comphelper
#endif // _COMPHELPER_SEQUENCEASVECTOR_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
