windows_gui 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70fd00b9f6b9731a32b4c777939230d8c975249a
-  data.tar.gz: 160a0a77b51fe4e98cbf95b22ae193d2ce637d45
+  metadata.gz: 6ec23607fe3529f755af6166bb29d24030adca1d
+  data.tar.gz: bfd01485c8c783919aedb5f32d25f1e1197d7a19
 SHA512:
-  metadata.gz: e0cfb247bd7fcfe942633222d5e5cb692dec09642adefa521f7e0c5c3ff7ff4945fdbfae4d9b1b605e1633ceb7a362fac343160c2da5ec180d2bd83df1c931b6
-  data.tar.gz: 2e1ec3665a659957201ab32213661b77a399e79c0c05f607d54336daa8702d2842c809d84fab5f70e0a68a91b2011f94e8512cf1cb04572dbcf4fcd789003ce6
+  metadata.gz: e791e779aa10e363f028acec6d8d2e6344649ed715b2ff5cb3f1045a18850fae0e2a0f26bedf7aef7c75d180bb68fc4bf8df18875c74dcfd30554428c2eda363
+  data.tar.gz: 628ac854859fb18eb80586fb0c788a377d09a8510d05625892aec071672f0ecfa81c6fa243c209bcf1b1243290c132f545962aff63e6ed7f780266cc1bc41fe0

data/README.md

@@ -10,4 +10,4 @@ gem install windows_gui
 
 ## Use
 
-See examples folder
+See examples folder (the UIRibbon example requires windows_com gem)

data/RELNOTES.md

@@ -1,5 +1,9 @@
 # Release Notes
 
+## 4.2.0
+
+Add crude mechanism for building UIRibbon resources on the fly (requires devenv)
+
 ## 4.1.0
 
 Add UIRibbon FFI bindings plus example (requires windows_com gem)

data/examples/UIRibbon/Command.rb

@@ -28,3 +28,7 @@ CmdButton1_SmallImages_RESID = 60019
 CmdButton1_SmallImages_120__RESID = 60020
 CmdButton1_LargeImages_RESID = 60021
 CmdButton1_LargeImages_120__RESID = 60022
+CmdAOT = 8
+CmdAOT_LabelTitle_RESID = 60023
+CmdAOT_LabelDescription_RESID = 60024
+CmdAOT_TooltipDescription_RESID = 60025

data/examples/UIRibbon/Command.rbw

@@ -1,7 +1,8 @@
 #WINDOWS_COM_TRACE_CALLBACK_REFCOUNT = true
+#WINDOWS_COM_TRACE_CALL_ARGS = true
 
 require 'windows_gui'
-require 'windows_gui/uiribbon' # requires windows_com gem
+require 'windows_gui/uiribbon'
 
 include WindowsGUI
 include UIRibbon
@@ -25,6 +26,16 @@ class UICH < IUICommandHandlerImpl
 
 	attr_reader :uif
 
+	def OnAOT(*args)
+		UsingFFIStructs(PROPVARIANT.new) { |v|
+			uif.GetUICommandProperty(CmdAOT, UI_PKEY_BooleanValue, v)
+
+			SetWindowPos(uif.hwnd,
+				(v[:boolVal] == -1) ? HWND_TOPMOST : HWND_NOTOPMOST, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE
+			)
+		}
+	end
+
 	def OnItem1(*args)
 		MessageBox(uif.hwnd,
 			L("#{self}.#{__method__}"),
@@ -49,6 +60,8 @@ class UICH < IUICommandHandlerImpl
 
 	def Execute(*args)
 		case args[0]
+		when CmdAOT
+			OnAOT(*args)
 		when CmdItem1
 			OnItem1(*args)
 		when CmdButton1
@@ -86,12 +99,18 @@ def OnCreate(hwnd,
 )
 	xtra = Id2Ref[GetWindowLong(hwnd, GWL_USERDATA)]
 
+	UIResources.Build(clean: true) if UIResources.BuildNeeded?()
+
 	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'))
+	xtra[:uif].Initialize(hwnd, xtra[:uia])
+	xtra[:uif].LoadUI(UIResources.Load(), L('APPLICATION_RIBBON'))
+
+	UsingFFIStructs(PROPVARIANT[VT_BOOL, :boolVal, -1]) { |v|
+		xtra[:uif].SetUICommandProperty(CmdAOT, UI_PKEY_BooleanValue, v)
+	}
 
 	0
 end
@@ -178,6 +197,7 @@ def WinMain
 	exit(0) if hwnd.null?
 
 	ShowWindow(hwnd, SW_SHOWNORMAL)
+	SetWindowPos(hwnd, HWND_TOPMOST, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE)
 	UpdateWindow(hwnd)
 
 	UsingFFIStructs(MSG.new) { |msg|

data/examples/UIRibbon/Command.xml

@@ -8,35 +8,38 @@
 <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>
+			<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>
+			<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>
+		<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>
+		<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>
+		<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>
+		<Image>../res/go-next.bmp</Image>
+		<Image MinDPI='120'>../res/go-next-big.bmp</Image>
 	</Command.LargeImages>
+</Command>
+
+<Command Name='cmdAOT' LabelTitle='&amp;Always On Top' LabelDescription='LabelDescription...' TooltipDescription='TooltipDescription...'>
 </Command>
 	</Application.Commands>
 
@@ -53,6 +56,7 @@
 			<Ribbon.QuickAccessToolbar>
 <QuickAccessToolbar CommandName='cmdQAT'>
 	<QuickAccessToolbar.ApplicationDefaults>
+		<CheckBox CommandName='cmdAOT' />
 		<Button CommandName='cmdItem1' />
 		<Button CommandName='cmdButton1' />
 	</QuickAccessToolbar.ApplicationDefaults>

data/lib/windows_gui/common.rb

@@ -1,7 +1,7 @@
 require 'weakref'
 require 'ffi'
 
-WINDOWS_GUI_VERSION = '4.1.0'
+WINDOWS_GUI_VERSION = '4.2.0'
 
 WINDOWS_GUI_VISUAL_STYLES = true unless defined?(WINDOWS_GUI_VISUAL_STYLES)
 WINDOWS_GUI_DPI_AWARE = true unless defined?(WINDOWS_GUI_DPI_AWARE)

data/lib/windows_gui/uiribbon.rb

@@ -12,31 +12,107 @@ module WindowsGUI
 	module UIRibbon
 		include WindowsCOM
 
-		def LoadUIDll(name = File.basename($0, '.rbw'))
-			path = File.dirname(File.expand_path($0))
-			dll_path = "#{path}/#{name}.dll"
+		module UIResources
+			def BuildNeeded?(opts = {})
+				opts[:name] ||= File.basename($0, '.rbw')
 
-			# pull in generated UIRibbon constants
-			require "#{path}/#{name}"
+				path = File.dirname(File.expand_path($0))
 
-			# load UIRibbon dll
-			hdll = DetonateLastError(FFI::Pointer::NULL, :LoadLibrary,
-				L(dll_path.dup)
-			)
+				dll_path = "#{path}/#{opts[:name]}.dll"
+				xml_path = "#{path}/#{opts[:name]}.xml"
 
-			STDERR.puts "#{dll_path} loaded (hdll: #{hdll})" if $DEBUG
+				yeah = !File.exist?(dll_path) || (
+					File.exist?(xml_path) &&
+					test(?M, xml_path) > test(?M, dll_path)
+				)
 
-			at_exit {
-				FreeLibrary(hdll)
+				STDERR.puts "UIRibbon resources build needed" if yeah
 
-				STDERR.puts "#{dll_path} unloaded" if $DEBUG
-			}
+				yeah
+			end
 
-			hdll
-		end
+			def Build(opts = {})
+				opts[:name] ||= File.basename($0, '.rbw')
 
-		module_function \
-			:LoadUIDll
+				path = File.dirname(File.expand_path($0))
+
+				xml_path = "#{path}/#{opts[:name]}.xml"
+				rb_path = "#{path}/#{opts[:name]}.rb"
+				dll_path = "#{path}/#{opts[:name]}.dll"
+				log_path = "#{path}/#{opts[:name]}.log"
+
+				opts[:sdkroot] ||= "#{ENV['ProgramFiles']}/Windows Kits/10"
+				opts[:vcroot] ||= "#{ENV['ProgramFiles']}/Microsoft Visual Studio 14.0/VC"
+
+				opts[:uicc] ||= "#{opts[:sdkroot]}/bin/x86/uicc.exe"
+				opts[:rc] ||= "#{opts[:sdkroot]}/bin/x86/rc.exe"
+				opts[:vcvars] ||= "#{opts[:vcroot]}/bin/vcvars32.bat"
+				opts[:link] ||= "#{opts[:vcroot]}/bin/link.exe"
+
+				raise 'Building the UIRibbon resources requires Windows SDK and VC' unless
+					[:uicc, :rc, :vcvars, :link].all? { |tool| File.exist?(opts[tool]) }
+
+				STDERR.puts "UIRibbon resources build toolchain OK"
+
+				File.delete(log_path) if File.exist?(log_path)
+
+				system <<-CMD
+@echo off && \
+"#{opts[:uicc]}" "#{opts[:name]}.xml" "#{opts[:name]}.bml" /header:"#{opts[:name]}.h" /res:"#{opts[:name]}.rc" > "#{opts[:name]}.log" && \
+"#{opts[:rc]}" /nologo /fo"#{ENV['TEMP']}/#{opts[:name]}.res" "#{opts[:name]}.rc" >> "#{opts[:name]}.log" && \
+call "#{opts[:vcvars]}" >> "#{opts[:name]}.log" && \
+"#{opts[:link]}" /nologo /machine:x86 /dll /noentry /out:"#{opts[:name]}.dll" "#{ENV['TEMP']}/#{opts[:name]}.res" >> "#{opts[:name]}.log"
+				CMD
+
+				raise "UIRibbon resources build FAILED - see #{log_path} for details" if
+					File.read(log_path) =~ /error/im
+
+				File.open(rb_path, 'w') { |rb|
+					rb.puts "# Generated by the UIRibbon build, do NOT modify\n\n"
+
+					File.foreach("#{path}/#{opts[:name]}.h") { |line|
+						rb.puts "#{$1[0].upcase}#{$1[1..-1]} = #{$2}" if line =~ /^\s*#define\s+(\w+)\s+(\d+)/
+					}
+				}
+
+				%w{bml h rc}.each { |ext|
+					File.delete("#{path}/#{opts[:name]}.#{ext}") if File.exist?("#{path}/#{opts[:name]}.#{ext}")
+				} if opts[:clean]
+
+				STDERR.puts "UIRibbon resources build succeeded"
+			end
+
+			def Load(opts = {})
+				opts[:name] ||= File.basename($0, '.rbw')
+
+				path = File.dirname(File.expand_path($0))
+
+				dll_path = "#{path}/#{opts[:name]}.dll"
+
+				# pull in generated UIRibbon constants
+				require "#{path}/#{opts[:name]}"
+
+				# load UIRibbon dll
+				hdll = DetonateLastError(FFI::Pointer::NULL, :LoadLibrary,
+					L(dll_path.dup)
+				)
+
+				STDERR.puts "#{dll_path} loaded (hdll: #{hdll})" if $DEBUG
+
+				at_exit {
+					FreeLibrary(hdll)
+
+					STDERR.puts "#{dll_path} unloaded" if $DEBUG
+				}
+
+				hdll
+			end
+
+			module_function \
+				:BuildNeeded?,
+				:Build,
+				:Load
+		end
 
 		UI_PKEY_Enabled = PROPERTYKEY[VT_BOOL, 1]
 		UI_PKEY_LabelDescription = PROPERTYKEY[VT_LPWSTR, 2]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: windows_gui
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Radoslav Peev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -57,6 +57,12 @@ files:
 - examples/Version.rbw
 - examples/WndExtra.rbw
 - examples/res/face-devilish.bmp
+- examples/res/go-next-big.bmp
+- examples/res/go-next-small.bmp
+- examples/res/go-next.bmp
+- examples/res/go-previous-big.bmp
+- examples/res/go-previous-small.bmp
+- examples/res/go-previous.bmp
 - lib/windows_gui.rb
 - lib/windows_gui/common.rb
 - lib/windows_gui/gdi.rb