event.js 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. /**
  2. * Publish/Subscribe event system for anonymous message passing
  3. *
  4. */
  5. if (typeof bobj == 'undefined') {
  6. bobj = {};
  7. }
  8. if (typeof bobj.event == 'undefined') {
  9. bobj.event = {};
  10. bobj.event._topicSubscriptions = {};
  11. bobj.event._globalSubscriptions = [];
  12. }
  13. /**
  14. * Publish an event for subscribers to receive
  15. *
  16. * @param topic [String] The event topic
  17. * @param arguments Unnamed args will be passed to subscribers
  18. */
  19. bobj.event.publish = function(topic) {
  20. var args = bobj.slice(arguments, 1);
  21. var topicSubs = bobj.event._topicSubscriptions[topic];
  22. if (topicSubs) {
  23. for (var i = 0; i < topicSubs.length; ++i) {
  24. topicSubs[i]._notify.apply(null, args);
  25. }
  26. }
  27. var globalSubs = bobj.event._globalSubscriptions;
  28. for (var j = 0; j < globalSubs.length; ++j) {
  29. globalSubs[j]._notify.apply(null, args);
  30. }
  31. };
  32. /**
  33. * Subscribe to a topic
  34. *
  35. * @param topic [String] The event topic
  36. * @param callback [Function] Function to be call with topic's arguments
  37. * @param target [Object] Object to notify (requires methName)
  38. * @param methName [String] Name of method to call when target is notified
  39. *
  40. * Arguments may be passed in any of the following combinations:
  41. * (topic, target, methName)
  42. * (topic, callback)
  43. * (target, methName)
  44. * (callback)
  45. *
  46. * When a topic is not specified, the subscriber receives all topics
  47. *
  48. * @return Subscription object that can be used to unsubscribe
  49. */
  50. bobj.event.subscribe = function() {
  51. var nmlr = bobj.event.subscribe._normalizer;
  52. if (!nmlr) {
  53. nmlr = bobj.event.subscribe._normalizer = new bobj.ArgumentNormalizer();
  54. // If 3 args: (topic, target, methName)
  55. nmlr.addRule('topic', 'target', 'methName');
  56. // If 2 args and first is a string: (topic, callback)
  57. nmlr.addRule([bobj.isString, 'topic'], 'callback');
  58. // If 2 args: (target, methName)
  59. nmlr.addRule('target', 'methName');
  60. // If 1 arg: (callback)
  61. nmlr.addRule('callback');
  62. }
  63. return bobj.event.kwSubscribe(nmlr.normalizeArray(arguments));
  64. };
  65. /**
  66. * Subscribe to a topic using keyword arguments
  67. *
  68. * @param kwArgs.topic [String] The event topic
  69. * @param kwArgs.callback [Function] Function to be call with topic's arguments
  70. * @param kwArgs.target [Object] Object to notify (requires methName)
  71. * @param kwArgs.methName [String] Name of method to call when target is notified
  72. *
  73. * @see bobj.event.subscribe
  74. *
  75. * @return Subscription object that can be used to unsubscribe
  76. */
  77. bobj.event.kwSubscribe = function(kwArgs) {
  78. var bind = MochiKit.Base.bind;
  79. var subscription = {};
  80. if (kwArgs.callback) {
  81. subscription._notify = kwArgs.callback;
  82. }
  83. else {
  84. subscription._notify = bind(kwArgs.target[kwArgs.methName], kwArgs.target);
  85. }
  86. if (kwArgs.topic) {
  87. subscription.topic = kwArgs.topic;
  88. var subs = bobj.event._topicSubscriptions;
  89. if (!subs[kwArgs.topic]) {
  90. subs[kwArgs.topic] = [];
  91. }
  92. subs[kwArgs.topic].push(subscription);
  93. }
  94. else {
  95. bobj.event._globalSubscriptions.push(subscription);
  96. }
  97. return subscription;
  98. };
  99. /**
  100. * Unsubscribe from a topic
  101. *
  102. * @param subscription [Subscription] The object returned by subscribe
  103. */
  104. bobj.event.unsubscribe = function(subscription) {
  105. var subsList = bobj.event._globalSubscriptions;
  106. if (subscription.topic) {
  107. subsList = bobj.event._topicSubscriptions[subscription.topic];
  108. }
  109. if (subsList) {
  110. var idx = MochiKit.Base.findIdentical(subsList, subscription);
  111. if (idx != -1) {
  112. subsList.splice(idx, 1); // remove the subscription
  113. delete subscription._notify; // prevent leaks
  114. }
  115. }
  116. };