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
363
364
365
366
367
368
369
370
371
372
|
/*************************************************************************
*
* 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: propertybaghelper.cxx,v $
* $Revision: 1.4 $
*
* 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.
*
************************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_forms.hxx"
#include "propertybaghelper.hxx"
#include "property.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/beans/PropertyExistException.hpp>
#include <com/sun/star/beans/XMultiPropertySet.hpp>
#include <com/sun/star/beans/NotRemoveableException.hpp>
#include <com/sun/star/beans/UnknownPropertyException.hpp>
/** === end UNO includes === **/
#include <tools/diagnose_ex.h>
#include <comphelper/sequence.hxx>
#include <rtl/logfile.hxx>
#include "rtl/instance.hxx"
#define NEW_HANDLE_BASE 10000
//........................................................................
namespace frm
{
//........................................................................
/** === begin UNO using === **/
using ::com::sun::star::lang::DisposedException;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::beans::Property;
using ::com::sun::star::uno::Any;
using ::com::sun::star::beans::PropertyExistException;
using ::com::sun::star::beans::PropertyValue;
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::beans::XMultiPropertySet;
using ::com::sun::star::beans::XPropertySetInfo;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::beans::NotRemoveableException;
using ::com::sun::star::beans::UnknownPropertyException;
/** === end UNO using === **/
namespace PropertyAttribute = ::com::sun::star::beans::PropertyAttribute;
//====================================================================
//= helper
//====================================================================
namespace
{
//----------------------------------------------------------------
static ::comphelper::IPropertyInfoService& lcl_getPropertyInfos()
{
static ConcreteInfoService s_aPropInfos;
return s_aPropInfos;
}
}
//====================================================================
//= PropertyBagHelper
//====================================================================
//--------------------------------------------------------------------
PropertyBagHelper::PropertyBagHelper( IPropertyBagHelperContext& _rContext )
:m_rContext( _rContext )
,m_pPropertyArrayHelper( NULL )
,m_bDisposed( false )
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::PropertyBagHelper" );
}
//--------------------------------------------------------------------
PropertyBagHelper::~PropertyBagHelper()
{
delete m_pPropertyArrayHelper, m_pPropertyArrayHelper = NULL;
}
//--------------------------------------------------------------------
void PropertyBagHelper::dispose()
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::dispose" );
m_bDisposed = true;
}
//--------------------------------------------------------------------
void PropertyBagHelper::impl_nts_checkDisposed_throw() const
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::impl_nts_checkDisposed_throw" );
if ( m_bDisposed )
throw DisposedException();
}
//--------------------------------------------------------------------
void PropertyBagHelper::impl_nts_invalidatePropertySetInfo()
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::impl_nts_invalidatePropertySetInfo" );
delete m_pPropertyArrayHelper, m_pPropertyArrayHelper = NULL;
}
//--------------------------------------------------------------------
sal_Int32 PropertyBagHelper::impl_findFreeHandle( const ::rtl::OUString& _rPropertyName )
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::impl_findFreeHandle" );
::comphelper::OPropertyArrayAggregationHelper& rPropInfo( impl_ts_getArrayHelper() );
// check the preferred handle
sal_Int32 nHandle = lcl_getPropertyInfos().getPreferedPropertyId( _rPropertyName );
if ( ( nHandle != -1 ) && rPropInfo.fillPropertyMembersByHandle( NULL, NULL, nHandle ) )
nHandle = -1;
// seach a free handle in <math>F_1009</math>
if ( nHandle == -1 )
{
sal_Int32 nPrime = 1009;
sal_Int32 nFactor = 11;
sal_Int32 nNum = nFactor;
while ( nNum != 1 )
{
if ( !rPropInfo.fillPropertyMembersByHandle( NULL, NULL, nNum + NEW_HANDLE_BASE ) )
{
// handle not used, yet
nHandle = nNum + NEW_HANDLE_BASE;
break;
}
nNum = ( nNum * nFactor ) % nPrime;
}
}
// search a free handle greater NEW_HANDLE_BASE
if ( nHandle == -1 )
{
nHandle = NEW_HANDLE_BASE + 1009;
while ( rPropInfo.fillPropertyMembersByHandle( NULL, NULL, nHandle ) )
++nHandle;
}
return nHandle;
}
//--------------------------------------------------------------------
::comphelper::OPropertyArrayAggregationHelper& PropertyBagHelper::impl_ts_getArrayHelper() const
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::impl_ts_getArrayHelper" );
//::osl::MutexGuard aGuard( m_rContext.getMutex() );
OPropertyArrayAggregationHelper* p = m_pPropertyArrayHelper;
if ( !p )
{
::osl::MutexGuard aGuard( m_rContext.getMutex() );
p = m_pPropertyArrayHelper;
if ( !p )
{
// our own fixed and our aggregate's properties
Sequence< Property > aFixedProps;
Sequence< Property > aAggregateProps;
m_rContext.describeFixedAndAggregateProperties( aFixedProps, aAggregateProps );
// our dynamic properties
Sequence< Property > aDynamicProps;
m_aDynamicProperties.describeProperties( aDynamicProps );
Sequence< Property > aOwnProps(
::comphelper::concatSequences( aFixedProps, aDynamicProps ) );
p = new OPropertyArrayAggregationHelper( aOwnProps, aAggregateProps, &lcl_getPropertyInfos(), NEW_HANDLE_BASE );
OSL_DOUBLE_CHECKED_LOCKING_MEMORY_BARRIER();
const_cast< PropertyBagHelper* >( this )->m_pPropertyArrayHelper = p;
}
} // if ( !p )
else
{
OSL_DOUBLE_CHECKED_LOCKING_MEMORY_BARRIER();
}
return *p;
}
//--------------------------------------------------------------------
void PropertyBagHelper::addProperty( const ::rtl::OUString& _rName, ::sal_Int16 _nAttributes, const Any& _rInitialValue )
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::addProperty" );
::osl::MutexGuard aGuard( m_rContext.getMutex() );
impl_nts_checkDisposed_throw();
//----------------------------------------------
// check name sanity
::comphelper::OPropertyArrayAggregationHelper& aPropInfo( impl_ts_getArrayHelper() );
if ( aPropInfo.hasPropertyByName( _rName ) )
throw PropertyExistException( _rName, m_rContext.getPropertiesInterface() );
//----------------------------------------------
// normalize the REMOVEABLE attribute - the FormComponent service
// requires that all dynamic properties are REMOVEABLE
_nAttributes |= PropertyAttribute::REMOVEABLE;
//----------------------------------------------
// find a free handle
sal_Int32 nHandle = impl_findFreeHandle( _rName );
//----------------------------------------------
// register the property, and invalidate our property meta data
m_aDynamicProperties.addProperty( _rName, nHandle, _nAttributes, _rInitialValue );
impl_nts_invalidatePropertySetInfo();
}
//--------------------------------------------------------------------
void PropertyBagHelper::removeProperty( const ::rtl::OUString& _rName )
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::removeProperty" );
::osl::MutexGuard aGuard( m_rContext.getMutex() );
impl_nts_checkDisposed_throw();
// check whether it's removeable at all
Reference< XMultiPropertySet > xMe( m_rContext.getPropertiesInterface(), UNO_QUERY_THROW );
Reference< XPropertySetInfo > xPSI( xMe->getPropertySetInfo(), UNO_QUERY_THROW );
Property aProperty( xPSI->getPropertyByName( _rName ) );
if ( ( aProperty.Attributes & PropertyAttribute::REMOVEABLE ) == 0 )
throw NotRemoveableException( _rName, xMe );
m_aDynamicProperties.removeProperty( _rName );
impl_nts_invalidatePropertySetInfo();
}
//--------------------------------------------------------------------
namespace
{
//----------------------------------------------------------------
struct SelectNameOfProperty : public ::std::unary_function< Property, ::rtl::OUString >
{
const ::rtl::OUString& operator()( const Property& _rProp ) const { return _rProp.Name; }
};
//----------------------------------------------------------------
struct SelectNameOfPropertyValue : public ::std::unary_function< PropertyValue, ::rtl::OUString >
{
const ::rtl::OUString& operator()( const PropertyValue& _rProp ) const { return _rProp.Name; }
};
//----------------------------------------------------------------
struct SelectValueOfPropertyValue : public ::std::unary_function< PropertyValue, Any >
{
const Any& operator()( const PropertyValue& _rProp ) const { return _rProp.Value; }
};
//----------------------------------------------------------------
struct PropertyValueLessByName : public ::std::binary_function< PropertyValue, PropertyValue, bool >
{
bool operator()( const PropertyValue& _lhs, const PropertyValue _rhs ) const
{
return _lhs.Name < _rhs.Name;
}
};
}
//--------------------------------------------------------------------
Sequence< PropertyValue > PropertyBagHelper::getPropertyValues()
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::getPropertyValues" );
::osl::MutexGuard aGuard( m_rContext.getMutex() );
impl_nts_checkDisposed_throw();
Reference< XMultiPropertySet > xMe( m_rContext.getPropertiesInterface(), UNO_QUERY_THROW );
Reference< XPropertySetInfo > xPSI( xMe->getPropertySetInfo(), UNO_QUERY_THROW );
Sequence< Property > aProperties( xPSI->getProperties() );
Sequence< ::rtl::OUString > aPropertyNames( aProperties.getLength() );
::std::transform( aProperties.getConstArray(), aProperties.getConstArray() + aProperties.getLength(),
aPropertyNames.getArray(), SelectNameOfProperty() );
Sequence< Any > aValues;
try
{
aValues = xMe->getPropertyValues( aPropertyNames );
if ( aValues.getLength() != aPropertyNames.getLength() )
throw RuntimeException();
}
catch( const RuntimeException& ) { throw; }
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
Sequence< PropertyValue > aPropertyValues( aValues.getLength() );
PropertyValue* pPropertyValue = aPropertyValues.getArray();
const ::rtl::OUString* pName = aPropertyNames.getConstArray();
const ::rtl::OUString* pNameEnd = aPropertyNames.getConstArray() + aPropertyNames.getLength();
const Any* pValue = aValues.getConstArray();
for ( ; pName != pNameEnd; ++pName, ++pValue, ++pPropertyValue )
{
pPropertyValue->Name = *pName;
pPropertyValue->Value = *pValue;
}
return aPropertyValues;
}
//--------------------------------------------------------------------
void PropertyBagHelper::setPropertyValues( const Sequence< PropertyValue >& _rProps )
{
// RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "forms", "dev@dba.openoffice.org", "PropertyBagHelper::setPropertyValues" );
::osl::ClearableMutexGuard aGuard( m_rContext.getMutex() );
impl_nts_checkDisposed_throw();
sal_Int32 nPropertyValues = _rProps.getLength();
// XMultiPropertySet::setPropertyValues expects its arguments to be sorted by name
// while XPropertyAccess::setPropertyValues doesn't. So first of all, sort.
Sequence< PropertyValue > aSortedProps( _rProps );
::std::sort( aSortedProps.getArray(), aSortedProps.getArray() + nPropertyValues, PropertyValueLessByName() );
// also, XPropertyAccess::setPropertyValues is expected to throw an UnknownPropertyException
// for unsupported properties, while XMultiPropertySet::setPropertyValues is expected to ignore
// those. So, check for unsupported properties first.
::comphelper::OPropertyArrayAggregationHelper& rArrayHelper( impl_ts_getArrayHelper() );
for ( const PropertyValue* pProperties = aSortedProps.getConstArray();
pProperties != aSortedProps.getConstArray() + nPropertyValues;
++pProperties
)
{
if ( !rArrayHelper.hasPropertyByName( pProperties->Name ) )
throw UnknownPropertyException( pProperties->Name, m_rContext.getPropertiesInterface() );
}
// Now finally split into a Name and a Value sequence, and forward to
// XMultiPropertySet::setPropertyValues
Sequence< ::rtl::OUString > aNames( nPropertyValues );
::std::transform( aSortedProps.getConstArray(), aSortedProps.getConstArray() + nPropertyValues,
aNames.getArray(), SelectNameOfPropertyValue() );
Sequence< Any > aValues( nPropertyValues );
::std::transform( aSortedProps.getConstArray(), aSortedProps.getConstArray() + nPropertyValues,
aValues.getArray(), SelectValueOfPropertyValue() );
Reference< XMultiPropertySet > xMe( m_rContext.getPropertiesInterface(), UNO_QUERY_THROW );
aGuard.clear();
xMe->setPropertyValues( aNames, aValues );
}
//........................................................................
} // namespace frm
//........................................................................
|
