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
|
/*!
* \file comp_attach_pt_t.h
* \brief OpenCSD : Component attachment point interface class.
*
* \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
*/
/*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ARM_COMP_ATTACH_PT_T_H_INCLUDED
#define ARM_COMP_ATTACH_PT_T_H_INCLUDED
#include <vector>
#include "opencsd/ocsd_if_types.h"
/** @defgroup ocsd_infrastructure OpenCSD Library : Library Component Infrastructure
@brief Classes providing library infrastructure and auxilary functionality
@{*/
#include "comp_attach_notifier_i.h"
/*!
* @class componentAttachPt
* @brief Single component interface pointer attachment point.
*
* This is a class template to standardise the connections between decode components.
*
* An attachment point connects a component interface pointer to the component providing the
* attachment point.
*
* This attachment point implementation allows a single interface to be connected.
*
*/
template <class T>
class componentAttachPt {
public:
componentAttachPt(); /**< Default constructor */
virtual ~componentAttachPt(); /**< Default destructor */
/*!
* Attach an interface of type T to the attachment point.
*
* @param component : interface to attach.
*
* @return ocsd_err_t : OCSD_OK if successful, OCSD_ERR_ATTACH_TOO_MANY if too many connections.
*/
virtual ocsd_err_t attach(T* component);
/*!
* Detach component from the attachment point.
*
* @param component : Component to detach.
*
* @return virtual ocsd_err_t : OCSD_OK if successful, OCSD_ERR_ATTACH_COMP_NOT_FOUND if no match to component.
*/
virtual ocsd_err_t detach(T* component);
// detach current first if anything attached, connect supplied pointer, remain unattached if pointer 0
virtual ocsd_err_t replace_first(T* component);
/*!
* Detach all components.
*/
virtual void detach_all();
/*!
* Return the current (first) attached interface pointer.
* Will return 0 if nothing attached or the attachment point is disabled.
*
* @return T* : Current Interface pointer of type T or 0.
*/
virtual T* first();
/*!
* Return the next attached interface.
* The componentAttachPt base implmentation will always return 0 as only a single attachment is possible
*
* @return T* : Always returns 0.
*/
virtual T* next();
/*!
* Returns the number of interface pointers attached to this attachment point.
*
* @return int : number of component interfaces attached.
*/
virtual int num_attached();
/*!
* Attach a notifier interface to the attachment point. Will call back on this interface whenever
* a component is attached or detached.
*
* @param *notifier : pointer to the IComponentAttachNotifier interface.
*/
void set_notifier(IComponentAttachNotifier *notifier);
/* enable state does not affect attach / detach, but can be used to filter access to interfaces */
const bool enabled() const; /**< return the enabled flag. */
void set_enabled(const bool enable);
/*!
* Check to see if any attachements. Will return attach state independent of enable state.
*
* @return const bool : true if attachment.
*/
const bool hasAttached() const { return m_hasAttached; };
/*!
* Return both the attachment and enabled state.
*
* @return const bool : true if both has attachment and is enabled.
*/
const bool hasAttachedAndEnabled() const { return m_hasAttached && m_enabled; };
protected:
bool m_enabled; /**< Flag to indicate if the attachment point is enabled. */
bool m_hasAttached; /**< Flag indicating at least one attached interface */
IComponentAttachNotifier *m_notifier; /**< Optional attachement notifier interface. */
T *m_comp; /**< pointer to the single attached interface */
};
template<class T> componentAttachPt<T>::componentAttachPt()
{
m_comp = 0;
m_notifier = 0;
m_enabled = true;
m_hasAttached = false;
}
template<class T> componentAttachPt<T>::~componentAttachPt()
{
detach_all();
}
template<class T> ocsd_err_t componentAttachPt<T>::attach(T* component)
{
if(m_comp != 0)
return OCSD_ERR_ATTACH_TOO_MANY;
m_comp = component;
if(m_notifier) m_notifier->attachNotify(1);
m_hasAttached = true;
return OCSD_OK;
}
template<class T> ocsd_err_t componentAttachPt<T>::replace_first(T* component)
{
if(m_hasAttached)
detach(m_comp);
if(component == 0)
return OCSD_OK;
return attach(component);
}
template<class T> ocsd_err_t componentAttachPt<T>::detach(T* component)
{
if(m_comp != component)
return OCSD_ERR_ATTACH_COMP_NOT_FOUND;
m_comp = 0;
m_hasAttached = false;
if(m_notifier) m_notifier->attachNotify(0);
return OCSD_OK;
}
template<class T> T* componentAttachPt<T>::first()
{
return (m_enabled) ? m_comp : 0;
}
template<class T> T* componentAttachPt<T>::next()
{
return 0;
}
template<class T> int componentAttachPt<T>::num_attached()
{
return ((m_comp != 0) ? 1 : 0);
}
template<class T> void componentAttachPt<T>::detach_all()
{
m_comp = 0;
m_hasAttached = false;
if(m_notifier) m_notifier->attachNotify(0);
}
template<class T> void componentAttachPt<T>::set_notifier(IComponentAttachNotifier *notifier)
{
m_notifier = notifier;
}
template<class T> const bool componentAttachPt<T>::enabled() const
{
return m_enabled;
}
template<class T> void componentAttachPt<T>::set_enabled(const bool enable)
{
m_enabled = enable;
}
/** @}*/
#endif // ARM_COMP_ATTACH_PT_T_H_INCLUDED
/* End of File comp_attach_pt_t.h */
|
