win32-nio 0.1.1 → 0.1.2

data/lib/win32/nio.rb

@@ -1,200 +1,200 @@
-require 'ffi'
-require 'win32/event'
-
-require File.join(File.dirname(__FILE__), 'windows/functions')
-require File.join(File.dirname(__FILE__), 'windows/constants')
-require File.join(File.dirname(__FILE__), 'windows/structs')
-require File.join(File.dirname(__FILE__), 'windows/macros')
-
-# The Win32 module serves as a namespace only.
-module Win32
-
-  # The NIO class encapsulates the native IO methods for MS Windows.
-  class NIO
-    include Windows::Constants
-    include Windows::Structs
-    extend  Windows::Functions
-    extend  Windows::Macros
-
-    # The version of the win32-nio library
-    VERSION = '0.1.1'
-
-    # This method is similar to Ruby's IO.read method except that it uses
-    # native function calls.
-    #
-    # Examples:
-    #
-    # # Read everything
-    # Win32::NIO.read(file)
-    #
-    # # Read the first 100 bytes
-    # Win32::NIO.read(file, 100)
-    #
-    # # Read 50 bytes starting at offset 10
-    # Win32::NIO.read(file, 50, 10)
-    #
-    # Note that the +options+ that may be passed to this method are limited
-    # to :encoding, :mode and :event because we're no longer using the open
-    # function internally. In the case of :mode the only thing that is checked
-    # for is the presence of the 'b' (binary) mode.
-    #
-    # The :event option, if present, must be a Win32::Event object.
-    #--
-    # In practice the fact that I ignore open_args: is irrelevant since you
-    # would never want to open in anything other than GENERIC_READ. I suppose
-    # I could change this to as a way to pass flags to CreateFile.
-    #
-    def self.read(name, length=nil, offset=0, options={})
-      begin
-        fname = name + "\0"
-        fname.encode!('UTF-16LE')
-
-        flags = FILE_FLAG_SEQUENTIAL_SCAN
-        olap  = Overlapped.new
-        event = options[:event]
-
-        if event
-          raise TypeError unless event.is_a?(Win32::Event)
-        end
-
-        olap[:Offset] = offset
-
-        if offset > 0 || event
-          flags |= FILE_FLAG_OVERLAPPED
-          olap[:hEvent] = event.handle if event
-        end
-
-        handle = CreateFileW(
-          fname,
-          GENERIC_READ,
-          FILE_SHARE_READ,
-          nil,
-          OPEN_EXISTING,
-          flags,
-          0
-        )
-
-        if handle == INVALID_HANDLE_VALUE
-          raise SystemCallError.new("CreateFile", FFI.errno)
-        end
-
-        length ||= File.size(name)
-        buf  = 0.chr * length
-
-        if block_given?
-          callback = Proc.new{ |e,b,o| block.call }
-          bool = ReadFileEx(handle, buf, buf.size, olap, callback)
-        else
-          bool = ReadFile(handle, buf, buf.size, nil, olap)
-        end
-
-        errno = FFI.errno
-
-        SleepEx(1, true) # Must be in alertable wait state
-
-        unless bool
-          if errno == ERROR_IO_PENDING
-            bytes = FFI::MemoryPointer.new(:ulong)
-            unless GetOverlappedResult(handle, olap, bytes, true)
-              raise SystemCallError.new("GetOverlappedResult", FFI.errno)
-            end
-          else
-            raise SystemCallError.new("ReadFile", errno)
-          end
-        end
-
-        result = buf.delete(0.chr)
-
-        result.encode!(options[:encoding]) if options[:encoding]
-
-        if options[:mode] && options[:mode].include?('t') && ($/ != "\r\n")
-          result.gsub!(/\r\n/, $/)
-        end
-
-        result
-      ensure
-        CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
-      end
-    end # NIO.read
-
-    # Reads the entire file specified by portname as individual lines, and
-    # returns those lines in an array. Lines are separated by +sep+.
-    #--
-    # The semantics are the same as the MRI version but the implementation
-    # is drastically different. We use a scattered IO read.
-    #
-    def self.readlines(file, sep = "\r\n")
-      fname = file + "\0"
-      fname.encode!('UTF-16LE')
-
-      begin
-        handle = CreateFileW(
-          fname,
-          GENERIC_READ,
-          FILE_SHARE_READ,
-          nil,
-          OPEN_EXISTING,
-          FILE_FLAG_OVERLAPPED | FILE_FLAG_NO_BUFFERING,
-          0
-        )
-
-        if handle == INVALID_HANDLE_VALUE
-          raise SystemCallError.new("CreateFileW", FFI.errno)
-        end
-
-        sysinfo = SystemInfo.new
-        GetSystemInfo(sysinfo)
-
-        file_size = File.size(file)
-        page_size = sysinfo[:dwPageSize]
-        page_num  = (file_size.to_f / page_size).ceil
-
-        begin
-          size = page_size * page_num
-          base_address = VirtualAlloc(nil, size, MEM_COMMIT, PAGE_READWRITE)
-
-          if base_address == 0
-            raise SystemCallError.new("VirtualAlloc", FFI.errno)
-          end
-
-          # Add 1 for null as per the docs
-          array = FFI::MemoryPointer.new(FileSegmentElement, page_num + 1)
-
-          for i in 0...page_num
-            fse = FileSegmentElement.new(array[i])
-            fse[:Alignment] = base_address + page_size * i
-          end
-
-          overlapped = Overlapped.new
-
-          bool = ReadFileScatter(handle, array, size, nil, overlapped)
-
-          unless bool
-            error = FFI.errno
-            if error == ERROR_IO_PENDING
-              SleepEx(1, true) while !HasOverlappedIoCompleted(overlapped)
-            else
-              raise SystemCallError.new("ReadFileScatter", error)
-            end
-          end
-
-          string = array[0].read_pointer.read_string
-
-          if sep == ""
-            array = string.split(/(\r\n){2,}/)
-            array.delete("\r\n")
-          else
-            array = string.split(sep)
-          end
-
-          array
-        ensure
-          VirtualFree(base_address, 0, MEM_RELEASE)
-        end
-      ensure
-        CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
-      end
-    end # NIO.readlines
-
-  end # NIO
-end # Win32
+require 'ffi'
+require 'win32/event'
+
+require File.join(File.dirname(__FILE__), 'windows/functions')
+require File.join(File.dirname(__FILE__), 'windows/constants')
+require File.join(File.dirname(__FILE__), 'windows/structs')
+require File.join(File.dirname(__FILE__), 'windows/macros')
+
+# The Win32 module serves as a namespace only.
+module Win32
+
+  # The NIO class encapsulates the native IO methods for MS Windows.
+  class NIO
+    include Windows::Constants
+    include Windows::Structs
+    extend  Windows::Functions
+    extend  Windows::Macros
+
+    # The version of the win32-nio library
+    VERSION = '0.1.2'
+
+    # This method is similar to Ruby's IO.read method except that it uses
+    # native function calls.
+    #
+    # Examples:
+    #
+    # # Read everything
+    # Win32::NIO.read(file)
+    #
+    # # Read the first 100 bytes
+    # Win32::NIO.read(file, 100)
+    #
+    # # Read 50 bytes starting at offset 10
+    # Win32::NIO.read(file, 50, 10)
+    #
+    # Note that the +options+ that may be passed to this method are limited
+    # to :encoding, :mode and :event because we're no longer using the open
+    # function internally. In the case of :mode the only thing that is checked
+    # for is the presence of the 'b' (binary) mode.
+    #
+    # The :event option, if present, must be a Win32::Event object.
+    #--
+    # In practice the fact that I ignore open_args: is irrelevant since you
+    # would never want to open in anything other than GENERIC_READ. I suppose
+    # I could change this to as a way to pass flags to CreateFile.
+    #
+    def self.read(name, length=nil, offset=0, options={})
+      begin
+        fname = name + "\0"
+        fname.encode!('UTF-16LE')
+
+        flags = FILE_FLAG_SEQUENTIAL_SCAN
+        olap  = Overlapped.new
+        event = options[:event]
+
+        if event
+          raise TypeError unless event.is_a?(Win32::Event)
+        end
+
+        olap[:Offset] = offset
+
+        if offset > 0 || event
+          flags |= FILE_FLAG_OVERLAPPED
+          olap[:hEvent] = event.handle if event
+        end
+
+        handle = CreateFileW(
+          fname,
+          GENERIC_READ,
+          FILE_SHARE_READ,
+          nil,
+          OPEN_EXISTING,
+          flags,
+          0
+        )
+
+        if handle == INVALID_HANDLE_VALUE
+          raise SystemCallError.new("CreateFile", FFI.errno)
+        end
+
+        length ||= File.size(name)
+        buf  = 0.chr * length
+
+        if block_given?
+          callback = Proc.new{ |e,b,o| block.call }
+          bool = ReadFileEx(handle, buf, buf.size, olap, callback)
+        else
+          bool = ReadFile(handle, buf, buf.size, nil, olap)
+        end
+
+        errno = FFI.errno
+
+        SleepEx(1, true) # Must be in alertable wait state
+
+        unless bool
+          if errno == ERROR_IO_PENDING
+            bytes = FFI::MemoryPointer.new(:ulong)
+            unless GetOverlappedResult(handle, olap, bytes, true)
+              raise SystemCallError.new("GetOverlappedResult", FFI.errno)
+            end
+          else
+            raise SystemCallError.new("ReadFile", errno)
+          end
+        end
+
+        result = buf.delete(0.chr)
+
+        result.encode!(options[:encoding]) if options[:encoding]
+
+        if options[:mode] && options[:mode].include?('t') && ($/ != "\r\n")
+          result.gsub!(/\r\n/, $/)
+        end
+
+        result
+      ensure
+        CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
+      end
+    end # NIO.read
+
+    # Reads the entire file specified by portname as individual lines, and
+    # returns those lines in an array. Lines are separated by +sep+.
+    #--
+    # The semantics are the same as the MRI version but the implementation
+    # is drastically different. We use a scattered IO read.
+    #
+    def self.readlines(file, sep = "\r\n")
+      fname = file + "\0"
+      fname.encode!('UTF-16LE')
+
+      begin
+        handle = CreateFileW(
+          fname,
+          GENERIC_READ,
+          FILE_SHARE_READ,
+          nil,
+          OPEN_EXISTING,
+          FILE_FLAG_OVERLAPPED | FILE_FLAG_NO_BUFFERING,
+          0
+        )
+
+        if handle == INVALID_HANDLE_VALUE
+          raise SystemCallError.new("CreateFileW", FFI.errno)
+        end
+
+        sysinfo = SystemInfo.new
+        GetSystemInfo(sysinfo)
+
+        file_size = File.size(file)
+        page_size = sysinfo[:dwPageSize]
+        page_num  = (file_size.to_f / page_size).ceil
+
+        begin
+          size = page_size * page_num
+          base_address = VirtualAlloc(nil, size, MEM_COMMIT, PAGE_READWRITE)
+
+          if base_address == 0
+            raise SystemCallError.new("VirtualAlloc", FFI.errno)
+          end
+
+          # Add 1 for null as per the docs
+          array = FFI::MemoryPointer.new(FileSegmentElement, page_num + 1)
+
+          for i in 0...page_num
+            fse = FileSegmentElement.new(array[i])
+            fse[:Alignment] = base_address + page_size * i
+          end
+
+          overlapped = Overlapped.new
+
+          bool = ReadFileScatter(handle, array, size, nil, overlapped)
+
+          unless bool
+            error = FFI.errno
+            if error == ERROR_IO_PENDING
+              SleepEx(1, true) while !HasOverlappedIoCompleted(overlapped)
+            else
+              raise SystemCallError.new("ReadFileScatter", error)
+            end
+          end
+
+          string = array[0].read_pointer.read_string
+
+          if sep == ""
+            array = string.split(/(\r\n){2,}/)
+            array.delete("\r\n")
+          else
+            array = string.split(sep)
+          end
+
+          array
+        ensure
+          VirtualFree(base_address, 0, MEM_RELEASE)
+        end
+      ensure
+        CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
+      end
+    end # NIO.readlines
+
+  end # NIO
+end # Win32

data/lib/win32/windows/constants.rb

@@ -1,72 +1,72 @@
-module Windows
-  module Constants
-    INVALID_HANDLE_VALUE = 0xFFFFFFFF
-
-    CREATE_NEW        = 1
-    CREATE_ALWAYS     = 2
-    OPEN_EXISTING     = 3
-    OPEN_ALWAYS       = 4
-    TRUNCATE_EXISTING = 5
-
-    GENERIC_READ    = 0x80000000
-    GENERIC_WRITE   = 0x40000000
-    GENERIC_EXECUTE = 0x20000000
-    GENERIC_ALL     = 0x10000000
-
-    FILE_SHARE_READ = 0x00000001
-
-    FILE_FLAG_WRITE_THROUGH       = 0x80000000
-    FILE_FLAG_OVERLAPPED          = 0x40000000
-    FILE_FLAG_NO_BUFFERING        = 0x20000000
-    FILE_FLAG_RANDOM_ACCESS       = 0x10000000
-    FILE_FLAG_SEQUENTIAL_SCAN     = 0x08000000
-    FILE_FLAG_DELETE_ON_CLOSE     = 0x04000000
-    FILE_FLAG_BACKUP_SEMANTICS    = 0x02000000
-    FILE_FLAG_POSIX_SEMANTICS     = 0x01000000
-    FILE_FLAG_OPEN_REPARSE_POINT  = 0x00200000
-    FILE_FLAG_OPEN_NO_RECALL      = 0x00100000
-    FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000
-
-    MEM_COMMIT      = 0x1000
-    MEM_RESERVE     = 0x2000
-    MEM_DECOMMIT    = 0x4000
-    MEM_RELEASE     = 0x8000
-    MEM_FREE        = 0x10000
-    MEM_PRIVATE     = 0x20000
-    MEM_MAPPED      = 0x40000
-    MEM_RESET       = 0x80000
-    MEM_TOP_DOWN    = 0x100000
-    MEM_WRITE_WATCH = 0x200000
-    MEM_PHYSICAL    = 0x400000
-    MEM_LARGE_PAGES = 0x20000000
-    MEM_4MB_PAGES   = 0x80000000
-
-    PAGE_NOACCESS          = 0x01
-    PAGE_READONLY          = 0x02
-    PAGE_READWRITE         = 0x04
-    PAGE_WRITECOPY         = 0x08
-    PAGE_EXECUTE           = 0x10
-    PAGE_EXECUTE_READ      = 0x20
-    PAGE_EXECUTE_READWRITE = 0x40
-    PAGE_EXECUTE_WRITECOPY = 0x80
-    PAGE_GUARD             = 0x100
-    PAGE_NOCACHE           = 0x200
-    PAGE_WRITECOMBINE      = 0x400
-
-    INFINITE         = 0xFFFFFFFF
-    WAIT_OBJECT_0    = 0
-    WAIT_TIMEOUT     = 0x102
-    WAIT_ABANDONED   = 128
-    WAIT_ABANDONED_0 = WAIT_ABANDONED
-    WAIT_FAILED      = 0xFFFFFFFF
-    
-    STATUS_WAIT_0           =  0    
-    STATUS_ABANDONED_WAIT_0 =  128    
-    STATUS_USER_APC         =  192    
-    STATUS_TIMEOUT          =  258    
-    STATUS_PENDING          =  259
-
-    ERROR_IO_INCOMPLETE     = 996
-    ERROR_IO_PENDING        = 997
-  end
-end
+module Windows
+  module Constants
+    INVALID_HANDLE_VALUE = 0xFFFFFFFF
+
+    CREATE_NEW        = 1
+    CREATE_ALWAYS     = 2
+    OPEN_EXISTING     = 3
+    OPEN_ALWAYS       = 4
+    TRUNCATE_EXISTING = 5
+
+    GENERIC_READ    = 0x80000000
+    GENERIC_WRITE   = 0x40000000
+    GENERIC_EXECUTE = 0x20000000
+    GENERIC_ALL     = 0x10000000
+
+    FILE_SHARE_READ = 0x00000001
+
+    FILE_FLAG_WRITE_THROUGH       = 0x80000000
+    FILE_FLAG_OVERLAPPED          = 0x40000000
+    FILE_FLAG_NO_BUFFERING        = 0x20000000
+    FILE_FLAG_RANDOM_ACCESS       = 0x10000000
+    FILE_FLAG_SEQUENTIAL_SCAN     = 0x08000000
+    FILE_FLAG_DELETE_ON_CLOSE     = 0x04000000
+    FILE_FLAG_BACKUP_SEMANTICS    = 0x02000000
+    FILE_FLAG_POSIX_SEMANTICS     = 0x01000000
+    FILE_FLAG_OPEN_REPARSE_POINT  = 0x00200000
+    FILE_FLAG_OPEN_NO_RECALL      = 0x00100000
+    FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000
+
+    MEM_COMMIT      = 0x1000
+    MEM_RESERVE     = 0x2000
+    MEM_DECOMMIT    = 0x4000
+    MEM_RELEASE     = 0x8000
+    MEM_FREE        = 0x10000
+    MEM_PRIVATE     = 0x20000
+    MEM_MAPPED      = 0x40000
+    MEM_RESET       = 0x80000
+    MEM_TOP_DOWN    = 0x100000
+    MEM_WRITE_WATCH = 0x200000
+    MEM_PHYSICAL    = 0x400000
+    MEM_LARGE_PAGES = 0x20000000
+    MEM_4MB_PAGES   = 0x80000000
+
+    PAGE_NOACCESS          = 0x01
+    PAGE_READONLY          = 0x02
+    PAGE_READWRITE         = 0x04
+    PAGE_WRITECOPY         = 0x08
+    PAGE_EXECUTE           = 0x10
+    PAGE_EXECUTE_READ      = 0x20
+    PAGE_EXECUTE_READWRITE = 0x40
+    PAGE_EXECUTE_WRITECOPY = 0x80
+    PAGE_GUARD             = 0x100
+    PAGE_NOCACHE           = 0x200
+    PAGE_WRITECOMBINE      = 0x400
+
+    INFINITE         = 0xFFFFFFFF
+    WAIT_OBJECT_0    = 0
+    WAIT_TIMEOUT     = 0x102
+    WAIT_ABANDONED   = 128
+    WAIT_ABANDONED_0 = WAIT_ABANDONED
+    WAIT_FAILED      = 0xFFFFFFFF
+    
+    STATUS_WAIT_0           =  0    
+    STATUS_ABANDONED_WAIT_0 =  128    
+    STATUS_USER_APC         =  192    
+    STATUS_TIMEOUT          =  258    
+    STATUS_PENDING          =  259
+
+    ERROR_IO_INCOMPLETE     = 996
+    ERROR_IO_PENDING        = 997
+  end
+end