auto_click 0.1.6 → 0.1.9

data/CHANGELOG

@@ -1,3 +1,16 @@
+
+0.1.9
+Add support for keybaord region specific keys using US-keyboard standard
+
+0.1.8
+Implement key_stroke, key_down and key_up
+
+0.1.7
+Primitive implementation of key_stroke. Need good api before putting it into method list
+
+0.1.6
+Edit changelog and readme.rdoc problem
+
 0.1.4
 Implement left_drag and right_drag
 
@@ -12,7 +25,7 @@ Primitive implementation of mouse_move_percentage_absolute_real, mouse_move_perc
 Specify required ruby environments
 
 0.1.0
-rewrite the program using dl instead of Win32API
+rewrite the program using DL instead of Win32API
 
 0.0.5
 remove gem dependency requirement.

data/README.rdoc

@@ -1,13 +1,6 @@
 = AutoClick
 
-Ruby gem for simulating mouse clicks and mouse cursor movement.
-
-== Description
-
-Provide several Ruby methods for simulating mouse click and cursor movement in Windows.
-This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. 
-Currently contains 7 methods (mouse_move(x,y), left_click, right_click, cursor_position, mouse_scroll, left_drag and right drag).
-More control over mouse movement such as speed or locus will be implemented in future releases.
+Smulating mouse click, cursor movement and keystrokes
 
 == Install
 
@@ -31,18 +24,61 @@ To show the current cursor position:
 
   puts cursor_position
   
-To scroll up (forward) 10 wheel steps
+To scroll up (forward) 10 wheel steps:
   
   mouse_scroll(10)
   
-To scroll down (backward) 5 wheel steps
+To scroll down (backward) 5 wheel steps:
   
   mouse_scroll(-5)
   
-To drag the icon on (50,50) to (200,300)
+To drag the icon on (50,50) to (200,300):
+
   left_drag(50,50,200,300)
  
- 
+To send keystroke 'a':
+
+  key_stroke('a')
+
+To send keystroke tab:
+
+  key_stroke('tab')
+  
+Suppose the notepad window on the top left corner of the screen, to type "Auto Click" in notepad (assume that the capslock is off):
+
+  mouse_move(100,100)
+  leftclick            
+  key_down('shift')        
+  key_stroke('a')  
+  key_up('shift')
+  key_stroke('u')
+  key_stroke('t')
+  key_stroke('o')
+  key_stroke('space')
+  key_stroke('c')
+  key_stroke('l')
+  key_stroke('i')
+  key_stroke('c')
+  key_stroke('k')
+  
+Methods like get_windows("notepad") will be implemented in future release.
+Notice that 'a' means the key 'a' instead of the letter 'a'. Therefore key_stroke('a') and key_stroke('A') is basically the same. If the capslock is off but you want to type the capitalized A, you need to:
+
+  key_down('shift')        
+  key_stroke('a')  
+  key_up('shift')
+  
+A list of key stroke names will be included in the readme later. 'a' to 'z', 'num0' to 'num9', 'f1' to 'f12', 'shift' 'ctrl' 'alt' 'win' 'tab' 'del' 'ins' 'return' 'esc' 'pageup' 'pagedown' 'left' 'right' 'up' 'down' 'equal' 'hyphen'......etc are all acceptable key names.
+  
+If you know the virtual key code you can directly enter the key code, for example:
+
+  key_stroke(0x41)
+  
+is the same as
+
+  key_stroke('a')
+  
+  
 == Method List
 
 - left_click
@@ -53,11 +89,29 @@ To drag the icon on (50,50) to (200,300)
 
 - mouse_move(x,y)
 
-- mouse_scroll(d)
+- mouse_scroll(step)
 
 - left_drag(sx,sy,ex,ey)
 
 - right_drag(sx,sy,ex,ey)
+
+- key_stroke(key_name)
+
+- key_down(key_name)
+
+- key_up(key_name)
+ 
+ 
+== Change log (for full change log please refer to the CHANGELOG file in the repository
+
+- 0.1.9 Add support for keybaord region specific keys using US-keyboard standard
+
+- 0.1.8 Implement key_stroke, key_down and key_up
+
+- 0.1.7 Primitive implementation of key_stroke. Need good api before putting it into method list
+
+- 0.1.4 Implement left_drag and right_drag
+
  
 == Tested with
 

data/auto_click.gemspec

@@ -9,8 +9,12 @@ Gem::Specification.new do |s|
   s.authors     = ["erinata"]
   s.email       = ["erinata@gmail.com"]
   s.homepage    = ""
-  s.summary     = %q{Smulating mouse click and cursor movement}
-  s.description = %q{Provide several Ruby methods for simulating mouse click and cursor movement in Windows. This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. Currently contains 7 methods (mouse_move(x,y), left_click, right_click, cursor_position, mouse_scroll, left_drag and right drag). More control over mouse movement such as speed or locus will be implemented in future releases.}
+  s.summary     = %q{Smulating mouse click, cursor movement and keystrokes}
+  s.description = %q{Provide several Ruby methods for simulating mouse click, cursor movement and keystrokes in Windows. 
+                     This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. 
+                     Methods include mouse_move(x,y), left_click, right_click, cursor_position, mouse_scroll, key_up, key_down...etc.
+                     See https://github.com/erinata/auto_click for more details.
+                     (More control over mouse movement such as speed or locus will be implemented in future releases)}
   
   s.required_ruby_version = '>= 1.9.0'
 

data/lib/auto_click.rb

@@ -1,5 +1,6 @@
 require 'dl/import'
 require 'auto_click/input_structure'
+require 'auto_click/virtual_key'
 require 'auto_click/user32'
 
 module AutoClick
@@ -83,6 +84,27 @@ module AutoClick
     send_input( [@@rightup] )
     sleep 0.1
   end
+  
+  def key_stroke(key)
+    code=VirtualKey.code_from_string(key)
+    send_input([InputStructure.keyboard_input(code,0x0000),
+                InputStructure.keyboard_input(code,0x0002)])
+  end
+  
+  def key_down(key)
+    code=VirtualKey.code_from_string(key)
+    send_input([InputStructure.keyboard_input(code,0x0000)])
+  end
+  
+  def key_up(key)
+    code=VirtualKey.code_from_string(key)
+    send_input([InputStructure.keyboard_input(code,0x0002)])
+  end
+  
+  def type(string)
+    puts string
+  end
+
 end
 
 

data/lib/auto_click/input_structure.rb

@@ -11,4 +11,14 @@ module InputStructure
   end
   
   
+  def self.keyboard_input(wVk,dw_flags)
+    ki = Array.new(7, 0)
+    ki[0] = 1
+    ki[1] = wVk
+    ki[2] = dw_flags
+    ki.pack('LLLLLLL')
+  end
+
+  
+  
 end

data/lib/auto_click/version.rb

@@ -1,3 +1,3 @@
 module AutoClick
-  VERSION = "0.1.6"
+  VERSION = "0.1.9"
 end

data/lib/auto_click/virtual_key.rb

@@ -0,0 +1,529 @@
+module VirtualKey
+  def self.code_from_string(string)
+        
+    if string.kind_of? Fixnum
+      return string
+    elsif string.kind_of? String
+      string=string.delete('_').delete('-').delete(' ')
+    end
+    string = string.to_sym.downcase  
+    case string
+    #when
+    #  0x00S
+    #when
+    #  0x01
+    #when
+    #  0x02
+    #when
+    #  0x03
+    #when
+    #  0x04
+    #when
+    #  0x05
+    #when
+    #  0x06
+    #when
+    #  0x07
+    when :back,:backspace
+      0x08
+    when :tab
+      0x09
+    #when
+    #  0x0A
+    #when
+    #  0x0B
+    when :clear
+      0x0C
+    when :return,:enter
+      0x0D
+    #when
+    #  0x0E
+    #when
+    #  0x0F
+    when :shift
+      0x10
+    when :ctrl,:control
+      0x11
+    when :alt,:alternate
+      0x12
+    when :pause
+      0x13
+    when :cap,:capslock,:caplock
+      0x14
+    #when
+    #  0x15
+    #when
+    #  0x16
+    #when
+    #  0x17
+    #when
+    #  0x18
+    #when
+    #  0x19
+    #when
+    #  0x1A
+    when :esc,:escape
+      0x1B
+    #when
+    #  0x1C
+    #when
+    #  0x1D
+    #when
+    #  0x1E
+    #when
+    #  0x1F
+    when :space,:spacebar
+      0x20
+    when :pageup
+      0x21
+    when :pagedown
+      0x22
+    when :end
+      0x23
+    when :home
+      0x24
+    when :left,:leftarrow,:leftkey
+      0x25
+    when :up,:uparrow,:upkey
+      0x26
+    when :right,:rightarrow,:rightkey
+      0x27
+    when :down,:downarrow,:downkey
+      0x28
+    when :select
+      0x29
+    when :print
+      0x2A
+    when :exe,:execute
+      0x2B
+    when :printscr,:printscreen
+      0x2C
+    when :ins,:insert
+      0x2D
+    when :del,:delete
+      0x2E
+    when :help
+      0x2F
+    when :num0,:number0
+      0x30
+    when :num1,:number1
+      0x31
+    when :num2,:number2
+      0x32
+    when :num3,:number3
+      0x33
+    when :num4,:number4
+      0x34
+    when :num5,:number5
+      0x35
+    when :num6,:number6
+      0x36
+    when :num7,:number7
+      0x37
+    when :num8,:number8
+      0x38
+    when :num9,:number9
+      0x39
+    #when
+    #  0x3A
+    #when
+    #  0x3B
+    #when
+    #  0x3C
+    #when
+    #  0x3D
+    #when
+    #  0x3E
+    #when
+    #  0x3F
+    #when
+    #  0x40
+    when :a
+      0x41
+    when :b
+      0x42
+    when :c
+      0x43
+    when :d
+      0x44
+    when :e
+      0x45
+    when :f
+      0x46
+    when :g
+      0x47
+    when :h
+      0x48
+    when :i
+      0x49
+    when :j
+      0x4A
+    when :k
+      0x4B
+    when :l
+      0x4C
+    when :m
+      0x4D
+    when :n
+      0x4E
+    when :o
+      0x4F
+    when :p
+      0x50
+    when :q
+      0x51
+    when :r
+      0x52
+    when :s
+      0x53
+    when :t
+      0x54
+    when :u
+      0x55
+    when :v
+      0x56
+    when :w
+      0x57
+    when :x
+      0x58
+    when :y
+      0x59
+    when :z
+      0x5A
+    when :win, :windows,:leftwin
+      0x5B
+    when :rightwin
+      0x5C
+    when :app,:application
+      0x5D
+    #when
+    #  0x5E
+    when :sleep
+      0x5F
+    when :numpad0,:numberpad0
+      0x60
+    when :numpad1,:numberpad1
+      0x61
+    when :numpad2,:numberpad2
+      0x62
+    when :numpad3,:numberpad3
+      0x63
+    when :numpad4,:numberpad4
+      0x64
+    when :numpad5,:numberpad5
+      0x65
+    when :numpad6,:numberpad6
+      0x66
+    when :numpad7,:numberpad7
+      0x67
+    when :numpad8,:numberpad8
+      0x68
+    when :numpad9,:numberpad9
+      0x69
+    when :multiply,:multiplication
+      0x6A
+    when :add,:addition
+      0x6B
+    when :separator
+      0x6C
+    when :substract,:subtraction
+      0x6D
+    when :decimal
+      0x6E
+    when :divide,:division
+      0x6F
+    when :f1
+      0x70
+    when :f2
+      0x71
+    when :f3
+      0x72
+    when :f4
+      0x73
+    when :f5
+      0x74
+    when :f6
+      0x75
+    when :f7
+      0x76
+    when :f8
+      0x77
+    when :f9
+      0x78
+    when :f10
+      0x79
+    when :f11
+      0x7A
+    when :f12
+      0x7B
+    when :f13
+      0x7C
+    when :f14
+      0x7D
+    when :f15
+      0x7E
+    when :f16
+      0x7F
+    when :f17
+      0x80
+    when :f18
+      0x81
+    when :f19
+      0x82
+    when :f20
+      0x83
+    when :f21
+      0x84
+    when :f22
+      0x85
+    when :f23
+      0x86
+    when :f24
+      0x87
+    #when
+    #  0x88
+    #when
+    #  0x89
+    #when
+    #  0x8A
+    #when
+    #  0x8B
+    #when
+    #  0x8C
+    #when
+    #  0x8D
+    #when
+    #  0x8E
+    #when
+    #  0x8F
+    when :numlock,:numberlock
+      0x90
+    when :scroll,:scrolllock
+      0x91
+    #when
+    #  0x92
+    #when
+    #  0x93
+    #when
+    #  0x94
+    #when
+    #  0x95
+    #when
+    #  0x96
+    #when
+    #  0x97
+    #when
+    #  0x98
+    #when
+    #  0x99
+    #when
+    #  0x9A
+    #when
+    #  0x9B
+    #when
+    #  0x9C
+    #when
+    #  0x9D
+    #when
+    #  0x9E
+    #when
+    #  0x9F
+    when :leftshift
+      0xA0
+    when :rightshift
+      0xA1
+    when :leftcontrol,:leftctrl
+      0xA2
+    when :rightcontrol,:rightctrl
+      0xA3
+    when :menu,:leftmenu
+      0xA4
+    when :rightmenu
+      0xA5
+    when :browserback
+      0xA6
+    when :browserforward
+      0xA7
+    when :browserrefresh
+      0xA8
+    when :browserstop
+      0xA9
+    when :browsersearch
+      0xAA
+    when :browserfav,:browserfavourites
+      0xAB
+    when :browserstart,:browserhome
+      0xAC
+    when :mute,:volmute,:volumemute
+      0xAD
+    when :voldown,:volumedown
+      0xAE
+    when :volup,:volumeup
+      0xAF
+    when :nexttrack
+      0xB0
+    when :previoustrack
+      0xB1
+    when :mediastop
+      0xB2
+    when :mediaplay,:mediapause
+      0xB3
+    when :mail
+      0xB4
+    when :mediaselect
+      0xB5
+    when :app1,:application1
+      0xB6
+    when :app2,:application2
+      0xB7
+    #when
+    #  0xB8
+    #when
+    #  0xB9
+    when :semicolon,:colon
+      0xBA
+    when :equal, :plus
+      0xBB
+    when :comma, :smallerthan
+      0xBC
+    when :hyphen,:underscore,:understrike
+      0xBD
+    when :period, :dot, :greaterthan
+      0xBE
+    when :slash,:question,:questionmark,:forwardslash
+      0xBF
+    when :grave, :graveaccent, :tilde,:leftquote
+      0xC0
+    #when
+    #  0xC1
+    #when
+    #  0xC2
+    #when
+    #  0xC3
+    #when
+    #  0xC4
+    #when
+    #  0xC5
+    #when
+    #  0xC6
+    #when
+    #  0xC7
+    #when
+    #  0xC8
+    #when
+    #  0xC9
+    #when
+    #  0xCA
+    #when
+    #  0xCB
+    #when
+    #  0xCC
+    #when
+    #  0xCD
+    #when
+    #  0xCE
+    #when
+    #  0xCF
+    #when
+    #  0xD0
+    #when
+    #  0xD1
+    #when
+    #  0xD2
+    #when
+    #  0xD3
+    #when
+    #  0xD4
+    #when
+    #  0xD5
+    #when
+    #  0xD6
+    #when
+    #  0xD7
+    #when
+    #  0xD8
+    #when
+    #  0xD9
+    #when
+    #  0xDA
+    when :openbranket, :leftbranket, :opensquarebranket, :leftsquarebranket, :squarebranket 
+      0xDB
+    when :pipe, :pipes, :bar, :brokenbar, :backslash
+      0xDC
+    when :closebranket, :closesquarebranket, :rightbranket, :rightsquarebranket
+      0xDD
+    when :quote,:singlequote,:doublequote, :rightquote
+      0xDE
+    #when
+    #  0xDF
+    #when
+    #  0xE0
+    #when
+    #  0xE1
+    #when
+    #  0xE2
+    #when
+    #  0xE3
+    #when
+    #  0xE4
+    #when
+    #  0xE5
+    #when
+    #  0xE6
+    #when
+    #  0xE7
+    #when
+    #  0xE8
+    #when
+    #  0xE9
+    #when
+    #  0xEA
+    #when
+    #  0xEB
+    #when
+    #  0xEC
+    #when
+    #  0xED
+    #when
+    #  0xEE
+    #when
+    #  0xEF
+    #when
+    #  0xF0
+    #when
+    #  0xF1
+    #when
+    #  0xF2
+    #when
+    #  0xF3
+    #when
+    #  0xF4
+    #when
+    #  0xF5
+    #when
+    #  0xF6
+    #when
+    #  0xF7
+    #when
+    #  0xF8
+    #when
+    #  0xF9
+    when :play 
+      0xFA
+    when :zoom
+      0xFB
+    #when
+    #  0xFC
+    #when
+    #  0xFD
+    #when
+    #  0xFE
+    #when
+    #  0xFF
+    else 0  
+    end
+    
+
+  end
+ 
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - erinata
@@ -18,7 +18,12 @@ date: 2011-01-03 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: Provide several Ruby methods for simulating mouse click and cursor movement in Windows. This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. Currently contains 7 methods (mouse_move(x,y), left_click, right_click, cursor_position, mouse_scroll, left_drag and right drag). More control over mouse movement such as speed or locus will be implemented in future releases.
+description: |-
+  Provide several Ruby methods for simulating mouse click, cursor movement and keystrokes in Windows. 
+                       This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. 
+                       Methods include mouse_move(x,y), left_click, right_click, cursor_position, mouse_scroll, key_up, key_down...etc.
+                       See https://github.com/erinata/auto_click for more details.
+                       (More control over mouse movement such as speed or locus will be implemented in future releases)
 email: 
 - erinata@gmail.com
 executables: []
@@ -39,6 +44,7 @@ files:
 - lib/auto_click/input_structure.rb
 - lib/auto_click/user32.rb
 - lib/auto_click/version.rb
+- lib/auto_click/virtual_key.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -72,6 +78,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Smulating mouse click and cursor movement
+summary: Smulating mouse click, cursor movement and keystrokes
 test_files: []