au3 0.1.1 → 0.1.2

data/lib/AutoItX3/window/send_message.rb

@@ -0,0 +1,271 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009, 2010 Marvin Gülker, Steven Heidel
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+#This file is only useful together with the other ones
+require_relative "../../au3"
+
+module AutoItX3
+  
+  class Window
+    
+    Window.functions[:get_last_error] = Win32::API.new("GetLastError", '', 'I', "kernel32")
+    
+    #Constant values for use with Window#send_message and 
+    #Window#post_message. The constant names and values have 
+    #been extracted from wm.h at http://technology.niagarac.on.ca, 
+    #which in turn was extracted from the winuser.h which is 
+    #Copyright (c) 1985-1996 Microsoft Corporation. 
+    module Messages
+      WM_CREATE = 0x0001
+      WM_DESTROY = 0x0002
+      WM_MOVE = 0x0003
+      WM_SIZE = 0x0005
+      WM_ACTIVATE = 0x0006
+      WM_SETFOCUS = 0x0007
+      WM_KILLFOCUS = 0x0008
+      WM_ENABLE = 0x000A
+      WM_SETREDRAW = 0x000B
+      WM_SETTEXT = 0x000C
+      WM_GETTEXT = 0x000D
+      WM_GETTEXTLENGTH = 0x000E
+      WM_PAINT = 0x000F
+      WM_CLOSE = 0x0010
+      WM_QUERYENDSESSION = 0x0011
+      WM_QUIT = 0x0012
+      WM_QUERYOPEN = 0x0013
+      WM_ERASEBKGND = 0x0014
+      WM_SYSCOLORCHANGE = 0x0015
+      WM_ENDSESSION = 0x0016
+      WM_SHOWWINDOW = 0x0018
+      WM_WININICHANGE = 0x001A
+      WM_DEVMODECHANGE = 0x001B
+      WM_ACTIVATEAPP = 0x001C
+      WM_FONTCHANGE = 0x001D
+      WM_TIMECHANGE = 0x001E
+      WM_CANCELMODE = 0x001F
+      WM_SETCURSOR = 0x0020
+      WM_MOUSEACTIVATE = 0x0021
+      WM_CHILDACTIVATE = 0x0022
+      WM_QUEUESYNC = 0x0023
+      WM_GETMINMAXINFO = 0x0024
+      WM_PAINTICON = 0x0026
+      WM_ICONERASEBKGND = 0x0027
+      WM_NEXTDLGCTL = 0x0028
+      WM_SPOOLERSTATUS = 0x002A
+      WM_DRAWITEM = 0x002B
+      WM_MEASUREITEM = 0x002C
+      WM_DELETEITEM = 0x002D
+      WM_VKEYTOITEM = 0x002E
+      WM_CHARTOITEM = 0x002F
+      WM_SETFONT = 0x0030
+      WM_GETFONT = 0x0031
+      WM_SETHOTKEY = 0x0032
+      WM_GETHOTKEY = 0x0033
+      WM_QUERYDRAGICON = 0x0037
+      WM_COMPAREITEM = 0x0039
+      WM_COMPACTING = 0x0041
+      WM_COMMNOTIFY = 0x0044 #No longer supported
+      WM_WINDOWPOSCHANGING = 0x0046
+      WM_WINDOWPOSCHANGED = 0x0047
+      WM_POWER = 0x0048
+      WM_COPYDATA = 0x004A
+      WM_CANCELJOURNAL = 0x004B
+      WM_NOTIFY = 0x004E
+      WM_INPUTLANGCHANGEREQUEST = 0x0050
+      WM_INPUTLANGCHANGE = 0x0051
+      WM_TCARD = 0x0052
+      WM_HELP = 0x0053
+      WM_USERCHANGED = 0x0054
+      WM_NOTIFYFORMAT = 0x0055
+      WM_CONTEXTMENU = 0x007B
+      WM_STYLECHANGING = 0x007C
+      WM_STYLECHANGED = 0x007D
+      WM_DISPLAYCHANGE = 0x007E
+      WM_GETICON = 0x007F
+      WM_SETICON = 0x0080
+      WM_NCCREATE = 0x0081
+      WM_NCDESTROY = 0x0082
+      WM_NCCALCSIZE = 0x0083
+      WM_NCHITTEST = 0x0084
+      WM_NCPAINT = 0x0085
+      WM_NCACTIVATE = 0x0086
+      WM_GETDLGCODE = 0x0087
+      WM_NCMOUSEMOVE = 0x00A0
+      WM_NCLBUTTONDOWN = 0x00A1
+      WM_NCLBUTTONUP = 0x00A2
+      WM_NCLBUTTONDBLCLK = 0x00A3
+      WM_NCRBUTTONDOWN = 0x00A4
+      WM_NCRBUTTONUP = 0x00A5
+      WM_NCRBUTTONDBLCLK = 0x00A6
+      WM_NCMBUTTONDOWN = 0x00A7
+      WM_NCMBUTTONUP = 0x00A8
+      WM_NCMBUTTONDBLCLK = 0x00A9
+      WM_KEYFIRST = 0x0100
+      WM_KEYDOWN = 0x0100
+      WM_KEYUP = 0x0101
+      WM_CHAR = 0x0102
+      WM_DEADCHAR = 0x0103
+      WM_SYSKEYDOWN = 0x0104
+      WM_SYSKEYUP = 0x0105
+      WM_SYSCHAR = 0x0106
+      WM_SYSDEADCHAR = 0x0107
+      WM_KEYLAST = 0x0108
+      WM_IME_STARTCOMPOSITION = 0x010D
+      WM_IME_ENDCOMPOSITION = 0x010E
+      WM_IME_COMPOSITION = 0x010F
+      WM_IME_KEYLAST = 0x010F
+      WM_INITDIALOG = 0x0110
+      WM_COMMAND = 0x0111
+      WM_SYSCOMMAND = 0x0112
+      WM_TIMER = 0x0113
+      WM_HSCROLL = 0x0114
+      WM_VSCROLL = 0x0115
+      WM_INITMENU = 0x0116
+      WM_INITMENUPOPUP = 0x0117
+      WM_MENUSELECT = 0x011F
+      WM_MENUCHAR = 0x0120
+      WM_ENTERIDLE = 0x0121
+      WM_CTLCOLORMSGBOX = 0x0132
+      WM_CTLCOLOREDIT = 0x0133
+      WM_CTLCOLORLISTBOX = 0x0134
+      WM_CTLCOLORBTN = 0x0135
+      WM_CTLCOLORDLG = 0x0136
+      WM_CTLCOLORSCROLLBAR = 0x0137
+      WM_CTLCOLORSTATIC = 0x0138
+      WM_MOUSEFIRST = 0x0200
+      WM_MOUSEMOVE = 0x0200
+      WM_LBUTTONDOWN = 0x0201
+      WM_LBUTTONUP = 0x0202
+      WM_LBUTTONDBLCLK = 0x0203
+      WM_RBUTTONDOWN = 0x0204
+      WM_RBUTTONUP = 0x0205
+      WM_RBUTTONDBLCLK = 0x0206
+      WM_MBUTTONDOWN = 0x0207
+      WM_MBUTTONUP = 0x0208
+      WM_MBUTTONDBLCLK = 0x0209
+      WM_MOUSEWHEEL = 0x020A
+      WM_MOUSELAST = 0x0209
+      WM_PARENTNOTIFY = 0x0210
+      WM_ENTERMENULOOP = 0x0211
+      WM_EXITMENULOOP = 0x0212
+      WM_NEXTMENU = 0x0213
+      WM_SIZING = 0x0214
+      WM_CAPTURECHANGED = 0x0215
+      WM_MOVING = 0x0216
+      WM_POWERBROADCAST = 0x0218
+      WM_DEVICECHANGE = 0x0219
+      WM_IME_SETCONTEXT = 0x0281
+      WM_IME_NOTIFY = 0x0282
+      WM_IME_CONTROL = 0x0283
+      WM_IME_COMPOSITIONFULL = 0x0284
+      WM_IME_SELECT = 0x0285
+      WM_IME_CHAR = 0x0286
+      WM_IME_KEYDOWN = 0x0290
+      WM_IME_KEYUP = 0x0291
+      WM_MDICREATE = 0x0220
+      WM_MDIDESTROY = 0x0221
+      WM_MDIACTIVATE = 0x0222
+      WM_MDIRESTORE = 0x0223
+      WM_MDINEXT = 0x0224
+      WM_MDIMAXIMIZE = 0x0225
+      WM_MDITILE = 0x0226
+      WM_MDICASCADE = 0x0227
+      WM_MDIICONARRANGE = 0x0228
+      WM_MDIGETACTIVE = 0x0229
+      WM_MDISETMENU = 0x0230
+      WM_ENTERSIZEMOVE = 0x0231
+      WM_EXITSIZEMOVE = 0x0232
+      WM_DROPFILES = 0x0233
+      WM_MDIREFRESHMENU = 0x0234
+      WM_MOUSEHOVER = 0x02A1
+      WM_MOUSELEAVE = 0x02A3
+      WM_CUT = 0x0300
+      WM_COPY = 0x0301
+      WM_PASTE = 0x0302
+      WM_CLEAR = 0x0303
+      WM_UNDO = 0x0304
+      WM_RENDERFORMAT = 0x0305
+      WM_RENDERALLFORMATS = 0x0306
+      WM_DESTROYCLIPBOARD = 0x0307
+      WM_DRAWCLIPBOARD = 0x0308
+      WM_PAINTCLIPBOARD = 0x0309
+      WM_VSCROLLCLIPBOARD = 0x030A
+      WM_SIZECLIPBOARD = 0x030B
+      WM_ASKCBFORMATNAME = 0x030C
+      WM_CHANGECBCHAIN = 0x030D
+      WM_HSCROLLCLIPBOARD = 0x030E
+      WM_QUERYNEWPALETTE = 0x030F
+      WM_PALETTEISCHANGING = 0x0310
+      WM_PALETTECHANGED = 0x0311
+      WM_HOTKEY = 0x0312
+      WM_PRINT = 0x0317
+      WM_PRINTCLIENT = 0x0318
+      WM_HANDHELDFIRST = 0x0358
+      WM_HANDHELDLAST = 0x035F
+      WM_AFXFIRST = 0x0360
+      WM_AFXLAST = 0x037F
+      WM_PENWINFIRST = 0x0380
+      WM_PENWINLAST = 0x038F
+      
+      WM_USER = 0x0400
+      MY_MESSAGE = WM_USER + 1
+      MY_OTHER_MESSAGE = WM_USER + 2
+    end
+    
+    #Sends a window message to +self+ and waits for the window 
+    #to process it. 
+    #===Parameters
+    #[+msg+] The message to send. Either a constant from the Window::Messages module, or a symbol formed off a such name. For example, for WM_DESTROY you'd pass :destroy. 
+    #[+info1+] (0) Additional message-specific information (wParam value). 
+    #[+info2+] (0) Additional message-specific information (lParam value). 
+    #===Return value
+    #The return value of the SendMessage() function. 
+    #===Raises
+    #[Au3Error] Window not found. 
+    #[Errno::EACCES] Windows's security policy blocked the function call. 
+    #===Example
+    #  win.send_message(:destroy) #Immediately destroys a window. No chance to save. 
+    #You can find the additional paramters needed for each message at the Windows API docs at MSDN[http://msdn.microsoft.com/en-us/library/aa383749%28VS.85%29.aspx]. 
+    #I recommand you to query the search function with something like "WM_PAINT" if you want to know more about WM_PAINT. 
+    def send_message(msg, info1 = 0, info2 = 0)
+      Window.functions[__method__] ||= Win32::API.new("SendMessage", 'LILL', 'L', "user32")
+      
+      raise_unfound unless exists?
+      msg = Messages.const_get(:"WM_#{msg.to_s.upcase}") if msg.kind_of? Symbol
+      ret = Window.functions[__method__].call(self.to_i, msg, info1, info2)
+      Kernel.raise(Errno::EACCES, "The Windows UIPI blocked your function call.") if Window.functions[:get_last_error].call == 5
+      ret
+    end
+    
+    #Puts a window message in +self+'s message queue and immediately returns. 
+    #===Parameters
+    #[+msg+] The message to send. Either a constant from the Window::Messages module, or a symbol formed off a such name. For example, for WM_QUIT you'd pass :quit. 
+    #[+info1+] (0) Additional message-specific information (wParam value). 
+    #[+info2+] (0) Additional message-specific information (lParam value). 
+    #===Return value
+    #The return value of the PostMessage() function. 
+    #===Raises
+    #[Au3Error] Window not found. 
+    #[Errno::EACCES] Windows's security policy blocked the function call. 
+    #===Example
+    #  win.post_message(:quit) #Request a window to exit. It doesn't have to obey, though. 
+    #===Remarks
+    #You can find the additional paramters needed for each message at the Windows API docs at MSDN[http://msdn.microsoft.com/en-us/library/aa383749%28VS.85%29.aspx]. 
+    #I recommand you to query the search function with something like "WM_PAINT" if you want to know more about WM_PAINT. 
+    def post_message(msg, info1 = 0, info2 = 0)
+      Window.functions[__method__] ||= Win32::API.new("PostMessage", 'LILL', 'I', "user32")
+      
+      raise_unfound unless exists?
+      msg = Messages.const_get(:"WM_#{msg.to_s.upcase}") if msg.kind_of? Symbol
+      ret = Window.functions[__method__].call(self.to_i, msg, info1, info2)
+      Kernel.raise(Errno::EACCES, "The Windows UIPI blocked your function call.") if Window.functions[:get_last_error].call == 5
+      ret
+    end
+    
+  end
+  
+end

data/lib/HISTORY.rdoc

@@ -1,5 +1,15 @@
 =History of au3
 Important changes are marked <b>bold</b>. Bugfixes are written <i>italic</i>. 
+
+==0.1.2
+*  Improved the documentation significantly.
+*  <i>Fixed a typo and a bug in window.rb which made Window.select_menu_item raising errors. Also enhanced documentation of this method. Thanks to sdavis26 for reporting. </i>
+*  <i>TreeView#send_command_to_tree_view raised an error when passed integer values. This has been fixed.</i>
+*  <i>The method AutoItX3::ListView#selected returned strings although thedocs said that it returned indices which are generally expectedto be numbers. This has been corrected; the method returns now an array of integers.</i>
+*  <i>Button#checked? always returned false. This has been fixed. </i>
+*  <i>Window#client_size always raised an ArgumentError. This has been fixed. </i>
+*  <b>Added the Window#send_message and Window#post_message methods. Since they belong rather to automation in general than to AutoIt in special, they reside in an extra file 'AutoItX3/window/send_message.rb' which you have to require first in order to get them.</b>
+
 ==0.1.1
 *  Corrected documentation main page set by the Rakefile
 * <b>Added ##method_missing to the AutoItX3 module to allow shortcuts like <tt>AutoItX3.ctrl_c</tt>. </b>

data/lib/README.rdoc

@@ -1,3 +1,4 @@
+-- Encoding: UTF-8 ++
 =au3
 <tt>.au3</tt> is the usual file extension for {AutoIt version 3}[http://www.autoitscript.com/autoit3/index.shtml] 
 scripts. That this library uses it as its name, tells a lot about 
@@ -20,6 +21,15 @@ Or, if you don't want to copy the file over and over again, put it in your Ruby'
 bin directory. If you want to deploy your program, the final recipient need not 
 to have AutoIt installed - it's enough if you just include the AutoItX3.dll in your 
 application (and make sure you've read the AutoItX3 license - it's quite short). 
+==Win32API problems:
+You may get an error message similar to this after requiring 'au3':
+  The specified module was not found. 
+This message also appears if you just require "win32/api", it's therefore not a problem with au3. 
+The simplest solution is to gem uninstall win32-api followed by 
+  gem install win32-api --platform=ruby
+which forces RubyGems to compile win32-api from source. Of course, in order to 
+do this you need to have a C compiler, for example from the RubyInstaller devkit or 
+MinGW/MSYS directly. 
 ==Usage
 The majority of +au3+'s methods is bundled in the AutoItX3 module 
 and accessable via it's module methods. In order to get them, 
@@ -53,12 +63,27 @@ wrapped in the AutoItX3::Control class.
   edit = window.focused_control
   #Set the text. You should also have a look on the AutoItX3.send_keys method.
   edit.text = "ABCDEFG"
+
+If you like to play with window messages directly, require 'AutoItX3/window/send_message' which 
+leaves the scope of AutoIt behind and directly wraps some Win32API functions. You get two new instance 
+methods for the AutoItX3::Window class, #post_message and #send_message, and now you can enjoy 
+doing things like 
+  require "au3"
+  require "AutoItX3/window/send_message"
+  #...
+  win.post_message(:close)
+. See the method's documentations for more information on this. 
 ===Don't know where to start?
 Have a look at the documentation of the AutoItX3 module. 
 +au3+ is well documented and even if you don't find something 
 useful, you may just want to play around with it. ;-)
 ==Copyright
-  Copyright © 2009 Marvin Gülker
+  Copyright © 2009, 2010 Marvin Gülker, Steven Heidel
+  
+  Contact: 
+  Marvin Gülker (Quintus): sutniuq@@gmx@net
+  Steven Heidel (stevenheidel): steven@@livingskyweb@ca
+  
   Licensed under the same terms as Ruby (see http://www.ruby-lang.org/en/LICENSE.txt )
     Initia in potestate nostra sunt, de eventu fortuna iudicat. 
 ==License

data/lib/au3.rb

@@ -1,2 +1,8 @@
 #Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009, 2010 Marvin Gülker, Steven Heidel
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
 require_relative("AutoItX3/au3.rb")

data/test/test_misc.rb

@@ -34,7 +34,7 @@ class MiscTest < Test::Unit::TestCase
   end
   
   def test_opt
-    AutoItX3.run("mspaint.exe")
+    pid = AutoItX3.run("mspaint.exe")
     AutoItX3.opt("WinTitleMatchMode", 2) do
       assert(AutoItX3::Window.wait("Paint", "", 3)) #Timeout means false
     end
@@ -43,6 +43,7 @@ class MiscTest < Test::Unit::TestCase
     assert(AutoItX3::Window.wait("Paint", "", 3))
     AutoItX3.opt("WinTitleMatchMode", 1)
     assert_equal(false, AutoItX3::Window.wait("Paint", "", 3))
+    AutoItX3.kill_process(pid)
   end
   
 end

data/test/test_window_messages.rb

@@ -0,0 +1,42 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009, 2010 Marvin Gülker, Steven Heidel
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+begin
+  require_relative "../lib/au3"
+  require_relative "../lib/AutoItX3/window/send_message"
+rescue LoadError
+  #Aha, this is the gem, not the build environment
+  require "au3"
+  require "AutoItX3/window/send_message"
+end
+require "test/unit"
+
+class WindowCommandTest < Test::Unit::TestCase
+  
+  def self.startup
+    AutoItX3.opt("WinTitleMatchMode", 2)
+  end
+  
+  def setup
+    AutoItX3.run("mspaint")
+    sleep 1
+    @win = AutoItX3::Window.new("Paint")
+  end
+  
+  def test_send_message
+    @win.send_message(:close)
+    sleep 0.5
+    assert(!@win.exists?)
+  end
+  
+  def test_post_message
+    @win.post_message(:close)
+    sleep 0.5
+    assert(!@win.exists?)
+  end
+  
+end

metadata

@@ -1,40 +1,56 @@
 --- !ruby/object:Gem::Specification 
 name: au3
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
-- Marvin Guelker
+- "Marvin G\xC3\xBClker, Steven Heidel"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-12-27 00:00:00 +01:00
+date: 2010-06-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: win32-api
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
         version: "1.4"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: test-unit
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
         version: "2.0"
-    version: 
+  type: :development
+  version_requirements: *id002
 description: "  au3 is a gem that provides Ruby bindings to the AutoIt Windows automation tool by \n\
   using it's DLL interface AutoItX. \n"
-email: sutniuq@gmx.net
+email: sutniuq@gmx.net, steven@livingskyweb.ca
 executables: []
 
 extensions: []
@@ -50,6 +66,7 @@ files:
 - test/test_mouse.rb
 - test/test_process.rb
 - test/test_window.rb
+- test/test_window_messages.rb
 - lib/HISTORY.rdoc
 - lib/README.rdoc
 - lib/au3.rb
@@ -62,8 +79,9 @@ files:
 - lib/AutoItX3/mouse.rb
 - lib/AutoItX3/process.rb
 - lib/AutoItX3/window.rb
+- lib/AutoItX3/window/send_message.rb
 has_rdoc: true
-homepage: http://wiki.github.com/Quintus/Automations
+homepage: http://auto.rubyforge.org/
 licenses: []
 
 post_install_message: 
@@ -75,22 +93,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 29
+      segments: 
+      - 1
+      - 9
       version: "1.9"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: 
 - Microsoft Windows
 - AutoItX3.dll from AutoIt3
 rubyforge_project: Automations
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A binding to the AutoItX3 Windows automation tool.
@@ -103,3 +128,4 @@ test_files:
 - test/test_mouse.rb
 - test/test_process.rb
 - test/test_window.rb
+- test/test_window_messages.rb