Track when callbacks are invoked so that we can ensure that all screens are shown/hidden before invoking callbacks

monarch/monarch.lua

@@ -1,3 +1,5 @@
+local callback_tracker = require "monarch.utils.callback_tracker"
+
 local M = {}
 
 local CONTEXT = hash("monarch_context")
@@ -310,7 +312,6 @@ end
 
 local function back_in(screen, previous_screen, cb)
 	log("back_in()", screen.id)
-	print("back_in()", screen.id)
 	local co
 	co = coroutine.create(function()
 		active_transition_count = active_transition_count + 1
@@ -341,7 +342,6 @@ end
 
 local function back_out(screen, next_screen, cb)
 	log("back_out()", screen.id)
-	print("back_out()", screen.id)
 	local co
 	co = coroutine.create(function()
 		notify_listeners(M.SCREEN_TRANSITION_OUT_STARTED, { screen = screen.id, next_screen = next_screen.id })
@@ -401,9 +401,12 @@ end
 function M.show(id, options, data, cb)
 	assert(id, "You must provide a screen id")
 	if M.is_busy() then
+		log("show() monarch is busy, ignoring request")
 		return false
 	end
 
+	local callbacks = callback_tracker()
+	
 	id = tohash(id)
 	assert(screens[id], ("There is no screen registered with id %s"):format(tostring(id)))
 
@@ -424,13 +427,13 @@ function M.show(id, options, data, cb)
 			-- close all popups
 			while top.popup do
 				stack[#stack] = nil
-				show_out(top, screen)
+				show_out(top, screen, callbacks.track())
 				top = stack[#stack]
 			end
 			-- unload and transition out from top
 			-- unless we're showing the same screen as is already visible
 			if top and top.id ~= screen.id then
-				show_out(top, screen)
+				show_out(top, screen, callbacks.track())
 			end
 		end
 	end
@@ -447,7 +450,9 @@ function M.show(id, options, data, cb)
 	end
 
 	-- show screen
-	show_in(screen, top, options and options.reload, cb)
+	show_in(screen, top, options and options.reload, callbacks.track())
+
+	if cb then callbacks.when_done(cb) end
 
 	return true
 end
@@ -459,9 +464,12 @@ end
 -- @return true if successfully going back, false if busy performing another operation
 function M.back(data, cb)
 	if M.is_busy() then
+		log("back() monarch is busy, ignoring request")
 		return false
 	end
 
+	local callbacks = callback_tracker()
+	
 	local screen = table.remove(stack)
 	if screen then
 		log("back()", screen.id)
@@ -473,7 +481,7 @@ function M.back(data, cb)
 				if data then
 					top.data = data
 				end
-				back_in(top, screen, cb)
+				back_in(top, screen, callbacks.track())
 			end)
 		else
 			back_out(screen, top)
@@ -481,12 +489,13 @@ function M.back(data, cb)
 				if data then
 					top.data = data
 				end
-				back_in(top, screen, cb)
+				back_in(top, screen, callbacks.track())
 			end
 		end
-	elseif cb then
-		cb()
 	end
+
+	if cb then callbacks.when_done(cb) end
+	
 	return true
 end
 

monarch/utils/callback_tracker.lua

@@ -0,0 +1,39 @@
+local M = {}
+
+
+function M.create()
+	local instance = {}
+
+	local callback = nil
+	local callback_count = 0
+
+	--- Create a callback function and track when it is done
+	-- @return Callback function
+	function instance.track()
+		callback_count = callback_count + 1
+		return function()
+			callback_count = callback_count - 1
+			if callback_count == 0 and callback then
+				callback()
+			end
+		end
+	end
+
+	--- Call a function when all callbacks have been triggered
+	-- @param cb Function to call when all 
+	function instance.when_done(cb)
+		callback = cb
+		if callback_count == 0 then
+			callback()
+		end
+	end
+
+	return instance
+end
+
+
+return setmetatable(M, {
+	__call = function(_, ...)
+		return M.create(...)
+	end
+})