/
Reference.h
213 lines (190 loc) · 5.7 KB
/
Reference.h
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
/**
* MaNGOS is a full featured server for World of Warcraft, supporting
* the following clients: 1.12.x, 2.4.3, 3.3.5a, 4.3.4a and 5.4.8
*
* Copyright (C) 2005-2019 MaNGOS project <https://getmangos.eu>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* World of Warcraft, and all World of Warcraft or Warcraft art, images,
* and lore are copyrighted by Blizzard Entertainment, Inc.
*/
#ifndef MANGOS_H_REFERENCE
#define MANGOS_H_REFERENCE
#include "Utilities/LinkedList.h"
//=====================================================
template<class TO, class FROM>
/**
* @brief
*
*/
class Reference : public LinkedListElement
{
private:
TO* iRefTo; /**< TODO */
FROM* iRefFrom; /**< TODO */
protected:
/**
* @brief Tell our refTo (target) object that we have a link
*
*/
virtual void targetObjectBuildLink() = 0;
/**
* @brief Tell our refTo (taget) object, that the link is cut
*
*/
virtual void targetObjectDestroyLink() = 0;
/**
* @brief Tell our refFrom (source) object, that the link is cut (Target destroyed)
*
*/
virtual void sourceObjectDestroyLink() = 0;
public:
/**
* @brief
*
*/
Reference()
: iRefTo(NULL), iRefFrom(NULL)
{
}
/**
* @brief
*
*/
virtual ~Reference() {}
/**
* @brief Create new link
*
* @param toObj
* @param fromObj
*/
void link(TO* toObj, FROM* fromObj)
{
assert(fromObj); // fromObj MUST not be NULL
if (isValid())
{ unlink(); }
if (toObj != NULL)
{
iRefTo = toObj;
iRefFrom = fromObj;
targetObjectBuildLink();
}
}
/**
* @brief We don't need the reference anymore.
*
* Call comes from the refFrom object. Tell our refTo object, that the
* link is cut.
*
*/
void unlink()
{
targetObjectDestroyLink();
delink();
iRefTo = NULL;
iRefFrom = NULL;
}
/**
* @brief Link is invalid due to destruction of referenced target object.
*
* Call comes from the refTo object. Tell our refFrom object, that the
* link is cut.
*
*/
void invalidate() // the iRefFrom MUST remain!!
{
sourceObjectDestroyLink();
delink();
iRefTo = NULL;
}
/**
* @brief
*
* @return bool
*/
bool isValid() const // Only check the iRefTo
{
return iRefTo != NULL;
}
/**
* @brief
*
* @return Reference<TO, FROM>
*/
Reference<TO, FROM>* next() { return((Reference<TO, FROM>*) LinkedListElement::next()); }
/**
* @brief
*
* @return const Reference<TO, FROM>
*/
Reference<TO, FROM> const* next() const { return((Reference<TO, FROM> const*) LinkedListElement::next()); }
/**
* @brief
*
* @return Reference<TO, FROM>
*/
Reference<TO, FROM>* prev() { return((Reference<TO, FROM>*) LinkedListElement::prev()); }
/**
* @brief
*
* @return const Reference<TO, FROM>
*/
Reference<TO, FROM> const* prev() const { return((Reference<TO, FROM> const*) LinkedListElement::prev()); }
/**
* @brief
*
* @return Reference<TO, FROM>
*/
Reference<TO, FROM>* nocheck_next() { return((Reference<TO, FROM>*) LinkedListElement::nocheck_next()); }
/**
* @brief
*
* @return const Reference<TO, FROM>
*/
Reference<TO, FROM> const* nocheck_next() const { return((Reference<TO, FROM> const*) LinkedListElement::nocheck_next()); }
/**
* @brief
*
* @return Reference<TO, FROM>
*/
Reference<TO, FROM>* nocheck_prev() { return((Reference<TO, FROM>*) LinkedListElement::nocheck_prev()); }
/**
* @brief
*
* @return const Reference<TO, FROM>
*/
Reference<TO, FROM> const* nocheck_prev() const { return((Reference<TO, FROM> const*) LinkedListElement::nocheck_prev()); }
/**
* @brief
*
* @return TO *operator ->
*/
TO* operator->() const { return iRefTo; }
/**
* @brief
*
* @return TO
*/
TO* getTarget() const { return iRefTo; }
/**
* @brief
*
* @return FROM
*/
FROM* getSource() const { return iRefFrom; }
};
//=====================================================
#endif