- 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
/* jshint -W097 */
/**
* @memberof PIXI
*/
export class SignalBinding<CbType>
{
_fn: any;
_once: boolean;
_next: SignalBinding<CbType>;
_prev: SignalBinding<CbType>;
_owner: Signal<CbType>;
_thisArg: any;
/**
* SignalBinding constructor.
* @constructs SignalBinding
* @param {Function} fn - Event handler to be called.
* @param {boolean} [once=false] - Should this listener be removed after dispatch
* @param {object} [thisArg] - The context of the callback function.
* @api private
*/
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
constructor(fn: CbType, once = false, thisArg: any)
{
this._fn = fn;
this._once = once;
this._thisArg = thisArg;
this._next = this._prev = this._owner = null;
}
detach(): boolean
{
if (this._owner === null) return false;
this._owner.detach(this);
return true;
}
}
/**
* @param self
* @param node
* @private
*/
function _addSignalBinding<CbType>(self: Signal<CbType>, node: SignalBinding<CbType>)
{
if (!self._head)
{
self._head = node;
self._tail = node;
}
else
{
self._tail._next = node;
node._prev = self._tail;
self._tail = node;
}
node._owner = self;
return node;
}
/**
* @memberof PIXI
*/
export class Signal<CbType = (...args: any) => void>
{
_head: SignalBinding<CbType>;
_tail: SignalBinding<CbType>;
/**
* MiniSignal constructor.
* @example
* let mySignal = new Signal();
* let binding = mySignal.add(onSignal);
* mySignal.dispatch('foo', 'bar');
* mySignal.detach(binding);
*/
constructor()
{
this._head = this._tail = undefined;
}
/**
* Return an array of attached SignalBinding.
* @param {boolean} [exists=false] - We only need to know if there are handlers.
* @returns {PIXI.SignalBinding[] | boolean} Array of attached SignalBinding or Boolean if called with exists = true
* @api public
*/
handlers(exists = false): Array<SignalBinding<CbType>> | boolean
{
let node = this._head;
if (exists) return !!node;
const ee = [];
while (node)
{
ee.push(node);
node = node._next;
}
return ee;
}
/**
* Return true if node is a SignalBinding attached to this MiniSignal
* @param {PIXI.SignalBinding} node - Node to check.
* @returns {boolean} True if node is attache to mini-signal
*/
has(node: SignalBinding<CbType>): boolean
{
if (!(node instanceof SignalBinding))
{
throw new Error('MiniSignal#has(): First arg must be a SignalBinding object.');
}
return node._owner === this;
}
/**
* Dispaches a signal to all registered listeners.
* @param {...any} args
* @returns {boolean} Indication if we've emitted an event.
*/
dispatch(...args: any[]): boolean
{
let node = this._head;
if (!node) return false;
while (node)
{
if (node._once) this.detach(node);
node._fn.apply(node._thisArg, args);
node = node._next;
}
return true;
}
/**
* Register a new listener.
* @param {Function} fn - Callback function.
* @param {object} [thisArg] - The context of the callback function.
* @returns {PIXI.SignalBinding} The SignalBinding node that was added.
*/
add(fn: CbType, thisArg: any = null): SignalBinding<CbType>
{
if (typeof fn !== 'function')
{
throw new Error('MiniSignal#add(): First arg must be a Function.');
}
return _addSignalBinding<CbType>(this, new SignalBinding<CbType>(fn, false, thisArg));
}
/**
* Register a new listener that will be executed only once.
* @param {Function} fn - Callback function.
* @param {object} [thisArg] - The context of the callback function.
* @returns {PIXI.SignalBinding} The SignalBinding node that was added.
*/
once(fn: CbType, thisArg: any = null): SignalBinding<CbType>
{
if (typeof fn !== 'function')
{
throw new Error('MiniSignal#once(): First arg must be a Function.');
}
return _addSignalBinding<CbType>(this, new SignalBinding<CbType>(fn, true, thisArg));
}
/**
* Remove binding object.
* @param {PIXI.SignalBinding} node - The binding node that will be removed.
* @returns {Signal} The instance on which this method was called.
@api public */
detach(node: SignalBinding<CbType>): this
{
if (!(node instanceof SignalBinding))
{
throw new Error('MiniSignal#detach(): First arg must be a SignalBinding object.');
}
if (node._owner !== this) return this; // todo: or error?
if (node._prev) node._prev._next = node._next;
if (node._next) node._next._prev = node._prev;
if (node === this._head)
{ // first node
this._head = node._next;
if (node._next === null)
{
this._tail = null;
}
}
else if (node === this._tail)
{ // last node
this._tail = node._prev;
this._tail._next = null;
}
node._owner = null;
return this;
}
/**
* Detach all listeners.
* @returns {Signal} The instance on which this method was called.
*/
detachAll(): this
{
let node = this._head;
if (!node) return this;
this._head = this._tail = null;
while (node)
{
node._owner = null;
node = node._next;
}
return this;
}
}