Removed backward comp fix for monarch.back()

Fixes #102

README_API.md

@@ -212,12 +212,14 @@ IMPORTANT! You must call `monarch.on_message(message_id, message, sender)` from
 * `fn` (function) - The function to call screen focus changes
 
 
-## monarch.on_post(screen_id, fn)
+## monarch.on_post(screen_id, fn_or_url)
-Set a function to be called when `msg.post()` is called on a specific screen. IMPORTANT! You must call `monarch.on_message(message_id, message, sender)` from the same script as this function was called.
+Set either a function to be called when `msg.post()` is called on a specific screen or a URL where the message is sent.
+
+IMPORTANT! If you provide a function you must also make sure to call `monarch.on_message(message_id, message, sender)` from the same script as this function was called.
 
 **PARAMETERS**
 * `screen_id` (string|hash) - Id of the screen
-* `fn` (function) - The function to call when the screen receives a message using `msg.post`
+* `fn_or_url` (function) - The function to call or URL to send message to
 
 
 ## monarch.debug()

README_TRANSITIONS.md

@@ -114,7 +114,7 @@ end
 
 function on_message(self, message_id, message, sender)
 	if message_id == hash("my_resize_message") then
-		self.transition.window_resized(message.width, message.height)
+		transition.window_resized(message.width, message.height)
 	end
 end
 ```

example/advanced/confirm.gui_script

@@ -29,7 +29,7 @@ function on_input(self, action_id, action)
 			end
 		elseif gui.pick_node(self.no, action.x, action.y) then
 			print("no")
-			monarch.back(function()
+			monarch.back(nil, nil, function()
 				print("back from popup done")
 			end)
 		end

example/advanced/popup.gui_script

@@ -27,7 +27,7 @@ function on_input(self, action_id, action)
 			end)
 		elseif gui.pick_node(self.cancel, action.x, action.y) then
 			print("cancel")
-			monarch.back(function()
+			monarch.back(nil, nil, function()
 				print("back from popup done")
 			end)
 		elseif gui.pick_node(self.about, action.x, action.y) then

example/advanced/pregame.gui_script

@@ -19,7 +19,7 @@ function on_input(self, action_id, action)
 			end)
 		elseif gui.pick_node(self.back, action.x, action.y) then
 			print("back")
-			monarch.back(function()
+			monarch.back(nil, nil, function()
 				print("back from pregame done")
 			end)
 		end

monarch/monarch.lua

@@ -228,6 +228,17 @@ function M.is_visible(id)
 end
 
 
+--- Check if a screen is loaded
+-- @param id (string|hash)
+-- @return true if the screen is loaded
+function M.is_loaded(id)
+	assert(id, "You must provide a screen id")
+	id = tohash(id)
+	assert(screens[id], ("There is no screen registered with id %s"):format(tostring(id)))
+	return screens[id].loaded
+end
+
+
 --- Check if a screen is a popup
 -- @param id Screen id
 -- @return true if the screen is a popup
@@ -509,8 +520,12 @@ local function load(screen)
 		msg.post(screen.proxy, MSG_ENABLE)
 	elseif screen.factory then
 		screen.factory_ids = collectionfactory.create(screen.factory)
-		screen.transition_url = screen.factory_ids[screen.transition_id]
+		if screen.transition_id then
-		screen.focus_url = screen.factory_ids[screen.focus_id]
+			screen.transition_url = screen.factory_ids[screen.transition_id]
+		end
+		if screen.focus_id then
+			screen.focus_url = screen.factory_ids[screen.focus_id]
+		end
 	end
 	screen.loaded = true
 	screen.preloaded = false
@@ -715,8 +730,8 @@ local function back_out(screen, next_screen, wait_for_transition, cb)
 	log("back_out()", screen.id)
 	assert(wait_for_transition ~= nil)
 	run_coroutine(screen, cb, function()
-		notify_transition_listeners(M.SCREEN_TRANSITION_OUT_STARTED, { screen = screen.id, next_screen = next_screen and next_screen.id })
 		active_transition_count = active_transition_count + 1
+		notify_transition_listeners(M.SCREEN_TRANSITION_OUT_STARTED, { screen = screen.id, next_screen = next_screen and next_screen.id })
 		change_context(screen)
 		release_input(screen, next_screen)
 		focus_lost(screen, next_screen)
@@ -863,13 +878,10 @@ function M.show(id, options, data, cb)
 				show_in(screen, top, options and options.reload, add_to_stack, WAIT_FOR_TRANSITION, callbacks.track())
 			else
 				-- show screen
-				local cb = callbacks.track()
+				show_in(screen, top, options and options.reload, add_to_stack, WAIT_FOR_TRANSITION, callbacks.track())
-				show_in(screen, top, options and options.reload, add_to_stack, DO_NOT_WAIT_FOR_TRANSITION, function()
+				if add_to_stack and top and not top.popup then
-					if add_to_stack and top and not top.popup then
+					show_out(top, screen, WAIT_FOR_TRANSITION, callbacks.track())
-						show_out(top, screen, WAIT_FOR_TRANSITION, callbacks.track())
+				end
-					end
-					cb()
-				end)
 			end
 
 			callbacks.when_done(function()
@@ -912,7 +924,7 @@ function M.hide(id, cb)
 			log("hide() you can only hide the screen at the top of the stack", id)
 			return false
 		end
-		return M.back(id, cb)
+		return M.back(nil, nil, cb)
 	else
 		log("hide() queuing action", id)
 		queue_action(function(action_done, action_error)
@@ -974,17 +986,6 @@ end
 -- @param cb (function) - Optional callback to invoke when the previous screen is visible again
 function M.back(options, data, cb)
 	log("back() queuing action")
-	-- backwards compatibility with old version M.back(data, cb)
-	-- case when back(data, cb)
-	if type(data) == "function" then
-		cb = data
-		data = options
-		options = nil
-	-- case when back(data, nil)
-	elseif options ~= nil and data == nil and cb == nil then
-		data = options
-		options = nil
-	end
 
 	queue_action(function(action_done)
 		local callbacks = callback_tracker()
@@ -1014,16 +1015,16 @@ function M.back(options, data, cb)
 					-- we do this to ensure that we do not reset the times step of the screen
 					-- we go back to until it is no longer obscured by the popup
 					if screen.popup and not top.popup then
+						local back_cb = callbacks.track()
 						back_out(screen, top, WAIT_FOR_TRANSITION, function()
 							back_in(top, screen, WAIT_FOR_TRANSITION, back_cb)
 						end)
 					else
-						back_in(top, screen, DO_NOT_WAIT_FOR_TRANSITION, function()
+						back_in(top, screen, WAIT_FOR_TRANSITION, callbacks.track())
-							back_out(screen, top, WAIT_FOR_TRANSITION, back_cb)
+						back_out(screen, top, WAIT_FOR_TRANSITION, callbacks.track())
-						end)
 					end
 				else
-					back_out(screen, top, WAIT_FOR_TRANSITION, back_cb)
+					back_out(screen, top, WAIT_FOR_TRANSITION, callbacks.track())
 				end
 			end
 		end
@@ -1181,8 +1182,8 @@ end
 -- @return error (string|nil) Error message if unable to send message
 function M.post(id, message_id, message)
 	assert(id, "You must provide a screen id")
-	if not M.is_visible(id) then
+	if not M.is_loaded(id) then
-		return false, "Unable to post message to screen if it isn't visible"
+		return false, "Unable to post message to screen if it isn't loaded"
 	end
 
 	assert(message_id, "You must provide a message_id")
@@ -1334,20 +1335,30 @@ function M.on_focus_changed(id, fn)
 end
 
 ---
--- Set a function to call when a screen is sent a message using monarch.post()
+-- Set either a function to be called when msg.post() is called on a specific
--- The function will receive (message_id, message, sender)
+-- screen or a URL where the message is sent.
--- IMPORTANT! You must call monarch.on_message() from the same script as
+-- IMPORTANT! If you provide a function you must also make sure to call
--- this function was called
+-- monarch.on_message(message_id, message, sender) from the same script as
+-- this function was called.
 -- @param id Screen id to associate the message listener function with
--- @param fn Message listener function
+-- @param fn_or_url The function to call or URL to send message to
-function M.on_post(id, fn)
+function M.on_post(id, fn_or_url)
 	assert(id, "You must provide a screen id")
-	assert(fn, "You must provide a post receiver function")
 	id = tohash(id)
 	assert(screens[id], ("There is no screen registered with id %s"):format(tostring(id)))
 	local screen = screens[id]
-	screen.receiver_url = msg.url()
+
-	screen.receiver_fn = fn
+	local t = type(fn_or_url)
+	if t == "function" then
+		screen.receiver_fn = fn_or_url
+		screen.receiver_url = msg.url()
+	elseif t == "userdata" or t == "string" then
+		screen.receiver_fn = nil
+		screen.receiver_url = fn_or_url
+	else
+		screen.receiver_fn = nil
+		screen.receiver_url = msg.url()
+	end
 end
 
 local function url_to_key(url)

test/test_monarch.lua

@@ -81,7 +81,7 @@ return function()
 			monarch.when_preloaded(screen_id, done)
 		end)
 	end
-		
+
 	describe("monarch", function()
 		before(function()
 			mock_msg.mock()
@@ -142,12 +142,12 @@ return function()
 			monarch.show(SCREEN1)
 			assert(wait_until_stack({ SCREEN1 }))
 			assert(wait_until_visible(SCREEN1))
-			
+
 			monarch.show(SCREEN2)
 			assert(wait_until_stack({ SCREEN1, SCREEN2 }))
 			assert(wait_until_hidden(SCREEN1))
 			assert(wait_until_visible(SCREEN2))
-			
+
 			monarch.show(POPUP1)
 			assert(wait_until_stack({ SCREEN1, SCREEN2, POPUP1 }))
 			assert(wait_until_hidden(SCREEN1))
@@ -155,6 +155,17 @@ return function()
 			assert(wait_until_visible(POPUP1))
 		end)
 
+		it("should be able to tell if a screen is loaded or not", function()
+			assert(not monarch.is_loaded(SCREEN1))
+			monarch.show(SCREEN1)
+			assert(wait_until_visible(SCREEN1))
+			assert(monarch.is_loaded(SCREEN1))
+			
+			monarch.hide(SCREEN1)
+			assert(wait_until_hidden(SCREEN1))
+			assert(not monarch.is_loaded(SCREEN1))
+		end)
+		
 		it("should be able to show a screen without adding it to the stack", function()
 			monarch.show(BACKGROUND, { no_stack = true })
 			assert(wait_until_visible(BACKGROUND), "Background was never shown")
@@ -219,7 +230,7 @@ return function()
 			assert(monarch.data(SCREEN2) == data2, "Expected data on screen2 doesn't match actual data")
 
 			local data_back = { going = "back" }
-			monarch.back(data_back)
+			monarch.back(nil, data_back)
 			assert(wait_until_visible(SCREEN1))
 
 			assert(monarch.data(SCREEN1) == data_back, "Expected data on screen1 doesn't match actual data")
@@ -415,7 +426,7 @@ return function()
 			assert(mock_msg.messages(URL1)[2].message.screen == SCREEN1)
 			assert(mock_msg.messages(URL2)[2].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
 			assert(mock_msg.messages(URL2)[2].message.screen == SCREEN1)
-												
+
 			monarch.remove_listener(URL2)
 			monarch.show(SCREEN2)
 			assert(wait_until_not_busy())
@@ -424,10 +435,10 @@ return function()
 			assert(#mock_msg.messages(URL2) == 2)
 			assert(mock_msg.messages(URL1)[3].message_id == monarch.SCREEN_TRANSITION_IN_STARTED)
 			assert(mock_msg.messages(URL1)[3].message.screen == SCREEN2)
-			assert(mock_msg.messages(URL1)[4].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
+			assert(mock_msg.messages(URL1)[4].message_id == monarch.SCREEN_TRANSITION_OUT_STARTED)
-			assert(mock_msg.messages(URL1)[4].message.screen == SCREEN2)
+			assert(mock_msg.messages(URL1)[4].message.screen == SCREEN1)
-			assert(mock_msg.messages(URL1)[5].message_id == monarch.SCREEN_TRANSITION_OUT_STARTED)
+			assert(mock_msg.messages(URL1)[5].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
-			assert(mock_msg.messages(URL1)[5].message.screen == SCREEN1)
+			assert(mock_msg.messages(URL1)[5].message.screen == SCREEN2)
 			assert(mock_msg.messages(URL1)[6].message_id == monarch.SCREEN_TRANSITION_OUT_FINISHED)
 			assert(mock_msg.messages(URL1)[6].message.screen == SCREEN1)
 
@@ -438,10 +449,10 @@ return function()
 			assert(#mock_msg.messages(URL2) == 2)
 			assert(mock_msg.messages(URL1)[7].message_id == monarch.SCREEN_TRANSITION_IN_STARTED)
 			assert(mock_msg.messages(URL1)[7].message.screen == SCREEN1)
-			assert(mock_msg.messages(URL1)[8].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
+			assert(mock_msg.messages(URL1)[8].message_id == monarch.SCREEN_TRANSITION_OUT_STARTED)
-			assert(mock_msg.messages(URL1)[8].message.screen == SCREEN1)
+			assert(mock_msg.messages(URL1)[8].message.screen == SCREEN2)
-			assert(mock_msg.messages(URL1)[9].message_id == monarch.SCREEN_TRANSITION_OUT_STARTED)
+			assert(mock_msg.messages(URL1)[9].message_id == monarch.SCREEN_TRANSITION_IN_FINISHED)
-			assert(mock_msg.messages(URL1)[9].message.screen == SCREEN2)
+			assert(mock_msg.messages(URL1)[9].message.screen == SCREEN1)
 			assert(mock_msg.messages(URL1)[10].message_id == monarch.SCREEN_TRANSITION_OUT_FINISHED)
 			assert(mock_msg.messages(URL1)[10].message.screen == SCREEN2)
 		end)