Merge pull request #140 from boydm/update_callbacks

Update callbacks and new push model

Author: boydm

lib/scenic/cache/base.ex

@@ -119,10 +119,7 @@ defmodule Scenic.Cache.Base do
           # load the asset into the cache (run time)
           Scenic.Cache.Static.Texture.load(@asset_path, @asset_hash)
 
-          # push the graph. (run time)
-          push_graph(@graph)
-
-          {:ok, @graph}
+          {:ok, :some_state, push: @graph}
         end
 
       end
@@ -284,10 +281,7 @@ defmodule Scenic.Cache.Base do
               # load the asset into the cache (run time)
               Scenic.Cache.File.load(@asset_path, @asset_hash)
 
-              # push the graph. (run time)
-              push_graph(@graph)
-
-              {:ok, @graph}
+              {:ok, :some_state, push: @graph}
             end
 
           end

lib/scenic/cache/support/file.ex

@@ -73,10 +73,7 @@ defmodule Scenic.Cache.Support.File do
           # load the asset into the texture cache (at run time)
           Scenic.Cache.Static.Texture.load(@asset_path, @asset_hash)
 
-          # push the graph.
-          push_graph(@graph)
-
-          {:ok, @graph}
+          {:ok, :some_state, push: @graph}
         end
 
       end

lib/scenic/cache/support/hash.ex

@@ -40,7 +40,6 @@ defmodule Scenic.Cache.Support.Hash do
 
   # --------------------------------------------------------
   @doc false
-  @deprecated "Cache.valid_hash_types/0 will be removed in 0.10.0"
   @spec valid_hash_types() :: [:ripemd160 | :sha | :sha224 | :sha256 | :sha384 | :sha512, ...]
   def valid_hash_types(), do: @hash_types
 

lib/scenic/component.ex

@@ -57,8 +57,7 @@ defmodule Scenic.Component do
       use Scenic.Component, has_children: false
 
   Setting `has_children` to `false` this will do two things. First, it won't create
-  a dynamic supervisor for this scene, which saves some resources. Second,
-  `push_graph/1` goes through a fast pass that doesn't scan the graph for dynamic children.
+  a dynamic supervisor for this scene, which saves some resources.
 
   For example, the Button component sets `has_children` to `false`.
 

lib/scenic/component/button.ex

@@ -160,9 +160,7 @@ defmodule Scenic.Component.Button do
       id: id
     }
 
-    push_graph(graph)
-
-    {:ok, state}
+    {:ok, state, push: graph}
   end
 
   defp do_aligned_text(graph, :center, text, fill, width, vpos) do
@@ -214,8 +212,7 @@ defmodule Scenic.Component.Button do
         } = state
       ) do
     state = Map.put(state, :contained, true)
-    update_color(state)
-    {:noreply, state}
+    {:noreply, state, push: update_color(state)}
   end
 
   # --------------------------------------------------------
@@ -227,8 +224,7 @@ defmodule Scenic.Component.Button do
         } = state
       ) do
     state = Map.put(state, :contained, false)
-    update_color(state)
-    {:noreply, state}
+    {:noreply, state, push: update_color(state)}
   end
 
   # --------------------------------------------------------
@@ -242,7 +238,7 @@ defmodule Scenic.Component.Button do
 
     ViewPort.capture_input(context, [:cursor_button, :cursor_pos])
 
-    {:noreply, state}
+    {:noreply, state, push: update_color(state)}
   end
 
   # --------------------------------------------------------
@@ -260,7 +256,7 @@ defmodule Scenic.Component.Button do
       send_event({:click, id})
     end
 
-    {:noreply, state}
+    {:noreply, state, push: update_color(state)}
   end
 
   # --------------------------------------------------------
@@ -276,29 +272,25 @@ defmodule Scenic.Component.Button do
       p
       |> Primitive.put_style(:fill, theme.background)
     end)
-    |> push_graph()
   end
 
   defp update_color(%{graph: graph, theme: theme, pressed: false, contained: true}) do
     Graph.modify(graph, :btn, fn p ->
       p
       |> Primitive.put_style(:fill, theme.background)
     end)
-    |> push_graph()
   end
 
   defp update_color(%{graph: graph, theme: theme, pressed: true, contained: false}) do
     Graph.modify(graph, :btn, fn p ->
       p
       |> Primitive.put_style(:fill, theme.background)
     end)
-    |> push_graph()
   end
 
   defp update_color(%{graph: graph, theme: theme, pressed: true, contained: true}) do
     Graph.modify(graph, :btn, fn p ->
       Primitive.put_style(p, :fill, theme.active)
     end)
-    |> push_graph()
   end
 end

lib/scenic/component/input/caret.ex

@@ -82,7 +82,6 @@ defmodule Scenic.Component.Input.Caret do
         hidden: true,
         id: :caret
       )
-      |> push_graph()
 
     state = %{
       graph: graph,
@@ -91,39 +90,33 @@ defmodule Scenic.Component.Input.Caret do
       focused: false
     }
 
-    {:ok, state}
+    {:ok, state, push: graph}
   end
 
   # --------------------------------------------------------
   @doc false
   def handle_cast(:start_caret, %{graph: graph, timer: nil} = state) do
     # turn on the caret
-    graph =
-      graph
-      |> Graph.modify(:caret, &update_opts(&1, hidden: false))
-      |> push_graph()
+    graph = Graph.modify(graph, :caret, &update_opts(&1, hidden: false))
 
     # start the timer
     {:ok, timer} = :timer.send_interval(@caret_ms, :blink)
 
-    {:noreply, %{state | graph: graph, hidden: false, timer: timer, focused: true}}
+    {:noreply, %{state | graph: graph, hidden: false, timer: timer, focused: true}, push: graph}
   end
 
   # --------------------------------------------------------
   def handle_cast(:stop_caret, %{graph: graph, timer: timer} = state) do
     # hide the caret
-    graph =
-      graph
-      |> Graph.modify(:caret, &update_opts(&1, hidden: true))
-      |> push_graph()
+    graph = Graph.modify(graph, :caret, &update_opts(&1, hidden: true))
 
     # stop the timer
     case timer do
       nil -> :ok
       timer -> :timer.cancel(timer)
     end
 
-    {:noreply, %{state | graph: graph, hidden: true, timer: nil, focused: false}}
+    {:noreply, %{state | graph: graph, hidden: true, timer: nil, focused: false}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -132,18 +125,15 @@ defmodule Scenic.Component.Input.Caret do
         %{graph: graph, timer: timer, focused: true} = state
       ) do
     # show the caret
-    graph =
-      graph
-      |> Graph.modify(:caret, &update_opts(&1, hidden: false))
-      |> push_graph()
+    graph = Graph.modify(graph, :caret, &update_opts(&1, hidden: false))
 
     # stop the timer
     if timer, do: :timer.cancel(timer)
 
     # restart the timer
     {:ok, timer} = :timer.send_interval(@caret_ms, :blink)
 
-    {:noreply, %{state | graph: graph, hidden: false, timer: timer}}
+    {:noreply, %{state | graph: graph, hidden: false, timer: timer}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -156,11 +146,8 @@ defmodule Scenic.Component.Input.Caret do
     # invert the hidden flag
     hidden = !hidden
 
-    graph =
-      graph
-      |> Graph.modify(:caret, &update_opts(&1, hidden: hidden))
-      |> push_graph()
+    graph = Graph.modify(graph, :caret, &update_opts(&1, hidden: hidden))
 
-    {:noreply, %{state | graph: graph, hidden: hidden}}
+    {:noreply, %{state | graph: graph, hidden: hidden}, push: graph}
   end
 end

lib/scenic/component/input/checkbox.ex

@@ -150,24 +150,22 @@ defmodule Scenic.Component.Input.Checkbox do
       id: id
     }
 
-    push_graph(graph)
-
-    {:ok, state}
+    {:ok, state, push: graph}
   end
 
   # --------------------------------------------------------
   @doc false
   def handle_input({:cursor_enter, _uid}, _, %{pressed: true} = state) do
     state = Map.put(state, :contained, true)
     graph = update_graph(state)
-    {:noreply, %{state | graph: graph}}
+    {:noreply, %{state | graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
   def handle_input({:cursor_exit, _uid}, _, %{pressed: true} = state) do
     state = Map.put(state, :contained, false)
     graph = update_graph(state)
-    {:noreply, %{state | graph: graph}}
+    {:noreply, %{state | graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -181,7 +179,7 @@ defmodule Scenic.Component.Input.Checkbox do
 
     ViewPort.capture_input(context, [:cursor_button, :cursor_pos])
 
-    {:noreply, %{state | graph: graph}}
+    {:noreply, %{state | graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -208,7 +206,7 @@ defmodule Scenic.Component.Input.Checkbox do
 
     graph = update_graph(state)
 
-    {:noreply, %{state | graph: graph}}
+    {:noreply, %{state | graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -243,6 +241,5 @@ defmodule Scenic.Component.Input.Checkbox do
       false ->
         Graph.modify(graph, :chx, &Primitive.put_style(&1, :hidden, true))
     end
-    |> push_graph()
   end
 end

lib/scenic/component/input/dropdown.ex

@@ -279,9 +279,7 @@ defmodule Scenic.Component.Input.Dropdown do
       rotate_caret: rotate_caret
     }
 
-    push_graph(graph)
-
-    {:ok, state}
+    {:ok, state, push: graph}
   end
 
   # ============================================================================
@@ -312,15 +310,14 @@ defmodule Scenic.Component.Input.Dropdown do
       graph
       |> Graph.modify(@caret_id, &update_opts(&1, rotate: rotate_caret))
       |> Graph.modify(@dropbox_id, &update_opts(&1, hidden: false))
-      |> push_graph()
 
     state =
       state
       |> Map.put(:down, true)
       |> Map.put(:drop_time, :os.system_time(:milli_seconds))
       |> Map.put(:graph, graph)
 
-    {:noreply, state}
+    {:noreply, state, push: graph}
   end
 
   # ============================================================================
@@ -333,11 +330,9 @@ defmodule Scenic.Component.Input.Dropdown do
         %{down: true, items: items, graph: graph, selected_id: selected_id, theme: theme} = state
       ) do
     # set the appropriate hilighting for each of the items
-    graph =
-      update_highlighting(graph, items, selected_id, id, theme)
-      |> push_graph
+    graph = update_highlighting(graph, items, selected_id, id, theme)
 
-    {:noreply, %{state | hover_id: id, graph: graph}}
+    {:noreply, %{state | hover_id: id, graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -347,11 +342,9 @@ defmodule Scenic.Component.Input.Dropdown do
         %{down: true, items: items, graph: graph, selected_id: selected_id, theme: theme} = state
       ) do
     # set the appropriate hilighting for each of the items
-    graph =
-      update_highlighting(graph, items, selected_id, nil, theme)
-      |> push_graph
+    graph = update_highlighting(graph, items, selected_id, nil, theme)
 
-    {:noreply, %{state | hover_id: nil, graph: graph}}
+    {:noreply, %{state | hover_id: nil, graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -377,10 +370,8 @@ defmodule Scenic.Component.Input.Dropdown do
       # raise the dropdown
       |> Graph.modify(@caret_id, &update_opts(&1, rotate: @rotate_neutral))
       |> Graph.modify(@dropbox_id, &update_opts(&1, hidden: true))
-      # push to the viewport
-      |> push_graph()
 
-    {:noreply, %{state | down: false, graph: graph}}
+    {:noreply, %{state | down: false, graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -407,12 +398,11 @@ defmodule Scenic.Component.Input.Dropdown do
         |> update_highlighting(items, selected_id, nil, theme)
         |> Graph.modify(@caret_id, &update_opts(&1, rotate: @rotate_neutral))
         |> Graph.modify(@dropbox_id, &update_opts(&1, hidden: true))
-        |> push_graph()
 
       # release the input capture
       ViewPort.release_input(context, [:cursor_button, :cursor_pos])
 
-      {:noreply, %{state | down: false, hover_id: nil, graph: graph}}
+      {:noreply, %{state | down: false, hover_id: nil, graph: graph}, push: graph}
     end
   end
 
@@ -438,10 +428,8 @@ defmodule Scenic.Component.Input.Dropdown do
       # raise the dropdown
       |> Graph.modify(@caret_id, &update_opts(&1, rotate: @rotate_neutral))
       |> Graph.modify(@dropbox_id, &update_opts(&1, hidden: true))
-      # push to the viewport
-      |> push_graph()
 
-    {:noreply, %{state | down: false, graph: graph}}
+    {:noreply, %{state | down: false, graph: graph}, push: graph}
   end
 
   # --------------------------------------------------------
@@ -474,10 +462,8 @@ defmodule Scenic.Component.Input.Dropdown do
       # raise the dropdown
       |> Graph.modify(@caret_id, &update_opts(&1, rotate: @rotate_neutral))
       |> Graph.modify(@dropbox_id, &update_opts(&1, hidden: true))
-      # push to the viewport
-      |> push_graph()
 
-    {:noreply, %{state | down: false, graph: graph, selected_id: item_id}}
+    {:noreply, %{state | down: false, graph: graph, selected_id: item_id}, push: graph}
   end
 
   # ============================================================================