win 0.3.6 → 0.3.7

data/HISTORY

@@ -18,3 +18,7 @@
 == 0.3.6 / 2010-05-31
 
 * Complex convenience methods (dialog
+
+== 0.3.7 / 2010-06-01
+
+* SetForegroudWindow added

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.3.7

data/lib/extension.rb

@@ -0,0 +1,26 @@
+# This file extends core Ruby classes! Please make sure it doesn't create conflicts
+
+class String
+  # returns snake_case representation of string
+  def snake_case
+    gsub(/([a-z])([A-Z0-9])/, '\1_\2' ).downcase
+  end
+
+  # returns camel_case representation of string
+  def camel_case
+    if self.include? '_'
+      self.split('_').map{|e| e.capitalize}.join
+    else
+      unless self =~ (/^[A-Z]/)
+        self.capitalize
+      else
+        self
+      end
+    end
+  end
+
+  # converts string to 'wide char' (Windows Unicode) format
+  def to_w
+    (self+"\x00").encode('utf-16LE')
+  end
+end

data/lib/win/gui/dialog.rb

@@ -3,23 +3,196 @@ require 'win/gui/window'
 
 module Win
   module Gui
-    # Contains constants and Win32API functions related to dialog manipulation
-    #
-    module Dialog
-
-      # IDs of standard dialog controls and items
-      IDOK = 1
-      IDCANCEL = 2
-      IDABORT = 3
-      IDRETRY = 4
-      IDIGNORE = 5
-      IDYES = 6
-      IDNO = 7
-      ErrorIcon = 0x0014
 
+    # Contains constants and Win32 API functions related to dialog manipulation.
+    # Windows dialog basics can be found here:
+    # http://msdn.microsoft.com/en-us/library/ms644996#init_box
+    module Dialog
       include Win::Library
       include Win::Gui::Window
 
+      # Message Box flags:
+
+      # To indicate the buttons displayed in the message box, specify one of the following values:
+
+      # The message box contains one push button: OK. This is the default.
+      MB_OK                        = 0x00000000
+      # The message box contains two push buttons: OK and Cancel.
+      MB_OKCANCEL                  = 0x00000001
+      # The message box contains three push buttons: Abort, Retry, and Ignore (considered obsolete)
+      MB_ABORTRETRYIGNORE          = 0x00000002
+      # The message box contains three push buttons: Yes, No, and Cancel.
+      MB_YESNOCANCEL               = 0x00000003
+      # The message box contains two push buttons: Yes and No.
+      MB_YESNO                     = 0x00000004
+      # The message box contains two push buttons: Retry and Cancel.
+      MB_RETRYCANCEL               = 0x00000005
+      #  The message box contains three push buttons: Cancel, Try Again, Continue (Win 2000/XP).
+      # Use this message box type instead of MB_ABORTRETRYIGNORE.
+      MB_CANCELTRYCONTINUE         = 0x00000006
+
+      # To display an icon in the message box, specify one of the following values:
+
+      # A stop-sign icon appears in the message box.
+      MB_ICONHAND                  = 0x00000010
+      # A question-mark icon appears in the message box. The question-mark message icon is no longer
+      # recommended because it does not clearly represent a specific type of message and because the phrasing
+      # of a message as a question could apply to any message type. In addition, users can confuse the message
+      # symbol question mark with Help information. Therefore, do not use this question mark message symbol in
+      # your message boxes. The system continues to support its inclusion only for backward compatibility.
+      MB_ICONQUESTION              = 0x00000020
+      # An exclamation-point icon appears in the message box.
+      MB_ICONEXCLAMATION           = 0x00000030
+      # An icon consisting of a lowercase letter i in a circle appears in the message box.
+      MB_ICONASTERISK              = 0x00000040
+      MB_USERICON                  = 0x00000080
+      # An exclamation-point icon appears in the message box.
+      MB_ICONWARNING               = MB_ICONEXCLAMATION
+      # A stop-sign icon appears in the message box.
+      MB_ICONERROR                 = MB_ICONHAND
+      # An icon consisting of a lowercase letter i in a circle appears in the message box.
+      MB_ICONINFORMATION           = MB_ICONASTERISK
+      # A stop-sign icon appears in the message box.
+      MB_ICONSTOP                  = MB_ICONHAND
+
+      # To indicate the default button, specify one of the following values:
+
+      # The first button is the default button.
+      # MB_DEFBUTTON1 is the default unless MB_DEFBUTTON2, MB_DEFBUTTON3, or MB_DEFBUTTON4 is specified.
+      MB_DEFBUTTON1                = 0x00000000
+      # The second button is the default button.
+      MB_DEFBUTTON2                = 0x00000100
+      # The 3rd button is the default button.
+      MB_DEFBUTTON3                = 0x00000200
+      # The 4th button is the default button.
+      MB_DEFBUTTON4                = 0x00000300
+
+      # To indicate the modality of the dialog box, specify one of the following values:
+
+      # The user must respond to the message box before continuing work in the window identified by the hWnd
+      # parameter. However, the user can move to the windows of other threads and work in those windows.
+      # Depending on the hierarchy of windows in the application, the user may be able to move to other
+      # windows within the thread. All child windows of the parent of the message box are automatically 
+      # disabled, but pop-up windows are not.
+      # MB_APPLMODAL is the default if neither MB_SYSTEMMODAL nor MB_TASKMODAL is specified.
+      MB_APPLMODAL                 = 0x00000000
+      # Same as MB_APPLMODAL except that the message box has the WS_EX_TOPMOST style. Use system-modal message
+      # boxes to notify the user of serious, potentially damaging errors that require immediate attention (for
+      # example, running out of memory). This flag has no effect on the user's ability to interact with
+      # windows other than those associated with hWnd.
+      MB_SYSTEMMODAL               = 0x00001000
+      # Same as MB_APPLMODAL except that all the top-level windows belonging to the current thread are
+      # disabled if the hWnd parameter is NULL. Use this flag when the calling application or library does not
+      # have a window handle available but still needs to prevent input to other windows in the calling thread
+      # without suspending other threads.
+      MB_TASKMODAL                 = 0x00002000
+
+      # To specify other options, use one or more of the following values.
+
+      # Adds a Help button to the message box. When the user clicks the Help button or presses F1,
+      # the system sends a WM_HELP message to the owner.
+      MB_HELP                      = 0x00004000
+      MB_NOFOCUS                   = 0x00008000
+      # The message box becomes the foreground window. Internally, the system calls the SetForegroundWindow
+      # function for the message box.
+      MB_SETFOREGROUND             = 0x00010000
+      # Windows NT/2000/XP: Same as desktop of the interactive window station. For more information, see
+      # Window Stations.
+      # Windows NT 4.0 and earlier: If the current input desktop is not the default desktop, MessageBox fails.
+      # Windows 2000/XP: If the current input desktop is not the default desktop, MessageBox does not return
+      # until the user switches to the default desktop.
+      # Windows 95/98/Me: This flag has no effect.
+      MB_DEFAULT_DESKTOP_ONLY      = 0x00020000
+      # The message box is created with the WS_EX_TOPMOST window style.
+      MB_TOPMOST                   = 0x00040000
+      # The text is right-justified.
+      MB_RIGHT                     = 0x00080000
+      # Displays message and caption text using right-to-left reading order on Hebrew and Arabic systems.
+      MB_RTLREADING                = 0x00100000
+      # Assume Win2k or later
+      # Windows NT/2000/XP: The caller is a service notifying the user of an event. The function displays a
+      # message box on the current active desktop, even if there is no user logged on to the computer.
+      # Terminal Services: If the calling thread has an impersonation token, the function directs the message
+      # box to the session specified in the impersonation token.
+      # If this flag is set, the hWnd parameter must be NULL. This is so that the message box can appear on a
+      # desktop other than the desktop corresponding to the hWnd.
+      # For more information on the changes between Microsoft Windows NT 3.51 and Windows NT 4.0, see Remarks.
+      # For information on security considerations in regard to using this flag, see Interactive Services.
+      MB_SERVICE_NOTIFICATION      = 0x00200000
+      # Windows NT/2000/XP: This value corresponds to the value defined for MB_SERVICE_NOTIFICATION for
+      # Windows NT version 3.51.
+      MB_SERVICE_NOTIFICATION_NT3X = 0x00040000
+      MB_TYPEMASK                  = 0x0000000F
+      MB_ICONMASK                  = 0x000000F0
+      MB_DEFMASK                   = 0x00000F00
+      MB_MODEMASK                  = 0x00003000
+      MB_MISCMASK                  = 0x0000C000
+
+      # IDs of standard dialog controls and items:
+
+      # These are returned as user input from modal dialog:
+      IDOK        = 0x01  # The OK button was selected.
+      IDCANCEL    = 0x02  # The Cancel button was selected.
+      IDABORT     = 0x03  # The Abort button was selected.
+      IDRETRY     = 0x04  # The Retry button was selected.
+      IDIGNORE    = 0x05  # The Ignore button was selected.
+      IDYES       = 0x06  # The YES button was selected.
+      IDNO        = 0x07  # The NO button was selected.
+      IDTRYAGAIN  = 0x10  # The Try Again button was selected.
+      IDCONTINUE  = 0x11  # The Continue button was selected.
+
+      # These are not returned, their presence helps to programmatically identify type of present dialog:
+      ErrorIcon = 0x14  # ID of Error Icon (this dialog informs about some Error)
+
+      ##
+      # DialogProc is an application-defined callback function used with the CreateDialog and DialogBox
+      # families of functions. It processes messages sent to a modal or modeless dialog box. The DLGPROC
+      # type defines a pointer to this callback function. DialogProc is a placeholder for the
+      # application-defined function name.
+      #
+      # [*Syntax*] INT_PTR CALLBACK DialogProc( HWND hwndDlg, UINT uMsg, WPARAM wParam, LPARAM lParam );
+      #
+      # hwndDlg:: [in] Handle to the dialog box.
+      # uMsg:: [in] Specifies the message.
+      # wParam:: [in] Specifies additional message-specific information.
+      # lParam:: [in] Specifies additional message-specific information.
+      #
+      # *Returns*:: Typically, the dialog box procedure should return TRUE if it processed the message, and
+      #             FALSE if it did not. If the dialog box procedure returns FALSE, the dialog manager
+      #             performs the default dialog operation in response to the message.
+      # If the dialog box procedure processes a message that requires a specific return value, the dialog box
+      # procedure should set the desired return value by calling SetWindowLong(hwndDlg, DWL_MSGRESULT,
+      # lResult) immediately before returning TRUE. Note that you must call SetWindowLong immediately before
+      # returning TRUE; doing so earlier may result in the DWL_MSGRESULT value being overwritten by a nested
+      # dialog box message.
+      # The following messages are exceptions to the general rules stated above. Consult the documentation for
+      # the specific message for details on the semantics of the return value.
+      # WM_CHARTOITEM
+      # WM_COMPAREITEM
+      # WM_CTLCOLORBTN
+      # WM_CTLCOLORDLG
+      # WM_CTLCOLOREDIT
+      # WM_CTLCOLORLISTBOX
+      # WM_CTLCOLORSCROLLBAR
+      # WM_CTLCOLORSTATIC
+      # WM_INITDIALOG
+      # WM_QUERYDRAGICON
+      # WM_VKEYTOITEM
+      # ---
+      # *Remarks*:
+      # You should use the dialog box procedure only if you use the dialog box class for the dialog box. This
+      # is the default class and is used when no explicit class is specified in the dialog box template.
+      # Although the dialog box procedure is similar to a window procedure, it must not call the DefWindowProc
+      # function to process unwanted messages. Unwanted messages are processed internally by the dialog box
+      # window procedure.
+      # ---
+      # *See* *Also*:
+      # Dialog Boxes Overview, CreateDialog, CreateDialogIndirect, CreateDialogIndirectParam,
+      # CreateDialogParam, DefWindowProc, DialogBox, DialogBoxIndirect, DialogBoxIndirectParam,
+      # DialogBoxParam, SetFocus, WM_INITDIALOG
+      #
+      callback :DialogProc, [:HWND, :UINT, :WPARAM, :LPARAM], :int
+
       ##
       # The GetDlgItem function retrieves a handle to a control in the specified dialog box.
       #
@@ -36,12 +209,151 @@ module Win
       # As long as the hDlg parameter specifies a parent window and the child window has a unique identifier
       # (as specified by the hMenu parameter in the CreateWindow or CreateWindowEx function that created the 
       # child window), GetDlgItem returns a valid handle to the child window.
+      # ---
+      # <b>Enhanced (snake_case) API: returns nil if function fails</b>
+      #
+      # :call-seq:
+      #   control_handle = [get_]dlg_item( dialog_handle, control_id )
+      #
+      function :GetDlgItem, [:ulong, :int], :ulong, zeronil: true
+
+      ##
+      # MessageBox Function
+      # --------------------------------------------------------------------------------
+      # The MessageBox function creates, displays, and operates a message box. The message box contains an
+      # application-defined message and title, along with any combination of predefined icons and push
+      # buttons.
+      #
+      # [*Syntax*] int MessageBox( HWND hWnd, LPCTSTR lpText, LPCTSTR lpCaption, UINT uType );
+      #
+      # hWnd:: [in] Handle to the owner window of the message box to be created. If this parameter is NULL,
+      #        the message box has no owner window.
+      # lpText:: [in] Pointer to a null-terminated string that contains the message to be displayed.
+      # lpCaption:: [in] Pointer to a null-terminated string that contains the dialog box title. If this
+      #             parameter is NULL, the default title Error is used.
+      # uType:: [in] Specifies the contents and behavior of the dialog box. This parameter can be a
+      #         combination of flags from the following groups of flags.
+      #         To indicate the buttons displayed in the message box, specify one of the following values.
+      #         MB_ABORTRETRYIGNORE, MB_CANCELTRYCONTINUE, MB_HELP, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL
+      #         MB_YESNO, MB_YESNOCANCEL
+      #         To display an icon in the message box, specify one of the following values.
+      #         MB_ICONEXCLAMATION, MB_ICONWARNING, MB_ICONINFORMATION, MB_ICONASTERISK, MB_ICONQUESTION
+      #         MB_ICONSTOP, MB_ICONERROR, MB_ICONHAND
+      #         To indicate the default button, specify one of the following values.
+      #         MB_DEFBUTTON1, MB_DEFBUTTON2, MB_DEFBUTTON3, MB_DEFBUTTON4
+      #         To indicate the modality of the dialog box, specify one of the following values.
+      #         MB_APPLMODAL, MB_SYSTEMMODAL, MB_TASKMODAL
+      #         To specify other options, use one or more of the following values.
+      #         MB_DEFAULT_DESKTOP_ONLY, MB_RIGHT, MB_RTLREADING, MB_SETFOREGROUND, MB_TOPMOST
+      #         MB_SERVICE_NOTIFICATION, MB_SERVICE_NOTIFICATION_NT3X
+      #         For more information on the changes between Windows NT 3.51 and Windows NT 4.0, see Remarks.
+      #
+      # *Returns*:: If a message box has a Cancel button, the function returns the IDCANCEL value if either
+      #             the ESC key is pressed or the Cancel button is selected. If the message box has no Cancel
+      #             button, pressing ESC has no effect.
+      # If the function fails, the return value is zero. To get extended error information, call GetLastError.
+      # If the function succeeds, the return value is one of the following menu-item values.
+      # IDABORT:: Abort button was selected.
+      # IDCANCEL:: Cancel button was selected.
+      # IDCONTINUE:: Continue button was selected.
+      # IDIGNORE:: Ignore button was selected.
+      # IDNO:: No button was selected.
+      # IDOK:: OK button was selected.
+      # IDRETRY:: Retry button was selected.
+      # IDTRYAGAIN:: Try Again button was selected.
+      # IDYES:: Yes button was selected.
+      # ---
+      # *Remarks*:
+      # Adding two right-to-left marks (RLMs), represented by Unicode formatting character U+200F, in the
+      # beginning of a MessageBox display string is interpreted by the Win32 MessageBox rendering engine so as
+      # to cause the reading order of the MessageBox to be rendered as right-to-left (RTL).
+      # When you use a system-modal message box to indicate that the system is low on memory, the strings
+      # pointed to by the lpText and lpCaption parameters should not be taken from a resource file because an
+      # attempt to load the resource may fail.
+      # If you create a message box while a dialog box is present, use a handle to the dialog box as the hWnd
+      # parameter. The hWnd parameter should not identify a child window, such as a control in a dialog box.
+      # Windows 95/98/Me: The system can support a maximum of 16,364 window handles.
+      # Windows NT/2000/XP: The value of MB_SERVICE_NOTIFICATION changed starting with Windows NT 4.0. Windows
+      # NT 4.0 provides backward compatibility for preexisting services by mapping the old value to the new
+      # value in the implementation of MessageBox. This mapping is done only for executables that have a
+      # version number earlier than 4.0, as set by the linker.
+      # To build a service that uses MB_SERVICE_NOTIFICATION and can run on both Microsoft Windows NT 3.x and
+      # Windows NT 4.0, you can do one of the following.
+      # At link-time, specify a version number less than 4.0.
+      # At link-time, specify version 4.0. At run-time, use the GetVersionEx function to check the system
+      # version. Then, when running on Windows NT 3.x, use MB_SERVICE_NOTIFICATION_NT3X; and on Windows NT
+      # 4.0, use MB_SERVICE_NOTIFICATION.
+      # Windows 95/98/Me: Even though MessageBoxW exists, it is supported by the Microsoft Layer for Unicode
+      # on Windows 95/98/Me Systems to give more consistent behavior across all Windows operating systems.
+      # ---
+      # *See* *Also*:
+      # Dialog Boxes Overview, FlashWindow, MessageBeep, MessageBoxEx, MessageBoxIndirect, SetForegroundWindow
+      # ---
+      # <b>Enhanced (snake_case) API: accepts text and caption, uType is optional. Returns nil if function fails</b>
       #
       # :call-seq:
-      #   control_handle = [get_]dlg_item( dialog_handle, id )
+      #  selected_item = message_box(owner_handle, text, caption, type)
       #
-      function :GetDlgItem, [:ulong, :int], :ulong
+      function :MessageBox, [:HWND, :LPCTSTR, :LPCTSTR, :UINT], :int, zeronil: true,
+               &->(api, handle, text, caption, type=MB_OK) {
+                  text_pointer = FFI::MemoryPointer.from_string(text)
+                  caption_pointer = FFI::MemoryPointer.from_string(caption)
+                  api.call handle, text_pointer, caption_pointer, type }
+
+      # Untested:
+
+      ##
+      function :CreateDialogIndirectParam, ['L', 'P', 'L', :DialogProc, 'L'], 'L'
+      ##
+      function :CreateDialogParam, ['L', 'P', 'L', :DialogProc, 'L'], 'L'
+      ##
+      function :DialogBoxIndirectParam, ['L', 'P', 'L', :DialogProc, 'L'], 'P'
+      ##
+      function :DialogBoxParam, ['L', 'P', 'L', :DialogProc, 'L'], 'P'
+      ##
+      function :EndDialog, 'LP', 'B'
+      ##
+      function :GetDialogBaseUnits, 'V', 'L'
+      ##
+      function :GetDlgCtrlID, 'L', 'I'
+      ##
+      function :GetDlgItemText, 'LIPI', 'I'
+      ##
+      function :GetNextDlgGroupItem, 'LLI', 'L'
+      ##
+      function :GetNextDlgTabItem, 'LLI', 'L'
+      ##
+      function :IsDialogMessage, 'LP', 'B'
+      ##
+      function :MapDialogRect, 'LP', 'B'
+      ##
+      function :MessageBoxEx, 'LPPII', 'I'
+      ##
+      function :MessageBoxIndirect, 'P', 'I'
+      ##
+      function :SendDlgItemMessage, 'LIILL', 'L'
+      ##
+      function :SetDlgItemInt, 'LIII', 'L'
+      ##
+      function :SetDlgItemText, 'LIP', 'B'
+
+      # Macros from WinUser.h
+
+      def CreateDialog(hInstance, lpName, hParent, lpDialogFunc)
+         CreateDialogParam(hInstance, lpName, hParent, lpDialogFunc, 0)
+      end
+
+      def CreateDialogIndirect(hInst, lpTemp, hPar, lpDialFunc)
+         CreateDialogIndirectParam(hInst, lpTemp, hPar, lpDialFunc, 0)
+      end
+
+      def DialogBox(hInstance, lpTemp, hParent, lpDialogFunc)
+         DialogBoxParam(hInstance, lpTemp, hParent, lpDialogFunc, 0)
+      end
 
+      def DialogBoxIndirect(hInst, lpTemp, hParent, lpDialogFunc)
+         DialogBoxParamIndirect(hInst, lpTemp, hParent, lpDialogFunc, 0)
+      end
     end
   end
 end

data/lib/win/gui/input.rb

@@ -73,6 +73,15 @@ module Win
       #  HELP key
       VK_HELP     = 0x2F
 
+      # US semicolon
+      VK_OEM_1 = 0xBA
+      # US backslash
+      VK_OEM_102 = 0xE2
+      # US period (point)
+      VK_OEM_PERIOD = 0xBE
+      # US comma
+      VK_OEM_COMMA = 0xBC
+
 #  Public Type MOUSEINPUT
 #  dx As Long
 #  dy As Long

data/lib/win/gui/message.rb

@@ -748,57 +748,42 @@ module Win
       #
       function :DispatchMessage, [:pointer], :long
 
+      # Untested:
+
       ##
       function :BroadcastSystemMessage, 'LPIIL', 'L'
-
       ##
-      try_function :BroadcastSystemMessageEx, 'LPILLP', 'L'   # Windows XP or later
-
+      try_function :BroadcastSystemMessageEx, 'LPILLP', 'L'   # Windows XP or later only
       ##
       function :DefWindowProc, 'LLLL', 'L'
-
       ##
       function :GetInputState, 'V', 'B'
-
       ##
       function :GetMessageExtraInfo, 'V', 'L'
-
       ##
       function :GetMessagePos, 'V', 'L'
-
       ##
       function :GetMessageTime, 'V', 'L'
-
       ##
       function :GetQueueStatus, 'I', 'L'
-
       ##
       function :InSendMessage, 'V', 'B'
-
       ##
       function :InSendMessageEx, 'L', 'L'
-
       ##
       function :PostQuitMessage, 'I', 'V'
-
       ##
       function :PostThreadMessage, 'LILL', 'B'
-
       ##
       function :RegisterWindowMessage, 'P', 'I'
-
       ##
       function :ReplyMessage, 'L', 'B'
-
       ##
       function :SendMessageTimeout, 'LILLIIP', 'L'
-
       ##
       function :SendNotifyMessage, 'LILLIIP', 'L'
-
       ##
       function :SetMessageExtraInfo, 'L', 'L'
-
       ##
       function :WaitMessage, 'V', 'B'
     end

data/lib/win/gui/window.rb

@@ -634,6 +634,62 @@ module Win
       #
       function :GetForegroundWindow, [], :HWND, zeronil: true
 
+      ##
+      # SetForegroundWindow function puts the thread that created the specified window into the foreground
+      # and activates the window. Keyboard input is directed to the window, and various visual cues are 
+      # changed for the user. The system assigns a slightly higher priority to the thread that created the
+      # foreground window than it does to other threads.
+      #
+      # [*Syntax*] BOOL SetForegroundWindow( HWND hWnd );
+      #
+      # hWnd:: [in] Handle to the window that should be activated and brought to the foreground.
+      #
+      # *Returns*:: If the window was brought to the foreground, the return value is nonzero.
+      # If the window was not brought to the foreground, the return value is zero.
+      # ---
+      # *Remarks*:
+      # Windows 98/Me: The system restricts which processes can set the foreground window. A process can set
+      # the foreground window only if one of the following conditions is true:
+      # - The process is the foreground process.
+      # - The process was started by the foreground process.
+      # - The process received the last input event.
+      # - There is no foreground process.
+      # - The foreground process is being debugged.
+      # - The foreground is not locked (see LockSetForegroundWindow).
+      # - The foreground lock time-out has expired (see SPI_GETFOREGROUNDLOCKTIMEOUT in SystemParametersInfo).
+      # - Windows 2000/XP: No menus are active.
+      #
+      # With this change, an application cannot force a window to the foreground while the user is working
+      # with another window. Instead, Foreground and Background Windows will activate the window (see
+      # SetActiveWindow) and call the function to notify the user. However, on Microsoft Windows 98 and
+      # Windows Millennium Edition (Windows Me), if a nonforeground thread calls SetForegroundWindow and
+      # passes the handle of a window that was not created by the calling thread, the window is not flashed on
+      # the taskbar. To have SetForegroundWindow behave the same as it did on Windows 95 and Microsoft Windows
+      # NT 4.0, change the foreground lock timeout value when the application is installed. This can be done
+      # from the setup or installation application with the following function call:
+      # SystemParametersInfo(SPI_SETFOREGROUNDLOCKTIMEOUT, 0, (LPVOID)0, SPIF_SENDWININICHANGE |
+      # SPIF_UPDATEINIFILE);
+      # This method allows SetForegroundWindow on Windows 98/Windows Me and Windows 2000/Windows XP to behave
+      # the same as Windows 95 and Windows NT 4.0, respectively, for all applications. The setup application
+      # should warn the user that this is being done so that the user isn't surprised by the changed behavior.
+      # On Windows Windows 2000 and Windows XP, the call fails unless the calling thread can change the
+      # foreground window, so this must be called from a setup or patch application. For more information, see
+      # Foreground and Background Windows.
+      # A process that can set the foreground window can enable another process to set the foreground window
+      # by calling the AllowSetForegroundWindow function. The process specified by dwProcessId loses the
+      # ability to set the foreground window the next time the user generates input, unless the input is
+      # directed at that process, or the next time a process calls AllowSetForegroundWindow, unless that
+      # process is specified.
+      # The foreground process can disable calls to SetForegroundWindow by calling the LockSetForegroundWindow function.
+      #
+      # ---
+      # <b>Enhanced (snake_case) API: returns true/false</b>
+      #
+      # :call-seq:
+      #  success = set_foreground_window(h_wnd)
+      #
+      function :SetForegroundWindow, [:HWND], :int8, boolean: true
+
       ##
       # The GetActiveWindow function retrieves the window handle to the active window attached to
       # the calling thread's message queue.

data/lib/win/library.rb

@@ -1,5 +1,5 @@
 require 'ffi'
-require 'win/extensions'
+require 'extension'
 
 # Related Windows API functions are grouped by topic and defined in separate namespaces (modules),
 # that also contain related constants and convenience methods. For example, Win::Dde module

data/spec/extension_spec.rb

@@ -0,0 +1,73 @@
+require File.join(File.dirname(__FILE__), "spec_helper" )
+require 'extension'
+
+module WinTest
+
+  describe String do
+    describe '#snake_case' do
+      it 'transforms CamelCase strings' do
+        'GetCharWidth32'.snake_case.should == 'get_char_width_32'
+      end
+      
+      it 'leaves snake_case strings intact' do
+        'keybd_event'.snake_case.should == 'keybd_event'
+      end
+    end
+
+    describe '#camel_case' do
+      it 'transforms snake_case strings' do
+        'get_char_width_32'.camel_case.should == 'GetCharWidth32'
+      end
+
+      it 'leaves CamelCase strings intact' do
+        'GetCharWidth32'.camel_case.should == 'GetCharWidth32'
+      end
+    end
+
+    describe '#to_w' do
+      it 'transcodes string to utf-16LE' do
+        'GetCharWidth32'.to_w.encoding.name.should == 'UTF-16LE'
+      end
+
+      it 'ensures that encoded string is null-terminated' do
+        'GetCharWidth32'.to_w.bytes.to_a[-2..-1].should == [0, 0]
+      end
+    end
+
+#    context '#to_vkeys' do
+#      it 'transforms number char into [equivalent key code]' do
+#       ('0'..'9').each {|char| char.to_vkeys.should == char.unpack('C')}
+#      end
+#
+#      it 'transforms uppercase letters into [shift, equivalent key code]' do
+#       ('A'..'Z').each {|char| char.to_vkeys.should == [0x10, *char.unpack('C')]}
+#        # Win.const_get(:VK_SHIFT) = 0x10 Bad coupling
+#      end
+#
+#      it 'transforms lowercase letters into [(upcase) key code]' do
+#       ('a'..'z').each {|char| char.to_vkeys.should == char.upcase.unpack('C')}
+#      end
+#
+#      it 'transforms space into [equivalent key code]' do
+#        " ".to_vkeys.should == " ".unpack('C')
+#      end
+#
+#      it 'raises error if char is not implemented punctuation' do
+#       ('!'..'/').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
+#       (':'..'@').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
+#       ('['..'`').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
+#       ('{'..'~').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
+#      end
+#
+#      it 'raises error if char is non-printable or non-ascii' do
+#        lambda {1.chr.to_vkeys}.should raise_error CONVERSION_ERROR
+#        lambda {230.chr.to_vkeys}.should raise_error CONVERSION_ERROR
+#      end
+#
+#      it 'raises error if string is multi-char' do
+#        lambda {'hello'.to_vkeys}.should raise_error CONVERSION_ERROR
+#        lambda {'23'.to_vkeys}.should raise_error CONVERSION_ERROR
+#      end
+#    end
+  end
+end

data/spec/spec_helper.rb

@@ -120,10 +120,11 @@ module WinTestApp
     @launched_test_app = app
   end
 
-  def close_test_app(app = @launched_test_app)
-    while app && app.respond_to?( :handle) && find_window(nil, WIN_TITLE)
-      shut_window app.handle
+  def close_test_app
+    while @launched_test_app && find_window(nil, WIN_TITLE)
+      shut_window @launched_test_app.handle
       sleep SLEEP_DELAY
+      keystroke('N') if find_window(nil, "Steganos Locknote") # Dealing with closing modal dialog
     end
     @launched_test_app = nil
   end
@@ -131,12 +132,21 @@ module WinTestApp
   # Creates test app object and yields it back to the block
   def test_app
     app = launch_test_app
-
-#    def app.textarea #define singleton method retrieving app's text area
-#      Window::Window.new find_window_ex(self.handle, 0, TEXTAREA_CLASS, nil)
-#    end
-
     yield app
-    close_test_app app
+    close_test_app
+  end
+
+  # Emulates combinations of (any amount of) keys pressed one after another (Ctrl+Alt+P) and then released
+  # *keys should be a sequence of a virtual-key codes. These codes must be a value in the range 1 to 254.
+  # For a complete list, see msdn:Virtual Key Codes.
+  # If alphanumerical char is given instead of virtual key code, only lowercase letters result (no VK_SHIFT!).
+  def keystroke(*keys)
+    return if keys.empty?
+    key = String === keys.first ? keys.first.upcase.ord : keys.first.to_i
+    keybd_event key, 0, KEYEVENTF_KEYDOWN, 0
+    sleep KEY_DELAY
+    keystroke *keys[1..-1]
+    sleep KEY_DELAY
+    keybd_event key, 0, KEYEVENTF_KEYUP, 0
   end
 end

data/spec/win/gui/dialog_spec.rb

@@ -1,18 +1,62 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 require 'win/gui/input'
-#require 'win/gui/window'
 
-module WinWindowTest
+module WinGuiDialogTest
 
   include WinTestApp
   include Win::Gui::Dialog
 
+  def test_app_with_dialog(type=:close)
+    test_app do |app|
+      case type
+        when :close
+          keystroke('A')
+          shut_window app.handle
+          sleep 0.01 until dialog = find_window(nil, "Steganos Locknote")
+        when :save
+          keystroke(VK_ALT, 'F', 'A')
+          sleep 0.01 until dialog = find_window(nil, "Save As")
+      end
+      yield app, dialog
+      keystroke(VK_ESCAPE)
+    end
+  end
+
   describe Win::Gui::Dialog do
 
+    describe "#message_box" do
+      spec{ pending; use{ selected_item = message_box(owner_handle=0, text="Text", caption="Caption", type=0) }}
+
+      it "creates, displays, and operates a message box" do
+        pending 'Not possible to test message_box directly, it blocks all related threads :('
+          t = Thread.new do
+            selected_item = message_box(handle=0, text="Text", caption="Caption", type=MB_YESNO | MB_HELP)
+            puts selected_item
+          end
+          t.join
+      end
+    end # describe message_box
+
+
     describe '#get_dlg_item' do
       spec{ use{ control_handle = get_dlg_item(handle = 0, item_id = 1) }}
 
-      it 'returns handle to correctly specified control'
+      it 'returns handle to an existing controls in a dialog' do
+        test_app_with_dialog(:close) do |app, dialog|
+          get_dlg_item(dialog, item_id=IDYES).should_not == nil
+          get_dlg_item(dialog, item_id=IDNO).should_not == nil
+          get_dlg_item(dialog, item_id=IDCANCEL).should_not == nil
+        end
+      end
+
+      it 'returns nil/0 for non-existing controls in a dialog' do
+        test_app_with_dialog(:close) do |app, dialog|
+          get_dlg_item(dialog, item_id=IDOK).should == nil
+          get_dlg_item(dialog, item_id=IDABORT).should == nil
+          GetDlgItem(dialog, item_id=IDRETRY).should == 0
+          GetDlgItem(dialog, item_id=IDCONTINUE).should == 0
+        end
+      end
 
     end
   end

data/spec/win/gui/input_spec.rb

@@ -1,8 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 require 'win/gui/input'
-#require 'win/gui/window'
 
-module WinWindowTest
+module WinGuiInputTest
 
   include WinTestApp
   include Win::Gui::Input

data/spec/win/gui/window_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 require 'win/gui/window'
 
-module WinWindowTest
+module WinGuiWindowTest
 
   include WinTestApp
   include Win::Gui::Window
@@ -192,6 +192,25 @@ module WinWindowTest
         end
       end
 
+      describe "#set_foreground_window" do
+        spec{ use{ success = SetForegroundWindow(handle=0) }}
+        spec{ use{ success = set_foreground_window(handle=0) }}
+
+        it "puts the thread that created the specified window into the foreground and activates the window" do
+          test_app do |app|
+            set_foreground_window(any_handle).should be_true
+            foreground?(app.handle).should be_false
+            success = set_foreground_window(app.handle)
+            foreground?(app.handle).should be_true
+          end
+        end
+
+        it "returns false/0 if operation failed" do
+            set_foreground_window(not_a_handle).should == false
+            SetForegroundWindow(not_a_handle).should == 0
+        end
+      end # describe set_foreground_window
+
       describe '#get_foreground_window' do
         # ! Different from GetActiveWindow !
         spec{ use{ handle = GetForegroundWindow() }}
@@ -201,10 +220,10 @@ module WinWindowTest
         it 'returns handle to window that is currently in foreground' do
           test_app do |app|
             @app_handle = app.handle
-            fg1 = foreground_window
+            fg1 = get_foreground_window
             @app_handle.should == fg1
           end
-          fg2 = foreground_window
+          fg2 = get_foreground_window
           @app_handle.should_not == fg2
         end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 6
-  version: 0.3.6
+  - 7
+  version: 0.3.7
 platform: ruby
 authors: 
 - arvicco
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-31 00:00:00 +04:00
+date: 2010-06-02 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,22 +68,22 @@ extra_rdoc_files:
 - HISTORY
 - README.rdoc
 files: 
+- lib/extension.rb
 - lib/version.rb
 - lib/win/dde.rb
 - lib/win/error.rb
-- lib/win/extensions.rb
 - lib/win/gui/dialog.rb
 - lib/win/gui/input.rb
 - lib/win/gui/message.rb
 - lib/win/gui/window.rb
 - lib/win/gui.rb
 - lib/win/library.rb
+- spec/extension_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/test_apps/locknote/LockNote.exe
 - spec/win/dde_spec.rb
 - spec/win/error_spec.rb
-- spec/win/extensions_spec.rb
 - spec/win/gui/dialog_spec.rb
 - spec/win/gui/input_spec.rb
 - spec/win/gui/message_spec.rb
@@ -140,12 +140,12 @@ signing_key:
 specification_version: 3
 summary: Rubyesque interfaces and wrappers for Windows API functions pre-defined using FFI
 test_files: 
+- spec/extension_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/test_apps/locknote/LockNote.exe
 - spec/win/dde_spec.rb
 - spec/win/error_spec.rb
-- spec/win/extensions_spec.rb
 - spec/win/gui/dialog_spec.rb
 - spec/win/gui/input_spec.rb
 - spec/win/gui/message_spec.rb

data/lib/win/extensions.rb

@@ -1,41 +0,0 @@
-class String
-  # returns snake_case representation of string
-  def snake_case
-    gsub(/([a-z])([A-Z0-9])/, '\1_\2' ).downcase
-  end
-
-  # returns camel_case representation of string
-  def camel_case
-    if self.include? '_'
-      self.split('_').map{|e| e.capitalize}.join
-    else
-      unless self =~ (/^[A-Z]/)
-        self.capitalize
-      else
-        self
-      end
-    end
-  end
-
-  # converts string to 'wide char' (Windows Unicode) format
-  def to_w
-    (self+"\x00").encode('utf-16LE')
-  end
-  
-  # converts one-char string into keyboard-scan 'Virtual key' code
-  # only letters and numbers convertable so far, need to be extended
-  def to_vkeys
-    unless size == 1
-      raise "Can't convert but a single character: #{self}"
-    end
-    ascii = upcase.unpack('C')[0]
-    case self
-      when 'a'..'z', '0'..'9', ' '
-      [ascii]
-      when 'A'..'Z'
-      [0x10, ascii]    # Win.const_get(:VK_SHIFT) = 0x10 Bad coupling
-    else
-      raise "Can't convert unknown character: #{self}"
-    end
-  end
-end

data/spec/win/extensions_spec.rb

@@ -1,73 +0,0 @@
-require File.join(File.dirname(__FILE__), ".." , "spec_helper" )
-require 'win/extensions'
-
-module WinTest
-
-  describe String do
-    context '#snake_case' do
-      it 'transforms CamelCase strings' do
-        'GetCharWidth32'.snake_case.should == 'get_char_width_32'
-      end
-      
-      it 'leaves snake_case strings intact' do
-        'keybd_event'.snake_case.should == 'keybd_event'
-      end
-    end
-
-    context '#camel_case' do
-      it 'transforms snake_case strings' do
-        'get_char_width_32'.camel_case.should == 'GetCharWidth32'
-      end
-
-      it 'leaves CamelCase strings intact' do
-        'GetCharWidth32'.camel_case.should == 'GetCharWidth32'
-      end
-    end
-
-    context '#to_w' do
-      it 'transcodes string to utf-16LE' do
-        'GetCharWidth32'.to_w.encoding.name.should == 'UTF-16LE'
-      end
-
-      it 'ensures that encoded string is null-terminated' do
-        'GetCharWidth32'.to_w.bytes.to_a[-2..-1].should == [0, 0]
-      end
-    end
-
-    context '#to_vkeys' do
-      it 'transforms number char into [equivalent key code]' do
-       ('0'..'9').each {|char| char.to_vkeys.should == char.unpack('C')}
-      end
-      
-      it 'transforms uppercase letters into [shift, equivalent key code]' do
-       ('A'..'Z').each {|char| char.to_vkeys.should == [0x10, *char.unpack('C')]}
-        # Win.const_get(:VK_SHIFT) = 0x10 Bad coupling
-      end
-      
-      it 'transforms lowercase letters into [(upcase) key code]' do
-       ('a'..'z').each {|char| char.to_vkeys.should == char.upcase.unpack('C')}
-      end
-      
-      it 'transforms space into [equivalent key code]' do 
-        " ".to_vkeys.should == " ".unpack('C')
-      end
-      
-      it 'raises error if char is not implemented punctuation' do
-       ('!'..'/').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
-       (':'..'@').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
-       ('['..'`').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
-       ('{'..'~').each {|char| lambda {char.to_vkeys}.should raise_error CONVERSION_ERROR }
-      end
-      
-      it 'raises error if char is non-printable or non-ascii' do
-        lambda {1.chr.to_vkeys}.should raise_error CONVERSION_ERROR
-        lambda {230.chr.to_vkeys}.should raise_error CONVERSION_ERROR
-      end
-      
-      it 'raises error if string is multi-char' do
-        lambda {'hello'.to_vkeys}.should raise_error CONVERSION_ERROR
-        lambda {'23'.to_vkeys}.should raise_error CONVERSION_ERROR
-      end  
-    end
-  end
-end