win32-clipboard 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1e9d66dee40bab2644c326883aa740d9cda4c7a
-  data.tar.gz: a35a610cd2d18dd40fdc04486b9492c41df6a065
+  metadata.gz: 359fdeba42a4dab1eb7e042e4bcf4a53f816238b
+  data.tar.gz: 03fef4f1ab539e544e6dcb1b8079d38d722cf636
 SHA512:
-  metadata.gz: 019a82dd2e1110b082fa59c815f551b53a1620db009112d5d506889c88527f78d8cd84692112627ebb1f725406cd258a60d22c07552377922e68a8502c845c19
-  data.tar.gz: 22c2fad73246cd26eedca03248e5a3f0afc2d28bea15350341807ee4c57102f5c9089ae175a1cf47e016886df1f3c473afa197200796d0164b6d6e3afdfd5fa3
+  metadata.gz: 55d0dbe9871da1c7af56d9d0a5f2ce9f5daa1154983e47cb9d1f15c0059e68339b281733e9ea33ca3335fbb86a8e985bde343f56d2c4555fe9a45f5eace40bb1
+  data.tar.gz: 3ac574c4d51126ecf250d2e6ce867c1d9447a0e56940be4610d357d361ce03b320e9f3f25e2d311720dc28d11926f97eba4916400befd0ef50410acc558c91ff

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.6.3 - 7-Feb-2014
+* Fixed a potential duplication notification issue in the notify_change method.
+  Thanks go to u338steven for the spot and patch.
+* Fixed a clipboard chaining issue in the notify_change method when there are
+  multiple clipboard instances. Thanks again go to u338steven.
+
 == 0.6.2 - 27-Jan-2014
 * Fix and more tests for the internal get_image_data. Thanks go to u338steven
   for the spot and patches.

data/README

@@ -104,7 +104,7 @@ Clipboard::UNICODETEXT
    Ruby's
     
 == Copyright
-   (C) 2003-2008 Daniel J. Berger
+   (C) 2003-2014 Daniel J. Berger
    All Rights Reserved
     
 == Authors

data/Rakefile

@@ -51,6 +51,12 @@ namespace :test do
     t.verbose = true
     t.test_files = FileList['test/test_image_clipboard.rb']
   end
+
+  Rake::TestTask.new(:chain) do |t|
+    t.warning = true
+    t.verbose = true
+    t.test_files = FileList['test/test_clipboard_chain.rb']
+  end
 end
 
 task :default => 'test:all'

data/lib/win32/clipboard.rb

@@ -16,7 +16,7 @@ module Win32
     extend Windows::Structs
 
     # The version of this library
-    VERSION = '0.6.2'
+    VERSION = '0.6.3'
 
     # Clipboard formats
 
@@ -44,9 +44,7 @@ module Win32
     def self.empty
       begin
         open
-        unless EmptyClipboard()
-          raise SystemCallError.new('EmptyClipboard', FFI.errno)
-        end
+        clear_if_already_opened
       ensure
         close
       end
@@ -147,8 +145,8 @@ module Win32
     #
     def self.set_data(clip_data, format = TEXT)
       begin
-        clear
         open
+        clear_if_already_opened
 
         # NULL terminate text or strip header of bitmap file
         case format
@@ -268,10 +266,25 @@ module Win32
       name   = 'ruby-clipboard-' + Time.now.to_s
       handle = CreateWindowEx(0, 'static', name, 0, 0, 0, 0, 0, 0, 0, 0, nil)
 
+      next_viewer = SetClipboardViewer(handle)
+
+      if next_viewer.nil?
+        raise SystemCallError.new('SetClipboardViewer', FFI.errno)
+      end
+
+      SetWindowLongPtr(handle, GWL_USERDATA, next_viewer)
+
+      ObjectSpace.define_finalizer(self, proc{self.close_window(handle)})
+
       @first_notify = true
 
       wnd_proc = FFI::Function.new(:uintptr_t, [:uintptr_t, :uint, :uintptr_t, :uintptr_t]) do |hwnd, umsg, wparam, lparam|
         case umsg
+           when WM_DESTROY
+             next_viewer = GetWindowLongPtr(hwnd, GWL_USERDATA)
+             ChangeClipboardChain(hwnd, next_viewer)
+             PostQuitMessage(0)
+             rv = 0
            when WM_DRAWCLIPBOARD
              yield unless @first_notify
              next_viewer = GetWindowLongPtr(hwnd, GWL_USERDATA)
@@ -280,8 +293,9 @@ module Win32
              end
              rv = 0
            when WM_CHANGECBCHAIN
-             yield unless @first_notify
+             next_viewer = GetWindowLongPtr(hwnd, GWL_USERDATA)
              next_viewer = lparam if next_viewer == wparam
+             SetWindowLongPtr(hwnd, GWL_USERDATA, next_viewer)
              if next_viewer != 0
                PostMessage(next_viewer, umsg, wparam, lparam)
              end
@@ -299,14 +313,6 @@ module Win32
         raise SystemCallError.new('SetWindowLongPtr', FFI.errno)
       end
 
-      next_viewer = SetClipboardViewer(handle)
-
-      if next_viewer.nil?
-        raise SystemCallError.new('SetClipboardViewer', FFI.errno)
-      end
-
-      SetWindowLongPtr(handle, GWL_USERDATA, next_viewer)
-
       msg = FFI::MemoryPointer.new(:char, 100)
 
       while true
@@ -345,6 +351,14 @@ module Win32
       end
     end
 
+    # Clear the clipboard that is already opened
+    #
+    def self.clear_if_already_opened
+      unless EmptyClipboard()
+        raise SystemCallError.new('EmptyClipboard', FFI.errno)
+      end
+    end
+
     # Get data for enhanced metadata files
     #
     def self.get_metafile_data(handle)
@@ -421,6 +435,12 @@ module Win32
 
       array
     end
+
+    # Close a window.(for self.notify_change)
+    #
+    def self.close_window(handle)
+      SendMessage(handle, WM_CLOSE, 0, 0)
+    end
   end
 end
 

data/lib/win32/windows/constants.rb

@@ -1,6 +1,8 @@
 module Windows
   module Constants
     GHND = 0x0042
+    WM_DESTROY = 0x0002
+    WM_CLOSE = 0x0010
     WM_DRAWCLIPBOARD = 0x0308
     WM_CHANGECBCHAIN = 0x030D
     GWL_USERDATA = -21

data/lib/win32/windows/functions.rb

@@ -24,6 +24,7 @@ module Windows
 
     ffi_lib :user32
 
+    attach_function :ChangeClipboardChain, [:hwnd, :hwnd], :bool
     attach_function :CloseClipboard, [], :bool
     attach_function :CountClipboardFormats, [], :int
     attach_function :CreateWindowEx, :CreateWindowExA, [:dword, :string, :string, :dword, :int, :int, :int, :int, :hwnd, :hmenu, :hinstance, :pointer], :hwnd
@@ -37,9 +38,11 @@ module Windows
     attach_function :OpenClipboard, [:hwnd], :bool
     attach_function :PeekMessage, :PeekMessageA, [:pointer, :hwnd, :uint, :uint, :uint], :bool
     attach_function :PostMessage, :PostMessageA, [:hwnd, :uint, :uintptr_t, :uintptr_t], :bool
+    attach_function :PostQuitMessage, :PostQuitMessage, [:uint], :void
     attach_function :RegisterClipboardFormat, :RegisterClipboardFormatA, [:string], :uint
     attach_function :SetClipboardData, [:uint, :handle], :handle
     attach_function :SetClipboardViewer, [:hwnd], :hwnd
+    attach_function :SendMessage, :SendMessageA, [:hwnd, :uint, :uintptr_t, :uintptr_t], :bool
     attach_function :TranslateMessage, [:pointer], :bool
 
     # Use Long on 32-bit Ruby, LongPtr on 64-bit Ruby

data/test/lock.rb

@@ -0,0 +1,18 @@
+require 'timeout'
+require 'tmpdir'
+
+def lock(&block)
+  Timeout::timeout(5) do
+    open(File.join(Dir.tmpdir, 'ruby-win32-clipboard.lock'), 'w') do |f|
+      begin
+        f.flock(File::LOCK_EX)
+        yield
+      ensure
+        f.flock(File::LOCK_UN)
+      end
+    end
+  end
+rescue Timeout::Error
+  raise 'Lock(timeout)'
+end
+

data/test/notify.rb

@@ -0,0 +1,27 @@
+require 'win32/clipboard'
+require File.join(File.dirname(__FILE__), 'lock')
+
+include Win32
+
+timeout = ARGV[1].to_i
+
+def write
+  data = ''
+  lock do
+    data = Clipboard.data
+  end
+
+  begin
+    STDOUT.puts data
+    STDOUT.flush
+  rescue => e
+    puts $!
+  end
+  if data == ARGV[0]
+    exit
+  end
+end
+
+Timeout::timeout(timeout) do
+  Clipboard.notify_change {write}
+end

data/test/test_clipboard.rb

@@ -10,11 +10,12 @@
 ###########################################################################
 require 'test-unit'
 require 'win32/clipboard'
+require 'timeout'
 include Win32
 
 class TC_Win32_ClipBoard < Test::Unit::TestCase
   test "version is set to expected value" do
-    assert_equal('0.6.2', Clipboard::VERSION)
+    assert_equal('0.6.3', Clipboard::VERSION)
   end
 
   test "data method basic functionality" do
@@ -141,6 +142,26 @@ class TC_Win32_ClipBoard < Test::Unit::TestCase
 
   test "notify_change basic functionality" do
     assert_respond_to(Clipboard, :notify_change)
+    def wait(&block)
+      Timeout::timeout(5) do
+        while @count == 0
+          yield if block
+          sleep(0.1)
+        end
+      end
+    end
+
+    @count = 0
+    t = Thread.start do
+      Clipboard.notify_change {@count += 1}
+    end
+    wait {Clipboard.set_data('ready')}
+    @count = 0
+
+    Clipboard.set_data('foo')
+    wait
+    assert_equal(@count, 1)
+    t.kill
   end
 
   test "expected constants are defined" do

data/test/test_clipboard_chain.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+###########################################################################
+# test_clipboard_chain.rb
+#
+# Test suite for the win32-clipboard library(only clipboard chain).
+###########################################################################
+require 'test-unit'
+require 'win32/clipboard'
+require 'timeout'
+require File.join(File.dirname(__FILE__), 'lock')
+
+include Win32
+
+class TC_Clipboard_Chain < Test::Unit::TestCase
+  test "clipboard viewer chain" do
+    begin
+      # Add clipboard viewer 1-3
+      # clipboard viewer chain: cv3 -> cv2 -> cv1
+      cv1 = ClipboardViewer.new('1')
+      puts 'Added clipboard viewer 1'
+
+      cv2 = ClipboardViewer.new('2')
+      puts 'Added clipboard viewer 2'
+
+      cv3 = ClipboardViewer.new('3')
+      puts 'Added clipboard viewer 3'
+
+      lock do
+        Clipboard.set_data('foo')
+      end
+
+      result = Clipboard.data
+      assert_equal(result, cv1.result)
+      assert_equal(result, cv2.result)
+      assert_equal(result, cv3.result)
+
+      # Remove clipboard viewer 2
+      # clipboard viewer chain: cv3 -> cv1
+      assert_not_nil(cv2.remove)
+
+      cv1.clear
+      cv3.clear
+      Clipboard.set_data('bar')
+
+      result = Clipboard.data
+      assert_equal(result, cv1.result)
+      assert_equal(result, cv3.result)
+
+      # Remove clipboard viewer 3
+      assert_not_nil(cv3.remove)
+
+      cv1.clear
+      Clipboard.set_data('foobar')
+
+      result = Clipboard.data
+      assert_equal(result, cv1.result)
+      assert_not_nil(cv1.remove)
+    ensure
+      cv1.exit
+      cv2.exit
+      cv3.exit
+    end
+  end
+
+  class ClipboardViewer
+    NOTIFY_TIMEOUT = 20
+    def initialize(key)
+      @key = key
+      load_path = File.join(File.join(File.dirname(__FILE__), '..'), 'lib')
+      @pipe = IO.popen("#{RbConfig.ruby} -I #{load_path} #{File.join(File.dirname(__FILE__), "notify.rb")} #{key} #{NOTIFY_TIMEOUT}")
+      @result = nil
+      is_ready = false
+
+      @t = Thread.start do
+        begin
+          while true
+            result = @pipe.gets.chomp
+
+            if result == 'ready'
+              is_ready = true
+            else
+              @result = result
+            end
+
+            if @result == @key.chop
+              break
+            end
+          end
+        rescue => e
+          puts $!
+          puts e.backtrace
+        end
+      end
+
+      Timeout::timeout(5) do
+        until is_ready
+          lock do
+            Clipboard.set_data('ready')
+          end
+          sleep(0.1)
+        end
+      end
+    end
+
+    def clear
+      @result = nil
+    end
+
+    def result
+      Timeout::timeout(5) do
+        until @result
+          sleep(0.1)
+        end
+      end
+      @result
+    rescue Timeout::Error
+      raise 'Cannot get result.(Timeout)'
+    end
+
+    def remove
+      return unless @t.alive?
+      lock do
+        Clipboard.set_data(@key)
+      end
+      ret = @t.join(3)
+      if ret
+        @pipe.close
+      end
+      ret
+    end
+
+    def exit
+      return unless @t.alive?
+      Process.kill('KILL', @pipe.pid)
+    end
+  end
+end

data/win32-clipboard.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 Gem::Specification.new do |spec|
   spec.name      = 'win32-clipboard'
-  spec.version   = '0.6.2'
+  spec.version   = '0.6.3'
   spec.authors   = ['Daniel J. Berger', 'Park Heesob']
   spec.license   = 'Artistic 2.0'
   spec.email     = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-clipboard
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -87,7 +87,10 @@ files:
 - test/img/32bit_bitfields2.bmp
 - test/img/4bit.bmp
 - test/img/8bit.bmp
+- test/lock.rb
+- test/notify.rb
 - test/test_clipboard.rb
+- test/test_clipboard_chain.rb
 - test/test_html_clipboard.rb
 - test/test_image_clipboard.rb
 - win32-clipboard.gemspec
@@ -111,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A library for interacting with the Windows clipboard