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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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 _DBA_COREDATAACCESS_MODELIMPL_HXX_
#define _DBA_COREDATAACCESS_MODELIMPL_HXX_
#include "apitools.hxx"
#include "bookmarkcontainer.hxx"
#include "ContentHelper.hxx"
#include "core_resource.hxx"
#include "documentevents.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/beans/XPropertyAccess.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/document/XDocumentSubStorageSupplier.hpp>
#include <com/sun/star/document/XEventListener.hpp>
#include <com/sun/star/document/XStorageBasedDocument.hpp>
#include <com/sun/star/embed/ElementModes.hpp>
#include <com/sun/star/embed/XStorage.hpp>
#include <com/sun/star/embed/XTransactionListener.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/frame/XStorable.hpp>
#include <com/sun/star/lang/NotInitializedException.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/sdb/XBookmarksSupplier.hpp>
#include <com/sun/star/sdb/XCompletedConnection.hpp>
#include <com/sun/star/sdb/XFormDocumentsSupplier.hpp>
#include <com/sun/star/sdb/XQueryDefinitionsSupplier.hpp>
#include <com/sun/star/sdb/XReportDocumentsSupplier.hpp>
#include <com/sun/star/sdbc/XDataSource.hpp>
#include <com/sun/star/sdbc/XIsolatedConnection.hpp>
#include <com/sun/star/sdbcx/XTablesSupplier.hpp>
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/util/XFlushable.hpp>
#include <com/sun/star/util/XModifiable.hpp>
#include <com/sun/star/util/XNumberFormatsSupplier.hpp>
#include <com/sun/star/util/XNumberFormatter.hpp>
#include <com/sun/star/util/XRefreshable.hpp>
#include <com/sun/star/sdb/XDocumentDataSource.hpp>
#include <com/sun/star/frame/DoubleInitializationException.hpp>
/** === end UNO includes === **/
#include <comphelper/broadcasthelper.hxx>
#include <comphelper/proparrhlp.hxx>
#include <comphelper/sharedmutex.hxx>
#include <connectivity/CommonTools.hxx>
#include <cppuhelper/propshlp.hxx>
#include <cppuhelper/weakref.hxx>
#include <sfx2/docmacromode.hxx>
#include <sfx2/docstoragemodifylistener.hxx>
#include <tools/string.hxx>
#include <unotools/sharedunocomponent.hxx>
#include <vos/mutex.hxx>
#include <memory>
namespace comphelper
{
class NamedValueCollection;
}
//........................................................................
namespace dbaccess
{
//........................................................................
typedef ::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XConnection > OWeakConnection;
typedef std::vector< OWeakConnection > OWeakConnectionArray;
struct AsciiPropertyValue
{
// note: the canonic member order would be AsciiName / DefaultValue, but
// this crashes on unxlngi6.pro, since there's a bug which somehow results in
// getDefaultDataSourceSettings returning corrupted Any instances then.
::com::sun::star::uno::Any DefaultValue;
const sal_Char* AsciiName;
const ::com::sun::star::uno::Type& ValueType;
AsciiPropertyValue()
:DefaultValue( )
,AsciiName( NULL )
,ValueType( ::cppu::UnoType< ::cppu::UnoVoidType >::get() )
{
}
AsciiPropertyValue( const sal_Char* _pAsciiName, const ::com::sun::star::uno::Any& _rDefaultValue )
:DefaultValue( _rDefaultValue )
,AsciiName( _pAsciiName )
,ValueType( _rDefaultValue.getValueType() )
{
OSL_ENSURE( ValueType.getTypeClass() != ::com::sun::star::uno::TypeClass_VOID,
"AsciiPropertyValue::AsciiPropertyValue: NULL values not allowed here, use the other CTOR for this!" );
}
AsciiPropertyValue( const sal_Char* _pAsciiName, const ::com::sun::star::uno::Type& _rValeType )
:DefaultValue()
,AsciiName( _pAsciiName )
,ValueType( _rValeType )
{
OSL_ENSURE( ValueType.getTypeClass() != ::com::sun::star::uno::TypeClass_VOID,
"AsciiPropertyValue::AsciiPropertyValue: VOID property values not supported!" );
}
};
class ODatabaseContext;
class OSharedConnectionManager;
//============================================================
//= VosMutexFacade
//============================================================
/** a class which provides an IMutex interface to an OSL-based mutex
*/
class VosMutexFacade : public ::vos::IMutex
{
public:
/** beware of life time: the mutex you pass here must live as least as long
as the VosMutexFacade instance lives.
*/
VosMutexFacade( ::osl::Mutex& _rMutex );
// IMutex
virtual void SAL_CALL acquire();
virtual sal_Bool SAL_CALL tryToAcquire();
virtual void SAL_CALL release();
private:
::osl::Mutex& m_rMutex;
};
//============================================================
//= ODatabaseModelImpl
//============================================================
typedef ::utl::SharedUNOComponent< ::com::sun::star::embed::XStorage > SharedStorage;
class ODatabaseContext;
class DocumentStorageAccess;
class OSharedConnectionManager;
class ODatabaseModelImpl :public ::rtl::IReference
,public ::sfx2::IMacroDocumentAccess
,public ::sfx2::IModifiableDocument
{
public:
enum ObjectType
{
E_FORM = 0,
E_REPORT = 1,
E_QUERY = 2,
E_TABLE = 3
};
enum EmbeddedMacros
{
// the database document (storage) itself contains macros
eDocumentWideMacros,
// there are sub document( storage)s containing macros
eSubDocumentMacros,
// there are no known macro( storage)s
eNoMacros
};
private:
OModuleClient m_aModuleClient;
::com::sun::star::uno::WeakReference< ::com::sun::star::frame::XModel > m_xModel;
::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XDataSource > m_xDataSource;
DocumentStorageAccess* m_pStorageAccess;
::comphelper::SharedMutex m_aMutex;
VosMutexFacade m_aMutexFacade;
::std::vector< TContentPtr > m_aContainer; // one for each ObjectType
::sfx2::DocumentMacroMode m_aMacroMode;
sal_Int16 m_nImposedMacroExecMode;
::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer > m_xBasicLibraries;
::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer > m_xDialogLibraries;
SharedStorage m_xDocumentStorage;
::rtl::Reference< ::sfx2::DocumentStorageModifyListener > m_pStorageModifyListener;
ODatabaseContext* m_pDBContext;
DocumentEventsData m_aDocumentEvents;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > m_aArgs;
/// the URL the document was loaded from
::rtl::OUString m_sDocFileLocation;
oslInterlockedCount m_refCount;
/// do we have any object (forms/reports) which contains macros?
::boost::optional< EmbeddedMacros > m_aEmbeddedMacros;
/// true if setting the Modified flag of the document is currently locked
bool m_bModificationLock;
/// true if and only if a database document existed previously (though meanwhile disposed), and was already initialized
bool m_bDocumentInitialized;
/** the URL which the document should report as it's URL
This might differ from ->m_sDocFileLocation in case the document was loaded
as part of a crash recovery process. In this case, ->m_sDocFileLocation points to
the temporary file where the DB had been saved to, after a crash.
->m_sDocumentURL then is the URL of the document which actually had
been recovered.
*/
::rtl::OUString m_sDocumentURL;
public:
OWeakConnectionArray m_aConnections;
const ::comphelper::ComponentContext m_aContext;
public:
::com::sun::star::uno::WeakReference< ::com::sun::star::container::XNameAccess > m_xCommandDefinitions;
::com::sun::star::uno::WeakReference< ::com::sun::star::container::XNameAccess > m_xTableDefinitions;
::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >
m_xNumberFormatsSupplier;
::rtl::OUString m_sConnectURL;
::rtl::OUString m_sName; // transient, our creator has to tell us the title
::rtl::OUString m_sUser;
::rtl::OUString m_aPassword; // transient !
::rtl::OUString m_sFailedPassword;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>
m_aLayoutInformation;
sal_Int32 m_nLoginTimeout;
sal_Bool m_bReadOnly : 1;
sal_Bool m_bPasswordRequired : 1;
sal_Bool m_bSuppressVersionColumns : 1;
sal_Bool m_bModified : 1;
sal_Bool m_bDocumentReadOnly : 1;
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyAccess >
m_xSettings;
::com::sun::star::uno::Sequence< ::rtl::OUString > m_aTableFilter;
::com::sun::star::uno::Sequence< ::rtl::OUString > m_aTableTypeFilter;
OSharedConnectionManager* m_pSharedConnectionManager;
::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >
m_xSharedConnectionManager;
sal_uInt16 m_nControllerLockCount;
void reset();
/** determines whether the database document has an embedded data storage
*/
inline bool isEmbeddedDatabase() const { return ( m_sConnectURL.compareToAscii( "sdbc:embedded:", 14 ) == 0 ); }
/** stores the embedded storage ("database")
@param _bPreventRootCommits
Normally, committing the embedded storage results in also commiting the root storage
- this is an automatism for data safety reasons.
If you pass <TRUE/> here, committing the root storage is prevented for this particular
call.
@return <TRUE/> if the storage could be commited, otherwise <FALSE/>
*/
bool commitEmbeddedStorage( bool _bPreventRootCommits = false );
/// commits all sub storages
void commitStorages()
SAL_THROW(( ::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException ));
ODatabaseModelImpl(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory,
ODatabaseContext& _pDBContext
);
virtual ~ODatabaseModelImpl();
ODatabaseModelImpl(
const ::rtl::OUString& _rRegistrationName,
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory,
ODatabaseContext& _rDBContext
);
// XEventListener
void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw(::com::sun::star::uno::RuntimeException);
void setModified( sal_Bool bModified );
void dispose();
inline ::rtl::OUString getURL() const { return m_sDocumentURL; }
inline ::rtl::OUString getDocFileLocation() const { return m_sDocFileLocation; }
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
getStorage(
const ObjectType _eType, const sal_Int32 _nDesiredMode = ::com::sun::star::embed::ElementModes::READWRITE );
// helper
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >&
getNumberFormatsSupplier();
DocumentEventsData&
getDocumentEvents() { return m_aDocumentEvents; }
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >&
getResource() const { return m_aArgs; }
void attachResource(
const ::rtl::OUString& _rURL,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArgs );
static ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >
stripLoadArguments( const ::comphelper::NamedValueCollection& _rArguments );
// other stuff
void flushTables();
// disposes all elements in m_aStorages, and clears it
void disposeStorages() SAL_THROW(());
/// creates a ->com::sun::star::embed::StorageFactory
::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory >
createStorageFactory() const;
/// commits our storage
void commitRootStorage();
/// commits a given storage if it's not readonly
static bool commitStorageIfWriteable(
const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage
)
SAL_THROW((
::com::sun::star::io::IOException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException
));
/// commits a given storage if it's not readonly, ignoring (but asserting) all errors
static bool commitStorageIfWriteable_ignoreErrors(
const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage
)
SAL_THROW(());
void clearConnections();
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > getOrCreateRootStorage();
inline ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > getRootStorage() const { return m_xDocumentStorage.getTyped(); }
inline void resetRootStroage() { impl_switchToStorage_throw( NULL ); }
/** returns the data source. If it doesn't exist it will be created
*/
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource> getOrCreateDataSource();
/** returns the model, if there already exists one
*/
::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > getModel_noCreate() const;
/** returns a new ->ODatabaseDocument
@param _bInitializeIfNecessary
calls XLoadable::initNew on the newly created model, if necessary
@precond
No ->ODatabaseDocument exists so far
@seealso
getModel_noCreate
*/
::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > createNewModel_deliverOwnership( bool _bInitialize );
struct ResetModelAccess { friend class ODatabaseDocument; private: ResetModelAccess() { } };
/** resets the model to NULL
Only to be called when the model is being disposed
*/
void modelIsDisposing( const bool _wasInitialized, ResetModelAccess );
bool hadInitializedDocument() const { return m_bDocumentInitialized; }
DocumentStorageAccess*
getDocumentStorageAccess();
::com::sun::star::uno::Reference< ::com::sun::star::document::XDocumentSubStorageSupplier >
getDocumentSubStorageSupplier();
inline const ::comphelper::SharedMutex& getSharedMutex() const { return m_aMutex; }
/** @see osl_incrementInterlockedCount.
*/
virtual oslInterlockedCount SAL_CALL acquire();
/** @see osl_decrementInterlockedCount.
*/
virtual oslInterlockedCount SAL_CALL release();
/// returns a all known data source settings, including their default values
static const AsciiPropertyValue* getDefaultDataSourceSettings();
/** retrieves the requested container of objects (forms/reports/tables/queries)
*/
TContentPtr& getObjectContainer( const ObjectType _eType );
/** returns the name of the storage which is used to stored objects of the given type, if applicable
*/
static ::rtl::OUString
getObjectContainerStorageName( const ObjectType _eType );
/** revokes the data source registration at the database context
*/
void revokeDataSource() const;
/** determines whether a given object storage contains macros
*/
static bool objectHasMacros(
const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxContainerStorage,
const ::rtl::OUString& _rPersistentName
);
/** determines which kind of embedded macros are present in the document
*/
EmbeddedMacros determineEmbeddedMacros();
/** checks our document's macro execution mode, using the interaction handler as supplied with our
load arguments
*/
bool checkMacrosOnLoading();
/** adjusts our document's macro execution mode, without using any UI, assuming the user
would reject execution of macros, if she would have been asked.
If checkMacrosOnLoading has been called before (and thus the macro execution mode
is already adjusted), then the current execution mode is simply returned.
@return
whether or not macro execution is allowed
*/
bool adjustMacroMode_AutoReject();
/** resets our macro execute mode, so next time the checkMacrosOnLoading is called, it will
behave as if it has never been called before
*/
void resetMacroExecutionMode();
/** ensures that ->m_xBasicLibraries resp. m_xDialogLibraries exists
@return
the requested library container. Is never <NULL/>.
@throws RuntimeException
if something does wrong, which indicates a server error in the installation
*/
::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer >
getLibraryContainer( bool _bScript );
/** lets our library containers store themself into the given root storage
*/
void storeLibraryContainersTo( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxToRootStorage );
/** rebases the document to the given storage
No actual committing, copying, saving, whatsoever happens. The storage is just remembered as the documents
new storage, nothing more.
@throws ::com::sun::star::lang::IllegalArgumentException
if the given storage is <NULL/>
@throws ::com::sun::star::lang::RuntimeException
if any of the invoked operations does so
*/
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
switchToStorage(
const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxNewRootStorage
);
/** switches to the given document location/URL
The document location is the URL of the file from which the document has been loaded.
The document URL is the "intended location" of the document. It differs from the location
if and only if the document was loaded as part of a document recovery process. In this case,
the location points to some temporary file, but the URL is the URL of the file which has been
just recovered. The next store operation would operate on the URL, not the location.
*/
void switchToURL(
const ::rtl::OUString& _rDocumentLocation,
const ::rtl::OUString& _rDocumentURL
);
/** returns the macro mode imposed by an external instance, which passed it to attachResource
*/
sal_Int16 getImposedMacroExecMode() const
{
return m_nImposedMacroExecMode;
}
void setImposedMacroExecMode( const sal_Int16 _nMacroMode )
{
m_nImposedMacroExecMode = _nMacroMode;
}
public:
// IMacroDocumentAccess overridables
virtual sal_Int16 getCurrentMacroExecMode() const;
virtual sal_Bool setCurrentMacroExecMode( sal_uInt16 );
virtual ::rtl::OUString getDocumentLocation() const;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage > getZipStorageToSign();
virtual sal_Bool documentStorageHasMacros() const;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::document::XEmbeddedScripts > getEmbeddedDocumentScripts() const;
virtual sal_Int16 getScriptingSignatureState();
virtual sal_Bool hasTrustedScriptingSignature( sal_Bool bAllowUIToAddAuthor );
virtual void showBrokenSignatureWarning( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& _rxInteraction ) const;
// IModifiableDocument
virtual void storageIsModified();
// don't use directly, use the ModifyLock class instead
void lockModify() { m_bModificationLock = true; }
void unlockModify() { m_bModificationLock = false; }
bool isModifyLocked() const { return m_bModificationLock; }
private:
void impl_construct_nothrow();
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
impl_switchToStorage_throw( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxNewRootStorage );
};
/** a small base class for UNO components whose functionality depends on a ODatabaseModelImpl
*/
class ModelDependentComponent
{
protected:
::rtl::Reference< ODatabaseModelImpl > m_pImpl;
mutable ::comphelper::SharedMutex m_aMutex;
protected:
ModelDependentComponent( const ::rtl::Reference< ODatabaseModelImpl >& _model );
virtual ~ModelDependentComponent();
/** returns the component itself
*/
virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getThis() const = 0;
inline ::osl::Mutex& getMutex() const
{
return m_aMutex;
}
public:
struct GuardAccess { friend class ModelMethodGuard; private: GuardAccess() { } };
/** returns the mutex used for thread safety
@throws ::com::sun::star::lang::DisposedException
if m_pImpl is <NULL/>. Usually, you will set this member in your derived
component's <code>dispose</code> method to <NULL/>.
*/
inline ::osl::Mutex& getMutex( GuardAccess ) const
{
return getMutex();
}
inline ::rtl::Reference< ODatabaseModelImpl > getImpl( GuardAccess )
{
return m_pImpl;
}
/// checks whether the component is already disposed, throws a DisposedException if so
inline void checkDisposed() const
{
if ( !m_pImpl.is() )
throw ::com::sun::star::lang::DisposedException( ::rtl::OUString::createFromAscii( "Component is already disposed." ), getThis() );
}
inline void lockModify()
{
m_pImpl->lockModify();
}
inline void unlockModify()
{
m_pImpl->unlockModify();
}
};
class ModifyLock
{
public:
ModifyLock( ModelDependentComponent& _component )
:m_rComponent( _component )
{
m_rComponent.lockModify();
}
~ModifyLock()
{
m_rComponent.unlockModify();
}
private:
ModelDependentComponent& m_rComponent;
};
/** a guard for public methods of objects dependent on a ODatabaseModelImpl instance
Just put this guard onto the stack at the beginning of your method. Don't bother yourself
with a MutexGuard, checks for being disposed, and the like.
*/
class ModelMethodGuard : public ::osl::ResettableMutexGuard
{
private:
typedef ::osl::ResettableMutexGuard BaseMutexGuard;
public:
/** constructs the guard
@param _component
the component whose functionality depends on a ODatabaseModelImpl instance
@throws ::com::sun::star::lang::DisposedException
If the given component is already disposed
*/
ModelMethodGuard( const ModelDependentComponent& _component )
:BaseMutexGuard( _component.getMutex( ModelDependentComponent::GuardAccess() ) )
{
_component.checkDisposed();
}
~ModelMethodGuard()
{
}
};
//........................................................................
} // namespace dbaccess
//........................................................................
#endif // _DBA_COREDATAACCESS_DATALINK_HXX_
|
