events.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. // Copyright Joyent, Inc. and other Node contributors.
  2. //
  3. // Permission is hereby granted, free of charge, to any person obtaining a
  4. // copy of this software and associated documentation files (the
  5. // "Software"), to deal in the Software without restriction, including
  6. // without limitation the rights to use, copy, modify, merge, publish,
  7. // distribute, sublicense, and/or sell copies of the Software, and to permit
  8. // persons to whom the Software is furnished to do so, subject to the
  9. // following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included
  12. // in all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15. // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16. // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
  17. // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  18. // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  19. // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20. // USE OR OTHER DEALINGS IN THE SOFTWARE.
  21. var objectCreate = Object.create || objectCreatePolyfill
  22. var objectKeys = Object.keys || objectKeysPolyfill
  23. var bind = Function.prototype.bind || functionBindPolyfill
  24. function EventEmitter() {
  25. if (!this._events || !Object.prototype.hasOwnProperty.call(this, '_events')) {
  26. this._events = objectCreate(null);
  27. this._eventsCount = 0;
  28. }
  29. this._maxListeners = this._maxListeners || undefined;
  30. }
  31. module.exports = EventEmitter;
  32. // Backwards-compat with node 0.10.x
  33. EventEmitter.EventEmitter = EventEmitter;
  34. EventEmitter.prototype._events = undefined;
  35. EventEmitter.prototype._maxListeners = undefined;
  36. // By default EventEmitters will print a warning if more than 10 listeners are
  37. // added to it. This is a useful default which helps finding memory leaks.
  38. var defaultMaxListeners = 10;
  39. var hasDefineProperty;
  40. try {
  41. var o = {};
  42. if (Object.defineProperty) Object.defineProperty(o, 'x', { value: 0 });
  43. hasDefineProperty = o.x === 0;
  44. } catch (err) { hasDefineProperty = false }
  45. if (hasDefineProperty) {
  46. Object.defineProperty(EventEmitter, 'defaultMaxListeners', {
  47. enumerable: true,
  48. get: function() {
  49. return defaultMaxListeners;
  50. },
  51. set: function(arg) {
  52. // check whether the input is a positive number (whose value is zero or
  53. // greater and not a NaN).
  54. if (typeof arg !== 'number' || arg < 0 || arg !== arg)
  55. throw new TypeError('"defaultMaxListeners" must be a positive number');
  56. defaultMaxListeners = arg;
  57. }
  58. });
  59. } else {
  60. EventEmitter.defaultMaxListeners = defaultMaxListeners;
  61. }
  62. // Obviously not all Emitters should be limited to 10. This function allows
  63. // that to be increased. Set to zero for unlimited.
  64. EventEmitter.prototype.setMaxListeners = function setMaxListeners(n) {
  65. if (typeof n !== 'number' || n < 0 || isNaN(n))
  66. throw new TypeError('"n" argument must be a positive number');
  67. this._maxListeners = n;
  68. return this;
  69. };
  70. function $getMaxListeners(that) {
  71. if (that._maxListeners === undefined)
  72. return EventEmitter.defaultMaxListeners;
  73. return that._maxListeners;
  74. }
  75. EventEmitter.prototype.getMaxListeners = function getMaxListeners() {
  76. return $getMaxListeners(this);
  77. };
  78. // These standalone emit* functions are used to optimize calling of event
  79. // handlers for fast cases because emit() itself often has a variable number of
  80. // arguments and can be deoptimized because of that. These functions always have
  81. // the same number of arguments and thus do not get deoptimized, so the code
  82. // inside them can execute faster.
  83. function emitNone(handler, isFn, self) {
  84. if (isFn)
  85. handler.call(self);
  86. else {
  87. var len = handler.length;
  88. var listeners = arrayClone(handler, len);
  89. for (var i = 0; i < len; ++i)
  90. listeners[i].call(self);
  91. }
  92. }
  93. function emitOne(handler, isFn, self, arg1) {
  94. if (isFn)
  95. handler.call(self, arg1);
  96. else {
  97. var len = handler.length;
  98. var listeners = arrayClone(handler, len);
  99. for (var i = 0; i < len; ++i)
  100. listeners[i].call(self, arg1);
  101. }
  102. }
  103. function emitTwo(handler, isFn, self, arg1, arg2) {
  104. if (isFn)
  105. handler.call(self, arg1, arg2);
  106. else {
  107. var len = handler.length;
  108. var listeners = arrayClone(handler, len);
  109. for (var i = 0; i < len; ++i)
  110. listeners[i].call(self, arg1, arg2);
  111. }
  112. }
  113. function emitThree(handler, isFn, self, arg1, arg2, arg3) {
  114. if (isFn)
  115. handler.call(self, arg1, arg2, arg3);
  116. else {
  117. var len = handler.length;
  118. var listeners = arrayClone(handler, len);
  119. for (var i = 0; i < len; ++i)
  120. listeners[i].call(self, arg1, arg2, arg3);
  121. }
  122. }
  123. function emitMany(handler, isFn, self, args) {
  124. if (isFn)
  125. handler.apply(self, args);
  126. else {
  127. var len = handler.length;
  128. var listeners = arrayClone(handler, len);
  129. for (var i = 0; i < len; ++i)
  130. listeners[i].apply(self, args);
  131. }
  132. }
  133. EventEmitter.prototype.emit = function emit(type) {
  134. var er, handler, len, args, i, events;
  135. var doError = (type === 'error');
  136. events = this._events;
  137. if (events)
  138. doError = (doError && events.error == null);
  139. else if (!doError)
  140. return false;
  141. // If there is no 'error' event listener then throw.
  142. if (doError) {
  143. if (arguments.length > 1)
  144. er = arguments[1];
  145. if (er instanceof Error) {
  146. throw er; // Unhandled 'error' event
  147. } else {
  148. // At least give some kind of context to the user
  149. var err = new Error('Unhandled "error" event. (' + er + ')');
  150. err.context = er;
  151. throw err;
  152. }
  153. return false;
  154. }
  155. handler = events[type];
  156. if (!handler)
  157. return false;
  158. var isFn = typeof handler === 'function';
  159. len = arguments.length;
  160. switch (len) {
  161. // fast cases
  162. case 1:
  163. emitNone(handler, isFn, this);
  164. break;
  165. case 2:
  166. emitOne(handler, isFn, this, arguments[1]);
  167. break;
  168. case 3:
  169. emitTwo(handler, isFn, this, arguments[1], arguments[2]);
  170. break;
  171. case 4:
  172. emitThree(handler, isFn, this, arguments[1], arguments[2], arguments[3]);
  173. break;
  174. // slower
  175. default:
  176. args = new Array(len - 1);
  177. for (i = 1; i < len; i++)
  178. args[i - 1] = arguments[i];
  179. emitMany(handler, isFn, this, args);
  180. }
  181. return true;
  182. };
  183. function _addListener(target, type, listener, prepend) {
  184. var m;
  185. var events;
  186. var existing;
  187. if (typeof listener !== 'function')
  188. throw new TypeError('"listener" argument must be a function');
  189. events = target._events;
  190. if (!events) {
  191. events = target._events = objectCreate(null);
  192. target._eventsCount = 0;
  193. } else {
  194. // To avoid recursion in the case that type === "newListener"! Before
  195. // adding it to the listeners, first emit "newListener".
  196. if (events.newListener) {
  197. target.emit('newListener', type,
  198. listener.listener ? listener.listener : listener);
  199. // Re-assign `events` because a newListener handler could have caused the
  200. // this._events to be assigned to a new object
  201. events = target._events;
  202. }
  203. existing = events[type];
  204. }
  205. if (!existing) {
  206. // Optimize the case of one listener. Don't need the extra array object.
  207. existing = events[type] = listener;
  208. ++target._eventsCount;
  209. } else {
  210. if (typeof existing === 'function') {
  211. // Adding the second element, need to change to array.
  212. existing = events[type] =
  213. prepend ? [listener, existing] : [existing, listener];
  214. } else {
  215. // If we've already got an array, just append.
  216. if (prepend) {
  217. existing.unshift(listener);
  218. } else {
  219. existing.push(listener);
  220. }
  221. }
  222. // Check for listener leak
  223. if (!existing.warned) {
  224. m = $getMaxListeners(target);
  225. if (m && m > 0 && existing.length > m) {
  226. existing.warned = true;
  227. var w = new Error('Possible EventEmitter memory leak detected. ' +
  228. existing.length + ' "' + String(type) + '" listeners ' +
  229. 'added. Use emitter.setMaxListeners() to ' +
  230. 'increase limit.');
  231. w.name = 'MaxListenersExceededWarning';
  232. w.emitter = target;
  233. w.type = type;
  234. w.count = existing.length;
  235. if (typeof console === 'object' && console.warn) {
  236. console.warn('%s: %s', w.name, w.message);
  237. }
  238. }
  239. }
  240. }
  241. return target;
  242. }
  243. EventEmitter.prototype.addListener = function addListener(type, listener) {
  244. return _addListener(this, type, listener, false);
  245. };
  246. EventEmitter.prototype.on = EventEmitter.prototype.addListener;
  247. EventEmitter.prototype.prependListener =
  248. function prependListener(type, listener) {
  249. return _addListener(this, type, listener, true);
  250. };
  251. function onceWrapper() {
  252. if (!this.fired) {
  253. this.target.removeListener(this.type, this.wrapFn);
  254. this.fired = true;
  255. switch (arguments.length) {
  256. case 0:
  257. return this.listener.call(this.target);
  258. case 1:
  259. return this.listener.call(this.target, arguments[0]);
  260. case 2:
  261. return this.listener.call(this.target, arguments[0], arguments[1]);
  262. case 3:
  263. return this.listener.call(this.target, arguments[0], arguments[1],
  264. arguments[2]);
  265. default:
  266. var args = new Array(arguments.length);
  267. for (var i = 0; i < args.length; ++i)
  268. args[i] = arguments[i];
  269. this.listener.apply(this.target, args);
  270. }
  271. }
  272. }
  273. function _onceWrap(target, type, listener) {
  274. var state = { fired: false, wrapFn: undefined, target: target, type: type, listener: listener };
  275. var wrapped = bind.call(onceWrapper, state);
  276. wrapped.listener = listener;
  277. state.wrapFn = wrapped;
  278. return wrapped;
  279. }
  280. EventEmitter.prototype.once = function once(type, listener) {
  281. if (typeof listener !== 'function')
  282. throw new TypeError('"listener" argument must be a function');
  283. this.on(type, _onceWrap(this, type, listener));
  284. return this;
  285. };
  286. EventEmitter.prototype.prependOnceListener =
  287. function prependOnceListener(type, listener) {
  288. if (typeof listener !== 'function')
  289. throw new TypeError('"listener" argument must be a function');
  290. this.prependListener(type, _onceWrap(this, type, listener));
  291. return this;
  292. };
  293. // Emits a 'removeListener' event if and only if the listener was removed.
  294. EventEmitter.prototype.removeListener =
  295. function removeListener(type, listener) {
  296. var list, events, position, i, originalListener;
  297. if (typeof listener !== 'function')
  298. throw new TypeError('"listener" argument must be a function');
  299. events = this._events;
  300. if (!events)
  301. return this;
  302. list = events[type];
  303. if (!list)
  304. return this;
  305. if (list === listener || list.listener === listener) {
  306. if (--this._eventsCount === 0)
  307. this._events = objectCreate(null);
  308. else {
  309. delete events[type];
  310. if (events.removeListener)
  311. this.emit('removeListener', type, list.listener || listener);
  312. }
  313. } else if (typeof list !== 'function') {
  314. position = -1;
  315. for (i = list.length - 1; i >= 0; i--) {
  316. if (list[i] === listener || list[i].listener === listener) {
  317. originalListener = list[i].listener;
  318. position = i;
  319. break;
  320. }
  321. }
  322. if (position < 0)
  323. return this;
  324. if (position === 0)
  325. list.shift();
  326. else
  327. spliceOne(list, position);
  328. if (list.length === 1)
  329. events[type] = list[0];
  330. if (events.removeListener)
  331. this.emit('removeListener', type, originalListener || listener);
  332. }
  333. return this;
  334. };
  335. EventEmitter.prototype.removeAllListeners =
  336. function removeAllListeners(type) {
  337. var listeners, events, i;
  338. events = this._events;
  339. if (!events)
  340. return this;
  341. // not listening for removeListener, no need to emit
  342. if (!events.removeListener) {
  343. if (arguments.length === 0) {
  344. this._events = objectCreate(null);
  345. this._eventsCount = 0;
  346. } else if (events[type]) {
  347. if (--this._eventsCount === 0)
  348. this._events = objectCreate(null);
  349. else
  350. delete events[type];
  351. }
  352. return this;
  353. }
  354. // emit removeListener for all listeners on all events
  355. if (arguments.length === 0) {
  356. var keys = objectKeys(events);
  357. var key;
  358. for (i = 0; i < keys.length; ++i) {
  359. key = keys[i];
  360. if (key === 'removeListener') continue;
  361. this.removeAllListeners(key);
  362. }
  363. this.removeAllListeners('removeListener');
  364. this._events = objectCreate(null);
  365. this._eventsCount = 0;
  366. return this;
  367. }
  368. listeners = events[type];
  369. if (typeof listeners === 'function') {
  370. this.removeListener(type, listeners);
  371. } else if (listeners) {
  372. // LIFO order
  373. for (i = listeners.length - 1; i >= 0; i--) {
  374. this.removeListener(type, listeners[i]);
  375. }
  376. }
  377. return this;
  378. };
  379. function _listeners(target, type, unwrap) {
  380. var events = target._events;
  381. if (!events)
  382. return [];
  383. var evlistener = events[type];
  384. if (!evlistener)
  385. return [];
  386. if (typeof evlistener === 'function')
  387. return unwrap ? [evlistener.listener || evlistener] : [evlistener];
  388. return unwrap ? unwrapListeners(evlistener) : arrayClone(evlistener, evlistener.length);
  389. }
  390. EventEmitter.prototype.listeners = function listeners(type) {
  391. return _listeners(this, type, true);
  392. };
  393. EventEmitter.prototype.rawListeners = function rawListeners(type) {
  394. return _listeners(this, type, false);
  395. };
  396. EventEmitter.listenerCount = function(emitter, type) {
  397. if (typeof emitter.listenerCount === 'function') {
  398. return emitter.listenerCount(type);
  399. } else {
  400. return listenerCount.call(emitter, type);
  401. }
  402. };
  403. EventEmitter.prototype.listenerCount = listenerCount;
  404. function listenerCount(type) {
  405. var events = this._events;
  406. if (events) {
  407. var evlistener = events[type];
  408. if (typeof evlistener === 'function') {
  409. return 1;
  410. } else if (evlistener) {
  411. return evlistener.length;
  412. }
  413. }
  414. return 0;
  415. }
  416. EventEmitter.prototype.eventNames = function eventNames() {
  417. return this._eventsCount > 0 ? Reflect.ownKeys(this._events) : [];
  418. };
  419. // About 1.5x faster than the two-arg version of Array#splice().
  420. function spliceOne(list, index) {
  421. for (var i = index, k = i + 1, n = list.length; k < n; i += 1, k += 1)
  422. list[i] = list[k];
  423. list.pop();
  424. }
  425. function arrayClone(arr, n) {
  426. var copy = new Array(n);
  427. for (var i = 0; i < n; ++i)
  428. copy[i] = arr[i];
  429. return copy;
  430. }
  431. function unwrapListeners(arr) {
  432. var ret = new Array(arr.length);
  433. for (var i = 0; i < ret.length; ++i) {
  434. ret[i] = arr[i].listener || arr[i];
  435. }
  436. return ret;
  437. }
  438. function objectCreatePolyfill(proto) {
  439. var F = function() {};
  440. F.prototype = proto;
  441. return new F;
  442. }
  443. function objectKeysPolyfill(obj) {
  444. var keys = [];
  445. for (var k in obj) if (Object.prototype.hasOwnProperty.call(obj, k)) {
  446. keys.push(k);
  447. }
  448. return k;
  449. }
  450. function functionBindPolyfill(context) {
  451. var fn = this;
  452. return function () {
  453. return fn.apply(context, arguments);
  454. };
  455. }