win32-clipboard 0.4.0 → 0.4.1

data/CHANGES

@@ -1,3 +1,7 @@
+== 0.4.1 - 30-Jul-2006
+* Now uses the windows-pr package.  No API changes.
+* Made Clipboard.get_data a true alias (instead of a facade).
+
 == 0.4.0 - 24-Feb-2006
 * Removed the C version entirely and replaced it with a pure Ruby version
   that uses the Win32API package.

data/MANIFEST

@@ -1,8 +1,8 @@
 MANIFEST
 CHANGES
 README
-
-doc/clipboard.txt
+install.rb
+win32-clipboard.gemspec
 
 examples/clipboard_test.rb
 

data/README

@@ -9,7 +9,7 @@
    puts "Number of available formats: " + Clipboard.num_formats
     
    puts "Setting data to 'foobar'"
-   Clipboard.data = "foobar"
+   Clipboard.set_data("foobar")
     
    puts "Clipboard now contains: " + Clipboard.data
     
@@ -27,12 +27,6 @@ Clipboard.get_data(format=nil)
    Note that this method does implicit conversions on formats with regards
    to text data.  See the MSDN documentation for more details.
     
-Clipboard.set_data(data, format=nil)
-   Sets the clipboard contents to the data that you specify.  You may
-   optionally specify a clipboard format.  The default is Clipboard::TEXT.
-    
-   See the 'Constants' section for a list of the supported formats.
-    
 Clipboard.empty
    Empty the contents of the clipboard
     
@@ -64,6 +58,12 @@ Clipboard.register_format(format)
 	Registered clipboard formats are identified by values in the range 0xC000
 	through 0xFFFF.
 	
+Clipboard.set_data(data, format=nil)
+   Sets the clipboard contents to the data that you specify.  You may
+   optionally specify a clipboard format.  The default is Clipboard::TEXT.
+    
+   See the 'Constants' section for a list of the supported formats.
+	
 == Error Classes
 ClipboardError
 	Typically only raised if the clipboard fails to open or if you attempt to

data/lib/win32/clipboard.rb

@@ -1,58 +1,34 @@
-require "Win32API"
+require 'windows/clipboard'
+require 'windows/memory'
+require 'windows/error'
 
 module Win32
    class ClipboardError < StandardError; end
    class Clipboard
-      VERSION = '0.4.0'
+      include Windows::Clipboard
+      include Windows::Memory
+      include Windows::Error
+      extend Windows::Clipboard
+      extend Windows::Memory
+      extend Windows::Error
+      
+      VERSION = '0.4.1'
       
       # Clipboard data types
-      TEXT        = 1
-      OEMTEXT     = 7
-      UNICODETEXT = 13
-   		
-      # Alloc constants
-      GMEM_MOVEABLE = 0x0002
-      GMEM_ZEROINIT = 0x0040
-      GHND          = 0x0042
- 
-      # Clipboard specific functions
-      @@OpenClipboard    = Win32API.new('user32', 'OpenClipboard', 'L', 'I')
-      @@CloseClipboard   = Win32API.new('user32', 'CloseClipboard', 'V', 'I')
-      @@GetClipboardData = Win32API.new('user32', 'GetClipboardData', 'I', 'P')
-      @@SetClipboardData = Win32API.new('user32', 'SetClipboardData', 'II', 'I')
-      @@EmptyClipboard   = Win32API.new('user32', 'EmptyClipboard', 'V', 'I')
+      TEXT        = CF_TEXT
+      OEMTEXT     = CF_OEMTEXT
+      UNICODETEXT = CF_UNICODETEXT
 
-      @@CountClipboardFormats = Win32API.new(
-         'user32', 'CountClipboardFormats', 'V', 'I'
-      )
-      
-      @@IsClipboardFormatAvailable = Win32API.new(
-         'user32', 'IsClipboardFormatAvailable', 'I', 'I'
-      )
-      
-      @@GetClipboardFormatName = Win32API.new(
-         'user32', 'GetClipboardFormatName', 'IPI', 'I'
-      )
-      
-      @@EnumClipboardFormats = Win32API.new(
-         'user32', 'EnumClipboardFormats', 'I', 'I'
-      )
-      
-      @@RegisterClipboardFormat = Win32API.new(
-         'user32', 'RegisterClipboardFormat', 'P', 'I'
-      )
-   		
-      # Generic Win32 functions
-      @@GlobalAlloc  = Win32API.new('kernel32', 'GlobalAlloc', 'II' ,'I')
-      @@GlobalLock   = Win32API.new('kernel32', 'GlobalLock', 'I' ,'I')
-      @@GlobalFree   = Win32API.new('kernel32', 'GlobalFree', 'I' ,'I')
-      @@Memcpy       = Win32API.new('msvcrt',  'memcpy', 'IPI', 'I')
+      # We'll use a custom definition of memcpy since this is different than
+      # what's in the Windows::MSVCRT::Buffer module.
+      @@Memcpy = Win32API.new('msvcrt',  'memcpy', 'IPI', 'I')
 
       # Sets the clipboard contents to the data that you specify.  You may
       # optionally specify a clipboard format.  The default is Clipboard::TEXT.
+      # 
       def self.set_data(clip_data, format = TEXT)
          self.open
-         @@EmptyClipboard.call
+         EmptyClipboard()
 
          # NULL terminate text
          case format
@@ -61,73 +37,80 @@ module Win32
          end
 
          # Global Allocate a movable piece of memory.
-         hmem = @@GlobalAlloc.call(GHND, clip_data.length + 4)
-         mem  = @@GlobalLock.call(hmem)
+         hmem = GlobalAlloc(GHND, clip_data.length + 4)
+         mem  = GlobalLock(hmem)
          @@Memcpy.call(mem, clip_data, clip_data.length)
 
          # Set the new data
-         if @@SetClipboardData.call(format, hmem) == 0
-            @@GlobalFree.call(hmem)
+         if SetClipboardData(format, hmem) == 0
+            error = get_last_error
+            GlobalFree(hmem)
             self.close
-            raise ClipboardError, "SetClipboardData() failed"
+            raise ClipboardError, "SetClipboardData() failed: #{error}"
          end
 
-         @@GlobalFree.call(hmem)   
+         GlobalFree(hmem)   
          self.close
          self
       end 		
 
-      # Returns the data currently in the clipboard.  If 'format' is
+      # Returns the data currently in the clipboard.  If +format+ is
       # specified, it will attempt to retrieve the data in that format. The
-      # default is Clipboard::TEXT. 		  		
+      # default is Clipboard::TEXT.
+      # 
       def self.data(format = TEXT)
          clipdata = ""
          self.open
          begin
-            clipdata = @@GetClipboardData.call(format)
+            clipdata = GetClipboardData(format)
          rescue ArgumentError
             # Assume failure is caused by no data in clipboard
          end
          self.close
          clipdata
       end
-
-      # An alias for Clipboard.data.
-      def self.get_data(format = TEXT)
-         self.data(format)
+      
+      # Singleton aliases
+      # 
+      class << self
+         alias :get_data :data
       end
 
       # Empties the contents of the clipboard.
+      # 
       def self.empty
          self.open
-         @@EmptyClipboard.call
+         EmptyClipboard()
          self.close
          self
       end
 
       # Returns the number of different data formats currently on the
       # clipboard.
+      # 
       def self.num_formats
          count = 0
          self.open
-         count = @@CountClipboardFormats.call
+         count = CountClipboardFormats()
          self.close
          count
       end
       
       # Returns whether or not +format+ (an int) is currently available.
+      # 
       def self.format_available?(format)
-         @@IsClipboardFormatAvailable.call(format) == 0 ? false : true
+         IsClipboardFormatAvailable(format)
       end
       
-      # Returns the corresponding name for the given 'format_number', or nil
+      # Returns the corresponding name for the given +format_num+, or nil
       # if it does not exist.  You cannot specify any of the predefined
       # clipboard formats (or nil is returned), only registered formats.
-      def self.format_name(format)
+      # 
+      def self.format_name(format_num)
          val = nil
          buf = 0.chr * 80
          self.open
-         if @@GetClipboardFormatName.call(format, buf, buf.length) != 0
+         if GetClipboardFormatName(format_num, buf, buf.length) != 0
             val = buf
          end
          self.close
@@ -136,21 +119,22 @@ module Win32
       
       # Returns a hash of all the current formats, with the format number as
       # the key and the format name as the value for that key.
+      # 
       def self.formats
          formats = {}
          format = 0
          
          self.open
-         while 0 != (format = @@EnumClipboardFormats.call(format))
+         while 0 != (format = EnumClipboardFormats(format))
             buf = 0.chr * 80
-            @@GetClipboardFormatName.call(format, buf, buf.length)
+            GetClipboardFormatName(format, buf, buf.length)
             formats[format] = buf.split(0.chr).first
          end
          self.close
          formats
       end
       
-      # Registers the given 'format' (a String) as a clipboard format, which
+      # Registers the given +format+ (a String) as a clipboard format, which
       # can then be used as a valid clipboard format.
       #
       # If a registered format with the specified name already exists, a new
@@ -161,22 +145,24 @@ module Win32
       #
       # Registered clipboard formats are identified by values in the range 0xC000
       # through 0xFFFF.
+      # 
       def self.register_format(format)
-         if @@RegisterClipboardFormat.call(format) == 0
-            raise ClipboardError, "RegisterClipboardFormat() call failed"
+         if RegisterClipboardFormat(format) == 0
+            error = "RegisterClipboardFormat() call failed: " + get_last_error
+            raise ClipboardError,  error
          end
       end
 
       private
 
       def self.open
-         if 0 == @@OpenClipboard.call(0)
-            raise ClipboardError, "OpenClipboard() failed"
+         if 0 == OpenClipboard(0)
+            raise ClipboardError, "OpenClipboard() failed: " + get_last_error
          end
       end
 
       def self.close
-         @@CloseClipboard.call
+         CloseClipboard()
       end
    end
 end

data/test/tc_clipboard.rb

@@ -18,7 +18,7 @@ include Win32
 
 class TC_Win32ClipBoard < Test::Unit::TestCase  
    def test_version
-      assert_equal('0.4.0', Clipboard::VERSION)
+      assert_equal('0.4.1', Clipboard::VERSION)
    end
      
    def test_data
@@ -28,6 +28,14 @@ class TC_Win32ClipBoard < Test::Unit::TestCase
       assert_raises(NameError){ Clipboard.data(CF_FOO) }
    end
    
+   # Alias
+   def test_get_data
+      assert_respond_to(Clipboard, :get_data)
+      assert_nothing_raised{ Clipboard.get_data }     
+      assert_kind_of(String, Clipboard.get_data, 'bad data type')
+      assert_raises(NameError){ Clipboard.get_data(CF_FOO) }
+   end
+   
    def test_set_data
       assert_respond_to(Clipboard, :set_data)
       assert_nothing_raised{ Clipboard.set_data("foo") }

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: win32-clipboard
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2006-02-24 00:00:00 -07:00
+  version: 0.4.1
+date: 2006-07-30 00:00:00 -06:00
 summary: A package for interacting with the Windows clipboard
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Daniel J. Berger
 files: 
@@ -47,5 +48,13 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: windows-pr
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.1
+    version: