au3 0.1.0

data/lib/AutoItX3/filedir.rb

@@ -0,0 +1,99 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009 Marvin Gülker
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+module AutoItX3
+  
+  class << self
+    
+    #====Arguments
+    #Every | is ment to be a backslash. 
+    #- device: The device letter to map the drive to, in the form <tt>"X:"</tt>. If this is an asterisk *, the next available letter will be used. 
+    #- remote_share: The address of the network drive, in the form <tt>"||Server|Drive"</tt> or <tt>"||Server|Share"</tt>. 
+    #- flags (0): A combination (via +) of 1 (PersistantMapping) and 8 (Show authentification dialog if neccessary). 
+    #- username (""): The username, of the form <tt>"username"</tt> or <tt>"Domain|username"</tt>. 
+    #- password (""): The login password. 
+    #====Description
+    #Maps a network drive and raises an Au3Error if the action is not successful. 
+    def add_drive_map(device, remote_share, flags = 0, username = "", password = "")
+      @functions[__method__] ||= AU3_Function.new("DriveMapAdd", 'SSLSSPI')
+      buffer = " " * BUFFER_SIZE
+      buffer.wide!
+      @functions[__method__].call(device, remote_share, flags, username, password, buffer, buffer.size - 1)
+      
+      case last_error
+        when 1 then raise(Au3Error, "Unknown error occured while mapping network drive!")
+        when 2 then raise(Au3Error, "Access denied!")
+        when 3 then raise(Au3Error, "Device '#{device}' is already assigned!")
+        when 4 then raise(Au3Error, "Invalid device name '#{device}'!")
+        when 5 then raise(Au3Error, "Invalid remote share '#{remote_share}'!")
+        when 6 then raise(Au3Error, "The password is incorrect!")
+        else return buffer.normal.strip
+      end
+    end
+    
+    #Disconnects a network drive. +device+ can be either of form <tt>"X:"</tt> or 
+    #<tt>"||Server|share"</tt> (imagine every | to be a backslash). 
+    #Raises an Au3Error if the disconnection was unsucsessful. 
+    def delete_drive_map(device)
+      @functions[__method__] ||= AU3_Function.new("DriveMapDel", 'S', 'L')
+      result = @functions[__method__].call(device)
+      if result == 0
+        raise(Au3Error, "Failed to remove remote device '#{device}'!")
+      end
+      true
+    end
+    
+    #Gets the server of the network drive named by +device+ or raises an Au3Error if it 
+    #can't access the device for some reason. The returned string will be of form 
+    #<tt>"||Server|drive"</tt> (every | is ment to be a backslash).  
+    def get_drive_map(device)
+      @functions[__method__] ||= AU3_Function.new("DriveMapGet", 'SPI')
+      buffer = " " * BUFFER_SIZE
+      buffer.wide!
+      ret = @functions[__method__].call(device, buffer, buffer.size - 1)
+      
+      if last_error == 1
+        raise(Au3Error, "Failed to retrieve information about device '#{device}'")
+      end
+      buffer.normal.strip
+    end
+    
+    #Deletes a key-value pair in a standard <tt>.ini</tt> file. 
+    def delete_ini_entry(filename, section, key)
+      @functions[__method__] ||= AU3_Function.new("IniDelete", 'SSS', 'L')
+      if @functions[__method__].call(filename.wide, section.wide, key.wide) == 0
+        false
+      else
+        true
+      end
+    end
+    
+    #Reads a value from a standard <tt>.ini</tt> file or returns the string given by +default+ 
+    #if it can't find the key. The returned string will have a maximum length of 99,999 characters. 
+    def read_ini_entry(filename, section, key, default = nil)
+      @functions[__method__] ||= AU3_Function.new("IniRead", 'SSSSPI')
+      buffer = " " * BUFFER_SIZE
+      buffer.wide!
+      @functions[__method__].call(filename.wide, section.wide, key.wide, default.to_s.wide, buffer, buffer.size - 1)
+      buffer.normal.strip
+    end
+    
+    #Writes the specified key-value pair in a <tt>.ini</tt> file. Existing key-value pairs are overwritten. 
+    #A non-existing file will be created. Raises an Au3Error if +filename+ is read-only. 
+    def write_ini_entry(filename, section, key_value, value)
+      @functions[__method__] ||= AU3_Function.new("IniWrite", 'SSSS', 'L')
+      
+      if @functions[__method__].call(filename.wide, section.wide, key_value.wide, value.wide) == 0
+        raise(Au3Error, "Cannot open file for write access!")
+      else
+        value
+      end
+    end
+    
+  end #au3single
+  
+end #AutoItX3

data/lib/AutoItX3/graphic.rb

@@ -0,0 +1,32 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009 Marvin Gülker
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+module AutoItX3
+  
+  class << self
+    
+    #Computes a checksum of the pixels in the specified region. If the checksum 
+    #changes, that only indidcates that *something* has changed, not *what*. 
+    #Note that this method may be very time-consuming, so think about increasing the 
+    #+step+ parameter (but bear in mind that that will generate more inaccurate checksums). 
+    def pixel_checksum(x1, y1, x2, y2, step = 1)
+      @functions[__method__] ||= AU3_Function.new("PixelChecksum", 'LLLLL', 'L')
+      @functions[__method__].call(x1, y1, x2, y2, step)
+    end
+    
+    #Retrieves the *decimal* color value of a pixel. If you want the hexadecimal, 
+    #pass in true as a third parameter. 
+    def get_pixel_color(x, y, hex = false)
+      @functions[__method__] ||= AU3_Function.new("PixelGetColor", 'LL', 'L')
+      res = @functions[__method__].call(x, y)
+      return "#" + res.to_s(16).upcase if hex
+      res
+    end
+    
+  end
+  
+end

data/lib/AutoItX3/keyboard.rb

@@ -0,0 +1,166 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009 Marvin Gülker
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+module AutoItX3
+  
+  class << self
+    
+    #Simulates the given keystrokes. If you don't 
+    #set +flag+ to true (which disables escape sequences), you may 
+    #use some of the follwing escape sequences in braces { and } 
+    #(copied from the AutoItX3 help): 
+    #  Escape sequence     | Resulting keypress
+    #  ====================+============================================================
+    #  !                   | !
+    #  --------------------+------------------------------------------------------------
+    #  #                   | #
+    #  --------------------+------------------------------------------------------------
+    #  +                   | +
+    #  --------------------+------------------------------------------------------------
+    #  ^                   | ^
+    #  --------------------+------------------------------------------------------------
+    #  {                   | {
+    #  --------------------+------------------------------------------------------------
+    #  }                   | }
+    #  --------------------+------------------------------------------------------------
+    #  SPACE               | SPACE
+    #  --------------------+------------------------------------------------------------
+    #  ENTER               | Return on the main keyboard
+    #  --------------------+------------------------------------------------------------
+    #  ALT                 | Alt
+    #  --------------------+------------------------------------------------------------
+    #  BACKSPACE or BS     | Backspace
+    #  --------------------+------------------------------------------------------------
+    #  DELETE or DEL       | Del
+    #  --------------------+------------------------------------------------------------
+    #  UP                  | Up arrow
+    #  --------------------+------------------------------------------------------------
+    #  DOWN                | Down arrow
+    #  --------------------+------------------------------------------------------------
+    #  LEFT                | Left arrow
+    #  --------------------+------------------------------------------------------------
+    #  RIGHT               | Right arrow
+    #  --------------------+------------------------------------------------------------
+    #  HOME                | Home
+    #  --------------------+------------------------------------------------------------
+    #  END                 | End
+    #  --------------------+------------------------------------------------------------
+    #  ESCAPE or ESC       | ESC
+    #  --------------------+------------------------------------------------------------
+    #  INSERT or INS       | Ins
+    #  --------------------+------------------------------------------------------------
+    #  PGUP                | Page Up
+    #  --------------------+------------------------------------------------------------
+    #  PGDN                | Page Down
+    #  --------------------+------------------------------------------------------------
+    #  F1 - F12            | Function keys 1 to 12
+    #  --------------------+------------------------------------------------------------
+    #  TAB                 | Tab
+    #  --------------------+------------------------------------------------------------
+    #  PRINTSCREEN         | Printscreen
+    #  --------------------+------------------------------------------------------------
+    #  LWIN                | Left Windows key
+    #  --------------------+------------------------------------------------------------
+    #  RWIN                | Right Windows key
+    #  --------------------+------------------------------------------------------------
+    #  NUMLOCK on          | NumLock on
+    #  --------------------+------------------------------------------------------------
+    #  CAPSLOCK off        | CapsLock off
+    #  --------------------+------------------------------------------------------------
+    #  SCROLLLOCK toggle   | ScrollLock toggle
+    #  --------------------+------------------------------------------------------------
+    #  BREAK               | For CTRL-Break processing
+    #  --------------------+------------------------------------------------------------
+    #  PAUSE               | Pause
+    #  --------------------+------------------------------------------------------------
+    #  NUMPAD0 - NUMPAD9   | Numpad number keys. 
+    #  --------------------+------------------------------------------------------------
+    #  NUMPADMUTLT         | Numpad Multipy
+    #  --------------------+------------------------------------------------------------
+    #  NUMPADADD           | Numpad Add
+    #  --------------------+------------------------------------------------------------
+    #  NUMPADSUBT          | Numpad Subtract
+    #  --------------------+------------------------------------------------------------
+    #  NUMPADDIV           | Numpad Division
+    #  --------------------+------------------------------------------------------------
+    #  NUMPADDOT           | Numpad dot
+    #  --------------------+------------------------------------------------------------
+    #  NUMPADENTER         | Numpad return key
+    #  --------------------+------------------------------------------------------------
+    #  APPSKEY             | Windows App key
+    #  --------------------+------------------------------------------------------------
+    #  LALT                | Left Alt key
+    #  --------------------+------------------------------------------------------------
+    #  RALT                | Right Alt key
+    #  --------------------+------------------------------------------------------------
+    #  LCTRL               | Left control key
+    #  --------------------+------------------------------------------------------------
+    #  LSHIFT              | Left Shift key
+    #  --------------------+------------------------------------------------------------
+    #  RSHIFT              | Right Shift key
+    #  --------------------+------------------------------------------------------------
+    #  SLEEP               | Computer Sleep key
+    #  --------------------+------------------------------------------------------------
+    #  ALTDOWN             | Hold Alt down until ALTUP is sent
+    #  --------------------+------------------------------------------------------------
+    #  SHIFTDOWN           | Hold Shift down until SHIFTUP is sent
+    #  --------------------+------------------------------------------------------------
+    #  CTRLDOWN            | Hold CTRL down until CTRLUP is sent
+    #  --------------------+------------------------------------------------------------
+    #  LWINDOWN            | Hold the left Windows key down until LWDINUP is sent
+    #  --------------------+------------------------------------------------------------
+    #  RWINDOWN            | Hold the right Windows key down until RWINUP is sent
+    #  --------------------+------------------------------------------------------------
+    #  ASC nnnn            | Send the kombination Alt+nnnn on numpad
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_BACK        | 2000/XP Only: Select the browser "back" button
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_FORWARD     | 2000/XP Only: Select the browser "forward" button
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_REFRESH     | 2000/XP Only: Select the browser "refresh" button
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_STOP        | 2000/XP Only: Select the browser "stop" button
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_SEARCH      | 2000/XP Only: Select the browser "search" button
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_FAVORITES   | 2000/XP Only: Select the browser "favorites" button
+    #  --------------------+------------------------------------------------------------
+    #  BROWSER_HOME        | 2000/XP Only: Launch the browser and go to the home page
+    #  --------------------+------------------------------------------------------------
+    #  VOLUME_MUTE         | 2000/XP Only: Mute the volume
+    #  --------------------+------------------------------------------------------------
+    #  VOLUME_DOWN         | 2000/XP Only: Reduce the volume
+    #  --------------------+------------------------------------------------------------
+    #  VOLUME_UP           | 2000/XP Only: Increase the volume
+    #  --------------------+------------------------------------------------------------
+    #  MEDIA_NEXT          | 2000/XP Only: Select next track in media player
+    #  --------------------+------------------------------------------------------------
+    #  MEDIA_PREV          | 2000/XP Only: Select previous track in media player
+    #  --------------------+------------------------------------------------------------
+    #  MEDIA_STOP          | 2000/XP Only: Stop media player
+    #  --------------------+------------------------------------------------------------
+    #  MEDIA_PLAY_PAUSE    | 2000/XP Only: Play/pause media player
+    #  --------------------+------------------------------------------------------------
+    #  LAUNCH_MAIL         | 2000/XP Only: Launch the email application
+    #  --------------------+------------------------------------------------------------
+    #  LAUNCH_MEDIA        | 2000/XP Only: Launch media player
+    #  --------------------+------------------------------------------------------------
+    #  LAUNCH_APP1         | 2000/XP Only: Launch user app1
+    #  --------------------+------------------------------------------------------------
+    #  LAUNCH_APP2         | 2000/XP Only: Launch user app2
+    #
+    #A "!" in +keys+ indicates an ALT keystroke, 
+    #the "+" means SHIFT, "^" CTRL 
+    #and "#" is the Windows key. 
+    def send_keys(keys, flag = false)
+      @functions[__method__] ||= AU3_Function.new("Send", 'SL')
+      @functions[__method__].call(keys.wide, flag)
+    end
+    
+  end
+  
+end

data/lib/AutoItX3/misc.rb

@@ -0,0 +1,105 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009 Marvin Gülker
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+module AutoItX3
+  
+  class << self
+    
+    #Blocks user input or enables it (but the user can gain back control by 
+    #pressing [CTRL] + [ALT] + [DEL]). In older versions of Windows, 
+    #AutoIt may also be blocked. Does not work with Windows Vista. 
+    def block_input=(val)
+      @functions[__method__] ||= AU3_Function.new("BlockInput", 'L')
+      @functions[__method__].call(!!val)
+      @input_blocked = !!val
+    end
+    
+    #Returns wheather or not input is blocked by AutoItX3. 
+    def input_blocked?
+      @input_blocked ||= false
+    end
+    
+    #Opens the cd drive named in +drive+. +drive+ should be of form 
+    #<tt>"X:"</tt>. The cd tray must be local at this computer, remote drives 
+    #cannot be accessed. 
+    def open_cd_tray(tray)
+      @functions[__method__] ||= AU3_Function.new("CDTray", 'SS', 'L')
+      raise(ArgumentError, "The drive name has to be of form 'X:'!") unless tray =~ /^\w:$/
+      if @functions[__method__].call(tray.wide, "open".wide) == 0
+        return false
+      else
+        return true
+      end
+    end
+    
+    #Closes a cd tray. +drive+ should be of form <tt>"X:"</tt>. The cd tray must 
+    #be local at this computer, remote drives cannot be accessed. 
+    #The method may return true if +drive+ is a laptop drive which can only be 
+    #closed manually. 
+    def close_cd_tray(tray)
+      @functions[__method__] ||= AU3_Function.new("CDTray", 'SS', 'L')
+      raise(ArgumentError, "The drive name has to be of form 'X:'!") unless tray =~ /^\w:$/
+      if @functions[__method__].call(tray.wide, "closed".wide) == 0
+        return false
+      else
+        return true
+      end
+    end
+    
+    #Determines wheather the current user has administrator privileges. 
+    def is_admin?
+      @functions[__method__] ||= AU3_Function.new("IsAdmin", 'V', 'L')
+      return false if @functions[__method__].call == 0
+      true
+    end
+    
+    #Writes +text+ to the Windows clipboard. 
+    #You can't write NUL characters to the clipboard, the text will 
+    #be terminated. 
+    def cliptext=(text)
+      @functions[__method__] ||= AU3_Function.new("ClipPut", 'S')
+      @functions[__method__].call(text.wide)
+      text
+    end
+    
+    #Returns the text saved in the clipboard. It will be truncated at the 99,999th character or 
+    #at a NUL char. 
+    def cliptext
+      @functions[__method__] ||= AU3_Function.new("ClipGet", 'PL')
+      cliptext = " " * BUFFER_SIZE
+      cliptext.wide!
+      @functions[__method__].call(cliptext, cliptext.size - 1)
+      cliptext.normal.strip
+    end
+    
+    #call-seq: 
+    #  tool_tip( text [, x = INTDEFAULT [, y = INTDEFAULT ] ] ) ==> nil
+    #  tooltip( text [, x = INTDEFAULT [, y = INTDEFAULT ] ] ) ==> nil
+    #
+    #Displays a tooltip at the given position. If +x+ and +y+ are ommited, 
+    #the tooltip will be displayed at the current cursor position. Coordinates 
+    #out of range are automatically corrected. 
+    #The tooltip will be deleted when the program ends, or after a system-dependent 
+    #timeout. 
+    def tool_tip(text, x = INTDEFAULT, y = INTDEFAULT)
+      @functions[__method__] ||= AU3_Function.new("ToolTip", 'SLL')
+      @functions[__method__].call(text.wide, x, y)
+    end
+    alias tooltip tool_tip
+    
+    #Wait for the specified amount of milliseconds. In AutoIt, this function is named 
+    #"Sleep", but to avoid compatibility issues with Ruby's own sleep I decided to 
+    #name the function "msleep" (the "m" indicates "milli"). If you wish to name it 
+    #"sleep", simply define an alias. 
+    def msleep(msecs)
+      @functions[__method__] ||= AU3_Function.new("Sleep", 'L')
+      @functions[__method__].call(msecs)
+    end
+    
+  end #au3single
+  
+end #AutoItX3

data/lib/AutoItX3/mouse.rb

@@ -0,0 +1,130 @@
+#Encoding: UTF-8
+#This file is part of au3. 
+#Copyright © 2009 Marvin Gülker
+#
+#au3 is published under the same terms as Ruby. 
+#See http://www.ruby-lang.org/en/LICENSE.txt
+
+module AutoItX3
+  
+  #Unknown cursor icon
+  UNKNOWN_CURSOR = 0
+  #Application starting cursor (arrow with a hourglass next to it)
+  APP_STARTING_CURSOR = 1
+  #The normal cursor
+  ARROW_CURSOR = 2
+  #Cross cursor
+  CROSS_CURSOR = 3
+  #Cursor with a question mark next to it
+  HELP_CURSOR = 4
+  #Cursor for editing lines of text
+  IBEAM_CURSOR = 5
+  ICON_CURSOR = 6
+  #Cursor for forbidden actions (a circle with a strike through it)
+  NO_CURSOR = 7
+  SIZE_CURSOR = 8
+  SIZE_ALL_CURSOR = 9
+  SIZE_NESW_CURSOR = 10
+  SIZE_NS_CURSOR = 11
+  SIZE_NWSE_CURSOR = 12
+  SIZE_WE_CURSOR = 13
+  UP_ARROW_CURSOR = 14
+  #Wait (the well-known "hourglass")
+  WAIT_CURSOR = 15
+  
+  class << self
+    
+    #====Arguments
+    #- x (INTDEFAULT): The X position. The cursor's current X if not specified. 
+    #- y (INTDEFAULT): The Y position. The cursor's current Y if not specified. 
+    #- button("Primary"): The mouse button to click width. On a mouse for left-handed people the right, for right-handed people the left mouse button. 
+    #- clicks(1): The number of times to click. 
+    #- speed(10): The speed the mouse cursor will move with. If set to 0, the cursor is set immediatly. 
+    #
+    #Clicks the mouse. 
+    def mouse_click(x = INTDEFAULT, y = INTDEFAULT, button = "Primary", clicks = 1, speed = 10)
+      @functions[__method__] ||= AU3_Function.new("MouseClick", 'SLLLL', 'L')
+      @functions[__method__].call(button.wide, x, y, clicks, speed)
+      
+      raise(Au3Error, "Invalid button '#{button}'!") if last_error == 1
+      nil
+    end
+    
+    #Performes a drag & drop operation with the given parameters. 
+    def drag_mouse(x1, y1, x2, y2, button = "Primary", speed = 10)
+      @functions[__method__] ||= AU3_Function.new("MouseClickDrag", 'SLLLLL', 'L')
+      @functions[__method__].call(button.wide, x1, y1, x2, y2, speed)
+      
+      raise(Au3Error, "Invalid button '#{button}'!") if last_error == 1
+      nil
+    end
+    
+    #call-seq: 
+    #  hold_mouse_down( [ button = "Primary" ] ) ==> nil
+    #  mouse_down( [ button = "Primary" ] ) ==> nil
+    #
+    #Holds a mouse button down (the left by default, or the right if mouse buttons are swapped). 
+    #You should release the mouse button somewhen. 
+    def hold_mouse_down(button = "Primary")
+      @functions[__method__] ||= AU3_Function.new("MouseDown", 'S')
+      @functions[__method__].call(button.wide)
+      nil
+    end
+    
+    #call-seq: 
+    #  cursor_id ==> aFixnum
+    #  get_cursor_id ==> aFixnum
+    #
+    #Returns one of the *_CURSOR constants to indicate which cursor icon is actually shown. 
+    def cursor_id
+      @functions[__method__] ||= AU3_Function.new("MouseGetCursor", '', 'L')
+      @functions[__method__].call
+    end
+    
+    #call-seq: 
+    #  cursor_pos ==> anArray
+    #  get_cursor_pos ==> anArray
+    #
+    #Returns the current cursor position in a two-element array of form <tt>[x, y]</tt>. 
+    def cursor_pos
+      @functions[:cursor_pos_x] ||= AU3_Function.new("MouseGetPosX", 'V', 'L')
+      @functions[:cursor_pos_y] ||= AU3_Function.new("MouseGetPosY", 'V', 'L')
+      [@functions[:cursor_pos_x].call, @functions[:cursor_pos_y].call]
+    end
+    
+    #call-seq: 
+    #  move_mouse( x , y [, speed = 10 ] ) ==> nil
+    #  mouse_move( x , y [, speed = 10 ] ) ==> nil
+    #
+    #Moves the mouse cursor to the given position. If +speed+ is 0, 
+    #it's set immediately. 
+    def move_mouse(x, y, speed = 10)
+      @functions[__method__] ||= AU3_Function.new("MouseMove", 'LLL', 'L')
+      @functions[__method__].call(x, y, speed)
+      nil
+    end
+    
+    #call-seq: 
+    #  release_mouse( [ button = "Primary" ] ) ==> nil
+    #  mouse_up( [ button = "Primary" ] ) ==> nil
+    #
+    #Releases a mouse button hold down by #hold_mouse_down. 
+    def release_mouse(button = "Primary")
+      @functions[__method__] ||= AU3_Function.new("MouseUp", 'S')
+      @functions[__method__].call(button.wide)
+      nil
+    end
+    
+    #Scrolls up or down the mouse wheel +times+ times. Use 
+    #ether "Up" or "Down" as the value for +direction+. 
+    def mouse_wheel(direction, times = 5)
+      @functions[__method__] ||= AU3_Function.new("MouseWheel", 'SL')
+      @functions[__method__].call(direction.wide, times)
+      
+      raise(Au3Error, "Undefined mouse wheel direction '#{direction}!") if last_error == 1
+      nil
+    end
+    
+  end
+  
+end