wmctile 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9474c678206339ee6e362df09689aef832d39fe3
-  data.tar.gz: 6a044f9a0bf34619394dc6b34e3cece57b8ecfcf
+  metadata.gz: d4216479b45b21cb886179229cc5575b55b3fe1f
+  data.tar.gz: fb6b1145637252d54ba0620ed27ee10bc94dd206
 SHA512:
-  metadata.gz: 2ed77ce751f458f2fbca1de12acfaf3a4042c85a5bf548c7030ba95c925f13a6daa072c54a5b039c5d3df8a208110530063e99154f371a7553fb8baa80231499
-  data.tar.gz: 72909e8e7b1fb0ad795f6fd77b4e2f92c8631b51031138d675319f976df95561d7ae3bc571c6af35eda59474d6dfa43f2c36e991835479cd425afe3c1828bfa6
+  metadata.gz: 58ecfd20728f51d591d0b13d241046acae6bf1047ec37b9feb9158ae9275299a6506cfb1b76d9e6785d5be361a43328caed81a31e1eee8b6d6596048c4f77691
+  data.tar.gz: 5d981b8f5400b7fb1762e69797d33e764135a6052074db3073c96e7acd12626fa7ecfb988152a13ed0e8e5ce0959c85c9568fdb5d3cda9b5be98e047c19d0009

data/bin/wmctile

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require_relative '../lib/wmctile'
+
+router = Wmctile::Router.new
+router.dispatch ARGV

data/lib/wmctile/class.rb

@@ -0,0 +1,13 @@
+class Wmctile::Class
+	def cmd cmd
+		# [0..-2] to strip the last \n
+		`#{ cmd }`[0..-2]
+	end
+	def notify title, string, icon = nil
+		if icon
+			system "notify-send -i '#{ icon }' '#{title}' '#{string}'"
+		else	
+			system "notify-send '#{title}' '#{string}'"
+		end
+	end
+end

data/lib/wmctile/class_with_dmenu.rb

@@ -0,0 +1,24 @@
+require 'dmenu'
+
+class Wmctile::ClassWithDmenu < Wmctile::Class
+	def dmenu items
+		a = Dmenu.new
+		# override defaults
+		a.background = '#242424'
+		a.case_insensitive = true
+		a.font = 'Ubuntu Mono-12'
+		a.foreground = 'white'
+		a.lines = 10
+		a.position = :bottom
+		a.selected_background = '#2e557e'
+		# set items
+		a.items = items
+		# run
+		b = a.run()
+		if b.is_a? Dmenu::Item
+			return b.value
+		else
+			return b
+		end
+	end
+end

data/lib/wmctile/memory.rb

@@ -0,0 +1,64 @@
+require 'yaml'
+
+class Wmctile::Memory < Wmctile::Class
+	##################################
+	## init ##########################
+	##################################
+	def initialize
+		@path = File.expand_path '~/.config/wmctile/wmctile-memory.yml'
+		if not File.exist? @path
+			raw_memory = self.create_new_memory
+		end
+		raw_memory ||= File.read @path
+		@memory = YAML.load(raw_memory)
+	end
+	def create_new_memory
+		dir_path = @path[/(.*)\/wmctile-memory.yml/, 1]
+		if not Dir.exists? dir_path
+			Dir.mkdir dir_path
+		end
+		out_file = File.new @path, 'w'
+		# 20 workspaces should suffice
+		20.times do |i|
+			out_file.puts "#{i}:"
+		end
+		out_file.close
+	end
+	def write_memory
+		out_file = File.new @path, 'w'
+		out_file.puts @memory.to_yaml
+		out_file.close
+	end
+	##################################
+	## getters/setters ###############
+	##################################
+	def get workspace = 0, key = nil, key_sub = nil
+		begin
+			a = @memory[workspace]
+			if key.nil?
+				return nil
+			else
+				a = a[key]
+				if key_sub.nil?
+					return a
+				else
+					return a[key_sub]
+				end
+			end
+		rescue Exception => e
+			return nil			
+		end
+	end
+	def set workspace = 0, key, hash
+		hash.merge! 'time' => Time.now.to_i
+		if @memory[workspace].nil?
+			@memory[workspace] = {}
+		end
+		if @memory[workspace][key]
+			@memory[workspace][key] = hash
+		else
+			@memory[workspace].merge! key => hash
+		end
+		self.write_memory
+	end
+end

data/lib/wmctile/router.rb

@@ -0,0 +1,187 @@
+class Wmctile::Router < Wmctile::Class
+	##################################
+	## init ##########################
+	##################################
+	def initialize
+		@settings = Wmctile::Settings.new
+		@all_workspaces = false
+	end
+	##################################
+	## main dispatch method ##########
+	##################################
+	def dispatch args = []
+		if args.length
+			main_arg = args[0]
+			if ['--all-workspaces', '-a'].include? main_arg 
+				@all_workspaces = true
+				drop = 2
+				main_arg = args[1]
+			else
+				@all_workspaces = false
+				drop = 1
+			end
+			if main_arg and !['dispatch', 'initialize', 'wm', 'wt', 'memory'].include? main_arg and self.respond_to? main_arg
+				self.send main_arg, *args.drop(drop)
+			else
+				self.help
+			end
+		else
+			self.help
+		end
+	end
+	##################################
+	## object getter methods #########
+	##################################
+	def wm
+		@wm || @wm = Wmctile::WindowManager.new(@settings)
+	end
+	def wt
+		# @wm might be nil
+		@wt || @wt = Wmctile::WindowTiler.new(@settings, self.memory, @wm)
+	end
+	def memory
+		@memory || @memory = Wmctile::Memory.new
+	end
+	##################################
+	## actual command-line methods ###
+	##################################
+	def help args = nil
+		puts <<-eos
+wmctile version 0.1.1
+
+usage:
+   wmctile [--option1, --option2, ...] <command> ['argument1', 'argument2', ...]
+
+examples:
+   wmctile snap 'left' 'terminator'
+   wmctile summon --all-workspaces ':ACTIVE:'
+
+options:
+   --all-workspaces, -a
+      Use all workspaces when searching for windows. 
+
+commands:
+   summon 'window_string'
+      Summons a window matching 'window_str'.
+
+   summon_or_run 'window_string' 'command_to_run'
+      Summons a window matching 'window_string'. If no window is found, the 'command_to_run' is run.
+
+   switch_to 'window_string'
+      Switches to a window matching 'window_string'.
+
+   switch_to_or_run 'window_string' 'command_to_run'
+      Switches to a window matching 'window_string'. If no window is found, the 'command_to_run' is run.
+
+   maximize 'window_string'
+      Maximizes a window matching 'window_string'.
+
+   unmaximize 'window_string'
+      Unmaximizes a window matching 'window_string'.
+
+   shade 'window_string'
+      Shades a window matching 'window_string'.
+
+   unshade 'window_string'
+      Unshades a window matching 'window_string'.
+
+   unshade_last_shaded
+      Unshades the last shaded window on active workspace.
+
+   snap 'where' 'window_string' ['portion']
+      Snaps a window matching 'window_string' to occupy the 'where' 'portion' of the screen.
+         'where' can be one of 'left', 'right', 'top', 'bottom'
+         'portion' is a float number with the default of 0.5
+
+   resize 'where' ['portion']
+      Resizes the last performed action (snap/tile etc.) on active workspace.
+         'where' can be one of 'left', 'right', 'top', 'bottom'
+             The action depends on the previously performed action. When you resize 'left' a previous snap 'left', you're shrinking the  window. When you resize 'left' a previous snap 'right', you're increasing the size of the window.
+         'portion' is a float number with the default of 0.01 by which to edit the previous portion of the screen
+
+   resize_snap 'where' ['portion']
+      Resizes the last performed snap on active workspace. Arguments are the same as in resize command.
+
+additional information:
+   To use the active window, pass ':ACTIVE:' as the 'window_string' argument.
+		eos
+	end
+	def summon window_str
+		window = self.wm.find_in_windows window_str, @all_workspaces
+		if window
+			window.summon
+			return true
+		else
+			return false
+		end
+	end
+	def summon_or_run window_str, cmd_to_run
+		unless self.summon window_str
+			self.cmd "#{ cmd_to_run } > /dev/null &"
+		end
+	end
+	def switch_to window_str
+		window = self.wm.find_in_windows window_str, @all_workspaces
+		if window
+			window.switch_to
+			return true
+		else
+			return false
+		end
+	end
+	def switch_to_or_run window_str, cmd_to_run
+		unless self.switch_to window_str
+			self.cmd "#{ cmd_to_run } > /dev/null &"
+		end
+	end
+	def maximize window_str
+		window = self.wm.get_window window_str
+		if window
+			window.maximize
+		end
+	end
+	def unmaximize window_str
+		window = self.wm.get_window window_str
+		if window
+			window.unmaximize
+		end
+	end
+	def shade window_str
+		window = self.wm.get_window window_str
+		if window
+			window.shade
+			self.memory.set self.wm.workspace, 'shade', {
+				'window_id' => window.id
+			}
+		end
+	end
+	def unshade window_str
+		window = self.wm.get_window window_str
+		if window
+			window.unshade
+			self.memory.set self.wm.workspace, 'unshade', {
+				'window_id' => window.id
+			}
+		end
+	end
+	def unshade_last_shaded
+		win_id = self.memory.get self.wm.workspace, 'shade', 'window_id'
+		window = Wmctile::Window.new win_id, @settings
+		if window
+			window.unshade
+			self.memory.set self.wm.workspace, 'unshade', {
+				'window_id' => window.id
+			}
+		end
+	end
+	def snap where = 'left', window_str = nil, portion = 0.5
+		self.wt.snap where, window_str, portion
+	end
+	def resize where = 'left', portion = 0.01
+		self.wt.resize where, portion
+	end
+	def resize_snap where = 'left', portion = 0.01
+		self.wt.resize_snap where, portion
+	end
+
+end

data/lib/wmctile/settings.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+
+class Wmctile::Settings < Wmctile::Class
+	def method_missing sym, *args, &block
+		return false
+	end
+
+	def initialize
+		path = File.expand_path '~/.config/wmctile/wmctile-settings.yml'
+		if not File.exist? path
+			raw_settings = self.create_new_settings path
+		end
+		raw_settings ||= File.read path
+		settings = YAML.load(raw_settings)
+		if settings
+			settings.each { |name, value|
+				instance_variable_set("@#{name}", value)
+				self.class.class_eval { attr_reader name.intern }
+			}
+		end
+	end
+
+	def test_requirements
+		req = ['xrandr', 'wmctrl', 'dmenu']
+		ret = req.reject { |r| self.cmd("which #{ r }").length > 0 }
+		return ret
+	end
+	def create_new_settings path
+		req = self.test_requirements
+		unless req.nil? or req.length == 0
+			puts <<-eos
+You don't have #{ req.join(', ') } installed. Wmctile can't run without that.
+
+To fix this on Ubuntu, run:
+
+sudo apt-get install #{ req.join(' ') }
+			eos
+			exit
+		end
+		dir_path = path[/(.*)\/wmctile-settings.yml/, 1]
+		if not Dir.exists? dir_path
+			Dir.mkdir dir_path
+		end
+		out_file = File.new path, 'w'
+		out_file.puts self.default_settings.to_yaml
+		out_file.close
+	end
+	def default_settings
+		{
+			:window_border => 1,
+			:panel_height => 24,
+			:panel_width => 0,
+			:hostname => self.cmd('hostname')
+		}
+	end
+end

data/lib/wmctile/window.rb

@@ -0,0 +1,69 @@
+class Wmctile::Window < Wmctile::Class
+	attr_accessor :id, :name, :title
+
+	def initialize win_string, settings
+		@default_movement = { :x => 0, :y => 0, :width => '-1', :height => '-1' }
+		@settings = settings
+		@id = win_string[/0x[\d\w]{8}/]
+		self.get_name_and_title win_string
+	end
+	def get_name_and_title win_string
+		if win_string == @id
+			@name = ''
+			@title = ''
+		else
+			after_id_and_workspace = win_string[14..-1].split(/\s+#{ @settings.hostname }\s+/, 2)
+			@name = after_id_and_workspace[0]
+			@title = after_id_and_workspace[1]
+		end
+	end
+	def dmenu_item
+		unless @dmenu_item
+			str = "#{ @id } #{ @name } #{ @title }"
+			@dmenu_item = Dmenu::Item.new str, self
+		end
+		@dmenu_item
+	end
+	def get_name
+		if @name == ''
+			self.get_name_and_title self.cmd('wmctrl -lx | grep ' + @id)
+		end
+		@name
+	end
+	def get_name_length
+		@name.length
+	end
+	def set_name_length name_length
+		@name += ' '*(name_length - @name.length)
+	end
+	def wmctrl wm_cmd = '', summon = false
+		self.cmd "wmctrl -i#{ summon ? 'R' : 'r' } #{ @id } #{ wm_cmd }"
+		return self # return self so that commands can be chained
+	end
+	def move how_to_move = {}
+		how_to_move = @default_movement.merge! how_to_move
+		cmd = "-e 0,#{ how_to_move[:x].to_i },#{ how_to_move[:y].to_i },#{ how_to_move[:width].to_i },#{ how_to_move[:height].to_i }"
+		self.unshade
+		self.unmaximize
+		self.wmctrl cmd
+	end
+	def shade
+		self.wmctrl '-b add,shaded'
+	end
+	def unshade
+		self.wmctrl '-b remove,shaded'
+	end
+	def summon
+		self.wmctrl '', true
+	end
+	def switch_to
+		self.cmd "wmctrl -ia #{ @id }"
+		return self
+	end
+	def maximize
+		self.wmctrl '-b add,maximized_vert,maximized_horz'
+	end
+	def unmaximize
+		self.wmctrl '-b remove,maximized_vert,maximized_horz'
+	end
+end

data/lib/wmctile/window_manager.rb

@@ -0,0 +1,174 @@
+class Wmctile::WindowManager < Wmctile::ClassWithDmenu
+	attr_accessor :w, :h, :workspace, :windows
+	##################################
+	## init ##########################
+	##################################
+	def initialize settings
+		@settings = settings
+		self.init_dimensions
+	end
+	def init_dimensions
+		# legacy (but fast) method via wmctrl
+		# dimensions = cmd("wmctrl -d | awk '{ print $9 }' | head -n1").split('x')
+		# xrandr is slower, but offers more information
+		dimensions = cmd("xrandr | grep -E '\sconnected\s[0-9]+x[0-9]+\+0' | awk '{print $3}' | awk -F'+' '{print $1}'").split('x')
+		@w = dimensions[0].to_i - 2*@settings.window_border
+		@h = dimensions[1].to_i - 2*@settings.window_border - @settings.panel_height
+		@workspace = cmd("wmctrl -d | grep '\*' | awk '{ print $1 }'").to_i
+	end
+	##################################
+	## dimension getters #############
+	##################################
+	def width portion = 1
+		@w * portion
+	end
+	def height portion = 1
+		@h * portion
+	end
+	##################################
+	## window getters ################
+	##################################
+	def get_window window_str = nil, all_workspaces = false
+		if window_str.nil?
+			window = self.ask_for_window all_workspaces
+		else
+			if window_str == ':ACTIVE:'
+				window = self.get_active_window
+			else
+				window = self.find_window window_str, all_workspaces
+				unless window
+					# does window_str have an icon bundle in it? (aka evince.Evince)
+					if window_str =~ /[a-z0-9]+\.[a-z0-9]+/i
+						icon = window_str.split('.').first
+					else
+						icon = nil
+					end
+					self.notify 'No window found', "#{ window_str }", icon
+				end
+			end
+		end
+		window
+	end
+	def get_active_window
+		win_id = self.cmd('wmctrl -a :ACTIVE: -v 2>&1').split('Using window: ').last
+		Wmctile::Window.new win_id, @settings
+	end
+	def find_window window_string, all_workspaces = false
+		cmd = "wmctrl -lx | grep -F #{ window_string }"
+		cmd += ' | grep -E \'0x\w+\s+' + @workspace.to_s + '\s+\''  unless all_workspaces
+		window_string = self.cmd cmd
+		window_string = window_string.split("\n").first
+		if window_string.nil?
+			return nil
+		else
+			return Wmctile::Window.new window_string, @settings
+		end
+	end
+	def find_windows window_string, all_workspaces = false
+		cmd = "wmctrl -lx | grep -F #{ window_string }"
+		cmd += ' | grep -E \'0x\w+\s+' + @workspace.to_s + '\s+\''  unless all_workspaces
+		window_strings = self.cmd cmd
+		window_strings = window_strings.split("\n")
+		if window_string.nil?
+			return nil
+		else
+			return window_strings.map { |w| Wmctile::Window.new w, @settings }
+		end
+	end
+	def find_in_windows window_string, all_workspaces = false
+		if window_string.nil?
+			self.ask_for_window all_workspaces
+		else
+			windows = self.find_windows window_string, all_workspaces
+			if windows
+				ids = windows.collect(&:id)
+				active_win = self.get_active_window
+				if ids.include? active_win.id
+					# cycle through the windows
+					i = ids.index active_win.id
+					# try the next one
+					if ids[i+1]
+						window = windows[i+1]
+					# fallback to the first one
+					else
+						window = windows.first
+					end
+				else
+					# switch to the first one
+					window = windows.first
+				end
+				return window
+			end
+			return nil
+		end
+	end
+	def ask_for_window all_workspaces = false
+		self.dmenu self.windows.map(&:dmenu_item)
+	end
+	##################################
+	## window lists ##################
+	##################################
+	def build_win_list all_workspaces = false
+		unless all_workspaces
+			variable_name = '@windows_on_workspace'
+		else
+			variable_name = '@windows_all'
+		end
+		unless instance_variable_get(variable_name)
+			unless all_workspaces
+				cmd = "wmctrl -lx | grep \" #{ @workspace } \""
+			else
+				cmd = "wmctrl -lx"
+			end
+			arr = cmd(cmd).split("\n")
+
+			new_list = arr.map { |w| Wmctile::Window.new(w, @settings) }
+			name_length = new_list.map(&:get_name_length).max
+			new_list.each { |w| w.set_name_length(name_length) }
+
+			instance_variable_set(variable_name, new_list)
+		end
+		instance_variable_get(variable_name)
+	end
+	def windows all_workspaces = false
+		unless all_workspaces
+			variable_name = '@windows_on_workspace'
+		else
+			variable_name = '@windows_all'
+		end
+		unless instance_variable_get(variable_name)
+			self.build_win_list all_workspaces
+		else
+			instance_variable_get(variable_name)
+		end
+	end
+	##################################
+	## window size calculators #######
+	##################################
+	def calculate_snap where, portion = 0.5
+		return case where
+		when 'left'
+			{
+				:x => @settings.panel_width, :y => @settings.panel_height,
+				:height => self.height, :width => self.width(portion)
+			}
+		when 'right'
+			{
+				:x => self.width(portion), :y => @settings.panel_height,
+				:height => self.height, :width => self.width(1-portion)
+			}
+		when 'top'
+			{
+				:x => @settings.panel_width, :y => @settings.panel_height,
+				:height => self.height(portion), :width => self.width
+			}
+		when 'bottom'
+			{
+				:x => @settings.panel_width, :y => @settings.panel_height + self.height(1-portion),
+				:height => self.height(portion), :width => self.width
+			}
+		else
+			nil
+		end
+	end
+end

data/lib/wmctile/window_tiler.rb

@@ -0,0 +1,95 @@
+class Wmctile::WindowTiler < Wmctile::Class
+	##################################
+	## init ##########################
+	##################################
+	def initialize settings, memory, wm = nil
+		@settings = settings
+		@memory = memory
+		@wm = wm
+	end
+	##################################
+	## object getter methods #########
+	##################################
+	def wm
+		@wm || @wm = Wmctile::WindowManager.new(@settings)
+	end
+	def memory
+		@memory || @memory = Wmctile::Memory.new
+	end
+	##################################
+	## actual snapping methods #######
+	##################################
+	def snap where = 'left', window_str = nil, portion = 0.5
+		window = self.wm.get_window window_str
+		if window
+			how_to_move = self.wm.calculate_snap where, portion.to_f
+			if how_to_move
+				window.move how_to_move
+				self.memory.set self.wm.workspace, 'snap', {
+					'where' => where, 'portion' => portion, 'window_id' => window.id
+				}
+			end
+		end
+	end
+	def resize where = 'left', portion = 0.01
+		portion = portion.to_f
+		# what are we moving? the last one used from these:
+		methods = ['snap']
+		freshest_meth = nil
+		freshest_time = 0
+		methods.each do |meth|
+			time = self.memory.get self.wm.workspace, meth, 'time'
+			if time > freshest_time
+				freshest_time = time
+				freshest_meth = meth
+			end
+		end
+		# ok, got it, it's freshest_meth
+		self.send "resize_#{ freshest_meth }", where, portion
+	end
+	def resize_snap where = 'left', portion = 0.01
+		portion = portion.to_f
+		info = self.memory.get self.wm.workspace, 'snap'
+		if info.nil?
+			return nil
+		end
+		negative = case info['where']
+		when 'left'
+			if where == 'left'	
+				true
+			elsif where == 'right'
+				false
+			else
+				nil
+			end
+		when 'right'
+			if where == 'left'	
+				false
+			elsif where == 'right'
+				true
+			else
+				nil
+			end
+		when 'top'
+			if where == 'bottom'	
+				false
+			elsif where == 'top'
+				true
+			else
+				nil
+			end
+		when 'bottom'
+			if where == 'top'	
+				false
+			elsif where == 'bottom'
+				true
+			else
+				nil
+			end
+		end
+		unless negative.nil?
+			portion = -portion  if negative
+			self.snap info['where'], info['window_id'], info['portion']+portion
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wmctile
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mreq
@@ -30,7 +30,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/wmctile
 - lib/wmctile.rb
+- lib/wmctile/class.rb
+- lib/wmctile/class_with_dmenu.rb
+- lib/wmctile/memory.rb
+- lib/wmctile/router.rb
+- lib/wmctile/settings.rb
+- lib/wmctile/window.rb
+- lib/wmctile/window_manager.rb
+- lib/wmctile/window_tiler.rb
 homepage: http://mreq.github.io/wmctile
 licenses:
 - GPL-2