]> git.madduck.net Git - etc/awesome.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

util.menu_iterator: cleaned indentation; added wiki entry; closes #386
authorLuca CPZ <luca.cpz@gmail.com>
Sat, 17 Feb 2018 13:06:20 +0000 (14:06 +0100)
committerLuca CPZ <luca.cpz@gmail.com>
Sat, 17 Feb 2018 13:06:20 +0000 (14:06 +0100)
helpers.lua
util/menu_iterator.lua
wiki

index 313579f8a3d28368b4918faf5e0a32f4b9ca9e37..fb71335f91a25a6a6b995648a91a8e45e2ef2649 100644 (file)
@@ -10,6 +10,7 @@ local timer      = require("gears.timer")
 local debug      = require("debug")
 local io         = { lines = io.lines,
                      open  = io.open }
 local debug      = require("debug")
 local io         = { lines = io.lines,
                      open  = io.open }
+local pairs      = pairs
 local rawget     = rawget
 local table      = { sort  = table.sort }
 
 local rawget     = rawget
 local table      = { sort  = table.sort }
 
@@ -179,9 +180,8 @@ function helpers.spairs(t)
     end
 end
 
     end
 end
 
--- create trivial partition of a set. The trivial partition set is the simplest
--- partition of a set. For e.g., the trivial partition set of {a, b, c}, is
--- simply {{a}, {b}, {c}}.
+-- create the partition of singletons of a given set
+-- example: the trivial partition set of {a, b, c}, is {{a}, {b}, {c}}
 function helpers.trivial_partition_set(set)
     local ss = {}
     for _,e in pairs(set) do
 function helpers.trivial_partition_set(set)
     local ss = {}
     for _,e in pairs(set) do
index 913482a2829f0c974d62dfccf3e3f15960d57916..0ea4e0e2d2f9cdf6bf0c30fbe9b093dc66e5aeb0 100644 (file)
@@ -7,16 +7,22 @@
 
 --]]
 
 
 --]]
 
--- Menu iterator using naughty.notify
+-- Menu iterator with Naughty notifications
+-- lain.util.menu_iterator
 
 local naughty = require("naughty")
 
 local naughty = require("naughty")
-local util = require("lain.util")
+local util    = require("lain.util")
+local atable  = require("awful.util").table
+local assert  = assert
+local pairs   = pairs
+local tconcat = table.concat
+local unpack  = unpack
 
 local state = { cid = nil }
 
 local function naughty_destroy_callback(reason)
 
 local state = { cid = nil }
 
 local function naughty_destroy_callback(reason)
-    if reason == naughty.notificationClosedReason.expired or
-        reason == naughty.notificationClosedReason.dismissedByUser then
+    local closed = naughty.notificationClosedReason
+    if reason == closed.expired or reason == closed.dismissedByUser then
         local actions = state.index and state.menu[state.index - 1][2]
         if actions then
             for _,action in pairs(actions) do
         local actions = state.index and state.menu[state.index - 1][2]
         if actions then
             for _,action in pairs(actions) do
@@ -28,14 +34,15 @@ local function naughty_destroy_callback(reason)
     end
 end
 
     end
 end
 
--- Iterates over a list of pairs {label, {callbacks}}. After timeout, the last
--- visited choice associated callbacks are executed.
--- * menu:    a list of pairs {label, {callbacks}
--- * timeout: time to wait before confirming menu selection
--- * icon:    icon to display left to the choiced label
+-- Iterates over a menu.
+-- After the timeout, callbacks associated to the last visited choice are
+-- executed. Inputs:
+-- * menu:    a list of {label, {callbacks}} pairs
+-- * timeout: time to wait before confirming the menu selection
+-- * icon:    icon to display in the notification of the chosen label
 local function iterate(menu, timeout, icon)
 local function iterate(menu, timeout, icon)
-    timeout = timeout or 4 -- default timeout for each menu entry
-    icon    = icon or nil  -- icon to display on the menu
+    local timeout = timeout or 4 -- default timeout for each menu entry
+    local icon    = icon or nil  -- icon to display on the menu
 
     -- Build the list of choices
     if not state.index then
 
     -- Build the list of choices
     if not state.index then
@@ -44,8 +51,8 @@ local function iterate(menu, timeout, icon)
     end
 
     -- Select one and display the appropriate notification
     end
 
     -- Select one and display the appropriate notification
-    local label, action
-    local next  = state.menu[state.index]
+    local label
+    local next = state.menu[state.index]
     state.index = state.index + 1
 
     if not next then
     state.index = state.index + 1
 
     if not next then
@@ -54,86 +61,84 @@ local function iterate(menu, timeout, icon)
     else
         label, _ = unpack(next)
     end
     else
         label, _ = unpack(next)
     end
+
     state.cid = naughty.notify({
     state.cid = naughty.notify({
-        text = label,
-        icon = icon,
-        timeout = timeout,
-        screen = mouse.screen,
+        text        = label,
+        icon        = icon,
+        timeout     = timeout,
+        screen      = mouse.screen,
         replaces_id = state.cid,
         replaces_id = state.cid,
-        destroy = naughty_destroy_callback
+        destroy     = naughty_destroy_callback
     }).id
 end
 
     }).id
 end
 
--- Generates a menu compatible with the iterate function argument and suitable
--- for the following cases:
--- * all possible choices individually.
--- * all possible choices are all the possible subsets of the set of individual
---   choices (the powerset)
+-- Generates a menu compatible with the first argument of `iterate` function and
+-- suitable for the following cases:
+-- * all possible choices individually (partition of singletons);
+-- * all possible subsets of the set of choices (powerset).
 --
 --
--- The following describes the function arguments:
+-- Inputs:
 -- * args: an array containing the following members:
 -- * args: an array containing the following members:
---   * choices:       the list of choices from which to generate the menu
---   * name:          the displayed name of the menu (in the form "name: choices")
---   * selected_cb:   the callback to execute for each selected choice. Takes
---                    the choice as a string argument. The function
---                    menu_iterator.naughty_destroy_callback will handle nil
---                    callbacks. It is then fine to pass nil callbacks.
---   * rejected_cb:   the callback to execute for each rejected choice (in the
---                    set of possible choices, but not selected). Takes the
---                    choice as a string argument. The function
---                    menu_iterator.naughty_destroy_callback will handle nil
---                    callbacks. It is then fine to pass nil callbacks.
---   * extra_choices: an array of pairs { choice_text, cb } for extra choices to
---                    be added to the menu. The function
---                    menu_iterator.naughty_destroy_callback will handle nil
---                    callbacks. It is then fine to pass nil callbacks.
---   * combination:   the combination of choice to generate. Possible choices
---                    are "powerset" and "single" (the default).
+--   * choices:       Array of choices (string) on which the menu will be
+--                    generated.
+--   * name:          Displayed name of the menu (in the form "name: choices").
+--   * selected_cb:   Callback to execute for each selected choice. Takes
+--                    the choice as a string argument. Can be `nil` (no action
+--                    to execute).
+--   * rejected_cb:   Callback to execute for each rejected choice (possible
+--                    choices which are not selected). Takes the choice as a
+--                    string argument. Can be `nil` (no action to execute).
+--   * extra_choices: An array of extra { choice_str, callback_fun } pairs to be
+--                    added to the menu. Each callback_fun can be `nil`.
+--   * combination:   The combination of choices to generate. Possible values:
+--                    "powerset" and "single" (default).
+-- Output:
+-- * m: menu to be iterated over.
 local function menu(args)
 local function menu(args)
-    local choices     = assert(args.choices or args[1])
-    local name        = assert(args.name or args[2])
-    local selected_cb = args.selected_cb
-    local rejected_cb = args.rejected_cb
+    local choices       = assert(args.choices or args[1])
+    local name          = assert(args.name or args[2])
+    local selected_cb   = args.selected_cb
+    local rejected_cb   = args.rejected_cb
     local extra_choices = args.extra_choices or {}
 
     local ch_combinations = args.combination == "powerset" and helpers.powerset(choices) or helpers.trivial_partition_set(choices)
     local extra_choices = args.extra_choices or {}
 
     local ch_combinations = args.combination == "powerset" and helpers.powerset(choices) or helpers.trivial_partition_set(choices)
+
     for _,c in pairs(extra_choices) do
     for _,c in pairs(extra_choices) do
-        ch_combinations = awful.util.table.join(ch_combinations, {{c[1]}})
+        ch_combinations = atable.join(ch_combinations, {{c[1]}})
     end
 
     end
 
-    local m = {}
+    local m = {} -- the menu
+
     for _,c in pairs(ch_combinations) do
         if #c > 0 then
             local cbs = {}
     for _,c in pairs(ch_combinations) do
         if #c > 0 then
             local cbs = {}
+
             -- selected choices
             for _,ch in pairs(c) do
             -- selected choices
             for _,ch in pairs(c) do
-                if awful.util.table.hasitem(choices, ch) then
+                if atable.hasitem(choices, ch) then
                     cbs[#cbs + 1] = selected_cb and function() selected_cb(ch) end or nil
                 end
             end
 
             -- rejected choices
             for _,ch in pairs(choices) do
                     cbs[#cbs + 1] = selected_cb and function() selected_cb(ch) end or nil
                 end
             end
 
             -- rejected choices
             for _,ch in pairs(choices) do
-                if not awful.util.table.hasitem(c, ch) and awful.util.table.hasitem(choices, ch) then
+                if not atable.hasitem(c, ch) and atable.hasitem(choices, ch) then
                     cbs[#cbs + 1] = rejected_cb and function() rejected_cb(ch) end or nil
                 end
             end
 
                     cbs[#cbs + 1] = rejected_cb and function() rejected_cb(ch) end or nil
                 end
             end
 
-            -- add user extra choices (like the choice "None" for e.g.)
+            -- add user extra choices (like the choice "None" for example)
             for _,x in pairs(extra_choices) do
                 if x[1] == c[1] then
                     cbs[#cbs + 1] = x[2]
                 end
             end
 
             for _,x in pairs(extra_choices) do
                 if x[1] == c[1] then
                     cbs[#cbs + 1] = x[2]
                 end
             end
 
-            m[#m + 1] = { name .. ": " .. table.concat(c, " + "), cbs }
+            m[#m + 1] = { name .. ": " .. tconcat(c, " + "), cbs }
         end
     end
 
     return m
 end
 
         end
     end
 
     return m
 end
 
-return {
-    iterate = iterate,
-    menu    = menu
-}
+return { iterate = iterate, menu = menu }
diff --git a/wiki b/wiki
index e8860c7593f86584b45ada7d5232f32915ba20a6..967f567364e9304e79ddfb552096f3f0874950f6 160000 (submodule)
--- a/wiki
+++ b/wiki
@@ -1 +1 @@
-Subproject commit e8860c7593f86584b45ada7d5232f32915ba20a6
+Subproject commit 967f567364e9304e79ddfb552096f3f0874950f6