Added more documentation. Changed monarch.get_stack()

Replace strings with constants / new type of transactions / information for the focus messages

.luacheckrc

@@ -0,0 +1,42 @@
+std = "max"
+files['.luacheckrc'].global = false
+unused_args = false
+
+globals = {
+  "sys",
+  "go",
+  "gui",
+  "label",
+  "render",
+  "crash",
+  "sprite",
+  "sound",
+  "tilemap",
+  "spine",
+  "particlefx",
+  "physics",
+  "factory",
+  "collectionfactory",
+  "iac",
+  "msg",
+  "vmath",
+  "url",
+  "http",
+  "image",
+  "json",
+  "zlib",
+  "iap",
+  "push",
+  "facebook",
+  "hash",
+  "hash_to_hex",
+  "pprint",
+  "init",
+  "final",
+  "update",
+  "on_input",
+  "on_message",
+  "on_reload",
+  "window",
+  "unityads"
+}

.test/run.sh

@@ -0,0 +1,34 @@
+
+if [ $# -eq 0 ]; then
+	PLATFORM="x86_64-linux"
+else
+	PLATFORM="$1"
+fi
+
+echo "${PLATFORM}"
+
+# {"version": "1.2.89", "sha1": "5ca3dd134cc960c35ecefe12f6dc81a48f212d40"}
+SHA1=$(curl -s http://d.defold.com/stable/info.json | sed 's/.*sha1": "\(.*\)".*/\1/')
+echo "Using Defold dmengine_headless version ${SHA1}"
+
+#DMENGINE_URL="http://d.defold.com/archive/${SHA1}/engine/linux/dmengine_headless"
+DMENGINE_URL="http://d.defold.com/archive/${SHA1}/engine/${PLATFORM}/dmengine_headless"
+BOB_URL="http://d.defold.com/archive/${SHA1}/bob/bob.jar"
+
+echo "Downloading ${DMENGINE_URL}"
+curl -o dmengine_headless ${DMENGINE_URL}
+chmod +x dmengine_headless
+
+echo "Downloading ${BOB_URL}"
+curl -o bob.jar ${BOB_URL}
+
+if [ -n "${DEFOLD_AUTH}" ] && [ -n "${DEFOLD_USER}" ]; then
+	echo "Running bob.jar - resolving dependencies"
+	java -jar bob.jar --auth "${DEFOLD_AUTH}" --email "${DEFOLD_USER}" resolve
+fi
+
+echo "Running bob.jar - building"
+java -jar bob.jar --debug build
+
+echo "Starting dmengine_headless"
+./dmengine_headless

.travis.yml

@@ -0,0 +1,27 @@
+sudo: required
+
+script:
+  - sudo unlink /usr/bin/gcc && sudo ln -s /usr/bin/gcc-5 /usr/bin/gcc
+  - gcc --version
+
+addons:
+  apt:
+    sources:
+    - ubuntu-toolchain-r-test
+    packages:
+    - gcc-5
+    - g++-5
+
+language: java
+
+jdk:
+  - oraclejdk8
+
+#DEFOLD_AUTH=auth token
+env:
+  global:
+    - secure: "1rVLsDcb7dFdgyB9D1JQDr4JhWSosoMvgYgrqZNPxJ/Du3qtY3bk6dgQim+g2fDMQpDOPCQ/EhmhtrLJrIgBhhvOcsrVKT8gl9ZnATw5tHGI6XTw3eod8WgsU8owlc7CaT3XaUgwVshmW3oB/257SDf6kHwsCv/gAJuCEL5RZp76BhTWsfyeDCgz5XXgWx4a21tcIWz96jxEsrYQKLLV2ne55CxU5Hw9IMU7Ig7pkGoYCf1g+iUEA39NC8nIrQibUoJj3yNB2u3ZFwGf2LuDjjkSIsyYWn1LzA2fQYw5uAcjiQ/aDkj6sAEvwrWsIsJhOon5cQBFIU6cIIN2oK3A7BA0zJj0EsTFPUMIeryyoqiuLUDoIvHD/eEqouNduP6Kml02Ql0pDZnjDy/+nzp2e7VA5Sd9Xg1XKd1mmHKx4nc2U+IcIDZWAerFKcqQqeZSwzz5igv07w5zYZ99KCSBMH2K/2H/CNekHa6SQQ29mC8D3lDXOfwEq3fAhsabgUGe2uAgUY1nKwJBKEi7r+KEROBr5ydkWenzbCXv3GNNsuCHKpNFuoZv3QMyjUjlPBxZVndNLSv85juhkBx6wXAh8CxTt78Y8GV0xI8oazSM065gpDmENGVqyO1bUn2CZF8YRC4MLfHK+245QN82ui+YOqVudTX8RGWnX0GFUncjaRQ="
+    - DEFOLD_USER=bjorn.ritzl@king.com
+
+script:
+  - "./.test/run.sh"

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Björn Ritzl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -6,6 +6,8 @@ You can use Monarch in your own project by adding this project as a [Defold libr
 
 https://github.com/britzl/monarch/archive/master.zip
 
+Or point to the ZIP file of a [specific release](https://github.com/britzl/monarch/releases).
+
 # Usage
 Using Monarch requires that screens are created in a certain way. Once you have one or more screens created you can start navigating between the screens.
 
@@ -76,7 +78,7 @@ You can add optional transitions when navigating between screens. The default be
 * ```transition_show_in```
 * ```transition_show_out```
 * ```transition_back_in```
-* ``transition_back_out```
+* ```transition_back_out```
 
 When a transition is completed it is up to the developer to send a ```transition_done``` message back to the sender to indicate that the transition is completed and that Monarch can continue the navigation sequence. Monarch comes with a system for setting up transitions easily in a gui_script. Example:
 
@@ -98,20 +100,20 @@ When a transition is completed it is up to the developer to send a ```transition
 	end
 
 ## Screen focus gain/loss
-Monarch will send focus gain and focus loss messages if a Focus Url was provided when the screen was created. Example:
+Monarch will send focus gain and focus loss messages if a Focus Url was provided when the screen was created. The focus gained message will contain the id of the previous screen and the focus loss message will contain the id of the next screen. Example:
 
 	local monarch = require "monarch.monarch"
 
 	function on_message(self, message_id, message, sender)
 		if message_id == monarch.FOCUS_GAINED then
-			print("Focus gained")
+			print("Focus gained, previous screen: ", message.id)
 		elseif message_id == monarch.FOCUS_LOST then
-			print("Focus lost")
+			print("Focus lost, next screen: ", message.id)
 		end
 	end
 
 ## Callbacks
-Both the ```monarch.show()``` and ```monarch.back()``` functions take an optional callback function that will be invoked when the ```transition_show_in``` (or the ```transition_back_in``` in the case of a ```monarch.back()``` call) transition is completed. Tthe transition is considered completed when a ```transition_done``` message has been received (see section on [transitions](#transitions) above).
+Both the ```monarch.show()``` and ```monarch.back()``` functions take an optional callback function that will be invoked when the ```transition_show_in``` (or the ```transition_back_in``` in the case of a ```monarch.back()``` call) transition is completed. The transition is considered completed when a ```transition_done``` message has been received (see section on [transitions](#transitions) above).
 
 ## Monarch API
 
@@ -127,6 +129,7 @@ Show a Monarch screen
 The options table can contain the following fields:
 
 * ```clear``` (boolean) - If the clear flag is set Monarch will search the stack for the screen that is to be shown. If the screen already exists in the stack and the clear flag is set Monarch will remove all screens between the current top and the screen in question.
+* ```reload``` (boolean) - If the reload flag is set Monarch will reload the collection proxy if it's already loaded (this can happen if the previous screen was a popup).
 
 ### monarch.back([data], [callback])
 Go back to a previous Monarch screen
@@ -135,6 +138,7 @@ Go back to a previous Monarch screen
 * ```data``` (table) - Optional data to associate with the screen you are going back to.  Retrieve using ```monarch.data()```.
 * ```callback``` (function) - Function to call when the previous screen is visible.
 
+
 ### monarch.data(screen_id)
 Get the data associated with a screen (from a call to ```monarch.show()``` or ```monarch.back()```).
 
@@ -143,3 +147,13 @@ Get the data associated with a screen (from a call to ```monarch.show()``` or ``
 
 **RETURN**
 * ```data``` (table) - Data associated with the screen.
+
+
+### monarch.screen_exists(screen_id)
+Check if a Monarch screen exists.
+
+**PARAMETERS**
+* ```screen_id``` (hash) - Id of the screen to get data for
+
+**RETURN**
+* ```exists``` (boolean) - True if the screen exists.

example/about.collection

@@ -0,0 +1,37 @@
+name: "about"
+scale_along_z: 0
+embedded_instances {
+  id: "go"
+  data: "components {\n"
+  "  id: \"about\"\n"
+  "  component: \"/example/about.gui\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}

example/about.gui

@@ -0,0 +1,603 @@
+script: "/example/about.gui_script"
+fonts {
+  name: "example"
+  font: "/assets/example.font"
+}
+background_color {
+  x: 0.0
+  y: 0.0
+  z: 0.0
+  w: 0.0
+}
+nodes {
+  position {
+    x: 320.0
+    y: 568.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 400.0
+    y: 300.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.3019608
+    y: 0.3019608
+    z: 0.3019608
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "root"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 120.0
+    y: -112.414
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 110.0
+    y: 50.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "ok_reload_button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "OK, reload"
+  font: "example"
+  id: "ok_reload_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "ok_reload_button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 380.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "When clicking OK the menu will be shown again using monarch.show()"
+  font: "example"
+  id: "text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: true
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: -0.0
+    y: -112.414
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 110.0
+    y: 50.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "ok_clear_button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "OK, clear"
+  font: "example"
+  id: "ok_clear_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "ok_clear_button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: -120.0
+    y: -112.414
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 110.0
+    y: 50.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "ok_clearreload_button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 100.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "OK, clear and reload"
+  font: "example"
+  id: "ok_clearreload_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: true
+  parent: "ok_clearreload_button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: 120.0
+    y: -54.414
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 110.0
+    y: 50.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "ok_button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "OK"
+  font: "example"
+  id: "ok_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "ok_button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+material: "/builtins/materials/gui.material"
+adjust_reference: ADJUST_REFERENCE_PARENT
+max_nodes: 512

example/about.gui_script

@@ -0,0 +1,31 @@
+local monarch = require "monarch.monarch"
+local transitions = require "monarch.transitions.gui"
+
+function init(self)
+	msg.post(".", "acquire_input_focus")
+	gui.set_render_order(15)
+
+	self.transition = transitions.create(gui.get_node("root"))
+		.show_in(transitions.slide_in_top, gui.EASING_OUTQUAD, 0.6, 0)
+		.show_out(transitions.slide_out_top, gui.EASING_INQUAD, 0.6, 0)
+		.back_in(transitions.slide_in_top, gui.EASING_OUTQUAD, 0.6, 0)
+		.back_out(transitions.slide_out_top, gui.EASING_INQUAD, 0.6, 0)
+end
+
+function on_input(self, action_id, action)
+	if action_id == hash("touch") and action.released then
+		if gui.pick_node(gui.get_node("ok_reload_button"), action.x, action.y) then
+			monarch.show(hash("menu"), { reload = true })
+		elseif gui.pick_node(gui.get_node("ok_clear_button"), action.x, action.y) then
+			monarch.show(hash("menu"), { clear = true })
+		elseif gui.pick_node(gui.get_node("ok_clearreload_button"), action.x, action.y) then
+			monarch.show(hash("menu"), { clear = true, reload = true })
+		elseif gui.pick_node(gui.get_node("ok_button"), action.x, action.y) then
+			monarch.show(hash("menu"))
+		end
+	end
+end
+
+function on_message(self, message_id, message, sender)
+	self.transition.handle(message_id, message, sender)
+end

example/example.collection

@@ -1,4 +1,4 @@
-name: "main"
+name: "example"
 scale_along_z: 0
 embedded_instances {
   id: "menu"
@@ -307,3 +307,71 @@ embedded_instances {
     z: 1.0
   }
 }
+embedded_instances {
+  id: "about"
+  data: "components {\n"
+  "  id: \"screen\"\n"
+  "  component: \"/monarch/screen.script\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "  properties {\n"
+  "    id: \"screen_id\"\n"
+  "    value: \"about\"\n"
+  "    type: PROPERTY_TYPE_HASH\n"
+  "  }\n"
+  "  properties {\n"
+  "    id: \"popup\"\n"
+  "    value: \"true\"\n"
+  "    type: PROPERTY_TYPE_BOOLEAN\n"
+  "  }\n"
+  "  properties {\n"
+  "    id: \"transition_url\"\n"
+  "    value: \"about:/go#about\"\n"
+  "    type: PROPERTY_TYPE_URL\n"
+  "  }\n"
+  "}\n"
+  "embedded_components {\n"
+  "  id: \"collectionproxy\"\n"
+  "  type: \"collectionproxy\"\n"
+  "  data: \"collection: \\\"/example/about.collection\\\"\\n"
+  "exclude: false\\n"
+  "\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}

example/main.script

@@ -1,6 +1,14 @@
 local monarch = require "monarch.monarch"
 
 function init(self)
-	monarch.show(hash("menu"))
+	self.wait = true
 	msg.post("@render:/", "clear_color", { color = vmath.vector4(0.4, 0.6, 0.8,1.0) })
 end
+
+function update(self)
+	-- Ensure that the initial screen has had enough time to register
+	if self.wait == true and monarch.screen_exists(hash("menu")) then
+		self.wait = false
+		monarch.show(hash("menu"))
+	end	
+end

example/menu.gui

@@ -181,6 +181,305 @@ nodes {
   text_leading: 1.0
   text_tracking: 0.0
 }
+nodes {
+  position {
+    x: 499.0
+    y: 1078.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 50.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "about_button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "ABOUT"
+  font: "example"
+  id: "about_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "about_button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: 138.0
+    y: 1078.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 50.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "back_button"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_MANUAL
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "BACK"
+  font: "example"
+  id: "back_text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "back_button"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+nodes {
+  position {
+    x: 320.0
+    y: 1024.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "<text>"
+  font: "example"
+  id: "timestamp"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "root"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
 material: "/builtins/materials/gui.material"
 adjust_reference: ADJUST_REFERENCE_PARENT
 max_nodes: 512

example/menu.gui_script

@@ -4,6 +4,8 @@ local transitions = require "monarch.transitions.gui"
 function init(self)
 	msg.post(".", "acquire_input_focus")
 
+	gui.set_text(gui.get_node("timestamp"), os.date())
+
 	self.transition = transitions.create(gui.get_node("root"))
 		.show_in(transitions.slide_in_right, gui.EASING_OUTQUAD, 0.6, 0)
 		.show_out(transitions.slide_out_left, gui.EASING_INQUAD, 0.6, 0)
@@ -17,6 +19,12 @@ function on_input(self, action_id, action)
 			monarch.show(hash("popup"), nil, nil, function()
 				print("showing popup done")
 			end)
+		elseif gui.pick_node(gui.get_node("about_button"), action.x, action.y) then
+			monarch.show(hash("about"), nil, nil, function()
+			print("showing about done")
+			end)
+		elseif gui.pick_node(gui.get_node("back_button"), action.x, action.y) then
+			monarch.back()
 		end
 	end
 end

example/popup.gui_script

@@ -8,10 +8,10 @@ function init(self)
 	gui.set_render_order(15)
 
 	self.transition = transitions.create(gui.get_node("root"))
-		.show_in(transitions.slide_in_top, gui.EASING_OUTQUAD, 0.6, 0)
-		.show_out(transitions.slide_out_top, gui.EASING_INQUAD, 0.6, 0)
-		.back_in(transitions.slide_in_top, gui.EASING_OUTQUAD, 0.6, 0)
-		.back_out(transitions.slide_out_top, gui.EASING_INQUAD, 0.6, 0)
+		.show_in(transitions.scale_in, gui.EASING_OUTBACK, 0.3, 0)
+		.show_out(transitions.scale_out, gui.EASING_INBACK, 0.3, 0)
+		.back_in(transitions.scale_in, gui.EASING_OUTBACK, 0.3, 0)
+		.back_out(transitions.scale_out, gui.EASING_INBACK, 0.3, 0)
 end
 
 function on_input(self, action_id, action)

game.project

@@ -1,9 +1,10 @@
 [project]
 title = Monarch
 version = 0.9
+dependencies = https://github.com/britzl/deftest/archive/1.2.1.zip
 
 [bootstrap]
-main_collection = /example/main.collectionc
+main_collection = /test/test.collectionc
 
 [input]
 game_binding = /input/game.input_bindingc

monarch/monarch.lua

@@ -8,13 +8,26 @@ local CONTEXT = hash("monarch_context")
 local PROXY_LOADED = hash("proxy_loaded")
 local PROXY_UNLOADED = hash("proxy_unloaded")
 
-M.TRANSITION_DONE = hash("transition_done")
-M.FOCUS_GAINED = hash("monarch_focus_gained")
-M.FOCUS_LOST = hash("monarch_focus_lost")
+local RELEASE_INPUT_FOCUS = hash("release_input_focus")
+local ACQUIRE_INPUT_FOCUS = hash("acquire_input_focus")
+local ASYNC_LOAD = hash("async_load")
+local UNLOAD = hash("unload")
+local ENABLE = hash("enable")
+
+M.TRANSITION = {}
+M.TRANSITION.DONE = hash("transition_done")
+M.TRANSITION.SHOW_IN = hash("transition_show_in")
+M.TRANSITION.SHOW_OUT = hash("transition_show_out")
+M.TRANSITION.BACK_IN = hash("transition_back_in")
+M.TRANSITION.BACK_OUT = hash("transition_back_out")
+
+M.FOCUS = {}
+M.FOCUS.GAINED = hash("monarch_focus_gained")
+M.FOCUS.LOST = hash("monarch_focus_lost")
 
 
 local function screen_from_proxy(proxy)
-	for _,screen in pairs(screens) do
+	for _, screen in pairs(screens) do
 		if screen.proxy == proxy then
 			return screen
 		end
@@ -23,15 +36,19 @@ end
 
 local function screen_from_script()
 	local url = msg.url()
-	for _,screen in pairs(screens) do
+	for _, screen in pairs(screens) do
 		if screen.script == url then
 			return screen
 		end
 	end
 end
 
-local function in_stack(id)
-	for i=1,#stack do
+
+--- Check if a screen exists in the current screen stack
+-- @param id
+-- @return true of the screen is in the stack
+function M.in_stack(id)
+	for i = 1, #stack do
 		if stack[i].id == id then
 			return true
 		end
@@ -39,8 +56,33 @@ local function in_stack(id)
 	return false
 end
 
+
+--- Check if a screen is at the top of the stack
+-- (primarily used for unit tests, but could have a usecase outside tests)
+-- @param id
+-- @return true if the screen is at the top of the stack
+function M.is_top(id)
+	local top = stack[#stack]
+	return top and top.id == id or false
+end
+
+
+--- Register a new screen
+-- This is done automatically by the screen.script. It is expected that the
+-- caller of this function is a script component attached to the same game
+-- object as the proxy. This is required since monarch will acquire and
+-- release input focus of the game object where the proxy is attached.
+-- @param id Unique id of the screen
+-- @param proxy URL to the collection proxy containing the screen
+-- @param popup true the screen is a popup
+-- @param transition_url Optional URL to a script that is
+-- responsible for the screen transitions
+-- @param focus_url Optional URL to a script that is to be notified of
+-- focus lost/gained events
 function M.register(id, proxy, popup, transition_url, focus_url)
 	assert(not screens[id], ("There is already a screen registered with id %s"):format(tostring(id)))
+	assert(proxy, "You must provide a collection proxy URL")
+	local url = msg.url(proxy)
 	screens[id] = {
 		id = id,
 		proxy = proxy,
@@ -51,6 +93,9 @@ function M.register(id, proxy, popup, transition_url, focus_url)
 	}
 end
 
+--- Unregister a screen
+-- This is done automatically by the screen.script
+-- @param id Id of the screen to unregister
 function M.unregister(id)
 	assert(screens[id], ("There is no screen registered with id %s"):format(tostring(id)))
 	screens[id] = nil
@@ -60,17 +105,18 @@ local function show_out(screen, next_screen, cb)
 	local co
 	co = coroutine.create(function()
 		screen.co = co
-		msg.post(screen.script, "release_input_focus")
+		msg.post(screen.script, RELEASE_INPUT_FOCUS)
 		msg.post(screen.script, CONTEXT)
 		coroutine.yield()
 		if not next_screen.popup then
-			msg.post(screen.transition_url, "transition_show_out")
+			msg.post(screen.transition_url, M.TRANSITION.SHOW_OUT)
 			coroutine.yield()
-			msg.post(screen.proxy, "unload")
+			msg.post(screen.proxy, UNLOAD)
 			coroutine.yield()
+			screen.loaded = false
 		end
 		if screen.focus_url then
-			msg.post(screen.focus_url, M.FOCUS_LOST)
+			msg.post(screen.focus_url, M.FOCUS.LOST, {id = next_screen.id})
 		end
 		screen.co = nil
 		if cb then cb() end
@@ -78,21 +124,32 @@ local function show_out(screen, next_screen, cb)
 	coroutine.resume(co)
 end
 
-local function show_in(screen, cb)
+local function show_in(screen, previous_screen, reload, cb)
 	local co
 	co = coroutine.create(function()
 		screen.co = co
 		msg.post(screen.script, CONTEXT)
 		coroutine.yield()
-		msg.post(screen.proxy, "async_load")
-		coroutine.yield()
-		msg.post(screen.proxy, "enable")
+		if reload and screen.loaded then
+			msg.post(screen.proxy, UNLOAD)
+			coroutine.yield()
+			screen.loaded = false
+		end
+		-- the screen could be loaded if the previous screen was a popup
+		-- and the popup asked to show this screen again
+		-- in that case we shouldn't attempt to load it again
+		if not screen.loaded then
+			msg.post(screen.proxy, ASYNC_LOAD)
+			coroutine.yield()
+			msg.post(screen.proxy, ENABLE)
+			screen.loaded = true
+		end
 		stack[#stack + 1] = screen
-		msg.post(screen.transition_url, "transition_show_in")
+		msg.post(screen.transition_url, M.TRANSITION.SHOW_IN)
 		coroutine.yield()
-		msg.post(screen.script, "acquire_input_focus")
+		msg.post(screen.script, ACQUIRE_INPUT_FOCUS)
 		if screen.focus_url then
-			msg.post(screen.focus_url, M.FOCUS_GAINED)
+			msg.post(screen.focus_url, M.FOCUS.GAINED, {id = previous_screen and previous_screen.id})
 		end
 		screen.co = nil
 		if cb then cb() end
@@ -107,15 +164,16 @@ local function back_in(screen, previous_screen, cb)
 		msg.post(screen.script, CONTEXT)
 		coroutine.yield()
 		if not previous_screen.popup then
-			msg.post(screen.proxy, "async_load")
+			msg.post(screen.proxy, ASYNC_LOAD)
 			coroutine.yield()
-			msg.post(screen.proxy, "enable")
-			msg.post(screen.transition_url, "transition_back_in")
+			msg.post(screen.proxy, ENABLE)
+			screen.loaded = true
+			msg.post(screen.transition_url, M.TRANSITION.BACK_IN)
 			coroutine.yield()
 		end
-		msg.post(screen.script, "acquire_input_focus")
+		msg.post(screen.script, ACQUIRE_INPUT_FOCUS)
 		if screen.focus_url then
-			msg.post(screen.focus_url, M.FOCUS_GAINED)
+			msg.post(screen.focus_url, M.FOCUS.GAINED, {id = previous_screen.id})
 		end
 		screen.co = nil
 		if cb then cb() end
@@ -123,18 +181,20 @@ local function back_in(screen, previous_screen, cb)
 	coroutine.resume(co)
 end
 
-local function back_out(screen, cb)
+local function back_out(screen, next_screen, cb)
 	local co
 	co = coroutine.create(function()
 		screen.co = co
-		msg.post(screen.script, "release_input_focus")
+		msg.post(screen.script, RELEASE_INPUT_FOCUS)
 		msg.post(screen.script, CONTEXT)
 		coroutine.yield()
-		msg.post(screen.transition_url, "transition_back_out")
+		msg.post(screen.transition_url, M.TRANSITION.BACK_OUT)
 		coroutine.yield()
-		msg.post(screen.proxy, "unload")
+		msg.post(screen.proxy, UNLOAD)
+		coroutine.yield()
+		screen.loaded = false
 		if screen.focus_url then
-			msg.post(screen.focus_url, M.FOCUS_LOST)
+			msg.post(screen.focus_url, M.FOCUS.LOST, {id = next_screen and next_screen.id})
 		end
 		screen.co = nil
 		if cb then cb() end
@@ -152,12 +212,21 @@ function M.data(id)
 	return screens[id].data
 end
 
+--- Checks to see if a screen id is registered
+-- @param id Id of the screen to check if is registered
+-- @return True or False if the screen id is registered or not
+function M.screen_exists(id)
+	return screens[id] ~= nil
+end
+
 --- Show a new screen
 -- @param id Id of the screen to show
 -- @param options Table with options when showing the screen (can be nil). Valid values:
 -- 		* clear - Set to true if the stack should be cleared down to an existing instance of the screen
+-- 		* reload - Set to true if screen should be reloaded if it already exists in the stack and is loaded.
+--				  This would be the case if doing a show() from a popup on the screen just below the popup.
 -- @param data Optional data to set on the screen. Can be retrieved by the data() function
--- @ param cb Optional callback to invoke when screen is shown
+-- @param cb Optional callback to invoke when screen is shown
 function M.show(id, options, data, cb)
 	assert(id, "You must provide a screen id")
 	assert(screens[id], ("There is no screen registered with id %s"):format(tostring(id)))
@@ -177,7 +246,7 @@ function M.show(id, options, data, cb)
 			top = stack[#stack]
 		end
 		-- unload and transition out from top
-		if top then
+		if top and top.id ~= screen.id then
 			show_out(top, screen)
 		end
 	end
@@ -186,17 +255,14 @@ function M.show(id, options, data, cb)
 	-- already and the clear flag is set then we need
 	-- to remove every screen on the stack up until and
 	-- including the screen itself
-	if options and options.clear and in_stack(id) then
-		while true do
-			if table.remove(stack).id == id then
-				break
-			end
-
+	if options and options.clear then
+		while M.in_stack(id) do
+			table.remove(stack)
 		end
 	end
 
 	-- show screen
-	show_in(screen, cb)
+	show_in(screen, top, options and options.reload, cb)
 end
 
 
@@ -206,11 +272,11 @@ end
 function M.back(data, cb)
 	local screen = table.remove(stack)
 	if screen then
-		back_out(screen, cb)
 		local top = stack[#stack]
+		back_out(screen, top, cb)
 		if top then
 			if data then
-				screen.data = data
+				top.data = data
 			end
 			back_in(top, screen)
 		end
@@ -228,20 +294,33 @@ function M.on_message(message_id, message, sender)
 	elseif message_id == PROXY_UNLOADED then
 		local screen = screen_from_proxy(sender)
 		assert(screen, "Unable to find screen for unloaded proxy")
+		coroutine.resume(screen.co)
 	elseif message_id == CONTEXT then
 		local screen = screen_from_script()
 		assert(screen, "Unable to find screen for current script url")
 		coroutine.resume(screen.co)
-	elseif message_id == M.TRANSITION_DONE then
+	elseif message_id == M.TRANSITION.DONE then
 		local screen = screen_from_script()
 		assert(screen, "Unable to find screen for current script url")
 		coroutine.resume(screen.co)
 	end
 end
 
+--- Get a list of ids for the current screen stack
+-- (primarily used for unit testing, but could have uses outside testing)
+-- @return Table with screen ids. First entry is at the bottom of the
+-- stack and the last value is at the top (and currently visible)
+function M.get_stack()
+	local s = {}
+	for k,v in pairs(stack) do
+		s[k] = v.id
+	end
+	return s
+end
+
 function M.dump_stack()
 	local s = ""
-	for i,screen in ipairs(stack) do
+	for i, screen in ipairs(stack) do
 		s = s .. ("%d = %s\n"):format(i, tostring(screen.id))
 	end
 	return s

monarch/screen.script

@@ -1,4 +1,4 @@
-local monarch = require "monarch.monarch"
+local monarch
 
 go.property("screen_proxy", msg.url("#collectionproxy"))
 go.property("screen_id", hash(""))
@@ -8,6 +8,7 @@ go.property("focus_url", msg.url())
 
 
 function init(self)
+	monarch = require "monarch.monarch"
 	monarch.register(self.screen_id, self.screen_proxy, self.popup, self.transition_url, self.focus_url)
 end
 
@@ -22,11 +23,11 @@ function on_message(self, message_id, message, sender)
 		monarch.back()
 	elseif message_id == hash("back") then
 		monarch.back()
-	elseif message_id == hash("transition_show_in")
-		or message_id == hash("transition_show_out")
-		or message_id == hash("transition_back_in")
-		or message_id == hash("transition_back_out") then
-		msg.post(sender, "transition_done")
+	elseif message_id == monarch.TRANSITION.SHOW_IN
+		or message_id == monarch.TRANSITION.SHOW_OUT
+		or message_id == monarch.TRANSITION.BACK_IN
+		or message_id == monarch.TRANSITION.BACK_OUT then
+			msg.post(sender, monarch.TRANSITION.DONE)
 	else
 		monarch.on_message(message_id, message, sender)
 	end

monarch/transitions/gui.lua

@@ -1,3 +1,5 @@
+local monarch = require "monarch.monarch"
+
 local M = {}
 
 local WIDTH = tonumber(sys.get_config("display.width"))
@@ -6,34 +8,36 @@ local HEIGHT = tonumber(sys.get_config("display.height"))
 local LEFT = vmath.vector3(-WIDTH * 2, 0, 0)
 local RIGHT = vmath.vector3(WIDTH * 2, 0, 0)
 local TOP = vmath.vector3(0, HEIGHT * 2, 0)
-local BOTTOM = vmath.vector3(0, -HEIGHT * 2, 0)
+local BOTTOM = vmath.vector3(0, - HEIGHT * 2, 0)
+
+local ZERO_SCALE = vmath.vector3(0, 0, 1)
 
 function M.instant(node, to, easing, duration, delay, url)
-	msg.post(url, "transition_done")
+	msg.post(url, monarch.TRANSITION.DONE)
 end
 
 local function slide_in(direction, node, to, easing, duration, delay, url)
 	local from = to + direction
 	gui.set_position(node, from)
 	gui.animate(node, gui.PROP_POSITION, to, easing, duration, delay, function()
-		msg.post(url, "transition_done")
+		msg.post(url, monarch.TRANSITION.DONE)
 	end)
 end
 
 function M.slide_in_left(node, to, easing, duration, delay, url)
-	return slide_in(LEFT, node, to, easing, duration, delay, url)
+	return slide_in(LEFT, node, to.pos, easing, duration, delay, url)
 end
 
 function M.slide_in_right(node, to, easing, duration, delay, url)
-	slide_in(RIGHT, node, to, easing, duration, delay, url)
+	slide_in(RIGHT, node, to.pos, easing, duration, delay, url)
 end
 
 function M.slide_in_top(node, to, easing, duration, delay, url)
-	slide_in(TOP, node, to, easing, duration, delay, url)
+	slide_in(TOP, node, to.pos, easing, duration, delay, url)
 end
 
 function M.slide_in_bottom(node, to, easing, duration, delay, url)
-	slide_in(BOTTOM, node, to, easing, duration, delay, url)
+	slide_in(BOTTOM, node, to.pos, easing, duration, delay, url)
 end
 
 
@@ -41,24 +45,38 @@ local function slide_out(direction, node, from, easing, duration, delay, url)
 	local to = from + direction
 	gui.set_position(node, from)
 	gui.animate(node, gui.PROP_POSITION, to, easing, duration, delay, function()
-		msg.post(url, "transition_done")
+		msg.post(url, monarch.TRANSITION.DONE)
 	end)
 end
 
 function M.slide_out_left(node, from, easing, duration, delay, url)
-	slide_out(LEFT, node, from, easing, duration, delay, url)
+	slide_out(LEFT, node, from.pos, easing, duration, delay, url)
 end
 
 function M.slide_out_right(node, from, easing, duration, delay, url)
-	slide_out(RIGHT, node, from, easing, duration, delay, url)
+	slide_out(RIGHT, node, from.pos, easing, duration, delay, url)
 end
 
 function M.slide_out_top(node, from, easing, duration, delay, url)
-	slide_out(TOP, node, from, easing, duration, delay, url)
+	slide_out(TOP, node, from.pos, easing, duration, delay, url)
 end
 
 function M.slide_out_bottom(node, from, easing, duration, delay, url)
-	slide_out(BOTTOM, node, from, easing, duration, delay, url)
+	slide_out(BOTTOM, node, from.pos, easing, duration, delay, url)
+end
+
+function M.scale_in(node, to, easing, duration, delay, url)
+	gui.set_scale(node, ZERO_SCALE)
+	gui.animate(node, gui.PROP_SCALE, to.scale, easing, duration, delay, function()
+		msg.post(url, monarch.TRANSITION.DONE)
+	end)
+end
+
+function M.scale_out(node, from, easing, duration, delay, url)
+	gui.set_scale(node, from.scale)
+	gui.animate(node, gui.PROP_SCALE, ZERO_SCALE, easing, duration, delay, function()
+		msg.post(url, monarch.TRANSITION.DONE)
+	end)
 end
 
 --- Create a transition for a node
@@ -69,13 +87,15 @@ function M.create(node)
 	local instance = {}
 
 	local transitions = {
-		[hash("transition_show_in")] = M.instant,
-		[hash("transition_show_out")] = M.instant,
-		[hash("transition_back_in")] = M.instant,
-		[hash("transition_back_out")] = M.instant,
+		[monarch.TRANSITION.SHOW_IN] = M.instant,
+		[monarch.TRANSITION.SHOW_OUT] = M.instant,
+		[monarch.TRANSITION.BACK_IN] = M.instant,
+		[monarch.TRANSITION.BACK_OUT] = M.instant,
 	}
 
-	local initial_position = gui.get_position(node)
+	local initial_data = {}
+	initial_data.pos = gui.get_position(node)
+	initial_data.scale = gui.get_scale(node)
 
 	-- Forward on_message calls here
 	function instance.handle(message_id, message, sender)
@@ -91,8 +111,8 @@ function M.create(node)
 	-- @param duration Transition duration
 	-- @param delay Transition delay
 	function instance.show_in(fn, easing, duration, delay)
-		transitions[hash("transition_show_in")] = function(url)
-			fn(node, initial_position, easing, duration, delay or 0, url)
+		transitions[monarch.TRANSITION.SHOW_IN] = function(url)
+			fn(node, initial_data, easing, duration, delay or 0, url)
 		end
 		return instance
 	end
@@ -100,8 +120,8 @@ function M.create(node)
 	-- Specify the transition function when this node is transitioned
 	-- from when showing another screen
 	function instance.show_out(fn, easing, duration, delay)
-		transitions[hash("transition_show_out")] = function(url)
-			fn(node, initial_position, easing, duration, delay or 0, url)
+		transitions[monarch.TRANSITION.SHOW_OUT] = function(url)
+			fn(node, initial_data, easing, duration, delay or 0, url)
 		end
 		return instance
 	end
@@ -109,8 +129,8 @@ function M.create(node)
 	--- Specify the transition function when this node is transitioned
 	-- to when navigating back in the screen stack
 	function instance.back_in(fn, easing, duration, delay)
-		transitions[hash("transition_back_in")] = function(url)
-			fn(node, initial_position, easing, duration, delay or 0, url)
+		transitions[monarch.TRANSITION.BACK_IN] = function(url)
+			fn(node, initial_data, easing, duration, delay or 0, url)
 		end
 		return instance
 	end
@@ -118,8 +138,8 @@ function M.create(node)
 	--- Specify the transition function when this node is transitioned
 	-- from when navigating back in the screen stack
 	function instance.back_out(fn, easing, duration, delay)
-		transitions[hash("transition_back_out")] = function(url)
-			fn(node, initial_position, easing, duration, delay or 0, url)
+		transitions[monarch.TRANSITION.BACK_OUT] = function(url)
+			fn(node, initial_data, easing, duration, delay or 0, url)
 		end
 		return instance
 	end

test/cowait.lua

@@ -0,0 +1,48 @@
+local M = {}
+
+
+local instances = {}
+
+local function create(fn)
+	local instance = {
+		co = coroutine.running(),
+		fn = fn,
+	}
+	table.insert(instances, instance)
+	coroutine.yield(instance.co)
+end
+
+	
+
+function M.seconds(amount)
+	local time = socket.gettime() + amount
+	create(function()
+		return socket.gettime() >= time
+	end)
+end
+
+
+function M.eval(fn)
+	create(fn)
+end
+
+function M.update()
+	for k,instance in pairs(instances) do
+		if instance.fn() then
+			instances[k] = nil
+			coroutine.resume(instance.co)
+		end
+	end
+end
+
+return setmetatable(M, {
+	__call = function(self, arg1, ...)
+		if type(arg1) == "number" then
+			return M.seconds(arg1, ...)
+		elseif type(arg1) == "function" then
+			return M.eval(arg1, ...)
+		else
+			error("Unknown argument type")
+		end
+	end
+})

test/cowait.script

@@ -0,0 +1,5 @@
+local cowait = require "test.cowait"
+
+function update(self, dt)
+	cowait.update()
+end

test/data/screen1.collection

@@ -0,0 +1,37 @@
+name: "screen1"
+scale_along_z: 0
+embedded_instances {
+  id: "go"
+  data: "components {\n"
+  "  id: \"screen1\"\n"
+  "  component: \"/test/data/screen1.gui\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}

test/data/screen1.gui

@@ -0,0 +1,131 @@
+script: "/test/data/screen1.gui_script"
+fonts {
+  name: "example"
+  font: "/assets/example.font"
+}
+background_color {
+  x: 0.0
+  y: 0.0
+  z: 0.0
+  w: 0.0
+}
+nodes {
+  position {
+    x: 320.0
+    y: 568.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "box"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "1"
+  font: "example"
+  id: "text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "box"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+material: "/builtins/materials/gui.material"
+adjust_reference: ADJUST_REFERENCE_PARENT
+max_nodes: 512

test/data/screen1.gui_script

@@ -0,0 +1,12 @@
+function init(self)
+	print("init - screen1")
+end
+
+function final(self)
+	print("final - screen1")
+end
+
+function on_message(self, message_id, message, sender)
+	-- Add message-handling code here
+	-- Remove this function if not needed
+end

test/data/screen2.collection

@@ -0,0 +1,37 @@
+name: "screen2"
+scale_along_z: 0
+embedded_instances {
+  id: "go"
+  data: "components {\n"
+  "  id: \"screen2\"\n"
+  "  component: \"/test/data/screen2.gui\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}

test/data/screen2.gui

@@ -0,0 +1,131 @@
+script: "/test/data/screen2.gui_script"
+fonts {
+  name: "example"
+  font: "/assets/example.font"
+}
+background_color {
+  x: 0.0
+  y: 0.0
+  z: 0.0
+  w: 0.0
+}
+nodes {
+  position {
+    x: 320.0
+    y: 697.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  type: TYPE_BOX
+  blend_mode: BLEND_MODE_ALPHA
+  texture: ""
+  id: "box"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  adjust_mode: ADJUST_MODE_FIT
+  layer: ""
+  inherit_alpha: true
+  slice9 {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 0.0
+  }
+  clipping_mode: CLIPPING_MODE_NONE
+  clipping_visible: true
+  clipping_inverted: false
+  alpha: 1.0
+  template_node_child: false
+  size_mode: SIZE_MODE_AUTO
+}
+nodes {
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  size {
+    x: 200.0
+    y: 100.0
+    z: 0.0
+    w: 1.0
+  }
+  color {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  type: TYPE_TEXT
+  blend_mode: BLEND_MODE_ALPHA
+  text: "2"
+  font: "example"
+  id: "text"
+  xanchor: XANCHOR_NONE
+  yanchor: YANCHOR_NONE
+  pivot: PIVOT_CENTER
+  outline {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  shadow {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+    w: 1.0
+  }
+  adjust_mode: ADJUST_MODE_FIT
+  line_break: false
+  parent: "box"
+  layer: ""
+  inherit_alpha: true
+  alpha: 1.0
+  outline_alpha: 1.0
+  shadow_alpha: 1.0
+  template_node_child: false
+  text_leading: 1.0
+  text_tracking: 0.0
+}
+material: "/builtins/materials/gui.material"
+adjust_reference: ADJUST_REFERENCE_PARENT
+max_nodes: 512

test/data/screen2.gui_script

@@ -0,0 +1,12 @@
+function init(self)
+	print("init - screen2")
+end
+
+function final(self)
+	print("final - screen2")
+end
+
+function on_message(self, message_id, message, sender)
+	-- Add message-handling code here
+	-- Remove this function if not needed
+end

test/data/screens.collection

@@ -0,0 +1,118 @@
+name: "screens"
+scale_along_z: 0
+embedded_instances {
+  id: "screen1"
+  data: "components {\n"
+  "  id: \"screen\"\n"
+  "  component: \"/monarch/screen.script\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "  properties {\n"
+  "    id: \"screen_id\"\n"
+  "    value: \"screen1\"\n"
+  "    type: PROPERTY_TYPE_HASH\n"
+  "  }\n"
+  "}\n"
+  "embedded_components {\n"
+  "  id: \"collectionproxy\"\n"
+  "  type: \"collectionproxy\"\n"
+  "  data: \"collection: \\\"/test/data/screen1.collection\\\"\\n"
+  "exclude: false\\n"
+  "\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}
+embedded_instances {
+  id: "screen2"
+  data: "components {\n"
+  "  id: \"screen\"\n"
+  "  component: \"/monarch/screen.script\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "  properties {\n"
+  "    id: \"screen_id\"\n"
+  "    value: \"screen2\"\n"
+  "    type: PROPERTY_TYPE_HASH\n"
+  "  }\n"
+  "}\n"
+  "embedded_components {\n"
+  "  id: \"collectionproxy\"\n"
+  "  type: \"collectionproxy\"\n"
+  "  data: \"collection: \\\"/test/data/screen2.collection\\\"\\n"
+  "exclude: false\\n"
+  "\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}

test/test.collection

@@ -0,0 +1,70 @@
+name: "test"
+scale_along_z: 0
+embedded_instances {
+  id: "go"
+  data: "components {\n"
+  "  id: \"test\"\n"
+  "  component: \"/test/test.script\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  "components {\n"
+  "  id: \"cowait\"\n"
+  "  component: \"/test/cowait.script\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  "embedded_components {\n"
+  "  id: \"screensfactory\"\n"
+  "  type: \"collectionfactory\"\n"
+  "  data: \"prototype: \\\"/test/data/screens.collection\\\"\\n"
+  "load_dynamically: false\\n"
+  "\"\n"
+  "  position {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "  }\n"
+  "  rotation {\n"
+  "    x: 0.0\n"
+  "    y: 0.0\n"
+  "    z: 0.0\n"
+  "    w: 1.0\n"
+  "  }\n"
+  "}\n"
+  ""
+  position {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+  }
+  rotation {
+    x: 0.0
+    y: 0.0
+    z: 0.0
+    w: 1.0
+  }
+  scale3 {
+    x: 1.0
+    y: 1.0
+    z: 1.0
+  }
+}

test/test.script

@@ -0,0 +1,9 @@
+local deftest = require "deftest.deftest"
+
+local test_monarch = require "test.test_monarch"
+
+
+function init(self)
+	deftest.add(test_monarch)
+	deftest.run()
+end

test/test_monarch.lua

@@ -0,0 +1,135 @@
+local cowait = require "test.cowait"
+local monarch = require "monarch.monarch"
+
+local SCREEN1 = hash("screen1")
+local SCREEN2 = hash("screen2")
+local FOOBAR = hash("foobar")
+
+return function()
+
+	local screens_instances = {}
+
+	local function is_shown(screen_id)
+		return monarch.is_top(screen_id)
+	end
+
+	local function is_hidden(screen_id)
+		return not monarch.is_top(screen_id)
+	end
+
+	local function wait_timeout(fn, ...)
+		local args = { ... }
+		local time = socket.gettime()
+		cowait(function()
+			return fn(unpack(args)) or socket.gettime() > time + 5	
+		end)
+		return fn(...)
+	end
+		
+	local function wait_until_shown(screen_id)
+		return wait_timeout(is_shown, screen_id)
+	end
+	local function wait_until_hidden(screen_id)
+		return wait_timeout(is_hidden, screen_id)
+	end
+
+	local function assert_stack(expected_screens)
+		local actual_screens = monarch.get_stack()
+		if #actual_screens ~= #expected_screens then
+			error("Stack length mismatch", 2)
+		end
+		for i=1,#actual_screens do
+			if actual_screens[i] ~= expected_screens[i] then
+				error("Stack content not matching", 2)
+			end
+		end
+	end
+
+	
+	describe("monarch", function()
+		before(function()
+			monarch = require "monarch.monarch"
+			screens_instances = collectionfactory.create("#screensfactory")
+		end)
+
+		after(function()
+			package.loaded["monarch.monarch"] = nil
+			for id,instance_id in pairs(screens_instances) do
+				go.delete(instance_id)
+			end
+			cowait(0.1)
+		end)
+
+
+		it("should be able to tell if a screen exists", function()
+			assert(monarch.screen_exists(SCREEN1))
+			assert(not monarch.screen_exists(hash("foobar")))
+		end)
+
+
+		it("should be able to show screens and go back to previous screens", function()
+			monarch.show(SCREEN1)
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+			assert_stack({ SCREEN1 })
+
+			monarch.show(SCREEN2)
+			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
+			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
+			assert_stack({ SCREEN1, SCREEN2 })
+
+			monarch.back()
+			assert(wait_until_hidden(SCREEN2), "Screen2 was never hidden")
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+			assert_stack({ SCREEN1 })
+
+			monarch.back()
+			assert(wait_until_hidden(SCREEN1), "Screen1 was never hidden")
+			assert_stack({ })
+		end)
+
+
+		it("should be able to pass data to a screen when showning it or going back to it", function()
+			local data1 = { foo = "bar" }
+			monarch.show(SCREEN1, nil, data1)
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+
+			local data2 = { boo = "car" }
+			monarch.show(SCREEN2, nil, data2)
+			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
+			
+			assert(monarch.data(SCREEN1) == data1, "Expected data on screen1 doesn't match actual data")
+			assert(monarch.data(SCREEN2) == data2, "Expected data on screen2 doesn't match actual data")
+
+			local data_back = { going = "back" }
+			monarch.back(data_back)
+			assert_stack({ SCREEN1 })
+
+			assert(monarch.data(SCREEN1) == data_back, "Expected data on screen1 doesn't match actual data")
+		end)
+
+
+		it("should be able to show the same screen twice", function()
+			monarch.show(SCREEN1)
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+			assert_stack({ SCREEN1 })
+			monarch.show(SCREEN1)
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+			assert_stack({ SCREEN1, SCREEN1 })
+		end)
+		
+
+		it("should be able to clear the stack if trying to show the same screen twice", function()
+			monarch.show(SCREEN1)
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+			assert_stack({ SCREEN1 })
+			monarch.show(SCREEN2)
+			assert(wait_until_shown(SCREEN2), "Screen2 was never shown")
+			assert_stack({ SCREEN1, SCREEN2 })
+			monarch.show(SCREEN1, { clear = true })
+			assert(wait_until_shown(SCREEN1), "Screen1 was never shown")
+			assert_stack({ SCREEN1 })
+		end)
+		
+						
+	end)
+end