rename dmenu_cmd to menu_cmd in anticipation of switching to using wimenu

[wmiirc-lua.git] / core / wmii.lua

--
-- Copyright (c) 2007, Bart Trojanowski <bart@jukie.net>
--
-- WMII event loop, in lua
--
-- http://www.jukie.net/~bart/blog/tag/wmiirc-lua
-- git://www.jukie.net/wmiirc-lua.git/
--

-- ========================================================================
-- DOCUMENTATION
-- ========================================================================
--[[
=pod

=head1 NAME 

wmii.lua - WMII event-loop methods in lua

=head1 SYNOPSIS

    require "wmii"

    -- Write something to the wmii filesystem, in this case a key event.
    wmii.write ("/event", "Key Mod1-j")

    -- Set your wmii /ctl parameters
    wmii.set_ctl({
        font = '....'
    })

    -- Configure wmii.lua parameters
    wmii.set_conf ({
        xterm = 'x-terminal-emulator'
    })

    -- Now start the event loop
    wmii.run_event_loop()

=head1 DESCRIPTION

wmii.lua provides methods for replacing the stock sh-based wmiirc shipped with
wmii 3.6 and newer with a lua-based event loop.

It should be used by your wmiirc

=head1 METHODS

=over 4

=cut
--]]

-- ========================================================================
-- MODULE SETUP
-- ========================================================================

local wmiidir = os.getenv("HOME") .. "/.wmii-3.5"
local wmiirc = wmiidir .. "/wmiirc"

package.path  = wmiidir .. "/core/?.lua;" ..
                wmiidir .. "/plugins/?.lua;" ..
                package.path
package.cpath = wmiidir .. "/core/?.so;" ..
                wmiidir .. "/plugins/?.so;" ..
                package.cpath

local ixp = require "ixp"
local eventloop = require "eventloop"
local history = require "history"

local io = require("io")
local os = require("os")
local string = require("string")
local table = require("table")
local math = require("math")
local type = type
local error = error
local print = print
local pcall = pcall
local pairs = pairs
local package = package
local require = require
local tostring = tostring
local tonumber = tonumber
local setmetatable = setmetatable

-- kinda silly, but there is no working liblua5.1-posix0 in ubuntu
-- so we make it optional
local have_posix, posix = pcall(require,"posix")

module("wmii")

-- get the process id
local myid
if have_posix then
        -- but having posix is not enough as the API changes, so we try each one
        if posix.getprocessid then
                local stat,rc = pcall (posix.getprocessid, "pid")
                if stat then
                        myid = rc
                end
        end
        if not myid and posix.getpid then
                local stat,rc = pcall (posix.getpid, "pid")
                if stat then
                        myid = rc
                end
        end
end
if not myid then
        -- we were not able to get the PID, but we can create a random number
        local now = tonumber(os.date("%s"))
        math.randomseed(now)
        myid = math.random(10000)
end

-- ========================================================================
-- MODULE VARIABLES
-- ========================================================================

-- wmiir points to the wmiir executable
-- TODO: need to make sure that wmiir is in path, and if not find it
local wmiir = "wmiir"

-- wmii_adr is the address we use when connecting using ixp
local wmii_adr = os.getenv("WMII_ADDRESS")
        or ("unix!/tmp/ns." ..  os.getenv("USER") ..  "." 
            .. os.getenv("DISPLAY"):match("(:%d+)") .. "/wmii")

-- wmixp is the ixp context we use to talk to wmii
local wmixp = ixp.new(wmii_adr)

-- history of previous views, view_hist[#view_hist] is the last one
local view_hist = {}                  -- sorted with 1 being the oldest
local view_hist_max = 50              -- max number to keep track of

-- allow for a client to be forced to a tag
local next_client_goes_to_tag = nil

-- program and action histories
local prog_hist = history.new (20)
local action_hist = history.new(10)

-- where to find plugins
plugin_path = os.getenv("HOME") .. "/.wmii-3.5/plugins/?.so;"
           .. os.getenv("HOME") .. "/.wmii-3.5/plugins/?.lua;"
           .. "/usr/local/lib/lua/5.1/wmii/?.so;"
           .. "/usr/local/share/lua/5.1/wmii/?.lua;"
           .. "/usr/lib/lua/5.1/wmii/?.so;"
           .. "/usr/share/lua/5.1/wmii/?.lua"

-- where to find wmiirc (see find_wmiirc())
wmiirc_path = os.getenv("HOME") .. "/.wmii-3.5/wmiirc.lua;"
           .. os.getenv("HOME") .. "/.wmii-3.5/wmiirc;"
           .. "/etc/X11/wmii-3.5/wmiirc.lua;"
           .. "/etc/X11/wmii-3.5/wmiirc"

-- ========================================================================
-- LOCAL HELPERS
-- ========================================================================

--[[
=pod

=item log ( str )

Log the message provided in C<str>

Currently just writes to io.stderr

=cut
--]]
function log (str)
        if get_conf("debug") then
                io.stderr:write (str .. "\n")
        end
end

--[[
=pod

=item find_wmiirc ( )

Locates the wmiirc script.  It looks in ~/.wmii-3.5 and /etc/X11/wmii-3.5
for the first lua script bearing the name wmiirc.lua or wmiirc.  Returns
first match.

=cut
--]]
function find_wmiirc()
        local fn
        for fn in string.gmatch(wmiirc_path, "[^;]+") do
                -- try to locate the files locally
                local file = io.open(fn, "r")
                if file then
                        local txt = file:read("*line")
                        file:close()
                        if type(txt) == 'string' and txt:match("lua") then
                                return fn
                        end
                end
        end
        return nil
end


-- ========================================================================
-- MAIN ACCESS FUNCTIONS
-- ========================================================================

--[[
=pod

=item ls ( dir, fmt )

List the wmii filesystem directory provided in C<dir>, in the format specified
by C<fmt>.  

Returns an iterator of TODO

=cut
--]]
function ls (dir, fmt)
        local verbose = fmt and fmt:match("l")

        local s = wmixp:stat(dir)
        if not s then
                return function () return nil end
        end
        if s.modestr:match("^[^d]") then
                return function ()
                        return stat2str(verbose, s)
                end
        end

        local itr = wmixp:idir (dir)
        if not itr then
                --return function ()
                        return nil
                --end
        end


        return function ()
                local s = itr()
                if s then
                        return stat2str(verbose, s)
                end
                return nil
        end
end

local function stat2str(verbose, stat)
        if verbose then
                return string.format("%s %s %s %5d %s %s", stat.modestr, stat.uid, stat.gid, stat.length, stat.timestr, stat.name)
        else
                if stat.modestr:match("^d") then
                        return stat.name .. "/"
                else
                        return stat.name
                end
        end
end

-- ------------------------------------------------------------------------
-- read all contents of a wmii virtual file
function read (file)
        return wmixp:read (file)
end

-- ------------------------------------------------------------------------
-- return an iterator which walks all the lines in the file
--
-- example:
--     for event in wmii.iread("/ctl")
--         ...
--     end
--
-- NOTE: don't use iread for files that could block, as this will interfere
-- with timer processing and event delivery.  Instead fork off a process to
-- execute wmiir and read back the responses via callback.
function iread (file)
        return wmixp:iread(file)
end

-- ------------------------------------------------------------------------
-- create a wmii file, optionally write data to it
function create (file, data)
        wmixp:create(file, data)
end

-- ------------------------------------------------------------------------
-- remove a wmii file
function remove (file)
        wmixp:remove(file)
end

-- ------------------------------------------------------------------------
-- write a value to a wmii virtual file system
function write (file, value)
        wmixp:write (file, value)
end

-- ------------------------------------------------------------------------
-- setup a table describing the menu command
local function menu_cmd (prompt)
        local cmdt = { wmiir, "setsid", "dmenu", "-b" }
        local fn = get_ctl("font")
        if fn then
                cmdt[#cmdt+1] = "-fn"
                cmdt[#cmdt+1] = fn
        end
        local normcolors = get_ctl("normcolors")
        if normcolors then
                local nf, nb = normcolors:match("(#%x+)%s+(#%x+)%s#%x+")
                if nf then
                        cmdt[#cmdt+1] = "-nf"
                        cmdt[#cmdt+1] = "'" .. nf .. "'"
                end
                if nb then
                        cmdt[#cmdt+1] = "-nb"
                        cmdt[#cmdt+1] = "'" .. nb .. "'"
                end
        end
        local focuscolors = get_ctl("focuscolors")
        if focuscolors then
                local sf, sb = focuscolors:match("(#%x+)%s+(#%x+)%s#%x+")
                if sf then
                        cmdt[#cmdt+1] = "-sf"
                        cmdt[#cmdt+1] = "'" .. sf .. "'"
                end
                if sb then
                        cmdt[#cmdt+1] = "-sb"
                        cmdt[#cmdt+1] = "'" .. sb .. "'"
                end
        end
        if prompt then
                cmdt[#cmdt+1] = "-p"
                cmdt[#cmdt+1] = "'" .. prompt .. "'"
        end

        return cmdt
end

-- ------------------------------------------------------------------------
-- displays the menu given an table of entires, returns selected text
function menu (tbl, prompt)
        local menu = menu_cmd(prompt)

        local infile = os.tmpname()
        local fh = io.open (infile, "w+")

        local i,v
        for i,v in pairs(tbl) do
                if type(i) == 'number' and type(v) == 'string' then
                        fh:write (v)
                else
                        fh:write (i)
                end
                fh:write ("\n")
        end
        fh:close()

        local outfile = os.tmpname()

        menu[#menu+1] = "<"
        menu[#menu+1] = infile
        menu[#menu+1] = ">"
        menu[#menu+1] = outfile

        local cmd = table.concat(menu," ")
        os.execute (cmd)

        fh = io.open (outfile, "r")
        os.remove (outfile)

        local sel = fh:read("*l")
        fh:close()

        return sel
end

-- ------------------------------------------------------------------------
-- displays the a tag selection menu, returns selected tag
function tag_menu ()
        local tags = get_tags()

        return menu(tags, "tag:")
end

-- ------------------------------------------------------------------------
-- displays the a program menu, returns selected program
function prog_menu ()
        local menu = menu_cmd("cmd:")

        local outfile = os.tmpname()

        menu[#menu+1] = ">"
        menu[#menu+1] = outfile

        local hstt = { }
        for n in prog_hist:walk_reverse_unique() do
                hstt[#hstt+1] = "echo '" .. n .. "' ; "
        end

        local cmd = "(" .. table.concat(hstt)
                         .. "dmenu_path ) |" 
                         .. table.concat(menu," ")
        os.execute (cmd)

        local fh = io.open (outfile, "rb")
        os.remove (outfile)

        local prog = fh:read("*l")
        io.close (fh)

        return prog
end

-- ------------------------------------------------------------------------
-- returns a table of sorted tags names
function get_tags()
        local t = {}
        local s
        for s in wmixp:idir ("/tag") do
                if s.name and not (s.name == "sel") then
                        t[#t + 1] = s.name
                end
        end
        table.sort(t)
        return t
end

-- ------------------------------------------------------------------------
-- returns a table of sorted screen names
function get_screens()
        local t = {}
        local s
        for s in wmixp:idir ("/screen") do
                if s.name and not (s.name == "sel") then
                        t[#t + 1] = s.name
                end
        end
        table.sort(t)
        return t
end

-- ------------------------------------------------------------------------
-- returns current view, on current screen or specified screen
function get_view(screen)
        return get_screen_ctl(screen, "view") or get_ctl("view")
end

-- ------------------------------------------------------------------------
-- changes the current view to the name given
function set_view(sel)
        local cur = get_view()
        local all = get_tags()

        if #all < 2 or sel == cur then
                -- nothing to do if we have less then 2 tags
                return
        end

        if not (type(sel) == "string") then
                error ("string argument expected")
        end

        -- set new view
        write ("/ctl", "view " .. sel)
end

-- ------------------------------------------------------------------------
-- changes the current view to the index given
function set_view_index(sel)
        local cur = get_view()
        local all = get_tags()

        if #all < 2 then
                -- nothing to do if we have less then 2 tags
                return
        end

        local num = tonumber (sel)
        if not num then
                error ("number argument expected")
        end

        local name = all[sel]
        if not name or name == cur then
                return
        end

        -- set new view
        write ("/ctl", "view " .. name)
end

-- ------------------------------------------------------------------------
-- chnages to current view by offset given
function set_view_ofs(jump)
        local cur = get_view()
        local all = get_tags()

        if #all < 2 then
                -- nothing to do if we have less then 2 tags
                return
        end

        -- range check
        if (jump < - #all) or (jump > #all) then
                error ("view selector is out of range")
        end

        -- find the one that's selected index
        local curi = nil
        local i,v
        for i,v in pairs (all) do
                if v == cur then curi = i end
        end

        -- adjust by index
        local newi = math.fmod(#all + curi + jump - 1, #all) + 1
        if (newi < - #all) or (newi > #all) then
                error ("error computng new view")
        end

        write ("/ctl", "view " .. all[newi])
end

-- ------------------------------------------------------------------------
-- toggle between last view and current view
function toggle_view()
        local last = view_hist[#view_hist]
        if last then
                set_view(last)
        end
end

-- ========================================================================
-- ACTION HANDLERS
-- ========================================================================

local action_handlers = {
        man = function (act, args)
                local xterm = get_conf("xterm") or "xterm"
                local page = args
                if (not page) or (not page:match("%S")) then
                        page = wmiidir .. "/wmii.3lua"
                end
                local cmd = xterm .. " -e man " .. page .. " &"
                log ("    executing: " .. cmd)
                os.execute (wmiir .. " setsid " .. cmd)
        end,

        quit = function ()
                write ("/ctl", "quit")
        end,

        exec = function (act, args)
                local what = args or "wmii"
                log ("    asking wmii to exec " .. tostring(what))
                cleanup()
                write ("/ctl", "exec " .. what)
        end,

        xlock = function (act)
                local cmd = get_conf("xlock") or "xscreensaver-command --lock"
                os.execute (wmiir .. " setsid " .. cmd)
        end,

        wmiirc = function ()
                if have_posix then
                        local wmiirc = find_wmiirc()
                        if wmiirc then
                                log ("    executing: lua " .. wmiirc)
                                cleanup()
                                posix.exec (wmiirc)
                                posix.exec ("/bin/sh", "-c", "exec lua wmiirc")
                                posix.exec ("/usr/bin/lua", wmiirc)
                        end
                else
                        log("sorry cannot restart; you don't have lua's posix library.")
                end
        end,

        urgent = function ()
                wmixp:write ("/client/sel/ctl", "Urgent toggle")
        end,

--[[
        rehash = function ()
                -- TODO: consider storing list of executables around, and 
                -- this will then reinitialize that list
                log ("    TODO: rehash")
        end,

        status = function ()
                -- TODO: this should eventually update something on the /rbar
                log ("    TODO: status")
        end,
--]]
}

--[[
=pod

=item add_action_handler (action, fn)

Add an Alt-a action handler callback function, I<fn>, for the given action string I<action>.

=cut
--]]
function add_action_handler (action, fn)

        if type(action) ~= "string" or type(fn) ~= "function" then
                error ("expecting a string and a function")
        end

        if action_handlers[action] then
                error ("action handler already exists for '" .. action .. "'")
        end

        action_handlers[action] = fn
end

--[[
=pod

=item remove_action_handler (action)

Remove an action handler callback function for the given action string I<action>.

=cut
--]]
function remove_action_handler (action)

        action_handlers[action] = nil
end

-- ========================================================================
-- KEY HANDLERS
-- ========================================================================

function ke_fullscreen_toggle()
        wmixp:write ("/client/sel/ctl", "Fullscreen toggle")
end

function ke_view_starting_with_letter (letter)
        local i,v

        -- find the view name in history in reverse order
        for i=#view_hist,1,-1 do
                v = view_hist[i]
                if letter == v:sub(1,1) then
                        set_view(v)
                        return true
                end
        end

        -- otherwise just pick the first view that matches
        local all = get_tags()
        for i,v in pairs(all) do
                if letter == v:sub(1,1) then
                        set_view_index (i)
                        return true
                end
        end

        return false
end

function ke_handle_action()
        local actions = { }
        local seen = {}

        local n
        for n in action_hist:walk_reverse() do
                if not seen[n] then
                        actions[#actions+1] = n
                        seen[n] = 1
                end
        end

        local v
        for n,v in pairs(action_handlers) do
                if not seen[n] then
                        actions[#actions+1] = n
                        seen[n] = 1
                end
        end

        local text = menu(actions, "action:")
        if text then
                log ("Action: " .. text)
                local act = text
                local args = nil
                local si = text:find("%s")
                if si then
                        act,args = string.match(text .. " ", "(%w+)%s(.+)")
                end
                if act then
                        local fn = action_handlers[act]
                        if fn then
                                action_hist:add (act)
                                local r, err = pcall (fn, act, args)
                                if not r then
                                        log ("WARNING: " .. tostring(err))
                                end
                        end
                end
        end
end


local key_handlers = {
        ["*"] = function (key)
                log ("*: " .. key)
        end,

        -- execution and actions
        ["Mod1-Return"] = function (key)
                local xterm = get_conf("xterm") or "xterm"
                log ("    executing: " .. xterm)
                os.execute (wmiir .. " setsid " .. xterm .. " &")
        end,
        ["Mod1-Shift-Return"] = function (key)
                local tag = tag_menu()
                if tag then
                        local xterm = get_conf("xterm") or "xterm"
                        log ("    executing: " .. xterm .. "  on: " .. tag)
                        next_client_goes_to_tag = tag
                        os.execute (wmiir .. " setsid " .. xterm .. " &")
                end
        end,
        ["Mod1-a"] = function (key)
                ke_handle_action()
        end,
        ["Mod1-p"] = function (key)
                local prog = prog_menu()
                if prog then
                        prog_hist:add(prog:match("(%w+)"))
                        log ("    executing: " .. prog)
                        os.execute (wmiir .. " setsid " .. prog .. " &")
                end
        end,
        ["Mod1-Shift-p"] = function (key)
                local tag = tag_menu()
                if tag then
                        local prog = prog_menu()
                        if prog then
                                log ("    executing: " .. prog .. "  on: " .. tag)
                                next_client_goes_to_tag = tag
                                os.execute (wmiir .. " setsid " .. prog .. " &")
                        end
                end
        end,
        ["Mod1-Shift-c"] = function (key)
                write ("/client/sel/ctl", "kill")
        end,

        -- HJKL active selection
        ["Mod1-h"] = function (key)
                write ("/tag/sel/ctl", "select left")
        end,
        ["Mod1-l"] = function (key)
                write ("/tag/sel/ctl", "select right")
        end,
        ["Mod1-j"] = function (key)
                write ("/tag/sel/ctl", "select down")
        end,
        ["Mod1-k"] = function (key)
                write ("/tag/sel/ctl", "select up")
        end,

        -- HJKL movement
        ["Mod1-Shift-h"] = function (key)
                write ("/tag/sel/ctl", "send sel left")
        end,
        ["Mod1-Shift-l"] = function (key)
                write ("/tag/sel/ctl", "send sel right")
        end,
        ["Mod1-Shift-j"] = function (key)
                write ("/tag/sel/ctl", "send sel down")
        end,
        ["Mod1-Shift-k"] = function (key)
                write ("/tag/sel/ctl", "send sel up")
        end,

        -- floating vs tiled
        ["Mod1-space"] = function (key)
                write ("/tag/sel/ctl", "select toggle")
        end,
        ["Mod1-Shift-space"] = function (key)
                write ("/tag/sel/ctl", "send sel toggle")
        end,

        -- work spaces (# and @ are wildcards for numbers and letters)
        ["Mod4-#"] = function (key, num)
                -- first attempt to find a view that starts with the number requested
                local num_str = tostring(num)
                if not ke_view_starting_with_letter (num_str) then
                        -- if we fail, then set it to the index requested
                        set_view_index (num)
                end
        end,
        ["Mod4-Shift-#"] = function (key, num)
                write ("/client/sel/tags", tostring(num))
        end,
        ["Mod4-@"] = function (key, letter)
                ke_view_starting_with_letter (letter)
        end,
        ["Mod4-Shift-@"] = function (key, letter)
                local all = get_tags()
                local i,v
                for i,v in pairs(all) do
                        if letter == v:sub(1,1) then
                                write ("/client/sel/tags", v)
                                break
                        end
                end
        end,
        ["Mod1-comma"] = function (key)
                set_view_ofs (-1)
        end,
        ["Mod1-period"] = function (key)
                set_view_ofs (1)
        end,
        ["Mod1-r"] = function (key)
                -- got to the last view
                toggle_view()
        end,

        -- switching views and retagging
        ["Mod1-t"] = function (key)
                -- got to a view
                local tag = tag_menu()
                if tag then
                        set_view (tag)
                end
        end,
        ["Mod1-Shift-t"] = function (key)
                -- move selected client to a tag
                local tag = tag_menu()
                if tag then
                        write ("/client/sel/tags", tag)
                end
        end,
        ["Mod1-Shift-r"] = function (key)
                -- move selected client to a tag, and follow
                local tag = tag_menu()
                if tag then
                        -- get the current window id
                        local xid = wmixp:read("/client/sel/ctl") or ""
                        
                        -- modify the tag
                        write("/client/sel/tags", tag)

                        -- if the client is still in this tag, then
                        -- it might have been a regexp tag... check
                        local test = wmixp:read("/client/sel/ctl")
                        if not test or test ~= xid then
                                -- if the window moved, follow it
                                set_view(tag)
                        end
                end
        end,
        ["Mod1-Control-t"] = function (key)
                log ("    TODO: Mod1-Control-t: " .. key)
        end,

        -- column modes
        ["Mod1-d"] = function (key)
                write("/tag/sel/ctl", "colmode sel default-max")
        end,
        ["Mod1-s"] = function (key)
                write("/tag/sel/ctl", "colmode sel stack-max")
        end,
        ["Mod1-m"] = function (key)
                write("/tag/sel/ctl", "colmode sel stack+max")
        end,
        ["Mod1-f"] = function (key)
                ke_fullscreen_toggle()
        end,

        -- changing client flags
        ["Shift-Mod1-f"] = function (key)
                log ("setting flags")

                local cli = get_client ()

                local flags = { "suspend", "raw" }
                local current_flags = cli:flags_string()

                local what = menu(flags, "current flags: " .. current_flags .. " toggle:")

                cli:toggle(what)
        end,
        ["Mod4-space"] = function (key)
                local cli = get_client ()
                cli:toggle("raw")
        end,
}

--[[
=pod

=item add_key_handler (key, fn)

Add a keypress handler callback function, I<fn>, for the given key sequence I<key>.

=cut
--]]
function add_key_handler (key, fn)

        if type(key) ~= "string" or type(fn) ~= "function" then
                error ("expecting a string and a function")
        end

        if key_handlers[key] then
                -- TODO: we may wish to allow multiple handlers for one keypress
                error ("key handler already exists for '" .. key .. "'")
        end

        key_handlers[key] = fn
end

--[[
=pod

=item remove_key_handler (key)

Remove an key handler callback function for the given key I<key>.

Returns the handler callback function.

=cut
--]]
function remove_key_handler (key)

        local fn = key_handlers[key]
        key_handlers[key] = nil
        return fn
end

--[[
=pod

=item remap_key_handler (old_key, new_key)

Remove a key handler callback function from the given key I<old_key>,
and assign it to a new key I<new_key>.

=cut
--]]
function remap_key_handler (old_key, new_key)

        local fn = remove_key_handler(old_key)

        return add_key_handler (new_key, fn)
end


-- ------------------------------------------------------------------------
-- update the /keys wmii file with the list of all handlers
local alphabet="abcdefghijklmnopqrstuvwxyz"
function update_active_keys ()
        local t = {}
        local x, y
        for x,y in pairs(key_handlers) do
                if x:find("%w") then
                        local i = x:find("#$")
                        if i then
                                local j
                                for j=0,9 do
                                        t[#t + 1] = x:sub(1,i-1) .. j
                                end
                        else
                                i = x:find("@$")
                                if i then
                                        local j
                                        for j=1,alphabet:len() do
                                                local a = alphabet:sub(j,j)
                                                t[#t + 1] = x:sub(1,i-1) .. a
                                        end
                                else
                                        t[#t + 1] = tostring(x)
                                end
                        end
                end
        end
        local all_keys = table.concat(t, "\n")
        --log ("setting /keys to...\n" .. all_keys .. "\n");
        write ("/keys", all_keys)
end

-- ------------------------------------------------------------------------
-- update the /lbar wmii file with the current tags
function update_displayed_tags ()
        -- list of all screens
        local screens = get_screens()
        if not screens then
                update_displayed_tags_on_screen()
                return
        end

        local i, s
        for i,s in pairs(screens) do
                update_displayed_tags_on_screen(s)
        end
end

function update_displayed_tags_on_screen(s)
        local lbar = "/lbar"
        if s then
                lbar = "/screen/" .. s .. "/lbar"
        end

        -- colours for screen
        local fc = get_screen_ctl(s, "focuscolors") or get_ctl("focuscolors") or ""
        local nc = get_screen_ctl(s, "normcolors") or get_ctl("normcolors") or ""

        -- build up a table of existing tags in the /lbar
        local old = {}
        local ent
        for ent in wmixp:idir (lbar) do
                old[ent.name] = 1
        end

        -- for all actual tags in use create any entries in /lbar we don't have
        -- clear the old table entries if we have them
        local cur = get_view(s)
        local all = get_tags()
        local i,v
        for i,v in pairs(all) do
                local color = nc
                if cur == v then
                        color = fc
                end
                if not old[v] then
                       create (lbar .. "/" .. v, color .. " " .. v)
                end
                write (lbar .. "/" .. v, color .. " " .. v)
                old[v] = nil
        end

        -- anything left in the old table should be removed now
        for i,v in pairs(old) do
                if v then
                        remove(lbar.."/"..i)
                end
        end

        create ("/screen/"..s.."/lbar/000000000000000000", '-'..s..'-')
end

function create_tag_widget(name)
        local nc = get_ctl("normcolors") or ""
        local screens = get_screens()
        if not screens then
                create ("/lbar/" .. name, nc .. " " .. name)
                return
        end
        local i, s
        for i,s in pairs(screens) do
                create ("/screen/"..s.."/lbar/" .. name, nc .. " " .. name)
        end
end

function destroy_tag_widget(name)
        local screens = get_screens()
        if not screens then
                remove ("/lbar/" .. name)
                return
        end
        local i, s
        for i,s in pairs(screens) do
                remove ("/screen/"..s.."/lbar/" .. name)
        end
end


-- ========================================================================
-- EVENT HANDLERS
-- ========================================================================

local widget_ev_handlers = {
}

--[[
=pod

=item _handle_widget_event (ev, arg)

Top-level event handler for redispatching events to widgets.  This event
handler is added for any widget event that currently has a widget registered
for it.

Valid widget events are currently

        RightBarMouseDown <buttonnumber> <widgetname>
        RightBarClick <buttonnumber> <widgetname>

the "Click" event is sent on mouseup.

The callbacks are given only the button number as their argument, to avoid the
need to reparse.

=cut
--]]

local function _handle_widget_event (ev, arg)

        log("_handle_widget_event: " .. tostring(ev) .. " - " .. tostring(arg))

        -- parse arg to strip out our widget name
        local number,wname = string.match(arg, "(%d+)%s+(.+)")

        -- check our dispatch table for that widget
        if not wname then
                log("Didn't find wname")
                return
        end

        local wtable = widget_ev_handlers[wname]
        if not wtable then
                log("No widget cares about" .. wname)
                return
        end

        local fn = wtable[ev] or wtable["*"]
        if fn then
                success, err = pcall( fn, ev, tonumber(number) )
                if not success then
                        log("Callback had an error in _handle_widget_event: " .. tostring(err) )
                        return nil
                end
        else 
                log("no function found for " .. ev)
        end
end

local ev_handlers = {
        ["*"] = function (ev, arg)
                log ("ev: " .. tostring(ev) .. " - " .. tostring(arg))
        end,

        RightBarClick = _handle_widget_event,

        -- process timer events
        ProcessTimerEvents = function (ev, arg)
                process_timers()
        end,

        -- exit if another wmiirc started up
        Start = function (ev, arg)
                if arg then
                        if arg == "wmiirc" then
                                -- backwards compatibility with bash version
                                log ("    exiting; pid=" .. tostring(myid))
                                cleanup()
                                os.exit (0)
                        else
                                -- ignore if it came from us
                                local pid = string.match(arg, "wmiirc (%d+)")
                                if pid then
                                        local pid = tonumber (pid)
                                        if not (pid == myid) then
                                                log ("    exiting; pid=" .. tostring(myid))
                                                cleanup()
                                                os.exit (0)
                                        end
                                end
                        end
                end
        end,

        -- tag management
        CreateTag = function (ev, arg)
                log ("CreateTag: " .. arg)
                create_tag_widget(arg)
        end,
        DestroyTag = function (ev, arg)
                log ("DestroyTag: " .. arg)
                destroy_tag_widget(arg)

                -- remove the tag from history
                local i,v
                for i=#view_hist,1,-1 do
                        v = view_hist[i]
                        if arg == v then
                                table.remove(view_hist,i)
                        end
                end
        end,

        FocusTag = function (ev, arg)
                log ("FocusTag: " .. arg)

                local tag,scrn = arg:match("(%w+)%s*(%w*)")
                if not tag then
                        return
                end

                local file = "/lbar/" .. tag
                if scrn and scrn:len() > 0 then
                        file = "/screen/" .. scrn .. file
                end

                local fc = get_screen_ctl(scrn, "focuscolors") or get_ctl("focuscolors") or ""
                log ("# echo " .. fc .. " " .. tag .. " | wmiir write " .. file)

                create (file, fc .. " " .. tag)
                write (file, fc .. " " .. tag)
        end,
        UnfocusTag = function (ev, arg)
                log ("UnfocusTag: " .. arg)

                local tag,scrn = arg:match("(%w+)%s*(%w*)")
                if not tag then
                        return
                end

                local file = "/lbar/" .. tag
                if scrn and scrn:len() > 0 then
                        file = "/screen/" .. scrn .. file
                end

                local nc = get_screen_ctl(scrn, "normcolors") or get_ctl("normcolors") or ""
                log ("# echo " .. nc .. " " .. tag .. " | wmiir write " .. file)

                create (file, nc .. " " .. tag)
                write (file, nc .. " " .. tag)

                -- don't duplicate the last entry
                if not (tag == view_hist[#view_hist]) then
                        view_hist[#view_hist+1] = tag

                        -- limit to view_hist_max
                        if #view_hist > view_hist_max then
                                table.remove(view_hist, 1)
                        end
                end
        end,

        -- key event handling
        Key = function (ev, arg)
                log ("Key: " .. arg)
                local magic = nil
                -- can we find an exact match?
                local fn = key_handlers[arg]
                if not fn then
                        local key = arg:gsub("-%d$", "-#")
                        -- can we find a match with a # wild card for the number
                        fn = key_handlers[key]
                        if fn then
                                -- convert the trailing number to a number
                                magic = tonumber(arg:match("-(%d)$"))
                        end
                end
                if not fn then
                        local key = arg:gsub("-%a$", "-@")
                        -- can we find a match with a @ wild card for a letter
                        fn = key_handlers[key]
                        if fn then
                                -- split off the trailing letter
                                magic = arg:match("-(%a)$")
                        end
                end
                if not fn then
                        -- everything else failed, try default match
                        fn = key_handlers["*"]
                end
                if fn then
                        local r, err = pcall (fn, arg, magic)
                        if not r then
                                log ("WARNING: " .. tostring(err))
                        end
                end
        end,

        -- mouse handling on the lbar
        LeftBarClick = function (ev, arg)
                local button,tag = string.match(arg, "(%w+)%s+(%S+)")
                set_view (tag)
        end,

        -- focus updates
        ClientFocus = function (ev, arg)
                log ("ClientFocus: " .. arg)
                client_focused (arg)
        end,
        ColumnFocus = function (ev, arg)
                log ("ColumnFocus: " .. arg)
        end,

        -- client handling
        CreateClient = function (ev, arg)
                if next_client_goes_to_tag then
                        local tag = next_client_goes_to_tag
                        local cli = arg
                        next_client_goes_to_tag = nil
                        write ("/client/" .. cli .. "/tags", tag)
                        set_view(tag)
                end
                client_created (arg)
        end,
        DestroyClient = function (ev, arg)
                client_destoryed (arg)
        end,

        -- urgent tag
        UrgentTag = function (ev, arg)
                log ("UrgentTag: " .. arg)
                write ("/lbar/" .. arg, "*" .. arg);
        end,
        NotUrgentTag = function (ev, arg)
                log ("NotUrgentTag: " .. arg)
                write ("/lbar/" .. arg, arg);
        end,

        -- notifications
        Unresponsive = function (ev, arg)
                log ("Unresponsive: " .. arg)
                -- TODO ask the user if it shoudl be killed off
        end,

        Notice = function (ev, arg)
                log ("Notice: " .. arg)
                -- TODO send to the message plugin (or implement there)
        end,

        -- /
}

--[[
=pod

=item add_widget_event_handler (wname, ev, fn)

Add an event handler callback for the I<ev> event on the widget named I<wname>

=cut
--]]
--
function add_widget_event_handler (wname, ev, fn)
        if type(wname) ~= "string" or type(ev) ~= "string" or type(fn) ~= "function" then
                error ("expecting string for widget name, string for event name and a function callback")
        end

        -- Make sure the widget event handler is present
        if not ev_handlers[ev] then
                ev_handlers[ev] = _handle_widget_event
        end

        if not widget_ev_handlers[wname] then
                widget_ev_handlers[wname] = { }
        end

        if widget_ev_handlers[wname][ev] then
                -- TODO: we may wish to allow multiple handlers for one event
                error ("event handler already exists on widget '" .. wname .. "' for '" .. ev .. "'")
        end

        widget_ev_handlers[wname][ev] = fn
end

--[[
=pod

=item remove_widget_event_handler (wname, ev)

Remove an event handler callback function for the I<ev> on the widget named I<wname>.

=cut
--]]
function remove_event_handler (wname, ev)

        if not widget_ev_handlers[wname] then
                return
        end

        widget_ev_handlers[wname][ev] = nil
end

--[[
=pod

=item add_event_handler (ev, fn)

Add an event handler callback function, I<fn>, for the given event I<ev>.

=cut
--]]
-- TODO: Need to allow registering widgets for RightBar* events.  Should probably be done with its own event table, though
function add_event_handler (ev, fn)
        if type(ev) ~= "string" or type(fn) ~= "function" then
                error ("expecting a string and a function")
        end

        if ev_handlers[ev] then
                -- TODO: we may wish to allow multiple handlers for one event
                error ("event handler already exists for '" .. ev .. "'")
        end


        ev_handlers[ev] = fn
end

--[[
=pod

=item remove_event_handler (ev)

Remove an event handler callback function for the given event I<ev>.

=cut
--]]
function remove_event_handler (ev)

        ev_handlers[ev] = nil
end


-- ========================================================================
-- MAIN INTERFACE FUNCTIONS
-- ========================================================================

local config = {
        xterm = 'x-terminal-emulator',
        xlock = "xscreensaver-command --lock",
        debug = false,
}

-- ------------------------------------------------------------------------
-- write configuration to /ctl wmii file
--   wmii.set_ctl({ "var" = "val", ...})
--   wmii.set_ctl("var, "val")
function set_ctl (first,second)
        if type(first) == "table" and second == nil then
                local x, y
                for x, y in pairs(first) do
                        write ("/ctl", x .. " " .. y)
                end

        elseif type(first) == "string" and type(second) == "string" then
                write ("/ctl", first .. " " .. second)

        else
                error ("expecting a table or two string arguments")
        end
end

-- ------------------------------------------------------------------------
-- read a value from /ctl wmii file
--   table = wmii.get_ctl()
--   value = wmii.get_ctl("variable")
function get_ctl (name)
        local s
        local t = {}
        for s in iread("/ctl") do
                local var,val = s:match("(%w+)%s+(.+)")
                if var == name then
                        return val
                end
                t[var] = val
        end
        if not name then
                return t
        end
        return nil
end

-- ------------------------------------------------------------------------
-- write configuration to /screen/*/ctl wmii file
--   wmii.set_screen_ctl("screen", { "var" = "val", ...})
--   wmii.set_screen_ctl("screen", "var, "val")
function set_screen_ctl (screen, first, second)
        local ctl = "/screen/" .. tostring(screen) .. "/ctl"
        if not screen then
                error ("screen is not set")
        elseif type(first) == "table" and second == nil then
                local x, y
                for x, y in pairs(first) do
                        write (ctl, x .. " " .. y)
                end

        elseif type(first) == "string" and type(second) == "string" then
                write (ctl, first .. " " .. second)

        else
                error ("expecting a screen name, followed by a table or two string arguments")
        end
end

-- ------------------------------------------------------------------------
-- read a value from /screen/*/ctl wmii file
--   table = wmii.get_screen_ctl("screen")
--   value = wmii.get_screen_ctl("screen", "variable")
function get_screen_ctl (screen, name)
        local s
        local t = {}
        if not screen then
                return nil
        end
        local ctl = "/screen/" .. tostring(screen) .. "/ctl"
        for s in iread(ctl) do
                local var,val = s:match("(%w+)%s+(.+)")
                if var == name then
                        return val
                end
                -- sometimes first line is the name of the entry
                -- in which case there will be no space
                t[var or ""] = val
        end
        if not name then
                return t
        end
        return nil
end

-- ------------------------------------------------------------------------
-- set an internal wmiirc.lua variable
--   wmii.set_conf({ "var" = "val", ...})
--   wmii.set_conf("var, "val")
function set_conf (first,second)
        if type(first) == "table" and second == nil then
                local x, y
                for x, y in pairs(first) do
                        config[x] = y
                end

        elseif type(first) == "string" 
                        and (type(second) == "string" 
                                or type(second) == "number"
                                or type(second) == "boolean") then
                config[first] = second

        else
                error ("expecting a table, or string and string/number as arguments")
        end
end

-- ------------------------------------------------------------------------
-- read an internal wmiirc.lua variable
function get_conf (name)
        if name then
                return config[name]
        end
        return config
end

-- ========================================================================
-- THE EVENT LOOP
-- ========================================================================

-- the event loop instance
local el = eventloop.new()
local event_read_fd = -1

-- ------------------------------------------------------------------------
-- start/restart the core event reading process
local function start_event_reader ()
        if event_read_fd ~= -1 then
                if el:check_exec(event_read_fd) then
                        return
                end
        end
        log("wmii: starting /event reading process")
        event_read_fd = el:add_exec (wmiir .. " read /event",
                function (line)
                        local line = line or "nil"

                        -- try to split off the argument(s)
                        local ev,arg = string.match(line, "(%S+)%s+(.+)")
                        if not ev then
                                ev = line
                        end

                        -- now locate the handler function and call it
                        local fn = ev_handlers[ev] or ev_handlers["*"]
                        if fn then
                                local r, err = pcall (fn, ev, arg)
                                if not r then
                                        log ("WARNING: " .. tostring(err))
                                end
                        end
                end
        )
        log("wmii: ... fd=" .. tostring(event_read_fd))
end

-- ------------------------------------------------------------------------
-- run the event loop and process events, this function does not exit
function run_event_loop ()
        -- stop any other instance of wmiirc
        wmixp:write ("/event", "Start wmiirc " .. tostring(myid))

        log("wmii: updating lbar")

        update_displayed_tags ()

        log("wmii: updating rbar")

        update_displayed_widgets ()

        log("wmii: updating active keys")

        update_active_keys ()

        log("wmii: starting event loop")
        while true do
                start_event_reader()
                local sleep_for = process_timers()
                el:run_loop(sleep_for)
        end
end

-- ========================================================================
-- PLUGINS API
-- ========================================================================

api_version = 0.1       -- the API version we export

plugins = {}            -- all plugins that were loaded

-- ------------------------------------------------------------------------
-- plugin loader which also verifies the version of the api the plugin needs
--
-- here is what it does
--   - does a manual locate on the file using package.path
--   - reads in the file w/o using the lua interpreter
--   - locates api_version=X.Y string
--   - makes sure that api_version requested can be satisfied
--   - if the plugins is available it will set variables passed in
--   - it then loads the plugin
--
-- TODO: currently the api_version must be in an X.Y format, but we may want 
-- to expend this so plugins can say they want '0.1 | 1.3 | 2.0' etc
--
function load_plugin(name, vars)
        local backup_path = package.path or "./?.lua"

        log ("loading " .. name)

        -- this is the version we want to find
        local api_major, api_minor = tostring(api_version):match("(%d+)%.0*(%d+)")
        if (not api_major) or (not api_minor) then
                log ("WARNING: could not parse api_version in core/wmii.lua")
                return nil
        end

        -- first find the plugin file
        local s, path_match, full_name, file
        for s in string.gmatch(plugin_path, "[^;]+") do
                -- try to locate the files locally
                local fn = s:gsub("%?", name)
                file = io.open(fn, "r")
                if file then
                        path_match = s
                        full_name = fn
                        break
                end
        end

        -- read it in
        local txt
        if file then
                txt = file:read("*all")
                file:close()
        end

        if not txt then
                log ("WARNING: could not load plugin '" .. name .. "'")
                return nil
        end

        -- find the api_version line
        local line, plugin_version
        for line in string.gmatch(txt, "%s*api_version%s*=%s*%d+%.%d+%s*") do
                plugin_version = line:match("api_version%s*=%s*(%d+%.%d+)%s*")
                if plugin_version then
                        break
                end
        end

        if not plugin_version then
                log ("WARNING: could not find api_version string in plugin '" .. name .. "'")
                return nil
        end

        -- decompose the version string
        local plugin_major, plugin_minor = plugin_version:match("(%d+)%.0*(%d+)")
        if (not plugin_major) or (not plugin_minor) then
                log ("WARNING: could not parse api_version for '" .. name .. "' plugin")
                return nil
        end

        -- make a version test
        if plugin_major ~= api_major then
                log ("WARNING: " .. name ..  " plugin major version missmatch, is " .. plugin_version 
                     .. " (api " .. tonumber(api_version) .. ")")
                return nil
        end

        if plugin_minor > api_minor then
                log ("WARNING: '" .. name ..  "' plugin minor version missmatch, is " .. plugin_version 
                     .. " (api " .. tonumber(api_version) .. ")")
                return nil
        end

        -- the configuration parameters before loading
        if type(vars) == "table" then
                local var, val
                for var,val in pairs(vars) do
                        local success = pcall (set_conf, name .. "." .. var, val)
                        if not success then
                                log ("WARNING: bad variable {" .. tostring(var) .. ", " .. tostring(val) .. "} "
                                        .. "given; loading '" .. name .. "' plugin failed.")
                                return nil
                        end
                end
        end

        -- actually load the module, but use only the path where we though it should be
        package.path = path_match
        local success,what = pcall (require, name)
        package.path = backup_path
        if not success then
                log ("WARNING: failed to load '" .. name .. "' plugin")
                log (" - path: " .. tostring(path_match))
                log (" - file: " .. tostring(full_name))
                log (" - plugin's api_version: " .. tostring(plugin_version))
                log (" - reason: " .. tostring(what))
                return nil
        end

        -- success
        log ("OK, plugin " .. name .. " loaded,  requested api v" .. plugin_version)
        plugins[name] = what
        return what
end

-- ------------------------------------------------------------------------
-- widget template
widget = {}
widgets = {}

-- ------------------------------------------------------------------------
-- create a widget object and add it to the wmii /rbar
--
-- examples:
--     widget = wmii.widget:new ("999_clock")
--     widget = wmii.widget:new ("999_clock", clock_event_handler)
function widget:new (name, fn)
        local o = {}

        if type(name) == "string" then
                o.name = name
                if type(fn) == "function" then
                        o.fn = fn
                end
        else
                error ("expected name followed by an optional function as arguments")
        end

        setmetatable (o,self)
        self.__index = self
        self.__gc = function (o) o:hide() end

        widgets[name] = o

        o:show()
        return o
end

-- ------------------------------------------------------------------------
-- stop and destroy the timer
function widget:delete ()
        widgets[self.name] = nil
        self:hide()
end

-- ------------------------------------------------------------------------
-- displays or updates the widget text
--
-- examples:
--   w:show("foo")
--   w:show("foo", "#888888 #222222 #333333")
--   w:show("foo", cell_fg .. " " .. cell_bg .. " " .. border)
--
function widget:show (txt, colors)
        local colors = colors or get_ctl("normcolors") or ""
        local txt = txt or self.txt or ""
        local towrite = txt
        if colors then
                towrite = colors .. " " .. towrite
        end
        if not self.txt then
                create ("/rbar/" .. self.name, towrite)
        else
                write ("/rbar/" .. self.name, towrite)
        end
        self.txt = txt
end

-- ------------------------------------------------------------------------
-- hides a widget and removes it from the bar
function widget:hide ()
        if self.txt then
                remove ("/lbar/" .. self.name)
                self.txt = nil
        end
end

--[[
=pod

=item widget:add_event_handler (ev, fn)

Add an event handler callback for this widget, using I<fn> for event I<ev>

=cut
--]]

function widget:add_event_handler (ev, fn)
        add_widget_event_handler( self.name, ev, fn) 
end


-- ------------------------------------------------------------------------
-- remove all /rbar entries that we don't have widget objects for
function update_displayed_widgets ()
        -- colours for /rbar
        local nc = get_ctl("normcolors") or ""

        -- build up a table of existing tags in the /lbar
        local old = {}
        local s
        for s in wmixp:idir ("/rbar") do
                old[s.name] = 1
        end

        -- for all actual widgets in use we want to remove them from the old list
        local i,v
        for i,v in pairs(widgets) do
                old[v.name] = nil
        end

        -- anything left in the old table should be removed now
        for i,v in pairs(old) do
                if v then
                        remove("/rbar/"..i)
                end
        end
end

-- ------------------------------------------------------------------------
-- create a new program and for each line it generates call the callback function
-- returns fd which can be passed to kill_exec()
function add_exec (command, callback)
        return el:add_exec (command, callback)
end

-- ------------------------------------------------------------------------
-- terminates a program spawned off by add_exec()
function kill_exec (fd)
        return el:kill_exec (fd)
end

-- ------------------------------------------------------------------------
-- timer template
timer = {}
local timers = {}

-- ------------------------------------------------------------------------
-- create a timer object and add it to the event loop
--
-- examples:
--     timer:new (my_timer_fn)
--     timer:new (my_timer_fn, 15)
function timer:new (fn, seconds)
        local o = {}

        if type(fn) == "function" then
                o.fn = fn
        else
                error ("expected function followed by an optional number as arguments")
        end

        setmetatable (o,self)
        self.__index = self
        self.__gc = function (o) o:stop() end

        -- add the timer
        timers[#timers+1] = o

        if seconds then
                o:resched(seconds)
        end
        return o
end

-- ------------------------------------------------------------------------
-- stop and destroy the timer
function timer:delete ()
        self:stop()
        local i,t
        for i,t in pairs(timers) do
                if t == self then
                        table.remove (timers,i)
                        return
                end
        end
end

-- ------------------------------------------------------------------------
-- run the timer given new interval
function timer:resched (seconds)
        local seconds = seconds or self.interval
        if not (type(seconds) == "number") then
                error ("timer:resched expected number as argument")
        end

        local now = tonumber(os.date("%s"))

        self.interval = seconds
        self.next_time = now + seconds

        -- resort the timer list
        table.sort (timers, timer.is_less_then)
end

-- helper for sorting timers
function timer:is_less_then(another)
        if not self.next_time then
                return false    -- another is smaller, nil means infinity

        elseif not another.next_time then
                return true     -- self is smaller, nil means infinity

        elseif self.next_time < another.next_time then
                return true     -- self is smaller than another
        end

        return false            -- another is smaller then self
end

-- ------------------------------------------------------------------------
-- stop the timer
function timer:stop ()
        self.next_time = nil

        -- resort the timer list
        table.sort (timers, timer.is_less_then)
end

-- ------------------------------------------------------------------------
-- figure out how long before the next event
function time_before_next_timer_event()
        local tmr = timers[1]
        if tmr and tmr.next_time then
                local now = tonumber(os.date("%s"))
                local seconds = tmr.next_time - now
                if seconds > 0 then
                        return seconds
                end
        end
        return 0        -- sleep for ever
end

-- ------------------------------------------------------------------------
-- handle outstanding events
function process_timers ()
        local now = tonumber(os.date("%s"))
        local torun = {}
        local i,tmr

        for i,tmr in pairs (timers) do
                if not tmr then
                        -- prune out removed timers
                        table.remove(timers,i)
                        break

                elseif not tmr.next_time then
                        -- break out once we find a timer that is stopped
                        break

                elseif tmr.next_time > now then
                        -- break out once we get to the future
                        break
                end

                -- this one is good to go
                torun[#torun+1] = tmr
        end

        for i,tmr in pairs (torun) do
                tmr:stop()
                local status,new_interval = pcall (tmr.fn, tmr)
                if status then
                        new_interval = new_interval or self.interval
                        if new_interval and (new_interval ~= -1) then
                                tmr:resched(new_interval)
                        end
                else
                        log ("ERROR: " .. tostring(new_interval))
                end
        end

        local sleep_for = time_before_next_timer_event()
        return sleep_for
end

-- ------------------------------------------------------------------------
-- cleanup everything in preparation for exit() or exec()
function cleanup ()

        local i,v,tmr,p

        log ("wmii: stopping timer events")

        for i,tmr in pairs (timers) do
                pcall (tmr.delete, tmr)
        end
        timers = {}

        log ("wmii: terminating eventloop")

        pcall(el.kill_all,el)

        log ("wmii: disposing of widgets")

        -- dispose of all widgets
        for i,v in pairs(widgets) do
                pcall(v.delete,v)
        end
        timers = {}

        -- FIXME: it doesn't seem to do what I want
        --[[ 
        log ("wmii: releasing plugins")

        for i,p in pairs(plugins) do
                if p.cleanup then
                        pcall (p.cleanup, p)
                end
        end
        plugins = {}
        --]]

        log ("wmii: dormant")
end

-- ========================================================================
-- CLIENT HANDLING
-- ========================================================================

--[[
-- Notes on client tracking
--
-- When a client is created wmii sends us a CreateClient message, and
-- we in turn create a 'client' object and store it in the 'clients'
-- table indexed by the client's ID.
--
-- Each client object stores the following:
--   .xid   - the X client ID
--   .pid   - the process ID
--   .prog  - program object representing the process
--
-- The client and program objects track the following modes for each program:
--
--   raw mode:
--      - for each client window
--      - Mod4-space toggles the state between normal and raw
--      - Mod1-f raw also toggles the state
--      - in raw mode all input goes to the client, except for Mod4-space
--      - a focused client with raw mode enabled is put into raw mode
--
--   suspend mode:
--      - for each program
--      - Mod1-f suspend toggles the state for current client's program
--      - a focused client, whose program was previous suspended is resumed
--      - an unfocused client, with suspend enabled, will be suspended
--      - suspend/resume is done by sending the STOP/CONT signals to the PID
--]]

function xid_to_pid (xid)
        local cmd = "xprop -id " .. tostring(xid) .. " _NET_WM_PID"
        local file = io.popen (cmd)
        local out = file:read("*a")
        file:close()
        local pid = out:match("^_NET_WM_PID.*%s+=%s+(%d+)%s+$")
        return tonumber(pid)
end

local focused_xid = nil
local clients = {}              -- table of client objects indexed by xid
local programs = {}             -- table of program objects indexed by pid
local mode_widget = widget:new ("999_client_mode")

-- make programs table have weak values
-- programs go away as soon as no clients point to it
local programs_mt = {}
setmetatable(programs, programs_mt)
programs_mt.__mode = 'v'

-- program class
program = {}
function program:new (pid)
        -- make an object
        local o = {}
        setmetatable (o,self)
        self.__index = self
        self.__gc = function (old) old:cont() end
        -- initialize the new object
        o.pid = pid
        -- suspend mode
        o.suspend = {}
        o.suspend.toggle = function (prog)
                                prog.suspend.enabled = not prog.suspend.enabled
                        end
        o.suspend.enabled = false       -- if true, defocusing suspends (SIGSTOP)
        o.suspend.active = true         -- if true, focusing resumes (SIGCONT)
        return o
end

function program:stop ()
        if not self.suspend.active then
                local cmd = "kill -STOP " .. tostring(self.pid)
                log ("    executing: " .. cmd)
                os.execute (cmd)
                self.suspend.active = true
        end
end

function program:cont ()
        if self.suspend.active then
                local cmd = "kill -CONT " .. tostring(self.pid)
                log ("    executing: " .. cmd)
                os.execute (cmd)
                self.suspend.active = false
        end
end

function get_program (pid)
        local prog = programs[pid]
        if pid and not prog then
                prog = program:new (pid)
                programs[pid] = prog
        end
        return prog
end

-- client class
client = {}
function client:new (xid)
        local pid = xid_to_pid(xid)
        if not pid then
                log ("WARNING: failed to convert XID " .. tostring(xid) .. " to a PID")
                return
        end
        -- make an object
        local o = {}
        setmetatable (o,self)
        self.__index = function (t,k) 
                if k == 'suspend' then          -- suspend mode is tracked per program
                        return t.prog.suspend
                end
                return self[k]
        end
        self.__gc = function (old) old.prog=nil end
        -- initialize the new object
        o.xid = xid
        o.pid = pid
        o.prog = get_program (pid)
        -- raw mode
        o.raw = {}
        o.raw.toggle = function (cli)
                                cli.raw.enabled = not cli.raw.enabled
                                cli:set_raw_mode()
                        end
        o.raw.enabled = false           -- if true, raw mode enabled when client is focused
        return o
end

function client:stop ()
        if self.suspend.enabled then
                self.prog:stop()
        end
end

function client:cont ()
        self.prog:cont()
end

function client:set_raw_mode()
        if not self or not self.raw.enabled then        -- normal mode
                update_active_keys ()
        else                                            -- raw mode
                write ("/keys", "Mod4-space")
        end
end

function client:toggle(what)
        if what and self[what] then
                local ctl = self[what]

                ctl.toggle (self)

                log ("xid=" .. tostring (xid) 
                .. "  pid=" .. tostring (self.pid) .. " (" .. tostring (self.prog.pid) .. ")"
                .. "  what=" .. tostring (what) 
                .. "  enabled=" .. tostring(ctl["enabled"]))
        end
        mode_widget:show (self:flags_string())
end

function client:flags_string()
        local ret = ''
        if self.suspend.enabled then ret = ret .. "s" else ret = ret .. "-" end
        if self.raw.enabled     then ret = ret .. "r" else ret = ret .. "-" end
        return ret
end

function get_client (xid)
        local xid = xid or wmixp:read("/client/sel/ctl")
        local cli = clients[xid]
        if not cli then
                cli = client:new (xid)
                clients[xid] = cli
        end
        return cli
end

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
function client_created (xid)
        log ("-client_created " .. tostring(xid))
        return get_client(xid)
end

function client_destoryed (xid)
        log ("-client_destoryed " .. tostring(xid))
        if clients[xid] then
                local cli = clients[xid]
                clients[xid] = nil
                log ("  del pid: " .. tostring(cli.pid))
                cli:cont()
        end
        if focused_xid == xid then
                focused_xid = nil
        end
end

function client_focused (xid)
        log ("-client_focused " .. tostring(xid))
        -- return the current focused xid if nil is passed
        if type(xid) ~= 'string' or not xid:match("0x[0-9][a-f][A-F]*$") then
                return focused_xid
        end
        -- do nothing if the same xid
        if focused_xid == xid then
                return clients[xid]
        end

        local old = clients[focused_xid]
        local new = get_client(xid)

        -- handle raw mode switch
        if not old or ( old and new and old.raw.enabled ~= new.raw.enabled ) then
                new:set_raw_mode()
        end

        -- do nothing if the same pid
        if old and new and old.pid == new.pid then
                mode_widget:show (new:flags_string())
                return clients[xid]
        end

        if old then
                --[[
                log ("  old pid: " .. tostring(old.pid)
                      .. "  xid: " .. tostring(old.xid)
                    .. "  flags: " .. old:flags_string())
                    ]]--
                old:stop()
        end

        if new then
                --[[
                log ("  new pid: " .. tostring(new.pid)
                      .. "  xid: " .. tostring(new.xid)
                    .. "  flags: " .. new:flags_string())
                    ]]--
                new:cont()
        end

        mode_widget:show (new:flags_string())
        focused_xid = xid
        return new
end


-- ========================================================================
-- DOCUMENTATION
-- ========================================================================

--[[
=pod

=back

=head1 ENVIRONMENT

=over 4

=item WMII_ADDRESS

Used to determine location of wmii's listen socket.

=back

=head1 SEE ALSO

L<wmii(1)>, L<lua(1)>

=head1 AUTHOR

Bart Trojanowski B<< <bart@jukie.net> >>

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2007, Bart Trojanowski <bart@jukie.net>

This is free software.  You may redistribute copies of it under the terms of
the GNU General Public License L<http://www.gnu.org/licenses/gpl.html>.  There
is NO WARRANTY, to the extent permitted by law.

=cut
--]]