# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1450869446 0
# Node ID 138241cc1b3ae09b3ecb87977d31f040c40ebd74
# Parent  5d52e4ee2ae1c03754029c9b5e8ef2b94ed708f3
util.events: Document data structures

diff -r 5d52e4ee2ae1 -r 138241cc1b3a util/events.lua
--- a/util/events.lua	Fri Jan 01 19:53:45 2016 +0100
+++ b/util/events.lua	Wed Dec 23 11:17:26 2015 +0000
@@ -17,10 +17,15 @@
 local _ENV = nil;
 
 local function new()
+	-- Map event name to ordered list of handlers (lazily built): handlers[event_name] = array_of_handler_functions
 	local handlers = {};
+	-- Array of wrapper functions that wrap all events (nil if empty)
 	local global_wrappers;
+	-- Per-event wrappers: wrappers[event_name] = wrapper_function
 	local wrappers = {};
+	-- Event map: event_map[handler_function] = priority_number
 	local event_map = {};
+	-- Called on-demand to build handlers entries
 	local function _rebuild_index(handlers, event)
 		local _handlers = event_map[event];
 		if not _handlers or next(_handlers) == nil then return; end