windows_com 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0194380637c6543160a0be00e072f4806e0cdd65'
-  data.tar.gz: 935c162da6720ad0ba281f0bc7d8d6573f82fcca
+  metadata.gz: 8fd412b3685ad9f5901bd3f89dbf2b6a477fa884
+  data.tar.gz: 29d1847667d2b8e406c09b9fab9afd5785e0f545
 SHA512:
-  metadata.gz: ed3ab8238d527d4fd4b6770a70b39d0cf6690c1036ba4702d162ef230954bf293051bab645200dd0e6e69c5f091a45aec62e903a0c8d699c32f96294e952e1bb
-  data.tar.gz: 0e6994e3718acc2292accf0dca730484428dd2c22816580d07169c1d7926311108b209b192196b773af6de539647f629f6fdefc74789d790829e6b7e658ff6a2
+  metadata.gz: dadc3e3d21b5f52341fee37cee3ed18024d305fc8e547d1adb959dc2d323f3c235a4402d5a115902ddb86c9e9a7fcc717a0e8ca86bdfeed6a3a3ca54519326e2
+  data.tar.gz: 3ddeeffb332b95f21147f2300edca335c5848025850289647b142e56ba3feb01426bda38d845ca0001e9d4d4234f567f5a08461d07fe0ea87364977392f78aee

data/README.md

@@ -2,10 +2,12 @@
 
 Ruby FFI (x86) bindings to essential COM related Windows APIs
 
+![Screenshot](./screenshot.png)
+
 ## Install
 
 gem install windows_com
 
 ## Use
 
-See examples folder
+See examples folder (the UIRibbon example requires windows_gui gem)

data/RELNOTES.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## 2.0.0
+
+- Add COMCallback module for implementing COM objects on the Ruby/FFI side
+- enhance some bound FFI structs with useful methods
+- improve code
+
 ## 1.0.0
 
 Rename library to windows_com and ensure it works with recent ruby

data/examples/DesktopGadget.rbw

@@ -10,12 +10,8 @@ IDesktopGadget = COMInterface[IUnknown,
 
 DesktopGadget = COMFactory[IDesktopGadget, '924ccc1b-6562-4c85-8657-d177925222b6']
 
-dg = DesktopGadget.new
-
-begin
+UsingCOMObjects(DesktopGadget.new) { |dg|
 	dg.RunGadget(
-		"#{ENV['ProgramFiles']}\\Windows Sidebar\\Gadgets\\Clock.Gadget\0".encode('utf-16le')
+		"#{ENV['ProgramFiles']}\\Windows Sidebar\\Gadgets\\Clock.Gadget\0".encode!('utf-16le')
 	)
-ensure
-	dg.Release
-end
+}

data/examples/UIRibbon/Command.rb

@@ -0,0 +1,30 @@
+# Generated by the UIRibbon build, do NOT modify
+
+CmdAppMenu = 2
+CmdQAT = 3
+CmdTab1 = 4
+CmdTab1_LabelTitle_RESID = 60001
+CmdTab1Group1 = 5
+CmdTab1Group1_LabelTitle_RESID = 60002
+CmdTab1Group1_LabelDescription_RESID = 60003
+CmdTab1Group1_TooltipDescription_RESID = 60004
+CmdTab1Group1_SmallImages_RESID = 60005
+CmdTab1Group1_SmallImages_120__RESID = 60006
+CmdTab1Group1_LargeImages_RESID = 60007
+CmdTab1Group1_LargeImages_120__RESID = 60008
+CmdItem1 = 6
+CmdItem1_LabelTitle_RESID = 60009
+CmdItem1_LabelDescription_RESID = 60010
+CmdItem1_TooltipDescription_RESID = 60011
+CmdItem1_SmallImages_RESID = 60012
+CmdItem1_SmallImages_120__RESID = 60013
+CmdItem1_LargeImages_RESID = 60014
+CmdItem1_LargeImages_120__RESID = 60015
+CmdButton1 = 7
+CmdButton1_LabelTitle_RESID = 60016
+CmdButton1_LabelDescription_RESID = 60017
+CmdButton1_TooltipDescription_RESID = 60018
+CmdButton1_SmallImages_RESID = 60019
+CmdButton1_SmallImages_120__RESID = 60020
+CmdButton1_LargeImages_RESID = 60021
+CmdButton1_LargeImages_120__RESID = 60022

data/examples/UIRibbon/Command.rbw

@@ -0,0 +1,201 @@
+#WINDOWS_COM_TRACE_CALLBACK_REFCOUNT = true
+
+require 'windows_gui'
+require 'windows_gui/uiribbon' # requires windows_com gem
+
+include WindowsGUI
+include UIRibbon
+
+class UIF < UIFramework
+	def initialize(hwnd)
+		@hwnd = hwnd
+
+		super()
+	end
+
+	attr_reader :hwnd
+end
+
+class UICH < IUICommandHandlerImpl
+	def initialize(uif)
+		@uif = uif
+
+		super()
+	end
+
+	attr_reader :uif
+
+	def OnItem1(*args)
+		MessageBox(uif.hwnd,
+			L("#{self}.#{__method__}"),
+			APPNAME,
+			MB_OK
+		)
+
+		uif.SetUICommandProperty(CmdButton1, UI_PKEY_Enabled, PROPVARIANT[VT_BOOL, :boolVal, -1])
+		uif.SetUICommandProperty(CmdItem1, UI_PKEY_Enabled, PROPVARIANT[VT_BOOL, :boolVal, 0])
+	end
+
+	def OnButton1(*args)
+		MessageBox(uif.hwnd,
+			L("#{self}.#{__method__}"),
+			APPNAME,
+			MB_OK
+		)
+
+		uif.SetUICommandProperty(CmdItem1, UI_PKEY_Enabled, PROPVARIANT[VT_BOOL, :boolVal, -1])
+		uif.SetUICommandProperty(CmdButton1, UI_PKEY_Enabled, PROPVARIANT[VT_BOOL, :boolVal, 0])
+	end
+
+	def Execute(*args)
+		case args[0]
+		when CmdItem1
+			OnItem1(*args)
+		when CmdButton1
+			OnButton1(*args)
+		end
+
+		S_OK
+	end
+end
+
+class UIA < IUIApplicationImpl
+	def initialize(uich)
+		@uich = uich
+
+		super()
+	end
+
+	attr_reader :uich
+
+	def OnCreateUICommand(*args)
+		uich.QueryInterface(uich.class::IID, args[-1])
+
+		S_OK
+	end
+end
+
+WndExtra = Struct.new(
+	:uif,
+	:uich,
+	:uia
+)
+
+def OnCreate(hwnd,
+	cs
+)
+	xtra = Id2Ref[GetWindowLong(hwnd, GWL_USERDATA)]
+
+	xtra[:uif] = UIF.new(hwnd)
+	xtra[:uich] = UICH.new(xtra[:uif])
+	xtra[:uia] = UIA.new(xtra[:uich])
+
+	xtra[:uif].Initialize(hwnd, xtra[:uia].vptr)
+	xtra[:uif].LoadUI(LoadUIDll(), L('APPLICATION_RIBBON'))
+
+	0
+end
+
+def OnDestroy(hwnd)
+	xtra = Id2Ref[GetWindowLong(hwnd, GWL_USERDATA)]
+
+	xtra[:uif].Destroy()
+	xtra[:uif].Release()
+	xtra[:uich].Release()
+	xtra[:uia].Release()
+
+	PostQuitMessage(0); 0
+end
+
+WindowProc = FFI::Function.new(:long,
+	[:pointer, :uint, :uint, :long],
+	convention: :stdcall
+) { |hwnd, uMsg, wParam, lParam|
+begin
+	result = case uMsg
+	when WM_NCCREATE
+		DefWindowProc(hwnd, uMsg, wParam, lParam)
+
+		SetWindowLong(hwnd,
+			GWL_USERDATA,
+			CREATESTRUCT.new(FFI::Pointer.new(lParam))[:lpCreateParams].to_i
+		)
+
+		1
+	when WM_CREATE
+		OnCreate(hwnd, CREATESTRUCT.new(FFI::Pointer.new(lParam)))
+	when WM_DESTROY
+		OnDestroy(hwnd)
+	end
+
+	result || DefWindowProc(hwnd, uMsg, wParam, lParam)
+rescue SystemExit => ex
+	PostQuitMessage(ex.status)
+rescue
+	case MessageBox(hwnd,
+		L(FormatException($!)),
+		APPNAME,
+		MB_ABORTRETRYIGNORE | MB_ICONERROR
+	)
+	when IDABORT
+		PostQuitMessage(2)
+	when IDRETRY
+		retry
+	end
+end
+}
+
+def WinMain
+	Id2RefTrack(xtra = WndExtra.new)
+
+	UsingFFIStructs(WNDCLASSEX.new) { |wc|
+		wc[:cbSize] = wc.size
+		wc[:lpfnWndProc] = WindowProc
+		wc[:cbWndExtra] = FFI::Type::Builtin::POINTER.size
+		wc[:hInstance] = GetModuleHandle(nil)
+		wc[:hIcon] = LoadIcon(nil, IDI_APPLICATION)
+		wc[:hCursor] = LoadCursor(nil, IDC_ARROW)
+		wc[:hbrBackground] = FFI::Pointer.new(COLOR_WINDOW + 1)
+
+		UsingFFIMemoryPointers(PWSTR(APPNAME)) { |className|
+			wc[:lpszClassName] = className
+
+			DetonateLastError(0, :RegisterClassEx,
+				wc
+			)
+		}
+	}
+
+	hwnd = CreateWindowEx(
+		WS_EX_CLIENTEDGE, APPNAME, APPNAME, WS_OVERLAPPEDWINDOW | WS_CLIPCHILDREN,
+		CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT, CW_USEDEFAULT,
+		nil, nil, GetModuleHandle(nil), FFI::Pointer.new(xtra.object_id)
+	)
+
+	raise "CreateWindowEx failed (last error: #{GetLastError()})" if
+		hwnd.null? && GetLastError() != 0
+
+	exit(0) if hwnd.null?
+
+	ShowWindow(hwnd, SW_SHOWNORMAL)
+	UpdateWindow(hwnd)
+
+	UsingFFIStructs(MSG.new) { |msg|
+		until DetonateLastError(-1, :GetMessage,
+			msg, nil, 0, 0
+		) == 0
+			TranslateMessage(msg)
+			DispatchMessage(msg)
+		end
+
+		exit(msg[:wParam])
+	}
+rescue
+	MessageBox(hwnd,
+		L(FormatException($!)),
+		APPNAME,
+		MB_ICONERROR
+	); exit(1)
+end
+
+WinMain()

data/examples/UIRibbon/Command.xml

@@ -0,0 +1,71 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<Application xmlns='http://schemas.microsoft.com/windows/2009/Ribbon'>
+	<Application.Commands>
+<Command Name='cmdAppMenu' />
+
+<Command Name='cmdQAT' />
+
+<Command Name='cmdTab1' LabelTitle='Tab1' />
+	<Command Name='cmdTab1Group1' LabelTitle='&amp;Group1' LabelDescription='LabelDescription...' TooltipDescription='TooltipDescription...'>
+		<Command.SmallImages>
+			<Image>../../res/go-next-small.bmp</Image>
+			<Image MinDPI='120'>../../res/go-next.bmp</Image>
+		</Command.SmallImages>
+		<Command.LargeImages>
+			<Image>../../res/go-next.bmp</Image>
+			<Image MinDPI='120'>../../res/go-next-big.bmp</Image>
+		</Command.LargeImages>
+	</Command>
+
+<Command Name='cmdItem1' LabelTitle='&amp;Item1' LabelDescription='LabelDescription...' TooltipDescription='TooltipDescription...'>
+	<Command.SmallImages>
+		<Image>../../res/go-previous-small.bmp</Image>
+		<Image MinDPI='120'>../../res/go-previous.bmp</Image>
+	</Command.SmallImages>
+	<Command.LargeImages>
+		<Image>../../res/go-previous.bmp</Image>
+		<Image MinDPI='120'>../../res/go-previous-big.bmp</Image>
+	</Command.LargeImages>
+</Command>
+
+<Command Name='cmdButton1' LabelTitle='&amp;Button1' LabelDescription='LabelDescription...' TooltipDescription='TooltipDescription...'>
+	<Command.SmallImages>
+		<Image>../../res/go-next-small.bmp</Image>
+		<Image MinDPI='120'>../../res/go-next.bmp</Image>
+	</Command.SmallImages>
+	<Command.LargeImages>
+		<Image>../../res/go-next.bmp</Image>
+		<Image MinDPI='120'>../../res/go-next-big.bmp</Image>
+	</Command.LargeImages>
+</Command>
+	</Application.Commands>
+
+	<Application.Views>
+		<Ribbon>
+			<Ribbon.ApplicationMenu>
+<ApplicationMenu CommandName='cmdAppMenu'>
+	<MenuGroup Class='MajorItems'>
+		<Button CommandName='cmdItem1' />
+	</MenuGroup>
+</ApplicationMenu>
+			</Ribbon.ApplicationMenu>
+
+			<Ribbon.QuickAccessToolbar>
+<QuickAccessToolbar CommandName='cmdQAT'>
+	<QuickAccessToolbar.ApplicationDefaults>
+		<Button CommandName='cmdItem1' />
+		<Button CommandName='cmdButton1' />
+	</QuickAccessToolbar.ApplicationDefaults>
+</QuickAccessToolbar>
+			</Ribbon.QuickAccessToolbar>
+
+			<Ribbon.Tabs>
+<Tab CommandName='cmdTab1'>
+	<Group CommandName='cmdTab1Group1' SizeDefinition='OneButton'>
+		<Button CommandName='cmdButton1' />
+	</Group>
+</Tab>
+			</Ribbon.Tabs>
+		</Ribbon>
+	</Application.Views>
+</Application>

data/lib/windows_com.rb

@@ -1,4 +1,5 @@
 require_relative 'windows_com/common'
 require_relative 'windows_com/libc'
+require_relative 'windows_com/shlwapi'
 require_relative 'windows_com/ole'
 require_relative 'windows_com/oleaut'

data/lib/windows_com/common.rb

@@ -1,12 +1,21 @@
 require 'ffi'
 
-WINDOWS_COM_VERSION = '1.0.0'
+WINDOWS_COM_VERSION = '2.0.0'
 
 WINDOWS_COM_OLE_INIT = true unless defined?(WINDOWS_COM_OLE_INIT)
+WINDOWS_COM_TRACE_CALLBACK_REFCOUNT = false unless defined?(WINDOWS_COM_TRACE_CALLBACK_REFCOUNT)
 
 module WindowsCOM
 	extend FFI::Library
 
+	def UsingCOMObjects(*objs)
+		yield(*objs)
+	ensure
+		objs.each { |obj|
+			obj.Release
+		}
+	end
+
 	def DetonateHresult(name, *args)
 		hresult = send(name, *args)
 		failed = FAILED(hresult)
@@ -18,7 +27,48 @@ module WindowsCOM
 		yield hresult if failed && block_given?
 	end
 
+	module FFIStructMemoryEquality
+		def ==(other)
+			WindowsCOM.windows_com_memcmp(self, other, self.size) == 0
+		end
+	end
+
+	module FFIStructAnonymousAccess
+		def [](k)
+			if members.include?(k)
+				super
+			elsif self[:_].members.include?(k)
+				self[:_][k]
+			else
+				self[:_][:_][k]
+			end
+		end
+
+		def []=(k, v)
+			if members.include?(k)
+				super
+			elsif self[:_].members.include?(k)
+				self[:_][k] = v
+			else
+				self[:_][:_][k] = v
+			end
+		end
+	end
+
+	# use with extend
+	module VariantBasicCreation
+		def [](type, field, val)
+			var = new
+
+			var[:vt] = type
+			var[field] = val
+
+			var
+		end
+	end
+
 	module_function \
+		:UsingCOMObjects,
 		:DetonateHresult
 
 	S_OK = 0
@@ -60,38 +110,39 @@ module WindowsCOM
 		:HRESULT_FROM_WIN32
 
 	class GUID < FFI::Struct
+		include FFIStructMemoryEquality
+
 		layout \
 			:Data1, :ulong,
 			:Data2, :ushort,
 			:Data3, :ushort,
 			:Data4, [:uchar, 8]
-	end
 
-	def GUIDFromString(str)
-		raise 'Bad GUID format' unless str =~ /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/i
+		def self.[](str)
+			raise 'Bad GUID format' unless str =~ /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/i
 
-		guid = GUID.new
+			guid = new
 
-		guid[:Data1] = str[0, 8].to_i(16)
-		guid[:Data2] = str[9, 4].to_i(16)
-		guid[:Data3] = str[14, 4].to_i(16)
-		guid[:Data4][0] = str[19, 2].to_i(16)
-		guid[:Data4][1] = str[21, 2].to_i(16)
-		str[24, 12].split('').each_slice(2).with_index { |a, i|
-			guid[:Data4][i + 2] = a.join('').to_i(16)
-		}
+			guid[:Data1] = str[0, 8].to_i(16)
+			guid[:Data2] = str[9, 4].to_i(16)
+			guid[:Data3] = str[14, 4].to_i(16)
+			guid[:Data4][0] = str[19, 2].to_i(16)
+			guid[:Data4][1] = str[21, 2].to_i(16)
+			str[24, 12].split('').each_slice(2).with_index { |a, i|
+				guid[:Data4][i + 2] = a.join('').to_i(16)
+			}
 
-		guid
-	end
+			guid
+		end
 
-	def GUIDEqual(guid1, guid2)
-		windows_com_memcmp(guid1, guid2, GUID.size) == 0
+		def to_s
+			format '%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X',
+				self[:Data1], self[:Data2], self[:Data3],
+				self[:Data4][0], self[:Data4][1],
+				self[:Data4][2], self[:Data4][3], self[:Data4][4], self[:Data4][5], self[:Data4][6], self[:Data4][7]
+		end
 	end
 
-	module_function \
-		:GUIDFromString,
-		:GUIDEqual
-
 	class COMVptr_ < FFI::Struct
 		layout \
 			:lpVtbl, :pointer
@@ -100,7 +151,7 @@ module WindowsCOM
 	module COMVtbl_
 		def self.[](parent_vtbl, spec)
 			spec.each { |name, sig|
-				sig[0].unshift(:pointer) # prepend *this* pointer
+				sig[0].unshift(:pointer) # prepend *this* pointer to FFI func signature
 			}
 
 			Class.new(FFI::Struct) {
@@ -124,10 +175,10 @@ module WindowsCOM
 		def self.[](vtbl, siid)
 			Class.new {
 				const_set :Vtbl, vtbl
-				const_set :IID, WindowsCOM::GUIDFromString(siid)
+				const_set :IID, WindowsCOM::GUID[siid]
 
 				def initialize(pointer)
-					@vptr = COMVptr_.new(pointer)
+					@vptr = WindowsCOM::COMVptr_.new(pointer)
 					@vtbl = self.class::Vtbl.new(@vptr[:lpVtbl])
 				end
 
@@ -158,11 +209,11 @@ module WindowsCOM
 	module COMFactory
 		def self.[](iface, sclsid)
 			Class.new(iface) {
-				const_set :CLSID, WindowsCOM::GUIDFromString(sclsid)
+				const_set :CLSID, WindowsCOM::GUID[sclsid]
 
-				def initialize(clsctx = CLSCTX_INPROC)
+				def initialize(clsctx = WindowsCOM::CLSCTX_INPROC)
 					FFI::MemoryPointer.new(:pointer) { |ppv|
-						DetonateHresult(:CoCreateInstance,
+						WindowsCOM::DetonateHresult(:CoCreateInstance,
 							self.class::CLSID, nil, clsctx, self.class::IID, ppv
 						)
 
@@ -172,4 +223,74 @@ module WindowsCOM
 			}
 		end
 	end
+
+	module COMCallback
+		def self.[](iface)
+			Class.new(iface) {
+				def initialize
+					@vtbl = self.class::Vtbl.new
+					@vtbl.members.each { |name|
+						@vtbl[name] = instance_variable_set("@__ffi_func__#{name}",
+							FFI::Function.new(*@vtbl.class::Spec[name].reverse, convention: :stdcall) { |*args|
+								__send__(name, *args[1..-1]) # remove *this* pointer from Ruby meth call
+							}
+						)
+					}
+
+					@vptr = WindowsCOM::COMVptr_.new
+					@vptr[:lpVtbl] = @vtbl
+
+					@refc = 0
+					AddRef()
+				end
+
+				attr_reader :refc
+
+				def QueryInterface(iid, ppv)
+					unless self.class::IID == iid || WindowsCOM::IUnknown::IID == iid
+						STDERR.puts "#{self}.#{__method__} called with unsupported interface id (IID: #{iid})" if $DEBUG
+
+						ppv.write_pointer(0)
+						return WindowsCOM::E_NOINTERFACE
+					end
+
+					ppv.write_pointer(@vptr)
+					AddRef()
+					WindowsCOM::S_OK
+				end
+
+				def AddRef
+					@refc += 1
+
+					STDERR.puts "#{self}.#{__method__} (@refc: #{@refc})" if
+						$DEBUG || WINDOWS_COM_TRACE_CALLBACK_REFCOUNT
+
+					@refc
+				end
+
+				def Release
+					@refc -= 1
+
+					STDERR.puts "#{self}.#{__method__} (@refc: #{@refc})" if
+						$DEBUG || WINDOWS_COM_TRACE_CALLBACK_REFCOUNT
+
+					if @refc == 0
+						@vtbl.pointer.free
+						@vptr.pointer.free
+
+						STDERR.puts "#{self} refcount is 0, #{@vtbl} and #{@vptr} freed" if
+							$DEBUG || WINDOWS_COM_TRACE_CALLBACK_REFCOUNT
+					end
+
+					@refc
+				end
+
+				(self::Vtbl.members - WindowsCOM::IUnknown::Vtbl.members).each { |name|
+					define_method(name) { |*args|
+						WindowsCOM::E_NOTIMPL
+					}
+				}
+			}
+		end
+	end
 end

data/lib/windows_com/ole.rb

@@ -1,6 +1,7 @@
 if __FILE__ == $0
 	require_relative 'common'
 	require_relative 'libc'
+	require_relative 'shlwapi'
 end
 
 module WindowsCOM
@@ -31,6 +32,8 @@ module WindowsCOM
 	attach_function :CoTaskMemFree, [:pointer], :void
 
 	class LARGE_INTEGER < FFI::Union
+		include FFIStructAnonymousAccess
+
 		layout \
 			:_, Class.new(FFI::Struct) {
 				layout \
@@ -42,6 +45,8 @@ module WindowsCOM
 	end
 
 	class ULARGE_INTEGER < FFI::Union
+		include FFIStructAnonymousAccess
+
 		layout \
 			:_, Class.new(FFI::Struct) {
 				layout \
@@ -134,6 +139,9 @@ module WindowsCOM
 	VT_TYPEMASK = 0xff
 
 	class VARIANT < FFI::Union
+		extend VariantBasicCreation
+		include FFIStructAnonymousAccess
+
 		layout \
 			:_, Class.new(FFI::Struct) {
 				layout \
@@ -200,12 +208,33 @@ module WindowsCOM
 	end
 
 	class PROPERTYKEY < FFI::Struct
+		include FFIStructMemoryEquality
+
 		layout \
 			:fmtid, GUID,
 			:pid, :ulong
+
+		def self.[](type, index)
+			propkey = new
+
+			propkey[:pid] = type
+
+			guid = propkey[:fmtid]
+			guid[:Data1] = 0x00000000 + index
+			guid[:Data2] = 0x7363
+			guid[:Data3] = 0x696e
+			[0x84, 0x41, 0x79, 0x8a, 0xcf, 0x5a, 0xeb, 0xb7].each_with_index { |part, i|
+				guid[:Data4][i] = part
+			}
+
+			propkey
+		end
 	end
 
 	class PROPVARIANT < FFI::Union
+		extend VariantBasicCreation
+		include FFIStructAnonymousAccess
+
 		layout \
 			:_, Class.new(FFI::Struct) {
 				layout \

data/lib/windows_com/oleaut.rb

@@ -1,6 +1,7 @@
 if __FILE__ == $0
 	require_relative 'common'
 	require_relative 'libc'
+	require_relative 'shlwapi'
 	require_relative 'ole'
 end
 
@@ -33,6 +34,8 @@ module WindowsCOM
 	attach_function :SafeArrayAccessData, [:pointer, :pointer], :long
 	attach_function :SafeArrayUnaccessData, [:pointer], :long
 
+	attach_function :VariantClear, [:pointer], :long
+
 	OLEIVERB_PRIMARY = 0
 	OLEIVERB_SHOW = -1
 	OLEIVERB_OPEN = -2

data/lib/windows_com/shlwapi.rb

@@ -0,0 +1,11 @@
+if __FILE__ == $0
+	require_relative 'common'
+	require_relative 'libc'
+end
+
+module WindowsCOM
+	ffi_lib 'shlwapi'
+	ffi_convention :stdcall
+
+	attach_function :SHStrDup, :SHStrDupW, [:string, :buffer_out], :long
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: windows_com
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Radoslav Peev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -35,12 +35,17 @@ files:
 - README.md
 - RELNOTES.md
 - examples/DesktopGadget.rbw
+- examples/UIRibbon/Command.dll
+- examples/UIRibbon/Command.rb
+- examples/UIRibbon/Command.rbw
+- examples/UIRibbon/Command.xml
 - lib/windows_com.rb
 - lib/windows_com/common.rb
-- lib/windows_com/cruft.rb
 - lib/windows_com/libc.rb
 - lib/windows_com/ole.rb
 - lib/windows_com/oleaut.rb
+- lib/windows_com/shlwapi.rb
+- screenshot.png
 homepage: https://github.com/rpeev/windows_com
 licenses:
 - MIT

data/lib/windows_com/cruft.rb

@@ -1,173 +0,0 @@
-__END__
-module COMHelpers
-  def QueryInstance(klass)
-    instance = nil
-
-    FFI::MemoryPointer.new(:pointer) { |ppv|
-      QueryInterface(klass::IID, ppv)
-
-      instance = klass.new(ppv.read_pointer)
-    }
-
-    begin
-      yield instance; return self
-    ensure
-      instance.Release
-    end if block_given?
-
-    instance
-  end
-
-  def UseInstance(klass, name, *args)
-    instance = nil
-
-    FFI::MemoryPointer.new(:pointer) { |ppv|
-      send(name, *args, klass::IID, ppv)
-
-      yield instance = klass.new(ppv.read_pointer)
-    }
-
-    self
-  ensure
-    instance.Release if instance
-  end
-end
-
-module COMCallback
-  def self.[](iface)
-    Class.new(FFI::Struct) {
-      send(:include, COMHelpers)
-
-      layout \
-        :lpVtbl, :pointer
-
-      def initialize(opts = {})
-        @vtbl, @refc = iface::VTBL.new, 1
-
-        @vtbl.members.each { |name|
-          @vtbl[name] = instance_variable_set("@fn#{name}",
-            FFI::Function.new(*@vtbl.class::SPEC[name].reverse, convention: :stdcall) { |*args|
-              send(name, *args[1..-1])
-            }
-          )
-        }
-
-        self[:lpVtbl] = @vtbl
-
-        begin
-          yield self
-        ensure
-          Release()
-        end if block_given?
-      end
-
-      attr_reader :vtbl, :refc
-
-      def QueryInterface(riid, ppv)
-        if [IUnknown::IID, iface::IID].any? { |iid| windows_com_memcmp(riid, iid, iid.size) == 0 }
-          ppv.write_pointer(self)
-        else
-          ppv.write_pointer(0); return E_NOINTERFACE
-        end
-
-        AddRef(); S_OK
-      end
-
-      def AddRef
-        @refc += 1
-      end
-
-      def Release
-        @refc -= 1
-      end
-
-      (iface::VTBL.members - IUnknown::VTBL.members).each { |name|
-        define_method(name) { |*args|
-          E_NOTIMPL
-        }
-      }
-    }
-  end
-end
-
-module AnonymousFFIStructSupport
-  def [](k)
-    if members.include?(k)
-      super
-    elsif self[:_].members.include?(k)
-      self[:_][k]
-    else
-      self[:_][:_][k]
-    end
-  end
-
-  def []=(k, v)
-    if members.include?(k)
-      super
-    elsif self[:_].members.include?(k)
-      self[:_][k] = v
-    else
-      self[:_][:_][k] = v
-    end
-  end
-end
-
-# PROPERTYKEY
-def self.[](type, index)
-  new.tap { |key|
-    key[:fmtid].tap { |guid|
-      guid[:Data1] = 0x00000000 + index
-      guid[:Data2] = 0x7363
-      guid[:Data3] = 0x696e
-      [0x84, 0x41, 0x79, 0x8a, 0xcf, 0x5a, 0xeb, 0xb7].each_with_index { |part, i|
-        guid[:Data4][i] = part
-      }
-    }
-
-    key[:pid] = type
-  }
-end
-
-# PROPVARIANT
-def ==(other) windows_com_memcmp(other, self, size) == 0 end
-
-def self.[](t, *v) new.tap { |var| var.send("#{t}=", *v) } end
-
-def bool; raise 'Wrong type tag.' unless self[:vt] == VT_BOOL; self[:boolVal] != 0 end
-def bool=(bool) self[:vt] = VT_BOOL; self[:boolVal] = (bool) ? -1 : 0 end
-
-def int; raise 'Wrong type tag.' unless self[:vt] == VT_I4; self[:intVal] end
-def int=(int) self[:vt] = VT_I4; self[:intVal] = int end
-
-def uint; raise 'Wrong type tag.' unless self[:vt] == VT_UI4; self[:uintVal] end
-def uint=(uint) self[:vt] = VT_UI4; self[:uintVal] = uint end
-
-def unknown
-  raise 'Wrong type tag.' unless self[:vt] == VT_UNKNOWN
-
-  yield Unknown.new(self[:punkVal])
-ensure
-  Windows.PropVariantClear(self)
-end
-
-def unknown=(unknown) self[:vt] = VT_UNKNOWN; self[:punkVal] = unknown.pointer; unknown.AddRef end
-
-def wstring; raise 'Wrong type tag.' unless self[:vt] == VT_LPWSTR; Windows.WCSTOMBS(self[:pwszVal]) end
-
-def wstring=(string)
-  self[:vt] = VT_LPWSTR
-
-  FFI::MemoryPointer.new(:pointer) { |p|
-    Windows.DetonateHresult(:SHStrDup, string, p)
-
-    self[:pwszVal] = p.read_pointer
-  }
-end
-
-def decimal
-  raise 'Wrong type tag.' unless self[:vt] == VT_DECIMAL
-
-  Rational(self[:decVal][:Lo64], 10 ** self[:decVal][:scale]) + self[:decVal][:Hi32]
-end
-
-def decimal=(decimal) self[:vt] = VT_DECIMAL; self[:decVal][:Lo64] = decimal end