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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
/*************************************************************************
*
* $RCSfile: sequenceashashmap.hxx,v $
*
* $Revision: 1.4 $
*
* last change: $Author: vg $ $Date: 2005-02-16 16:01:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _COMPHELPER_SEQUENCEASHASHMAP_HXX_
#define _COMPHELPER_SEQUENCEASHASHMAP_HXX_
//_______________________________________________
// includes
#ifndef INCLUDED_HASH_MAP
#include <hash_map>
#define INCLUDED_HASH_MAP
#endif
#ifndef INCLUDED_ALGORITHM
#include <algorithm>
#define INCLUDED_ALGORITHM
#endif
#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
#include <com/sun/star/uno/Sequence.hxx>
#endif
#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
#include <com/sun/star/beans/PropertyValue.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_NAMEDVALUE_HPP_
#include <com/sun/star/beans/NamedValue.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_IllegalTypeException_HPP_
#include <com/sun/star/beans/IllegalTypeException.hpp>
#endif
#ifndef INCLUDED_COMPHELPERDLLAPI_H
#include "comphelper/comphelperdllapi.h"
#endif
// see method dbg_dumpToFile() below!
#if OSL_DEBUG_LEVEL > 1
#ifndef _RTL_USTRBUF_HXX_
#include <rtl/ustrbuf.hxx>
#endif
#include <stdio.h>
#endif
//_______________________________________________
// namespace
namespace comphelper{
//_______________________________________________
// definitions
/** @short Implements a stl hash map on top of some
specialized sequence from type PropertyValue
or NamedValue.
@descr That provides the possibility to modify
such name sequences very easy ...
*/
struct SequenceAsHashMapBase : public ::std::hash_map<
::rtl::OUString ,
::com::sun::star::uno::Any ,
::rtl::OUStringHash ,
::std::equal_to< ::rtl::OUString > >
{
};
class COMPHELPER_DLLPUBLIC SequenceAsHashMap : public SequenceAsHashMapBase
{
//-------------------------------------------
public:
//---------------------------------------
/** @short creates an empty hash map.
*/
SequenceAsHashMap();
//---------------------------------------
/** @see operator<<(const ::com::sun::star::uno::Any&)
*/
SequenceAsHashMap(const ::com::sun::star::uno::Any& aSource);
//---------------------------------------
/** @see operator<<(const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >&)
*/
SequenceAsHashMap(const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& lSource);
//---------------------------------------
/** @see operator<<(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >&)
*/
SequenceAsHashMap(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lSource);
//---------------------------------------
/** @see operator<<(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >&)
*/
SequenceAsHashMap(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& lSource);
//---------------------------------------
/** @short not realy used but maybe usefull :-)
*/
~SequenceAsHashMap();
//---------------------------------------
/** @short fill this map from the given
any, which of course must contain
a suitable sequence of element types
"css.beans.PropertyValue" or "css.beans.NamedValue".
@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
contains the new items for this map.
@throw An <type scope="com::sun::star::beans">IllegalTypeException</type>
is thrown, if the given any does not contain a suitable sequence ...
but not if its a VOID Any!
*/
void operator<<(const ::com::sun::star::uno::Any& aSource);
//---------------------------------------
/** @short fill this map from the given
sequence, where every Any must contain
an item from type "css.beans.PropertyValue"
"css.beans.NamedValue".
@param lSource
contains the new items for this map.
@throw An <type scope="com::sun::star::beans">IllegalTypeException</type>
is thrown, if the given any sequence
uses wrong types for its items. VOID Any will be ignored!
*/
void operator<<(const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& lSource);
//---------------------------------------
/** @short fill this map from the given
PropertyValue sequence.
@param lSource
contains the new items for this map.
*/
void operator<<(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lSource);
//---------------------------------------
/** @short fill this map from the given
NamedValue sequence.
@param lSource
contains the new items for this map.
*/
void operator<<(const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& lSource);
//---------------------------------------
/** @short converts this map instance to an
PropertyValue sequence.
@param lDestination
target sequence for converting.
*/
void operator>>(::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lDestination) const;
//---------------------------------------
/** @short converts this map instance to an
NamedValue sequence.
@param lDestination
target sequence for converting.
*/
void operator>>(::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& lDestination) const;
//---------------------------------------
/** @short return this map instance to as a
NamedValue sequence, which can be
used in const environments only.
@descr Its made const to prevent using of the
return value directly as an in/out parameter!
usage: myMethod(stlDequeAdapter.getAsNamedValueList());
@return A const sequence of type NamedValue, which
contains all items of this map.
*/
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > getAsConstNamedValueList() const;
//---------------------------------------
/** @short return this map instance to as a
PropertyValue sequence, which can be
used in const environments only.
@descr Its made const to prevent using of the
return value directly as an in/out parameter!
usage: myMethod(stlDequeAdapter.getAsPropertyValueList());
@return A const sequence of type PropertyValue, which
contains all items of this map.
*/
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > getAsConstPropertyValueList() const;
//---------------------------------------
/** @short check if the specified item exists
and return its (unpacked!) value or it returns the
specified default value otherwhise.
@descr If a value should be extracted only in case
the requsted property exists realy (without creating
of new items as it the index operator of a
has_map does!) this method can be used.
@param sKey
key name of the item.
@param aDefault
the default value, which is returned
if the specified item could not
be found.
@return The (unpacked!) value of the specified property or
the given default value otherwhise.
@attention "unpacked" means the Any content of every iterator->second!
*/
template< class TValueType >
TValueType getUnpackedValueOrDefault(const ::rtl::OUString& sKey ,
const TValueType& aDefault) const
{
const_iterator pIt = find(sKey);
if (pIt == end())
return aDefault;
TValueType aValue;
if (!(pIt->second >>= aValue))
return aDefault;
return aValue;
}
//---------------------------------------
/** @short creates a new item with the specified
name and value only in case such item name
does not already exist.
@descr To check if the property already exists only
her name is used for compare. Its value isnt
checked!
@param sKey
key name of the property.
@param aValue
the new (unpacked!) value.
Note: This value will be transformed to an Any
internaly, because only Any values can be
part of a PropertyValue or NamedValue structure.
@return TRUE if this property was added as new item;
FALSE if it already exists.
*/
template< class TValueType >
sal_Bool createItemIfMissing(const ::rtl::OUString& sKey ,
const TValueType& aValue)
{
if (find(sKey) == end())
{
(*this)[sKey] = ::com::sun::star::uno::makeAny(aValue);
return sal_True;
}
return sal_False;
}
//---------------------------------------
/** @short can be used to generate a file dump of
the current content of this instance.
@descr Because the content of STL container
cant be analyzed easy, such dump function
seem to be usefull.
Of course its available in debug versions
only.
@param pFileName
a system file name.
(doesnt matter if relativ or absolute)
@param pComment
used to mark the dump inside the same log file.
Can be usefull to analyze changes of this
hash map due to the parts of an operation.
*/
#if OSL_DEBUG_LEVEL > 1
void dbg_dumpToFile(const char* pFileName, const char* pComment) const;
#endif
};
} // namespace comphelper
#endif // _COMPHELPER_SEQUENCEASHASHMAP_HXX_
|