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
|
/* -*- 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 INCLUDED_COMPHELPER_COMPONENTBASE_HXX
#define INCLUDED_COMPHELPER_COMPONENTBASE_HXX
#include <comphelper/comphelperdllapi.h>
#include <cppuhelper/interfacecontainer.h>
namespace comphelper
{
//= ComponentBase
class COMPHELPER_DLLPUBLIC ComponentBase
{
protected:
/** creates a ComponentBase instance
The instance is not initialized. As a consequence, every ComponentMethodGuard instantiated for
this component will throw a css::lang::NotInitializedException,
until ->setInitialized() is called.
*/
ComponentBase( ::cppu::OBroadcastHelper& _rBHelper )
:m_rBHelper( _rBHelper )
,m_bInitialized( false )
{
}
struct NoInitializationNeeded { };
/** creates a ComponentBase instance
The instance is already initialized, so there's no need to call setInitialized later on. Use this
constructor for component implementations which do not require explicit initialization.
*/
ComponentBase( ::cppu::OBroadcastHelper& _rBHelper, NoInitializationNeeded )
:m_rBHelper( _rBHelper )
,m_bInitialized( true )
{
}
~ComponentBase() COVERITY_NOEXCEPT_FALSE {}
/** marks the instance as initialized
Subsequent instantiations of a ComponentMethodGuard won't throw the NotInitializedException now.
*/
void setInitialized() { m_bInitialized = true; }
public:
/// helper struct to grant access to selected public methods to the ComponentMethodGuard class
struct GuardAccess { friend class ComponentMethodGuard; private: GuardAccess() { } };
/// retrieves the component's mutex
::osl::Mutex& getMutex( GuardAccess ) { return getMutex(); }
/// checks whether the component is already disposed, throws a DisposedException if so.
void checkDisposed( GuardAccess ) const;
/// checks whether the component is already initialized, throws a NotInitializedException if not.
void checkInitialized( GuardAccess ) const;
protected:
/// retrieves the component's broadcast helper
::cppu::OBroadcastHelper& getBroadcastHelper() { return m_rBHelper; }
/// retrieves the component's mutex
::osl::Mutex& getMutex() { return m_rBHelper.rMutex; }
/// determines whether the instance is already disposed
bool impl_isDisposed() const { return m_rBHelper.bDisposed; }
/// determines whether the component is already initialized
bool
impl_isInitialized_nothrow() const { return m_bInitialized; }
/** returns the context to be used when throwing exceptions
The default implementation returns <NULL/>.
*/
static css::uno::Reference< css::uno::XInterface >
getComponent();
private:
::cppu::OBroadcastHelper& m_rBHelper;
bool m_bInitialized;
};
class ComponentMethodGuard
{
public:
enum class MethodType
{
/// allow the method to be called only when being initialized and not being disposed
Default,
/// allow the method to be called without being initialized
WithoutInit
};
ComponentMethodGuard( ComponentBase& _rComponent, const MethodType _eType = MethodType::Default )
:m_aMutexGuard( _rComponent.getMutex( ComponentBase::GuardAccess() ) )
{
if ( _eType != MethodType::WithoutInit )
_rComponent.checkInitialized( ComponentBase::GuardAccess() );
_rComponent.checkDisposed( ComponentBase::GuardAccess() );
}
void clear()
{
m_aMutexGuard.clear();
}
private:
osl::ClearableMutexGuard m_aMutexGuard;
};
} // namespace ComponentBase
#endif // INCLUDED_COMPHELPER_COMPONENTBASE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
