From 68093d8ef80d1bc746f48192c0a6687127ccebb2 Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Wed, 23 Dec 2015 11:17:26 +0000 Subject: [PATCH] util.events: Document data structures --- util/events.lua | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/util/events.lua b/util/events.lua index 825ffb19..073d2a60 100644 --- a/util/events.lua +++ b/util/events.lua @@ -17,10 +17,15 @@ local next = next; 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 -- 2.30.2