wiki updated; closes #261

[etc/awesome.git] / util / quake.lua

diff --git a/util/quake.lua b/util/quake.lua
index 000c6186c7ed0f237c5451d7f43ed59ca9dc4dba..6363578774de8880372c73eeee3fa2ce7378a227 100644 (file)
--- a/util/quake.lua
+++ b/util/quake.lua
@@ -3,22 +3,22 @@
                                                    
      Licensed under GNU General Public License v2  
       * (c) 2016, Luke Bonham                      
                                                    
      Licensed under GNU General Public License v2  
       * (c) 2016, Luke Bonham                      

+      * (c) 2015, unknown                          

                                                    
 --]]
 
                                                    
 --]]
 

-local awful  = require("awful")
-local capi   = { client = client,
-                 mouse  = mouse,
-                 screen = screen,
-                 timer  = timer }
-local string = string
+local awful        = require("awful")
+local capi         = { client = client,
+                       timer  = require("gears.timer") }
+local math         = { floor  = math.floor }
+local string       = string

 
 local pairs        = pairs
 
 local pairs        = pairs

+local screen       = screen

 local setmetatable = setmetatable
 local tostring     = tostring
 
 -- Quake-like Dropdown application spawn
 local setmetatable = setmetatable
 local tostring     = tostring
 
 -- Quake-like Dropdown application spawn

--- Original version: https://awesomewm.org/wiki/Drop-down_terminal#Another_solution

 local quake = {}
 
 -- If you have a rule like "awful.client.setslave" for your terminals,
 local quake = {}
 
 -- If you have a rule like "awful.client.setslave" for your terminals,


@@ -26,134 +26,142 @@ local quake = {}
 -- run into problems with focus.
 
 function quake:display()
 -- run into problems with focus.
 
 function quake:display()

-   -- First, we locate the client
-   local client = nil
-   local i = 0
-   for c in awful.client.iterate(function (c)
-       -- c.name may be changed!
-                        return c.instance == self.name
-   end, nil, self.screen)
-   do
-       i = i + 1
-       if i == 1 then
-           client = c
-       else
-           -- Additional matching clients, let's remove the sticky bit
-           -- which may persist between awesome restarts. We don't close
-           -- them as they may be valuable. They will just turn into
-           -- normal clients.
-           c.sticky = false
-           c.ontop = false
-           c.above = false
-       end
-   end
-
-   if not client and not self.visible then return end
-
-   if not client then
-       -- The client does not exist, we spawn it
-       awful.util.spawn(self.app .. " " .. string.format(self.argname, self.name),
-       false, self.screen)
-       self.notexist = true
-       return
-   end
-
-   -- Resize
-   awful.client.floating.set(client, true)
-   client.border_width = 0
-   client.size_hints_honor = false
-   if self.notexist then
-       client:geometry(self.geometry)
-       self.notexist = false
-   end
-
-   -- Not sticky and on top
-   client.ontop = true
-   client.above = true
-   client.skip_taskbar = true
-   client.sticky = false
-
-   -- Toggle display
-   if self.visible then
-       client.hidden = false
-       client:raise()
-       self.last_tag = tostring(awful.tag.selected(self.screen))
-       client:tags({awful.tag.selected(self.screen)})
-       capi.client.focus = client
+    if self.followtag then self.screen = awful.screen.focused() end
+
+    -- First, we locate the client
+    local client = nil
+    local i = 0
+    for c in awful.client.iterate(function (c)
+        -- c.name may be changed!
+        return c.instance == self.name
+    end, nil, self.screen)
+    do
+        i = i + 1
+        if i == 1 then
+            client = c
+        else
+            -- Additional matching clients, let's remove the sticky bit
+            -- which may persist between awesome restarts. We don't close
+            -- them as they may be valuable. They will just turn into
+            -- normal clients.
+            c.sticky = false
+            c.ontop = false
+            c.above = false
+        end
+    end
+
+    if not client and not self.visible then return end
+
+    if not client then
+        -- The client does not exist, we spawn it
+        awful.spawn(string.format("%s %s %s", self.app,
+                    string.format(self.argname, self.name), self.extra),
+                    false, self.screen)
+        self.notexist = true
+        return
+    end
+
+    -- Resize
+    client.floating = true
+    client.border_width = self.border
+    client.size_hints_honor = false
+    if self.notexist then
+        self:compute_size()
+        client:geometry(self.geometry)
+        self.notexist = false
+    end
+
+    -- Not sticky and on top
+    client.sticky = false
+    client.ontop = true
+    client.above = true
+    client.skip_taskbar = true
+
+    -- Toggle display
+    if self.visible then
+        client.hidden = false
+        client:raise()
+        self.last_tag = self.screen.selected_tag
+        client:tags({self.screen.selected_tag})
+        capi.client.focus = client

    else
    else

-       client.hidden = true
-       local ctags = client:tags()
-       for i, t in pairs(ctags) do
-           ctags[i] = nil
-       end
-       client:tags(ctags)
-   end
-
-   return client
+        client.hidden = true
+        local ctags = client:tags()
+        for i, t in pairs(ctags) do
+            ctags[i] = nil
+        end
+        client:tags(ctags)
+    end
+
+    return client
+end
+
+function quake:compute_size()
+    local geom = screen[self.screen].workarea
+    local width, height
+    if self.width  <= 1 then width = math.floor(geom.width * self.width) - 2 * self.border end
+    if self.height <= 1 then height = math.floor(geom.height * self.height) end
+    local x, y
+    if     self.horiz == "left"  then x = geom.x
+    elseif self.horiz == "right" then x = geom.width + geom.x - self.width
+    else   x = geom.x + (geom.width - self.width)/2 end
+    if     self.vert == "top"    then y = geom.y
+    elseif self.vert == "bottom" then y = geom.height + geom.y - self.height
+    else   y = geom.y + (geom.height - self.height)/2 end
+    self.geometry = { x = x, y = y, width = width, height = height }

 end
 
 function quake:new(config)
 end
 
 function quake:new(config)

-   local conf = config or {}
-
-   conf.app     = conf.app     or "xterm"    -- application to spawn
-   conf.name    = conf.name    or "QuakeDD"  -- window name
-   conf.argname = conf.argname or "-name %s" -- how to specify window name
-   conf.visible = conf.visible or false      -- initially not visible
-   conf.screen  = conf.screen  or capi.mouse.screen
-
-   -- If width or height <= 1 this is a proportion of the workspace
-   wibox_height = conf.wibox_height or 18       -- statusbar weight
-   height       = conf.height       or 0.25        -- height
-   width        = conf.width        or 1             -- width
-   vert         = conf.vert         or "top"     -- top, bottom or center
-   horiz        = conf.horiz        or "center" -- left, right or center
-
-   -- Compute size
-   local geom = capi.screen[conf.screen].workarea
-   if width  <= 1 then width = geom.width * width end
-   if height <= 1 then height = geom.height * height end
-   local x, y
-   if     horiz == "left"  then x = geom.x
-   elseif horiz == "right" then x = geom.width + geom.x - width
-   else   x = geom.x + (geom.width - width)/2 end
-   if     vert == "top"    then y = geom.y
-   elseif vert == "bottom" then y = geom.height + geom.y - height
-   else   y = geom.y + (geom.height - height)/2 end
-   conf.geometry = { x = x, y = y + wibox_height, width = width, height = height }
-
-   local console = setmetatable(conf, { __index = quake })
-   capi.client.connect_signal("manage", function(c)
-       if c.instance == console.name and c.screen == console.screen then
-           console:display()
-                        end
-   end)
-   capi.client.connect_signal("unmanage", function(c)
-       if c.instance == console.name and c.screen == console.screen then
-           console.visible = false
-                  end
-               end)
-
-   -- "Reattach" currently running quake application. This is in case awesome is restarted.
-   local reattach = capi.timer { timeout = 0 }
-   reattach:connect_signal("timeout", function()
-       reattach:stop()
-                        console:display()
-   end)
-   reattach:start()
-
-   return console
+    local conf = config or {}
+
+    conf.app       = conf.app       or "xterm"    -- application to spawn
+    conf.name      = conf.name      or "QuakeDD"  -- window name
+    conf.argname   = conf.argname   or "-name %s" -- how to specify window name
+    conf.extra     = conf.extra     or ""         -- extra arguments
+    conf.visible   = conf.visible   or false      -- initially not visible
+    conf.border    = conf.border    or 1          -- client border width
+    conf.followtag = conf.followtag or false      -- spawn on currently focused screen
+    conf.screen    = conf.screen    or awful.screen.focused()
+
+    -- If width or height <= 1 this is a proportion of the workspace
+    conf.height       = conf.height       or 0.25     -- height
+    conf.width        = conf.width        or 1        -- width
+    conf.vert         = conf.vert         or "top"    -- top, bottom or center
+    conf.horiz        = conf.horiz        or "left"   -- left, right or center
+
+    local console = setmetatable(conf, { __index = quake })
+    capi.client.connect_signal("manage", function(c)
+        if c.instance == console.name and c.screen == console.screen then
+            console:display()
+        end
+    end)
+    capi.client.connect_signal("unmanage", function(c)
+        if c.instance == console.name and c.screen == console.screen then
+            console.visible = false
+        end
+     end)
+
+    -- "Reattach" currently running quake application. This is in case awesome is restarted.
+    local reattach = capi.timer { timeout = 0 }
+    reattach:connect_signal("timeout", function()
+        if self.followtag then self.screen = awful.screen.focused() end
+        reattach:stop()
+        console:display()
+    end)
+    reattach:start()
+
+    return console

 end
 
 function quake:toggle()
 end
 
 function quake:toggle()

-    current_tag = awful.tag.selected(self.screen)
-    if self.last_tag ~= tostring(current_tag) and self.visible then
-        awful.client.movetotag(current_tag, self:display())
-    else
-        self.visible = not self.visible
-        self:display()
-    end
+     if self.followtag then self.screen = awful.screen.focused() end
+     local current_tag = self.screen.selected_tag
+     if current_tag and self.last_tag ~= current_tag and self.visible then
+         self:display():move_to_tag(current_tag)
+     else
+         self.visible = not self.visible
+         self:display()
+     end

 end
 
 end
 

-setmetatable(quake, { __call = function(_, ...) return quake:new(...) end })
-
-return quake
+return setmetatable(quake, { __call = function(_, ...) return quake:new(...) end })