kernel32lib 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9461887352b87d1814c7f5be6e1324efad7efa60
+  data.tar.gz: 29178f62a4d0b9e696281a1fdc17104a6b61113d
+SHA512:
+  metadata.gz: 75ad77da4e4a2be816df0cabd7dd88f2c6fe127396b9ee14e0ea12358ca1c6d752f37cd61fb54c8ec8e5f8d7b6c0230d407ab8814f926f58593efa7ce4f323e3
+  data.tar.gz: 8479fd03a6bc3203b442a44a800f35f466482fa585e5a0e2d2a7f302874439afd1e52d9159c3d284ed108338797376f8898af649e1b6746abb986669fb146421

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## 0.0.2 (Jun 2, 2016)
+Features:
+- add WinAPI Consoles functions:
+* GetStdHandle
+* SetConsoleCursorPosition
+* GetConsoleScreenBufferInfo
+* SetConsoleScreenBufferSize
+* SetConsoleWindowInfo
+* SetConsoleTextAttribute
+* GetConsoleOutputCP
+* SetConsoleOutputCP
+Bugfixes:
+- check get_file_information_by_handle
+
+## 0.0.1 (Jun 1, 2016)
+Features:
+- add WinAPI Files functions:
+* CreateFile
+* CloseHandle
+* GetFileInformationByHandle
+* FileTimeToSystemTime
+* GetFileTime
+- add module Fixture (fixture for test)
+Bugfixes:
+- initial release

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Dmitriy Mullo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Kernel32Lib: kernel32lib
+
+Win32 API wrapper for Ruby which uses Fiddle and Fiddle::Importer
+
+## Installation and usage
+
+install:
+```
+gem install kernel32lib
+```
+usage:
+```ruby
+  require 'kernel32lib/files'
+  require 'kernel32lib/consoles'
+
+  # call Kernel32Lib.function_name(function_params (optional)...)
+  # e.g.
+  Kernel32Lib.get_file_information_by_handle(__FILE__)
+  # or
+  Kernel32Lib.get_console_output_cp
+```
+see more detailed example in ./fixtures/fixture_kernel32lib.rb
+
+## Troubleshooting
+
+Visit to [kernel32lib homepage](https://github.com/dim11981/kernel32lib)

data/fixtures/fixture_kernel32lib.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+#require 'kernel32lib'
+require(File.expand_path('../../win_api/files',__FILE__))
+require(File.expand_path('../../win_api/consoles',__FILE__))
+
+# Fixture module
+# test fixture
+module Fixture
+  def self.show
+    system 'cls'
+    puts '# get_file_information_by_handle'
+    puts "  - file information: #{Kernel32Lib.get_file_information_by_handle(__FILE__)}"
+    puts
+    puts '# get_file_time'
+    puts "  - file time: #{Kernel32Lib.get_file_time(__FILE__)}"
+    puts
+    puts '# try console'
+    console_output = Kernel32Lib.GetStdHandle(Kernel32Lib::STD_OUTPUT_HANDLE)
+    init_console_screen_buffer_info = Kernel32Lib.get_console_screen_buffer_info(console_output)
+    init_attributes = init_console_screen_buffer_info[:attributes]
+    init_screen_buffer_size = init_console_screen_buffer_info[:size]
+    init_window = init_console_screen_buffer_info[:window]
+    puts "  - console screen buffer info (1): #{init_console_screen_buffer_info}"
+    puts "  - console output code page: #{Kernel32Lib.get_console_output_cp}"
+    Kernel32Lib.set_console_window_info(console_output,true,[0,0,1,1])
+    Kernel32Lib.set_console_screen_buffer_size(console_output,[120,80])
+    Kernel32Lib.set_console_window_info(console_output,true,[0,0,70,25])
+    Kernel32Lib.set_console_text_attribute(console_output,Kernel32Lib::FOREGROUND_GREEN | Kernel32Lib::FOREGROUND_INTENSITY | Kernel32Lib::BACKGROUND_BLUE)
+    puts "  - console screen buffer info (2): #{Kernel32Lib.get_console_screen_buffer_info(console_output)}"
+    9.times { print '.'; sleep(0.5) }
+    Kernel32Lib.set_console_text_attribute(console_output,init_attributes.to_i)
+    Kernel32Lib.set_console_window_info(console_output,true,[0,0,1,1])
+    Kernel32Lib.set_console_screen_buffer_size(console_output,init_screen_buffer_size)
+    Kernel32Lib.set_console_window_info(console_output,true,init_window)
+    puts
+  end
+
+end

data/kernel32lib.gemspec

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'rubygems'
+require(File.expand_path('../lib/version.rb',__FILE__))
+
+Gem::Specification.new do |s|
+  s.name        = 'kernel32lib'
+  s.version     = Kernel32Lib::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = 'kernel32lib lib'
+  s.description = 'Win32 API wrapper for Ruby which uses Fiddle and Fiddle::Importer'
+  s.authors     = ['Dmitriy Mullo']
+  s.email       = ['d.a.mullo1981@gmail.com']
+  s.homepage    = 'https://github.com/dim11981/kernel32lib'
+  s.platform = Gem::Platform::RUBY
+  s.files       = Dir['*.md']+Dir['kernel32lib.*']+Dir['lib/*.rb']+Dir['win_api/*.rb']+Dir['test/*.rb']+Dir['fixtures/*']
+  s.require_path = 'lib'
+end

data/lib/kernel32lib.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'fiddle'
+require 'fiddle/import'
+
+# Kernel32Lib module
+# supports kernel32 WinAPI functions
+module Kernel32Lib
+  extend Fiddle::Importer
+  dlload 'kernel32.dll'
+  extern 'unsigned long GetLastError(void)'
+
+  # GetLastError
+  def self.get_last_error
+    Kernel32Lib.GetLastError(0)
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+# Kernel32Lib module
+# version
+module Kernel32Lib
+  VERSION = '0.0.2'
+end

data/test/test_kernel32lib.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require(File.expand_path('../../fixtures/fixture_kernel32lib',__FILE__))
+
+# begin test
+Fixture.show
+# end test

data/win_api/consoles.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+
+require(File.expand_path('../../lib/kernel32lib.rb',__FILE__))
+
+# Kernel32Lib module
+# Consoles
+module Kernel32Lib
+  extern 'void* GetStdHandle(unsigned long)'
+  extern 'int SetConsoleCursorPosition(void*,void*)'
+  extern 'int GetConsoleScreenBufferInfo(void*,void*)'
+  extern 'int SetConsoleScreenBufferSize(void*,void*)'
+  extern 'int SetConsoleWindowInfo(void*,void,void*)'
+  extern 'int SetConsoleTextAttribute(void*,unsigned long)'
+  extern 'unsigned int GetConsoleOutputCP(void)'
+  extern 'int SetConsoleOutputCP(unsigned int)'
+
+  STD_INPUT_HANDLE = -10
+  STD_OUTPUT_HANDLE = -11
+  STD_ERROR_HANDLE = -12
+
+  # Attributes flags:
+  FOREGROUND_BLUE = 0x0001 # text color contains blue.
+  FOREGROUND_GREEN = 0x0002 # text color contains green.
+  FOREGROUND_RED = 0x0004 # text color contains red.
+  FOREGROUND_WHITE = 0x0007 # text color contains white on black background.
+  FOREGROUND_INTENSITY = 0x0008 # text color is intensified.
+  BACKGROUND_BLUE = 0x0010 # background color contains blue.
+  BACKGROUND_GREEN = 0x0020 # background color contains green.
+  BACKGROUND_RED = 0x0040 # background color contains red.
+  BACKGROUND_WHITE = 0x0070 # background color contains white with black foreground.
+  BACKGROUND_INTENSITY = 0x0080 # background color is intensified.
+  COMMON_LVB_LEADING_BYTE = 0x0100 # Leading Byte of DBCS
+  COMMON_LVB_TRAILING_BYTE = 0x0200 # Trailing Byte of DBCS
+  COMMON_LVB_GRID_HORIZONTAL = 0x0400 # DBCS: Grid attribute: top horizontal.
+  COMMON_LVB_GRID_LVERTICAL = 0x0800 # DBCS: Grid attribute: left vertical.
+  COMMON_LVB_GRID_RVERTICAL = 0x1000 # DBCS: Grid attribute: right vertical.
+  COMMON_LVB_REVERSE_VIDEO = 0x4000 # DBCS: Reverse fore/back ground attribute.
+  COMMON_LVB_UNDERSCORE = 0x8000 # DBCS: Underscore.
+  COMMON_LVB_SBCSDBCS = 0x0300 # SBCS or DBCS flag.
+
+  # SetConsoleCursorPosition
+  def self.set_console_cursor_position(console_output,cursor_position)
+    lp_cursor_position = cursor_position.pack('s2')
+    Kernel32Lib.SetConsoleCursorPosition(console_output,lp_cursor_position.unpack('i')[0].to_i)
+  end
+
+  # GetConsoleScreenBufferInfo
+  def self.get_console_screen_buffer_info(console_output)
+    lp_console_screen_buffer_info = '0'*22
+    Kernel32Lib.GetConsoleScreenBufferInfo(console_output,lp_console_screen_buffer_info)
+    lp_console_screen_buffer_info = lp_console_screen_buffer_info.unpack('s4Ss4s2')
+    console_screen_buffer_info = {
+        size: [ lp_console_screen_buffer_info[0].to_i, lp_console_screen_buffer_info[1].to_i ],
+        cursor_position: [ lp_console_screen_buffer_info[2], lp_console_screen_buffer_info[3].to_i ],
+        attributes: lp_console_screen_buffer_info[4].to_i,
+        window: [ lp_console_screen_buffer_info[5].to_i, lp_console_screen_buffer_info[6].to_i, lp_console_screen_buffer_info[7].to_i, lp_console_screen_buffer_info[8].to_i ],
+        maximum_window_size: [ lp_console_screen_buffer_info[9].to_i, lp_console_screen_buffer_info[10].to_i ]
+    }
+    console_screen_buffer_info
+  end
+
+  # SetConsoleTextAttribute
+  def self.set_console_text_attribute(console_output,attributes)
+    Kernel32Lib.SetConsoleTextAttribute(console_output,attributes)
+  end
+
+  # GetStdHandle
+  def self.get_std_handle(std_handle)
+    Kernel32Lib.GetStdHandle(std_handle)
+  end
+
+  # GetConsoleOutputCP
+  def self.get_console_output_cp
+    Kernel32Lib.GetConsoleOutputCP(0)
+  end
+
+  # SetConsoleOutputCP
+  def self.set_console_output_cp(code_page_id)
+    Kernel32Lib.SetConsoleOutputCP(code_page_id)
+  end
+
+  # SetConsoleScreenBufferSize
+  def self.set_console_screen_buffer_size(console_output,size)
+    lp_size = size.pack('s2')
+    Kernel32Lib.SetConsoleScreenBufferSize(console_output,lp_size.unpack('i')[0].to_i)
+  end
+
+  # SetConsoleWindowInfo
+  def self.set_console_window_info(console_output,absolute,console_window)
+    lp_console_window = console_window.pack('s4')
+    Kernel32Lib.SetConsoleWindowInfo(console_output,absolute,lp_console_window)
+  end
+
+end

data/win_api/files.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+require(File.expand_path('../../lib/kernel32lib.rb',__FILE__))
+
+# Kernel32Lib module
+# Files
+module Kernel32Lib
+  extern 'void* CreateFile(char*,unsigned long,unsigned long,void*,unsigned long,unsigned long,void*)'
+  extern 'int CloseHandle(void*)'
+  extern 'int GetFileInformationByHandle(void*,void*)'
+  extern 'int FileTimeToSystemTime(void*,void*)'
+  extern 'int GetFileTime(void*,void*,void*,void*)'
+
+  # Access rights constants
+  FILE_READ_DATA = 1
+  FILE_WRITE_DATA = 2
+  FILE_APPEND_DATA = 4
+  GENERIC_READ = 0x80000000
+  GENERIC_WRITE = 0x40000000
+  GENERIC_EXECUTE = 0x20000000
+  GENERIC_ALL = 0x10000000
+
+  # Share mode constants
+  FILE_SHARE_0 = 0x00000000 # Prevents other processes from opening a file or device if they request delete, read, or write access.
+  FILE_SHARE_DELETE = 0x00000004 # Enables subsequent open operations on a file or device to request delete access.
+  FILE_SHARE_READ = 0x00000001 # Enables subsequent open operations on a file or device to request read access.
+  FILE_SHARE_WRITE = 0x00000002 # Enables subsequent open operations on a file or device to request write access.
+
+  # Creation disposition constants
+  CREATE_ALWAYS = 2 # Creates a new file, always.
+  CREATE_NEW = 1 # Creates a new file, only if it does not already exist.
+  OPEN_ALWAYS = 4 # Opens a file, always.
+  OPEN_EXISTING = 3 # Opens a file or device, only if it exists.
+  TRUNCATE_EXISTING = 5 # Opens a file and truncates it so that its size is zero bytes, only if it exists
+
+  # CreateFile flags and attributes constants
+  FILE_ATTRIBUTE_READONLY = 1 # The file is read only. Applications can read the file, but cannot write to or delete it.
+  FILE_ATTRIBUTE_HIDDEN = 2 # The file is hidden. Do not include it in an ordinary directory listing.
+  FILE_ATTRIBUTE_SYSTEM = 4 # The file is part of or used exclusively by an operating system.
+  FILE_ATTRIBUTE_DIRECTORY = 16 # The handle that identifies a directory.
+  FILE_ATTRIBUTE_ARCHIVE = 32 # The file should be archived. Applications use this attribute to mark files for backup or removal.
+  FILE_ATTRIBUTE_NORMAL = 128 # The file does not have other attributes set. This attribute is valid only if used alone.
+  FILE_ATTRIBUTE_TEMPORARY = 256 # The file is being used for temporary storage.
+  FILE_ATTRIBUTE_OFFLINE = 4096 # The data of a file is not immediately available.
+  FILE_ATTRIBUTE_ENCRYPTED = 16384 # The file or directory is encrypted.
+
+  FILE_FLAG_BACKUP_SEMANTICS = 0x02000000 # The file is being opened or created for a backup or restore operation.
+  FILE_FLAG_DELETE_ON_CLOSE = 0x04000000 # The file is to be deleted immediately after all of its handles are closed, which includes the specified handle and any other open or duplicated handles.
+  FILE_FLAG_NO_BUFFERING = 0x20000000 # The file or device is being opened with no system caching for data reads and writes.
+  FILE_FLAG_OPEN_NO_RECALL = 0x00100000 # The file data is requested, but it should continue to be located in remote storage.
+  FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000 # Normal reparse point processing will not occur; CreateFile will attempt to open the reparse point.
+  FILE_FLAG_OVERLAPPED = 0x40000000 # The file or device is being opened or created for asynchronous I/O.
+  FILE_FLAG_POSIX_SEMANTICS = 0x0100000 # Access will occur according to POSIX rules.
+  FILE_FLAG_RANDOM_ACCESS = 0x10000000 # Access is intended to be random.
+  FILE_FLAG_SESSION_AWARE = 0x00800000 # The file or device is being opened with session awareness.
+  FILE_FLAG_SEQUENTIAL_SCAN = 0x08000000 # Access is intended to be sequential from beginning to end.
+  FILE_FLAG_WRITE_THROUGH = 0x80000000 # Write operations will not go through any intermediate cache, they will go directly to disk.
+
+  # FileTimeToSystemTime
+  def self.file_time_to_system_time(file_time)
+    lp_system_time = '0'*16
+    Kernel32Lib.FileTimeToSystemTime(file_time,lp_system_time)
+    lp_system_time = lp_system_time.unpack('S8')
+    Time.mktime(lp_system_time[0],lp_system_time[1],lp_system_time[3],lp_system_time[4],lp_system_time[5],lp_system_time[6]+lp_system_time[7]/1000)
+  end
+
+  # GetFileInformationByHandle
+  def self.get_file_information_by_handle(file_path)
+    lp_file_information = '0'*52
+    #handle = Kernel32Lib.CreateFile(file_name,1,3,0,3,48,0)
+    handle = Kernel32Lib.CreateFile(file_path,Kernel32Lib::FILE_READ_DATA,Kernel32Lib::FILE_SHARE_READ | Kernel32Lib::FILE_SHARE_WRITE,nil,Kernel32Lib::OPEN_EXISTING,0,nil)
+    Kernel32Lib.GetFileInformationByHandle(handle,lp_file_information)
+    Kernel32Lib.CloseHandle(handle)
+
+    lp_file_information = lp_file_information.unpack('I13')
+    file_information = {
+      file_path: file_path,
+      file_attributes: lp_file_information[0],
+      creation_time: Kernel32Lib.file_time_to_system_time(lp_file_information[1,2].pack('I2')),
+      last_access_time: Kernel32Lib.file_time_to_system_time(lp_file_information[3,4].pack('I2')),
+      last_write_time: Kernel32Lib.file_time_to_system_time(lp_file_information[5,6].pack('I2')),
+      volume_serial_number: lp_file_information[7],
+      file_size_high: lp_file_information[8],
+      file_size_low: lp_file_information[9],
+      number_of_links: lp_file_information[10],
+      file_index_high: lp_file_information[11],
+      file_index_low: lp_file_information[12]
+    }
+
+    file_information
+  end
+
+  # GetFileTime
+  def self.get_file_time(file_path)
+    lp_creation_time = '0'*8
+    lp_access_time = '0'*8
+    lp_write_time = '0'*8
+    handle = Kernel32Lib.CreateFile(file_path,Kernel32Lib::FILE_READ_DATA,Kernel32Lib::FILE_SHARE_READ | Kernel32Lib::FILE_SHARE_WRITE,nil,Kernel32Lib::OPEN_EXISTING,0,nil)
+    Kernel32Lib.GetFileTime(handle,lp_creation_time,lp_access_time,lp_write_time)
+    Kernel32Lib.CloseHandle(handle)
+
+    lp_creation_time = lp_creation_time.unpack('I2')
+    lp_access_time = lp_access_time.unpack('I2')
+    lp_write_time = lp_write_time.unpack('I2')
+
+    file_time = {
+        creation_time: Kernel32Lib.file_time_to_system_time(lp_creation_time.pack('I2')),
+        last_access_time: Kernel32Lib.file_time_to_system_time(lp_access_time.pack('I2')),
+        last_write_time: Kernel32Lib.file_time_to_system_time(lp_write_time.pack('I2')),
+    }
+    file_time
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: kernel32lib
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dmitriy Mullo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-03 00:00:00.000000000 Z
+dependencies: []
+description: Win32 API wrapper for Ruby which uses Fiddle and Fiddle::Importer
+email:
+- d.a.mullo1981@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- fixtures/fixture_kernel32lib.rb
+- kernel32lib.gemspec
+- lib/kernel32lib.rb
+- lib/version.rb
+- test/test_kernel32lib.rb
+- win_api/consoles.rb
+- win_api/files.rb
+homepage: https://github.com/dim11981/kernel32lib
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: kernel32lib lib
+test_files: []