special_input_device 0.0.0

data/lib/special_input_device/special_input_device.rb

@@ -0,0 +1,67 @@
+# <code>SpecialInputDevice</code> is a collection of method to control the computer in the program way. It contains some
+# method to simulate the input signal mainly also has some useful method to detect current state of computer.
+module SpecialInputDevice
+
+  # A container of all modes.
+  # @see mode
+  module MODE
+    # Interception mode.
+    # This mode works for almost all application.
+    INTERCEPTION = :interception
+    # Win API mode.
+    # This mode only works for some type of application such as Windows Forms. However, this mode is a little bit
+    # faster.
+    WIN_API      = :win_api
+  end
+
+  # A container of all color compare methods.
+  # @see color_compare_method
+  module COLOR_COMPARE_METHOD
+    # Calculate similarity of two colors base on their Euclidean distance in bipyramidal HSL color model.
+    EUCLIDEAN_METRIC_IN_HSL_BIPYRAMIDAL = :euclidean_metric_in_hsl_bipyramidal
+    # Calculate similarity of two colors base on their Euclidean distance in cone HSV color model.
+    EUCLIDEAN_METRIC_IN_HSV_CONE        = :euclidean_metric_in_hsv_cone
+    # Calculate similarity of two colors base on their Euclidean distance in cube RGB color model.
+    EUCLIDEAN_METRIC_IN_RGB_CUBE        = :euclidean_metric_in_rgb_cube
+  end
+
+  @mode                 = MODE::INTERCEPTION
+  @color_compare_method = COLOR_COMPARE_METHOD::EUCLIDEAN_METRIC_IN_HSL_BIPYRAMIDAL
+
+  class << self
+
+    # @see SpecialInputDevice::MODE
+    # @return [Symbol]
+    attr_reader(:mode)
+    # @see SpecialInputDevice::COLOR_COMPARE_METHOD
+    # @return [Symbol]
+    attr_reader(:color_compare_method)
+    # Set the simulation mode
+    # @param [Symbol] value
+    # @return [Symbol]
+    def mode=(value)
+      modes = MODE.constants(false).map { |x| MODE.const_get(x) }
+      raise(ArgumentError, "Undefined mode '#{value.to_s}' passed. Defined modes are [#{modes.join(', ')}].") unless modes.include?(value)
+      @mode = value
+    end
+
+    # Set the color compare method
+    # @param [Symbol] value
+    # @return [Symbol]
+    def color_compare_method=(value)
+      color_compare_methods = COLOR_COMPARE_METHOD.constants(false).map { |x| COLOR_COMPARE_METHOD.const_get(x) }
+      raise(ArgumentError, "Undefined method '#{value.to_s}' passed. Defined methods are [#{color_compare_methods.join(', ')}].") unless color_compare_methods.include?(value)
+      @color_compare_method = value
+    end
+
+  end
+
+end
+
+require_relative('attributes_equal_checker')
+require_relative('color')
+require_relative('image')
+require_relative('key_code')
+require_relative('point')
+require_relative('rectangle')
+require_relative('table_2d')

data/lib/special_input_device/table_2d.rb

@@ -0,0 +1,157 @@
+# <code>Table2D</code> object is a container which act like a two dimensional array.
+class SpecialInputDevice::Table2D
+
+  include(Enumerable)
+
+  # @return [Fixnum] the width of table
+  attr_reader(:width)
+
+  # @return [Fixnum] the height of table
+  attr_reader(:height)
+
+  # @!scope class
+  # @overload new(width, height, default = nil, &block)
+  #   @param [Integer] width the width of table
+  #   @param [Integer] height the height of table
+  #   @param [Object] default the default value
+  #   @param [Proc] block initializer of the table
+  #   @yield [x, y] initializer of the table
+  #   @yieldparam [Integer] x the x coordinate
+  #   @yieldparam [Integer] y the y coordinate
+  #   @yieldreturn [Object] the value to be stored
+  def initialize(width, height, default = nil, &block)
+    @width  = width
+    @height = height
+    @data   = Array.new(width) do |x0|
+      Array.new(height) do |x1|
+        value = if block
+                  yield x0, x1
+                else
+                  default
+                end
+        validate(x0, x1, value)
+      end
+    end
+  end
+
+  # @param [Integer] x the x coordinate
+  # @param [Integer] y the y coordinate
+  # @return [Object] the object at the specific coordinate
+  def [](x, y)
+    raise(RangeError, "The table only has #{@height} row. The row at #{y} cannot be accessed.") unless (-@height...@height).include?(y)
+    raise(RangeError, "The table only has #{@width} column. The column at #{x} cannot be accessed") unless (-@width...@width).include?(x)
+    @data[x][y]
+  end
+
+  # @param [Integer] x the x coordinate
+  # @param [Integer] y the y coordinate
+  # @param [Object] value the new value
+  # @return [Object] the new value
+  def []=(x, y, value)
+    raise(RangeError, "The table only has #{@height} row. The row at #{y} cannot be accessed.") unless (-@height...@height).include?(y)
+    raise(RangeError, "The table only has #{@width} column. The column at #{x} cannot be accessed") unless (-@width...@width).include?(x)
+    validate(x, y, value)
+    @data[x][y] = value
+  end
+
+  # @param [Integer] x the x coordinate
+  # @param [Integer] y the y coordinate
+  # @return [Object] the object at the specific coordinate
+  def try_get(x, y)
+    self[x, y] if (-@width...@width).include?(x) && (-@height...@height).include?(y)
+  end
+
+  # @param [Integer] x the x coordinate
+  # @param [Integer] y the y coordinate
+  # @param [Object] value the new value
+  # @return [Object] the new value
+  def try_set(x, y, value)
+    self[x, y] = value if (-@width...@width).include?(x) && (-@height...@height).include?(y)
+  end
+
+  # @param [Proc] block the action
+  # @yield [value, position] the action
+  # @yieldparam [Object] value the value
+  # @yieldparam [SpecialInputDevice::Point] position the position of the value
+  # @yieldreturn [Object] value will be ignored
+  # @return [Enumerator, SpecialInputDevice::Table2D] a Enumerator if no block gavin, self otherwise.
+  def each(&block)
+    if block
+      @data.each.with_index do |v0, i0|
+        v0.each.with_index do |v1, i1|
+          yield v1, SpecialInputDevice::Point.new(i0, i1)
+        end
+      end
+      self
+    else
+      Enumerator.new(self)
+    end
+  end
+
+  # @param [Proc] block the action
+  # @yield [row] the action
+  # @yieldparam [Array<Object>] row the row
+  # @yieldreturn [Object] value will be ignored
+  # @return [Enumerator, SpecialInputDevice::Table2D] a Enumerator if no block gavin, self otherwise.
+  def each_row(&block)
+    enumerator = :zip.to_proc.call(*@data).each(&block)
+    block ? self : enumerator
+  end
+
+  # @param [Proc] block the action
+  # @yield [column] the action
+  # @yieldparam [Array<Object>] column the column
+  # @yieldreturn [Object] value will be ignored
+  # @return [Enumerator, SpecialInputDevice::Table2D] a Enumerator if no block gavin, self otherwise.
+  def each_column(&block)
+    enumerator = @data.each(&block)
+    block ? self : enumerator
+  end
+
+  # @param [Integer] y the y coordinate
+  # @param [Proc] block the action
+  # @yield [value] the action
+  # @yieldparam [Object] value the value
+  # @yieldreturn [Object] value will be ignored
+  # @return [Enumerator, SpecialInputDevice::Table2D] a Enumerator if no block gavin, self otherwise.
+  def each_in_row(y, &block)
+    raise(RangeError, "The table only has #{@height} row. The row at #{y} cannot be accessed.") unless (-@height...@height).include?(y)
+    enumerator = @data.map { |x| x[y] }.each(&block)
+    block ? self : enumerator
+  end
+
+  # @param [Integer] x the x coordinate
+  # @param [Proc] block the action
+  # @yield [value] the action
+  # @yieldparam [Object] value the value
+  # @yieldreturn [Object] value will be ignored
+  # @return [Enumerator, SpecialInputDevice::Table2D] a Enumerator if no block gavin, self otherwise.
+  def each_in_column(x, &block)
+    raise(RangeError, "The table only has #{@width} column. The column at #{x} cannot be accessed") unless (-@width...@width).include?(x)
+    enumerator = @data[x].each(&block)
+    block ? self : enumerator
+  end
+
+  # @param [Proc] block the mapper
+  # @yield [value, position] the mapper
+  # @yieldparam [Object] value the value
+  # @yieldparam [SpecialInputDevice::Point] position an array included x and y
+  # @yieldreturn [Object] the value to be stored
+  # @return [Enumerator, SpecialInputDevice::Table2D] a Enumerator if no block gavin, self otherwise.
+  def map(&block)
+    (0...width).each { |x0| (0...height).each { |x1| self[x0, x1] = yield self[x0, x1], SpecialInputDevice::Point.new(x0, x1) } }
+    block ? self : Enumerator.new(self, :map)
+  end
+
+  # Override this method if validation is needed. In this method, raise an <code>Exception</code> if it is not valid.
+  # @param [Integer] x the x coordinate
+  # @param [Integer] y the y coordinate
+  # @param [Object] value the object at the specific coordinate
+  # @return [Object] the value to be stored
+  def validate(x, y, value)
+    value
+  end
+
+  protected(:validate)
+
+end

data/stab/keyboard.rb

@@ -0,0 +1,35 @@
+# noinspection ALL
+module SpecialInputDevice::Keyboard
+
+  class << self
+
+    # Simulate holding the specified key down.
+    # @param [Integer] key_code virtual key code. Use a value of constant in {SpecialInputDevice::KeyCode}.
+    # @return [Module] self
+    # @see SpecialInputDevice::Window#key_hold
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def hold(key_code)
+      # This is a stub, used for indexing
+    end
+
+    # Simulate pressing the specified key.
+    # @param [Integer] key_code virtual key code. Use a value of constant in {SpecialInputDevice::KeyCode}.
+    # @return [Module] self
+    # @see SpecialInputDevice::Window#key_press
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def press(key_code)
+      # This is a stub, used for indexing
+    end
+
+    # Simulate releasing the specified key.
+    # @param [Integer] key_code virtual key code. Use a value of constant in {SpecialInputDevice::KeyCode}.
+    # @return [Module] self
+    # @see SpecialInputDevice::Window#key_release
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def release(key_code)
+      # This is a stub, used for indexing
+    end
+
+  end
+
+end

data/stab/mouse.rb

@@ -0,0 +1,189 @@
+# noinspection ALL
+module SpecialInputDevice::Mouse
+
+  class << self
+
+    # Lock the mouse.
+    # @return [Module] self
+    def lock
+      # This is a stub, used for indexing
+    end
+
+    # Unlock the mouse.
+    # @return [Module] self
+    def unlock
+      # This is a stub, used for indexing
+    end
+
+    # @return [SpecialInputDevice::Point] the point of cursor position
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def cursor_position
+      # This is a stub, used for indexing
+    end
+
+    # Move the cursor position relative to current position.
+    # @param [Integer] x the amount of horizontal motion specified as the number of pixels.
+    # @param [Integer] y the amount of vertical motion specified as the number of pixels.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def move_relatively(x, y)
+      # This is a stub, used for indexing
+    end
+
+    # Move the cursor position relative to the upper-left corner of primary screen.
+    # @param [Integer] x the x-coordinate of position specified as the number of pixels.
+    # @param [Integer] y the y-coordinate of position specified as the number of pixels.
+    # @return [Module] self
+    # @see SpecialInputDevice::Screen.primary_screen
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def move_to_primary(x, y)
+      # This is a stub, used for indexing
+    end
+
+    # Move the cursor position relative to the upper-left corner of virtual screen. If the position of virtual screen is
+    # inaccessible, the cursor will move to the closest point to the specified position.
+    # @param [Integer] x the x-coordinate of position specified as the number of pixels.
+    # @param [Integer] y the y-coordinate of position specified as the number of pixels.
+    # @return [Module] self
+    # @see SpecialInputDevice::Screen.virtual_screen
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def move_to_virtual(x, y)
+      # This is a stub, used for indexing
+    end
+
+    # Simulate clicking the left button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def left_click
+      # This is a stub, used for indexing
+    end
+
+    # Simulate holding the left button on the mouse down.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def left_down
+      # This is a stub, used for indexing
+    end
+
+    # Simulate releasing the left button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def left_up
+      # This is a stub, used for indexing
+    end
+
+    # Simulate clicking the right button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def right_click
+      # This is a stub, used for indexing
+    end
+
+    # Simulate holding the right button on the mouse down.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def right_down
+      # This is a stub, used for indexing
+    end
+
+    # Simulate releasing the right button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def right_up
+      # This is a stub, used for indexing
+    end
+
+    # Simulate clicking the middle button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def middle_click
+      # This is a stub, used for indexing
+    end
+
+    # Simulate holding the middle button on the mouse down.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def middle_down
+      # This is a stub, used for indexing
+    end
+
+    # Simulate releasing the middle button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def middle_up
+      # This is a stub, used for indexing
+    end
+
+    # Simulate clicking the x1 button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def x1_click
+      # This is a stub, used for indexing
+    end
+
+    # Simulate holding the x1 button on the mouse down.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def x1_down
+      # This is a stub, used for indexing
+    end
+
+    # Simulate releasing the x1 button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def x1_up
+      # This is a stub, used for indexing
+    end
+
+    # Simulate clicking the x2 button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def x2_click
+      # This is a stub, used for indexing
+    end
+
+    # Simulate holding the x2 button on the mouse down.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def x2_down
+      # This is a stub, used for indexing
+    end
+
+    # Simulate releasing the x2 button on the mouse.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def x2_up
+      # This is a stub, used for indexing
+    end
+
+    # Simulate wheeling the scroll backward.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def scroll_wheel_backward
+      # This is a stub, used for indexing
+    end
+
+    # Simulate wheeling the scroll forward.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def scroll_wheel_forward
+      # This is a stub, used for indexing
+    end
+
+    # Simulate wheeling the scroll to left hand side.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def scroll_wheel_to_left
+      # This is a stub, used for indexing
+    end
+
+    # Simulate wheeling the scroll to right hand side.
+    # @return [Module] self
+    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/ms646310.aspx Windows Dev Center - SendInput function
+    def scroll_wheel_to_right
+      # This is a stub, used for indexing
+    end
+
+  end
+
+end