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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: cacheitem.hxx,v $
* $Revision: 1.6 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __FILTER_CONFIG_CACHEITEM_HXX_
#define __FILTER_CONFIG_CACHEITEM_HXX_
//_______________________________________________
// includes
#include <hash_map>
#include <deque>
#include <list>
#include <com/sun/star/uno/Any.h>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <comphelper/sequenceasvector.hxx>
#include <comphelper/sequenceashashmap.hxx>
#include <osl/mutex.hxx>
//_______________________________________________
// namespace
namespace filter{
namespace config{
namespace css = ::com::sun::star;
//_______________________________________________
// definitions
/** @short Must be used as first derived base class
to get a full initialized mutex member,
which can be used during the ctor runs too!
*/
struct BaseLock
{
public:
// must be mutable to be useable in const environments too!
mutable ::osl::Mutex m_aLock;
};
typedef ::comphelper::SequenceAsVector< ::rtl::OUString > OUStringList;
//_______________________________________________
/** @short represent an item of a FilterCache
instance.
@descr This class is not threadsafe tp perform
operations, which use many instances of
this class! Synchronizations must be done outside.
*/
class CacheItem : public ::comphelper::SequenceAsHashMap
{
//-------------------------------------------
public:
//---------------------------------------
/** @short creates an empty item.
*/
CacheItem();
//---------------------------------------
/** @short update only properties, which are given by the
specified rItem.
@descr Update means: - add new properties
- change existing values
@param rUpdateItem
another cache item, which contains some special
properties, which should by used for updating
this one.
*/
void update(const CacheItem& rUpdateItem);
//---------------------------------------
/** @short check, if the given properties exists
at this item.
@descr All properties are compared in its minimum.
E.g: string lists => only the requested items
are checked. Additional existing items are ignored.
@param lProps
contains all properties, which must exist at this item.
@return TRUE if all given properties exists
at this item; FALSE otherwhise.
*/
sal_Bool haveProps(const CacheItem& lProps) const;
//---------------------------------------
/** @short check, if the given properties dont exists
at this item.
@descr All properties are compared in its minimum.
E.g: string lists => only the requested items
are checked. Additional existing items are ignored.
@param lProps
contains all properties, which should not exists at this item.
@return FALSE if at least on property exists at this item(!);
TRUE otherwhise.
*/
sal_Bool dontHaveProps(const CacheItem& lProps) const;
//---------------------------------------
/** @short check, if the given properties dont exists
at this item.
@descr All properties are compared in its minimum.
E.g: string lists => only the specified items
are checked. Additional existing items are ignored.
@param lProps
contains all properties, which should be checked.
@return TRUE if all given properties dont exists
at this item; FALSE otherwhise.
*/
sal_Bool excludeProps(const CacheItem& lProps) const;
//---------------------------------------
/** @short because we know two UIName properties
(a list with all locales and the value
for the current locale only), we must be shure
that the correspond together.
@param sActLocale
must specify the current office locale.
Its needed to adress the UIName property inside
the list of possible ones.
*/
void validateUINames(const ::rtl::OUString& sActLocale);
//---------------------------------------
/** @short convert this structure to a seq< PropertyValue >
and ignore all empty properties!
@descr Normaly the converter routines of the base class
SequenceAsHashMap do this job already.
But it doesnt provide a "pack" mechanism to
ignore properties with empty (means "void") values.
@return css::uno::Sequence< css::beans::PropertyValue >
as a list of all properties of this cacheitem,
where empty properties was removed.
*/
css::uno::Sequence< css::beans::PropertyValue > getAsPackedPropertyValueList();
};
//_______________________________________________
/** @short represent an item list of a FilterCache
instance.
*/
typedef ::std::hash_map< ::rtl::OUString ,
CacheItem ,
::rtl::OUStringHash ,
::std::equal_to< ::rtl::OUString > > CacheItemList;
//_______________________________________________
/** @short supports registration of multiple key to
another string information.
@descr E.g. a list of internal type names can be registered
to an extension. Organization as an hash makes it
faster then searching inside vectors.
On the other side e.g. URLPattern cant be realy adressed
by a hash value ... because the use wildcards. But
there we need key-value pairs too, which cant be provided
by a pur vector!
*/
typedef ::std::hash_map< ::rtl::OUString ,
OUStringList ,
::rtl::OUStringHash ,
::std::equal_to< ::rtl::OUString > > CacheItemRegistration;
//_______________________________________________
/** @short is used to collect all matching types of an URL
during type detection.
@descr Every type in this list is combined with an information,
which property matched to the given URL. The user of this
structure can decide then, if a deep detection should be
supressed e.g. if an URLPattern was used.
*/
struct FlatDetectionInfo
{
// the internal type name
::rtl::OUString sType;
// this type was found by a matching the URL extension
sal_Bool bMatchByExtension;
// this type was found by a matching URL Pattern
sal_Bool bMatchByPattern;
// the user selected this type explicitly
sal_Bool bPreselectedAsType;
// the user selected this type implicit by selecting a corresponding filter
sal_Bool bPreselectedByFilter;
// the user selected this type implicit by selecting a corresponding office module
sal_Bool bPreselectedByDocumentService;
FlatDetectionInfo()
: sType (::rtl::OUString())
, bMatchByExtension (sal_False )
, bMatchByPattern (sal_False )
, bPreselectedAsType (sal_False )
, bPreselectedByFilter (sal_False )
, bPreselectedByDocumentService(sal_False )
{}
};
typedef ::std::list< FlatDetectionInfo > FlatDetection;
} // namespace config
} // namespace filter
#endif // __FILTER_CONFIG_CACHEITEM_HXX_
|
