2 -- Copyright (c) 2007, Bart Trojanowski <bart@jukie.net>
4 -- WMII event loop, in lua
6 -- http://www.jukie.net/~bart/blog/tag/wmiirc-lua
7 -- git://www.jukie.net/wmiirc-lua.git/
10 -- ========================================================================
12 -- ========================================================================
18 wmii.lua - WMII event-loop methods in lua
24 -- Write something to the wmii filesystem, in this case a key event.
25 wmii.write ("/event", "Key Mod1-j")
27 -- Set your wmii /ctl parameters
32 -- Configure wmii.lua parameters
34 xterm = 'x-terminal-emulator'
37 -- Now start the event loop
42 wmii.lua provides methods for replacing the stock sh-based wmiirc shipped with
43 wmii 3.6 and newer with a lua-based event loop.
45 It should be used by your wmiirc
54 -- ========================================================================
56 -- ========================================================================
58 local wmiidir
= os
.getenv("HOME") .. "/.wmii-3.5"
59 local wmiirc
= wmiidir
.. "/wmiirc"
61 package
.path
= wmiidir
.. "/core/?.lua;" ..
62 wmiidir
.. "/plugins/?.lua;" ..
64 package
.cpath
= wmiidir
.. "/core/?.so;" ..
65 wmiidir
.. "/plugins/?.so;" ..
68 local ixp
= require
"ixp"
69 local eventloop
= require
"eventloop"
70 local history
= require
"history"
72 local io
= require("io")
73 local os
= require("os")
74 local string = require("string")
75 local table = require("table")
76 local math
= require("math")
82 local package
= package
83 local require
= require
84 local tostring = tostring
85 local tonumber = tonumber
86 local setmetatable
= setmetatable
88 -- kinda silly, but there is no working liblua5.1-posix0 in ubuntu
89 -- so we make it optional
90 local have_posix
, posix
= pcall(require
,"posix")
97 -- but having posix is not enough as the API changes, so we try each one
98 if posix
.getprocessid
then
99 local stat
,rc
= pcall (posix
.getprocessid
, "pid")
104 if not myid
and posix
.getpid
then
105 local stat
,rc
= pcall (posix
.getpid
, "pid")
112 -- we were not able to get the PID, but we can create a random number
113 local now
= tonumber(os
.date("%s"))
115 myid
= math
.random(10000)
118 -- ========================================================================
120 -- ========================================================================
122 -- wmiir points to the wmiir executable
123 -- TODO: need to make sure that wmiir is in path, and if not find it
124 local wmiir
= "wmiir"
126 -- wmii_adr is the address we use when connecting using ixp
127 local wmii_adr
= os
.getenv("WMII_ADDRESS")
128 or ("unix!/tmp/ns." .. os
.getenv("USER") .. "."
129 .. os
.getenv("DISPLAY"):match("(:%d+)") .. "/wmii")
131 -- wmixp is the ixp context we use to talk to wmii
132 local wmixp
= ixp
.new(wmii_adr
)
134 -- history of previous views, view_hist[#view_hist] is the last one
135 local view_hist
= {} -- sorted with 1 being the oldest
136 local view_hist_max
= 50 -- max number to keep track of
138 -- allow for a client to be forced to a tag
139 local next_client_goes_to_tag
= nil
141 -- program and action histories
142 local prog_hist
= history
.new (20)
143 local action_hist
= history
.new(10)
145 -- where to find plugins
146 plugin_path
= os
.getenv("HOME") .. "/.wmii-3.5/plugins/?.so;"
147 .. os
.getenv("HOME") .. "/.wmii-3.5/plugins/?.lua;"
148 .. "/usr/local/lib/lua/5.1/wmii/?.so;"
149 .. "/usr/local/share/lua/5.1/wmii/?.lua;"
150 .. "/usr/lib/lua/5.1/wmii/?.so;"
151 .. "/usr/share/lua/5.1/wmii/?.lua"
153 -- where to find wmiirc (see find_wmiirc())
154 wmiirc_path
= os
.getenv("HOME") .. "/.wmii-3.5/wmiirc.lua;"
155 .. os
.getenv("HOME") .. "/.wmii-3.5/wmiirc;"
156 .. "/etc/X11/wmii-3.5/wmiirc.lua;"
157 .. "/etc/X11/wmii-3.5/wmiirc"
159 -- ========================================================================
161 -- ========================================================================
168 Log the message provided in C<str>
170 Currently just writes to io.stderr
175 if get_conf("debug") then
176 io
.stderr
:write (str
.. "\n")
183 =item find_wmiirc ( )
185 Locates the wmiirc script. It looks in ~/.wmii-3.5 and /etc/X11/wmii-3.5
186 for the first lua script bearing the name wmiirc.lua or wmiirc. Returns
191 function find_wmiirc()
193 for fn
in string.gmatch(wmiirc_path
, "[^;]+") do
194 -- try to locate the files locally
195 local file
= io
.open(fn
, "r")
197 local txt
= file
:read("*line")
199 if type(txt
) == 'string' and txt
:match("lua") then
208 -- ========================================================================
209 -- MAIN ACCESS FUNCTIONS
210 -- ========================================================================
215 =item ls ( dir, fmt )
217 List the wmii filesystem directory provided in C<dir>, in the format specified
220 Returns an iterator of TODO
224 function ls (dir
, fmt
)
225 local verbose
= fmt
and fmt
:match("l")
227 local s
= wmixp
:stat(dir
)
229 return function () return nil end
231 if s
.modestr
:match("^[^d]") then
233 return stat2str(verbose
, s
)
237 local itr
= wmixp
:idir (dir
)
248 return stat2str(verbose
, s
)
254 local function stat2str(verbose
, stat
)
256 return string.format("%s %s %s %5d %s %s", stat
.modestr
, stat
.uid
, stat
.gid
, stat
.length
, stat
.timestr
, stat
.name
)
258 if stat
.modestr
:match("^d") then
259 return stat
.name
.. "/"
266 -- ------------------------------------------------------------------------
267 -- read all contents of a wmii virtual file
269 return wmixp
:read (file
)
272 -- ------------------------------------------------------------------------
273 -- return an iterator which walks all the lines in the file
276 -- for event in wmii.iread("/ctl")
280 -- NOTE: don't use iread for files that could block, as this will interfere
281 -- with timer processing and event delivery. Instead fork off a process to
282 -- execute wmiir and read back the responses via callback.
283 function iread (file
)
284 return wmixp
:iread(file
)
287 -- ------------------------------------------------------------------------
288 -- create a wmii file, optionally write data to it
289 function create (file
, data
)
290 wmixp
:create(file
, data
)
293 -- ------------------------------------------------------------------------
294 -- remove a wmii file
295 function remove (file
)
299 -- ------------------------------------------------------------------------
300 -- write a value to a wmii virtual file system
301 function write (file
, value
)
302 wmixp
:write (file
, value
)
305 -- ------------------------------------------------------------------------
306 -- setup a table describing dmenu command
307 local function dmenu_cmd (prompt
, iterator
)
308 local cmdt
= { "dmenu", "-b" }
309 local fn
= get_ctl("font")
311 cmdt
[#cmdt
+1] = "-fn"
314 local normcolors
= get_ctl("normcolors")
316 local nf
, nb
= normcolors
:match("(#%x+)%s+(#%x+)%s#%x+")
318 cmdt
[#cmdt
+1] = "-nf"
319 cmdt
[#cmdt
+1] = "'" .. nf
.. "'"
322 cmdt
[#cmdt
+1] = "-nb"
323 cmdt
[#cmdt
+1] = "'" .. nb
.. "'"
326 local focuscolors
= get_ctl("focuscolors")
328 local sf
, sb
= focuscolors
:match("(#%x+)%s+(#%x+)%s#%x+")
330 cmdt
[#cmdt
+1] = "-sf"
331 cmdt
[#cmdt
+1] = "'" .. sf
.. "'"
334 cmdt
[#cmdt
+1] = "-sb"
335 cmdt
[#cmdt
+1] = "'" .. sb
.. "'"
340 cmdt
[#cmdt
+1] = "'" .. prompt
.. "'"
346 -- ------------------------------------------------------------------------
347 -- displays the menu given an table of entires, returns selected text
348 function menu (tbl
, prompt
)
349 local dmenu
= dmenu_cmd(prompt
)
351 local infile
= os
.tmpname()
352 local fh
= io
.open (infile
, "w+")
355 for i
,v
in pairs(tbl
) do
356 if type(i
) == 'number' and type(v
) == 'string' then
365 local outfile
= os
.tmpname()
367 dmenu
[#dmenu
+1] = "<"
368 dmenu
[#dmenu
+1] = infile
369 dmenu
[#dmenu
+1] = ">"
370 dmenu
[#dmenu
+1] = outfile
372 local cmd
= table.concat(dmenu
," ")
375 fh
= io
.open (outfile
, "r")
378 local sel
= fh
:read("*l")
384 -- ------------------------------------------------------------------------
385 -- displays the a tag selection menu, returns selected tag
387 local tags
= get_tags()
389 return menu(tags
, "tag:")
392 -- ------------------------------------------------------------------------
393 -- displays the a program menu, returns selected program
394 function prog_menu ()
395 local dmenu
= dmenu_cmd("cmd:")
397 local outfile
= os
.tmpname()
399 dmenu
[#dmenu
+1] = ">"
400 dmenu
[#dmenu
+1] = outfile
403 for n
in prog_hist
:walk_reverse_unique() do
404 hstt
[#hstt
+1] = "echo '" .. n
.. "' ; "
407 local cmd
= "(" .. table.concat(hstt
)
409 .. table.concat(dmenu
," ")
412 local fh
= io
.open (outfile
, "rb")
415 local prog
= fh
:read("*l")
421 -- ------------------------------------------------------------------------
422 -- displays the a program menu, returns selected program
426 for s
in wmixp
:idir ("/tag") do
427 if s
.name
and not (s
.name
== "sel") then
435 -- ------------------------------------------------------------------------
436 -- displays the a program menu, returns selected program
438 local v
= wmixp
:read("/ctl") or ""
439 return v
:match("view%s+(%S+)")
442 -- ------------------------------------------------------------------------
443 -- changes the current view to the name given
444 function set_view(sel
)
445 local cur
= get_view()
446 local all
= get_tags()
448 if #all
< 2 or sel
== cur
then
449 -- nothing to do if we have less then 2 tags
453 if not (type(sel
) == "string") then
454 error ("string argument expected")
458 write ("/ctl", "view " .. sel
)
461 -- ------------------------------------------------------------------------
462 -- changes the current view to the index given
463 function set_view_index(sel
)
464 local cur
= get_view()
465 local all
= get_tags()
468 -- nothing to do if we have less then 2 tags
472 local num
= tonumber (sel
)
474 error ("number argument expected")
477 local name
= all
[sel
]
478 if not name
or name
== cur
then
483 write ("/ctl", "view " .. name
)
486 -- ------------------------------------------------------------------------
487 -- chnages to current view by offset given
488 function set_view_ofs(jump
)
489 local cur
= get_view()
490 local all
= get_tags()
493 -- nothing to do if we have less then 2 tags
498 if (jump
< - #all
) or (jump
> #all
) then
499 error ("view selector is out of range")
502 -- find the one that's selected index
505 for i
,v
in pairs (all
) do
506 if v
== cur
then curi
= i
end
510 local newi
= math
.fmod(#all
+ curi
+ jump
- 1, #all
) + 1
511 if (newi
< - #all
) or (newi
> #all
) then
512 error ("error computng new view")
515 write ("/ctl", "view " .. all
[newi
])
518 -- ------------------------------------------------------------------------
519 -- toggle between last view and current view
520 function toggle_view()
521 local last
= view_hist
[#view_hist
]
527 -- ========================================================================
529 -- ========================================================================
531 local action_handlers
= {
532 man
= function (act
, args
)
533 local xterm
= get_conf("xterm") or "xterm"
535 if (not page
) or (not page
:match("%S")) then
536 page
= wmiidir
.. "/wmii.3lua"
538 local cmd
= xterm
.. " -e man " .. page
.. " &"
539 log (" executing: " .. cmd
)
544 write ("/ctl", "quit")
547 exec
= function (act
, args
)
548 local what
= args
or "wmii"
549 log (" asking wmii to exec " .. tostring(what
))
551 write ("/ctl", "exec " .. what
)
554 xlock
= function (act
)
555 local cmd
= get_conf("xlock") or "xscreensaver-command --lock"
561 local wmiirc
= find_wmiirc()
563 log (" executing: lua " .. wmiirc
)
566 posix
.exec ("/bin/sh", "-c", "exec lua wmiirc")
567 posix
.exec ("/usr/bin/lua", wmiirc
)
570 log("sorry cannot restart; you don't have lua's posix library.")
575 wmixp
:write ("/client/sel/ctl", "Urgent toggle")
580 -- TODO: consider storing list of executables around, and
581 -- this will then reinitialize that list
582 log (" TODO: rehash")
586 -- TODO: this should eventually update something on the /rbar
587 log (" TODO: status")
595 =item add_action_handler (action, fn)
597 Add an Alt-a action handler callback function, I<fn>, for the given action string I<action>.
601 function add_action_handler (action
, fn
)
603 if type(action
) ~= "string" or type(fn
) ~= "function" then
604 error ("expecting a string and a function")
607 if action_handlers
[action
] then
608 error ("action handler already exists for '" .. action
.. "'")
611 action_handlers
[action
] = fn
617 =item remove_action_handler (action)
619 Remove an action handler callback function for the given action string I<action>.
623 function remove_action_handler (action
)
625 action_handlers
[action
] = nil
628 -- ========================================================================
630 -- ========================================================================
632 function ke_fullscreen_toggle()
633 wmixp
:write ("/client/sel/ctl", "Fullscreen toggle")
636 function ke_view_starting_with_letter (letter
)
639 -- find the view name in history in reverse order
640 for i
=#view_hist
,1,-1 do
642 if letter
== v
:sub(1,1) then
648 -- otherwise just pick the first view that matches
649 local all
= get_tags()
650 for i
,v
in pairs(all
) do
651 if letter
== v
:sub(1,1) then
660 function ke_handle_action()
665 for n
in action_hist
:walk_reverse() do
667 actions
[#actions
+1] = n
673 for n
,v
in pairs(action_handlers
) do
675 actions
[#actions
+1] = n
680 local text
= menu(actions
, "action:")
682 log ("Action: " .. text
)
685 local si
= text
:find("%s")
687 act
,args
= string.match(text
.. " ", "(%w+)%s(.+)")
690 local fn
= action_handlers
[act
]
692 action_hist
:add (act
)
693 local r
, err
= pcall (fn
, act
, args
)
695 log ("WARNING: " .. tostring(err
))
703 local key_handlers
= {
704 ["*"] = function (key
)
708 -- execution and actions
709 ["Mod1-Return"] = function (key
)
710 local xterm
= get_conf("xterm") or "xterm"
711 log (" executing: " .. xterm
)
712 os
.execute (xterm
.. " &")
714 ["Mod1-Shift-Return"] = function (key
)
715 local tag = tag_menu()
717 local xterm
= get_conf("xterm") or "xterm"
718 log (" executing: " .. xterm
.. " on: " .. tag)
719 next_client_goes_to_tag
= tag
720 os
.execute (xterm
.. " &")
723 ["Mod1-a"] = function (key
)
726 ["Mod1-p"] = function (key
)
727 local prog
= prog_menu()
729 prog_hist
:add(prog
:match("(%w+)"))
730 log (" executing: " .. prog
)
731 os
.execute (prog
.. " &")
734 ["Mod1-Shift-p"] = function (key
)
735 local tag = tag_menu()
737 local prog
= prog_menu()
739 log (" executing: " .. prog
.. " on: " .. tag)
740 next_client_goes_to_tag
= tag
741 os
.execute (prog
.. " &")
745 ["Mod1-Shift-c"] = function (key
)
746 write ("/client/sel/ctl", "kill")
749 -- HJKL active selection
750 ["Mod1-h"] = function (key
)
751 write ("/tag/sel/ctl", "select left")
753 ["Mod1-l"] = function (key
)
754 write ("/tag/sel/ctl", "select right")
756 ["Mod1-j"] = function (key
)
757 write ("/tag/sel/ctl", "select down")
759 ["Mod1-k"] = function (key
)
760 write ("/tag/sel/ctl", "select up")
764 ["Mod1-Shift-h"] = function (key
)
765 write ("/tag/sel/ctl", "send sel left")
767 ["Mod1-Shift-l"] = function (key
)
768 write ("/tag/sel/ctl", "send sel right")
770 ["Mod1-Shift-j"] = function (key
)
771 write ("/tag/sel/ctl", "send sel down")
773 ["Mod1-Shift-k"] = function (key
)
774 write ("/tag/sel/ctl", "send sel up")
778 ["Mod1-space"] = function (key
)
779 write ("/tag/sel/ctl", "select toggle")
781 ["Mod1-Shift-space"] = function (key
)
782 write ("/tag/sel/ctl", "send sel toggle")
785 -- work spaces (# and @ are wildcards for numbers and letters)
786 ["Mod4-#"] = function (key
, num
)
787 -- first attempt to find a view that starts with the number requested
788 local num_str
= tostring(num
)
789 if not ke_view_starting_with_letter (num_str
) then
790 -- if we fail, then set it to the index requested
794 ["Mod4-Shift-#"] = function (key
, num
)
795 write ("/client/sel/tags", tostring(num
))
797 ["Mod4-@"] = function (key
, letter
)
798 ke_view_starting_with_letter (letter
)
800 ["Mod4-Shift-@"] = function (key
, letter
)
801 local all
= get_tags()
803 for i
,v
in pairs(all
) do
804 if letter
== v
:sub(1,1) then
805 write ("/client/sel/tags", v
)
810 ["Mod1-comma"] = function (key
)
813 ["Mod1-period"] = function (key
)
816 ["Mod1-r"] = function (key
)
817 -- got to the last view
821 -- switching views and retagging
822 ["Mod1-t"] = function (key
)
824 local tag = tag_menu()
829 ["Mod1-Shift-t"] = function (key
)
830 -- move selected client to a tag
831 local tag = tag_menu()
833 write ("/client/sel/tags", tag)
836 ["Mod1-Shift-r"] = function (key
)
837 -- move selected client to a tag, and follow
838 local tag = tag_menu()
840 write ("/client/sel/tags", tag)
844 ["Mod1-Control-t"] = function (key
)
845 log (" TODO: Mod1-Control-t: " .. key
)
849 ["Mod1-d"] = function (key
)
850 write("/tag/sel/ctl", "colmode sel default-max")
852 ["Mod1-s"] = function (key
)
853 write("/tag/sel/ctl", "colmode sel stack-max")
855 ["Mod1-m"] = function (key
)
856 write("/tag/sel/ctl", "colmode sel stack+max")
858 ["Mod1-f"] = function (key
)
859 ke_fullscreen_toggle()
862 -- changing client flags
863 ["Shift-Mod1-f"] = function (key
)
864 log ("setting flags")
866 local cli
= get_client ()
868 local flags
= { "suspend", "raw" }
869 local current_flags
= cli
:flags_string()
871 local what
= menu(flags
, "current flags: " .. current_flags
.. " toggle:")
875 ["Mod4-space"] = function (key
)
876 local cli
= get_client ()
884 =item add_key_handler (key, fn)
886 Add a keypress handler callback function, I<fn>, for the given key sequence I<key>.
890 function add_key_handler (key
, fn
)
892 if type(key
) ~= "string" or type(fn
) ~= "function" then
893 error ("expecting a string and a function")
896 if key_handlers
[key
] then
897 -- TODO: we may wish to allow multiple handlers for one keypress
898 error ("key handler already exists for '" .. key
.. "'")
901 key_handlers
[key
] = fn
907 =item remove_key_handler (key)
909 Remove an key handler callback function for the given key I<key>.
911 Returns the handler callback function.
915 function remove_key_handler (key
)
917 local fn
= key_handlers
[key
]
918 key_handlers
[key
] = nil
925 =item remap_key_handler (old_key, new_key)
927 Remove a key handler callback function from the given key I<old_key>,
928 and assign it to a new key I<new_key>.
932 function remap_key_handler (old_key
, new_key
)
934 local fn
= remove_key_handler(old_key
)
936 return add_key_handler (new_key
, fn
)
940 -- ------------------------------------------------------------------------
941 -- update the /keys wmii file with the list of all handlers
942 local alphabet
="abcdefghijklmnopqrstuvwxyz"
943 function update_active_keys ()
946 for x
,y
in pairs(key_handlers
) do
948 local i
= x
:find("#$")
952 t
[#t
+ 1] = x
:sub(1,i
-1) .. j
958 for j
=1,alphabet
:len() do
959 local a
= alphabet
:sub(j
,j
)
960 t
[#t
+ 1] = x
:sub(1,i
-1) .. a
963 t
[#t
+ 1] = tostring(x
)
968 local all_keys
= table.concat(t
, "\n")
969 --log ("setting /keys to...\n" .. all_keys .. "\n");
970 write ("/keys", all_keys
)
973 -- ------------------------------------------------------------------------
974 -- update the /lbar wmii file with the current tags
975 function update_displayed_tags ()
977 local fc
= get_ctl("focuscolors") or ""
978 local nc
= get_ctl("normcolors") or ""
980 -- build up a table of existing tags in the /lbar
983 for s
in wmixp
:idir ("/lbar") do
987 -- for all actual tags in use create any entries in /lbar we don't have
988 -- clear the old table entries if we have them
989 local cur
= get_view()
990 local all
= get_tags()
992 for i
,v
in pairs(all
) do
998 create ("/lbar/" .. v
, color
.. " " .. v
)
1000 write ("/lbar/" .. v
, color
.. " " .. v
)
1004 -- anything left in the old table should be removed now
1005 for i
,v
in pairs(old
) do
1012 -- ========================================================================
1014 -- ========================================================================
1016 local widget_ev_handlers
= {
1022 =item _handle_widget_event (ev, arg)
1024 Top-level event handler for redispatching events to widgets. This event
1025 handler is added for any widget event that currently has a widget registered
1028 Valid widget events are currently
1030 RightBarMouseDown <buttonnumber> <widgetname>
1031 RightBarClick <buttonnumber> <widgetname>
1033 the "Click" event is sent on mouseup.
1035 The callbacks are given only the button number as their argument, to avoid the
1041 local function _handle_widget_event (ev
, arg
)
1043 log("_handle_widget_event: " .. tostring(ev
) .. " - " .. tostring(arg
))
1045 -- parse arg to strip out our widget name
1046 local number,wname
= string.match(arg
, "(%d+)%s+(.+)")
1048 -- check our dispatch table for that widget
1050 log("Didn't find wname")
1054 local wtable
= widget_ev_handlers
[wname
]
1056 log("No widget cares about" .. wname
)
1060 local fn
= wtable
[ev
] or wtable
["*"]
1062 success
, err
= pcall( fn
, ev
, tonumber(number) )
1064 log("Callback had an error in _handle_widget_event: " .. tostring(err
) )
1068 log("no function found for " .. ev
)
1072 local ev_handlers
= {
1073 ["*"] = function (ev
, arg
)
1074 log ("ev: " .. tostring(ev
) .. " - " .. tostring(arg
))
1077 RightBarClick
= _handle_widget_event
,
1079 -- process timer events
1080 ProcessTimerEvents
= function (ev
, arg
)
1084 -- exit if another wmiirc started up
1085 Start
= function (ev
, arg
)
1087 if arg
== "wmiirc" then
1088 -- backwards compatibility with bash version
1089 log (" exiting; pid=" .. tostring(myid
))
1093 -- ignore if it came from us
1094 local pid
= string.match(arg
, "wmiirc (%d+)")
1096 local pid
= tonumber (pid
)
1097 if not (pid
== myid
) then
1098 log (" exiting; pid=" .. tostring(myid
))
1108 CreateTag
= function (ev
, arg
)
1109 local nc
= get_ctl("normcolors") or ""
1110 create ("/lbar/" .. arg
, nc
.. " " .. arg
)
1112 DestroyTag
= function (ev
, arg
)
1113 remove ("/lbar/" .. arg
)
1115 -- remove the tag from history
1117 for i
=#view_hist
,1,-1 do
1120 table.remove(view_hist
,i
)
1125 FocusTag
= function (ev
, arg
)
1126 local fc
= get_ctl("focuscolors") or ""
1127 create ("/lbar/" .. arg
, fc
.. " " .. arg
)
1128 write ("/lbar/" .. arg
, fc
.. " " .. arg
)
1130 UnfocusTag
= function (ev
, arg
)
1131 local nc
= get_ctl("normcolors") or ""
1132 create ("/lbar/" .. arg
, nc
.. " " .. arg
)
1133 write ("/lbar/" .. arg
, nc
.. " " .. arg
)
1135 -- don't duplicate the last entry
1136 if not (arg
== view_hist
[#view_hist
]) then
1137 view_hist
[#view_hist
+1] = arg
1139 -- limit to view_hist_max
1140 if #view_hist
> view_hist_max
then
1141 table.remove(view_hist
, 1)
1146 -- key event handling
1147 Key
= function (ev
, arg
)
1148 log ("Key: " .. arg
)
1150 -- can we find an exact match?
1151 local fn
= key_handlers
[arg
]
1153 local key
= arg
:gsub("-%d$", "-#")
1154 -- can we find a match with a # wild card for the number
1155 fn
= key_handlers
[key
]
1157 -- convert the trailing number to a number
1158 magic
= tonumber(arg
:match("-(%d)$"))
1162 local key
= arg
:gsub("-%a$", "-@")
1163 -- can we find a match with a @ wild card for a letter
1164 fn
= key_handlers
[key
]
1166 -- split off the trailing letter
1167 magic
= arg
:match("-(%a)$")
1171 -- everything else failed, try default match
1172 fn
= key_handlers
["*"]
1175 local r
, err
= pcall (fn
, arg
, magic
)
1177 log ("WARNING: " .. tostring(err
))
1182 -- mouse handling on the lbar
1183 LeftBarClick
= function (ev
, arg
)
1184 local button
,tag = string.match(arg
, "(%w+)%s+(%S+)")
1189 ClientFocus
= function (ev
, arg
)
1190 log ("ClientFocus: " .. arg
)
1191 client_focused (arg
)
1193 ColumnFocus
= function (ev
, arg
)
1194 log ("ColumnFocus: " .. arg
)
1198 CreateClient
= function (ev
, arg
)
1199 if next_client_goes_to_tag
then
1200 local tag = next_client_goes_to_tag
1202 next_client_goes_to_tag
= nil
1203 write ("/client/" .. cli
.. "/tags", tag)
1206 client_created (arg
)
1208 DestroyClient
= function (ev
, arg
)
1209 client_destoryed (arg
)
1213 UrgentTag
= function (ev
, arg
)
1214 log ("UrgentTag: " .. arg
)
1215 write ("/lbar/" .. arg
, "*" .. arg
);
1217 NotUrgentTag
= function (ev
, arg
)
1218 log ("NotUrgentTag: " .. arg
)
1219 write ("/lbar/" .. arg
, arg
);
1223 Unresponsive
= function (ev
, arg
)
1224 log ("Unresponsive: " .. arg
)
1225 -- TODO ask the user if it shoudl be killed off
1228 Notice
= function (ev
, arg
)
1229 log ("Notice: " .. arg
)
1230 -- TODO send to the message plugin (or implement there)
1239 =item add_widget_event_handler (wname, ev, fn)
1241 Add an event handler callback for the I<ev> event on the widget named I<wname>
1246 function add_widget_event_handler (wname
, ev
, fn
)
1247 if type(wname
) ~= "string" or type(ev
) ~= "string" or type(fn
) ~= "function" then
1248 error ("expecting string for widget name, string for event name and a function callback")
1251 -- Make sure the widget event handler is present
1252 if not ev_handlers
[ev
] then
1253 ev_handlers
[ev
] = _handle_widget_event
1256 if not widget_ev_handlers
[wname
] then
1257 widget_ev_handlers
[wname
] = { }
1260 if widget_ev_handlers
[wname
][ev
] then
1261 -- TODO: we may wish to allow multiple handlers for one event
1262 error ("event handler already exists on widget '" .. wname
.. "' for '" .. ev
.. "'")
1265 widget_ev_handlers
[wname
][ev
] = fn
1271 =item remove_widget_event_handler (wname, ev)
1273 Remove an event handler callback function for the I<ev> on the widget named I<wname>.
1277 function remove_event_handler (wname
, ev
)
1279 if not widget_ev_handlers
[wname
] then
1283 widget_ev_handlers
[wname
][ev
] = nil
1289 =item add_event_handler (ev, fn)
1291 Add an event handler callback function, I<fn>, for the given event I<ev>.
1295 -- TODO: Need to allow registering widgets for RightBar* events. Should probably be done with its own event table, though
1296 function add_event_handler (ev
, fn
)
1297 if type(ev
) ~= "string" or type(fn
) ~= "function" then
1298 error ("expecting a string and a function")
1301 if ev_handlers
[ev
] then
1302 -- TODO: we may wish to allow multiple handlers for one event
1303 error ("event handler already exists for '" .. ev
.. "'")
1307 ev_handlers
[ev
] = fn
1313 =item remove_event_handler (ev)
1315 Remove an event handler callback function for the given event I<ev>.
1319 function remove_event_handler (ev
)
1321 ev_handlers
[ev
] = nil
1325 -- ========================================================================
1326 -- MAIN INTERFACE FUNCTIONS
1327 -- ========================================================================
1330 xterm
= 'x-terminal-emulator',
1331 xlock
= "xscreensaver-command --lock",
1335 -- ------------------------------------------------------------------------
1336 -- write configuration to /ctl wmii file
1337 -- wmii.set_ctl({ "var" = "val", ...})
1338 -- wmii.set_ctl("var, "val")
1339 function set_ctl (first
,second
)
1340 if type(first
) == "table" and second
== nil then
1342 for x
, y
in pairs(first
) do
1343 write ("/ctl", x
.. " " .. y
)
1346 elseif type(first
) == "string" and type(second
) == "string" then
1347 write ("/ctl", first
.. " " .. second
)
1350 error ("expecting a table or two string arguments")
1354 -- ------------------------------------------------------------------------
1355 -- read a value from /ctl wmii file
1356 -- table = wmii.get_ctl()
1357 -- value = wmii.get_ctl("variable"
1358 function get_ctl (name
)
1361 for s
in iread("/ctl") do
1362 local var
,val
= s
:match("(%w+)%s+(.+)")
1374 -- ------------------------------------------------------------------------
1375 -- set an internal wmiirc.lua variable
1376 -- wmii.set_conf({ "var" = "val", ...})
1377 -- wmii.set_conf("var, "val")
1378 function set_conf (first
,second
)
1379 if type(first
) == "table" and second
== nil then
1381 for x
, y
in pairs(first
) do
1385 elseif type(first
) == "string"
1386 and (type(second
) == "string"
1387 or type(second
) == "number") then
1388 config
[first
] = second
1391 error ("expecting a table, or string and string/number as arguments")
1395 -- ------------------------------------------------------------------------
1396 -- read an internal wmiirc.lua variable
1397 function get_conf (name
)
1404 -- ========================================================================
1406 -- ========================================================================
1408 -- the event loop instance
1409 local el
= eventloop
.new()
1411 -- add the core event handler for events
1412 el
:add_exec (wmiir
.. " read /event",
1414 local line
= line
or "nil"
1416 -- try to split off the argument(s)
1417 local ev
,arg
= string.match(line
, "(%S+)%s+(.+)")
1422 -- now locate the handler function and call it
1423 local fn
= ev_handlers
[ev
] or ev_handlers
["*"]
1425 local r
, err
= pcall (fn
, ev
, arg
)
1427 log ("WARNING: " .. tostring(err
))
1432 -- ------------------------------------------------------------------------
1433 -- run the event loop and process events, this function does not exit
1434 function run_event_loop ()
1435 -- stop any other instance of wmiirc
1436 wmixp
:write ("/event", "Start wmiirc " .. tostring(myid
))
1438 log("wmii: updating lbar")
1440 update_displayed_tags ()
1442 log("wmii: updating rbar")
1444 update_displayed_widgets ()
1446 log("wmii: updating active keys")
1448 update_active_keys ()
1450 log("wmii: starting event loop")
1452 local sleep_for
= process_timers()
1453 el
:run_loop(sleep_for
)
1457 -- ========================================================================
1459 -- ========================================================================
1461 api_version
= 0.1 -- the API version we export
1463 plugins
= {} -- all plugins that were loaded
1465 -- ------------------------------------------------------------------------
1466 -- plugin loader which also verifies the version of the api the plugin needs
1468 -- here is what it does
1469 -- - does a manual locate on the file using package.path
1470 -- - reads in the file w/o using the lua interpreter
1471 -- - locates api_version=X.Y string
1472 -- - makes sure that api_version requested can be satisfied
1473 -- - if the plugins is available it will set variables passed in
1474 -- - it then loads the plugin
1476 -- TODO: currently the api_version must be in an X.Y format, but we may want
1477 -- to expend this so plugins can say they want '0.1 | 1.3 | 2.0' etc
1479 function load_plugin(name
, vars
)
1480 local backup_path
= package
.path
or "./?.lua"
1482 log ("loading " .. name
)
1484 -- this is the version we want to find
1485 local api_major
, api_minor
= tostring(api_version
):match("(%d+)%.0*(%d+)")
1486 if (not api_major
) or (not api_minor
) then
1487 log ("WARNING: could not parse api_version in core/wmii.lua")
1491 -- first find the plugin file
1492 local s
, path_match
, full_name
, file
1493 for s
in string.gmatch(plugin_path
, "[^;]+") do
1494 -- try to locate the files locally
1495 local fn
= s
:gsub("%?", name
)
1496 file
= io
.open(fn
, "r")
1507 txt
= file
:read("*all")
1512 log ("WARNING: could not load plugin '" .. name
.. "'")
1516 -- find the api_version line
1517 local line
, plugin_version
1518 for line
in string.gmatch(txt
, "%s*api_version%s*=%s*%d+%.%d+%s*") do
1519 plugin_version
= line
:match("api_version%s*=%s*(%d+%.%d+)%s*")
1520 if plugin_version
then
1525 if not plugin_version
then
1526 log ("WARNING: could not find api_version string in plugin '" .. name
.. "'")
1530 -- decompose the version string
1531 local plugin_major
, plugin_minor
= plugin_version
:match("(%d+)%.0*(%d+)")
1532 if (not plugin_major
) or (not plugin_minor
) then
1533 log ("WARNING: could not parse api_version for '" .. name
.. "' plugin")
1537 -- make a version test
1538 if plugin_major
~= api_major
then
1539 log ("WARNING: " .. name
.. " plugin major version missmatch, is " .. plugin_version
1540 .. " (api " .. tonumber(api_version
) .. ")")
1544 if plugin_minor
> api_minor
then
1545 log ("WARNING: '" .. name
.. "' plugin minor version missmatch, is " .. plugin_version
1546 .. " (api " .. tonumber(api_version
) .. ")")
1550 -- the configuration parameters before loading
1551 if type(vars
) == "table" then
1553 for var
,val
in pairs(vars
) do
1554 local success
= pcall (set_conf
, name
.. "." .. var
, val
)
1556 log ("WARNING: bad variable {" .. tostring(var
) .. ", " .. tostring(val
) .. "} "
1557 .. "given; loading '" .. name
.. "' plugin failed.")
1563 -- actually load the module, but use only the path where we though it should be
1564 package
.path
= path_match
1565 local success
,what
= pcall (require
, name
)
1566 package
.path
= backup_path
1568 log ("WARNING: failed to load '" .. name
.. "' plugin")
1569 log (" - path: " .. tostring(path_match
))
1570 log (" - file: " .. tostring(full_name
))
1571 log (" - plugin's api_version: " .. tostring(plugin_version
))
1572 log (" - reason: " .. tostring(what
))
1577 log ("OK, plugin " .. name
.. " loaded, requested api v" .. plugin_version
)
1578 plugins
[name
] = what
1582 -- ------------------------------------------------------------------------
1587 -- ------------------------------------------------------------------------
1588 -- create a widget object and add it to the wmii /rbar
1591 -- widget = wmii.widget:new ("999_clock")
1592 -- widget = wmii.widget:new ("999_clock", clock_event_handler)
1593 function widget
:new (name
, fn
)
1596 if type(name
) == "string" then
1598 if type(fn
) == "function" then
1602 error ("expected name followed by an optional function as arguments")
1605 setmetatable (o
,self
)
1607 self
.__gc
= function (o
) o
:hide() end
1615 -- ------------------------------------------------------------------------
1616 -- stop and destroy the timer
1617 function widget
:delete ()
1618 widgets
[self
.name
] = nil
1622 -- ------------------------------------------------------------------------
1623 -- displays or updates the widget text
1627 -- w:show("foo", "#888888 #222222 #333333")
1628 -- w:show("foo", cell_fg .. " " .. cell_bg .. " " .. border)
1630 function widget
:show (txt
, colors
)
1631 local colors
= colors
or get_ctl("normcolors") or ""
1632 local txt
= txt
or self
.txt
or ""
1635 towrite
= colors
.. " " .. towrite
1637 if not self
.txt
then
1638 create ("/rbar/" .. self
.name
, towrite
)
1640 write ("/rbar/" .. self
.name
, towrite
)
1645 -- ------------------------------------------------------------------------
1646 -- hides a widget and removes it from the bar
1647 function widget
:hide ()
1649 remove ("/lbar/" .. self
.name
)
1657 =item widget:add_event_handler (ev, fn)
1659 Add an event handler callback for this widget, using I<fn> for event I<ev>
1664 function widget
:add_event_handler (ev
, fn
)
1665 add_widget_event_handler( self
.name
, ev
, fn
)
1669 -- ------------------------------------------------------------------------
1670 -- remove all /rbar entries that we don't have widget objects for
1671 function update_displayed_widgets ()
1672 -- colours for /rbar
1673 local nc
= get_ctl("normcolors") or ""
1675 -- build up a table of existing tags in the /lbar
1678 for s
in wmixp
:idir ("/rbar") do
1682 -- for all actual widgets in use we want to remove them from the old list
1684 for i
,v
in pairs(widgets
) do
1688 -- anything left in the old table should be removed now
1689 for i
,v
in pairs(old
) do
1696 -- ------------------------------------------------------------------------
1697 -- create a new program and for each line it generates call the callback function
1698 -- returns fd which can be passed to kill_exec()
1699 function add_exec (command
, callback
)
1700 return el
:add_exec (command
, callback
)
1703 -- ------------------------------------------------------------------------
1704 -- terminates a program spawned off by add_exec()
1705 function kill_exec (fd
)
1706 return el
:kill_exec (fd
)
1709 -- ------------------------------------------------------------------------
1714 -- ------------------------------------------------------------------------
1715 -- create a timer object and add it to the event loop
1718 -- timer:new (my_timer_fn)
1719 -- timer:new (my_timer_fn, 15)
1720 function timer
:new (fn
, seconds
)
1723 if type(fn
) == "function" then
1726 error ("expected function followed by an optional number as arguments")
1729 setmetatable (o
,self
)
1731 self
.__gc
= function (o
) o
:stop() end
1734 timers
[#timers
+1] = o
1742 -- ------------------------------------------------------------------------
1743 -- stop and destroy the timer
1744 function timer
:delete ()
1747 for i
,t
in pairs(timers
) do
1749 table.remove (timers
,i
)
1755 -- ------------------------------------------------------------------------
1756 -- run the timer given new interval
1757 function timer
:resched (seconds
)
1758 local seconds
= seconds
or self
.interval
1759 if not (type(seconds
) == "number") then
1760 error ("timer:resched expected number as argument")
1763 local now
= tonumber(os
.date("%s"))
1765 self
.interval
= seconds
1766 self
.next_time
= now
+ seconds
1768 -- resort the timer list
1769 table.sort (timers
, timer
.is_less_then
)
1772 -- helper for sorting timers
1773 function timer
:is_less_then(another
)
1774 if not self
.next_time
then
1775 return false -- another is smaller, nil means infinity
1777 elseif not another
.next_time
then
1778 return true -- self is smaller, nil means infinity
1780 elseif self
.next_time
< another
.next_time
then
1781 return true -- self is smaller than another
1784 return false -- another is smaller then self
1787 -- ------------------------------------------------------------------------
1789 function timer
:stop ()
1790 self
.next_time
= nil
1792 -- resort the timer list
1793 table.sort (timers
, timer
.is_less_then
)
1796 -- ------------------------------------------------------------------------
1797 -- figure out how long before the next event
1798 function time_before_next_timer_event()
1799 local tmr
= timers
[1]
1800 if tmr
and tmr
.next_time
then
1801 local now
= tonumber(os
.date("%s"))
1802 local seconds
= tmr
.next_time
- now
1807 return 0 -- sleep for ever
1810 -- ------------------------------------------------------------------------
1811 -- handle outstanding events
1812 function process_timers ()
1813 local now
= tonumber(os
.date("%s"))
1817 for i
,tmr
in pairs (timers
) do
1819 -- prune out removed timers
1820 table.remove(timers
,i
)
1823 elseif not tmr
.next_time
then
1824 -- break out once we find a timer that is stopped
1827 elseif tmr
.next_time
> now
then
1828 -- break out once we get to the future
1832 -- this one is good to go
1833 torun
[#torun
+1] = tmr
1836 for i
,tmr
in pairs (torun
) do
1838 local status
,new_interval
= pcall (tmr
.fn
, tmr
)
1840 new_interval
= new_interval
or self
.interval
1841 if new_interval
and (new_interval
~= -1) then
1842 tmr
:resched(new_interval
)
1845 log ("ERROR: " .. tostring(new_interval
))
1849 local sleep_for
= time_before_next_timer_event()
1853 -- ------------------------------------------------------------------------
1854 -- cleanup everything in preparation for exit() or exec()
1859 log ("wmii: stopping timer events")
1861 for i
,tmr
in pairs (timers
) do
1862 pcall (tmr
.delete
, tmr
)
1866 log ("wmii: terminating eventloop")
1868 pcall(el
.kill_all
,el
)
1870 log ("wmii: disposing of widgets")
1872 -- dispose of all widgets
1873 for i
,v
in pairs(widgets
) do
1878 -- FIXME: it doesn't seem to do what I want
1880 log ("wmii: releasing plugins")
1882 for i,p in pairs(plugins) do
1884 pcall (p.cleanup, p)
1890 log ("wmii: dormant")
1893 -- ========================================================================
1895 -- ========================================================================
1898 -- Notes on client tracking
1900 -- When a client is created wmii sends us a CreateClient message, and
1901 -- we in turn create a 'client' object and store it in the 'clients'
1902 -- table indexed by the client's ID.
1904 -- Each client object stores the following:
1905 -- .xid - the X client ID
1906 -- .pid - the process ID
1907 -- .prog - program object representing the process
1909 -- The client and program objects track the following modes for each program:
1912 -- - for each client window
1913 -- - Mod4-space toggles the state between normal and raw
1914 -- - Mod1-f raw also toggles the state
1915 -- - in raw mode all input goes to the client, except for Mod4-space
1916 -- - a focused client with raw mode enabled is put into raw mode
1919 -- - for each program
1920 -- - Mod1-f suspend toggles the state for current client's program
1921 -- - a focused client, whose program was previous suspended is resumed
1922 -- - an unfocused client, with suspend enabled, will be suspended
1923 -- - suspend/resume is done by sending the STOP/CONT signals to the PID
1926 function xid_to_pid (xid
)
1927 local cmd
= "xprop -id " .. tostring(xid
) .. " _NET_WM_PID"
1928 local file
= io
.popen (cmd
)
1929 local out
= file
:read("*a")
1931 local pid
= out
:match("^_NET_WM_PID.*%s+=%s+(%d+)%s+$")
1932 return tonumber(pid
)
1935 local focused_xid
= nil
1936 local clients
= {} -- table of client objects indexed by xid
1937 local programs
= {} -- table of program objects indexed by pid
1938 local mode_widget
= widget
:new ("999_client_mode")
1940 -- make programs table have weak values
1941 -- programs go away as soon as no clients point to it
1942 local programs_mt
= {}
1943 setmetatable(programs
, programs_mt
)
1944 programs_mt
.__mode
= 'v'
1948 function program
:new (pid
)
1951 setmetatable (o
,self
)
1953 self
.__gc
= function (old
) old
:cont() end
1954 -- initialize the new object
1958 o
.suspend
.toggle
= function (prog
)
1959 prog
.suspend
.enabled
= not prog
.suspend
.enabled
1961 o
.suspend
.enabled
= false -- if true, defocusing suspends (SIGSTOP)
1962 o
.suspend
.active
= true -- if true, focusing resumes (SIGCONT)
1966 function program
:stop ()
1967 if not self
.suspend
.active
then
1968 local cmd
= "kill -STOP " .. tostring(self
.pid
)
1969 log (" executing: " .. cmd
)
1971 self
.suspend
.active
= true
1975 function program
:cont ()
1976 if self
.suspend
.active
then
1977 local cmd
= "kill -CONT " .. tostring(self
.pid
)
1978 log (" executing: " .. cmd
)
1980 self
.suspend
.active
= false
1984 function get_program (pid
)
1985 local prog
= programs
[pid
]
1987 prog
= program
:new (pid
)
1988 programs
[pid
] = prog
1995 function client
:new (xid
)
1998 setmetatable (o
,self
)
1999 self
.__index
= function (t
,k
)
2000 if k
== 'suspend' then -- suspend mode is tracked per program
2001 return t
.prog
.suspend
2005 self
.__gc
= function (old
) old
.prog
=nil end
2006 -- initialize the new object
2008 o
.pid
= xid_to_pid(xid
)
2009 o
.prog
= get_program (o
.pid
)
2012 o
.raw
.toggle
= function (cli
)
2013 cli
.raw
.enabled
= not cli
.raw
.enabled
2016 o
.raw
.enabled
= false -- if true, raw mode enabled when client is focused
2020 function client
:stop ()
2021 if self
.suspend
.enabled
then
2026 function client
:cont ()
2030 function client
:set_raw_mode()
2031 if not self
or not self
.raw
.enabled
then -- normal mode
2032 update_active_keys ()
2034 write ("/keys", "Mod4-space")
2038 function client
:toggle(what
)
2039 if what
and self
[what
] then
2040 local ctl
= self
[what
]
2044 log ("xid=" .. tostring (xid
)
2045 .. " pid=" .. tostring (self
.pid
) .. " (" .. tostring (self
.prog
.pid
) .. ")"
2046 .. " what=" .. tostring (what
)
2047 .. " enabled=" .. tostring(ctl
["enabled"]))
2049 mode_widget
:show (self
:flags_string())
2052 function client
:flags_string()
2054 if self
.suspend
.enabled
then ret
= ret
.. "s" else ret
= ret
.. "-" end
2055 if self
.raw
.enabled
then ret
= ret
.. "r" else ret
= ret
.. "-" end
2059 function get_client (xid
)
2060 local xid
= xid
or wmixp
:read("/client/sel/ctl")
2061 local cli
= clients
[xid
]
2063 cli
= client
:new (xid
)
2069 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
2070 function client_created (xid
)
2071 log ("-client_created " .. tostring(xid
))
2072 return get_client(xid
)
2075 function client_destoryed (xid
)
2076 log ("-client_destoryed " .. tostring(xid
))
2077 if clients
[xid
] then
2078 local cli
= clients
[xid
]
2080 log (" del pid: " .. tostring(cli
.pid
))
2083 if focused_xid
== xid
then
2088 function client_focused (xid
)
2089 log ("-client_focused " .. tostring(xid
))
2090 -- return the current focused xid if nil is passed
2094 -- do nothing if the same xid
2095 if focused_xid
== xid
then
2099 local old
= clients
[focused_xid
]
2100 local new
= get_client(xid
)
2102 -- handle raw mode switch
2103 if not old
or ( old
and new
and old
.raw
.enabled
~= new
.raw
.enabled
) then
2107 -- do nothing if the same pid
2108 if old
and new
and old
.pid
== new
.pid
then
2109 mode_widget
:show (new
:flags_string())
2115 log (" old pid: " .. tostring(old.pid)
2116 .. " xid: " .. tostring(old.xid)
2117 .. " flags: " .. old:flags_string())
2124 log (" new pid: " .. tostring(new.pid)
2125 .. " xid: " .. tostring(new.xid)
2126 .. " flags: " .. new:flags_string())
2131 mode_widget
:show (new
:flags_string())
2137 -- ========================================================================
2139 -- ========================================================================
2152 Used to determine location of wmii's listen socket.
2158 L<wmii(1)>, L<lua(1)>
2162 Bart Trojanowski B<< <bart@jukie.net> >>
2164 =head1 COPYRIGHT AND LICENSE
2166 Copyright (c) 2007, Bart Trojanowski <bart@jukie.net>
2168 This is free software. You may redistribute copies of it under the terms of
2169 the GNU General Public License L<http://www.gnu.org/licenses/gpl.html>. There
2170 is NO WARRANTY, to the extent permitted by law.