cura 0.0.1

data/lib/cura/event/middleware/base.rb

@@ -0,0 +1,21 @@
+module Cura
+  module Event
+    module Middleware
+      
+      # The base class for event middleware.
+      class Base
+        
+        # Call this middleware.
+        #
+        # @param [#to_h] options
+        # @option options [Event::Dispatcher] :dispatcher
+        # @option options [Event::Base] :event
+        def call(_options={})
+          # Does nothing on purpose
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/cura/event/middleware/dispatch.rb

@@ -0,0 +1,20 @@
+module Cura
+  module Event
+    module Middleware
+      
+      # Dispatches the event.
+      class Dispatch < Base
+        
+        # Dispatch the event.
+        #
+        # @param [#to_h] options
+        # @option options [Event::Base] :event
+        def call(options={})
+          options[:dispatch_queue] << options[:event]
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/cura/event/middleware/translator/base.rb

@@ -0,0 +1,37 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/middleware/base"
+end
+
+module Cura
+  module Event
+    module Middleware
+      module Translator
+        
+        # The base class for event middleware which detects multiple events and dispatches a new one when found.
+        class Base
+          
+          # Call this middleware.
+          #
+          # @param [#to_h] options
+          # @option options [Event::Dispatcher] :dispatcher
+          # @option options [Event::Base] :event
+          def call(options={})
+            translate_event(options) if should_translate?(options)
+          end
+          
+          protected
+          
+          def should_translate?(_options={})
+            false
+          end
+          
+          def translate_event(_options={})
+            # Does nothing on purpose
+          end
+          
+        end
+        
+      end
+    end
+  end
+end

data/lib/cura/event/middleware/translator/mouse_click.rb

@@ -0,0 +1,44 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/mouse_button"
+  require "cura/event/middleware/translator/base"
+end
+
+module Cura
+  module Event
+    module Middleware
+      module Translator
+        
+        # Translates MouseDown and MouseUp events into a MouseClick event.
+        class MouseClick < Base
+          
+          def initialize
+            @last_mouse_down_at = Time.now
+          end
+          
+          # Call this middleware.
+          #
+          # @param [#to_h] options
+          # @option options [Event::Dispatcher] :dispatcher
+          # @option options [Event::Base] :event
+          def call(options={})
+            event = options[:event]
+            
+            return unless event.is_a?(Event::Mouse)
+            
+            if event.down?
+              @last_mouse_down_at = event.created_at
+              @last_target = event.target
+            elsif event.up? && event.created_at > @last_mouse_down_at && @last_target.respond_to?(:contains_coordinates) && @last_target.contains_coordinates?(x: event.x, y: event.y)
+              @last_mouse_down_at = nil
+              @last_target = nil
+              
+              options[:dispatch_queue] << Event.new_from_name(:mouse_button, state: :click, target: event.target, x: event.x, y: event.y) # TODO: Left? Right? Termbox can't tell..
+            end
+          end
+          
+        end
+        
+      end
+    end
+  end
+end

data/lib/cura/event/mouse.rb

@@ -0,0 +1,34 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/base"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when a mouse's button state changes.
+    class Mouse < Base
+      
+      # Get the X coordinate where the mouse button was pressed.
+      #
+      # @return [Integer]
+      attr_reader :x
+      
+      # Get the Y coordinate where the mouse button was pressed.
+      #
+      # @return [Integer]
+      attr_reader :y
+      
+      protected
+      
+      def x=(value)
+        @x = value.to_i
+      end
+      
+      def y=(value)
+        @y = value.to_i
+      end
+      
+    end
+    
+  end
+end

data/lib/cura/event/mouse_button.rb

@@ -0,0 +1,103 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/mouse"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when a mouse's button state changes.
+    class MouseButton < Mouse
+      
+      VALID_NAMES = [:left, :middle, :right]
+      VALID_STATES = [:up, :down, :click, :double_click]
+      
+      def initialize(attributes={})
+        super
+        
+        # raise ArgumentError, "name must be set" if @name.nil? # TODO: Termbox doesn't support which button was released yet
+        raise ArgumentError, "state must be set" if @state.nil?
+      end
+      
+      # @method state
+      # Get the mouse button state.
+      # Will return `:up`, `:down`, `:click`, or `:double_click`.
+      #
+      # @return [Symbol]
+      
+      # @method state=(value)
+      # Set the mouse button state.
+      #
+      # @param [#to_sym] value
+      # @return [Symbol]
+      
+      attribute(:state) { |value| validate_list(value, VALID_STATES) }
+      
+      # @method name
+      # Get the mouse button name.
+      # Will return `:left`, `:middle`, or `:right`.
+      #
+      # @return [Symbol]
+      
+      # @method name=(value)
+      # Set the mouse button name.
+      #
+      # @param [#to_sym] value
+      # @return [Symbol]
+      
+      attribute(:name) { |value| validate_list(value, VALID_NAMES) }
+      
+      # @method left?
+      # Get whether the mouse button state occurred the left button.
+      #
+      # @return [Boolean]
+      
+      # @method middle?
+      # Get whether the mouse button state occurred the middle button.
+      #
+      # @return [Boolean]
+      
+      # @method right?
+      # Get whether the mouse button state occurred the right button.
+      #
+      # @return [Boolean]
+      
+      VALID_NAMES.each do |name|
+        define_method("#{name}?") { @name == name }
+      end
+      
+      # @method up?
+      # Get whether the mouse button state is up.
+      #
+      # @return [Boolean]
+      
+      # @method down?
+      # Get whether the mouse button state is down.
+      #
+      # @return [Boolean]
+      
+      # @method click?
+      # Get whether the mouse button state is click.
+      #
+      # @return [Boolean]
+      
+      # @method click?
+      # Get whether the mouse button state is double_click.
+      #
+      # @return [Boolean]
+      
+      VALID_STATES.each do |state|
+        define_method("#{state}?") { @state == state }
+      end
+      
+      protected
+      
+      def validate_list(value, list)
+        raise ArgumentError, "must be one of #{list.join(', ')}" unless list.include?(value)
+        
+        value.to_sym
+      end
+      
+    end
+    
+  end
+end

data/lib/cura/event/mouse_wheel_down.rb

@@ -0,0 +1,14 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/mouse"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when a mouse's wheel is scrolled down.
+    class MouseWheelDown < Mouse
+      
+    end
+    
+  end
+end

data/lib/cura/event/mouse_wheel_up.rb

@@ -0,0 +1,14 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/mouse"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when a mouse's wheel is scrolled up.
+    class MouseWheelUp < Mouse
+      
+    end
+    
+  end
+end

data/lib/cura/event/resize.rb

@@ -0,0 +1,17 @@
+if Kernel.respond_to?(:require)
+  require "cura/attributes/has_dimensions"
+  require "cura/event/base"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when an object is resized.
+    class Resize < Base
+      
+      include Attributes::HasDimensions
+      
+    end
+    
+  end
+end

data/lib/cura/event/selected.rb

@@ -0,0 +1,14 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/base"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when a component is selected.
+    class Selected < Base
+      
+    end
+    
+  end
+end

data/lib/cura/event/unfocus.rb

@@ -0,0 +1,14 @@
+if Kernel.respond_to?(:require)
+  require "cura/event/base"
+end
+
+module Cura
+  module Event
+    
+    # Dispatched when a component is unfocused.
+    class Unfocus < Base
+      
+    end
+    
+  end
+end

data/lib/cura/focus_controller.rb

@@ -0,0 +1,89 @@
+if Kernel.respond_to?(:require)
+  require "cura/attributes/has_initialize"
+  require "cura/attributes/has_attributes"
+  require "cura/attributes/has_application"
+end
+
+module Cura
+  
+  class FocusController
+    
+    include Attributes::HasInitialize
+    include Attributes::HasAttributes
+    include Attributes::HasApplication
+    
+    def initialize(attributes={})
+      @index = 0
+      
+      super
+      
+      # TODO: raise error if window or application is nil
+    end
+    
+    # @method window
+    # Get the window of the currently focused component.
+    #
+    # @return [Window]
+    
+    # @method window=(value)
+    # Set the window of the currently focused component.
+    #
+    # @param [#to_i] value
+    # @return [Window]
+    
+    attribute(:window) { |value| validate_window(value) }
+    
+    # @method index
+    # Get the index of the currently focused component.
+    #
+    # @return [Integer]
+    
+    # @method index=(value)
+    # Set the index of the currently focused component.
+    # This will dispatch a Event::Focus instance to the object.
+    #
+    # @param [#to_i] value
+    # @return [Integer]
+    
+    attribute(:index) { |value| set_index(value) }
+    
+    protected
+    
+    def validate_window(window)
+      raise TypeError, "must be a Cura::Window" unless window.is_a?(Window)
+      
+      window
+    end
+    
+    def set_index(value)
+      index = value.to_i
+      focusable_children = focusable_children_of(@window.root)
+      index %= focusable_children.length
+      
+      @window.application.dispatcher.target = focusable_children[index]
+      
+      index
+    end
+    
+    # TODO: When on a focusable component, set the index. When not on a focusable component, find nearest focusable component and set the index.
+    # def update_focused_index(component)
+    #   focusable_children = focusable_children_of(@window.root)
+    #
+    #   @index = focusable_children.index(component)
+    # end
+    
+    # Recursively find all children which are focusable.
+    def focusable_children_of(component)
+      result = []
+      
+      component.children.each do |child|
+        result << child if child.focusable?
+        result << focusable_children_of(child) if child.respond_to?(:children)
+      end
+      
+      result.flatten
+    end
+    
+  end
+  
+end

data/lib/cura/key.rb

@@ -0,0 +1,313 @@
+module Cura
+  
+  # Helpers for dealing with keyboard keys.
+  module Key
+    
+    NAMES = { # Name => Character
+      :ac_back => nil,
+      :ac_bookmarks => nil,
+      :ac_forward => nil,
+      :ac_home => nil,
+      :ac_refresh => nil,
+      :ac_search => nil,
+      :ac_stop => nil,
+      :again => nil,
+      :alterase => nil,
+      :ampersand => "&",
+      :apostrophe => nil,
+      :application => nil,
+      :asterisk => "*",
+      :at => "@",
+      :audio_mute => nil,
+      :audio_next => nil,
+      :audio_play => nil,
+      :audio_prev => nil,
+      :audio_previous => nil,
+      :audio_stop => nil,
+      :backquote => "`",
+      :backslash => '\\',
+      :backspace => nil,
+      :binary => nil,
+      :brightness_down => nil,
+      :brightness_up => nil,
+      :calculator => nil,
+      :cancel => nil,
+      :capslock => nil,
+      :caret => "^",
+      :clear => nil,
+      :clear_again => nil,
+      :clear_entry => nil,
+      :colon => ":",
+      :comma => ",",
+      :computer => nil,
+      :copy => nil,
+      :crsel => nil, # TODO: Clear selection?
+      :currency_subunit => nil,
+      :currency_unit => nil,
+      :cut => nil,
+      :decimal => nil, # See: hexadecimal
+      :decimal_separator => nil,
+      :delete => nil,
+      :display_switch => nil,
+      :divide => "%",
+      :dollar => "$", # TODO: i18n?
+      :double_ampersand => nil,
+      :double_quote => '"',
+      :double_vertical_bar => nil,
+      :down => nil,
+      :eject => nil,
+      :end => nil,
+      :enter => nil,
+      :equals => "=",
+      :equalsas400 => nil,
+      :escape => nil,
+      :exclamation => "!",
+      :execute => nil,
+      :exsel => nil,
+      :f1 => nil,
+      :f10 => nil,
+      :f11 => nil,
+      :f12 => nil,
+      :f13 => nil,
+      :f14 => nil,
+      :f15 => nil,
+      :f16 => nil,
+      :f17 => nil,
+      :f18 => nil,
+      :f19 => nil,
+      :f2 => nil,
+      :f20 => nil,
+      :f21 => nil,
+      :f22 => nil,
+      :f23 => nil,
+      :f24 => nil,
+      :f3 => nil,
+      :f4 => nil,
+      :f5 => nil,
+      :f6 => nil,
+      :f7 => nil,
+      :f8 => nil,
+      :f9 => nil,
+      :find => nil,
+      :grave => nil,
+      :greater => ">",
+      :hash => "#",
+      :help => nil,
+      :hexadecimal => nil,
+      :home => nil,
+      :insert => nil,
+      :international_1 => nil,
+      :international_2 => nil,
+      :international_3 => nil,
+      :international_4 => nil,
+      :international_5 => nil,
+      :international_6 => nil,
+      :international_7 => nil,
+      :international_8 => nil,
+      :international_9 => nil,
+      :kbdillum_down => nil,
+      :kbdillum_toggle => nil,
+      :kbdillum_up => nil,
+      :language_1 => nil,
+      :language_2 => nil,
+      :language_3 => nil,
+      :language_4 => nil,
+      :language_5 => nil,
+      :language_6 => nil,
+      :language_7 => nil,
+      :language_8 => nil,
+      :language_9 => nil,
+      :left => nil,
+      :left_alt => nil,
+      :left_brace => "{",
+      :left_bracket => "[",
+      :left_control => nil,
+      :left_ctrl => nil,
+      :left_gui => nil,
+      :left_parenthesis => "(",
+      :left_race => nil,
+      :left_shift => nil,
+      :less => "<",
+      :a => "a",
+      :b => "b",
+      :c => "c",
+      :d => "d",
+      :e => "e",
+      :f => "f",
+      :g => "g",
+      :h => "h",
+      :i => "i",
+      :j => "j",
+      :k => "k",
+      :l => "l",
+      :m => "m",
+      :n => "n",
+      :o => "o",
+      :p => "p",
+      :q => "q",
+      :r => "r",
+      :s => "s",
+      :t => "t",
+      :u => "u",
+      :v => "v",
+      :w => "w",
+      :x => "x",
+      :y => "y",
+      :z => "z",
+      :A => "A",
+      :B => "B",
+      :C => "C",
+      :D => "D",
+      :E => "E",
+      :F => "F",
+      :G => "G",
+      :H => "H",
+      :I => "I",
+      :J => "J",
+      :K => "K",
+      :L => "L",
+      :M => "M",
+      :N => "N",
+      :O => "O",
+      :P => "P",
+      :Q => "Q",
+      :R => "R",
+      :S => "S",
+      :T => "T",
+      :U => "U",
+      :V => "V",
+      :W => "W",
+      :X => "X",
+      :Y => "Y",
+      :Z => "Z",
+      :locking_capslock => nil,
+      :locking_numlock => nil,
+      :locking_scrolllock => nil,
+      :mail => nil,
+      :media_select => nil,
+      :mem_add => nil,
+      :mem_clear => nil,
+      :mem_divide => nil,
+      :mem_multiply => nil,
+      :mem_recall => nil,
+      :mem_store => nil,
+      :mem_subtract => nil,
+      :menu => nil,
+      :minus => "-",
+      :mode => nil,
+      :multiply => "*",
+      :mute => nil,
+      :non_us_backslash => nil,
+      :non_us_hash => nil,
+      :"0" => "0",
+      :"00" => "00",
+      :"000" => "000",
+      :"1" => "1",
+      :"2" => "2",
+      :"3" => "3",
+      :"4" => "4",
+      :"5" => "5",
+      :"6" => "6",
+      :"7" => "7",
+      :"8" => "8",
+      :"9" => "9",
+      :numlock_clear => nil,
+      :numpad_0 => "0",
+      :numpad_1 => "1",
+      :numpad_2 => "2",
+      :numpad_3 => "3",
+      :numpad_4 => "4",
+      :numpad_5 => "5",
+      :numpad_6 => "6",
+      :numpad_7 => "7",
+      :numpad_8 => "8",
+      :numpad_9 => "9",
+      :numpad_equals => "=",
+      :numpad_slash => "/",
+      :numpad_asterisk => "*",
+      :numpad_minus => "-",
+      :numpad_plus => "+",
+      :numpad_enter => nil,
+      :numpad_period => ".",
+      :octal => nil,
+      :oper => nil,
+      :out => nil,
+      :page_down => nil,
+      :page_up => nil,
+      :paste => nil,
+      :pause => nil,
+      :percent => "%",
+      :period => ".",
+      :plus => "+",
+      :plus_minus => nil,
+      :power => nil,
+      :print_screen => nil,
+      :prior => nil,
+      :question => "?",
+      :quote => '\'',
+      :return => nil,
+      :right => nil,
+      :right_alt => nil,
+      :right_brace => "}",
+      :right_bracket => "]",
+      :right_control => nil,
+      :right_ctrl => nil,
+      :right_gui => nil,
+      :right_parenthesis => ")",
+      :right_shift => nil,
+      :scrolllock => nil,
+      :select => nil,
+      :semicolon => ";",
+      :separator => nil,
+      :slash => "/",
+      :sleep => nil,
+      :space => nil,
+      :stop => nil,
+      :sysreq => nil,
+      :tab => nil,
+      :thousands_separator => nil,
+      :tilde => "~",
+      :underscore => "_",
+      :undo => nil,
+      :unknown => nil,
+      :up => nil,
+      :vertical_bar => "|",
+      :volume_down => nil,
+      :volume_up => nil,
+      :www => nil,
+      :xor => nil
+    }
+    
+    class << self
+      
+      # Check if the given name is valid.
+      #
+      # @param [#to_sym] value
+      # @return [Boolean]
+      def valid_name?(value)
+        NAMES.key?(value.to_sym)
+      end
+      
+      # Check if the given name is printable.
+      #
+      # @param [#to_sym] value
+      # @return [Boolean]
+      def name_is_printable?(value)
+        !NAMES[value.to_sym].nil?
+      end
+      
+      def name_from_character(value)
+        value = value.to_s[0]
+        
+        NAMES.key(value)
+      end
+      
+      def character_from_name(value)
+        NAMES[value.to_sym]
+      end
+      
+    end
+    
+  end
+  
+end