vrvirtualdesktop 0.0.1

data/lib/Win32/User32.rb

@@ -0,0 +1,142 @@
+#
+# This module contains information allowing the user to call
+# functions defined in User32.dll
+#
+
+require "dl"
+require "Win32API"
+
+module Win32
+# Constants 
+
+NULL = 0
+SW_HIDE = 0
+SW_SHOWNORMAL =      1
+SW_NORMAL =          1
+SW_SHOWMINIMIZED =   2
+SW_SHOWMAXIMIZED =   3
+SW_MAXIMIZE =        3
+SW_SHOWNOACTIVATE =  4
+SW_SHOW =            5
+SW_MINIMIZE =        6
+SW_SHOWMINNOACTIVE = 7
+SW_SHOWNA =          8
+SW_RESTORE =         9
+SW_SHOWDEFAULT =     10
+SW_FORCEMINIMIZE =   11
+SW_MAX =             11
+
+GWL_WNDPROC =       (-4)
+GWL_HINSTANCE =     (-6)
+GWL_HWNDPARENT =    (-8)
+GWL_STYLE =         (-16)
+GWL_EXSTYLE =       (-20)
+GWL_USERDATA =      (-21)
+GWL_ID =            (-12)
+
+WS_OVERLAPPED =     0x00000000
+WS_POPUP =          0x80000000
+WS_CHILD =          0x40000000
+WS_MINIMIZE =       0x20000000
+WS_VISIBLE =        0x10000000
+WS_DISABLED =       0x08000000
+WS_CLIPSIBLINGS =   0x04000000
+WS_CLIPCHILDREN =   0x02000000
+WS_MAXIMIZE =       0x01000000
+WS_CAPTION =        0x00C00000     #/* WS_BORDER | WS_DLGFRAME =*/
+WS_BORDER =         0x00800000
+WS_DLGFRAME =       0x00400000
+WS_VSCROLL =        0x00200000
+WS_HSCROLL =        0x00100000
+WS_SYSMENU =        0x00080000
+WS_THICKFRAME =     0x00040000
+WS_GROUP =          0x00020000
+WS_TABSTOP =        0x00010000
+
+WS_MINIMIZEBOX =    0x00020000
+WS_MAXIMIZEBOX =    0x00010000
+
+
+WS_TILED =          WS_OVERLAPPED
+WS_ICONIC =         WS_MINIMIZE
+WS_SIZEBOX =        WS_THICKFRAME
+
+#
+# Common Window Styles
+#
+WS_OVERLAPPEDWINDOW = (WS_OVERLAPPED     | 
+                             WS_CAPTION        | 
+                             WS_SYSMENU        | 
+                             WS_THICKFRAME     |
+                             WS_MINIMIZEBOX    |
+                             WS_MAXIMIZEBOX)
+
+WS_POPUPWINDOW =    (WS_POPUP          |
+                             WS_BORDER         |
+                             WS_SYSMENU)
+
+WS_CHILDWINDOW =    (WS_CHILD)
+
+WS_TILEDWINDOW =    WS_OVERLAPPEDWINDOW
+
+#
+# Extended Window Styles
+#
+WS_EX_DLGMODALFRAME =   0x00000001
+WS_EX_NOPARENTNOTIFY =  0x00000004
+WS_EX_TOPMOST =         0x00000008
+WS_EX_ACCEPTFILES =     0x00000010
+WS_EX_TRANSPARENT =     0x00000020
+
+WS_EX_MDICHILD =        0x00000040
+WS_EX_TOOLWINDOW =      0x00000080
+WS_EX_WINDOWEDGE =      0x00000100
+WS_EX_CLIENTEDGE =      0x00000200
+WS_EX_CONTEXTHELP =     0x00000400
+
+WS_EX_RIGHT =           0x00001000
+WS_EX_LEFT =            0x00000000
+WS_EX_RTLREADING =      0x00002000
+WS_EX_LTRREADING =      0x00000000
+WS_EX_LEFTSCROLLBAR =   0x00004000
+WS_EX_RIGHTSCROLLBAR =  0x00000000
+
+WS_EX_CONTROLPARENT =   0x00010000
+WS_EX_STATICEDGE =      0x00020000
+WS_EX_APPWINDOW =       0x00040000
+
+WS_EX_OVERLAPPEDWINDOW =(WS_EX_WINDOWEDGE | WS_EX_CLIENTEDGE)
+WS_EX_PALETTEWINDOW =   (WS_EX_WINDOWEDGE | WS_EX_TOOLWINDOW | WS_EX_TOPMOST)
+
+#
+# GetWindow() Constants
+#
+GW_HWNDFIRST =      0
+GW_HWNDLAST =       1
+GW_HWNDNEXT =       2
+GW_HWNDPREV =       3
+GW_OWNER =          4
+GW_CHILD =          5
+GW_ENABLEDPOPUP =   6
+GW_MAX =            6
+
+# Functions
+
+User32 = DL.dlopen("user32")
+EnumWindows = User32['EnumWindows', 'IPL']
+PostMessage = User32['PostMessage', 'ILILL']
+GetClassName = User32['GetClassName', 'ILpI']
+FindWindowEx = User32["FindWindowEx", "IIIPP"]
+RegisterWindowMessage = User32["RegisterWindowMessage", "IP"]
+SendMessage = User32["SendMessage", "IIIII"]
+ShowWindow = User32["ShowWindow", "III"]
+GetWindowLong = User32["GetWindowLong", "III"]
+GetWindow = User32["GetWindow", "III"]
+GetTopWindow = User32["GetTopWindow", "II"]
+IsIconic = User32["IsIconic", "II"]
+
+GetWindowLong_2 = Win32API.new("user32","GetWindowLong", ["I","I"],"I")
+GetWindow_2 = Win32API.new("user32","GetWindow", ["I","I"],"I")
+GetClassName_2 = Win32API.new("user32", "GetClassName", ["I", "P", "I"], "I")
+
+end # module Win32

data/lib/Win32/VirtualDesktop.rb

@@ -0,0 +1,418 @@
+require "rubygems"
+require_gem "SimpleTrace", "< 0.1.0"
+require "yaml"
+require "Win32API"
+require_gem "VRTools", "< 0.1.0"
+require "vr/vrdialog"
+
+module Win32
+
+#
+# A virtual desktop consists of a set of windows on it, a name, a numbered icon and whether it is active
+# or not
+#
+class VirtualDesktop
+	attr_reader :icon_id, :name, :index, :windows
+	attr_accessor :active
+	attr_accessor :form
+
+	class SetScreenName < VRModalDialog
+		#include AddControlFont
+		include VRCenterFeasible
+		include VRLayout
+		include VRKey_CREscFeasible
+		
+		attr_reader :name
+
+		DEFAULT_FONT = VRLocalScreen.factory.newfont("Arial",14)
+		
+		LABEL_H = 20
+		LABEL_W = 100
+		EDIT_H = 20
+		EDIT_W = 100
+		BUTTON_W = 70
+		BUTTON_H = 25
+		
+		def exinit(name)
+			@name = name
+			self
+		end
+		
+		def construct
+			self.caption = "Set Desktop Name"
+			v_frame = Layout::VertLayoutFrame.new(nil,{Layout::SPACING=>10}) do |vf|
+				# For the date input
+				Layout::HorzLayoutFrame.new(vf, {Layout::SPACING=>5}) do |hf|
+					hf.addcontrol(self, Layout::Dimensions.new(LABEL_W,LABEL_H), VRStatic, "static", "Screen Name:", 0)
+					hf.addcontrol(self, Layout::Dimensions.new(EDIT_W,EDIT_H), VREdit, "name_edit", @name, WStyle::WS_TABSTOP)
+				end
+				
+				Layout::HorzLayoutFrame.new(vf, {Layout::SPACING=>5}) do |hf|
+					hf.addcontrol(self, Layout::Dimensions.new(BUTTON_W,BUTTON_H), VRButton, "okbutton", "Ok", WStyle::WS_TABSTOP)
+					hf.addcontrol(self, Layout::Dimensions.new(BUTTON_W,BUTTON_H), VRButton, "cancelbutton", "Cancel", WStyle::WS_TABSTOP)
+				end
+			end
+			
+			v_frame.layout(0,0, v_frame.dimensions.min_width, v_frame.dimensions.min_height)
+
+			@name_edit.text = @name
+			
+			if self.kind_of?(VRDialogComponent) then
+				setButtonAs(@okbutton, VRDialogComponent::IDOK)
+				setButtonAs(@cancelbutton, VRDialogComponent::IDCANCEL)
+			end
+			
+			w, h = self.set_client_size(v_frame, v_frame.dimensions.min_width, v_frame.dimensions.min_height, 10)
+			center(@creator, w, h)
+		end
+
+		def okbutton_clicked
+			@name = @name_edit.text
+			self.close(VRDialogComponent::IDOK)
+		end
+
+		def cancelbutton_clicked
+			self.close(VRDialogComponent::IDCANCEL)
+		end
+	end
+
+
+	class << self
+		# create is here to allow another program to 
+		# change how virtual desktops are created (use an object
+		# loaded off of disk instead of a freshly created one
+		def create(*args)
+			VirtualDesktop.new(*args)
+		end
+	end
+		
+	def initialize(virtual_desktops, up_icon_filename, down_icon_filename, icon_id, name, index, active, window_manager)
+		@virtual_desktops ||= virtual_desktops
+		@up_icon ||= VRLocalScreen.factory.iconfromfile(up_icon_filename)
+		@down_icon ||= VRLocalScreen.factory.iconfromfile(down_icon_filename)
+		@icon_id ||= icon_id
+		@name ||= name
+		@index ||= index
+		@windows ||= []
+		@active ||= active
+		@form ||= nil
+		@windows ||= []
+		@window_manager ||= window_manager
+	end
+
+	def icon
+		if @active then
+			@down_icon
+		else
+			@up_icon
+		end
+	end
+
+	def modify_trayicon
+		form.modify_trayicon(icon.hicon, @name, @icon_id)	
+	end
+
+	def create_trayicon
+		form.create_trayicon(icon.hicon, @name, @icon_id)
+	end
+
+	def delete_trayicon
+		form.delete_trayicon(@icon_id)
+	end
+	
+	def active=(activate)
+		# if we are becoming active
+		if (activate && !@active) then
+			$TRACE.debug 5, "desktop '#{@name}' becoming active"
+			@windows.each do |window|
+				$TRACE.debug 5, "activating window #{window}"
+				window.show
+			end
+		# if we are becoming inactive
+		elsif (@active && !activate) then
+			$TRACE.debug 5, "desktop '#{@name}' becoming inactive"
+			@windows.each do |window|
+				$TRACE.debug 5, "deactivating window #{window}"
+				window.hide
+			end
+		end
+		
+		@active = activate
+		modify_trayicon
+	end
+
+	def add_window(window)
+		@virtual_desktops.add_window(window)
+		@windows.push(window)
+		$TRACE.debug 5, "adding window #{window}"
+		$TRACE.debug 5, "after add windows = #{@windows.map{|w| w.to_s}.join(',')}"
+	end
+
+	def remove_window(window)
+		@windows.delete_if {|x| x.hwnd == window.hwnd}
+		$TRACE.debug 5, "removing window #{window}"
+		$TRACE.debug 5, "after remove windows = #{@windows.map{|w| w.to_s}.join(',')}"
+	end
+
+	def handle_exit
+		@windows.each {|window| window.show}
+	end
+
+	def set_screen_name
+		set_screen_name_form = VRLocalScreen.newdialog(@mainForm,nil,SetScreenName)
+    	returnResult = set_screen_name_form.exinit(@name).open nil,true
+
+    	if returnResult == VRDialogComponent::IDOK then
+    		@name = set_screen_name_form.name
+    		modify_trayicon
+    	end
+	end
+
+	def contains_window(window)
+		@windows.index(window)
+	end
+	
+	def to_s
+		"#{name}: windows = " + @windows.map{|w| w.to_s}.join(",")		
+	end
+
+	class SaveInfo
+		attr_reader :window_handles, :name
+		def initialize(window_handles, name)
+			@window_handles = window_handles
+			@name = name
+		end
+		
+	end
+	
+	# 
+	# the info that we save for this desktop is just an array of window handles of 
+	# the windows on this desktop
+	#
+	def save_info
+		SaveInfo.new(@windows.map{|w| w.hwnd}, @name)
+	end
+
+	#
+	# when restoring those windows, find the window associated with the stored window handle
+	# and add it to the desktop and show it if we are active
+	#
+	def restore_info(save_info)
+		window_handles = save_info.window_handles
+
+		# add in the windows		
+		$TRACE.debug 5, "window_handles = #{window_handles.inspect}"
+		all_windows = @window_manager.get_all_windows(true).values
+		$TRACE.debug 5, "all-windows = " + all_windows.map{|w| w.to_s}.join(",")
+		window_handles.each do |hwnd|
+			window = all_windows.select{|w| w.hwnd == hwnd}[0]
+			if window then
+				$TRACE.debug 5, "found window = #{window}"
+				add_window(window)
+				if @active then
+					window.show
+				else
+					window.hide
+				end
+			end
+		end
+
+		# modify the tray icon name
+		@name = save_info.name
+		modify_trayicon
+	end
+end
+
+#
+# This class holds the array of virtual desktops
+# 
+class VirtualDesktops < Array
+	attr_reader :active_desktop_index
+
+	class << self
+		# create is here to allow another program to 
+		# change how virtual desktops are created (use an object
+		# loaded off of disk instead of a freshly created one
+		def create(*args)
+			VirtualDesktops.new(*args)
+		end
+	end
+	
+	NUM_NAMES = ["one", "two", "three", "four", "five", "six", "seven", "eight"]
+	def initialize(form, dir_base, icon_id_base, num_desktops, window_manager, *args)
+		super(*args)
+		@form ||= form
+		@active_desktop_index ||= 0
+		@window_manager ||= window_manager
+		@last_windows ||= get_all_windows
+		@all_windows ||= []
+		
+		NUM_NAMES.each_with_index do |number, index|
+			icon_base = dir_base + "/" + number
+			self.push(VirtualDesktop.create(self, icon_base + "_up.ico", icon_base + "_down.ico", icon_id_base+index, "Screen #{index+1}", index, index == 0, window_manager))
+			break if index+1 >= num_desktops
+		end
+	end
+
+	def push(virtual_desktop)
+		super(virtual_desktop)
+		virtual_desktop.form = @form
+	end
+
+	def active_desktop_index=(desktop_num)
+		self[@active_desktop_index].active = false
+		@active_desktop_index = desktop_num
+		self[desktop_num].active = true
+		@last_windows = get_all_windows
+	end
+
+	def active_desktop
+		self[@active_desktop_index]
+	end
+	
+	def change_desktop(icon_id)
+		clicked_desktop = self.select{|s| s.icon_id == icon_id}[0]
+		$TRACE.debug 5, "change_desktop: #{icon_id} -> #{clicked_desktop} ? #{@active_desktop_index}"
+		if clicked_desktop.index != @active_desktop_index then
+			$TRACE.debug 5, "changing desktops"
+			self.active_desktop_index = clicked_desktop.index
+
+			# save the changed state
+			save
+		end						
+	end
+
+	def move_window(icon_id)
+		# if the clicked desktop is not the active desktop then
+		clicked_desktop = self.select{|s| s.icon_id == icon_id}[0]
+		if clicked_desktop.index != @active_desktop_index then
+			# get top window object
+			windows = @window_manager.get_all_windows
+			top_window_hwnd = @window_manager.get_top_window(windows)
+			top_window = windows[top_window_hwnd]
+
+			# move it from the active to the clicked desktop
+			self[@active_desktop_index].remove_window(top_window)
+			self[clicked_desktop.index].add_window(top_window)
+
+			# and now hide it
+			top_window.hide
+
+			# save the changed state
+			save
+		end
+	end
+
+	def add_window(window)
+		@all_windows.push(window) unless @all_windows.index(window)
+	end
+	
+	def create_trayicons
+		self.reverse.each do |desktop|
+			desktop.create_trayicon
+		end
+	end
+
+	def delete_trayicons
+		self.each do |desktop|
+			desktop.delete_trayicon
+		end
+	end
+
+	def get_all_windows
+		# select all non-tooltip windows
+		@window_manager.get_all_windows.values.select do |w| 
+			!/tooltips/.match(w.class_name)
+		end
+	end
+
+	def contains_window(window)
+		self.each do |virtual_desktop|
+			if virtual_desktop.contains_window(window) then
+				return true
+			end
+		end
+
+		return false
+	end
+	
+	#
+	# this needs to be called periodically (< 1sec) to detect 
+	# windows that are being closed or opened
+	#
+	def periodic_timer
+		current_windows = get_all_windows
+		added_windows =  current_windows - @last_windows
+		removed_windows = @last_windows - current_windows
+		
+		$TRACE.debug 7, "cur  windows = " + current_windows.map{|w|w.hwnd}.join(",")
+		$TRACE.debug 7, "last windows = " + @last_windows.map{|w|w.hwnd}.join(",")
+		$TRACE.debug 7, "added_windows = " + added_windows.map{|w|"#{w.hwnd}-#{w.class_name}"}.join(",")
+		$TRACE.debug 7, "removed_windows = " + removed_windows.map{|w|"#{w.hwnd}-#{w.class_name}"}.join(",")
+
+		active_desktop = self[@active_desktop_index]
+		added_windows.each do |window|
+			active_desktop.add_window(window)
+		end
+		removed_windows.each do |window|
+			active_desktop.remove_window(window)
+		end
+
+		# save the state if there were any modifications
+		if added_windows.size > 0 || removed_windows.size > 0 then
+			save
+		end
+		
+		@last_windows = current_windows
+	end
+
+	def set_screen_name
+		self[@active_desktop_index].set_screen_name
+	end
+	
+	def save_info
+		virtual_desktops = []
+		self.each do |vd|
+			virtual_desktops.push(vd.save_info)
+		end
+		virtual_desktops
+	end
+
+	def restore_info(virtual_desktop_infos)
+		self.each_with_index do |virtual_desktop, i|
+			virtual_desktop.restore_info(virtual_desktop_infos[i])
+		end
+	end
+
+	class Configuration
+		attr_reader :save_info
+		def initialize(save_info)
+			@name = "Virtual Desktop Configuration File"
+			@version = "1.0"
+			@save_info = save_info
+		end
+	end
+	
+	def save
+		File.open("c:/vtdesk.txt", "w") do |f|
+			f.write(Configuration.new(self.save_info).to_yaml)
+		end
+	end
+
+	def restore
+		configuration = nil
+		File.open("c:/vtdesk.txt", "r") do |f|
+			configuration = YAML::load(f)
+		end
+
+		restore_info(configuration.save_info)
+	end
+
+	def handle_exit
+		self.each do |desktop|
+			desktop.handle_exit
+		end
+	end
+end
+
+end # module Win32