From dd9f578048528c9a365168e0be68bd4314008d5e Mon Sep 17 00:00:00 2001
From: Stefano Mazzucco <stefano@curso.re>
Date: Thu, 20 Jul 2017 22:23:01 +0100
Subject: [PATCH] Add capslock.lua file, README and screenshot

---
 .gitignore                      |   1 +
 README.md                       |  46 ++++++++++++++++++
 capslock.lua                    |  82 ++++++++++++++++++++++++++++++++
 screenshots/capslock_widget.png | Bin 0 -> 962 bytes
 4 files changed, 129 insertions(+)
 create mode 100644 README.md
 create mode 100644 capslock.lua
 create mode 100644 screenshots/capslock_widget.png

diff --git a/.gitignore b/.gitignore
index 6fd0a37..1c1a0e6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -39,3 +39,4 @@ luac.out
 *.x86_64
 *.hex
 
+*~
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..021eb7b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# A simple CAPS LOCK widget for Awesome
+
+Useful when you have a keyboard that does not have a CAPS LOCK indicator.
+
+This widget is really simple and parses the output of `xset` to figure out
+whether CAPS LOCK is active or not. (Hint: you need the `xset` utility for this
+widget to work)
+
+# Installation
+
+1. Ensure that `xset` is available to you on your system.
+2. Copy `capslock.lua` in your `~/.config/awesome/rc.lua` (e.g. by cloning this
+repository).
+3. Restart Awesome (e.g. press `modkey + Control` or run `awesome-client
+   "awesome.restart()"` from a terminal).
+
+# Usage
+
+For **Awesome 4.x**, add the following to your `~/.config/awesome/rc.lua`:
+
+``` lua
+local capslock = require("capslock")
+
+-- more config here
+
+    -- Add widgets to the wibox
+    s.mywibox:setup {
+-- more config here
+      { -- Right widgets
+        layout = wibox.layout.fixed.horizontal,
+        wibox.widget.systray(),
+        capslock,
+-- more config here
+-- {{{ Key bindings
+local globalkeys = awful.util.table.join(
+  capslock.key,
+-- more config follows
+```
+
+Now, when you activate CAPS LOCK, a chevron sign will be
+displayed: ![capslock screenshot](/screenshots/capslock_widget.png?raw=true)
+
+# Contributing
+
+If you have ideas about how to make this better, feel free to open an issue or
+submit a pull request.
diff --git a/capslock.lua b/capslock.lua
new file mode 100644
index 0000000..296ae63
--- /dev/null
+++ b/capslock.lua
@@ -0,0 +1,82 @@
+--[[
+
+  Copyright 2017 Stefano Mazzucco <stefano AT curso DOT re>
+
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free Software
+  Foundation, either version 3 of the License, or (at your option) any later
+  version.
+
+  This program is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+  details.
+
+  You should have received a copy of the GNU General Public License along with
+  this program.  If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.
+
+]]
+
+--[[
+  A simple widget to show whether Caps Lock is active.
+  Requirements:
+  - Awesome 4.x
+  - xset
+
+  @usage
+  capslock = require("capslock")
+  -- Add widget to wibox
+  s.mywibox:setup {
+  layout = wibox.layout.align.horizontal,
+  { -- Left widgets
+    layout = wibox.layout.fixed.horizontal,
+    capslock
+  }
+  -- more stuff
+  }
+  -- Add key to globalkeys
+  globalkeys = awful.util.table.join(globalkeys, capslock.key)
+
+]]
+
+local math = math
+local awful = require("awful")
+local gears = require("gears")
+local wibox = require("wibox")
+
+local checkbox = wibox.widget {
+  checked = false,
+  border_width = 0,
+  paddings = 2,
+  check_shape = function (cr, w, h)
+    gears.shape.transform(gears.shape.powerline)
+      :rotate(-math.pi/2)
+      :translate(-h, 0)(cr, w, h)
+  end,
+  widget = wibox.widget.checkbox
+}
+
+local function check_caps_lock()
+  awful.spawn.with_line_callback(
+    "bash -c 'sleep 0.2 && xset q'",
+    {
+      stdout = function (line)
+        if line:match("Caps Lock") then
+          local status = line:gsub(".*(Caps Lock:%s+)(%a+).*", "%2")
+          if status == "on" then
+            checkbox.checked = true
+          else
+            checkbox.checked = false
+          end
+        end
+      end
+    }
+  )
+end
+
+local capslock = awful.key({}, "Caps_Lock", check_caps_lock)
+checkbox.key = capslock
+
+check_caps_lock()
+
+return checkbox
diff --git a/screenshots/capslock_widget.png b/screenshots/capslock_widget.png
new file mode 100644
index 0000000000000000000000000000000000000000..c272f3606d5a22d467cf7bd8677e4770ab27e30a
GIT binary patch
literal 962
zcmV;z13mnSP)<h;3K|Lk000e1NJLTq000*N000yS0ssI3p4$P>00009a7bBm000XU
z000XU0RWnu7ytkRbV)=(R5;6hQ%!GMMHIbvW}auPC`yyYjm&}|NbNXI$%mst%Rc~A
zKDI!G)HW?@)kUjrP)XvXQISBbT3Dn(D3r}pMG_~hX<1U@&vr)_RBn<@ltrZY`MozY
zU0mm3vf!>}?woVx-ZOV_IGfqq+mliXW6U?-eg^<}eBgD?c}GVFrc(omsI_KFsoA-C
zr4+cXJDkmoj-24*V<U+~@3CWvJ9q9rsZ|oaM<JaWa9!7RU0Muf(k(TTvDN|ri^XD6
z%KYrDSNr=N#}PvC?jv0@`8fc{<tCmz`+H|+hY2A7U^YJu0O!t6T5B0&?Caa}ob&0a
zn*e}_I6gMwd7hNgTD!l$-_z66)zww6*TXR6oYRG((P)HWsI^u~-I~7*2l2!AcVE1y
zGsd*mIGoM+zTbY_9{HIm-}i;@`${QFeRcE8SS*H!#+a$;JODV3<NH3Qj=#YeV~kmA
zJ<p5B<6#&w#yIE37;CN88q=u($8ogQlmY<Gx$pZ@N~)DPj-!;42XSHYqLh+c5kd$d
z7ywvniG5-6Qh)zz*RJ0{M8+7|!@IkWG@DJW^~FnHB$G*^zJ2QSACDedYmG5H(R<Wd
zd-=-MWb&1$TgP!uoqp%><3Eit3=uD1xk_vRc>eq!S}3KiUB6+iWnmab$K_IS@!rDf
z%5nrU#xSY~0IJnWp|I*W&eNw)R+fLIB<GwNV*sF5t^BsWMrdnosZ?BFD-cLnYb)jQ
zg9k1-OMM1Gu(9zMIffItG2i!%G4Xgj2m(YTnMR|blwyp9VTg!`*did(n?y!3#)L5@
zdXq?kwo=N^&VJt4*XMcOFZY+~^|~>J6bV2`V+`iTM}r_R#>8T=APA@>Ddi`ho{hYs
z@I3Fw#f9zdZO%CrMJkAhnZXp5LzhS?&z+w<#6P5U|L3KxtxX!sR-4(OL1PTf|Nrw3
zX)P`Nw6(cOL)w}Y0GP?ob#`_hLf5L5#d{08ySwSZ!S=imBA1(Z^ze7`RA{Zqh(r8R
zvADiopytcvQmt0aW`{rg=;L+_8Dy;$k<ab-udNjtjRyV6C|@p@%H`6@lW)EI-usln
zgZPh1wOUzSSte#Q0j)p6Ib}+vVzIdK=E&%oGavjrB14%pfrJpPXG65sHk(Z;C1Z@d
k7ea(#NI#sIG%wWAOUm~r4KA^B`~Uy|07*qoM6N<$g6;~{DgXcg

literal 0
HcmV?d00001