commit b5f83958c976ad72814501add07e8903e988e604 Author: Mutzi Date: Sat Jul 6 20:31:50 2024 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6c986a4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build/ +.cache +backup.tar diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..e92dcc0 --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,54 @@ +-- Only allow symbols available in all Lua versions +std = "min" + +-- Get rid of "unused argument self"-warnings +self = false + +max_line_length = false + +-- The default config may set global variables +files["rc.lua"].allow_defined_top = true + +-- This file itself +files[".luacheckrc"].ignore = {"111", "112", "131"} + +-- Theme files, ignore max line length +files["themes/*"].ignore = {"631"} + +-- Global objects defined by the C code +read_globals = { + "awesome", + "button", + "dbus", + "drawable", + "drawin", + "key", + "keygrabber", + "mousegrabber", + "selection", + "tag", + "window", + "table.unpack", + "math.atan2", +} + +-- screen may not be read-only, because newer luacheck versions complain about +-- screen[1].tags[1].selected = true. +-- The same happens with the following code: +-- local tags = mouse.screen.tags +-- tags[7].index = 4 +-- client may not be read-only due to client.focus. +globals = { + "screen", + "mouse", + "root", + "client" +} + +-- Enable cache (uses .luacheckcache relative to this rc file). +cache = false + +-- Do not enable colors to make the CI output more readable. +color = false + +-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..c721087 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,15 @@ +cmake_minimum_required(VERSION 3.20) +project(awesome) + +find_package(PkgConfig) + +set(POSITION_INDEPENDENT_CODE YES) +set(C_STANDARD 11) +add_compile_options(-Wall -Wextra -pedantic) + +pkg_check_modules(CONSTRAIN REQUIRED x11 xi xfixes xrandr) + +add_library(constrain SHARED lib/constrain.c) + +target_link_libraries(constrain ${CONSTRAIN_LIBRARIES}) +target_include_directories(constrain PUBLIC ${CONSTRAIN_INCLUDE_DIRS}) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3194d90 --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +LUA_FILES = $(shell find src -type f -name '*.lua') rc.lua settings.lua + +.PHONY: test +test: build + { sleep 1; DISPLAY=:10 awesome -c "$(CURDIR)/rc.lua"; } & Xephyr :10 -name xephyr_awesome -ac -br -noreset -screen "1920x1080" + +.PHONY: deploy +deploy: build + @echo Backing old config up + rm -f backup.tar + tar -cvf backup.tar -C ~/.config awesome + rsync -avmh --delete --exclude 'settings.lua' --include '*.lua' --include '*.so' --include '*.png' --include '*/' --exclude '*' ./ ~/.config/awesome/ + +.PHONY: build +build: + cmake -S . -B build + cmake --build build + +.PHONY: luacheck +luacheck: + luacheck $(LUA_FILES) diff --git a/awesome.code-workspace b/awesome.code-workspace new file mode 100644 index 0000000..e0c69cc --- /dev/null +++ b/awesome.code-workspace @@ -0,0 +1,25 @@ +{ + "folders": [ + { + "path": "." + }, + { + "path": "../../.config/awesome" + } + ], + "settings": { + "Lua.runtime.version": "LuaJIT", + "Lua.diagnostics.globals": [ + "awesome", + "screen", + "tag", + "root", + "client", + "mouse", + "mousegrabber" + ], + "Lua.workspace.library": [ + "/usr/share/awesome/lib" + ] + } +} \ No newline at end of file diff --git a/check.sh b/check.sh new file mode 100755 index 0000000..ae0e070 --- /dev/null +++ b/check.sh @@ -0,0 +1,5 @@ +#!/bin/sh +files=(theme/*.lua theme/*/*.lua rc_parts/*.lua) +files=${files[@]} +stylua -c $files +luacheck $files diff --git a/icons/dwindle.png b/icons/dwindle.png new file mode 100755 index 0000000..94d8382 Binary files /dev/null and b/icons/dwindle.png differ diff --git a/icons/fairh.png b/icons/fairh.png new file mode 100755 index 0000000..4468efc Binary files /dev/null and b/icons/fairh.png differ diff --git a/icons/fairv.png b/icons/fairv.png new file mode 100755 index 0000000..7c8728e Binary files /dev/null and b/icons/fairv.png differ diff --git a/icons/floating.png b/icons/floating.png new file mode 100755 index 0000000..7593a2a Binary files /dev/null and b/icons/floating.png differ diff --git a/icons/fullscreen.png b/icons/fullscreen.png new file mode 100755 index 0000000..f63a69c Binary files /dev/null and b/icons/fullscreen.png differ diff --git a/icons/info/batcharge.png b/icons/info/batcharge.png new file mode 100644 index 0000000..80f6626 Binary files /dev/null and b/icons/info/batcharge.png differ diff --git a/icons/info/batempty.png b/icons/info/batempty.png new file mode 100644 index 0000000..1fadbbf Binary files /dev/null and b/icons/info/batempty.png differ diff --git a/icons/info/batfull.png b/icons/info/batfull.png new file mode 100644 index 0000000..9e357c3 Binary files /dev/null and b/icons/info/batfull.png differ diff --git a/icons/info/bathigh.png b/icons/info/bathigh.png new file mode 100644 index 0000000..c11aa44 Binary files /dev/null and b/icons/info/bathigh.png differ diff --git a/icons/info/batlow.png b/icons/info/batlow.png new file mode 100644 index 0000000..8f00a2b Binary files /dev/null and b/icons/info/batlow.png differ diff --git a/icons/info/batmid.png b/icons/info/batmid.png new file mode 100644 index 0000000..b29d682 Binary files /dev/null and b/icons/info/batmid.png differ diff --git a/icons/info/cpu.png b/icons/info/cpu.png new file mode 100644 index 0000000..660971c Binary files /dev/null and b/icons/info/cpu.png differ diff --git a/icons/info/download.png b/icons/info/download.png new file mode 100644 index 0000000..6b648d7 Binary files /dev/null and b/icons/info/download.png differ diff --git a/icons/info/mem.png b/icons/info/mem.png new file mode 100644 index 0000000..9acac79 Binary files /dev/null and b/icons/info/mem.png differ diff --git a/icons/info/pause.png b/icons/info/pause.png new file mode 100644 index 0000000..e6c0a77 Binary files /dev/null and b/icons/info/pause.png differ diff --git a/icons/info/play.png b/icons/info/play.png new file mode 100644 index 0000000..f4e48c8 Binary files /dev/null and b/icons/info/play.png differ diff --git a/icons/info/stop.png b/icons/info/stop.png new file mode 100644 index 0000000..b5feadc Binary files /dev/null and b/icons/info/stop.png differ diff --git a/icons/info/upload.png b/icons/info/upload.png new file mode 100644 index 0000000..eb20271 Binary files /dev/null and b/icons/info/upload.png differ diff --git a/icons/info/volhigh.png b/icons/info/volhigh.png new file mode 100644 index 0000000..9a19ecc Binary files /dev/null and b/icons/info/volhigh.png differ diff --git a/icons/info/vollow.png b/icons/info/vollow.png new file mode 100644 index 0000000..dca6e8a Binary files /dev/null and b/icons/info/vollow.png differ diff --git a/icons/info/volmute.png b/icons/info/volmute.png new file mode 100644 index 0000000..77f5c2a Binary files /dev/null and b/icons/info/volmute.png differ diff --git a/icons/info_normal/batcharge.png b/icons/info_normal/batcharge.png new file mode 100644 index 0000000..7fa5ef5 Binary files /dev/null and b/icons/info_normal/batcharge.png differ diff --git a/icons/info_normal/batempty.png b/icons/info_normal/batempty.png new file mode 100644 index 0000000..a87f4c1 Binary files /dev/null and b/icons/info_normal/batempty.png differ diff --git a/icons/info_normal/batfull.png b/icons/info_normal/batfull.png new file mode 100644 index 0000000..098d0bb Binary files /dev/null and b/icons/info_normal/batfull.png differ diff --git a/icons/info_normal/bathigh.png b/icons/info_normal/bathigh.png new file mode 100644 index 0000000..b5d9b34 Binary files /dev/null and b/icons/info_normal/bathigh.png differ diff --git a/icons/info_normal/batlow.png b/icons/info_normal/batlow.png new file mode 100644 index 0000000..dbe6459 Binary files /dev/null and b/icons/info_normal/batlow.png differ diff --git a/icons/info_normal/batmid.png b/icons/info_normal/batmid.png new file mode 100644 index 0000000..345ec9c Binary files /dev/null and b/icons/info_normal/batmid.png differ diff --git a/icons/info_normal/cpu.png b/icons/info_normal/cpu.png new file mode 100644 index 0000000..313b9dd Binary files /dev/null and b/icons/info_normal/cpu.png differ diff --git a/icons/info_normal/download.png b/icons/info_normal/download.png new file mode 100644 index 0000000..e680fa0 Binary files /dev/null and b/icons/info_normal/download.png differ diff --git a/icons/info_normal/mem.png b/icons/info_normal/mem.png new file mode 100644 index 0000000..1c955e7 Binary files /dev/null and b/icons/info_normal/mem.png differ diff --git a/icons/info_normal/pause.png b/icons/info_normal/pause.png new file mode 100644 index 0000000..5cd63ee Binary files /dev/null and b/icons/info_normal/pause.png differ diff --git a/icons/info_normal/play.png b/icons/info_normal/play.png new file mode 100644 index 0000000..3b5d40b Binary files /dev/null and b/icons/info_normal/play.png differ diff --git a/icons/info_normal/stop.png b/icons/info_normal/stop.png new file mode 100644 index 0000000..ccd0b51 Binary files /dev/null and b/icons/info_normal/stop.png differ diff --git a/icons/info_normal/upload.png b/icons/info_normal/upload.png new file mode 100644 index 0000000..5d81d4e Binary files /dev/null and b/icons/info_normal/upload.png differ diff --git a/icons/info_normal/volhigh.png b/icons/info_normal/volhigh.png new file mode 100644 index 0000000..fbc9a49 Binary files /dev/null and b/icons/info_normal/volhigh.png differ diff --git a/icons/info_normal/vollow.png b/icons/info_normal/vollow.png new file mode 100644 index 0000000..1a29f5c Binary files /dev/null and b/icons/info_normal/vollow.png differ diff --git a/icons/info_normal/volmute.png b/icons/info_normal/volmute.png new file mode 100644 index 0000000..e7480ec Binary files /dev/null and b/icons/info_normal/volmute.png differ diff --git a/icons/magnifier.png b/icons/magnifier.png new file mode 100755 index 0000000..8819554 Binary files /dev/null and b/icons/magnifier.png differ diff --git a/icons/max.png b/icons/max.png new file mode 100755 index 0000000..4b6a8c3 Binary files /dev/null and b/icons/max.png differ diff --git a/icons/spiral.png b/icons/spiral.png new file mode 100755 index 0000000..6a1ebf1 Binary files /dev/null and b/icons/spiral.png differ diff --git a/icons/submenu.png b/icons/submenu.png new file mode 100755 index 0000000..7c81cab Binary files /dev/null and b/icons/submenu.png differ diff --git a/icons/svgs/batcharge.svg b/icons/svgs/batcharge.svg new file mode 100644 index 0000000..5339947 --- /dev/null +++ b/icons/svgs/batcharge.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/batempty.svg b/icons/svgs/batempty.svg new file mode 100644 index 0000000..75c8e32 --- /dev/null +++ b/icons/svgs/batempty.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/batfull.svg b/icons/svgs/batfull.svg new file mode 100644 index 0000000..8f148ce --- /dev/null +++ b/icons/svgs/batfull.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/bathigh.svg b/icons/svgs/bathigh.svg new file mode 100644 index 0000000..dceb31f --- /dev/null +++ b/icons/svgs/bathigh.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/batlow.svg b/icons/svgs/batlow.svg new file mode 100644 index 0000000..d67f0f3 --- /dev/null +++ b/icons/svgs/batlow.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/batmid.svg b/icons/svgs/batmid.svg new file mode 100644 index 0000000..ee4a497 --- /dev/null +++ b/icons/svgs/batmid.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/cpu.svg b/icons/svgs/cpu.svg new file mode 100644 index 0000000..9c82de5 --- /dev/null +++ b/icons/svgs/cpu.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/download.svg b/icons/svgs/download.svg new file mode 100644 index 0000000..6829959 --- /dev/null +++ b/icons/svgs/download.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/mem.svg b/icons/svgs/mem.svg new file mode 100644 index 0000000..e15b96a --- /dev/null +++ b/icons/svgs/mem.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/upload.svg b/icons/svgs/upload.svg new file mode 100644 index 0000000..44aa945 --- /dev/null +++ b/icons/svgs/upload.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/volhigh.svg b/icons/svgs/volhigh.svg new file mode 100644 index 0000000..ae0ff13 --- /dev/null +++ b/icons/svgs/volhigh.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/vollow.svg b/icons/svgs/vollow.svg new file mode 100644 index 0000000..59ecfbd --- /dev/null +++ b/icons/svgs/vollow.svg @@ -0,0 +1 @@ + diff --git a/icons/svgs/volmute.svg b/icons/svgs/volmute.svg new file mode 100644 index 0000000..9d5b8b8 --- /dev/null +++ b/icons/svgs/volmute.svg @@ -0,0 +1 @@ + diff --git a/icons/tile.png b/icons/tile.png new file mode 100755 index 0000000..64103d9 Binary files /dev/null and b/icons/tile.png differ diff --git a/icons/tilebottom.png b/icons/tilebottom.png new file mode 100755 index 0000000..9363636 Binary files /dev/null and b/icons/tilebottom.png differ diff --git a/icons/tileleft.png b/icons/tileleft.png new file mode 100755 index 0000000..9331898 Binary files /dev/null and b/icons/tileleft.png differ diff --git a/icons/tiletop.png b/icons/tiletop.png new file mode 100755 index 0000000..1cef886 Binary files /dev/null and b/icons/tiletop.png differ diff --git a/icons/titlebar/close_focus.png b/icons/titlebar/close_focus.png new file mode 100755 index 0000000..cd297db Binary files /dev/null and b/icons/titlebar/close_focus.png differ diff --git a/icons/titlebar/close_normal.png b/icons/titlebar/close_normal.png new file mode 100755 index 0000000..5448ed8 Binary files /dev/null and b/icons/titlebar/close_normal.png differ diff --git a/icons/titlebar/floating_focus_active.png b/icons/titlebar/floating_focus_active.png new file mode 100755 index 0000000..ae5a8e2 Binary files /dev/null and b/icons/titlebar/floating_focus_active.png differ diff --git a/icons/titlebar/floating_focus_inactive.png b/icons/titlebar/floating_focus_inactive.png new file mode 100755 index 0000000..c54eb0c Binary files /dev/null and b/icons/titlebar/floating_focus_inactive.png differ diff --git a/icons/titlebar/floating_normal_active.png b/icons/titlebar/floating_normal_active.png new file mode 100755 index 0000000..62342d1 Binary files /dev/null and b/icons/titlebar/floating_normal_active.png differ diff --git a/icons/titlebar/floating_normal_inactive.png b/icons/titlebar/floating_normal_inactive.png new file mode 100755 index 0000000..e2bbdfa Binary files /dev/null and b/icons/titlebar/floating_normal_inactive.png differ diff --git a/icons/titlebar/maximized_focus_active.png b/icons/titlebar/maximized_focus_active.png new file mode 100755 index 0000000..957298b Binary files /dev/null and b/icons/titlebar/maximized_focus_active.png differ diff --git a/icons/titlebar/maximized_focus_inactive.png b/icons/titlebar/maximized_focus_inactive.png new file mode 100755 index 0000000..1187229 Binary files /dev/null and b/icons/titlebar/maximized_focus_inactive.png differ diff --git a/icons/titlebar/maximized_normal_active.png b/icons/titlebar/maximized_normal_active.png new file mode 100755 index 0000000..a705f81 Binary files /dev/null and b/icons/titlebar/maximized_normal_active.png differ diff --git a/icons/titlebar/maximized_normal_inactive.png b/icons/titlebar/maximized_normal_inactive.png new file mode 100755 index 0000000..4c1ab1f Binary files /dev/null and b/icons/titlebar/maximized_normal_inactive.png differ diff --git a/icons/titlebar/minimize_focus.png b/icons/titlebar/minimize_focus.png new file mode 100755 index 0000000..bbe8cff Binary files /dev/null and b/icons/titlebar/minimize_focus.png differ diff --git a/icons/titlebar/minimize_normal.png b/icons/titlebar/minimize_normal.png new file mode 100755 index 0000000..36621d0 Binary files /dev/null and b/icons/titlebar/minimize_normal.png differ diff --git a/icons/titlebar/ontop_focus_active.png b/icons/titlebar/ontop_focus_active.png new file mode 100755 index 0000000..25a3080 Binary files /dev/null and b/icons/titlebar/ontop_focus_active.png differ diff --git a/icons/titlebar/ontop_focus_inactive.png b/icons/titlebar/ontop_focus_inactive.png new file mode 100755 index 0000000..d3c077a Binary files /dev/null and b/icons/titlebar/ontop_focus_inactive.png differ diff --git a/icons/titlebar/ontop_normal_active.png b/icons/titlebar/ontop_normal_active.png new file mode 100755 index 0000000..117a203 Binary files /dev/null and b/icons/titlebar/ontop_normal_active.png differ diff --git a/icons/titlebar/ontop_normal_inactive.png b/icons/titlebar/ontop_normal_inactive.png new file mode 100755 index 0000000..d3a10c8 Binary files /dev/null and b/icons/titlebar/ontop_normal_inactive.png differ diff --git a/icons/titlebar/sticky_focus_active.png b/icons/titlebar/sticky_focus_active.png new file mode 100755 index 0000000..147ce6a Binary files /dev/null and b/icons/titlebar/sticky_focus_active.png differ diff --git a/icons/titlebar/sticky_focus_inactive.png b/icons/titlebar/sticky_focus_inactive.png new file mode 100755 index 0000000..396628a Binary files /dev/null and b/icons/titlebar/sticky_focus_inactive.png differ diff --git a/icons/titlebar/sticky_normal_active.png b/icons/titlebar/sticky_normal_active.png new file mode 100755 index 0000000..bdb5595 Binary files /dev/null and b/icons/titlebar/sticky_normal_active.png differ diff --git a/icons/titlebar/sticky_normal_inactive.png b/icons/titlebar/sticky_normal_inactive.png new file mode 100755 index 0000000..a96b9b1 Binary files /dev/null and b/icons/titlebar/sticky_normal_inactive.png differ diff --git a/icons/usedtag.png b/icons/usedtag.png new file mode 100644 index 0000000..50df334 Binary files /dev/null and b/icons/usedtag.png differ diff --git a/lib/constrain.c b/lib/constrain.c new file mode 100644 index 0000000..eccc00e --- /dev/null +++ b/lib/constrain.c @@ -0,0 +1,87 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define DEBUG + +#ifdef DEBUG +static FILE *log_file = NULL; +static void dbg(const char *fmt, ...) { + va_list args; + if (log_file == NULL) { + log_file = fopen("/home/mutzi/xdpb.txt", "a+"); + } + va_start(args, fmt); + vfprintf(log_file, fmt, args); + va_end(args); + fflush(log_file); +} +#else +static inline void dbg(const char *fmt, ...) {} +#endif + +static struct { + Display *display; + Window root_window; + + int have_barriers; + PointerBarrier t, b, l, r; +} globals; + +static PointerBarrier mkbar(int x1, int y1, int x2, int y2, int directions) { + PointerBarrier pb = XFixesCreatePointerBarrier(globals.display, globals.root_window, x1, y1, x2, y2, directions, 0, NULL); + dbg("mkbar(%d, %d, %d, %d, %d) = %lu\n", x1, y1, x2, y2, directions, pb); + return pb; +} + +static int toggle_constrain(lua_State *L) { + dbg("Toggling constrain\n"); + if (globals.have_barriers == 0) { + lua_getfield(L, -1, "x"); + lua_getfield(L, -2, "y"); + lua_getfield(L, -3, "width"); + lua_getfield(L, -4, "height"); + + int x = (int)lua_tointeger(L, -4), y = (int)lua_tointeger(L, -3), w = (int)lua_tointeger(L, -2), h = (int)lua_tointeger(L, -1); + + dbg("Window x: %d y: %d w: %d h: %d\n", x, y, w, h); + + globals.t = mkbar(x - 1, y, x + w + 1, y, BarrierPositiveY); + globals.b = mkbar(x - 1, y + h, x + w + 1, y + h, BarrierNegativeY); + globals.l = mkbar(x, y - 1, x, y + h + 1, BarrierPositiveX); + globals.r = mkbar(x + w, y - 1, x + w, y + h + 1, BarrierNegativeX); + + globals.have_barriers = 1; + char msg_format[200]; + lua_getfield(L, -5, "name"); + snprintf(msg_format, 200, "Constraining mouse to %s", lua_tostring(L, -1)); + lua_pushstring(L, msg_format); + } else { + XFixesDestroyPointerBarrier(globals.display, globals.t); + XFixesDestroyPointerBarrier(globals.display, globals.b); + XFixesDestroyPointerBarrier(globals.display, globals.l); + XFixesDestroyPointerBarrier(globals.display, globals.r); + + globals.have_barriers = 0; + lua_pushstring(L, "Released mouse"); + } + XSync(globals.display, 0); + return 1; +} + +int luaopen_libconstrain(lua_State *L) { + dbg("Constrain opened\n"); + globals.have_barriers = 0; + globals.display = XOpenDisplay(NULL); + globals.root_window = XDefaultRootWindow(globals.display); + lua_newtable(L); + lua_pushcfunction(L, toggle_constrain); + lua_setfield(L, -2, "toggle"); + return 1; +} diff --git a/lib/freedesktop/LICENSE b/lib/freedesktop/LICENSE new file mode 100644 index 0000000..23cb790 --- /dev/null +++ b/lib/freedesktop/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/lib/freedesktop/README.rst b/lib/freedesktop/README.rst new file mode 100644 index 0000000..16ca579 --- /dev/null +++ b/lib/freedesktop/README.rst @@ -0,0 +1,51 @@ +Awesome-Freedesktop +=================== + +------------------------------------------------------------------- +Freedesktop.org menu and desktop icons support for Awesome WM 4.x +------------------------------------------------------------------- + +:First author: Antonio Terceiro +:Maintainer: Luca CPZ +:Version: git +:License: GNU-GPL2_ +:Source: https://github.com/lcpz/awesome-freedesktop + +Description +----------- + +A port of awesome-freedesktop_ to Awesome_ 4.x. + +See branches_ for previous versions. + +Since the introduction of Menubar_ as a core library to provide Freedesktop.org +functionalities in Awesome, we can now avoid the dirty work by simply exploiting +``menubar.utils``. + +At the moment, the menu is complete, while the desktop icons are rather simple. Our goal +is to add the following features: + +- A better way to handle desktop icons path. +- Ability to drag and line up icons. +- Event-based signals, in particular: + - Updating trash icon according to its status. + - Dynamic update (no need to restart Awesome to see changes on the desktop). + +Screenshot +---------- + +.. image:: screenshot.png + :align: center + :alt: Showcase of Freedesktop.org support in Awesome, using Adwaita icons + +Installation and usage +---------------------- + +Read the wiki_. + +.. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html +.. _awesome-freedesktop: https://github.com/terceiro/awesome-freedesktop +.. _Awesome: https://github.com/awesomeWM/awesome +.. _branches: https://github.com/lcpz/awesome-freedesktop/branches +.. _Menubar: https://github.com/awesomeWM/awesome/tree/master/lib/menubar +.. _wiki: https://github.com/lcpz/awesome-freedesktop/wiki diff --git a/lib/freedesktop/awesome-freedesktop-scm-1.rockspec b/lib/freedesktop/awesome-freedesktop-scm-1.rockspec new file mode 100644 index 0000000..0dde608 --- /dev/null +++ b/lib/freedesktop/awesome-freedesktop-scm-1.rockspec @@ -0,0 +1,19 @@ +package = "awesome-freedesktop" +version = "scm-1" +source = { + url = "git+https://github.com/lcpz/awesome-freedesktop.git", + tag = "master", +} +description = { + summary = "Freedesktop.org menu and desktop icons support for Awesome WM", + homepage = "https://github.com/lcpz/awesome-freedesktop", + license = "GPL-2.0" +} +dependencies = { + "lua >= 5.3", +} +supported_platforms = { "linux" } +build = { + type = "builtin", + modules = { freedesktop = "init.lua" } +} diff --git a/lib/freedesktop/desktop.lua b/lib/freedesktop/desktop.lua new file mode 100644 index 0000000..b5fdb37 --- /dev/null +++ b/lib/freedesktop/desktop.lua @@ -0,0 +1,272 @@ +--[[ + + Awesome-Freedesktop + Freedesktop.org compliant desktop entries and menu + + Desktop section + + Licensed under GNU General Public License v2 + * (c) 2016, Luke Bonham + * (c) 2009-2015, Antonio Terceiro + +--]] + +local awful = require('awful') +local theme = require('beautiful') +local utils = require('menubar.utils') +local wibox = require('wibox') + +local io = io +local ipairs = ipairs +local mouse = mouse +local os = os +local string = string +local screen = screen +local table = table + +-- Desktop icons +-- freedesktop.desktop +local desktop = { + -- Default desktop basic icons + baseicons = { + [1] = { + label = 'This PC', + icon = 'computer', + onclick = 'computer://', + }, + [2] = { + label = 'Home', + icon = 'user-home', + onclick = os.getenv('HOME'), + }, + [3] = { + label = 'Trash', + icon = 'user-trash', + onclick = 'trash://', + }, + }, + -- Default parameters + iconsize = { width = 48, height = 48 }, + labelsize = { width = 140, height = 20 }, + margin = { x = 20, y = 20 }, +} + +-- MIME types list +local mime_types = {} + +-- Icons positioning +desktop.current_pos = {} + +-- @return iterator on input pipe +local function pipelines(...) + local f = assert(io.popen(...)) + return function() + local data = f:read() + if data == nil then + f:close() + end + return data + end +end + +-- Adds an icon to desktop +-- @param args settings from desktop.add_icons +-- @param label icon string label +-- @param icon icon string file path +-- @param onclick function to execute on click +function desktop.add_single_icon(args, label, icon, onclick) + local s = args.screen + local dcp = desktop.current_pos + + -- define icon dimensions and position + if not dcp[s] then + dcp[s] = { + x = (screen[s].geometry.x + args.iconsize.width + args.margin.x), + y = screen[s].geometry.y + 20 + args.margin.y, + } + end + + local tot_height = (icon and args.iconsize.height or 0) + (label and args.labelsize.height or 0) + if tot_height == 0 then + return + end + + if dcp[s].y + tot_height > screen[s].geometry.y + screen[s].geometry.height - 20 - args.margin.y then + dcp[s].x = dcp[s].x + args.labelsize.width + args.iconsize.width + args.margin.x + dcp[s].y = 20 + args.margin.y + end + + local common = { screen = s, bg = '#00000000', visible = true, type = 'desktop' } + + -- create icon container + if icon then + common.width = args.iconsize.width + common.height = args.iconsize.height + common.x = dcp[s].x + common.y = dcp[s].y + + icon = wibox.widget({ + image = icon, + resize = false, + widget = wibox.widget.imagebox, + }) + + icon:buttons(awful.button({}, 1, nil, onclick)) + + icon_container = wibox(common) + icon_container:set_widget(icon) + + dcp[s].y = dcp[s].y + args.iconsize.height + 5 + end + + -- create label container + if label then + common.width = args.labelsize.width + common.height = args.labelsize.height + common.x = dcp[s].x - (args.labelsize.width / 2) + args.iconsize.width / 2 + common.y = dcp[s].y + + caption = wibox.widget({ + text = label, + align = 'center', + forced_width = common.width, + forced_height = common.height, + ellipsize = 'middle', + widget = wibox.widget.textbox, + }) + + caption:buttons(awful.button({}, 1, onclick)) + caption_container = wibox(common) + caption_container:set_widget(caption) + end + + dcp[s].y = dcp[s].y + args.labelsize.height + args.margin.y + + desktop.current_pos = dcp + + return dcp +end + +-- Adds base icons (This PC, Trash, etc) to desktop +-- @param args settings from desktop.add_icons +function desktop.add_base_icons(args) + for _, base in ipairs(args.baseicons) do + desktop.add_single_icon(args, base.label, utils.lookup_icon(base.icon), function() + awful.spawn(string.format("%s '%s'", args.open_with, base.onclick)) + end) + end +end + +-- Looks up a suitable icon for filename +-- @param filename string file name +-- @return icon file path (string) +function desktop.lookup_file_icon(filename) + -- load system MIME types + if #mime_types == 0 then + for line in io.lines('/etc/mime.types') do + if not line:find('^#') then + local parsed = {} + for w in line:gmatch('[^%s]+') do + table.insert(parsed, w) + end + if #parsed > 1 then + for i = 2, #parsed do + mime_types[parsed[i]] = parsed[1]:gsub('/', '-') + end + end + end + end + end + + -- try to search a possible icon among standards + local extension = filename:match('%a+$') + local mime = mime_types[extension] or '' + local mime_family = mime:match('^%a+') or '' + + local possible_filenames = { + mime, + 'gnome-mime-' .. mime, + mime_family, + 'gnome-mime-' .. mime_family, + extension, + } + + for i, filename in ipairs(possible_filenames) do + local icon = utils.lookup_icon(filename) + if icon then + return icon + end + end + + -- if we don"t find ad icon, then pretend is a plain text file + return utils.lookup_icon('text-x-generic') +end + +-- Parse subdirectories and files list from input directory +-- @input dir directory to parse (string) +-- @return files table with found entries +function desktop.parse_dirs_and_files(dir) + local files = {} + local paths = pipelines('find ' .. dir .. ' -maxdepth 1 -type d |sort|tail -n +1') + for path in paths do + if path:match('[^/]+$') then + local file = {} + file.filename = path:match('[^/]+$') + file.path = path + file.show = true + file.icon = utils.lookup_icon('folder') + table.insert(files, file) + end + end + local paths = pipelines('find ' .. dir .. ' -maxdepth 1 -type f') + for path in paths do + if not path:find('%.desktop$') then + local file = {} + file.filename = path:match('[^/]+$') + file.path = path + file.show = true + file.icon = desktop.lookup_file_icon(file.filename) + table.insert(files, file) + end + end + return files +end + +-- Adds subdirectories and files icons from args.dir +-- @param args settings from desktop.add_icons +function desktop.add_dirs_and_files_icons(args) + for _, file in ipairs(desktop.parse_dirs_and_files(args.dir)) do + if file.show then + local label = args.showlabels and file.filename or nil + local onclick = function() + awful.spawn(string.format("%s '%s'", args.open_with, file.path)) + end + desktop.add_single_icon(args, label, file.icon, onclick) + end + end +end + +-- Main function, adds base, directory and files icons +-- @param args user defined settings, with fallback on defaults +function desktop.add_icons(args) + args = args or {} + args.screen = args.screen or mouse.screen + args.dir = args.dir or os.getenv('HOME') .. '/Desktop' + args.showlabels = args.showlabel or true + args.open_with = args.open_with or 'xdg_open' + args.baseicons = args.baseicons or desktop.baseicons + args.iconsize = args.iconsize or desktop.iconsize + args.labelsize = args.labelsize or desktop.labelsize + args.margin = args.margin or desktop.margin + + -- trying to fallback on Adwaita if theme.icon_theme is not defined + -- if Adwaita is missing too, no icons will be shown + if not theme.icon_theme then + theme.icon_theme = args.icon_theme or 'Adwaita' + end + + desktop.add_base_icons(args) + desktop.add_dirs_and_files_icons(args) +end + +return desktop diff --git a/lib/freedesktop/init.lua b/lib/freedesktop/init.lua new file mode 100644 index 0000000..1c66ba6 --- /dev/null +++ b/lib/freedesktop/init.lua @@ -0,0 +1,15 @@ +--[[ + + Awesome-Freedesktop + Freedesktop.org compliant desktop entries and menu + + Licensed under GNU General Public License v2 + * (c) 2016, Luke Bonham + * (c) 2009-2015, Antonio Terceiro + +--]] + +return { + desktop = require('freedesktop.desktop'), + menu = require('freedesktop.menu'), +} diff --git a/lib/freedesktop/menu.lua b/lib/freedesktop/menu.lua new file mode 100644 index 0000000..55bb668 --- /dev/null +++ b/lib/freedesktop/menu.lua @@ -0,0 +1,128 @@ +--[[ + + Awesome-Freedesktop + Freedesktop.org compliant desktop entries and menu + + Menu section + + Licensed under GNU General Public License v2 + * (c) 2016, Luke Bonham + * (c) 2014, Harvey Mittens + +--]] + +local Gio = require('lgi').Gio +local awful_menu = require('awful.menu') +local menu_gen = require('menubar.menu_gen') +local menu_utils = require('menubar.utils') + +local io, pairs, string, table, os = io, pairs, string, table, os + +-- Expecting a wm_name of awesome omits too many applications and tools +menu_utils.wm_name = '' + +-- Menu +-- freedesktop.menu +local menu = {} + +-- Check if a path is a directory. +-- @tparam string path The directory path +-- @treturn boolean True if path exists and is a directory +function menu.is_dir(path) + return Gio.File.new_for_path(path):query_file_type({}) == 'DIRECTORY' +end + +-- Remove non existent paths in order to avoid issues +local existent_paths = {} +for k, v in pairs(menu_gen.all_menu_dirs) do + if menu.is_dir(v) then + table.insert(existent_paths, v) + end +end +menu_gen.all_menu_dirs = existent_paths + +-- Determines whether an table includes a certain element +-- @param tab a given table +-- @param val the element to search for +-- @return true if the given string is found within the search table; otherwise, false if not +function menu.has_value(tab, val) + for index, value in pairs(tab) do + if val:find(value) then + return true + end + end + return false +end + +-- Use MenuBar parsing utils to build a menu for Awesome +-- @return awful.menu +function menu.build(args) + local args = args or {} + local before = args.before or {} + local after = args.after or {} + local skip_items = args.skip_items or {} + local sub_menu = args.sub_menu or false + + local result = {} + local _menu = awful_menu({ items = before }) + + menu_gen.generate(function(entries) + -- Add category icons + for k, v in pairs(menu_gen.all_categories) do + table.insert(result, { k, {}, v.icon }) + end + + -- Get items table + for k, v in pairs(entries) do + for _, cat in pairs(result) do + if cat[1] == v.category then + if not menu.has_value(skip_items, v.name) then + table.insert(cat[2], { v.name, v.cmdline, v.icon }) + end + break + end + end + end + + -- Cleanup things a bit + for i = #result, 1, -1 do + local v = result[i] + if #v[2] == 0 then + -- Remove unused categories + table.remove(result, i) + else + --Sort entries alphabetically (by name) + table.sort(v[2], function(a, b) + return string.byte(a[1]) < string.byte(b[1]) + end) + -- Replace category name with nice name + v[1] = menu_gen.all_categories[v[1]].name + end + end + + -- Sort categories alphabetically also + table.sort(result, function(a, b) + return string.byte(a[1]) < string.byte(b[1]) + end) + + -- Add menu item to hold the generated menu + if sub_menu then + result = { { sub_menu, result } } + end + + -- Add items to menu + for _, v in pairs(result) do + _menu:add(v) + end + for _, v in pairs(after) do + _menu:add(v) + end + end) + + -- Hold the menu in the module + menu.menu = _menu + + return _menu +end + +return menu diff --git a/lib/freedesktop/screenshot.png b/lib/freedesktop/screenshot.png new file mode 100644 index 0000000..bf254ac Binary files /dev/null and b/lib/freedesktop/screenshot.png differ diff --git a/lib/lain/.github/workflows/main.yml b/lib/lain/.github/workflows/main.yml new file mode 100644 index 0000000..37957f6 --- /dev/null +++ b/lib/lain/.github/workflows/main.yml @@ -0,0 +1,17 @@ +name: Lain + +on: [push] + +permissions: + contents: read + +jobs: + linting: + runs-on: ubuntu-latest + steps: + - run: echo "Running tests triggered by a ${{ github.event_name }} event." + - run: echo "Testing ${{ github.ref }} from ${{ github.repository }} on ${{ runner.os }}" + - name: Check out code + uses: actions/checkout@v3 + - name: Run tests + uses: lunarmodules/luacheck@v0 diff --git a/lib/lain/.gitmodules b/lib/lain/.gitmodules new file mode 100644 index 0000000..d95bcb5 --- /dev/null +++ b/lib/lain/.gitmodules @@ -0,0 +1,3 @@ +[submodule "lain.wiki"] + path = wiki + url = https://github.com/lcpz/lain.wiki.git diff --git a/lib/lain/.luacheckrc b/lib/lain/.luacheckrc new file mode 100644 index 0000000..9944223 --- /dev/null +++ b/lib/lain/.luacheckrc @@ -0,0 +1,27 @@ +-- Only allow symbols available in all Lua versions +std = "min" + +allow_defined = true +max_line_length = false +cache = true + +-- Global objects defined by the C code +read_globals = { + "awesome", + "mousegrabber", + "table.unpack", + "unpack", + "utf8" +} + +globals = { + "client", + "mouse", + "root", + "screen" +} + +-- https://luacheck.readthedocs.io/en/stable/warnings.html +ignore = { + "131" +} diff --git a/lib/lain/ISSUE_TEMPLATE.md b/lib/lain/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..e9dcc0b --- /dev/null +++ b/lib/lain/ISSUE_TEMPLATE.md @@ -0,0 +1,33 @@ +# Please, read me! + +So that I can help you quickly and without having to redirect you here. + +# If you have an issue + +**Please read the [wiki](https://github.com/lcpz/lain/wiki) and search the [Issues section](https://github.com/lcpz/lain/issues) first.** + +If you can't find a solution there, then go ahead and provide: + +* output of `awesome -v` and `lua -v` +* expected behavior and actual behavior +* steps to reproduce the problem +* X error log + +# How to provide X error log + +There are two ways: + +* (Physically) Restart X like this: + ```shell + startx -- -keeptty -nolisten tcp > $HOME/.xorg.log 2>&1 + ``` + the error log will be output into `$HOME/.xorg.log`. + +* (Virtually) Use [Xephyr](https://wikipedia.org/wiki/Xephyr): + ```shell + # set screen size as you like + Xephyr :1 -screen 1280x800 2> stdout.txt & DISPLAY=:1 awesome + ``` + the error log will be output in the file `stdout.txt`. + +Before reporting, read the log and see if you can solve it yourself. diff --git a/lib/lain/LICENSE b/lib/lain/LICENSE new file mode 100644 index 0000000..23cb790 --- /dev/null +++ b/lib/lain/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/lib/lain/README.rst b/lib/lain/README.rst new file mode 100644 index 0000000..616c7cd --- /dev/null +++ b/lib/lain/README.rst @@ -0,0 +1,40 @@ +Lain +==== + +.. image:: https://github.com/lcpz/lain/actions/workflows/main.yml/badge.svg + +------------------------------------------------- +Layouts, widgets and utilities for Awesome WM 4.x +------------------------------------------------- + +:Author: Luca CPZ +:Version: git +:License: GNU-GPL2_ +:Source: https://github.com/lcpz/lain + +Description +----------- + +Successor of awesome-vain_, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome_. + +Contributions +------------- + +Constructive criticism and suggestions are welcome. + +If you want to create a pull request, make sure that: + +- Your code fits with the general style of the module. In particular, you should use the same indentation pattern that the code uses, and also avoid adding space at the ends of lines. + +- Your code its easy to understand, maintainable, and modularized. You should also avoid code duplication wherever possible by adding functions to or using lain.helpers_. If something is unclear, or you can not write it in such a way that it will be clear, explain it with a comment. + +- You test your changes before submitting to make sure that your code works and does not break other parts of the module. + +- You update ``wiki`` submodule with a thorough section, if necessary. + +Contributed widgets have to be put in ``widget/contrib``. + +.. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html +.. _awesome-vain: https://github.com/vain/awesome-vain +.. _Awesome: https://github.com/awesomeWM/awesome +.. _lain.helpers: https://github.com/lcpz/lain/blob/master/helpers.lua diff --git a/lib/lain/helpers.lua b/lib/lain/helpers.lua new file mode 100644 index 0000000..bedb08f --- /dev/null +++ b/lib/lain/helpers.lua @@ -0,0 +1,210 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +local spawn = require('awful.spawn') +local timer = require('gears.timer') +local debug = require('debug') +local io = { lines = io.lines, open = io.open } +local pairs = pairs +local rawget = rawget +local tsort = table.sort +local unpack = unpack or table.unpack -- lua 5.1 retro-compatibility + +-- Lain helper functions for internal use +-- lain.helpers +local helpers = {} + +helpers.lain_dir = debug.getinfo(1, 'S').source:match([[^@(.*/).*$]]) +helpers.icons_dir = helpers.lain_dir .. 'icons/' +helpers.scripts_dir = helpers.lain_dir .. 'scripts/' + +-- {{{ Modules loader + +function helpers.wrequire(t, k) + return rawget(t, k) or require(t._NAME .. '.' .. k) +end + +-- }}} + +-- {{{ File operations + +-- check if the file exists and is readable +function helpers.file_exists(path) + local file = io.open(path, 'rb') + if file then + file:close() + end + return file ~= nil +end + +-- get a table with all lines from a file +function helpers.lines_from(path) + local lines = {} + for line in io.lines(path) do + lines[#lines + 1] = line + end + return lines +end + +-- get a table with all lines from a file matching regexp +function helpers.lines_match(regexp, path) + local lines = {} + for line in io.lines(path) do + if string.match(line, regexp) then + lines[#lines + 1] = line + end + end + return lines +end + +-- get first line of a file +function helpers.first_line(path) + local file, first = io.open(path, 'rb'), nil + if file then + first = file:read('*l') + file:close() + end + return first +end + +-- get first non empty line from a file +function helpers.first_nonempty_line(path) + for line in io.lines(path) do + if #line then + return line + end + end + return nil +end + +-- }}} + +-- {{{ Timer maker + +helpers.timer_table = {} + +function helpers.newtimer(name, timeout, fun, nostart, stoppable) + if not name or #name == 0 then + return + end + name = (stoppable and name) or timeout + if not helpers.timer_table[name] then + helpers.timer_table[name] = timer({ timeout = timeout }) + helpers.timer_table[name]:start() + end + helpers.timer_table[name]:connect_signal('timeout', fun) + if not nostart then + helpers.timer_table[name]:emit_signal('timeout') + end + return stoppable and helpers.timer_table[name] +end + +-- }}} + +-- {{{ Pipe operations + +-- run a command and execute a function on its output (asynchronous pipe) +-- @param cmd the input command +-- @param callback function to execute on cmd output +-- @return cmd PID +function helpers.async(cmd, callback) + return spawn.easy_async(cmd, function(stdout, _, _, exit_code) + callback(stdout, exit_code) + end) +end + +-- like above, but call spawn.easy_async with a shell +function helpers.async_with_shell(cmd, callback) + return spawn.easy_async_with_shell(cmd, function(stdout, _, _, exit_code) + callback(stdout, exit_code) + end) +end + +-- run a command and execute a function on its output line by line +function helpers.line_callback(cmd, callback) + return spawn.with_line_callback(cmd, { + stdout = function(line) + callback(line) + end, + }) +end + +-- }}} + +-- {{{ A map utility + +helpers.map_table = {} + +function helpers.set_map(element, value) + helpers.map_table[element] = value +end + +function helpers.get_map(element) + return helpers.map_table[element] +end + +-- }}} + +-- {{{ Misc + +-- check if an element exist on a table +function helpers.element_in_table(element, tbl) + for _, i in pairs(tbl) do + if i == element then + return true + end + end + return false +end + +-- iterate over table of records sorted by keys +function helpers.spairs(t) + -- collect the keys + local keys = {} + for k in pairs(t) do + keys[#keys + 1] = k + end + + tsort(keys) + + -- return the iterator function + local i = 0 + return function() + i = i + 1 + if keys[i] then + return keys[i], t[keys[i]] + end + end +end + +-- 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 + ss[#ss + 1] = { e } + end + return ss +end + +-- create the powerset of a given set +function helpers.powerset(s) + if not s then + return {} + end + local t = { {} } + for i = 1, #s do + for j = 1, #t do + t[#t + 1] = { s[i], unpack(t[j]) } + end + end + return t +end + +-- }}} + +return helpers diff --git a/lib/lain/icons/cal/black/1.png b/lib/lain/icons/cal/black/1.png new file mode 100644 index 0000000..d2fb62e Binary files /dev/null and b/lib/lain/icons/cal/black/1.png differ diff --git a/lib/lain/icons/cal/black/10.png b/lib/lain/icons/cal/black/10.png new file mode 100644 index 0000000..507b079 Binary files /dev/null and b/lib/lain/icons/cal/black/10.png differ diff --git a/lib/lain/icons/cal/black/11.png b/lib/lain/icons/cal/black/11.png new file mode 100644 index 0000000..336141b Binary files /dev/null and b/lib/lain/icons/cal/black/11.png differ diff --git a/lib/lain/icons/cal/black/12.png b/lib/lain/icons/cal/black/12.png new file mode 100644 index 0000000..c589729 Binary files /dev/null and b/lib/lain/icons/cal/black/12.png differ diff --git a/lib/lain/icons/cal/black/13.png b/lib/lain/icons/cal/black/13.png new file mode 100644 index 0000000..377518b Binary files /dev/null and b/lib/lain/icons/cal/black/13.png differ diff --git a/lib/lain/icons/cal/black/14.png b/lib/lain/icons/cal/black/14.png new file mode 100644 index 0000000..6f4a9fe Binary files /dev/null and b/lib/lain/icons/cal/black/14.png differ diff --git a/lib/lain/icons/cal/black/15.png b/lib/lain/icons/cal/black/15.png new file mode 100644 index 0000000..1a271c1 Binary files /dev/null and b/lib/lain/icons/cal/black/15.png differ diff --git a/lib/lain/icons/cal/black/16.png b/lib/lain/icons/cal/black/16.png new file mode 100644 index 0000000..5e65835 Binary files /dev/null and b/lib/lain/icons/cal/black/16.png differ diff --git a/lib/lain/icons/cal/black/17.png b/lib/lain/icons/cal/black/17.png new file mode 100644 index 0000000..f3fa0a9 Binary files /dev/null and b/lib/lain/icons/cal/black/17.png differ diff --git a/lib/lain/icons/cal/black/18.png b/lib/lain/icons/cal/black/18.png new file mode 100644 index 0000000..7acb37a Binary files /dev/null and b/lib/lain/icons/cal/black/18.png differ diff --git a/lib/lain/icons/cal/black/19.png b/lib/lain/icons/cal/black/19.png new file mode 100644 index 0000000..a557957 Binary files /dev/null and b/lib/lain/icons/cal/black/19.png differ diff --git a/lib/lain/icons/cal/black/2.png b/lib/lain/icons/cal/black/2.png new file mode 100644 index 0000000..17b33e0 Binary files /dev/null and b/lib/lain/icons/cal/black/2.png differ diff --git a/lib/lain/icons/cal/black/20.png b/lib/lain/icons/cal/black/20.png new file mode 100644 index 0000000..558d111 Binary files /dev/null and b/lib/lain/icons/cal/black/20.png differ diff --git a/lib/lain/icons/cal/black/21.png b/lib/lain/icons/cal/black/21.png new file mode 100644 index 0000000..0bbedc8 Binary files /dev/null and b/lib/lain/icons/cal/black/21.png differ diff --git a/lib/lain/icons/cal/black/22.png b/lib/lain/icons/cal/black/22.png new file mode 100644 index 0000000..762d262 Binary files /dev/null and b/lib/lain/icons/cal/black/22.png differ diff --git a/lib/lain/icons/cal/black/23.png b/lib/lain/icons/cal/black/23.png new file mode 100644 index 0000000..a39dcee Binary files /dev/null and b/lib/lain/icons/cal/black/23.png differ diff --git a/lib/lain/icons/cal/black/24.png b/lib/lain/icons/cal/black/24.png new file mode 100644 index 0000000..c00dbca Binary files /dev/null and b/lib/lain/icons/cal/black/24.png differ diff --git a/lib/lain/icons/cal/black/25.png b/lib/lain/icons/cal/black/25.png new file mode 100644 index 0000000..dc9243c Binary files /dev/null and b/lib/lain/icons/cal/black/25.png differ diff --git a/lib/lain/icons/cal/black/26.png b/lib/lain/icons/cal/black/26.png new file mode 100644 index 0000000..50bb182 Binary files /dev/null and b/lib/lain/icons/cal/black/26.png differ diff --git a/lib/lain/icons/cal/black/27.png b/lib/lain/icons/cal/black/27.png new file mode 100644 index 0000000..0fbf9fc Binary files /dev/null and b/lib/lain/icons/cal/black/27.png differ diff --git a/lib/lain/icons/cal/black/28.png b/lib/lain/icons/cal/black/28.png new file mode 100644 index 0000000..def6ab2 Binary files /dev/null and b/lib/lain/icons/cal/black/28.png differ diff --git a/lib/lain/icons/cal/black/29.png b/lib/lain/icons/cal/black/29.png new file mode 100644 index 0000000..531923c Binary files /dev/null and b/lib/lain/icons/cal/black/29.png differ diff --git a/lib/lain/icons/cal/black/3.png b/lib/lain/icons/cal/black/3.png new file mode 100644 index 0000000..98b552d Binary files /dev/null and b/lib/lain/icons/cal/black/3.png differ diff --git a/lib/lain/icons/cal/black/30.png b/lib/lain/icons/cal/black/30.png new file mode 100644 index 0000000..ca58151 Binary files /dev/null and b/lib/lain/icons/cal/black/30.png differ diff --git a/lib/lain/icons/cal/black/31.png b/lib/lain/icons/cal/black/31.png new file mode 100644 index 0000000..6e8da21 Binary files /dev/null and b/lib/lain/icons/cal/black/31.png differ diff --git a/lib/lain/icons/cal/black/4.png b/lib/lain/icons/cal/black/4.png new file mode 100644 index 0000000..4335979 Binary files /dev/null and b/lib/lain/icons/cal/black/4.png differ diff --git a/lib/lain/icons/cal/black/5.png b/lib/lain/icons/cal/black/5.png new file mode 100644 index 0000000..576ec11 Binary files /dev/null and b/lib/lain/icons/cal/black/5.png differ diff --git a/lib/lain/icons/cal/black/6.png b/lib/lain/icons/cal/black/6.png new file mode 100644 index 0000000..56fa8ab Binary files /dev/null and b/lib/lain/icons/cal/black/6.png differ diff --git a/lib/lain/icons/cal/black/7.png b/lib/lain/icons/cal/black/7.png new file mode 100644 index 0000000..7c90b3a Binary files /dev/null and b/lib/lain/icons/cal/black/7.png differ diff --git a/lib/lain/icons/cal/black/8.png b/lib/lain/icons/cal/black/8.png new file mode 100644 index 0000000..9d1f28e Binary files /dev/null and b/lib/lain/icons/cal/black/8.png differ diff --git a/lib/lain/icons/cal/black/9.png b/lib/lain/icons/cal/black/9.png new file mode 100644 index 0000000..00d0933 Binary files /dev/null and b/lib/lain/icons/cal/black/9.png differ diff --git a/lib/lain/icons/cal/white/1.png b/lib/lain/icons/cal/white/1.png new file mode 100644 index 0000000..a0faa20 Binary files /dev/null and b/lib/lain/icons/cal/white/1.png differ diff --git a/lib/lain/icons/cal/white/10.png b/lib/lain/icons/cal/white/10.png new file mode 100644 index 0000000..7d9343b Binary files /dev/null and b/lib/lain/icons/cal/white/10.png differ diff --git a/lib/lain/icons/cal/white/11.png b/lib/lain/icons/cal/white/11.png new file mode 100644 index 0000000..7af5e99 Binary files /dev/null and b/lib/lain/icons/cal/white/11.png differ diff --git a/lib/lain/icons/cal/white/12.png b/lib/lain/icons/cal/white/12.png new file mode 100644 index 0000000..b164f85 Binary files /dev/null and b/lib/lain/icons/cal/white/12.png differ diff --git a/lib/lain/icons/cal/white/13.png b/lib/lain/icons/cal/white/13.png new file mode 100644 index 0000000..fef74f3 Binary files /dev/null and b/lib/lain/icons/cal/white/13.png differ diff --git a/lib/lain/icons/cal/white/14.png b/lib/lain/icons/cal/white/14.png new file mode 100644 index 0000000..d747a6b Binary files /dev/null and b/lib/lain/icons/cal/white/14.png differ diff --git a/lib/lain/icons/cal/white/15.png b/lib/lain/icons/cal/white/15.png new file mode 100644 index 0000000..64418a6 Binary files /dev/null and b/lib/lain/icons/cal/white/15.png differ diff --git a/lib/lain/icons/cal/white/16.png b/lib/lain/icons/cal/white/16.png new file mode 100644 index 0000000..8b86700 Binary files /dev/null and b/lib/lain/icons/cal/white/16.png differ diff --git a/lib/lain/icons/cal/white/17.png b/lib/lain/icons/cal/white/17.png new file mode 100644 index 0000000..033b5ff Binary files /dev/null and b/lib/lain/icons/cal/white/17.png differ diff --git a/lib/lain/icons/cal/white/18.png b/lib/lain/icons/cal/white/18.png new file mode 100644 index 0000000..0cf1c24 Binary files /dev/null and b/lib/lain/icons/cal/white/18.png differ diff --git a/lib/lain/icons/cal/white/19.png b/lib/lain/icons/cal/white/19.png new file mode 100644 index 0000000..bfd3530 Binary files /dev/null and b/lib/lain/icons/cal/white/19.png differ diff --git a/lib/lain/icons/cal/white/2.png b/lib/lain/icons/cal/white/2.png new file mode 100644 index 0000000..e7f3fa4 Binary files /dev/null and b/lib/lain/icons/cal/white/2.png differ diff --git a/lib/lain/icons/cal/white/20.png b/lib/lain/icons/cal/white/20.png new file mode 100644 index 0000000..9a5a1fb Binary files /dev/null and b/lib/lain/icons/cal/white/20.png differ diff --git a/lib/lain/icons/cal/white/21.png b/lib/lain/icons/cal/white/21.png new file mode 100644 index 0000000..266ab9f Binary files /dev/null and b/lib/lain/icons/cal/white/21.png differ diff --git a/lib/lain/icons/cal/white/22.png b/lib/lain/icons/cal/white/22.png new file mode 100644 index 0000000..f486289 Binary files /dev/null and b/lib/lain/icons/cal/white/22.png differ diff --git a/lib/lain/icons/cal/white/23.png b/lib/lain/icons/cal/white/23.png new file mode 100644 index 0000000..244dceb Binary files /dev/null and b/lib/lain/icons/cal/white/23.png differ diff --git a/lib/lain/icons/cal/white/24.png b/lib/lain/icons/cal/white/24.png new file mode 100644 index 0000000..0ce1c75 Binary files /dev/null and b/lib/lain/icons/cal/white/24.png differ diff --git a/lib/lain/icons/cal/white/25.png b/lib/lain/icons/cal/white/25.png new file mode 100644 index 0000000..48d279c Binary files /dev/null and b/lib/lain/icons/cal/white/25.png differ diff --git a/lib/lain/icons/cal/white/26.png b/lib/lain/icons/cal/white/26.png new file mode 100644 index 0000000..7535855 Binary files /dev/null and b/lib/lain/icons/cal/white/26.png differ diff --git a/lib/lain/icons/cal/white/27.png b/lib/lain/icons/cal/white/27.png new file mode 100644 index 0000000..2aa9074 Binary files /dev/null and b/lib/lain/icons/cal/white/27.png differ diff --git a/lib/lain/icons/cal/white/28.png b/lib/lain/icons/cal/white/28.png new file mode 100644 index 0000000..0201976 Binary files /dev/null and b/lib/lain/icons/cal/white/28.png differ diff --git a/lib/lain/icons/cal/white/29.png b/lib/lain/icons/cal/white/29.png new file mode 100644 index 0000000..9305b9b Binary files /dev/null and b/lib/lain/icons/cal/white/29.png differ diff --git a/lib/lain/icons/cal/white/3.png b/lib/lain/icons/cal/white/3.png new file mode 100644 index 0000000..f1eb5de Binary files /dev/null and b/lib/lain/icons/cal/white/3.png differ diff --git a/lib/lain/icons/cal/white/30.png b/lib/lain/icons/cal/white/30.png new file mode 100644 index 0000000..1ba61aa Binary files /dev/null and b/lib/lain/icons/cal/white/30.png differ diff --git a/lib/lain/icons/cal/white/31.png b/lib/lain/icons/cal/white/31.png new file mode 100644 index 0000000..e9a873b Binary files /dev/null and b/lib/lain/icons/cal/white/31.png differ diff --git a/lib/lain/icons/cal/white/4.png b/lib/lain/icons/cal/white/4.png new file mode 100644 index 0000000..ee1ed6a Binary files /dev/null and b/lib/lain/icons/cal/white/4.png differ diff --git a/lib/lain/icons/cal/white/5.png b/lib/lain/icons/cal/white/5.png new file mode 100644 index 0000000..466aa71 Binary files /dev/null and b/lib/lain/icons/cal/white/5.png differ diff --git a/lib/lain/icons/cal/white/6.png b/lib/lain/icons/cal/white/6.png new file mode 100644 index 0000000..0a7bf4d Binary files /dev/null and b/lib/lain/icons/cal/white/6.png differ diff --git a/lib/lain/icons/cal/white/7.png b/lib/lain/icons/cal/white/7.png new file mode 100644 index 0000000..e971951 Binary files /dev/null and b/lib/lain/icons/cal/white/7.png differ diff --git a/lib/lain/icons/cal/white/8.png b/lib/lain/icons/cal/white/8.png new file mode 100644 index 0000000..cb03d0b Binary files /dev/null and b/lib/lain/icons/cal/white/8.png differ diff --git a/lib/lain/icons/cal/white/9.png b/lib/lain/icons/cal/white/9.png new file mode 100644 index 0000000..fca554a Binary files /dev/null and b/lib/lain/icons/cal/white/9.png differ diff --git a/lib/lain/icons/layout/default/cascade.png b/lib/lain/icons/layout/default/cascade.png new file mode 100644 index 0000000..292a057 Binary files /dev/null and b/lib/lain/icons/layout/default/cascade.png differ diff --git a/lib/lain/icons/layout/default/cascadetile.png b/lib/lain/icons/layout/default/cascadetile.png new file mode 100644 index 0000000..ba30f43 Binary files /dev/null and b/lib/lain/icons/layout/default/cascadetile.png differ diff --git a/lib/lain/icons/layout/default/cascadetilew.png b/lib/lain/icons/layout/default/cascadetilew.png new file mode 100644 index 0000000..d15eb70 Binary files /dev/null and b/lib/lain/icons/layout/default/cascadetilew.png differ diff --git a/lib/lain/icons/layout/default/cascadew.png b/lib/lain/icons/layout/default/cascadew.png new file mode 100644 index 0000000..da64bd6 Binary files /dev/null and b/lib/lain/icons/layout/default/cascadew.png differ diff --git a/lib/lain/icons/layout/default/centerfair.png b/lib/lain/icons/layout/default/centerfair.png new file mode 100644 index 0000000..188c243 Binary files /dev/null and b/lib/lain/icons/layout/default/centerfair.png differ diff --git a/lib/lain/icons/layout/default/centerfairw.png b/lib/lain/icons/layout/default/centerfairw.png new file mode 100644 index 0000000..ed4bcf5 Binary files /dev/null and b/lib/lain/icons/layout/default/centerfairw.png differ diff --git a/lib/lain/icons/layout/default/centerwork.png b/lib/lain/icons/layout/default/centerwork.png new file mode 100644 index 0000000..51e06bc Binary files /dev/null and b/lib/lain/icons/layout/default/centerwork.png differ diff --git a/lib/lain/icons/layout/default/centerworkh.png b/lib/lain/icons/layout/default/centerworkh.png new file mode 100644 index 0000000..c59092f Binary files /dev/null and b/lib/lain/icons/layout/default/centerworkh.png differ diff --git a/lib/lain/icons/layout/default/centerworkhw.png b/lib/lain/icons/layout/default/centerworkhw.png new file mode 100644 index 0000000..7820f8c Binary files /dev/null and b/lib/lain/icons/layout/default/centerworkhw.png differ diff --git a/lib/lain/icons/layout/default/centerworkw.png b/lib/lain/icons/layout/default/centerworkw.png new file mode 100644 index 0000000..85e6996 Binary files /dev/null and b/lib/lain/icons/layout/default/centerworkw.png differ diff --git a/lib/lain/icons/layout/default/termfair.png b/lib/lain/icons/layout/default/termfair.png new file mode 100644 index 0000000..06226c1 Binary files /dev/null and b/lib/lain/icons/layout/default/termfair.png differ diff --git a/lib/lain/icons/layout/default/termfairw.png b/lib/lain/icons/layout/default/termfairw.png new file mode 100644 index 0000000..0a8b576 Binary files /dev/null and b/lib/lain/icons/layout/default/termfairw.png differ diff --git a/lib/lain/icons/layout/zenburn/cascade.png b/lib/lain/icons/layout/zenburn/cascade.png new file mode 100644 index 0000000..fbe4fac Binary files /dev/null and b/lib/lain/icons/layout/zenburn/cascade.png differ diff --git a/lib/lain/icons/layout/zenburn/cascadetile.png b/lib/lain/icons/layout/zenburn/cascadetile.png new file mode 100644 index 0000000..2e03a80 Binary files /dev/null and b/lib/lain/icons/layout/zenburn/cascadetile.png differ diff --git a/lib/lain/icons/layout/zenburn/centerfair.png b/lib/lain/icons/layout/zenburn/centerfair.png new file mode 100644 index 0000000..75dc993 Binary files /dev/null and b/lib/lain/icons/layout/zenburn/centerfair.png differ diff --git a/lib/lain/icons/layout/zenburn/centerwork.png b/lib/lain/icons/layout/zenburn/centerwork.png new file mode 100644 index 0000000..af7a863 Binary files /dev/null and b/lib/lain/icons/layout/zenburn/centerwork.png differ diff --git a/lib/lain/icons/layout/zenburn/centerworkh.png b/lib/lain/icons/layout/zenburn/centerworkh.png new file mode 100644 index 0000000..88019b3 Binary files /dev/null and b/lib/lain/icons/layout/zenburn/centerworkh.png differ diff --git a/lib/lain/icons/layout/zenburn/termfair.png b/lib/lain/icons/layout/zenburn/termfair.png new file mode 100644 index 0000000..f7640b5 Binary files /dev/null and b/lib/lain/icons/layout/zenburn/termfair.png differ diff --git a/lib/lain/icons/mail.png b/lib/lain/icons/mail.png new file mode 100644 index 0000000..9c0c7a3 Binary files /dev/null and b/lib/lain/icons/mail.png differ diff --git a/lib/lain/icons/no_net.png b/lib/lain/icons/no_net.png new file mode 100644 index 0000000..3613372 Binary files /dev/null and b/lib/lain/icons/no_net.png differ diff --git a/lib/lain/icons/openweathermap/01d.png b/lib/lain/icons/openweathermap/01d.png new file mode 100644 index 0000000..569965e Binary files /dev/null and b/lib/lain/icons/openweathermap/01d.png differ diff --git a/lib/lain/icons/openweathermap/01n.png b/lib/lain/icons/openweathermap/01n.png new file mode 100644 index 0000000..ce5b135 Binary files /dev/null and b/lib/lain/icons/openweathermap/01n.png differ diff --git a/lib/lain/icons/openweathermap/02d.png b/lib/lain/icons/openweathermap/02d.png new file mode 100644 index 0000000..2ba9799 Binary files /dev/null and b/lib/lain/icons/openweathermap/02d.png differ diff --git a/lib/lain/icons/openweathermap/02n.png b/lib/lain/icons/openweathermap/02n.png new file mode 100644 index 0000000..12e4283 Binary files /dev/null and b/lib/lain/icons/openweathermap/02n.png differ diff --git a/lib/lain/icons/openweathermap/03d.png b/lib/lain/icons/openweathermap/03d.png new file mode 100644 index 0000000..1cf0e9d Binary files /dev/null and b/lib/lain/icons/openweathermap/03d.png differ diff --git a/lib/lain/icons/openweathermap/03n.png b/lib/lain/icons/openweathermap/03n.png new file mode 100644 index 0000000..89a42b8 Binary files /dev/null and b/lib/lain/icons/openweathermap/03n.png differ diff --git a/lib/lain/icons/openweathermap/04d.png b/lib/lain/icons/openweathermap/04d.png new file mode 100644 index 0000000..e7fb67f Binary files /dev/null and b/lib/lain/icons/openweathermap/04d.png differ diff --git a/lib/lain/icons/openweathermap/04n.png b/lib/lain/icons/openweathermap/04n.png new file mode 100644 index 0000000..e7fb67f Binary files /dev/null and b/lib/lain/icons/openweathermap/04n.png differ diff --git a/lib/lain/icons/openweathermap/09d.png b/lib/lain/icons/openweathermap/09d.png new file mode 100644 index 0000000..cfa066a Binary files /dev/null and b/lib/lain/icons/openweathermap/09d.png differ diff --git a/lib/lain/icons/openweathermap/09n.png b/lib/lain/icons/openweathermap/09n.png new file mode 100644 index 0000000..cfa066a Binary files /dev/null and b/lib/lain/icons/openweathermap/09n.png differ diff --git a/lib/lain/icons/openweathermap/10d.png b/lib/lain/icons/openweathermap/10d.png new file mode 100644 index 0000000..712d0c8 Binary files /dev/null and b/lib/lain/icons/openweathermap/10d.png differ diff --git a/lib/lain/icons/openweathermap/10n.png b/lib/lain/icons/openweathermap/10n.png new file mode 100644 index 0000000..712d0c8 Binary files /dev/null and b/lib/lain/icons/openweathermap/10n.png differ diff --git a/lib/lain/icons/openweathermap/11d.png b/lib/lain/icons/openweathermap/11d.png new file mode 100644 index 0000000..3b62f7c Binary files /dev/null and b/lib/lain/icons/openweathermap/11d.png differ diff --git a/lib/lain/icons/openweathermap/11n.png b/lib/lain/icons/openweathermap/11n.png new file mode 100644 index 0000000..3b62f7c Binary files /dev/null and b/lib/lain/icons/openweathermap/11n.png differ diff --git a/lib/lain/icons/openweathermap/13d.png b/lib/lain/icons/openweathermap/13d.png new file mode 100644 index 0000000..e265b01 Binary files /dev/null and b/lib/lain/icons/openweathermap/13d.png differ diff --git a/lib/lain/icons/openweathermap/13n.png b/lib/lain/icons/openweathermap/13n.png new file mode 100644 index 0000000..e265b01 Binary files /dev/null and b/lib/lain/icons/openweathermap/13n.png differ diff --git a/lib/lain/icons/openweathermap/50d.png b/lib/lain/icons/openweathermap/50d.png new file mode 100644 index 0000000..905ace3 Binary files /dev/null and b/lib/lain/icons/openweathermap/50d.png differ diff --git a/lib/lain/icons/openweathermap/50n.png b/lib/lain/icons/openweathermap/50n.png new file mode 100644 index 0000000..905ace3 Binary files /dev/null and b/lib/lain/icons/openweathermap/50n.png differ diff --git a/lib/lain/icons/openweathermap/README.md b/lib/lain/icons/openweathermap/README.md new file mode 100644 index 0000000..f908fbd --- /dev/null +++ b/lib/lain/icons/openweathermap/README.md @@ -0,0 +1,3 @@ +[Plain Weather Icons](http://merlinthered.deviantart.com/art/plain-weather-icons-157162192), created by [MerlinTheRed](http://merlinthered.deviantart.com/). + + diff --git a/lib/lain/icons/openweathermap/na.png b/lib/lain/icons/openweathermap/na.png new file mode 100644 index 0000000..1cc5132 Binary files /dev/null and b/lib/lain/icons/openweathermap/na.png differ diff --git a/lib/lain/icons/taskwarrior.png b/lib/lain/icons/taskwarrior.png new file mode 100644 index 0000000..c64fe86 Binary files /dev/null and b/lib/lain/icons/taskwarrior.png differ diff --git a/lib/lain/init.lua b/lib/lain/init.lua new file mode 100644 index 0000000..6770c40 --- /dev/null +++ b/lib/lain/init.lua @@ -0,0 +1,15 @@ +--[[ + + Lain + Layouts, widgets and utilities for Awesome WM + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +return { + layout = require('lain.layout'), + util = require('lain.util'), + widget = require('lain.widget'), +} diff --git a/lib/lain/lain-scm-1.rockspec b/lib/lain/lain-scm-1.rockspec new file mode 100644 index 0000000..70b0f43 --- /dev/null +++ b/lib/lain/lain-scm-1.rockspec @@ -0,0 +1,22 @@ +package = "lain" +version = "scm-1" +source = { + url = "git+https://github.com/lcpz/lain.git", + tag = "master" +} +description = { + summary = "Layout, widgets and utilities for Awesome WM", + detailed = "Alternative layouts, asynchronous widgets and utility functions for Awesome WM. Non-Lua dependency: curl (for IMAP, MPD and weather widgets).", + homepage = "https://github.com/lcpz/lain", + license = "GPL2" +} +dependencies = { + "lua >= 5.3", + "dkjson >= 2.6-1" +} +supported_platforms = { "linux" } +build = { + type = "builtin", + modules = { lain = "init.lua" } +} + diff --git a/lib/lain/layout/cascade.lua b/lib/lain/layout/cascade.lua new file mode 100644 index 0000000..1403b97 --- /dev/null +++ b/lib/lain/layout/cascade.lua @@ -0,0 +1,190 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2014, projektile + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local floor = math.floor +local screen = screen + +local cascade = { + name = 'cascade', + nmaster = 0, + offset_x = 32, + offset_y = 8, + tile = { + name = 'cascadetile', + nmaster = 0, + ncol = 0, + mwfact = 0, + offset_x = 5, + offset_y = 32, + extra_padding = 0, + }, +} + +local function do_cascade(p, tiling) + local t = p.tag or screen[p.screen].selected_tag + local wa = p.workarea + local cls = p.clients + + if #cls == 0 then + return + end + + if not tiling then + -- Cascade windows. + + local num_c + if cascade.nmaster > 0 then + num_c = cascade.nmaster + else + num_c = t.master_count + end + + -- Opening a new window will usually force all existing windows to + -- get resized. This wastes a lot of CPU time. So let's set a lower + -- bound to "how_many": This wastes a little screen space but you'll + -- get a much better user experience. + local how_many = (#cls >= num_c and #cls) or num_c + + local current_offset_x = cascade.offset_x * (how_many - 1) + local current_offset_y = cascade.offset_y * (how_many - 1) + + -- Iterate. + for i = 1, #cls, 1 do + local c = cls[i] + local g = {} + + g.x = wa.x + (how_many - i) * cascade.offset_x + g.y = wa.y + (i - 1) * cascade.offset_y + g.width = wa.width - current_offset_x + g.height = wa.height - current_offset_y + + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + + p.geometries[c] = g + end + else + -- Layout with one fixed column meant for a master window. Its + -- width is calculated according to mwfact. Other clients are + -- cascaded or "tabbed" in a slave column on the right. + + -- (1) (2) (3) (4) + -- +----------+---+ +----------+---+ +----------+---+ +----------+---+ + -- | | | | | 3 | | | 4 | | +---+| + -- | | | -> | | | -> | +---++ -> | +---+|+ + -- | 1 | 2 | | 1 +---++ | 1 | 3 || | 1 +---+|+| + -- | | | | | 2 || | +---++| | +---+|+ | + -- | | | | | || | | 2 | | | | 2 |+ | + -- +----------+---+ +---------+---++ +--------+---+-+ +------+---+---+ + + local mwfact + if cascade.tile.mwfact > 0 then + mwfact = cascade.tile.mwfact + else + mwfact = t.master_width_factor + end + + -- Make slave windows overlap main window? Do this if ncol is 1. + local overlap_main + if cascade.tile.ncol > 0 then + overlap_main = cascade.tile.ncol + else + overlap_main = t.column_count + end + + -- Minimum space for slave windows? See cascade.tile.lua. + local num_c + if cascade.tile.nmaster > 0 then + num_c = cascade.tile.nmaster + else + num_c = t.master_count + end + + local how_many = (#cls - 1 >= num_c and (#cls - 1)) or num_c + + local current_offset_x = cascade.tile.offset_x * (how_many - 1) + local current_offset_y = cascade.tile.offset_y * (how_many - 1) + + if #cls <= 0 then + return + end + + -- Main column, fixed width and height. + local c = cls[1] + local g = {} + -- Rounding is necessary to prevent the rendered size of slavewid + -- from being 1 pixel off when the result is not an integer. + local mainwid = floor(wa.width * mwfact) + local slavewid = wa.width - mainwid + + if overlap_main == 1 then + g.width = wa.width + + -- The size of the main window may be reduced a little bit. + -- This allows you to see if there are any windows below the + -- main window. + -- This only makes sense, though, if the main window is + -- overlapping everything else. + g.width = g.width - cascade.tile.extra_padding + else + g.width = mainwid + end + + g.height = wa.height + g.x = wa.x + g.y = wa.y + + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + + p.geometries[c] = g + + -- Remaining clients stacked in slave column, new ones on top. + if #cls <= 1 then + return + end + for i = 2, #cls do + c = cls[i] + g = {} + + g.width = slavewid - current_offset_x + g.height = wa.height - current_offset_y + + g.x = wa.x + mainwid + (how_many - (i - 1)) * cascade.tile.offset_x + g.y = wa.y + (i - 2) * cascade.tile.offset_y + + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + + p.geometries[c] = g + end + end +end + +function cascade.tile.arrange(p) + return do_cascade(p, true) +end + +function cascade.arrange(p) + return do_cascade(p, false) +end + +return cascade diff --git a/lib/lain/layout/centerwork.lua b/lib/lain/layout/centerwork.lua new file mode 100644 index 0000000..30c0e16 --- /dev/null +++ b/lib/lain/layout/centerwork.lua @@ -0,0 +1,290 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2018, Eugene Pakhomov + * (c) 2016, Henrik Antonsson + * (c) 2015, Joerg Jaspert + * (c) 2014, projektile + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local floor = math.floor +local max = math.max +local mouse = mouse +local mousegrabber = mousegrabber +local screen = screen + +local centerwork = { + name = 'centerwork', + horizontal = { name = 'centerworkh' }, +} + +local function arrange(p, layout) + local t = p.tag or screen[p.screen].selected_tag + local wa = p.workarea + local cls = p.clients + + if #cls == 0 then + return + end + + local g = {} + + -- Main column, fixed width and height + local mwfact = t.master_width_factor + local mainhei = floor(wa.height * mwfact) + local mainwid = floor(wa.width * mwfact) + local slavewid = wa.width - mainwid + local slaveLwid = floor(slavewid / 2) + local slaveRwid = slavewid - slaveLwid + local slavehei = wa.height - mainhei + local slaveThei = floor(slavehei / 2) + local slaveBhei = slavehei - slaveThei + local nbrFirstSlaves = floor(#cls / 2) + local nbrSecondSlaves = floor((#cls - 1) / 2) + + local slaveFirstDim, slaveSecondDim = 0, 0 + + if layout.name == 'centerwork' then -- vertical + if nbrFirstSlaves > 0 then + slaveFirstDim = floor(wa.height / nbrFirstSlaves) + end + if nbrSecondSlaves > 0 then + slaveSecondDim = floor(wa.height / nbrSecondSlaves) + end + + g.height = wa.height + g.width = mainwid + + g.x = wa.x + slaveLwid + g.y = wa.y + else -- horizontal + if nbrFirstSlaves > 0 then + slaveFirstDim = floor(wa.width / nbrFirstSlaves) + end + if nbrSecondSlaves > 0 then + slaveSecondDim = floor(wa.width / nbrSecondSlaves) + end + + g.height = mainhei + g.width = wa.width + + g.x = wa.x + g.y = wa.y + slaveThei + end + + g.width = max(g.width, 1) + g.height = max(g.height, 1) + + p.geometries[cls[1]] = g + + -- Auxiliary clients + if #cls <= 1 then + return + end + for i = 2, #cls do + g = {} + local idxChecker, dimToAssign + + local rowIndex = floor(i / 2) + + if layout.name == 'centerwork' then + if i % 2 == 0 then -- left slave + g.x = wa.x + g.y = wa.y + (rowIndex - 1) * slaveFirstDim + g.width = slaveLwid + + idxChecker, dimToAssign = nbrFirstSlaves, slaveFirstDim + else -- right slave + g.x = wa.x + slaveLwid + mainwid + g.y = wa.y + (rowIndex - 1) * slaveSecondDim + g.width = slaveRwid + + idxChecker, dimToAssign = nbrSecondSlaves, slaveSecondDim + end + + -- if last slave in row, use remaining space for it + if rowIndex == idxChecker then + g.height = wa.y + wa.height - g.y + else + g.height = dimToAssign + end + else + if i % 2 == 0 then -- top slave + g.x = wa.x + (rowIndex - 1) * slaveFirstDim + g.y = wa.y + g.height = slaveThei + + idxChecker, dimToAssign = nbrFirstSlaves, slaveFirstDim + else -- bottom slave + g.x = wa.x + (rowIndex - 1) * slaveSecondDim + g.y = wa.y + slaveThei + mainhei + g.height = slaveBhei + + idxChecker, dimToAssign = nbrSecondSlaves, slaveSecondDim + end + + -- if last slave in row, use remaining space for it + if rowIndex == idxChecker then + g.width = wa.x + wa.width - g.x + else + g.width = dimToAssign + end + end + + g.width = max(g.width, 1) + g.height = max(g.height, 1) + + p.geometries[cls[i]] = g + end +end + +local function mouse_resize_handler(c, _, _, _, orientation) + local wa = c.screen.workarea + local mwfact = c.screen.selected_tag.master_width_factor + local g = c:geometry() + local offset = 0 + local cursor = 'cross' + + local corner_coords + + if orientation == 'vertical' then + if g.height + 15 >= wa.height then + offset = g.height * 0.5 + cursor = 'sb_h_double_arrow' + elseif g.y + g.height + 15 <= wa.y + wa.height then + offset = g.height + end + corner_coords = { x = wa.x + wa.width * (1 - mwfact) / 2, y = g.y + offset } + else + if g.width + 15 >= wa.width then + offset = g.width * 0.5 + cursor = 'sb_v_double_arrow' + elseif g.x + g.width + 15 <= wa.x + wa.width then + offset = g.width + end + corner_coords = { y = wa.y + wa.height * (1 - mwfact) / 2, x = g.x + offset } + end + + mouse.coords(corner_coords) + + local prev_coords = {} + + mousegrabber.run(function(m) + if not c.valid then + return false + end + for _, v in ipairs(m.buttons) do + if v then + prev_coords = { x = m.x, y = m.y } + local new_mwfact + if orientation == 'vertical' then + new_mwfact = 1 - (m.x - wa.x) / wa.width * 2 + else + new_mwfact = 1 - (m.y - wa.y) / wa.height * 2 + end + c.screen.selected_tag.master_width_factor = math.min(math.max(new_mwfact, 0.01), 0.99) + return true + end + end + return prev_coords.x == m.x and prev_coords.y == m.y + end, cursor) +end + +function centerwork.arrange(p) + return arrange(p, centerwork) +end + +function centerwork.horizontal.arrange(p) + return arrange(p, centerwork.horizontal) +end + +function centerwork.mouse_resize_handler(c, corner, x, y) + return mouse_resize_handler(c, corner, x, y, 'vertical') +end + +function centerwork.horizontal.mouse_resize_handler(c, corner, x, y) + return mouse_resize_handler(c, corner, x, y, 'horizontal') +end + +--[[ +Make focus.byidx and swap.byidx behave more consistently with other layouts. +--]] + +local awful = require('awful') +local gears = require('gears') +local client = client + +local function compare_position(a, b) + if a.x == b.x then + return a.y < b.y + else + return a.x < b.x + end +end + +local function clients_by_position() + local this = client.focus + if this then + local sorted = {} + for _, c in ipairs(client.focus.first_tag:clients()) do + if not c.minimized then + sorted[#sorted + 1] = c + end + end + table.sort(sorted, compare_position) + + local idx = 0 + for i, that in ipairs(sorted) do + if this.window == that.window then + idx = i + end + end + + if idx > 0 then + return { sorted = sorted, idx = idx } + end + end + return {} +end + +local function in_centerwork() + return client.focus and client.focus.first_tag.layout.name == 'centerwork' +end + +centerwork.focus = {} + +--[[ +Drop in replacements for awful.client.focus.byidx and awful.client.swap.byidx +that behaves consistently with other layouts. +--]] + +function centerwork.focus.byidx(i) + if in_centerwork() then + local cls = clients_by_position() + if cls.idx then + local target = cls.sorted[gears.math.cycle(#cls.sorted, cls.idx + i)] + awful.client.focus.byidx(0, target) + end + else + awful.client.focus.byidx(i) + end +end + +centerwork.swap = {} + +function centerwork.swap.byidx(i) + if in_centerwork() then + local cls = clients_by_position() + if cls.idx then + local target = cls.sorted[gears.math.cycle(#cls.sorted, cls.idx + i)] + client.focus:swap(target) + end + else + awful.client.swap.byidx(i) + end +end + +return centerwork diff --git a/lib/lain/layout/init.lua b/lib/lain/layout/init.lua new file mode 100644 index 0000000..cdcbad0 --- /dev/null +++ b/lib/lain/layout/init.lua @@ -0,0 +1,19 @@ +--[[ + + Lain + Layouts, widgets and utilities for Awesome WM + + Layouts section + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local wrequire = require('lain.helpers').wrequire +local setmetatable = setmetatable + +local layout = { _NAME = 'lain.layout' } + +return setmetatable(layout, { __index = wrequire }) diff --git a/lib/lain/layout/termfair.lua b/lib/lain/layout/termfair.lua new file mode 100644 index 0000000..f1fcbe2 --- /dev/null +++ b/lib/lain/layout/termfair.lua @@ -0,0 +1,312 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2014, projektile + * (c) 2013, Luca CPZ + * (c) 2010, Nicolas Estibals + * (c) 2010-2012, Peter Hofmann + +--]] + +local math = math +local screen = screen +local tonumber = tonumber + +local termfair = { name = 'termfair' } +termfair.center = { name = 'centerfair' } +termfair.stable = { name = 'stablefair' } + +local function do_fair(p, orientation) + local t = p.tag or screen[p.screen].selected_tag + local wa = p.workarea + local cls = p.clients + + if #cls == 0 then + return + end + + -- How many vertical columns? Read from nmaster on the tag. + local num_x = tonumber(termfair.nmaster) or t.master_count + local ncol = tonumber(termfair.ncol) or t.column_count + if num_x <= 2 then + num_x = 2 + end + if ncol <= 1 then + ncol = 1 + end + local width = math.floor(wa.width / num_x) + + if orientation == 'west' then + -- Layout with fixed number of vertical columns (read from nmaster). + -- New windows align from left to right. When a row is full, a new + -- one above it is created. Like this: + + -- (1) (2) (3) + -- +---+---+---+ +---+---+---+ +---+---+---+ + -- | | | | | | | | | | | | + -- | 1 | | | -> | 1 | 2 | | -> | 1 | 2 | 3 | -> + -- | | | | | | | | | | | | + -- +---+---+---+ +---+---+---+ +---+---+---+ + + -- (4) (5) (6) + -- +---+---+---+ +---+---+---+ +---+---+---+ + -- | 1 | | | | 1 | 2 | | | 1 | 2 | 3 | + -- +---+---+---+ -> +---+---+---+ -> +---+---+---+ + -- | 2 | 3 | 4 | | 3 | 4 | 5 | | 4 | 5 | 6 | + -- +---+---+---+ +---+---+---+ +---+---+---+ + + local num_y = math.max(math.ceil(#cls / num_x), ncol) + local height = math.floor(wa.height / num_y) + local cur_num_x = num_x + local at_x = 0 + local at_y = 0 + + local remaining_clients = #cls + + -- We start the first row. Left-align by limiting the number of + -- available slots. + if remaining_clients < num_x then + cur_num_x = remaining_clients + end + + -- Iterate in reversed order. + for i = #cls, 1, -1 do + -- Get x and y position. + local c = cls[i] + local this_x = cur_num_x - at_x - 1 + local this_y = num_y - at_y - 1 + + -- Calculate geometry. + local g = {} + if this_x == (num_x - 1) then + g.width = wa.width - (num_x - 1) * width + else + g.width = width + end + + if this_y == (num_y - 1) then + g.height = wa.height - (num_y - 1) * height + else + g.height = height + end + + g.x = wa.x + this_x * width + g.y = wa.y + this_y * height + + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + + p.geometries[c] = g + + remaining_clients = remaining_clients - 1 + + -- Next grid position. + at_x = at_x + 1 + if at_x == num_x then + -- Row full, create a new one above it. + at_x = 0 + at_y = at_y + 1 + + -- We start a new row. Left-align. + if remaining_clients < num_x then + cur_num_x = remaining_clients + end + end + end + elseif orientation == 'stable' then + -- Layout with fixed number of vertical columns (read from nmaster). + -- New windows align from left to right. When a row is full, a new + -- one below it is created. Like this: + + -- (1) (2) (3) + -- +---+---+---+ +---+---+---+ +---+---+---+ + -- | | | | | | | | | | | | + -- | 1 | | | -> | 1 | 2 | | -> | 1 | 2 | 3 | -> + -- | | | | | | | | | | | | + -- +---+---+---+ +---+---+---+ +---+---+---+ + + -- (4) (5) (6) + -- +---+---+---+ +---+---+---+ +---+---+---+ + -- | 1 | 2 | 3 | | 1 | 2 | 3 | | 1 | 2 | 3 | + -- +---+---+---+ +---+---+---+ +---+---+---+ + -- | 4 | | | | 4 | 5 | | | 4 | 5 | 6 | + -- +---+---+---+ -> +---+---+---+ -> +---+---+---+ + + local num_y = math.max(math.ceil(#cls / num_x), ncol) + local height = math.floor(wa.height / num_y) + + for i = #cls, 1, -1 do + -- Get x and y position. + local c = cls[i] + local this_x = (i - 1) % num_x + local this_y = math.floor((i - this_x - 1) / num_x) + + -- Calculate geometry. + local g = {} + if this_x == (num_x - 1) then + g.width = wa.width - (num_x - 1) * width + else + g.width = width + end + + if this_y == (num_y - 1) then + g.height = wa.height - (num_y - 1) * height + else + g.height = height + end + + g.x = wa.x + this_x * width + g.y = wa.y + this_y * height + + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + + p.geometries[c] = g + end + elseif orientation == 'center' then + -- Layout with fixed number of vertical columns (read from nmaster). + -- Cols are centerded until there is nmaster columns, then windows + -- are stacked in the slave columns, with at most ncol clients per + -- column if possible. + + -- with nmaster=3 and ncol=1 you'll have + -- (1) (2) (3) + -- +---+---+---+ +-+---+---+-+ +---+---+---+ + -- | | | | | | | | | | | | | + -- | | 1 | | -> | | 1 | 2 | | -> | 1 | 2 | 3 | -> + -- | | | | | | | | | | | | | + -- +---+---+---+ +-+---+---+-+ +---+---+---+ + + -- (4) (5) + -- +---+---+---+ +---+---+---+ + -- | | | 3 | | | 2 | 4 | + -- + 1 + 2 +---+ -> + 1 +---+---+ + -- | | | 4 | | | 3 | 5 | + -- +---+---+---+ +---+---+---+ + + if #cls < num_x then + -- Less clients than the number of columns, let's center it! + local offset_x = wa.x + (wa.width - #cls * width) / 2 + for i = 1, #cls do + local g = { y = wa.y } + g.width = width + g.height = wa.height + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + g.x = offset_x + (i - 1) * width + p.geometries[cls[i]] = g + end + else + -- More clients than the number of columns, let's arrange it! + -- Master client deserves a special treatement + local g = {} + g.width = wa.width - (num_x - 1) * width + g.height = wa.height + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + g.x = wa.x + g.y = wa.y + p.geometries[cls[1]] = g + + -- Treat the other clients + + -- Compute distribution of clients among columns + local num_y = {} + local remaining_clients = #cls - 1 + local ncol_min = math.ceil(remaining_clients / (num_x - 1)) + + if ncol >= ncol_min then + for i = (num_x - 1), 1, -1 do + if (remaining_clients - i + 1) < ncol then + num_y[i] = remaining_clients - i + 1 + else + num_y[i] = ncol + end + remaining_clients = remaining_clients - num_y[i] + end + else + local rem = remaining_clients % (num_x - 1) + if rem == 0 then + for i = 1, num_x - 1 do + num_y[i] = ncol_min + end + else + for i = 1, num_x - 1 do + num_y[i] = ncol_min - 1 + end + for i = 0, rem - 1 do + num_y[num_x - 1 - i] = num_y[num_x - 1 - i] + 1 + end + end + end + + -- Compute geometry of the other clients + local nclient = 2 -- we start with the 2nd client + local wx = g.x + g.width + for i = 1, (num_x - 1) do + local height = math.floor(wa.height / num_y[i]) + local wy = wa.y + for _ = 0, (num_y[i] - 2) do + g = {} + g.x = wx + g.y = wy + g.height = height + g.width = width + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + p.geometries[cls[nclient]] = g + nclient = nclient + 1 + wy = wy + height + end + g = {} + g.x = wx + g.y = wy + g.height = wa.height - (num_y[i] - 1) * height + g.width = width + if g.width < 1 then + g.width = 1 + end + if g.height < 1 then + g.height = 1 + end + p.geometries[cls[nclient]] = g + nclient = nclient + 1 + wx = wx + width + end + end + end +end + +function termfair.center.arrange(p) + return do_fair(p, 'center') +end + +function termfair.stable.arrange(p) + return do_fair(p, 'stable') +end + +function termfair.arrange(p) + return do_fair(p, 'west') +end + +return termfair diff --git a/lib/lain/util/dkjson.lua b/lib/lain/util/dkjson.lua new file mode 100644 index 0000000..0cd5c08 --- /dev/null +++ b/lib/lain/util/dkjson.lua @@ -0,0 +1,809 @@ +-- Module options: +local always_use_lpeg = false +local register_global_module_table = false +local global_module_name = 'json' + +--[==[ + +David Kolf's JSON module for Lua 5.1 - 5.4 + +Version 2.6 + + +For the documentation see the corresponding readme.txt or visit +. + +You can contact the author by sending an e-mail to 'david' at the +domain 'dkolf.de'. + + +Copyright (C) 2010-2021 David Heiko Kolf + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +--]==] + +-- global dependencies: +local pairs, type, tostring, tonumber, getmetatable, setmetatable = + pairs, type, tostring, tonumber, getmetatable, setmetatable +local error, require, pcall, select = error, require, pcall, select +local floor, huge = math.floor, math.huge +local strrep, gsub, strsub, strbyte, strchar, strfind, strlen, strformat = + string.rep, string.gsub, string.sub, string.byte, string.char, string.find, string.len, string.format +local strmatch = string.match +local concat = table.concat + +local json = { version = 'dkjson 2.6' } + +local jsonlpeg = {} + +if register_global_module_table then + if always_use_lpeg then + _G[global_module_name] = jsonlpeg + else + _G[global_module_name] = json + end +end + +_ENV = nil -- blocking globals in Lua 5.2 and later + +pcall(function() + -- Enable access to blocked metatables. + -- Don't worry, this module doesn't change anything in them. + local debmeta = require('debug').getmetatable + if debmeta then + getmetatable = debmeta + end +end) + +json.null = setmetatable({}, { + __tojson = function() + return 'null' + end, +}) + +local function isarray(tbl) + local max, n, arraylen = 0, 0, 0 + for k, v in pairs(tbl) do + if k == 'n' and type(v) == 'number' then + arraylen = v + if v > max then + max = v + end + else + if type(k) ~= 'number' or k < 1 or floor(k) ~= k then + return false + end + if k > max then + max = k + end + n = n + 1 + end + end + if max > 10 and max > arraylen and max > n * 2 then + return false -- don't create an array with too many holes + end + return true, max +end + +local escapecodes = { + ['"'] = '\\"', + ['\\'] = '\\\\', + ['\b'] = '\\b', + ['\f'] = '\\f', + ['\n'] = '\\n', + ['\r'] = '\\r', + ['\t'] = '\\t', +} + +local function escapeutf8(uchar) + local value = escapecodes[uchar] + if value then + return value + end + local a, b, c, d = strbyte(uchar, 1, 4) + a, b, c, d = a or 0, b or 0, c or 0, d or 0 + if a <= 0x7f then + value = a + elseif 0xc0 <= a and a <= 0xdf and b >= 0x80 then + value = (a - 0xc0) * 0x40 + b - 0x80 + elseif 0xe0 <= a and a <= 0xef and b >= 0x80 and c >= 0x80 then + value = ((a - 0xe0) * 0x40 + b - 0x80) * 0x40 + c - 0x80 + elseif 0xf0 <= a and a <= 0xf7 and b >= 0x80 and c >= 0x80 and d >= 0x80 then + value = (((a - 0xf0) * 0x40 + b - 0x80) * 0x40 + c - 0x80) * 0x40 + d - 0x80 + else + return '' + end + if value <= 0xffff then + return strformat('\\u%.4x', value) + elseif value <= 0x10ffff then + -- encode as UTF-16 surrogate pair + value = value - 0x10000 + local highsur, lowsur = 0xD800 + floor(value / 0x400), 0xDC00 + (value % 0x400) + return strformat('\\u%.4x\\u%.4x', highsur, lowsur) + else + return '' + end +end + +local function fsub(str, pattern, repl) + -- gsub always builds a new string in a buffer, even when no match + -- exists. First using find should be more efficient when most strings + -- don't contain the pattern. + if strfind(str, pattern) then + return gsub(str, pattern, repl) + else + return str + end +end + +local function quotestring(value) + -- based on the regexp "escapable" in https://github.com/douglascrockford/JSON-js + value = fsub(value, '[%z\1-\31"\\\127]', escapeutf8) + if strfind(value, '[\194\216\220\225\226\239]') then + value = fsub(value, '\194[\128-\159\173]', escapeutf8) + value = fsub(value, '\216[\128-\132]', escapeutf8) + value = fsub(value, '\220\143', escapeutf8) + value = fsub(value, '\225\158[\180\181]', escapeutf8) + value = fsub(value, '\226\128[\140-\143\168-\175]', escapeutf8) + value = fsub(value, '\226\129[\160-\175]', escapeutf8) + value = fsub(value, '\239\187\191', escapeutf8) + value = fsub(value, '\239\191[\176-\191]', escapeutf8) + end + return '"' .. value .. '"' +end +json.quotestring = quotestring + +local function replace(str, o, n) + local i, j = strfind(str, o, 1, true) + if i then + return strsub(str, 1, i - 1) .. n .. strsub(str, j + 1, -1) + else + return str + end +end + +-- locale independent num2str and str2num functions +local decpoint, numfilter + +local function updatedecpoint() + decpoint = strmatch(tostring(0.5), '([^05+])') + -- build a filter that can be used to remove group separators + numfilter = '[^0-9%-%+eE' .. gsub(decpoint, '[%^%$%(%)%%%.%[%]%*%+%-%?]', '%%%0') .. ']+' +end + +updatedecpoint() + +local function num2str(num) + return replace(fsub(tostring(num), numfilter, ''), decpoint, '.') +end + +local function str2num(str) + local num = tonumber(replace(str, '.', decpoint)) + if not num then + updatedecpoint() + num = tonumber(replace(str, '.', decpoint)) + end + return num +end + +local function addnewline2(level, buffer, buflen) + buffer[buflen + 1] = '\n' + buffer[buflen + 2] = strrep(' ', level) + buflen = buflen + 2 + return buflen +end + +function json.addnewline(state) + if state.indent then + state.bufferlen = addnewline2(state.level or 0, state.buffer, state.bufferlen or #state.buffer) + end +end + +local encode2 -- forward declaration + +local function addpair(key, value, prev, indent, level, buffer, buflen, tables, globalorder, state) + local kt = type(key) + if kt ~= 'string' and kt ~= 'number' then + return nil, "type '" .. kt .. "' is not supported as a key by JSON." + end + if prev then + buflen = buflen + 1 + buffer[buflen] = ',' + end + if indent then + buflen = addnewline2(level, buffer, buflen) + end + buffer[buflen + 1] = quotestring(key) + buffer[buflen + 2] = ':' + return encode2(value, indent, level, buffer, buflen + 2, tables, globalorder, state) +end + +local function appendcustom(res, buffer, state) + local buflen = state.bufferlen + if type(res) == 'string' then + buflen = buflen + 1 + buffer[buflen] = res + end + return buflen +end + +local function exception(reason, value, state, buffer, buflen, defaultmessage) + defaultmessage = defaultmessage or reason + local handler = state.exception + if not handler then + return nil, defaultmessage + else + state.bufferlen = buflen + local ret, msg = handler(reason, value, state, defaultmessage) + if not ret then + return nil, msg or defaultmessage + end + return appendcustom(ret, buffer, state) + end +end + +function json.encodeexception(_reason, _value, _state, defaultmessage) + return quotestring('<' .. defaultmessage .. '>') +end + +encode2 = function(value, indent, level, buffer, buflen, tables, globalorder, state) + local valtype = type(value) + local valmeta = getmetatable(value) + valmeta = type(valmeta) == 'table' and valmeta -- only tables + local valtojson = valmeta and valmeta.__tojson + if valtojson then + if tables[value] then + return exception('reference cycle', value, state, buffer, buflen) + end + tables[value] = true + state.bufferlen = buflen + local ret, msg = valtojson(value, state) + if not ret then + return exception('custom encoder failed', value, state, buffer, buflen, msg) + end + tables[value] = nil + buflen = appendcustom(ret, buffer, state) + elseif value == nil then + buflen = buflen + 1 + buffer[buflen] = 'null' + elseif valtype == 'number' then + local s + if value ~= value or value >= huge or -value >= huge then + -- This is the behaviour of the original JSON implementation. + s = 'null' + else + s = num2str(value) + end + buflen = buflen + 1 + buffer[buflen] = s + elseif valtype == 'boolean' then + buflen = buflen + 1 + buffer[buflen] = value and 'true' or 'false' + elseif valtype == 'string' then + buflen = buflen + 1 + buffer[buflen] = quotestring(value) + elseif valtype == 'table' then + if tables[value] then + return exception('reference cycle', value, state, buffer, buflen) + end + tables[value] = true + level = level + 1 + local isa, n = isarray(value) + if n == 0 and valmeta and valmeta.__jsontype == 'object' then + isa = false + end + local msg + if isa then -- JSON array + buflen = buflen + 1 + buffer[buflen] = '[' + for i = 1, n do + buflen, msg = encode2(value[i], indent, level, buffer, buflen, tables, globalorder, state) + if not buflen then + return nil, msg + end + if i < n then + buflen = buflen + 1 + buffer[buflen] = ',' + end + end + buflen = buflen + 1 + buffer[buflen] = ']' + else -- JSON object + local prev = false + buflen = buflen + 1 + buffer[buflen] = '{' + local order = valmeta and valmeta.__jsonorder or globalorder + if order then + local used = {} + n = #order + for i = 1, n do + local k = order[i] + local v = value[k] + if v ~= nil then + used[k] = true + buflen, _msg = addpair(k, v, prev, indent, level, buffer, buflen, tables, globalorder, state) + prev = true -- add a seperator before the next element + end + end + for k, v in pairs(value) do + if not used[k] then + buflen, msg = addpair(k, v, prev, indent, level, buffer, buflen, tables, globalorder, state) + if not buflen then + return nil, msg + end + prev = true -- add a seperator before the next element + end + end + else -- unordered + for k, v in pairs(value) do + buflen, msg = addpair(k, v, prev, indent, level, buffer, buflen, tables, globalorder, state) + if not buflen then + return nil, msg + end + prev = true -- add a seperator before the next element + end + end + if indent then + buflen = addnewline2(level - 1, buffer, buflen) + end + buflen = buflen + 1 + buffer[buflen] = '}' + end + tables[value] = nil + else + return exception( + 'unsupported type', + value, + state, + buffer, + buflen, + "type '" .. valtype .. "' is not supported by JSON." + ) + end + return buflen +end + +function json.encode(value, state) + state = state or {} + local oldbuffer = state.buffer + local buffer = oldbuffer or {} + state.buffer = buffer + updatedecpoint() + local ret, msg = encode2( + value, + state.indent, + state.level or 0, + buffer, + state.bufferlen or 0, + state.tables or {}, + state.keyorder, + state + ) + if not ret then + error(msg, 2) + elseif oldbuffer == buffer then + state.bufferlen = ret + return true + else + state.bufferlen = nil + state.buffer = nil + return concat(buffer) + end +end + +local function loc(str, where) + local line, pos, linepos = 1, 1, 0 + while true do + pos = strfind(str, '\n', pos, true) + if pos and pos < where then + line = line + 1 + linepos = pos + pos = pos + 1 + else + break + end + end + return 'line ' .. line .. ', column ' .. (where - linepos) +end + +local function unterminated(str, what, where) + return nil, strlen(str) + 1, 'unterminated ' .. what .. ' at ' .. loc(str, where) +end + +local function scanwhite(str, pos) + while true do + pos = strfind(str, '%S', pos) + if not pos then + return nil + end + local sub2 = strsub(str, pos, pos + 1) + if sub2 == '\239\187' and strsub(str, pos + 2, pos + 2) == '\191' then + -- UTF-8 Byte Order Mark + pos = pos + 3 + elseif sub2 == '//' then + pos = strfind(str, '[\n\r]', pos + 2) + if not pos then + return nil + end + elseif sub2 == '/*' then + pos = strfind(str, '*/', pos + 2) + if not pos then + return nil + end + pos = pos + 2 + else + return pos + end + end +end + +local escapechars = { + ['"'] = '"', + ['\\'] = '\\', + ['/'] = '/', + ['b'] = '\b', + ['f'] = '\f', + ['n'] = '\n', + ['r'] = '\r', + ['t'] = '\t', +} + +local function unichar(value) + if value < 0 then + return nil + elseif value <= 0x007f then + return strchar(value) + elseif value <= 0x07ff then + return strchar(0xc0 + floor(value / 0x40), 0x80 + (floor(value) % 0x40)) + elseif value <= 0xffff then + return strchar(0xe0 + floor(value / 0x1000), 0x80 + (floor(value / 0x40) % 0x40), 0x80 + (floor(value) % 0x40)) + elseif value <= 0x10ffff then + return strchar( + 0xf0 + floor(value / 0x40000), + 0x80 + (floor(value / 0x1000) % 0x40), + 0x80 + (floor(value / 0x40) % 0x40), + 0x80 + (floor(value) % 0x40) + ) + else + return nil + end +end + +local function scanstring(str, pos) + local lastpos = pos + 1 + local buffer, n = {}, 0 + while true do + local nextpos = strfind(str, '["\\]', lastpos) + if not nextpos then + return unterminated(str, 'string', pos) + end + if nextpos > lastpos then + n = n + 1 + buffer[n] = strsub(str, lastpos, nextpos - 1) + end + if strsub(str, nextpos, nextpos) == '"' then + lastpos = nextpos + 1 + break + else + local escchar = strsub(str, nextpos + 1, nextpos + 1) + local value + if escchar == 'u' then + value = tonumber(strsub(str, nextpos + 2, nextpos + 5), 16) + if value then + local value2 + if 0xD800 <= value and value <= 0xDBff then + -- we have the high surrogate of UTF-16. Check if there is a + -- low surrogate escaped nearby to combine them. + if strsub(str, nextpos + 6, nextpos + 7) == '\\u' then + value2 = tonumber(strsub(str, nextpos + 8, nextpos + 11), 16) + if value2 and 0xDC00 <= value2 and value2 <= 0xDFFF then + value = (value - 0xD800) * 0x400 + (value2 - 0xDC00) + 0x10000 + else + value2 = nil -- in case it was out of range for a low surrogate + end + end + end + value = value and unichar(value) + if value then + if value2 then + lastpos = nextpos + 12 + else + lastpos = nextpos + 6 + end + end + end + end + if not value then + value = escapechars[escchar] or escchar + lastpos = nextpos + 2 + end + n = n + 1 + buffer[n] = value + end + end + if n == 1 then + return buffer[1], lastpos + elseif n > 1 then + return concat(buffer), lastpos + else + return '', lastpos + end +end + +local scanvalue -- forward declaration + +local function scantable(what, closechar, str, startpos, nullval, objectmeta, arraymeta) + local tbl, n = {}, 0 + local pos = startpos + 1 + if what == 'object' then + setmetatable(tbl, objectmeta) + else + setmetatable(tbl, arraymeta) + end + while true do + pos = scanwhite(str, pos) + if not pos then + return unterminated(str, what, startpos) + end + local char = strsub(str, pos, pos) + if char == closechar then + return tbl, pos + 1 + end + local val1, err + val1, pos, err = scanvalue(str, pos, nullval, objectmeta, arraymeta) + if err then + return nil, pos, err + end + pos = scanwhite(str, pos) + if not pos then + return unterminated(str, what, startpos) + end + char = strsub(str, pos, pos) + if char == ':' then + if val1 == nil then + return nil, pos, 'cannot use nil as table index (at ' .. loc(str, pos) .. ')' + end + pos = scanwhite(str, pos + 1) + if not pos then + return unterminated(str, what, startpos) + end + local val2 + val2, pos, err = scanvalue(str, pos, nullval, objectmeta, arraymeta) + if err then + return nil, pos, err + end + tbl[val1] = val2 + pos = scanwhite(str, pos) + if not pos then + return unterminated(str, what, startpos) + end + char = strsub(str, pos, pos) + else + n = n + 1 + tbl[n] = val1 + end + if char == ',' then + pos = pos + 1 + end + end +end + +scanvalue = function(str, pos, nullval, objectmeta, arraymeta) + pos = pos or 1 + pos = scanwhite(str, pos) + if not pos then + return nil, strlen(str) + 1, 'no valid JSON value (reached the end)' + end + local char = strsub(str, pos, pos) + if char == '{' then + return scantable('object', '}', str, pos, nullval, objectmeta, arraymeta) + elseif char == '[' then + return scantable('array', ']', str, pos, nullval, objectmeta, arraymeta) + elseif char == '"' then + return scanstring(str, pos) + else + local pstart, pend = strfind(str, '^%-?[%d%.]+[eE]?[%+%-]?%d*', pos) + if pstart then + local number = str2num(strsub(str, pstart, pend)) + if number then + return number, pend + 1 + end + end + pstart, pend = strfind(str, '^%a%w*', pos) + if pstart then + local name = strsub(str, pstart, pend) + if name == 'true' then + return true, pend + 1 + elseif name == 'false' then + return false, pend + 1 + elseif name == 'null' then + return nullval, pend + 1 + end + end + return nil, pos, 'no valid JSON value at ' .. loc(str, pos) + end +end + +local function optionalmetatables(...) + if select('#', ...) > 0 then + return ... + else + return { __jsontype = 'object' }, { __jsontype = 'array' } + end +end + +function json.decode(str, pos, nullval, ...) + local objectmeta, arraymeta = optionalmetatables(...) + return scanvalue(str, pos, nullval, objectmeta, arraymeta) +end + +function json.use_lpeg() + local g = require('lpeg') + + if g.version() == '0.11' then + error('due to a bug in LPeg 0.11, it cannot be used for JSON matching') + end + + local pegmatch = g.match + local P, S, R = g.P, g.S, g.R + + local function ErrorCall(str, pos, msg, state) + if not state.msg then + state.msg = msg .. ' at ' .. loc(str, pos) + state.pos = pos + end + return false + end + + local function Err(msg) + return g.Cmt(g.Cc(msg) * g.Carg(2), ErrorCall) + end + + local function ErrorUnterminatedCall(str, pos, what, state) + return ErrorCall(str, pos - 1, 'unterminated ' .. what, state) + end + + local SingleLineComment = P('//') * (1 - S('\n\r')) ^ 0 + local MultiLineComment = P('/*') * (1 - P('*/')) ^ 0 * P('*/') + local Space = (S(' \n\r\t') + P('\239\187\191') + SingleLineComment + MultiLineComment) ^ 0 + + local function ErrUnterminated(what) + return g.Cmt(g.Cc(what) * g.Carg(2), ErrorUnterminatedCall) + end + + local PlainChar = 1 - S('"\\\n\r') + local EscapeSequence = (P('\\') * g.C(S('"\\/bfnrt') + Err('unsupported escape sequence'))) / escapechars + local HexDigit = R('09', 'af', 'AF') + local function UTF16Surrogate(_match, _pos, high, low) + high, low = tonumber(high, 16), tonumber(low, 16) + if 0xD800 <= high and high <= 0xDBff and 0xDC00 <= low and low <= 0xDFFF then + return true, unichar((high - 0xD800) * 0x400 + (low - 0xDC00) + 0x10000) + else + return false + end + end + local function UTF16BMP(hex) + return unichar(tonumber(hex, 16)) + end + local U16Sequence = (P('\\u') * g.C(HexDigit * HexDigit * HexDigit * HexDigit)) + local UnicodeEscape = g.Cmt(U16Sequence * U16Sequence, UTF16Surrogate) + U16Sequence / UTF16BMP + local Char = UnicodeEscape + EscapeSequence + PlainChar + local String = P('"') * (g.Cs(Char ^ 0) * P('"') + ErrUnterminated('string')) + local Integer = P('-') ^ -1 * (P('0') + (R('19') * R('09') ^ 0)) + local Fractal = P('.') * R('09') ^ 0 + local Exponent = (S('eE')) * (S('+-')) ^ -1 * R('09') ^ 1 + local Number = (Integer * Fractal ^ -1 * Exponent ^ -1) / str2num + local Constant = P('true') * g.Cc(true) + P('false') * g.Cc(false) + P('null') * g.Carg(1) + local SimpleValue = Number + String + Constant + local ArrayContent, ObjectContent + + -- The functions parsearray and parseobject parse only a single value/pair + -- at a time and store them directly to avoid hitting the LPeg limits. + local function parsearray(str, pos, nullval, state) + local obj, cont + local start = pos + local npos + local t, nt = {}, 0 + repeat + obj, cont, npos = pegmatch(ArrayContent, str, pos, nullval, state) + if cont == 'end' then + return ErrorUnterminatedCall(str, start, 'array', state) + end + pos = npos + if cont == 'cont' or cont == 'last' then + nt = nt + 1 + t[nt] = obj + end + until cont ~= 'cont' + return pos, setmetatable(t, state.arraymeta) + end + + local function parseobject(str, pos, nullval, state) + local obj, key, cont + local start = pos + local npos + local t = {} + repeat + key, obj, cont, npos = pegmatch(ObjectContent, str, pos, nullval, state) + if cont == 'end' then + return ErrorUnterminatedCall(str, start, 'object', state) + end + pos = npos + if cont == 'cont' or cont == 'last' then + t[key] = obj + end + until cont ~= 'cont' + return pos, setmetatable(t, state.objectmeta) + end + + local Array = P('[') * g.Cmt(g.Carg(1) * g.Carg(2), parsearray) + local Object = P('{') * g.Cmt(g.Carg(1) * g.Carg(2), parseobject) + local Value = Space * (Array + Object + SimpleValue) + local ExpectedValue = Value + Space * Err('value expected') + local ExpectedKey = String + Err('key expected') + local End = P(-1) * g.Cc('end') + local ErrInvalid = Err('invalid JSON') + ArrayContent = ( + Value * Space * (P(',') * g.Cc('cont') + P(']') * g.Cc('last') + End + ErrInvalid) + + g.Cc(nil) * (P(']') * g.Cc('empty') + End + ErrInvalid) + ) * g.Cp() + local Pair = g.Cg(Space * ExpectedKey * Space * (P(':') + Err('colon expected')) * ExpectedValue) + ObjectContent = ( + g.Cc(nil) * g.Cc(nil) * P('}') * g.Cc('empty') + + End + + (Pair * Space * (P(',') * g.Cc('cont') + P('}') * g.Cc('last') + End + ErrInvalid) + ErrInvalid) + ) * g.Cp() + local DecodeValue = ExpectedValue * g.Cp() + + jsonlpeg.version = json.version + jsonlpeg.encode = json.encode + jsonlpeg.null = json.null + jsonlpeg.quotestring = json.quotestring + jsonlpeg.addnewline = json.addnewline + jsonlpeg.encodeexception = json.encodeexception + jsonlpeg.using_lpeg = true + + function jsonlpeg.decode(str, pos, nullval, ...) + local state = {} + state.objectmeta, state.arraymeta = optionalmetatables(...) + local obj, retpos = pegmatch(DecodeValue, str, pos, nullval, state) + if state.msg then + return nil, state.pos, state.msg + else + return obj, retpos + end + end + + -- cache result of this function: + json.use_lpeg = function() + return jsonlpeg + end + jsonlpeg.use_lpeg = json.use_lpeg + + return jsonlpeg +end + +if always_use_lpeg then + return json.use_lpeg() +end + +return json diff --git a/lib/lain/util/init.lua b/lib/lain/util/init.lua new file mode 100644 index 0000000..accd219 --- /dev/null +++ b/lib/lain/util/init.lua @@ -0,0 +1,210 @@ +--[[ + + Lain + Layouts, widgets and utilities for Awesome WM + + Utilities section + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local awful = require('awful') +local sqrt = math.sqrt +local pairs = pairs +local client = client +local tonumber = tonumber +local wrequire = require('lain.helpers').wrequire +local setmetatable = setmetatable + +-- Lain utilities submodule +-- lain.util +local util = { _NAME = 'lain.util' } + +-- Like awful.menu.clients, but only show clients of currently selected tags +function util.menu_clients_current_tags(menu, args) + -- List of currently selected tags. + local cls_tags = awful.screen.focused().selected_tags + + if cls_tags == nil then + return nil + end + + -- Final list of menu items. + local cls_t = {} + + -- For each selected tag get all clients of that tag and add them to + -- the menu. A click on a menu item will raise that client. + for i = 1, #cls_tags do + local t = cls_tags[i] + local cls = t:clients() + + for _, c in pairs(cls) do + cls_t[#cls_t + 1] = { + awful.util.escape(c.name) or '', + function() + c.minimized = false + client.focus = c + c:raise() + end, + c.icon, + } + end + end + + -- No clients? Then quit. + if #cls_t <= 0 then + return nil + end + + -- menu may contain some predefined values, otherwise start with a + -- fresh menu. + if not menu then + menu = {} + end + + -- Set the list of items and show the menu. + menu.items = cls_t + local m = awful.menu(menu) + m:show(args) + + return m +end + +-- Magnify a client: set it to "float" and resize it. +function util.magnify_client(c, width_f, height_f) + if c and not c.floating then + util.magnified_client = c + util.mc(c, width_f, height_f) + else + util.magnified_client = nil + c.floating = false + end +end + +-- https://github.com/lcpz/lain/issues/195 +function util.mc(c, width_f, height_f) + c = c or util.magnified_client + if not c then + return + end + + c.floating = true + local s = awful.screen.focused() + local mg = s.workarea + local g = {} + local mwfact = width_f or s.selected_tag.master_width_factor or 0.5 + g.width = sqrt(mwfact) * mg.width + g.height = sqrt(height_f or mwfact) * mg.height + g.x = mg.x + (mg.width - g.width) / 2 + g.y = mg.y + (mg.height - g.height) / 2 + + if c then + c:geometry(g) + end -- if c is still a valid object +end + +-- Non-empty tag browsing +-- direction in {-1, 1} <-> {previous, next} non-empty tag +function util.tag_view_nonempty(direction, sc) + direction = direction or 1 + local s = sc or awful.screen.focused() + local tags = s.tags + local sel = s.selected_tag + + local i = sel.index + repeat + i = i + direction + + -- Wrap around when we reach one of the bounds + if i > #tags then + i = i - #tags + end + if i < 1 then + i = i + #tags + end + + local t = tags[i] + + -- Stop when we get back to where we started + if t == sel then + break + end + + -- If it's The One, view it. + if #t:clients() > 0 then + t:view_only() + return + end + until false +end + +-- {{{ Dynamic tagging + +-- Add a new tag +function util.add_tag(layout) + awful.prompt.run({ + prompt = 'New tag name: ', + textbox = awful.screen.focused().mypromptbox.widget, + exe_callback = function(name) + if not name or #name == 0 then + return + end + awful.tag + .add(name, { screen = awful.screen.focused(), layout = layout or awful.layout.suit.tile }) + :view_only() + end, + }) +end + +-- Rename current tag +function util.rename_tag() + awful.prompt.run({ + prompt = 'Rename tag: ', + textbox = awful.screen.focused().mypromptbox.widget, + exe_callback = function(new_name) + if not new_name or #new_name == 0 then + return + end + local t = awful.screen.focused().selected_tag + if t then + t.name = new_name + end + end, + }) +end + +-- Move current tag +-- pos in {-1, 1} <-> {previous, next} tag position +function util.move_tag(pos) + local tag = awful.screen.focused().selected_tag + if tonumber(pos) <= -1 then + awful.tag.move(tag.index - 1, tag) + else + awful.tag.move(tag.index + 1, tag) + end +end + +-- Delete current tag +-- Any rule set on the tag shall be broken +function util.delete_tag() + local t = awful.screen.focused().selected_tag + if not t then + return + end + t:delete() +end + +-- }}} + +-- On the fly useless gaps change +function util.useless_gaps_resize(thatmuch, s, t) + local scr = s or awful.screen.focused() + local tag = t or scr.selected_tag + tag.gap = tag.gap + tonumber(thatmuch) + awful.layout.arrange(scr) +end + +return setmetatable(util, { __index = wrequire }) diff --git a/lib/lain/util/markup.lua b/lib/lain/util/markup.lua new file mode 100644 index 0000000..831b83d --- /dev/null +++ b/lib/lain/util/markup.lua @@ -0,0 +1,92 @@ +--[[ + + Licensed under MIT License + * (c) 2013, Luca CPZ + * (c) 2009, Uli Schlachter + * (c) 2009, Majic + +--]] + +local format = string.format +local setmetatable = setmetatable + +-- Lain markup util submodule +-- lain.util.markup +local markup = { fg = {}, bg = {} } + +-- Convenience tags +function markup.bold(text) + return format('%s', text) +end +function markup.italic(text) + return format('%s', text) +end +function markup.strike(text) + return format('%s', text) +end +function markup.underline(text) + return format('%s', text) +end +function markup.monospace(text) + return format('%s', text) +end +function markup.big(text) + return format('%s', text) +end +function markup.small(text) + return format('%s', text) +end + +-- Set the font +function markup.font(font, text) + return format("%s", font, text) +end + +-- Set the foreground +function markup.fg.color(color, text) + return format("%s", color, text) +end + +-- Set the background +function markup.bg.color(color, text) + return format("%s", color, text) +end + +-- Set foreground and background +function markup.color(fg, bg, text) + return format("%s", fg, bg, text) +end + +-- Set font and foreground +function markup.fontfg(font, fg, text) + return format("%s", font, fg, text) +end + +-- Set font and background +function markup.fontbg(font, bg, text) + return format("%s", font, bg, text) +end + +-- Set font, foreground and background +function markup.fontcolor(font, fg, bg, text) + return format("%s", font, fg, bg, text) +end + +-- link markup.{fg,bg}(...) calls to markup.{fg,bg}.color(...) +setmetatable(markup.fg, { + __call = function(_, ...) + return markup.fg.color(...) + end, +}) +setmetatable(markup.bg, { + __call = function(_, ...) + return markup.bg.color(...) + end, +}) + +-- link markup(...) calls to markup.fg.color(...) +return setmetatable(markup, { + __call = function(_, ...) + return markup.fg.color(...) + end, +}) diff --git a/lib/lain/util/menu_iterator.lua b/lib/lain/util/menu_iterator.lua new file mode 100644 index 0000000..104544f --- /dev/null +++ b/lib/lain/util/menu_iterator.lua @@ -0,0 +1,151 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2017, Simon Désaulniers + * (c) 2017, Uli Schlachter + * (c) 2017, Jeferson Siqueira + +--]] + +-- Menu iterator with Naughty notifications +-- lain.util.menu_iterator + +local naughty = require('naughty') +local helpers = require('lain.helpers') +local atable = require('awful.util').table +local assert = assert +local pairs = pairs +local tconcat = table.concat +local unpack = unpack or table.unpack -- lua 5.1 retro-compatibility + +local state = { cid = nil } + +local function naughty_destroy_callback(reason) + 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 + -- don't try to call nil callbacks + if action then + action() + end + end + state.index = nil + end + end +end + +-- 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) + timeout = timeout or 4 -- default timeout for each menu entry + icon = icon or nil -- icon to display on the menu + + -- Build the list of choices + if not state.index then + state.menu = menu + state.index = 1 + end + + -- Select one and display the appropriate notification + local label + local next = state.menu[state.index] + state.index = state.index + 1 + + if not next then + label = 'Cancel' + state.index = nil + else + label, _ = unpack(next) + end + + state.cid = naughty.notify({ + text = label, + icon = icon, + timeout = timeout, + screen = mouse.screen, + replaces_id = state.cid, + destroy = naughty_destroy_callback, + }).id +end + +-- 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). +-- +-- Inputs: +-- * args: an array containing the following members: +-- * 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 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) + + for _, c in pairs(extra_choices) do + ch_combinations = atable.join(ch_combinations, { { c[1] } }) + end + + local m = {} -- the menu + + for _, c in pairs(ch_combinations) do + if #c > 0 then + local cbs = {} + + -- selected choices + for _, ch in pairs(c) do + 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 + 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 + + -- 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 + + m[#m + 1] = { name .. ': ' .. tconcat(c, ' + '), cbs } + end + end + + return m +end + +return { iterate = iterate, menu = menu } diff --git a/lib/lain/util/quake.lua b/lib/lain/util/quake.lua new file mode 100644 index 0000000..0fbd748 --- /dev/null +++ b/lib/lain/util/quake.lua @@ -0,0 +1,203 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2016, Luca CPZ + * (c) 2015, unknown + +--]] + +local awful = require('awful') +local capi = { client = client } +local math = math +local string = string +local pairs = pairs +local screen = screen +local setmetatable = setmetatable + +-- Quake-like Dropdown application spawn +local quake = {} + +-- If you have a rule like "awful.client.setslave" for your terminals, +-- ensure you use an exception for QuakeDD. Otherwise, you may +-- run into problems with focus. + +function quake:display() + 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) + 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 + local cmd = string.format('%s %s %s', self.app, string.format(self.argname, self.name), self.extra) + awful.spawn(cmd, { tag = self.screen.selected_tag }) + return + end + + -- Set geometry + client.floating = true + client.border_width = self.border + client.size_hints_honor = false + local maximized = client.maximized + local fullscreen = client.fullscreen + client:geometry(self.geometry[self.screen.index] or self:compute_size()) + + -- Set not sticky and on top + client.sticky = false + client.ontop = true + client.above = true + client.skip_taskbar = true + + -- Additional user settings + if self.settings then + self.settings(client) + end + + -- Toggle display + if self.visible then + client.hidden = false + client.maximized = self.maximized + client.fullscreen = self.fullscreen + client:raise() + self.last_tag = self.screen.selected_tag + client:tags({ self.screen.selected_tag }) + capi.client.focus = client + else + self.maximized = maximized + self.fullscreen = fullscreen + client.maximized = false + client.fullscreen = false + client.hidden = true + local ctags = client:tags() + for j, _ in pairs(ctags) do + ctags[j] = nil + end + client:tags(ctags) + end + + return client +end + +function quake:compute_size() + -- skip if we already have a geometry for this screen + if not self.geometry[self.screen.index] then + local geom + if not self.overlap then + geom = screen[self.screen.index].workarea + else + geom = screen[self.screen.index].geometry + end + local width, height = self.width, self.height + if width <= 1 then + width = math.floor(geom.width * width) - 2 * self.border + end + if height <= 1 then + height = math.floor(geom.height * height) + end + local x, y + if self.horiz == 'left' then + x = geom.x + elseif self.horiz == 'right' then + x = geom.width + geom.x - width + else + x = geom.x + (geom.width - width) / 2 + end + if self.vert == 'top' then + y = geom.y + elseif self.vert == 'bottom' then + y = geom.height + geom.y - height + else + y = geom.y + (geom.height - height) / 2 + end + self.geometry[self.screen.index] = { x = x, y = y, width = width, height = height } + end + return self.geometry[self.screen.index] +end + +function quake:toggle() + 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 + local c = self:display() + if c then + c:move_to_tag(current_tag) + end + else + self.visible = not self.visible + self:display() + end +end + +function quake.new(conf) + conf = conf 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.border = conf.border or 1 -- client border width + conf.visible = conf.visible or false -- initially not visible + conf.followtag = conf.followtag or false -- spawn on currently focused screen + conf.overlap = conf.overlap or false -- overlap wibox + conf.screen = conf.screen or awful.screen.focused() + conf.settings = conf.settings + + -- 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 + conf.geometry = {} -- internal use + + conf.maximized = false + conf.fullscreen = false + + local dropdown = setmetatable(conf, { __index = quake }) + + capi.client.connect_signal('manage', function(c) + if c.instance == dropdown.name and c.screen == dropdown.screen then + dropdown:display() + end + end) + capi.client.connect_signal('unmanage', function(c) + if c.instance == dropdown.name and c.screen == dropdown.screen then + dropdown.visible = false + end + end) + + return dropdown +end + +return setmetatable(quake, { + __call = function(_, ...) + return quake.new(...) + end, +}) diff --git a/lib/lain/util/separators.lua b/lib/lain/util/separators.lua new file mode 100644 index 0000000..9b5675b --- /dev/null +++ b/lib/lain/util/separators.lua @@ -0,0 +1,118 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2015, Luca CPZ + * (c) 2015, plotnikovanton + +--]] + +local wibox = require('wibox') +local gears = require('gears') +local beautiful = require('beautiful') + +-- Lain Cairo separators util submodule +-- lain.util.separators +local separators = { height = beautiful.separators_height or 0, width = beautiful.separators_width or 9 } + +-- [[ Arrow + +-- Right +function separators.arrow_right(col1, col2) + local widget = wibox.widget.base.make_widget() + widget.col1 = col1 + widget.col2 = col2 + + widget.fit = function(_, _, _) + return separators.width, separators.height + end + + widget.update = function(_, _) + widget.col1 = col1 + widget.col2 = col2 + widget:emit_signal('widget::redraw_needed') + end + + widget.draw = function(_, _, cr, width, height) + if widget.col2 ~= 'alpha' then + cr:set_source_rgba(gears.color.parse_color(widget.col2)) + cr:new_path() + cr:move_to(0, 0) + cr:line_to(width, height / 2) + cr:line_to(width, 0) + cr:close_path() + cr:fill() + + cr:new_path() + cr:move_to(0, height) + cr:line_to(width, height / 2) + cr:line_to(width, height) + cr:close_path() + cr:fill() + end + + if widget.col1 ~= 'alpha' then + cr:set_source_rgba(gears.color.parse_color(widget.col1)) + cr:new_path() + cr:move_to(0, 0) + cr:line_to(width, height / 2) + cr:line_to(0, height) + cr:close_path() + cr:fill() + end + end + + return widget +end + +-- Left +function separators.arrow_left(col1, col2) + local widget = wibox.widget.base.make_widget() + widget.col1 = col1 + widget.col2 = col2 + + widget.fit = function(_, _, _) + return separators.width, separators.height + end + + widget.update = function(c1, c2) + widget.col1 = c1 + widget.col2 = c2 + widget:emit_signal('widget::redraw_needed') + end + + widget.draw = function(_, _, cr, width, height) + if widget.col1 ~= 'alpha' then + cr:set_source_rgba(gears.color.parse_color(widget.col1)) + cr:new_path() + cr:move_to(width, 0) + cr:line_to(0, height / 2) + cr:line_to(0, 0) + cr:close_path() + cr:fill() + + cr:new_path() + cr:move_to(width, height) + cr:line_to(0, height / 2) + cr:line_to(0, height) + cr:close_path() + cr:fill() + end + + if widget.col2 ~= 'alpha' then + cr:new_path() + cr:move_to(width, 0) + cr:line_to(0, height / 2) + cr:line_to(width, height) + cr:close_path() + + cr:set_source_rgba(gears.color.parse_color(widget.col2)) + cr:fill() + end + end + + return widget +end + +-- ]] + +return separators diff --git a/lib/lain/widget/alsa.lua b/lib/lain/widget/alsa.lua new file mode 100644 index 0000000..d8fca56 --- /dev/null +++ b/lib/lain/widget/alsa.lua @@ -0,0 +1,57 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010, Adrian C. + +--]] + +local helpers = require('lain.helpers') +local shell = require('awful.util').shell +local wibox = require('wibox') +local string = string + +-- ALSA volume +-- lain.widget.alsa + +local function factory(args) + args = args or {} + local alsa = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 5 + local settings = args.settings or function() end + + alsa.cmd = args.cmd or 'amixer' + alsa.channel = args.channel or 'Master' + alsa.togglechannel = args.togglechannel + + local format_cmd = string.format('%s get %s', alsa.cmd, alsa.channel) + + if alsa.togglechannel then + format_cmd = { + shell, + '-c', + string.format('%s get %s; %s get %s', alsa.cmd, alsa.channel, alsa.cmd, alsa.togglechannel), + } + end + + alsa.last = {} + + function alsa.update() + helpers.async(format_cmd, function(mixer) + local l, s = string.match(mixer, '([%d]+)%%.*%[([%l]*)') + l = tonumber(l) + if alsa.last.level ~= l or alsa.last.status ~= s then + volume_now = { level = l, status = s } + widget = alsa.widget + settings() + alsa.last = volume_now + end + end) + end + + helpers.newtimer(string.format('alsa-%s-%s', alsa.cmd, alsa.channel), timeout, alsa.update) + + return alsa +end + +return factory diff --git a/lib/lain/widget/alsabar.lua b/lib/lain/widget/alsabar.lua new file mode 100644 index 0000000..fbbd3ab --- /dev/null +++ b/lib/lain/widget/alsabar.lua @@ -0,0 +1,172 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2013, Rman + +--]] + +local helpers = require('lain.helpers') +local awful = require('awful') +local naughty = require('naughty') +local wibox = require('wibox') +local math = math +local string = string +local type = type +local tonumber = tonumber + +-- ALSA volume bar +-- lain.widget.alsabar + +local function factory(args) + local alsabar = { + colors = { + background = '#000000', + mute = '#EB8F8F', + unmute = '#A4CE8A', + }, + + _current_level = 0, + _playback = 'off', + } + + args = args or {} + + local timeout = args.timeout or 5 + local settings = args.settings or function() end + local width = args.width or 63 + local height = args.height or 1 + local margins = args.margins or 1 + local ticks = args.ticks or false + local ticks_size = args.ticks_size or 7 + local tick = args.tick or '|' + local tick_pre = args.tick_pre or '[' + local tick_post = args.tick_post or ']' + local tick_none = args.tick_none or ' ' + + alsabar.cmd = args.cmd or 'amixer' + alsabar.channel = args.channel or 'Master' + alsabar.togglechannel = args.togglechannel + alsabar.colors = args.colors or alsabar.colors + alsabar.followtag = args.followtag or false + alsabar.notification_preset = args.notification_preset + + if not alsabar.notification_preset then + alsabar.notification_preset = { font = 'Monospace 10' } + end + + local format_cmd = string.format('%s get %s', alsabar.cmd, alsabar.channel) + + if alsabar.togglechannel then + format_cmd = { + awful.util.shell, + '-c', + string.format('%s get %s; %s get %s', alsabar.cmd, alsabar.channel, alsabar.cmd, alsabar.togglechannel), + } + end + + alsabar.bar = wibox.widget({ + color = alsabar.colors.unmute, + background_color = alsabar.colors.background, + forced_height = height, + forced_width = width, + margins = margins, + paddings = margins, + ticks = ticks, + ticks_size = ticks_size, + widget = wibox.widget.progressbar, + }) + + alsabar.tooltip = awful.tooltip({ objects = { alsabar.bar } }) + + function alsabar.update(callback) + helpers.async(format_cmd, function(mixer) + local vol, playback = string.match(mixer, '([%d]+)%%.*%[([%l]*)') + + if not vol or not playback then + return + end + + if vol ~= alsabar._current_level or playback ~= alsabar._playback then + alsabar._current_level = tonumber(vol) + alsabar.bar:set_value(alsabar._current_level / 100) + if alsabar._current_level == 0 or playback == 'off' then + alsabar._playback = playback + alsabar.tooltip:set_text('[Muted]') + alsabar.bar.color = alsabar.colors.mute + else + alsabar._playback = 'on' + alsabar.tooltip:set_text(string.format('%s: %s', alsabar.channel, vol)) + alsabar.bar.color = alsabar.colors.unmute + end + + volume_now = { + level = alsabar._current_level, + status = alsabar._playback, + } + + settings() + + if type(callback) == 'function' then + callback() + end + end + end) + end + + function alsabar.notify() + alsabar.update(function() + local preset = alsabar.notification_preset + + preset.title = string.format('%s - %s%%', alsabar.channel, alsabar._current_level) + + if alsabar._playback == 'off' then + preset.title = preset.title .. ' Muted' + end + + -- tot is the maximum number of ticks to display in the notification + local tot = alsabar.notification_preset.max_ticks + + if not tot then + local wib = awful.screen.focused().mywibox + -- if we can grab mywibox, tot is defined as its height if + -- horizontal, or width otherwise + if wib then + if wib.position == 'left' or wib.position == 'right' then + tot = wib.width + else + tot = wib.height + end + -- fallback: default horizontal wibox height + else + tot = 20 + end + end + + local int = math.modf((alsabar._current_level / 100) * tot) + preset.text = + string.format('%s%s%s%s', tick_pre, string.rep(tick, int), string.rep(tick_none, tot - int), tick_post) + + if alsabar.followtag then + preset.screen = awful.screen.focused() + end + + if not alsabar.notification then + alsabar.notification = naughty.notify({ + preset = preset, + destroy = function() + alsabar.notification = nil + end, + }) + else + naughty.replace_text(alsabar.notification, preset.title, preset.text) + end + end) + end + + helpers.newtimer(string.format('alsabar-%s-%s', alsabar.cmd, alsabar.channel), timeout, alsabar.update) + + return alsabar +end + +return factory diff --git a/lib/lain/widget/bat.lua b/lib/lain/widget/bat.lua new file mode 100644 index 0000000..bed1570 --- /dev/null +++ b/lib/lain/widget/bat.lua @@ -0,0 +1,237 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local helpers = require('lain.helpers') +local fs = require('gears.filesystem') +local naughty = require('naughty') +local wibox = require('wibox') +local math = math +local string = string +local ipairs = ipairs +local tonumber = tonumber + +-- Battery infos +-- lain.widget.bat + +local function factory(args) + local pspath = args.pspath or '/sys/class/power_supply/' + + if not fs.is_dir(pspath) then + naughty.notify({ text = 'lain.widget.bat: invalid power supply path', timeout = 0 }) + return + end + + args = args or {} + + local bat = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 30 + local notify = args.notify or 'on' + local full_notify = args.full_notify or notify + local n_perc = args.n_perc or { 5, 15 } + local batteries = args.batteries or (args.battery and { args.battery }) or {} + local ac = args.ac or 'AC0' + local settings = args.settings or function() end + + function bat.get_batteries() + helpers.line_callback('ls -1 ' .. pspath, function(line) + local bstr = string.match(line, 'BAT%w+') + if bstr then + batteries[#batteries + 1] = bstr + else + ac = string.match(line, 'A%w+') or ac + end + end) + end + + if #batteries == 0 then + bat.get_batteries() + end + + bat_notification_critical_preset = { + title = 'Battery exhausted', + text = 'Shutdown imminent', + timeout = 15, + fg = '#000000', + bg = '#FFFFFF', + } + + bat_notification_low_preset = { + title = 'Battery low', + text = 'Plug the cable!', + timeout = 15, + fg = '#202020', + bg = '#CDCDCD', + } + + bat_notification_charged_preset = { + title = 'Battery full', + text = 'You can unplug the cable', + timeout = 15, + fg = '#202020', + bg = '#CDCDCD', + } + + bat_now = { + status = 'N/A', + ac_status = 'N/A', + perc = 'N/A', + time = 'N/A', + watt = 'N/A', + capacity = 'N/A', + } + + bat_now.n_status = {} + bat_now.n_perc = {} + bat_now.n_capacity = {} + for i = 1, #batteries do + bat_now.n_status[i] = 'N/A' + bat_now.n_perc[i] = 0 + bat_now.n_capacity[i] = 0 + end + + -- used to notify full charge only once before discharging + local fullnotification = false + + function bat.update() + -- luacheck: globals bat_now + local sum_rate_current = 0 + local sum_rate_voltage = 0 + local sum_rate_power = 0 + local sum_rate_energy = 0 + local sum_energy_now = 0 + local sum_energy_full = 0 + local sum_charge_full = 0 + local sum_charge_design = 0 + + for i, battery in ipairs(batteries) do + local bstr = pspath .. battery + local present = helpers.first_line(bstr .. '/present') + + if tonumber(present) == 1 then + -- current_now(I)[uA], voltage_now(U)[uV], power_now(P)[uW] + local rate_current = tonumber(helpers.first_line(bstr .. '/current_now')) + local rate_voltage = tonumber(helpers.first_line(bstr .. '/voltage_now')) + local rate_power = tonumber(helpers.first_line(bstr .. '/power_now')) + local charge_full = tonumber(helpers.first_line(bstr .. '/charge_full')) + local charge_design = tonumber(helpers.first_line(bstr .. '/charge_full_design')) + + -- energy_now(P)[uWh], charge_now(I)[uAh] + local energy_now = + tonumber(helpers.first_line(bstr .. '/energy_now') or helpers.first_line(bstr .. '/charge_now')) + + -- energy_full(P)[uWh], charge_full(I)[uAh] + local energy_full = tonumber(helpers.first_line(bstr .. '/energy_full') or charge_full) + + local energy_percentage = tonumber(helpers.first_line(bstr .. '/capacity')) + or math.floor((energy_now / energy_full) * 100) + + bat_now.n_status[i] = helpers.first_line(bstr .. '/status') or 'N/A' + bat_now.n_perc[i] = energy_percentage or bat_now.n_perc[i] + + if not charge_design or charge_design == 0 then + bat_now.n_capacity[i] = 0 + else + bat_now.n_capacity[i] = math.floor((charge_full / charge_design) * 100) + end + + sum_rate_current = sum_rate_current + (rate_current or 0) + sum_rate_voltage = sum_rate_voltage + (rate_voltage or 0) + sum_rate_power = sum_rate_power + (rate_power or 0) + sum_rate_energy = sum_rate_energy + (rate_power or (((rate_voltage or 0) * (rate_current or 0)) / 1e6)) + sum_energy_now = sum_energy_now + (energy_now or 0) + sum_energy_full = sum_energy_full + (energy_full or 0) + sum_charge_full = sum_charge_full + (charge_full or 0) + sum_charge_design = sum_charge_design + (charge_design or 0) + end + end + + bat_now.capacity = math.floor(math.min(100, (sum_charge_full / sum_charge_design) * 100)) + + -- When one of the battery is charging, others' status are either + -- "Full", "Unknown" or "Charging". When the laptop is not plugged in, + -- one or more of the batteries may be full, but only one battery + -- discharging suffices to set global status to "Discharging". + bat_now.status = bat_now.n_status[1] or 'N/A' + for _, status in ipairs(bat_now.n_status) do + if status == 'Discharging' or status == 'Charging' then + bat_now.status = status + end + end + bat_now.ac_status = tonumber(helpers.first_line(string.format('%s%s/online', pspath, ac))) or 'N/A' + + if bat_now.status ~= 'N/A' then + if bat_now.status ~= 'Full' and sum_rate_power == 0 and bat_now.ac_status == 1 then + bat_now.perc = math.floor(math.min(100, (sum_energy_now / sum_energy_full) * 100)) + bat_now.time = '00:00' + bat_now.watt = 0 + + -- update {perc,time,watt} iff battery not full and rate > 0 + elseif bat_now.status ~= 'Full' then + local rate_time = 0 + -- Calculate time and watt if rates are greater then 0 + if sum_rate_power > 0 or sum_rate_current > 0 then + local div = (sum_rate_power > 0 and sum_rate_power) or sum_rate_current + + if bat_now.status == 'Charging' then + rate_time = (sum_energy_full - sum_energy_now) / div + else -- Discharging + rate_time = sum_energy_now / div + end + + if 0 < rate_time and rate_time < 0.01 then -- check for magnitude discrepancies (#199) + rate_time_magnitude = math.abs(math.floor(math.log10(rate_time))) + rate_time = rate_time * 10 ^ (rate_time_magnitude - 2) + end + end + + local hours = math.floor(rate_time) + local minutes = math.floor((rate_time - hours) * 60) + bat_now.perc = math.floor(math.min(100, (sum_energy_now / sum_energy_full) * 100)) + bat_now.time = string.format('%02d:%02d', hours, minutes) + bat_now.watt = tonumber(string.format('%.2f', sum_rate_energy / 1e6)) + elseif bat_now.status == 'Full' then + bat_now.perc = 100 + bat_now.time = '00:00' + bat_now.watt = 0 + end + end + + widget = bat.widget + settings() + + -- notifications for critical, low, and full levels + if notify == 'on' then + if bat_now.status == 'Discharging' then + if tonumber(bat_now.perc) <= n_perc[1] then + bat.id = naughty.notify({ + preset = bat_notification_critical_preset, + replaces_id = bat.id, + }).id + elseif tonumber(bat_now.perc) <= n_perc[2] then + bat.id = naughty.notify({ + preset = bat_notification_low_preset, + replaces_id = bat.id, + }).id + end + fullnotification = false + elseif bat_now.status == 'Full' and full_notify == 'on' and not fullnotification then + bat.id = naughty.notify({ + preset = bat_notification_charged_preset, + replaces_id = bat.id, + }).id + fullnotification = true + end + end + end + + helpers.newtimer('batteries', timeout, bat.update) + + return bat +end + +return factory diff --git a/lib/lain/widget/cal.lua b/lib/lain/widget/cal.lua new file mode 100644 index 0000000..cec8087 --- /dev/null +++ b/lib/lain/widget/cal.lua @@ -0,0 +1,226 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2018, Luca CPZ + +--]] + +local helpers = require('lain.helpers') +local markup = require('lain.util.markup') +local awful = require('awful') +local naughty = require('naughty') +local floor = math.floor +local os = os +local pairs = pairs +local string = string +local tconcat = table.concat +local type = type +local tonumber = tonumber +local tostring = tostring + +-- Calendar notification +-- lain.widget.cal + +local function factory(args) + args = args or {} + local cal = { + attach_to = args.attach_to or {}, + week_start = args.week_start or 2, + three = args.three or false, + followtag = args.followtag or false, + week_number = args.week_number or 'none', + week_number_format = args.week_number_format or args.week_number == 'left' and '%3d | ' or '| %-3d', + icons = args.icons or helpers.icons_dir .. 'cal/white/', + notification_preset = args.notification_preset or { + font = 'Monospace 10', + fg = '#FFFFFF', + bg = '#000000', + }, + } + + function cal.get_week_number(m, st_day, x) + local date = os.date('*t', m) + + local week_step = (x ~= 0 and floor((x + st_day) / 7) - 1 or 0) + + local display_time = os.time({ + year = date.year, + month = date.month, + day = date.day + 7 * week_step, + }) + + return string.format(cal.week_number_format, os.date('%V', display_time)) + end + + function cal.sum_week_days(x, y) + return (x + y) % 7 + end + + function cal.build(month, year) + local current_month, current_year = tonumber(os.date('%m')), tonumber(os.date('%Y')) + local is_current_month = (not month or not year) or (month == current_month and year == current_year) + local today = is_current_month and tonumber(os.date('%d')) -- otherwise nil and not highlighted + local t = os.time({ year = year or current_year, month = month and month + 1 or current_month + 1, day = 0 }) + local d = os.date('*t', t) + local mth_days, st_day, this_month = d.day, (d.wday - d.day - cal.week_start + 1) % 7, os.date('%B %Y', t) + local notifytable = { + [1] = string.format('%s%s\n', string.rep(' ', floor((28 - this_month:len()) / 2)), markup.bold(this_month)), + } + for day_num = 0, 6 do + notifytable[#notifytable + 1] = string.format( + '%3s ', + os.date('%a', os.time({ year = 2006, month = 1, day = day_num + cal.week_start })) + ) + end + notifytable[#notifytable] = + string.format('%s\n%s', notifytable[#notifytable]:sub(1, -2), string.rep(' ', st_day * 4)) + local strx + for x = 1, mth_days do + strx = x + if x == today then + if x < 10 then + x = ' ' .. x + end + strx = markup.bold(markup.color(cal.notification_preset.bg, cal.notification_preset.fg, x) .. ' ') + end + strx = string.format('%s%s', string.rep(' ', 3 - tostring(x):len()), strx) + notifytable[#notifytable + 1] = + string.format('%-4s%s', strx, (x + st_day) % 7 == 0 and x ~= mth_days and '\n' or '') + end + if string.len(cal.icons or '') > 0 and today then + cal.icon = cal.icons .. today .. '.png' + end + cal.month, cal.year = d.month, d.year + + if cal.week_number ~= 'none' then + local m = os.time({ year = year or current_year, month = month and month or current_month, day = 1 }) + local head_prepend = string.rep(' ', tostring(string.format(cal.week_number_format, 0)):len()) + + if cal.week_number == 'left' then + notifytable[1] = head_prepend .. notifytable[1] -- month-year row + notifytable[2] = head_prepend .. notifytable[2] -- weekdays row + notifytable[8] = notifytable[8]:gsub('\n', '\n' .. cal.get_week_number(m, st_day, 0)) -- first week of the month + + for x = 10, #notifytable do + if cal.sum_week_days(st_day, x) == 2 then + notifytable[x] = cal.get_week_number(m, st_day, x) .. notifytable[x] + end + end + elseif cal.week_number == 'right' then + notifytable[8] = notifytable[8]:gsub('\n', head_prepend .. '\n') -- weekdays row + for x = 9, #notifytable do + if cal.sum_week_days(st_day, x) == 1 then + notifytable[x] = notifytable[x]:gsub('\n', cal.get_week_number(m, st_day, x - 7) .. '\n') + end + end + -- last week of the month + local end_days = cal.sum_week_days(st_day, mth_days) + if end_days ~= 0 then + end_days = 7 - end_days + end + notifytable[#notifytable] = notifytable[#notifytable] + .. string.rep(' ', 4 * end_days) + .. cal.get_week_number(m, st_day, mth_days + end_days) + end + end + + return notifytable + end + + function cal.getdate(month, year, offset) + if not month or not year then + month = tonumber(os.date('%m')) + year = tonumber(os.date('%Y')) + end + + month = month + offset + + while month > 12 do + month = month - 12 + year = year + 1 + end + + while month < 1 do + month = month + 12 + year = year - 1 + end + + return month, year + end + + function cal.hide() + if not cal.notification then + return + end + naughty.destroy(cal.notification) + cal.notification = nil + end + + function cal.show(seconds, month, year, scr) + local text = tconcat(cal.build(month, year)) + + if cal.three then + local current_month, current_year = cal.month, cal.year + local prev_month, prev_year = cal.getdate(cal.month, cal.year, -1) + local next_month, next_year = cal.getdate(cal.month, cal.year, 1) + text = string.format( + '%s\n\n%s\n\n%s', + tconcat(cal.build(prev_month, prev_year)), + text, + tconcat(cal.build(next_month, next_year)) + ) + cal.month, cal.year = current_month, current_year + end + + if cal.notification then + local title = cal.notification_preset.title or nil + naughty.replace_text(cal.notification, title, text) + return + end + + cal.notification = naughty.notify({ + preset = cal.notification_preset, + screen = cal.followtag and awful.screen.focused() or scr or 1, + --icon = cal.icon, + timeout = type(seconds) == 'number' and seconds or cal.notification_preset.timeout or 5, + text = text, + }) + end + + function cal.hover_on() + cal.show(0) + end + function cal.move(offset) + offset = offset or 0 + cal.month, cal.year = cal.getdate(cal.month, cal.year, offset) + cal.show(0, cal.month, cal.year) + end + function cal.prev() + cal.move(-1) + end + function cal.next() + cal.move(1) + end + + function cal.attach(widget) + widget:connect_signal('mouse::enter', cal.hover_on) + widget:connect_signal('mouse::leave', cal.hide) + widget:buttons( + awful.util.table.join( + awful.button({}, 1, cal.prev), + awful.button({}, 3, cal.next), + awful.button({}, 2, cal.hover_on), + awful.button({}, 5, cal.prev), + awful.button({}, 4, cal.next) + ) + ) + end + + for _, widget in pairs(cal.attach_to) do + cal.attach(widget) + end + + return cal +end + +return factory diff --git a/lib/lain/widget/contrib/init.lua b/lib/lain/widget/contrib/init.lua new file mode 100644 index 0000000..f245ac1 --- /dev/null +++ b/lib/lain/widget/contrib/init.lua @@ -0,0 +1,18 @@ +--[[ + + Lain + Layouts, widgets and utilities for Awesome WM + + Users contributed widgets section + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +local wrequire = require('lain.helpers').wrequire +local setmetatable = setmetatable + +local widget = { _NAME = 'lain.widget.contrib' } + +return setmetatable(widget, { __index = wrequire }) diff --git a/lib/lain/widget/contrib/moc.lua b/lib/lain/widget/contrib/moc.lua new file mode 100644 index 0000000..682b0fe --- /dev/null +++ b/lib/lain/widget/contrib/moc.lua @@ -0,0 +1,107 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2014, anticlockwise + +--]] + +local helpers = require('lain.helpers') +local shell = require('awful.util').shell +local focused = require('awful.screen').focused +local escape_f = require('awful.util').escape +local naughty = require('naughty') +local wibox = require('wibox') +local os = os +local string = string + +-- MOC audio player +-- lain.widget.contrib.moc + +local function factory(args) + args = args or {} + + local moc = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 2 + local music_dir = args.music_dir or os.getenv('HOME') .. '/Music' + local cover_pattern = args.cover_pattern or '*\\.(jpg|jpeg|png|gif)$' + local cover_size = args.cover_size or 100 + local default_art = args.default_art or '' + local followtag = args.followtag or false + local settings = args.settings or function() end + + moc_notification_preset = { title = 'Now playing', timeout = 6 } + + helpers.set_map('current moc track', nil) + + function moc.update() + helpers.async('mocp -i', function(f) + moc_now = { + state = 'N/A', + file = 'N/A', + artist = 'N/A', + title = 'N/A', + album = 'N/A', + elapsed = 'N/A', + total = 'N/A', + } + + for line in string.gmatch(f, '[^\n]+') do + for k, v in string.gmatch(line, '([%w]+):[%s](.*)$') do + if k == 'State' then + moc_now.state = v + elseif k == 'File' then + moc_now.file = v + elseif k == 'Artist' then + moc_now.artist = escape_f(v) + elseif k == 'SongTitle' then + moc_now.title = escape_f(v) + elseif k == 'Album' then + moc_now.album = escape_f(v) + elseif k == 'CurrentTime' then + moc_now.elapsed = escape_f(v) + elseif k == 'TotalTime' then + moc_now.total = escape_f(v) + end + end + end + + moc_notification_preset.text = + string.format('%s (%s) - %s\n%s', moc_now.artist, moc_now.album, moc_now.total, moc_now.title) + widget = moc.widget + settings() + + if moc_now.state == 'PLAY' then + if moc_now.title ~= helpers.get_map('current moc track') then + helpers.set_map('current moc track', moc_now.title) + + if followtag then + moc_notification_preset.screen = focused() + end + + local common = { + preset = moc_notification_preset, + icon = default_art, + icon_size = cover_size, + replaces_id = moc.id, + } + + local path = string.format('%s/%s', music_dir, string.match(moc_now.file, '.*/')) + local cover = + string.format("find '%s' -maxdepth 1 -type f | egrep -i -m1 '%s'", path, cover_pattern) + helpers.async({ shell, '-c', cover }, function(current_icon) + common.icon = current_icon:gsub('\n', '') + moc.id = naughty.notify(common).id + end) + end + elseif moc_now.state ~= 'PAUSE' then + helpers.set_map('current moc track', nil) + end + end) + end + + moc.timer = helpers.newtimer('moc', timeout, moc.update, true, true) + + return moc +end + +return factory diff --git a/lib/lain/widget/contrib/redshift.lua b/lib/lain/widget/contrib/redshift.lua new file mode 100644 index 0000000..0d9f278 --- /dev/null +++ b/lib/lain/widget/contrib/redshift.lua @@ -0,0 +1,58 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2017, Luca CPZ + * (c) 2014, blueluke + +--]] + +local async = require('lain.helpers').async +local awful = require('awful') +local execute = os.execute +local type = type + +-- Redshift +-- lain.widget.contrib.redshift +local redshift = { active = false, pid = nil } + +function redshift.start() + execute('pkill redshift') + awful.spawn.with_shell('redshift -x') -- clear adjustments + redshift.pid = awful.spawn.with_shell('redshift') + redshift.active = true + if type(redshift.update_fun) == 'function' then + redshift.update_fun(redshift.active) + end +end + +function redshift.toggle() + async({ awful.util.shell, '-c', string.format('ps -p %d -o pid=', redshift.pid) }, function(f) + if f and #f > 0 then -- redshift is running + -- Sending -USR1 toggles redshift (See project website) + execute('pkill -USR1 redshift') + redshift.active = not redshift.active + else -- not started or killed, (re)start it + redshift.start() + end + redshift.update_fun(redshift.active) + end) +end + +-- Attach to a widget +-- Provides a button which toggles redshift on/off on click +-- @param widget: Widget to attach to. +-- @param fun: Function to be run each time redshift is toggled (optional). +-- Use it to update widget text or icons on status change. +function redshift.attach(widget, fun) + redshift.update_fun = fun or function() end + if not redshift.pid then + redshift.start() + end + if widget then + widget:buttons(awful.util.table.join(awful.button({}, 1, function() + redshift.toggle() + end))) + end +end + +return redshift diff --git a/lib/lain/widget/contrib/task.lua b/lib/lain/widget/contrib/task.lua new file mode 100644 index 0000000..bb30726 --- /dev/null +++ b/lib/lain/widget/contrib/task.lua @@ -0,0 +1,96 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Jan Xie + +--]] + +local helpers = require('lain.helpers') +local markup = require('lain.util').markup +local awful = require('awful') +local naughty = require('naughty') +local mouse = mouse + +-- Taskwarrior notification +-- lain.widget.contrib.task +local task = {} + +function task.hide() + if not task.notification then + return + end + naughty.destroy(task.notification) + task.notification = nil +end + +function task.show(scr) + task.notification_preset.screen = task.followtag and awful.screen.focused() or scr or 1 + + helpers.async({ awful.util.shell, '-c', task.show_cmd }, function(f) + local widget_focused = true + + if mouse.current_widgets then + widget_focused = false + for _, v in ipairs(mouse.current_widgets) do + if task.widget == v then + widget_focused = true + break + end + end + end + + if widget_focused then + task.hide() + task.notification = naughty.notify({ + preset = task.notification_preset, + title = 'task next', + text = markup.font(task.notification_preset.font, awful.util.escape(f:gsub('\n*$', ''))), + }) + end + end) +end + +function task.prompt() + awful.prompt.run({ + prompt = task.prompt_text, + textbox = awful.screen.focused().mypromptbox.widget, + exe_callback = function(t) + helpers.async(t, function(f) + naughty.notify({ + preset = task.notification_preset, + title = t, + text = markup.font(task.notification_preset.font, awful.util.escape(f:gsub('\n*$', ''))), + }) + end) + end, + history_path = awful.util.getdir('cache') .. '/history_task', + }) +end + +function task.attach(widget, args) + args = args or {} + + task.show_cmd = args.show_cmd or 'task next' + task.prompt_text = args.prompt_text or 'Enter task command: ' + task.followtag = args.followtag or false + task.notification_preset = args.notification_preset + task.widget = widget + + if not task.notification_preset then + task.notification_preset = { + font = 'Monospace 10', + icon = helpers.icons_dir .. '/taskwarrior.png', + } + end + + if widget then + widget:connect_signal('mouse::enter', function() + task.show() + end) + widget:connect_signal('mouse::leave', function() + task.hide() + end) + end +end + +return task diff --git a/lib/lain/widget/contrib/tp_smapi.lua b/lib/lain/widget/contrib/tp_smapi.lua new file mode 100644 index 0000000..5dbf4ad --- /dev/null +++ b/lib/lain/widget/contrib/tp_smapi.lua @@ -0,0 +1,164 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2018, Luca CPZ + * (c) 2013, Conor Heine + +--]] + +local helpers = require('lain.helpers') +local focused = require('awful.screen').focused +local naughty = require('naughty') +local wibox = require('wibox') +local string = string +local type = type + +-- ThinkPad battery infos and widget creator +-- http://www.thinkwiki.org/wiki/Tp_smapi +-- lain.widget.contrib.tp_smapi + +local function factory(apipath) + local tp_smapi = { + path = apipath or '/sys/devices/platform/smapi', + } + + function tp_smapi.get(batid, feature) + return helpers.first_line(string.format('%s/%s/%s', tp_smapi.path, batid or 'BAT0', feature or '')) + end + + function tp_smapi.installed(batid) + return tp_smapi.get(batid, 'installed') == '1' + end + + function tp_smapi.status(batid) + return tp_smapi.get(batid, 'state') + end + + function tp_smapi.percentage(batid) + return tp_smapi.get(batid, 'remaining_percent') + end + + -- either running or charging time + function tp_smapi.time(batid) + local status = tp_smapi.status(batid) + local mins_left = tp_smapi.get( + batid, + string.match(string.lower(status), 'discharging') and 'remaining_running_time' or 'remaining_charging_time' + ) + if not string.find(mins_left, '^%d+') then + return 'N/A' + end + return string.format('%02d:%02d', math.floor(mins_left / 60), mins_left % 60) -- HH:mm + end + + function tp_smapi.hide() + if not tp_smapi.notification then + return + end + naughty.destroy(tp_smapi.notification) + tp_smapi.notification = nil + end + + function tp_smapi.show(batid, seconds, scr) + if not tp_smapi.installed(batid) then + return + end + + local mfgr = tp_smapi.get(batid, 'manufacturer') or 'no_mfgr' + local model = tp_smapi.get(batid, 'model') or 'no_model' + local chem = tp_smapi.get(batid, 'chemistry') or 'no_chem' + local status = tp_smapi.get(batid, 'state') + local time = tp_smapi.time(batid) + local msg + + if status and status ~= 'idle' then + msg = string.format( + '[%s] %s %s', + status, + time ~= 'N/A' and time or 'unknown remaining time', + string.lower(status):gsub(' ', ''):gsub('\n', '') == 'charging' and ' until charged' or ' remaining' + ) + else + msg = 'On AC power' + end + + tp_smapi.hide() + tp_smapi.notification = naughty.notify({ + title = string.format('%s: %s %s (%s)', batid, mfgr, model, chem), + text = msg, + timeout = type(seconds) == 'number' and seconds or 0, + screen = scr or focused(), + }) + end + + function tp_smapi.create_widget(args) + args = args or {} + + local pspath = args.pspath or '/sys/class/power_supply/' + local batteries = args.batteries or (args.battery and { args.battery }) or {} + local timeout = args.timeout or 30 + local settings = args.settings or function() end + + if #batteries == 0 then + helpers.line_callback('ls -1 ' .. pspath, function(line) + local bstr = string.match(line, 'BAT%w+') + if bstr then + batteries[#batteries + 1] = bstr + end + end) + end + + local all_batteries_installed = true + + for _, battery in ipairs(batteries) do + if not tp_smapi.installed(battery) then + naughty.notify({ + preset = naughty.config.critical, + title = 'tp_smapi: error while creating widget', + text = string.format('battery %s is not installed', battery), + }) + all_batteries_installed = false + break + end + end + + if not all_batteries_installed then + return + end + + tpbat = { + batteries = batteries, + widget = args.widget or wibox.widget.textbox(), + } + + function tpbat.update() + tpbat_now = { + n_status = {}, + n_perc = {}, + n_time = {}, + status = 'N/A', + } + + for i = 1, #batteries do + tpbat_now.n_status[i] = tp_smapi.status(batteries[i]) or 'N/A' + tpbat_now.n_perc[i] = tp_smapi.percentage(batteries[i]) + tpbat_now.n_time[i] = tp_smapi.time(batteries[i]) or 'N/A' + + if not tpbat_now.n_status[i]:lower():match('full') then + tpbat_now.status = tpbat_now.n_status[i] + end + end + + widget = tpbat.widget -- backwards compatibility + settings() + end + + helpers.newtimer('thinkpad-batteries', timeout, tpbat.update) + + return tpbat + end + + return tp_smapi +end + +return factory diff --git a/lib/lain/widget/cpu.lua b/lib/lain/widget/cpu.lua new file mode 100644 index 0000000..7f590cd --- /dev/null +++ b/lib/lain/widget/cpu.lua @@ -0,0 +1,74 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local helpers = require('lain.helpers') +local wibox = require('wibox') +local math = math +local string = string + +-- CPU usage +-- lain.widget.cpu + +local function factory(args) + args = args or {} + + local cpu = { core = {}, widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 2 + local settings = args.settings or function() end + + function cpu.update() + -- Read the amount of time the CPUs have spent performing + -- different kinds of work. Read the first line of /proc/stat + -- which is the sum of all CPUs. + for index, time in pairs(helpers.lines_match('cpu', '/proc/stat')) do + local coreid = index - 1 + local core = cpu.core[coreid] or { last_active = 0, last_total = 0, usage = 0 } + local at = 1 + local idle = 0 + local total = 0 + + for field in string.gmatch(time, '[%s]+([^%s]+)') do + -- 4 = idle, 5 = ioWait. Essentially, the CPUs have done + -- nothing during these times. + if at == 4 or at == 5 then + idle = idle + field + end + total = total + field + at = at + 1 + end + + local active = total - idle + + if core.last_active ~= active or core.last_total ~= total then + -- Read current data and calculate relative values. + local dactive = active - core.last_active + local dtotal = total - core.last_total + local usage = math.ceil(math.abs((dactive / dtotal) * 100)) + + core.last_active = active + core.last_total = total + core.usage = usage + + -- Save current data for the next run. + cpu.core[coreid] = core + end + end + + cpu_now = cpu.core + cpu_now.usage = cpu_now[0].usage + widget = cpu.widget + + settings() + end + + helpers.newtimer('cpu', timeout, cpu.update) + + return cpu +end + +return factory diff --git a/lib/lain/widget/fs.lua b/lib/lain/widget/fs.lua new file mode 100644 index 0000000..10e830f --- /dev/null +++ b/lib/lain/widget/fs.lua @@ -0,0 +1,174 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2018, Uli Schlacter + * (c) 2018, Otto Modinos + * (c) 2013, Luca CPZ + +--]] + +local helpers = require('lain.helpers') +local Gio = require('lgi').Gio +local focused = require('awful.screen').focused +local wibox = require('wibox') +local naughty = require('naughty') +local gears = require('gears') +local math = math +local string = string +local tconcat = table.concat +local type = type +local query_size = Gio.FILE_ATTRIBUTE_FILESYSTEM_SIZE +local query_free = Gio.FILE_ATTRIBUTE_FILESYSTEM_FREE +local query_used = Gio.FILE_ATTRIBUTE_FILESYSTEM_USED +local query = query_size .. ',' .. query_free .. ',' .. query_used + +-- File systems info +-- lain.widget.fs + +local function factory(args) + args = args or {} + + local fs = { + widget = args.widget or wibox.widget.textbox(), + units = { + [1] = 'Kb', + [2] = 'Mb', + [3] = 'Gb', + [4] = 'Tb', + [5] = 'Pb', + [6] = 'Eb', + [7] = 'Zb', + [8] = 'Yb', + }, + } + + function fs.hide() + if not fs.notification then + return + end + naughty.destroy(fs.notification) + fs.notification = nil + end + + function fs.show(seconds, scr) + fs.hide() + fs.update(function() + fs.notification_preset.screen = fs.followtag and focused() or scr or 1 + fs.notification = naughty.notify({ + preset = fs.notification_preset, + timeout = type(seconds) == 'number' and seconds or 5, + }) + end) + end + + local timeout = args.timeout or 600 + local partition = args.partition + local threshold = args.threshold or 99 + local showpopup = args.showpopup or 'on' + local settings = args.settings or function() end + + fs.followtag = args.followtag or false + fs.notification_preset = args.notification_preset + + if not fs.notification_preset then + fs.notification_preset = { + font = 'Monospace 10', + fg = '#FFFFFF', + bg = '#000000', + } + end + + local function update_synced() + local pathlen = 10 + fs_now = {} + + local notifypaths = {} + for _, mount in ipairs(Gio.unix_mounts_get()) do + local path = Gio.unix_mount_get_mount_path(mount) + local root = Gio.File.new_for_path(path) + local info = root:query_filesystem_info(query) + + if info then + local size = info:get_attribute_uint64(query_size) + local used = info:get_attribute_uint64(query_used) + local free = info:get_attribute_uint64(query_free) + + if size > 0 then + local units = math.floor(math.log(size) / math.log(1024)) + + fs_now[path] = { + units = fs.units[units], + percentage = math.floor(100 * used / size), -- used percentage + size = size / math.pow(1024, units), + used = used / math.pow(1024, units), + free = free / math.pow(1024, units), + } + + if fs_now[path].percentage > 0 then -- don't notify unused file systems + notifypaths[#notifypaths + 1] = path + + if #path > pathlen then + pathlen = #path + end + end + end + end + end + + widget = fs.widget + settings() + + if partition and fs_now[partition] and fs_now[partition].percentage >= threshold then + if not helpers.get_map(partition) then + naughty.notify({ + preset = naughty.config.presets.critical, + title = 'Warning', + text = string.format('%s is above %d%% (%d%%)', partition, threshold, fs_now[partition].percentage), + }) + helpers.set_map(partition, true) + else + helpers.set_map(partition, false) + end + end + + local fmt = '%-' .. tostring(pathlen) .. 's %4s\t%6s\t%6s\n' + local notifytable = { [1] = string.format(fmt, 'path', 'used', 'free', 'size') } + fmt = '\n%-' .. tostring(pathlen) .. 's %3s%%\t%6.2f\t%6.2f %s' + for _, path in ipairs(notifypaths) do + notifytable[#notifytable + 1] = string.format( + fmt, + path, + fs_now[path].percentage, + fs_now[path].free, + fs_now[path].size, + fs_now[path].units + ) + end + + fs.notification_preset.text = tconcat(notifytable) + end + + function fs.update(callback) + Gio.Async.start(gears.protected_call.call)(function() + update_synced() + if type(callback) == 'function' and callback then + callback() + end + end) + end + + if showpopup == 'on' then + fs.widget:connect_signal('mouse::enter', function() + fs.show(0) + end) + fs.widget:connect_signal('mouse::leave', function() + fs.hide() + end) + end + + helpers.newtimer(partition or 'fs', timeout, fs.update) + + return fs +end + +return factory diff --git a/lib/lain/widget/imap.lua b/lib/lain/widget/imap.lua new file mode 100644 index 0000000..59aafc6 --- /dev/null +++ b/lib/lain/widget/imap.lua @@ -0,0 +1,115 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +local helpers = require('lain.helpers') +local naughty = require('naughty') +local wibox = require('wibox') +local awful = require('awful') +local string = string +local type = type +local tonumber = tonumber + +-- Mail IMAP check +-- lain.widget.imap + +local function factory(args) + args = args or {} + + local imap = { widget = args.widget or wibox.widget.textbox() } + local server = args.server + local mail = args.mail + local password = args.password + local port = args.port or 993 + local timeout = args.timeout or 60 + local pwdtimeout = args.pwdtimeout or 10 + local is_plain = args.is_plain or false + local followtag = args.followtag or false + local notify = args.notify or 'on' + local settings = args.settings or function() end + + local head_command = 'curl --connect-timeout 3 -fsm 3' + local request = "-X 'STATUS INBOX (MESSAGES RECENT UNSEEN)'" + + if not server or not mail or not password then + return + end + + mail_notification_preset = { + icon = helpers.icons_dir .. 'mail.png', + position = 'top_left', + } + + helpers.set_map(mail, 0) + + if not is_plain then + if type(password) == 'string' or type(password) == 'table' then + helpers.async(password, function(f) + password = f:gsub('\n', '') + end) + elseif type(password) == 'function' then + imap.pwdtimer = helpers.newtimer(mail .. '-password', pwdtimeout, function() + local retrieved_password, try_again = password() + if not try_again then + imap.pwdtimer:stop() -- stop trying to retrieve + password = retrieved_password or '' -- failsafe + end + end, true, true) + end + end + + function imap.update() + -- do not update if the password has not been retrieved yet + if type(password) ~= 'string' then + return + end + + local curl = string.format( + "%s --url imaps://%s:%s/INBOX -u %s:'%s' %s -k", + head_command, + server, + port, + mail, + password, + request + ) + + helpers.async(curl, function(f) + imap_now = { ['MESSAGES'] = 0, ['RECENT'] = 0, ['UNSEEN'] = 0 } + + for s, d in f:gmatch('(%w+)%s+(%d+)') do + imap_now[s] = tonumber(d) + end + mailcount = imap_now['UNSEEN'] -- backwards compatibility + widget = imap.widget + + settings() + + if notify == 'on' and mailcount and mailcount >= 1 and mailcount > helpers.get_map(mail) then + if followtag then + mail_notification_preset.screen = awful.screen.focused() + end + naughty.notify({ + preset = mail_notification_preset, + text = string.format( + '%s has %d new message%s', + mail, + mailcount, + mailcount == 1 and '' or 's' + ), + }) + end + + helpers.set_map(mail, imap_now['UNSEEN']) + end) + end + + imap.timer = helpers.newtimer(mail, timeout, imap.update, true, true) + + return imap +end + +return factory diff --git a/lib/lain/widget/init.lua b/lib/lain/widget/init.lua new file mode 100644 index 0000000..1ba8be9 --- /dev/null +++ b/lib/lain/widget/init.lua @@ -0,0 +1,19 @@ +--[[ + + Lain + Layouts, widgets and utilities for Awesome WM + + Widgets section + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local wrequire = require('lain.helpers').wrequire +local setmetatable = setmetatable + +local widget = { _NAME = 'lain.widget' } + +return setmetatable(widget, { __index = wrequire }) diff --git a/lib/lain/widget/mem.lua b/lib/lain/widget/mem.lua new file mode 100644 index 0000000..597d15f --- /dev/null +++ b/lib/lain/widget/mem.lua @@ -0,0 +1,58 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local helpers = require('lain.helpers') +local wibox = require('wibox') +local gmatch, lines, floor = string.gmatch, io.lines, math.floor + +-- Memory usage (ignoring caches) +-- lain.widget.mem + +local function factory(args) + args = args or {} + + local mem = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 2 + local settings = args.settings or function() end + + function mem.update() + mem_now = {} + for line in lines('/proc/meminfo') do + for k, v in gmatch(line, '([%a]+):[%s]+([%d]+).+') do + if k == 'MemTotal' then + mem_now.total = floor(v / 1024 + 0.5) + elseif k == 'MemFree' then + mem_now.free = floor(v / 1024 + 0.5) + elseif k == 'Buffers' then + mem_now.buf = floor(v / 1024 + 0.5) + elseif k == 'Cached' then + mem_now.cache = floor(v / 1024 + 0.5) + elseif k == 'SwapTotal' then + mem_now.swap = floor(v / 1024 + 0.5) + elseif k == 'SwapFree' then + mem_now.swapf = floor(v / 1024 + 0.5) + elseif k == 'SReclaimable' then + mem_now.srec = floor(v / 1024 + 0.5) + end + end + end + + mem_now.used = mem_now.total - mem_now.free - mem_now.buf - mem_now.cache - mem_now.srec + mem_now.swapused = mem_now.swap - mem_now.swapf + mem_now.perc = math.floor(mem_now.used / mem_now.total * 100) + + widget = mem.widget + settings() + end + + helpers.newtimer('mem', timeout, mem.update) + + return mem +end + +return factory diff --git a/lib/lain/widget/mpd.lua b/lib/lain/widget/mpd.lua new file mode 100644 index 0000000..d786d14 --- /dev/null +++ b/lib/lain/widget/mpd.lua @@ -0,0 +1,159 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010, Adrian C. + +--]] + +local helpers = require('lain.helpers') +local shell = require('awful.util').shell +local escape_f = require('awful.util').escape +local focused = require('awful.screen').focused +local naughty = require('naughty') +local wibox = require('wibox') +local os = os +local string = string + +-- MPD infos +-- lain.widget.mpd + +local function factory(args) + args = args or {} + + local mpd = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 2 + local password = (args.password and #args.password > 0 and string.format('password %s\\n', args.password)) or '' + local host = args.host or os.getenv('MPD_HOST') or '127.0.0.1' + local port = args.port or os.getenv('MPD_PORT') or '6600' + local music_dir = args.music_dir or os.getenv('HOME') .. '/Music' + local cover_pattern = args.cover_pattern or '*\\.(jpg|jpeg|png|gif)$' + local cover_size = args.cover_size or 100 + local default_art = args.default_art + local notify = args.notify or 'on' + local followtag = args.followtag or false + local settings = args.settings or function() end + + local mpdh = string.format('telnet://%s:%s', host, port) + local echo = string.format('printf "%sstatus\\ncurrentsong\\nclose\\n"', password) + local cmd = string.format('%s | curl --connect-timeout 1 -fsm 3 %s', echo, mpdh) + + mpd_notification_preset = { title = 'Now playing', timeout = 6 } + + helpers.set_map('current mpd track', nil) + + function mpd.update() + helpers.async({ shell, '-c', cmd }, function(f) + mpd_now = { + random_mode = false, + single_mode = false, + repeat_mode = false, + consume_mode = false, + pls_pos = 'N/A', + pls_len = 'N/A', + state = 'N/A', + file = 'N/A', + name = 'N/A', + artist = 'N/A', + title = 'N/A', + album = 'N/A', + genre = 'N/A', + track = 'N/A', + date = 'N/A', + time = 'N/A', + elapsed = 'N/A', + volume = 'N/A', + } + + for line in string.gmatch(f, '[^\n]+') do + for k, v in string.gmatch(line, '([%w]+):[%s](.*)$') do + if k == 'state' then + mpd_now.state = v + elseif k == 'file' then + mpd_now.file = v + elseif k == 'Name' then + mpd_now.name = escape_f(v) + elseif k == 'Artist' then + mpd_now.artist = escape_f(v) + elseif k == 'Title' then + mpd_now.title = escape_f(v) + elseif k == 'Album' then + mpd_now.album = escape_f(v) + elseif k == 'Genre' then + mpd_now.genre = escape_f(v) + elseif k == 'Track' then + mpd_now.track = escape_f(v) + elseif k == 'Date' then + mpd_now.date = escape_f(v) + elseif k == 'Time' then + mpd_now.time = v + elseif k == 'elapsed' then + mpd_now.elapsed = string.match(v, '%d+') + elseif k == 'song' then + mpd_now.pls_pos = v + elseif k == 'playlistlength' then + mpd_now.pls_len = v + elseif k == 'repeat' then + mpd_now.repeat_mode = v ~= '0' + elseif k == 'single' then + mpd_now.single_mode = v ~= '0' + elseif k == 'random' then + mpd_now.random_mode = v ~= '0' + elseif k == 'consume' then + mpd_now.consume_mode = v ~= '0' + elseif k == 'volume' then + mpd_now.volume = v + end + end + end + + mpd_notification_preset.text = + string.format('%s (%s) - %s\n%s', mpd_now.artist, mpd_now.album, mpd_now.date, mpd_now.title) + widget = mpd.widget + settings() + + if mpd_now.state == 'play' then + if notify == 'on' and mpd_now.title ~= helpers.get_map('current mpd track') then + helpers.set_map('current mpd track', mpd_now.title) + + if followtag then + mpd_notification_preset.screen = focused() + end + + local common = { + preset = mpd_notification_preset, + icon = default_art, + icon_size = cover_size, + replaces_id = mpd.id, + } + + if not string.match(mpd_now.file, 'http.*://') then -- local file instead of http stream + local path = string.format('%s/%s', music_dir, string.match(mpd_now.file, '.*/')) + local cover = string.format( + "find '%s' -maxdepth 1 -type f | egrep -i -m1 '%s'", + path:gsub("'", "'\\''"), + cover_pattern + ) + helpers.async({ shell, '-c', cover }, function(current_icon) + common.icon = current_icon:gsub('\n', '') + if #common.icon == 0 then + common.icon = nil + end + mpd.id = naughty.notify(common).id + end) + else + mpd.id = naughty.notify(common).id + end + end + elseif mpd_now.state ~= 'pause' then + helpers.set_map('current mpd track', nil) + end + end) + end + + mpd.timer = helpers.newtimer('mpd', timeout, mpd.update, true, true) + + return mpd +end + +return factory diff --git a/lib/lain/widget/net.lua b/lib/lain/widget/net.lua new file mode 100644 index 0000000..5a95900 --- /dev/null +++ b/lib/lain/widget/net.lua @@ -0,0 +1,133 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local helpers = require('lain.helpers') +local naughty = require('naughty') +local wibox = require('wibox') +local string = string + +-- Network infos +-- lain.widget.net + +local function factory(args) + args = args or {} + + local net = { widget = args.widget or wibox.widget.textbox(), devices = {} } + local timeout = args.timeout or 2 + local units = args.units or 1024 -- KB + local notify = args.notify or 'on' + local wifi_state = args.wifi_state or 'off' + local eth_state = args.eth_state or 'off' + local screen = args.screen or 1 + local format = args.format or '%.1f' + local settings = args.settings or function() end + + -- Compatibility with old API where iface was a string corresponding to 1 interface + net.iface = ( + args.iface and (type(args.iface) == 'string' and { args.iface }) + or (type(args.iface) == 'table' and args.iface) + ) or {} + + function net.get_devices() + net.iface = {} -- reset at every call + helpers.line_callback('ip link', function(line) + net.iface[#net.iface + 1] = not string.match(line, 'LOOPBACK') and string.match(line, '(%w+): <') or nil + end) + end + + if #net.iface == 0 then + net.get_devices() + end + + function net.update() + -- These are the totals over all specified interfaces + net_now = { + devices = {}, + -- Bytes since last iteration + sent = 0, + received = 0, + } + + for _, dev in ipairs(net.iface) do + local dev_now = {} + local dev_before = net.devices[dev] or { last_t = 0, last_r = 0 } + local now_t = tonumber(helpers.first_line(string.format('/sys/class/net/%s/statistics/tx_bytes', dev)) or 0) + local now_r = tonumber(helpers.first_line(string.format('/sys/class/net/%s/statistics/rx_bytes', dev)) or 0) + + dev_now.carrier = helpers.first_line(string.format('/sys/class/net/%s/carrier', dev)) or '0' + dev_now.state = helpers.first_line(string.format('/sys/class/net/%s/operstate', dev)) or 'down' + + dev_now.sent = (now_t - dev_before.last_t) / timeout / units + dev_now.received = (now_r - dev_before.last_r) / timeout / units + + net_now.sent = net_now.sent + dev_now.sent + net_now.received = net_now.received + dev_now.received + + dev_now.sent = string.format(format, dev_now.sent) + dev_now.received = string.format(format, dev_now.received) + + dev_now.last_t = now_t + dev_now.last_r = now_r + + if + wifi_state == 'on' + and helpers.first_line(string.format('/sys/class/net/%s/uevent', dev)) == 'DEVTYPE=wlan' + then + dev_now.wifi = true + if string.match(dev_now.carrier, '1') then + dev_now.signal = tonumber(string.match(helpers.lines_from('/proc/net/wireless')[3], '(%-%d+%.)')) + or nil + end + else + dev_now.wifi = false + end + + if + eth_state == 'on' + and helpers.first_line(string.format('/sys/class/net/%s/uevent', dev)) ~= 'DEVTYPE=wlan' + then + dev_now.ethernet = true + else + dev_now.ethernet = false + end + + net.devices[dev] = dev_now + + -- Notify only once when connection is lost + if string.match(dev_now.carrier, '0') and notify == 'on' and helpers.get_map(dev) then + naughty.notify({ + title = dev, + text = 'No carrier', + icon = helpers.icons_dir .. 'no_net.png', + screen = screen, + }) + helpers.set_map(dev, false) + elseif string.match(dev_now.carrier, '1') then + helpers.set_map(dev, true) + end + + net_now.carrier = dev_now.carrier + net_now.state = dev_now.state + net_now.devices[dev] = dev_now + -- net_now.sent and net_now.received will be + -- the totals across all specified devices + end + + net_now.sent = string.format(format, net_now.sent) + net_now.received = string.format(format, net_now.received) + + widget = net.widget + settings() + end + + helpers.newtimer('network', timeout, net.update) + + return net +end + +return factory diff --git a/lib/lain/widget/pulse.lua b/lib/lain/widget/pulse.lua new file mode 100644 index 0000000..7c3845c --- /dev/null +++ b/lib/lain/widget/pulse.lua @@ -0,0 +1,60 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2016, Luca CPZ + +--]] + +local helpers = require('lain.helpers') +local shell = require('awful.util').shell +local wibox = require('wibox') +local string = string +local type = type + +-- PulseAudio volume +-- lain.widget.pulse + +local function factory(args) + args = args or {} + + local pulse = { widget = args.widget or wibox.widget.textbox(), device = 'N/A' } + local timeout = args.timeout or 5 + local settings = args.settings or function() end + + pulse.devicetype = args.devicetype or 'sink' + pulse.cmd = args.cmd + or 'pacmd list-' + .. pulse.devicetype + .. "s | sed -n -e '/*/,$!d' -e '/index/p' -e '/base volume/d' -e '/volume:/p' -e '/muted:/p' -e '/device\\.string/p'" + + function pulse.update() + helpers.async({ shell, '-c', type(pulse.cmd) == 'string' and pulse.cmd or pulse.cmd() }, function(s) + volume_now = { + index = string.match(s, 'index: (%S+)') or 'N/A', + device = string.match(s, 'device.string = "(%S+)"') or 'N/A', + muted = string.match(s, 'muted: (%S+)') or 'N/A', + } + + pulse.device = volume_now.index + + local ch = 1 + volume_now.channel = {} + for v in string.gmatch(s, ':.-(%d+)%%') do + volume_now.channel[ch] = v + ch = ch + 1 + end + + volume_now.left = volume_now.channel[1] or 'N/A' + volume_now.right = volume_now.channel[2] or 'N/A' + + widget = pulse.widget + settings() + end) + end + + helpers.newtimer('pulse', timeout, pulse.update) + + return pulse +end + +return factory diff --git a/lib/lain/widget/pulsebar.lua b/lib/lain/widget/pulsebar.lua new file mode 100644 index 0000000..3cd5f07 --- /dev/null +++ b/lib/lain/widget/pulsebar.lua @@ -0,0 +1,185 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2013, Rman + +--]] + +local helpers = require('lain.helpers') +local awful = require('awful') +local naughty = require('naughty') +local wibox = require('wibox') +local math = math +local string = string +local type = type +local tonumber = tonumber + +-- PulseAudio volume bar +-- lain.widget.pulsebar + +local function factory(args) + local pulsebar = { + colors = { + background = '#000000', + mute_background = '#000000', + mute = '#EB8F8F', + unmute = '#A4CE8A', + }, + + _current_level = 0, + _mute = 'no', + device = 'N/A', + } + + args = args or {} + + local timeout = args.timeout or 5 + local settings = args.settings or function() end + local width = args.width or 63 + local height = args.height or 1 + local margins = args.margins or 1 + local paddings = args.paddings or 1 + local ticks = args.ticks or false + local ticks_size = args.ticks_size or 7 + local tick = args.tick or '|' + local tick_pre = args.tick_pre or '[' + local tick_post = args.tick_post or ']' + local tick_none = args.tick_none or ' ' + + pulsebar.colors = args.colors or pulsebar.colors + pulsebar.followtag = args.followtag or false + pulsebar.notification_preset = args.notification_preset + pulsebar.devicetype = args.devicetype or 'sink' + pulsebar.cmd = args.cmd + or 'pacmd list-' + .. pulsebar.devicetype + .. "s | sed -n -e '/*/,$!d' -e '/index/p' -e '/base volume/d' -e '/volume:/p' -e '/muted:/p' -e '/device\\.string/p'" + + if not pulsebar.notification_preset then + pulsebar.notification_preset = { + font = 'Monospace 10', + } + end + + pulsebar.bar = wibox.widget({ + color = pulsebar.colors.unmute, + background_color = pulsebar.colors.background, + forced_height = height, + forced_width = width, + margins = margins, + paddings = paddings, + ticks = ticks, + ticks_size = ticks_size, + widget = wibox.widget.progressbar, + }) + + pulsebar.tooltip = awful.tooltip({ objects = { pulsebar.bar } }) + + function pulsebar.update(callback) + helpers.async( + { awful.util.shell, '-c', type(pulsebar.cmd) == 'string' and pulsebar.cmd or pulsebar.cmd() }, + function(s) + volume_now = { + index = string.match(s, 'index: (%S+)') or 'N/A', + device = string.match(s, 'device.string = "(%S+)"') or 'N/A', + muted = string.match(s, 'muted: (%S+)') or 'N/A', + } + + pulsebar.device = volume_now.index + + local ch = 1 + volume_now.channel = {} + for v in string.gmatch(s, ':.-(%d+)%%') do + volume_now.channel[ch] = v + ch = ch + 1 + end + + volume_now.left = volume_now.channel[1] or 'N/A' + volume_now.right = volume_now.channel[2] or 'N/A' + + local volu = volume_now.left + local mute = volume_now.muted + + if volu:match('N/A') or mute:match('N/A') then + return + end + + if volu ~= pulsebar._current_level or mute ~= pulsebar._mute then + pulsebar._current_level = tonumber(volu) + pulsebar.bar:set_value(pulsebar._current_level / 100) + if pulsebar._current_level == 0 or mute == 'yes' then + pulsebar._mute = mute + pulsebar.tooltip:set_text('[muted]') + pulsebar.bar.color = pulsebar.colors.mute + pulsebar.bar.background_color = pulsebar.colors.mute_background + else + pulsebar._mute = 'no' + pulsebar.tooltip:set_text( + string.format('%s %s: %s', pulsebar.devicetype, pulsebar.device, volu) + ) + pulsebar.bar.color = pulsebar.colors.unmute + pulsebar.bar.background_color = pulsebar.colors.background + end + + settings() + + if type(callback) == 'function' then + callback() + end + end + end + ) + end + + function pulsebar.notify() + pulsebar.update(function() + local preset = pulsebar.notification_preset + + preset.title = string.format('%s %s - %s%%', pulsebar.devicetype, pulsebar.device, pulsebar._current_level) + + if pulsebar._mute == 'yes' then + preset.title = preset.title .. ' muted' + end + + -- tot is the maximum number of ticks to display in the notification + -- fallback: default horizontal wibox height + local wib, tot = awful.screen.focused().mywibox, 20 + + -- if we can grab mywibox, tot is defined as its height if + -- horizontal, or width otherwise + if wib then + if wib.position == 'left' or wib.position == 'right' then + tot = wib.width + else + tot = wib.height + end + end + + local int = math.modf((pulsebar._current_level / 100) * tot) + preset.text = + string.format('%s%s%s%s', tick_pre, string.rep(tick, int), string.rep(tick_none, tot - int), tick_post) + + if pulsebar.followtag then + preset.screen = awful.screen.focused() + end + + if not pulsebar.notification then + pulsebar.notification = naughty.notify({ + preset = preset, + destroy = function() + pulsebar.notification = nil + end, + }) + else + naughty.replace_text(pulsebar.notification, preset.title, preset.text) + end + end) + end + + helpers.newtimer(string.format('pulsebar-%s-%s', pulsebar.devicetype, pulsebar.device), timeout, pulsebar.update) + + return pulsebar +end + +return factory diff --git a/lib/lain/widget/sysload.lua b/lib/lain/widget/sysload.lua new file mode 100644 index 0000000..1704432 --- /dev/null +++ b/lib/lain/widget/sysload.lua @@ -0,0 +1,39 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local helpers = require('lain.helpers') +local wibox = require('wibox') +local open, match = io.open, string.match + +-- System load +-- lain.widget.sysload + +local function factory(args) + args = args or {} + + local sysload = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 2 + local settings = args.settings or function() end + + function sysload.update() + local f = open('/proc/loadavg') + local ret = f:read('*all') + f:close() + + load_1, load_5, load_15 = match(ret, '([^%s]+) ([^%s]+) ([^%s]+)') + + widget = sysload.widget + settings() + end + + helpers.newtimer('sysload', timeout, sysload.update) + + return sysload +end + +return factory diff --git a/lib/lain/widget/temp.lua b/lib/lain/widget/temp.lua new file mode 100644 index 0000000..ed0f24a --- /dev/null +++ b/lib/lain/widget/temp.lua @@ -0,0 +1,50 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +local helpers = require('lain.helpers') +local wibox = require('wibox') +local tonumber = tonumber + +-- {thermal,core} temperature info +-- lain.widget.temp + +local function factory(args) + args = args or {} + + local temp = { widget = args.widget or wibox.widget.textbox() } + local timeout = args.timeout or 30 + local tempfile = args.tempfile or '/sys/devices/virtual/thermal/thermal_zone0/temp' + local format = args.format or '%.1f' + local settings = args.settings or function() end + + function temp.update() + helpers.async({ 'find', '/sys/devices', '-type', 'f', '-name', '*temp*' }, function(f) + temp_now = {} + local temp_fl, temp_value + for t in f:gmatch('[^\n]+') do + temp_fl = helpers.first_line(t) + if temp_fl then + temp_value = tonumber(temp_fl) + temp_now[t] = temp_value and temp_value / 1e3 or temp_fl + end + end + if temp_now[tempfile] then + coretemp_now = string.format(format, temp_now[tempfile]) + else + coretemp_now = 'N/A' + end + widget = temp.widget + settings() + end) + end + + helpers.newtimer('thermal', timeout, temp.update) + + return temp +end + +return factory diff --git a/lib/lain/widget/weather.lua b/lib/lain/widget/weather.lua new file mode 100644 index 0000000..e042ab6 --- /dev/null +++ b/lib/lain/widget/weather.lua @@ -0,0 +1,151 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2015, Luca CPZ + +--]] + +local helpers = require('lain.helpers') +local json = require('lain.util').dkjson +local focused = require('awful.screen').focused +local naughty = require('naughty') +local wibox = require('wibox') +local math = math +local os = os +local string = string +local type = type +local tonumber = tonumber + +-- OpenWeatherMap +-- current weather and X-days forecast +-- lain.widget.weather + +local function factory(args) + args = args or {} + + local weather = { widget = args.widget or wibox.widget.textbox() } + local APPID = args.APPID -- mandatory + local timeout = args.timeout or 60 * 15 -- 15 min + local current_call = args.current_call + or "curl -s 'https://api.openweathermap.org/data/2.5/weather?id=%s&units=%s&lang=%s&APPID=%s'" + local forecast_call = args.forecast_call + or "curl -s 'https://api.openweathermap.org/data/2.5/forecast?id=%s&units=%s&lang=%s&APPID=%s'" + local city_id = args.city_id or 0 -- placeholder + local units = args.units or 'metric' + local lang = args.lang or 'en' + local cnt = args.cnt or 5 + local icons_path = args.icons_path or helpers.icons_dir .. 'openweathermap/' + local notification_preset = args.notification_preset or {} + local notification_text_fun = args.notification_text_fun + or function(wn) + local day = os.date('%a %d', wn['dt']) + local temp = math.floor(wn['main']['temp']) + local desc = wn['weather'][1]['description'] + return string.format('%s: %s, %d ', day, desc, temp) + end + local weather_na_markup = args.weather_na_markup or ' N/A ' + local followtag = args.followtag or false + local showpopup = args.showpopup or 'on' + local settings = args.settings or function() end + + weather.widget:set_markup(weather_na_markup) + weather.icon_path = icons_path .. 'na.png' + weather.icon = wibox.widget.imagebox(weather.icon_path) + + function weather.show(seconds) + weather.hide() + + if followtag then + notification_preset.screen = focused() + end + + if not weather.notification_text then + weather.update() + weather.forecast_update() + end + + weather.notification = naughty.notify({ + preset = notification_preset, + text = weather.notification_text, + icon = weather.icon_path, + timeout = type(seconds) == 'number' and seconds or notification_preset.timeout, + }) + end + + function weather.hide() + if weather.notification then + naughty.destroy(weather.notification) + weather.notification = nil + end + end + + function weather.attach(obj) + obj:connect_signal('mouse::enter', function() + weather.show(0) + end) + obj:connect_signal('mouse::leave', function() + weather.hide() + end) + end + + function weather.forecast_update() + local cmd = string.format(forecast_call, city_id, units, lang, APPID) + helpers.async(cmd, function(f) + local err + weather_now, _, err = json.decode(f, 1, nil) + + if not err and type(weather_now) == 'table' and tonumber(weather_now['cod']) == 200 then + weather.notification_text = '' + for i = 1, weather_now['cnt'], math.floor(weather_now['cnt'] / cnt) do + weather.notification_text = weather.notification_text + .. notification_text_fun(weather_now['list'][i]) + if i < weather_now['cnt'] then + weather.notification_text = weather.notification_text .. '\n' + end + end + end + end) + end + + function weather.update() + local cmd = string.format(current_call, city_id, units, lang, APPID) + helpers.async(cmd, function(f) + local err + weather_now, _, err = json.decode(f, 1, nil) + + if not err and type(weather_now) == 'table' and tonumber(weather_now['cod']) == 200 then + local sunrise = tonumber(weather_now['sys']['sunrise']) + local sunset = tonumber(weather_now['sys']['sunset']) + local icon = weather_now['weather'][1]['icon'] + local loc_now = os.time() + + if sunrise <= loc_now and loc_now <= sunset then + icon = string.gsub(icon, 'n', 'd') + else + icon = string.gsub(icon, 'd', 'n') + end + + weather.icon_path = icons_path .. icon .. '.png' + widget = weather.widget + settings() + else + weather.icon_path = icons_path .. 'na.png' + weather.widget:set_markup(weather_na_markup) + end + + weather.icon:set_image(weather.icon_path) + end) + end + + if showpopup == 'on' then + weather.attach(weather.widget) + end + + weather.timer = helpers.newtimer('weather-' .. city_id, timeout, weather.update, false, true) + weather.timer_forecast = + helpers.newtimer('weather_forecast-' .. city_id, timeout, weather.forecast_update, false, true) + + return weather +end + +return factory diff --git a/lib/lain/wiki/Home.md b/lib/lain/wiki/Home.md new file mode 100644 index 0000000..c31550f --- /dev/null +++ b/lib/lain/wiki/Home.md @@ -0,0 +1,44 @@ +Welcome to the Lain wiki! + +If you spot a typo or have a suggestion to improve these pages, please notify me opening an [issue](https://github.com/lcpz/lain/issues) format. Thank you. + +Dependencies +------------ + +Package | Requested by | Reasons of choice +--- | --- | --- +[curl](https://curl.haxx.se) | `imap`, `mpd`, and `weather` widgets | 1. faster and simpler to use than [LuaSocket](https://github.com/diegonehab/luasocket); 2. it's in the core of almost every distro; 3. can be called [asynchronously](https://awesomewm.org/doc/api/libraries/awful.spawn.html#easy_async) + +Installation +------------ + +### Arch Linux + +[AUR package](https://aur.archlinux.org/packages/lain-git/) + +### Other distributions + +```shell +git clone https://github.com/lcpz/lain.git ~/.config/awesome/lain +``` + +Also available via [LuaRocks](https://luarocks.org/modules/lcpz/lain): + +```shell +luarocks install lcpz/lain +``` + +Usage +-------- + +First, include it into your `rc.lua`: + +```lua +local lain = require("lain") +``` + +Then check out the submodules you want: + +- [Layouts](https://github.com/lcpz/lain/wiki/Layouts) +- [Widgets](https://github.com/lcpz/lain/wiki/Widgets) +- [Utilities](https://github.com/lcpz/lain/wiki/Utilities) diff --git a/lib/lain/wiki/Layouts.md b/lib/lain/wiki/Layouts.md new file mode 100644 index 0000000..0286d4b --- /dev/null +++ b/lib/lain/wiki/Layouts.md @@ -0,0 +1,255 @@ + + lain/layout + . + |-- termfair + |-- termfair.center + |-- cascade + |-- cascade.tile + |-- centerwork + |-- centerwork.horizontal + +Usage +===== + +As usual, specify your favourites in `awful.layout.layouts`, or set them on specific tags with [`awful.layout.set`](https://awesomewm.org/doc/api/libraries/awful.layout.html#set). + +```lua +awful.layout.set(lain.layout.termfair, tag) +``` + +How do layouts work? +==================== + +`termfair` +-------- + +This layout restricts the size of each window. Each window will have the +same width but is variable in height. Furthermore, windows are +left-aligned. The basic workflow is as follows (the number above the +screen is the number of open windows, the number in a cell is the fixed +number of a client): + + (1) (2) (3) + +---+---+---+ +---+---+---+ +---+---+---+ + | | | | | | | | | | | | + | 1 | | | -> | 2 | 1 | | -> | 3 | 2 | 1 | -> + | | | | | | | | | | | | + +---+---+---+ +---+---+---+ +---+---+---+ + + (4) (5) (6) + +---+---+---+ +---+---+---+ +---+---+---+ + | 4 | | | | 5 | 4 | | | 6 | 5 | 4 | + +---+---+---+ -> +---+---+---+ -> +---+---+---+ + | 3 | 2 | 1 | | 3 | 2 | 1 | | 3 | 2 | 1 | + +---+---+---+ +---+---+---+ +---+---+---+ + +The first client will be located in the left column. When opening +another window, this new window will be placed in the left column while +moving the first window into the middle column. Once a row is full, +another row above it will be created. + +Default number of columns and rows are respectively taken from `nmaster` +and `ncol` values in `awful.tag`, but you can set your own. + +For example, this sets `termfair` to 3 columns and at least 1 row: + +```lua +lain.layout.termfair.nmaster = 3 +lain.layout.termfair.ncol = 1 +``` + +`termfair.center` +---------- + +Similar to `termfair`, but with fixed number of vertical columns. Cols are centerded until there are `nmaster` columns, then windows are stacked as slaves, with possibly `ncol` clients per column at most. + + (1) (2) (3) + +---+---+---+ +-+---+---+-+ +---+---+---+ + | | | | | | | | | | | | | + | | 1 | | -> | | 1 | 2 | | -> | 1 | 2 | 3 | -> + | | | | | | | | | | | | | + +---+---+---+ +-+---+---+-+ +---+---+---+ + + (4) (5) + +---+---+---+ +---+---+---+ + | | | 3 | | | 2 | 4 | + + 1 + 2 +---+ -> + 1 +---+---+ + | | | 4 | | | 3 | 5 | + +---+---+---+ +---+---+---+ + +Like `termfair`, default number of columns and rows are respectively taken from `nmaster` +and `ncol` values in `awful.tag`, but you can set your own. + +For example, this sets `termfair.center` to 3 columns and at least 1 row: + +```lua +lain.layout.termfair.center.nmaster = 3 +lain.layout.termfair.center.ncol = 1 +``` + +`cascade` +------- + +Cascade all windows of a tag. + +You can control the offsets by setting these two variables: + +```lua +lain.layout.cascade.offset_x = 64 +lain.layout.cascade.offset_y = 16 +``` + +The following reserves space for 5 windows: + +```lua +lain.layout.cascade.nmaster = 5 +``` + +That is, no window will get resized upon the creation of a new window, +unless there's more than 5 windows. + +`cascade.tile` +----------- + +Similar to `awful.layout.suit.tile` layout, however, clients in the slave +column are cascaded instead of tiled. + +Left column size can be set, otherwise is controlled by `mwfact` of the +tag. Additional windows will be opened in another column on the right. +New windows are placed above old windows. + +Whether the slave column is placed on top of the master window or not is +controlled by the value of `ncol`. A value of 1 means "overlapping slave column" +and anything else means "don't overlap windows". + +Usage example: + +```lua +lain.layout.cascade.tile.offset_x = 2 +lain.layout.cascade.tile.offset_y = 32 +lain.layout.cascade.tile.extra_padding = 5 +lain.layout.cascade.tile.nmaster = 5 +lain.layout.cascade.tile.ncol = 2 +``` + +`extra_padding` reduces the size of the master window if "overlapping +slave column" is activated. This allows you to see if there are any +windows in your slave column. + +Setting `offset_x` to a very small value or even 0 is recommended to avoid wasting space. + +`centerwork` +---------- + +You start with one window, centered horizontally: + + +--------------------------+ + | +----------+ | + | | | | + | | | | + | | | | + | | MAIN | | + | | | | + | | | | + | | | | + | | | | + | +----------+ | + +--------------------------+ + +This is your main working window. You do most of the work right here. +Sometimes, you may want to open up additional windows. They're put on left and right, alternately. + + +--------------------------+ + | +---+ +----------+ +---+ | + | | | | | | | | + | | | | | | | | + | | | | | | | | + | +---+ | MAIN | +---+ | + | +---+ | | +---+ | + | | | | | | | | + | | | | | | | | + | | | | | | | | + | +---+ +----------+ +---+ | + +--------------------------+ + +*Please note:* If you use Awesome's default configuration, navigation in +this layout may be very confusing. How do you get from the main window +to satellite ones depends on the order in which the windows are opened. +Thus, use of `awful.client.focus.bydirection()` is suggested. +Here's an example: + +```lua +globalkeys = awful.util.table.join( + -- [...] + awful.key({ modkey }, "j", + function() + awful.client.focus.bydirection("down") + if client.focus then client.focus:raise() end + end), + awful.key({ modkey }, "k", + function() + awful.client.focus.bydirection("up") + if client.focus then client.focus:raise() end + end), + awful.key({ modkey }, "h", + function() + awful.client.focus.bydirection("left") + if client.focus then client.focus:raise() end + end), + awful.key({ modkey }, "l", + function() + awful.client.focus.bydirection("right") + if client.focus then client.focus:raise() end + end), + -- [...] +) +``` + +`centerwork.horizontal` +----------- + +Same as `centerwork`, except that the main +window expands horizontally, and the additional windows +are put ontop/below it. Useful if you have a screen turned 90°. + +Pre 4.0 `uselesstile` patches +============================= + +In branch 3.5, this module provided useless gaps layouts. Since useless gaps have been implemented in Awesome 4.0, those layouts have been removed. + +Following are a couple of `uselesstile` variants that were not part of lain. They are kept only for reference and are not supported. + +Xmonad-like +----------- + +If you want to have `awful.layout.suit.tile` behave like xmonad, with internal gaps two times wider than external ones, download [this](https://gist.github.com/lcpz/9e56dcfbe66bfe14967c) as `lain/layout/uselesstile`. + +Inverted master +--------------- + +Want to invert master window position? Use [this](https://gist.github.com/lcpz/c59dc59c9f99d98218eb) version. You can set `single_gap` with `width` and `height` in your `theme.lua`, in order to define the window geometry when there's only one client, otherwise it goes maximized. An example: + + theme.single_gap = { width = 600, height = 100 } + +What about layout icons? +======================== + +They are located in ``lain/icons/layout``. + +To use them, define new `layout_*` variables in your ``theme.lua``. For instance: + +```lua +theme.lain_icons = os.getenv("HOME") .. + "/.config/awesome/lain/icons/layout/default/" +theme.layout_termfair = theme.lain_icons .. "termfair.png" +theme.layout_centerfair = theme.lain_icons .. "centerfair.png" -- termfair.center +theme.layout_cascade = theme.lain_icons .. "cascade.png" +theme.layout_cascadetile = theme.lain_icons .. "cascadetile.png" -- cascade.tile +theme.layout_centerwork = theme.lain_icons .. "centerwork.png" +theme.layout_centerworkh = theme.lain_icons .. "centerworkh.png" -- centerwork.horizontal +``` + +Credit goes to [Nicolas Estibals](https://github.com/nestibal) for creating +layout icons for default theme. + +You can use them as a template for your custom versions. \ No newline at end of file diff --git a/lib/lain/wiki/Utilities.md b/lib/lain/wiki/Utilities.md new file mode 100644 index 0000000..361bd2a --- /dev/null +++ b/lib/lain/wiki/Utilities.md @@ -0,0 +1,339 @@ +Quake +----- + +A Quake-like dropdown container for your favourite application. + +**Usage** + +Define it globally to have a single instance for all screens: + +```lua +local quake = lain.util.quake() +``` + +or define it in `connect_for_each_screen` to have one instance for each screen: + +```lua +awful.screen.connect_for_each_screen(function(s) + -- Quake application + s.quake = lain.util.quake() + -- [...] +``` + +**Keybinding example** + +If using a global instance: +```lua +awful.key({ modkey, }, "z", function () quake:toggle() end), +``` + +If using a per-screen instance: +```lua +awful.key({ modkey, }, "z", function () awful.screen.focused().quake:toggle() end), +``` + +**Input table** + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`app` | client to spawn | string | "xterm" +`name` | client name | string | "QuakeDD" +`argname` | how to specify client name | string | "-name %s" +`extra` | extra `app` arguments | string | empty string +`border` | border width | integer | 1 +`visible` | initially visible | boolean | false +`followtag` | always spawn on currently focused screen | boolean | false +`overlap` | Overlap the wibox or not | boolean | false +`settings` | Additional settings to make on the client | function | `nil` +`screen` | screen where to spawn the client | integer | `awful.screen.focused()` +`height` | dropdown client height | float in [0,1] or exact pixels number | 0.25 +`width` | dropdown client width | float in [0,1] or exact pixels number | 1 +`vert` | vertical position | string, possible values: "top", "bottom", "center" | "top" +`horiz` | horizontal position | string, possible values: "left", "right", "center" | "left" + +`height` and `width` express a fraction of the workspace. + +`settings` is a function which takes the client as input, and can be used to customize its properties. For instance: + +```lua +-- set the client sticky +s.quake = lain.util.quake { settings = function(c) c.sticky = true end } +``` + +Read [here](https://awesomewm.org/doc/api/classes/client.html#Object_properties) for the complete list of properties. + +**Notes** + +* [Does not work](https://github.com/lcpz/lain/issues/358) with `gnome-terminal`, `konsole`, or any other terminal which is strictly designed for a Desktop Environment. Just pick a better terminal, [there's plenty](https://wiki.archlinux.org/index.php/List_of_applications#Terminal_emulators). +* Set `followtag = true` if [experiencing issues with multiple screens](https://github.com/lcpz/lain/issues/346). +* If you have a `awful.client.setslave` rule for your application, ensure you use an exception for `QuakeDD` (or your defined `name`). Otherwise, you may run into problems with focus. +* If you are using a VTE-based terminal like `termite`, be sure to set [`argname = "--name %s"`](https://github.com/lcpz/lain/issues/211). +* If you are using a terminal that does not always set its `class_id` to your specified `name`, such as Alacritty, then toggling will not work. You can solve this issue as explained [here](https://github.com/lcpz/lain/issues/536#issuecomment-1180155486). + +Separators +---------- + +Adds Cairo separators. + +```lua +local separators = lain.util.separators +``` + +A separator function `separators.separator` takes two color arguments, defined as strings. `"alpha"` argument is allowed. Example: + +```lua +arrl_dl = separators.arrow_left(beautiful.bg_focus, "alpha") +arrl_ld = separators.arrow_left("alpha", beautiful.bg_focus) +``` + +You can customize height and width by setting `separators_height` and `separators_width` in your `theme.lua`. Default values are 0 and 9, respectively. + +List of functions: + + +-- separators + | + |`-- arrow_right() Draw a right arrow. + `-- arrow_left() Draw a left arrow. + +Markup +------ + +Easier markup. + +```lua +local markup = lain.util.markup +``` + +List of functions: + + +-- markup + | + |`-- bold() Set bold. + |`-- italic() Set italicized text. + |`-- strike() Set strikethrough text. + |`-- underline() Set underlined text. + |`-- monospace() Set monospaced text. + |`-- big() Set bigger text. + |`-- small() Set smaller text. + |`-- font() Set the font of the text. + |`-- font() Set the font of the text. + |`-- color() Set background and foreground color. + |`-- fontfg() Set font and foreground color. + |`-- fontbg() Set font and background color. + `-- fontcolor() Set font, plus background and foreground colors. + | + |`--+ bg + | | + | `-- color() Set background color. + | + `--+ fg + | + `-- color() Set foreground color. + +they all take one argument, which is the text to markup, except the following: + +```lua +markup.font(font, text) +markup.color(fg, bg, text) +markup.fontfg(font, fg, text) +markup.fontbg(font, bg, text) +markup.fontcolor(font, fg, bg, text) +markup.fg.color(color, text) +markup.bg.color(color, text) +``` + +Dynamic tagging +--------------- + +That is: + +- add a new tag; +- rename current tag; +- move current tag; +- delete current tag. + +If you delete a tag, any rule set on it shall be broken, so be careful. + +Use it with key bindings like these: + +```lua +awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mylayout) end), +awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag() end), +awful.key({ modkey, "Shift" }, "Left", function () lain.util.move_tag(1) end), -- move to next tag +awful.key({ modkey, "Shift" }, "Right", function () lain.util.move_tag(-1) end), -- move to previous tag +awful.key({ modkey, "Shift" }, "d", function () lain.util.delete_tag() end), +``` + +The argument in `lain.util.add_tag` represents the tag layout, and is optional: if not present, it will be defaulted to `awful.layout.suit.tile`. + +Useless gaps resize +--------------------- + +Changes `beautiful.useless_gaps` on the fly. + +```lua +lain.util.useless_gap_resize(thatmuch, s, t) +``` + +The argument `thatmuch` is the number of pixel to add to/substract from gaps (integer). + +The arguments `s` and `t` are the `awful.screen` and `awful.tag` in which you want to change the gap. They are optional. + +Following are example keybindings for changing client gaps on current screen and tag. + +Example 1: + +```lua +-- On the fly useless gaps change +awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end), +awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end), +``` + +where `altkey = Mod1`. Example 2: + +```lua +mywidget:buttons(awful.util.table.join ( + awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end), + awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end) + end) +)) +``` + +so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel. + +tag\_view\_nonempty +------------------- + +This function lets you jump to the next/previous non-empty tag. +It takes two arguments: + +* `direction`: `1` for next non-empty tag, `-1` for previous. +* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This + argument is optional. + +You can use it with key bindings like these: + +```lua +-- Non-empty tag browsing +awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end), +awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end), +``` + +where `altkey = "Mod1"`. + +magnify\_client +--------------- + +Set a client to floating and resize it in the same way the "magnifier" +layout does it. Place it on the "current" screen (derived from the mouse +position). This allows you to magnify any client you wish, regardless of +the currently used layout. Use it with a client keybinding like this: + +```lua +clientkeys = awful.util.table.join( + -- [...] + awful.key({ modkey, "Control" }, "m", lain.util.magnify_client), + -- [...] +) +``` + +If you want to "de-magnify" it, just retype the keybinding. + +If you want magnified client to respond to `incmwfact`, read [here](https://github.com/lcpz/lain/issues/195). + +menu\_clients\_current\_tags +---------------------------- + +Similar to `awful.menu.clients`, but this menu only shows the clients +of currently visible tags. Use it with a key binding like this: + +```lua +awful.key({ "Mod1" }, "Tab", function() + lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true }) +end), +``` + +menu\_iterator +-------------- + +A generic menu utility which enables iteration over lists of possible +actions to execute. The perfect example is a menu for choosing what +configuration to apply to X with `xrandr`, as suggested on the [Awesome wiki page](https://awesomewm.org/recipes/xrandr). + +

+ +
An example Synergy menu, courtesy of sim590 +

+ +You can either manually create a menu by defining a table in this format: + +```lua +{ { "choice description 1", callbackFuction1 }, { "choice description 2", callbackFunction2 }, ... } +``` + +or use `lain.util.menu_iterator.menu`. Once you have your menu, use it with `lain.menu_iterator.iterate`. + +### Input tables + +**lain.menu_iterator.iterate** + +| Argument | Description | Type +|---|---| --- +| `menu` | the menu to iterate on | table +| `timeout` | time (in seconds) to wait on a choice before the choice is accepted | integer (default: 4) +| `icon` | path to the icon to display in `naughty.notify` window | string + +**lain.menu_iterator.menu** + +| Argument | Description | Type +|---|---| --- +`choices` | list of choices (e.g., `{ "choice1", "choice2", ... }`) | array of strings +`name` | name of the program related to this menu | string +`selected_cb` | callback to execute for each selected choice, it takes one choice (string) as argument; can be `nil` (no action to execute) | function +`rejected_cb` | callback to execute for all rejected choices (the remaining choices, once one is selected), it takes one choice (string) as argument; can be `nil` (no action to execute) | function +`extra_choices` | more choices to be added to the menu; unlike `choices`, these ones won't trigger `rejected_cb` | array of `{ choice, callback }` pairs, where `choice` is a string and `callback` is a function +`combination` | how choices have to be combined in the menu; possible values are: "single" (default), the set of possible choices will simply be the input set ; "powerset", the set of possible choices will be the [power set](https://en.wikipedia.org/wiki/Power_set) of the input set | string + +### Examples + +A simple example is: + +```lua +local mymenu_iterable = lain.util.menu_iterator.menu { + choices = {"My first choice", "My second choice"}, + name = "My awesome program", + selected_cb = function(choice) + -- do something with selected choice + end, + rejected_cb = function(choice) + -- do something with every rejected choice + end +} +``` + +The variable `mymenu_iterable` is a menu compatible with the function `lain.util.menu_iterator.iterate`, which will iterate over it and displays notification with `naughty.notify` every time it is called. You can use it like this: + +```lua +local confirm_timeout = 5 -- time to wait before confirming the menu selection +local my_notify_icon = "/path/to/icon" -- the icon to display in the notification +lain.util.menu_iterator.iterate(mymenu_iterable, confirm_timeout, my_notify_icon) +``` + +Once `confirm_timeout` has passed without anymore calls to `iterate`, the choice is made and the associated callbacks (both for selected and rejected choices) are spawned. + +A useful practice is to add a `Cancel` option as an extra choice for canceling a menu selection. Extending the above example: + +```lua +local mymenu_iterable = lain.util.menu_iterator.menu { + choices = {"My first choice", "My second choice"}, + name = "My awesome program", + selected_cb = function(choice) + -- do something with selected choice + end, + rejected_cb = function(choice) + -- do something with every rejected choice + end + -- nil means no action to do + extra_choices = { {"Cancel"}, nil } +} +``` diff --git a/lib/lain/wiki/Widgets.md b/lib/lain/wiki/Widgets.md new file mode 100644 index 0000000..1653ea2 --- /dev/null +++ b/lib/lain/wiki/Widgets.md @@ -0,0 +1,55 @@ +# Usage + +Every lain widget is a table. + +A lain widget is generated by a `function`. + +The `function` signature, input and output arguments can be found in the [related wiki entry](https://github.com/lcpz/lain/wiki/Widgets#index). + +Every lain widget contains a `wibox.widget`, which is updated by a timed function. To access the widget, use the field `widget`, to access the timed function, use the field `update`. Some lain widgets may also have an `icon` field, which is a `wibox.widget.imagebox`, and/or a `timer` field, which is the `gears.timer` on `update`. + +Every `function` may take either a table or a list of variables as input. + +If the input is a table, you must define a function variable called `settings` in it. There you will be able to define `widget` appearance. + +For instance, if `widget` is a textbox, to markup it call `widget:set_markup(...)` within `settings`. + +In the scope of `settings` you can use predefined arguments, which are specified in the wiki entries. + +Example of a lain widget: + +```lua +local cpu = lain.widget.cpu { + settings = function() + widget:set_markup("Cpu " .. cpu_now.usage) + end +} +-- to access the widget: cpu.widget +``` + +Given the asynchronous nature of these widgets, be sure to use a [defensive programming](https://github.com/lcpz/lain/issues/451#issuecomment-615450523) style when you write your configuration. You can find various examples of this in [awesome-copycats](https://github.com/lcpz/awesome-copycats). + +# Index + +- [alsa](https://github.com/lcpz/lain/wiki/alsa) +- [alsabar](https://github.com/lcpz/lain/wiki/alsabar) +- [bat](https://github.com/lcpz/lain/wiki/bat) +- [cal](https://github.com/lcpz/lain/wiki/cal) +- [cpu](https://github.com/lcpz/lain/wiki/cpu) +- [fs](https://github.com/lcpz/lain/wiki/fs) +- [imap](https://github.com/lcpz/lain/wiki/imap) +- [mem](https://github.com/lcpz/lain/wiki/mem) +- [mpd](https://github.com/lcpz/lain/wiki/mpd) +- [net](https://github.com/lcpz/lain/wiki/net) +- [pulse](https://github.com/lcpz/lain/wiki/pulse) +- [pulsebar](https://github.com/lcpz/lain/wiki/pulsebar) +- [sysload](https://github.com/lcpz/lain/wiki/sysload) +- [temp](https://github.com/lcpz/lain/wiki/temp) +- [weather](https://github.com/lcpz/lain/wiki/weather) + +## User contributions + +- [moc](https://github.com/lcpz/lain/wiki/moc) +- [redshift](https://github.com/lcpz/lain/wiki/redshift) +- [task](https://github.com/lcpz/lain/wiki/task) +- [tp_smapi](https://github.com/lcpz/lain/wiki/tp_smapi) diff --git a/lib/lain/wiki/_Footer.md b/lib/lain/wiki/_Footer.md new file mode 100644 index 0000000..b64f13b --- /dev/null +++ b/lib/lain/wiki/_Footer.md @@ -0,0 +1 @@ +[Home](https://github.com/lcpz/lain/wiki) • [Layouts](https://github.com/lcpz/lain/wiki/Layouts) • [Widgets](https://github.com/lcpz/lain/wiki/Widgets) • [Utilities](https://github.com/lcpz/lain/wiki/Utilities) diff --git a/lib/lain/wiki/_Sidebar.md b/lib/lain/wiki/_Sidebar.md new file mode 100644 index 0000000..0289783 --- /dev/null +++ b/lib/lain/wiki/_Sidebar.md @@ -0,0 +1,26 @@ +* [Home](https://github.com/lcpz/lain/wiki/Home) +* [Layouts](https://github.com/lcpz/lain/wiki/Layouts) + * [Usage](https://github.com/lcpz/lain/wiki/Layouts#Usage) + * [How do layouts work?](https://github.com/lcpz/lain/wiki/Layouts#how-do-layouts-work) + * [termfair](https://github.com/lcpz/lain/wiki/Layouts#termfair) + * [centerfair](https://github.com/lcpz/lain/wiki/Layouts#termfaircenter) + * [cascade](https://github.com/lcpz/lain/wiki/Layouts#cascade) + * [cascadetile](https://github.com/lcpz/lain/wiki/Layouts#cascadetile) + * [centerwork](https://github.com/lcpz/lain/wiki/Layouts#centerwork) + * [centerworkh](https://github.com/lcpz/lain/wiki/Layouts#centerworkhorizontal) + * [Pre 4.0 uselesstile patches](https://github.com/lcpz/lain/wiki/Layouts#pre-40-uselesstile-patches) + * [What about layout icons?](https://github.com/lcpz/lain/wiki/Layouts#what-about-layout-icons) +* [Widgets](https://github.com/lcpz/lain/wiki/Widgets) + * [Usage](https://github.com/lcpz/lain/wiki/Widgets#usage) + * [Index](https://github.com/lcpz/lain/wiki/Widgets#index) + * [Users contributed](https://github.com/lcpz/lain/wiki/Widgets#users-contributed) +* [Utilities](https://github.com/lcpz/lain/wiki/Utilities) + * [quake](https://github.com/lcpz/lain/wiki/Utilities#quake) + * [separators](https://github.com/lcpz/lain/wiki/Utilities#separators) + * [markup](https://github.com/lcpz/lain/wiki/Utilities#markup) + * [dynamic tagging](https://github.com/lcpz/lain/wiki/Utilities#dynamic-tagging) + * [useless_gaps_resize](https://github.com/lcpz/lain/wiki/Utilities#useless-gaps-resize) + * [tag_view_non_empty](https://github.com/lcpz/lain/wiki/Utilities#tag_view_nonempty) + * [magnify_client](https://github.com/lcpz/lain/wiki/Utilities#magnify_client) + * [menu_clients_current_tags](https://github.com/lcpz/lain/wiki/Utilities#menu_clients_current_tags) + * [menu_iterator](https://github.com/lcpz/lain/wiki/Utilities#menu_iterator) diff --git a/lib/lain/wiki/alsa.md b/lib/lain/wiki/alsa.md new file mode 100644 index 0000000..1418379 --- /dev/null +++ b/lib/lain/wiki/alsa.md @@ -0,0 +1,149 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows ALSA volume. + +```lua +local volume = lain.widget.alsa() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 5 +`cmd` | Alsa mixer command | string | "amixer" +`channel` | Mixer channel | string | "Master" +`togglechannel` | Toggle channel | string | `nil` +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +`cmd` is useful if you need to pass additional arguments to amixer. For instance, you may want to define `cmd = "amixer -c X"` in order to set amixer with card `X`. + +`settings` can use the following variables: + +Variable | Meaning | Type | Values +--- | --- | --- | --- +`volume_now.level` | Volume level | integer | 0-100 +`volume_now.status` | Device status | string | "on", "off" + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`channel` | ALSA channel | string +`update` | Update `widget` | function + +## Toggle channel + +In case mute toggling can't be mapped to master channel (this happens, for instance, when you are using an HDMI output), define togglechannel as your S/PDIF device. You can get the device ID with `scontents` command. + +For instance, if card number is 1 and S/PDIF number is 3: + +```shell +$ amixer -c 1 scontents +Simple mixer control 'Master',0 + Capabilities: volume + Playback channels: Front Left - Front Right + Capture channels: Front Left - Front Right + Limits: 0 - 255 + Front Left: 255 [100%] + Front Right: 255 [100%] +Simple mixer control 'IEC958',0 + Capabilities: pswitch pswitch-joined + Playback channels: Mono + Mono: Playback [on] +Simple mixer control 'IEC958',1 + Capabilities: pswitch pswitch-joined + Playback channels: Mono + Mono: Playback [on] +Simple mixer control 'IEC958',2 + Capabilities: pswitch pswitch-joined + Playback channels: Mono + Mono: Playback [on] +Simple mixer control 'IEC958',3 + Capabilities: pswitch pswitch-joined + Playback channels: Mono + Mono: Playback [on] +``` + +you have to set `togglechannel = "IEC958,3"`. + +## Buttons + +If you want buttons, just add the following after your widget in `rc.lua`. + +```lua +volume.widget:buttons(awful.util.table.join( + awful.button({}, 1, function() -- left click + awful.spawn(string.format("%s -e alsamixer", terminal)) + end), + awful.button({}, 2, function() -- middle click + os.execute(string.format("%s set %s 100%%", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 3, function() -- right click + os.execute(string.format("%s set %s toggle", volume.cmd, volume.togglechannel or volume.channel)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + os.execute(string.format("%s set %s 1%%+", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + os.execute(string.format("%s set %s 1%%-", volume.cmd, volume.channel)) + volume.update() + end) +)) +``` + +## Keybindings + +You can control the widget with keybindings like these: + +```lua +-- ALSA volume control +awful.key({ altkey }, "Up", + function () + os.execute(string.format("amixer set %s 1%%+", volume.channel)) + volume.update() + end), +awful.key({ altkey }, "Down", + function () + os.execute(string.format("amixer set %s 1%%-", volume.channel)) + volume.update() + end), +awful.key({ altkey }, "m", + function () + os.execute(string.format("amixer set %s toggle", volume.togglechannel or volume.channel)) + volume.update() + end), +awful.key({ altkey, "Control" }, "m", + function () + os.execute(string.format("amixer set %s 100%%", volume.channel)) + volume.update() + end), +awful.key({ altkey, "Control" }, "0", + function () + os.execute(string.format("amixer set %s 0%%", volume.channel)) + volume.update() + end), +``` + +where `altkey = "Mod1"`. + +### Muting with PulseAudio + +If you are using this widget in conjuction with PulseAudio, add the option `-D pulse` to the muting keybinding, like this: + +```lua +awful.key({ altkey }, "m", + function () + os.execute(string.format("amixer -D pulse set %s toggle", volume.togglechannel or volume.channel)) + volume.update() + end), +``` diff --git a/lib/lain/wiki/alsabar.md b/lib/lain/wiki/alsabar.md new file mode 100644 index 0000000..a986d8f --- /dev/null +++ b/lib/lain/wiki/alsabar.md @@ -0,0 +1,108 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows ALSA volume with a progressbar; provides tooltips and notifications. + +```lua +local volume = lain.widget.alsabar() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 5 +`settings` | User settings | function | empty function +`width` | Bar width | number | 63 +`height` | Bar height | number | 1 +`margins` | Bar margins | number | 1 +`paddings` | Bar paddings | number | 1 +`ticks` | Set bar ticks on | boolean | false +`ticks_size` | Ticks size | integer | 7 +`tick` | String for a notification tick | string | "|" +`tick_pre` | String for the left notification delimeter | string | "[" +`tick_post` | String for the right notification delimeter | string | "]" +`tick_none` | String for an empty notification tick | string | " " +`cmd` | ALSA mixer command | string | "amixer" +`channel` | Mixer channel | string | "Master" +`togglechannel` | Toggle channel | string | `nil` +`tick` | The character usef for ticks in the notification | string | "|" +`colors` | Bar colors | table | see [Default colors](https://github.com/lcpz/lain/wiki/alsabar#default-colors) +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/alsabar#default-notification_preset) +`followtag` | Display the notification on currently focused screen | boolean | false + +`cmd` is useful if you need to pass additional arguments to `amixer`. For instance, you may want to define `cmd = "amixer -c X"` in order to set amixer with card `X`. + +In case mute toggling can't be mapped to master channel (this happens, for instance, when you are using an HDMI output), define `togglechannel` as your S/PDIF device. Read [`alsa`](https://github.com/lcpz/lain/wiki/alsa#toggle-channel) page to know how. + +To set the maximum number of ticks to display in the notification, define `max_ticks` (integer) in `notification_preset`. + +`settings` can use the following variables: + +Variable | Meaning | Type | Values +--- | --- | --- | --- +`volume_now.level` | Volume level | integer | 0-100 +`volume_now.status` | Device status | string | "on", "off" + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +### Default colors + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`background` | Bar backgrund color | string | "#000000" +`mute` | Bar mute color | string | "#EB8F8F" +`unmute` | Bar unmute color | string | "#A4CE8A" + +### Default `notification_preset` + +```lua +notification_preset = { + font = "Monospace 10" +} +``` + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`bar` | The widget | `wibox.widget.progressbar` +`channel` | ALSA channel | string +`notify` | The notification | function +`update` | Update `bar` | function +`tooltip` | The tooltip | `awful.tooltip` + +## Buttons + +If you want buttons, just add the following after your widget in `rc.lua`. + +```lua +volume.bar:buttons(awful.util.table.join( + awful.button({}, 1, function() -- left click + awful.spawn(string.format("%s -e alsamixer", terminal)) + end), + awful.button({}, 2, function() -- middle click + os.execute(string.format("%s set %s 100%%", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 3, function() -- right click + os.execute(string.format("%s set %s toggle", volume.cmd, volume.togglechannel or volume.channel)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + os.execute(string.format("%s set %s 1%%+", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + os.execute(string.format("%s set %s 1%%-", volume.cmd, volume.channel)) + volume.update() + end) +)) +``` + +## Keybindings + +Read [here](https://github.com/lcpz/lain/wiki/alsa#keybindings). If you want notifications, use `volume.notify()` instead of `volume.update()`. diff --git a/lib/lain/wiki/bat.md b/lib/lain/wiki/bat.md new file mode 100644 index 0000000..4af8cdc --- /dev/null +++ b/lib/lain/wiki/bat.md @@ -0,0 +1,103 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows the remaining time and percentage capacity of your laptop battery, as well +as the current wattage. Multiple batteries are supported. + +Displays a notification when battery is fully charged, low, or critical. + +```lua +local mybattery = lain.widget.bat() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 30 +`pspath` | Power supply directory path | string | "/sys/class/power_supply/" +`battery` | Single battery id | string | autodetected +`batteries` | Multiple batteries id table | table of strings | autodetected +`ac` | AC | string | autodetected +`notify` | Show notification popups | string | "on" +`full_notify` | Show a notification popup when the battery's fully charged | string | inherited value from `notify` +`n_perc` | Percentages assumed for critical and low battery levels | table of integers | `{5, 15}` +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +The widget will try to autodetect `battery`, `batteries` and `ac`. If something +goes wrong, you will have to define them manually. In that case, you only have +to define one between `battery` and `batteries`. If you have one battery, you +can either use `args.battery = "BAT*"` or `args.batteries = {"BAT*"}`, where `BAT*` +is the identifier of your battery in `pspath` (do not use it as a wildcard). +Of course, if you have multiple batteries, you need to use the latter option. + +To disable notifications, set `notify` to `"off"`. + +If you define `pspath`, **be sure** to not forget the final slash (/). + +`settings` can use the `bat_now` table, which contains the following strings: + +- `status`, general status ("N/A", "Discharging", "Charging", "Full"); +- `n_status[i]`, i-th battery status (like above); +- `ac_status`, AC-plug flag (0 if cable is unplugged, 1 if plugged, "N/A" otherwise); +- `perc`, total charge percentage (integer between 0 and 100 or "N/A"); +- `n_perc[i]`, i-th battery charge percentage (like above); +- `time`, time remaining until charge if charging, until discharge if discharging (HH:MM string or "N/A"); +- `watt`, battery watts (float with 2 decimals); +- `capacity`, remaining battery capacity in percent; +- `n_capacity[i]`, i-th battery remaining capacity (like above). + +and can modify the following three tables, which will be the preset for the naughty notifications: +* `bat_notification_charged_preset` (used if battery is fully charged and connected to AC) +* `bat_notification_low_preset` (used if battery charge level <= 15) +* `bat_notification_critical_preset` (used if battery charge level <= 5) + +Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for +the list of variables they can contain. Default definitions: + +```lua +bat_notification_charged_preset = { + title = "Battery full", + text = "You can unplug the cable", + timeout = 15, + fg = "#202020", + bg = "#CDCDCD" + } + +``` + +```lua +bat_notification_low_preset = { + title = "Battery low", + text = "Plug the cable!", + timeout = 15, + fg = "#202020", + bg = "#CDCDCD" +} +``` +```lua +bat_notification_critical_preset = { + title = "Battery exhausted", + text = "Shutdown imminent", + timeout = 15, + fg = "#000000", + bg = "#FFFFFF" +} +``` + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function + +The `update` function can be used to refresh the widget before `timeout` expires. + +## Note + +Alternatively, you can try the [`upower` recipe](https://awesomewm.org/recipes/watch). diff --git a/lib/lain/wiki/cal.md b/lib/lain/wiki/cal.md new file mode 100644 index 0000000..5b6e358 --- /dev/null +++ b/lib/lain/wiki/cal.md @@ -0,0 +1,83 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Creates a calendar notification that can be attached to widgets. + +This is a simpler but [faster](https://github.com/awesomeWM/awesome/issues/1861) +alternative to [`awful.widget.calendar_popup`](https://awesomewm.org/doc/api/classes/awful.widget.calendar_popup.html), which emulates UNIX's `cal`. + +```lua +local mycal = lain.widget.cal() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`attach_to` | List of widgets | table | empty table +`week_start` | First day of the week | integer | 2 (Monday) +`three` | Display three months spanning the date | boolean | false +`followtag` | Display the notification on currently focused screen | boolean | false +`week_number` | Display the week number | string ("none", "left" or "right") | "none" +`week_number_format` | Week number format | string | `"%3d \| "` for "left", `"\| %-3d"` for "right" +`icons` | Path to calendar icons | string | [icons/cal/white/](https://github.com/lcpz/lain/tree/master/icons/cal/white) +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/cal#default-notification_preset) + +Set `attach_to` as the list of widgets to which you want to attach the calendar, like this: + +```lua +local mycal = lain.widget.cal { + attach_to = { mywidget1, mywidget2, ... }, + -- [...] +} +``` + +For every widget in `attach_to`: + +- Left click / scroll down: switch to previous month. +- Middle click show current month. +- Right click / scroll up: switch to next month. + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +### Default `notification_preset` + +```lua +notification_preset = { + font = "Monospace 10", + fg = "#FFFFFF", + bg = "#000000" +} +``` + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`attach` | Attach the calendar to an input widget | function +`show` | Show calendar | function +`hide` | Hide calendar | function + +`attach` takes as argument any widget you want to attach the calendar to, while +`show` takes as optional argument an integer to indicate the seconds to timeout. + +## Keybinding + +```lua +awful.key({ altkey }, "c", function () mycal.show(7) end) +``` + +Where `altkey = "Mod1"`. + +## Notes + +* Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output. +* If you want to [disable notification icon](https://github.com/lcpz/lain/pull/351), set `icons = ""` in the input table. +* If you want to localise the calendar, put `os.setlocale(os.getenv("LANG"))` in your `rc.lua`. +* If you want to get notifications [only with mouse clicks](https://github.com/lcpz/lain/issues/320) on a given widget, use this code: + ```lua + yourwidget:disconnect_signal("mouse::enter", mycal.hover_on) + ``` diff --git a/lib/lain/wiki/cpu.md b/lib/lain/wiki/cpu.md new file mode 100644 index 0000000..d3dd6e5 --- /dev/null +++ b/lib/lain/wiki/cpu.md @@ -0,0 +1,31 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows the current CPU usage, both in general and per core. + +```lua +local mycpu = lain.widget.cpu() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 2 +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +`settings` can use these strings: + +* `cpu_now.usage`, the general use percentage; +* `cpu_now[i].usage`, the i-th core use percentage, with `i` starting from 1. + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function \ No newline at end of file diff --git a/lib/lain/wiki/fs.md b/lib/lain/wiki/fs.md new file mode 100644 index 0000000..a8b82aa --- /dev/null +++ b/lib/lain/wiki/fs.md @@ -0,0 +1,83 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows file systems informations. + +If a partition is given in input, a notification will be displayed when it is almost full. + +```lua +local mypartition = lain.widget.fs() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 600 +`partition` | (Optional) Partition to watch: a notification will be displayed when full | string | `nil` +`threshold` | Percentage threshold at which the notification is triggered | integer | 99 +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/fs#default-notification_preset) +`followtag` | Display the notification on currently focused screen | boolean | false +`showpopup` | Display popups with mouse hovering | string, possible values: "on", "off" | "on" +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +`settings` can use the table `fs_now`, which contains a string entry for each file system path available. For instance, root infos are located in the variable `fs_now["/"]`. Every entry in this table have the following variables: + +Variable | Meaning | Type +--- | --- | --- +`units` | (multiple of) units used | string ("Kb", "Mb", "Gb", and so on) +`percentage` | the used percentage | integer +`size` | size in `units` of the given fs | float +`used` | amount of space used in the given fs, expressed in `units` | float +`free` | amount of free space in the given fs, expressed in `units` | float + +Usage example: + +```lua +-- shows used (percentage) and remaining space in home partition +local fsroothome = lain.widget.fs({ + settings = function() + widget:set_text("/home: " .. fs_now["/home"].percentage .. "% (" .. + fs_now["/home"].free .. " " .. fs_now["/home"].units .. " left)") + end +}) +-- output example: "/home: 37% (239.4 Gb left)" +``` + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +### Default `notification_preset` + +```lua +notification_preset = { + font = "Monospace 10", + fg = "#FFFFFF", + bg = "#000000" +} +``` + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`show` | The notification | function + +You can display the notification with a key binding like this: + +```lua +awful.key({ altkey }, "h", function () mypartition.show(seconds, scr) end), +``` + +where ``altkey = "Mod1"`` and ``show`` arguments, both optionals, are: + +* `seconds`, notification time in seconds +* `scr`, screen which to display the notification in + +## Note + +Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output. diff --git a/lib/lain/wiki/imap.md b/lib/lain/wiki/imap.md new file mode 100644 index 0000000..5a17270 --- /dev/null +++ b/lib/lain/wiki/imap.md @@ -0,0 +1,116 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows mails count fetching over IMAP. + +```lua +local myimap = lain.widget.imap(args) +``` + +New mails are notified like this: + + +--------------------------------------------+ + | +---+ | + | |\ /| donald@disney.org has 3 new messages | + | +---+ | + +--------------------------------------------+ + +## Input table + +Required parameters are: + +Variable | Meaning | Type +--- | --- | --- +`server` | Mail server | string +`mail` | User mail | string +`password` | User password | string +`widget` | Widget to render | function | `wibox.widget.textbox` + +while the optional are: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`port` | IMAP port | integer | 993 +`timeout` | Refresh timeout (in seconds) | integer | 60 +`pwdtimeout` | Timeout for password retrieval function (see [here](https://github.com/lcpz/lain/wiki/imap#password-security)) | integer | 10 +`is_plain` | Define whether `password` is a plain password (true) or a command that retrieves it (false) | boolean | false +`followtag` | Notification behaviour | boolean | false +`notify` | Show notification popups | string | "on" +`settings` | User settings | function | empty function + +`settings` can use `imap_now` table, which contains the following non negative integers: + +- `["MESSAGES"]` +- `["RECENT"]` +- `["UNSEEN"]` + +example of fetch: `total = imap_now["MESSAGES"]`. For backwards compatibility, `settings` can also use `mailcount`, a pointer to `imap_now["UNSEEN"]`. + +Also, `settings` can modify `mail_notification_preset` table, which will be the preset for the naughty notifications. Check [here](https://awesomewm.org/apidoc/libraries/naughty.html#notify) for the list of variables it can contain. Default definition: + +```lua +mail_notification _preset = { + icon = "lain/icons/mail.png", + position = "top_left" +} +``` + +Note that `mailcount` and `imap_now` elements are equals to 0 either if there are no new mails or credentials are invalid, so make sure that your settings are correct. + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +You can have multiple instances of this widget at the same time. + +## Password security + +The reason why `is_plain` is false by default is to discourage the habit of storing passwords in plain. + +In general, when `is_plain == false`, `password` can be either a string, a table or a function: the widget will execute it asynchronously in the first two cases. + +### Using plain passwords + +You can set your password in plain like this: + +```lua +myimapcheck = lain.widget.imap { + is_plain = true, + password = "mymailpassword", + -- [...] +} +``` + +and you will have the same security provided by `~/.netrc`. + +### Using a password manager + +I recommend to use [spm](https://notabug.org/kl3/spm) or [pass](https://www.passwordstore.org). In this case, `password` has to be a function. Example stub: + +```lua +myimapcheck = lain.widget.imap { + password = function() + -- do your retrieval + return retrieved_password, try_again + end, + -- [...] +} +``` + +Where `retrieved_password` is the password retrieved from the manager, and `try_again` supports [DBus Secret Service](https://specifications.freedesktop.org/secret-service). + +The process flow is that the first `password()` call spawns the unlock prompt, then the second call retrieves the password. [Here](https://gist.github.com/lcpz/1854fc4320f4701957cd5309c8eed4a6) is an example of `password` function. + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function +`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) +`pwdtimer` | Password retrieval timer (available only if `password` is a function)| [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) + +The `update` function can be used to refresh the widget before `timeout` expires. + +You can use `timer` to start/stop the widget as you like. diff --git a/lib/lain/wiki/mem.md b/lib/lain/wiki/mem.md new file mode 100644 index 0000000..470908b --- /dev/null +++ b/lib/lain/wiki/mem.md @@ -0,0 +1,36 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows memory status in MiB, [like `top` and `free -h`](https://github.com/lcpz/lain/issues/271). + +```lua +local mymem = lain.widget.mem() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 2 +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +in `settings` you can use the following variables: + +Variable | Meaning | Type +--- | --- | --- +`mem_now.used` | Memory used (MiB) | string +`mem_now.swapused` | Swap memory used (MiB) | string +`mem_now.perc` | Memory percentage | int + +(See line 23-39 of [this file](https://github.com/lcpz/lain/blob/master/widget/mem.lua) for more potential variables.) + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function \ No newline at end of file diff --git a/lib/lain/wiki/moc.md b/lib/lain/wiki/moc.md new file mode 100644 index 0000000..6f68d4e --- /dev/null +++ b/lib/lain/wiki/moc.md @@ -0,0 +1,123 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +A widget for showing the current song track's information from MOC (Music On Console). + +```lua +local mymoc = lain.widget.contrib.moc() +``` + +Now playing songs are notified like this: + + +--------------------------------------------------------+ + | +-------+ | + | |/^\_/^\| Now playing | + | |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 | + | | '.o.' | Hammer Smashed Face (Radio Disney Version) | + | +-------+ | + +--------------------------------------------------------+ + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 1 +`music_dir` | Music directory | string | "~/Music" +`cover_size` | Album art notification size (both height and width) | integer | 100 +`cover_pattern` | Pattern for the album art file | string | `*\\.(jpg|jpeg|png|gif)`* +`default_art` | Default art | string | "" +`followtag` | Display the notification on currently focused screen | boolean | false +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +\* In Lua, "\\\\" means "\" escaped. + +Default `cover_pattern` definition will made the widget set the first jpg, jpeg, png or gif file found in the directory as the album art. + +Pay attention to case sensitivity when defining `music_dir`. + +`settings` can use `moc_now` table, which contains the following string values: + +- state (possible values: "PLAY", "PAUSE", "STOP") +- file +- artist +- title +- album +- elapsed (Time elapsed for the current track) +- total (The current track's total time) + +and can modify `moc_notification_preset` table, which will be the preset for the naughty notifications. Check [here](https://awesomewm.org/apidoc/libraries/naughty.html#notify) for the list of variables it can contain. Default definition: + +```lua +moc_notification_preset = { + title = "Now playing", + timeout = 6, + text = string.format("%s (%s) - %s\n%s", moc_now.artist, + moc_now.album, moc_now.elapsed, moc_now.title) +} +``` + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function +`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) + +The `update` function can be used to refresh the widget before `timeout` expires. + +You can use `timer` to start/stop the widget as you like. + +## Keybindings + +You can control the widget with key bindings like these: + +```lua +-- MOC control +awful.key({ altkey, "Control" }, "Up", + function () + os.execute("mocp -G") -- toggle + moc.update() + end), +awful.key({ altkey, "Control" }, "Down", + function () + os.execute("mocp -s") -- stop + moc.update() + end), +awful.key({ altkey, "Control" }, "Left", + function () + os.execute("mocp -r") -- previous + moc.update() + end), +awful.key({ altkey, "Control" }, "Right", + function () + os.execute("mocp -f") -- next + moc.update() + end), +``` + +where `altkey = "Mod1"`. + +If you don't use the widget for long periods and wish to spare CPU, you can toggle it with a keybinding like this: + +```lua +-- toggle MOC widget +awful.key({ altkey }, "0", + function () + local common = { text = "MOC widget ", position = "top_middle", timeout = 2 } + if moc.timer.started then + moc.timer:stop() + common.text = common.text .. markup.bold("OFF") + else + moc.timer:start() + common.text = common.text .. markup.bold("ON") + end + naughty.notify(common) + end), +``` diff --git a/lib/lain/wiki/mpd.md b/lib/lain/wiki/mpd.md new file mode 100644 index 0000000..9f614c0 --- /dev/null +++ b/lib/lain/wiki/mpd.md @@ -0,0 +1,182 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows MPD status. + +```lua +local mympd = lain.widget.mpd() +``` + +Now playing songs are notified like this: + + +--------------------------------------------------------+ + | +-------+ | + | |/^\_/^\| Now playing | + | |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 | + | | '.o.' | Hammer Smashed Face (Radio Disney Version) | + | +-------+ | + +--------------------------------------------------------+ + +**Note:** if MPD is turned off or not set correctly, the widget will constantly display "N/A" values. + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 2 +`password` | MPD password | string | "" +`host` | MPD server | string | "127.0.0.1" +`port` | MPD port | string | "6600" +`music_dir` | Music directory | string | "~/Music" +`cover_size` | Album art notification size (both height and width) | integer | 100 +`cover_pattern` | Pattern for the album art file | string | `*.(jpg\|jpeg\|png\|gif)$` +`default_art` | Default art | string | `nil` +`notify` | Show notification pop-ups | string | "on" +`followtag` | Notification behaviour | boolean | false +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +\* In Lua, "\\\\" means "\" escaped. + +The default `cover_pattern` definition will make the widget set the first JPG, JPEG, PNG or GIF file found in the directory as the album art. + +Pay attention to case sensitivity when defining `music_dir`. + +`settings` can use `mpd_now` table, which contains the following values: + +(**note:** the first four are boolean [flags](https://github.com/lcpz/lain/pull/205), the remaining are all strings) + +- random_mode +- single_mode +- repeat_mode +- consume_mode +- pls_pos (playlist position) +- pls_len (playlist length) +- state (possible values: "play", "pause", "stop") +- file +- artist +- title +- name +- album +- track +- genre +- date +- [time](https://github.com/lcpz/lain/pull/90) (length of current song, in seconds) +- [elapsed](https://github.com/lcpz/lain/pull/90) (elapsed time of current song, in seconds) +- volume + +And can modify `mpd_notification_preset` table, which will be the preset for the naughty notifications. Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the list of variables it can contain. Default definition: + +```lua +mpd_notification_preset = { + title = "Now playing", + timeout = 6, + text = string.format("%s (%s) - %s\n%s", mpd_now.artist, + mpd_now.album, mpd_now.date, mpd_now.title) +} +``` + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The textbox | `wibox.widget.textbox` +`update` | Update `widget` | function +`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) + +The `update` function can be used to refresh the widget before `timeout` expires. + +You can use `timer` to start/stop the widget as you like. + +## Key bindings + +You can control the widget with key bindings like these: + +```lua +-- MPD control +awful.key({ altkey, "Control" }, "Up", + function () + awful.spawn.with_shell("mpc toggle || ncmpc toggle || pms toggle") + mympd.update() + end), +awful.key({ altkey, "Control" }, "Down", + function () + awful.spawn.with_shell("mpc stop || ncmpc stop || pms stop") + mympd.update() + end), +awful.key({ altkey, "Control" }, "Left", + function () + awful.spawn.with_shell("mpc prev || ncmpc prev || pms prev") + mympd.update() + end), +awful.key({ altkey, "Control" }, "Right", + function () + awful.spawn.with_shell("mpc next || ncmpc next || pms next") + mympd.update() + end), +``` + +Where `altkey = "Mod1"`. + +If you don't use the widget for long periods and wish to spare CPU, you can toggle it with a key binding like this: + +```lua +-- disable MPD widget +awful.key({ altkey }, "0", + function () + local common = { + text = "MPD widget ", + position = "top_middle", + timeout = 2 + } + if mympd.timer.started then + mympd.timer:stop() + common.text = common.text .. markup.bold("OFF") + else + mympd.timer:start() + common.text = common.text .. markup.bold("ON") + end + naughty.notify(common) + end), +``` + +## Notes + +### Cover not showing in notifications + +If the cover file is existent but not showed in notifications, [try](https://github.com/lcpz/lain/issues/393) setting `music_dir` to a symlink of your music folder, rather than to a physical path. This can be easily done through +```shell +ln -s /the/real_path_to_your_music/ /home/username/Music +``` +However, this only applies if the music is stored outside your user-specific folder, for instance in an external partition. + +### Always use `set_markup` + +In `settings`, if you use `widget:set_text`, [it will ignore Pango markup](https://github.com/lcpz/lain/issues/258), so be sure to always use `widget:set_markup`. + +### Volume fade in toggling MPD + +If you want a fade in/out in toggling MPD, you can put [this script](https://gist.github.com/lcpz/76e315bc27c6cdf7edd5021964b88df1) in your local `bin` directory: + +```shell +$ curl https://gist.githubusercontent.com/lcpz/76e315bc27c6cdf7edd5021964b88df1/raw/97f7ba586418a4e07637cfbc91d2974278dfa623/mpd-fade -o ~/bin/mpc-fade +$ chmod +x ~/bin/mpc-fade +``` + +Set your 1% decrease/increase commands [here](https://gist.github.com/lcpz/76e315bc27c6cdf7edd5021964b88df1#file-mpd-fade-L8-L9), then use a key binding like this: + +```lua +-- MPD toggle with volume fading +awful.key({ "Shift" }, "Pause", + function() + awful.spawn.easy_async("mpc-fade 20 4", -- mpc-fade + function(stdout, stderr, reason, exit_code) + mympd.update() + end) + end), +``` diff --git a/lib/lain/wiki/net.md b/lib/lain/wiki/net.md new file mode 100644 index 0000000..4d0d508 --- /dev/null +++ b/lib/lain/wiki/net.md @@ -0,0 +1,117 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Monitors network interfaces and shows current traffic. + +```lua +local mynet = lain.widget.net() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 2 +`iface` | Network device(s) | string (single interface) or table of strings (multiple interfaces) | autodetected +`units` | Units | integer | 1024 (kilobytes) +`notify` | Display "no carrier" notifications | string | "on" +`wifi_state` | Get Wi-Fi connection status | string | "off" +`eth_state` | Get Ethernet connection status | string | "off" +`screen` | Notifications screen | integer | 1 +`format` | String format for output | string | "%.1f" +`settings` | User settings | function | empty function + +`iface` can be a string or an table of the form `{ "eth0", "eth1", ... }` containing a list of the devices to collect data on. + +If more than one device is included, `net_now.sent` and `net_now.received` will contain cumulative values over all given devices. +Use `net_now.devices["eth0"]` to access `sent`, `received`, `state` or `carrier` per device. + +Possible alternative values for `units` are 1 (byte) or multiple of 1024: 1024^2 (MB), 1024^3 (GB), and so on. + +If `notify = "off"` is set, the widget won't display a notification when there's no carrier. + +`settings` can use the following `iface` related strings: + +- `net_now.carrier` ("0", "1"); +- `net_now.state` ("up", "down"); +- `net_now.sent` and `net_now.received` (numbers) will be the sum across all specified interfaces; +- `net_now.devices["interface"]` contains the previous attributes for each detected interface. + +If `wifi_state = "on"` is set, `settings` can use the following extra strings attached to `net_now.devices["wireless interface"]`: +- `wifi` (true, false) indicates if the interface is connected to a network; +- `signal` (number) is the connection signal strength in dBm; + +If `eth_state = "on"` is set, `settings` can use the following extra string: `net_now.devices["ethernet interface"].ethernet`, which is a boolean indicating if an Ethernet connection's active. + +For compatibility reasons, if multiple devices are given, `net_now.carrier` and `net_now.state` correspond to the last interface in the `iface` table and should not be relied upon (deprecated). + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function +`get_devices` | Update the `iface` table | function + +## Notes + +### Setting `iface` manually + +If the widget [spawns a "no carrier" notification and you are sure to have an active network device](https://github.com/lcpz/lain/issues/102), then autodetection is probably not working. This may due to [your user privileges](https://github.com/lcpz/lain/issues/102#issuecomment-246470526). In this case you can set `iface` manually. You can see which device is **UP,LOWER_UP** with the following command: + +```shell +ip link show +``` +## Usage examples +### Two widgets for upload/download rates from the same `iface` + +```lua +local mynetdown = wibox.widget.textbox() +local mynetup = lain.widget.net { + settings = function() + widget:set_markup(net_now.sent) + mynetdown:set_markup(net_now.received) + end +} +``` +### Wi-Fi/Ethernet connection and signal strength indicator +```lua +local wifi_icon = wibox.widget.imagebox() +local eth_icon = wibox.widget.imagebox() +local net = lain.widget.net { + notify = "off", + wifi_state = "on", + eth_state = "on", + settings = function() + local eth0 = net_now.devices.eth0 + if eth0 then + if eth0.ethernet then + eth_icon:set_image(ethernet_icon_filename) + else + eth_icon:set_image() + end + end + + local wlan0 = net_now.devices.wlan0 + if wlan0 then + if wlan0.wifi then + local signal = wlan0.signal + if signal < -83 then + wifi_icon:set_image(wifi_weak_filename) + elseif signal < -70 then + wifi_icon:set_image(wifi_mid_filename) + elseif signal < -53 then + wifi_icon:set_image(wifi_good_filename) + elseif signal >= -53 then + wifi_icon:set_image(wifi_great_filename) + end + else + wifi_icon:set_image() + end + end + end +} +``` \ No newline at end of file diff --git a/lib/lain/wiki/pulse.md b/lib/lain/wiki/pulse.md new file mode 100644 index 0000000..c0c4333 --- /dev/null +++ b/lib/lain/wiki/pulse.md @@ -0,0 +1,136 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows and controls PulseAudio volume. + +```lua +local volume = lain.widget.pulse() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 5 +`devicetype` | PulseAudio device type | string ("sink", "source") | "sink" +`cmd` | PulseAudio command | string or function | see [here](https://github.com/lcpz/lain/blob/master/widget/pulse.lua#L25) +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +`cmd` is a terminal command to catch infos from current default device. You can redefine it, being sure that the ouput is something like this: + +```shell +* index: 0 + volume: front-left: 18340 / 28% / -33.18 dB, front-right: 18340 / 28% / -33.18 dB + muted: no + device.string = "front:1" +``` + +If your devices change dynamically, you can define it as a function which returns a command string. + +If `sed` doesn't work, you can try with `grep`: + +```lua +cmd = "pacmd list-" .. pulse.devicetype .. "s | grep -e $(pactl info | grep -e 'ink' | cut -d' ' -f3) -e 'volume: front' -e 'muted'" +``` + +### `settings` variables + +`settings` can use the following variables: + +Variable | Meaning | Type | Values +--- | --- | --- | --- +`volume_now.device` | Device name | string | device name or "N/A" +`volume_now.index` | Device index | string | >= "0" +`volume_now.muted` | Device mute status | string | "yes", "no", "N/A" +`volume_now.channel` | Device channels | table of string integers | `volume_now.channel[i]`, where `i >= 1` +`volume_now.left` | Front left sink level or first source | string | "0"-"100" +`volume_now.right` | Front right sink level or second source | string | "0"-"100" + +`volume_now.channel` is a table of your PulseAudio devices. Fetch a channel level like this: `volume_now.channel[i]`, where `i >= 1`. + +`volume_now.{left,right}` are pointers for `volume_now.{channel[1], channel[2]}` (stereo). + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function + +## Buttons + +```lua +volume.widget:buttons(awful.util.table.join( + awful.button({}, 1, function() -- left click + awful.spawn("pavucontrol") + end), + awful.button({}, 2, function() -- middle click + os.execute(string.format("pactl set-sink-volume %s 100%%", volume.device)) + volume.update() + end), + awful.button({}, 3, function() -- right click + os.execute(string.format("pactl set-sink-mute %s toggle", volume.device)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + os.execute(string.format("pactl set-sink-volume %s +1%%", volume.device)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + os.execute(string.format("pactl set-sink-volume %s -1%%", volume.device)) + volume.update() + end) +)) +``` + +## Keybindings + +```lua +-- PulseAudio volume control +awful.key({ altkey }, "Up", + function () + os.execute(string.format("pactl set-sink-volume %s +1%%", volume.device)) + volume.update() + end), +awful.key({ altkey }, "Down", + function () + os.execute(string.format("pactl set-sink-volume %s -1%%", volume.device)) + volume.update() + end), +awful.key({ altkey }, "m", + function () + os.execute(string.format("pactl set-sink-mute %s toggle", volume.device)) + volume.update() + end), +awful.key({ altkey, "Control" }, "m", + function () + os.execute(string.format("pactl set-sink-volume %s 100%%", volume.device)) + volume.update() + end), +awful.key({ altkey, "Control" }, "0", + function () + os.execute(string.format("pactl set-sink-volume %s 0%%", volume.device)) + volume.update() + end), +``` + +where `altkey = "Mod1"`. + +## Example + +```lua +-- PulseAudio volume (based on multicolor theme) +local volume = lain.widget.pulse { + settings = function() + vlevel = volume_now.left .. "-" .. volume_now.right .. "% | " .. volume_now.device + if volume_now.muted == "yes" then + vlevel = vlevel .. " M" + end + widget:set_markup(lain.util.markup("#7493d2", vlevel)) + end +} +``` diff --git a/lib/lain/wiki/pulsebar.md b/lib/lain/wiki/pulsebar.md new file mode 100644 index 0000000..de3a475 --- /dev/null +++ b/lib/lain/wiki/pulsebar.md @@ -0,0 +1,98 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows PulseAudio volume with a progressbar; provides tooltips and notifications. + +```lua +local volume = lain.widget.pulsebar() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 5 +`settings` | User settings | function | empty function +`width` | Bar width | number | 63 +`height` | Bar height | number | 1 +`margins` | Bar margins | number | 1 +`paddings` | Bar paddings | number | 1 +`ticks` | Set bar ticks on | boolean | false +`ticks_size` | Ticks size | number | 7 +`tick` | String for a notification tick | string | "|" +`tick_pre` | String for the left notification delimeter | string | "[" +`tick_post` | String for the right notification delimeter | string | "]" +`tick_none` | String for an empty notification tick | string | " " +`scallback` | [PulseAudio sink callback](https://github.com/lcpz/lain/wiki/pulseaudio/) | function | `nil` +`sink` | Mixer sink | number | 0 +`colors` | Bar colors | table | see [Default colors](https://github.com/lcpz/lain/wiki/pulsebar#default-colors) +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/pulsebar#default-notification_preset) +`followtag` | Display the notification on currently focused screen | boolean | false +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/pulsebar#default-notification_preset) +`devicetype` | PulseAudio device type | string ("sink", "source") | "sink" +`cmd` | PulseAudio command | string or function | see [here](https://github.com/lcpz/lain/blob/master/widget/pulsebar.lua#L48) + +Read [pulse](https://github.com/lcpz/lain/wiki/pulse) page for `cmd` settings. + +`settings` can use [these variables](https://github.com/lcpz/lain/wiki/pulse#settings-variables). + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +### Default colors + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`background` | Bar backgrund color | string | "#000000" +`mute` | Bar mute color | string | "#EB8F8F" +`unmute` | Bar unmute color | string | "#A4CE8A" + +### Default `notification_preset` + +```lua +notification_preset = { + font = "Monospace 10" +} +``` + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`bar` | The widget | `wibox.widget.progressbar` +`device` | PulseAudio device | string +`notify` | The notification | function +`update` | Update state | function +`tooltip` | The tooltip | `awful.tooltip` + +## Buttons + +```lua +volume.bar:buttons(awful.util.table.join( + awful.button({}, 1, function() -- left click + awful.spawn("pavucontrol") + end), + awful.button({}, 2, function() -- middle click + os.execute(string.format("pactl set-sink-volume %d 100%%", volume.device)) + volume.update() + end), + awful.button({}, 3, function() -- right click + os.execute(string.format("pactl set-sink-mute %d toggle", volume.device)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + os.execute(string.format("pactl set-sink-volume %d +1%%", volume.device)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + os.execute(string.format("pactl set-sink-volume %d -1%%", volume.device)) + volume.update() + end) +)) +``` + +## Keybindings + +Same as [here](https://github.com/lcpz/lain/wiki/pulse#keybindings). If you want notifications, use `volume.notify()` instead of `volume.update()`. diff --git a/lib/lain/wiki/redshift.md b/lib/lain/wiki/redshift.md new file mode 100644 index 0000000..ea6f637 --- /dev/null +++ b/lib/lain/wiki/redshift.md @@ -0,0 +1,103 @@ +### What is Redshift? # + +[**Project homepage**](http://jonls.dk/redshift/) + +>**Redshift** is an application that adjusts the computer display's color temperature based upon the Sun's apparent position in relation to the user's location on Earth. +> +>The program is free software, inspired by the proprietary f.lux, and can be used to reduce eye strain as well as insomnia and delayed sleep phase syndrome. +> +>The computer display's color temperature transitions evenly from night to daytime temperature to allow the user's eyes to slowly adapt. At night, the color temperature is low and is typically 3000–4000 K (default is 3500 K), preferably matching the room's lighting temperature. Typical color temperature during the daytime is 5500–6500 K (default is 5500 K). + +**Source:** [Wikipedia](https://en.wikipedia.org/wiki/Redshift_%28software%29) + +### Preparations + +**Redshift must be installed** on your system if you want to use this widget. + +Packages should be available for most distributions. Source code and build instructions can be found on Github [here](https://github.com/jonls/redshift). + +You also need a valid config file. Please see the [project homepage](http://jonls.dk/redshift/) for details. An example: [`~/.config/redshift.conf`](https://github.com/jonls/redshift/blob/master/redshift.conf.sample). + +You have to match the location settings to your personal situation: you can adjust the `lat` and `lon` variables using a [web service](https://encrypted.google.com/search?q=get+latitude+and+longitude). + +You might also want to modify the color temperatures to fit your preferences. + +### Using the widget + +This widget provides the following functions: + +| function | meaning | +| --- | --- | +| `redshift.toggle()` | Toggles Redshift adjustments on or off, and also restarts it if terminates. | +| `redshift.attach(widget, update_function)` | Attach to a widget. Click on the widget to toggle redshift on or off. `update_function` is a callback function which will be triggered each time Redshift changes its status. (See the examples below.) | + +### Usage examples + +#### Textbox status widget + +```lua +myredshift = wibox.widget.textbox() +lain.widget.contrib.redshift.attach( + myredshift, + function (active) + if active then + myredshift:set_text("RS on") + else + myredshift:set_text("RS off") + end + end +) +``` + +Then add `myredshift` to your wibox. + +#### Checkbox status widget + +```lua +local markup = lain.util.markup + +local myredshift = wibox.widget{ + checked = false, + check_color = "#EB8F8F", + border_color = "#EB8F8F", + border_width = 1, + shape = gears.shape.square, + widget = wibox.widget.checkbox +} + +local myredshift_text = wibox.widget{ + align = "center", + widget = wibox.widget.textbox, +} + +local myredshift_stack = wibox.widget{ + myredshift, + myredshift_text, + layout = wibox.layout.stack +} + +lain.widget.contrib.redshift.attach( + myredshift, + function (active) + if active then + -- rename 'beautiful' to 'theme' if using awesome-copycats + myredshift_text:set_markup(markup(beautiful.bg_normal, "R")) + else + -- rename 'beautiful' to 'theme' if using awesome-copycats + myredshift_text:set_markup(markup(beautiful.fg_normal, "R")) + end + myredshift.checked = active + end +) +``` + +Then add `myredshift_stack` to your wibox. + +#### Keybinding + +Add this to the keybindings in your `rc.lua`: + +```lua +-- Toggle Redshift with Mod+Shift+t +awful.key({ modkey, "Shift" }, "t", function () lain.widget.contrib.redshift.toggle() end), +``` diff --git a/lib/lain/wiki/sysload.md b/lib/lain/wiki/sysload.md new file mode 100644 index 0000000..5ed4c97 --- /dev/null +++ b/lib/lain/wiki/sysload.md @@ -0,0 +1,28 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows the current system load. + +```lua +mysysload = lain.widget.sysload() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 2 +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +`settings` can use strings `load_1`, `load_5` and `load_15`, which are the load averages over 1, 5, and 15 minutes. + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function \ No newline at end of file diff --git a/lib/lain/wiki/task.md b/lib/lain/wiki/task.md new file mode 100644 index 0000000..af53a6a --- /dev/null +++ b/lib/lain/wiki/task.md @@ -0,0 +1,51 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Attaches a [taskwarrior](http://taskwarrior.org) notifications to a widget, and lets you execute `task` commands from the promptbox. + +```lua +lain.widget.contrib.task.attach(widget, args) +``` + +`args` is an optional table which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`show_cmd` | Taskwarrior command to show in the popup | string | "task next" +`prompt_text` | Prompt text | string | "Enter task command: " +`followtag` | Display the notification on currently focused screen | boolean | false +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/task#default-notification_preset) + +The tasks are shown in a notification popup when the mouse is moved over the attached `widget`, and the popup is hidden when the mouse is moved away. By default, the notification will show the output of `task next`. With `show_cmd`, the `task` popup command can be customized, for example if you want to [filter the tasks](https://taskwarrior.org/docs/filter.html) or show a [custom report](https://github.com/lcpz/lain/pull/213). + +With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +You can call the notification with a keybinding like this: + +```lua +awful.key({ modkey, altkey }, "t", function () lain.widget.contrib.task.show(scr) end), +``` + +where ``altkey = "Mod1"`` and `scr` (optional) indicates the screen which you want the notification in. + +And you can prompt to input a `task` command with a keybinding like this: + +```lua +awful.key({ altkey }, "t", lain.widget.contrib.task.prompt), +``` + +### Default `notification_preset` + +```lua +notification_preset = { + font = "Monospace 10", + icon = helpers.icons_dir .. "/taskwarrior.png" +} +``` + +## Note + +* If your widget does not display `task next` output, try changing Taskwarrior verbose, for instance: `show_cmd = 'task rc.verbose:label'` or `show_cmd = 'task rc.verbose:nothing'`. \ No newline at end of file diff --git a/lib/lain/wiki/temp.md b/lib/lain/wiki/temp.md new file mode 100644 index 0000000..a4f8161 --- /dev/null +++ b/lib/lain/wiki/temp.md @@ -0,0 +1,37 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows the current CPU temperature. + +```lua +local mytemp = lain.widget.temp() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 30 +`tempfile` | Path of file which stores core temperature value | string | "/sys/devices/virtual/thermal/thermal_zone0/temp" +`settings` | User settings | function | empty function +`format` | String format for output | string | "%.1f" +`widget` | Widget to render | function | `wibox.widget.textbox` + +`settings` can use the string `coretemp_now`, which contains the info retrieved from `tempfile`, and the table `temp_now`, which contains an entry for each `*temp*` file in each directory in the following paths: + +```shell +/sys/class/devices/virtual/thermal/thermal_zone* +/sys/class/devices/platform/coretemp*/hwmon/hwon* +``` + +All values are expressed in Celsius (GNU/Linux standard). + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function diff --git a/lib/lain/wiki/tp_smapi.md b/lib/lain/wiki/tp_smapi.md new file mode 100644 index 0000000..3fa8adf --- /dev/null +++ b/lib/lain/wiki/tp_smapi.md @@ -0,0 +1,104 @@ +# Description + +[`tp_smapi`](http://www.thinkwiki.org/wiki/Tp_smapi) interface and widget creator. + +```lua +local tp_smapi = lain.widget.contrib.tp_smapi(apipath) +``` + +The argument `apipath` is an optional string which defines the API path. Its default value is `"/sys/devices/platform/smapi"`. + +# Functions + +## tp_smapi.get(batid, feature) + +Gets the `feature` of battery `batid`. Returns a string. The list of available features is available at [this page](https://www.thinkwiki.org/wiki/Tp_smapi#Battery_status_features). + +## tp_smapi.installed(batid) + +Checks if battery `batid` is installed. Returns a boolean. + +## tp_smapi.status(batid) + +Gets the status of battery `batid`. Returns a string ("charging", "discharging", or "full"). + +## tp_smapi.percentage(batid) + +Gets the percentage of battery `batid`. Returns a numeric string. + +## tp_smapi.time(batid) + +Gets the time of battery `batid`. Depending on the current status, it can be either running or charging time. Returns a string of the format `HH:MM`. + +## tp_smapi.hide() + +Removes any notification spawned by `tp_smapi.show`. + +## tp_smapi.show(batid, seconds, scr) + +Notifies the current information of battery `batid` for `seconds` seconds on screen `scr`. +The argument `scr` is optional, and if missing, the notification will be displayed on the currently focused screen. + +## tp_smapi.create_widget(args) + +Creates a [lain widget](https://github.com/lcpz/lain/wiki/Widgets#usage) of the available ThinkPad batteries. + +```lua +local tpbat = tp_smapi.create_widget() +``` + +### Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`widget` | The widget type to use | [`wibox.widget`](https://awesomewm.org/doc/api/classes/wibox.widget.html) | [`wibox.widget.textbox`](https://awesomewm.org/doc/api/classes/wibox.widget.textbox.html) +`timeout` | Refresh timeout (in seconds) | integer | 30 +`pspath` | Power supply directory path | string | "/sys/class/power_supply/" +`battery` | Single battery id | string | autodetected +`batteries` | Multiple batteries id table | table of strings | autodetected +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +The widget will try to autodetect `battery` and `batteries`. If something +goes wrong, you will have to define them manually. In that case, you only have +to define one between `battery` and `batteries`. If you have one battery, you +can either use `args.battery = "BAT*"` or `args.batteries = {"BAT*"}`, where `BAT*` +is the identifier of your battery in `pspath` (do not use it as a wildcard). +Of course, if you have multiple batteries, you need to use the latter option. + +If you define `pspath`, **be sure** to not forget the final slash (/). + +`settings` can use the `tpbat_now` table, which contains the following strings: + +- `status`, general status ("N/A", "discharging", "charging", "full"); +- `n_status[i]`, i-th battery status (like above); +- `n_perc[i]`, i-th battery charge percentage (like above); +- `n_time[i]`, i-th battery running or charging time (HH:MM string or "N/A"); + +`n_time[i]` is the running time of battery `i` when it is discharging, and the charging time otherwise. + +### Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | [`wibox.widget`](https://awesomewm.org/doc/api/classes/wibox.widget.html) | [textbox](https://awesomewm.org/doc/api/classes/wibox.widget.textbox.html) +`batteries` | Battery identifiers | Table of strings +`update` | Update `widget` | function +`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) + +The `update` function can be used to refresh the widget before `timeout` expires. + +### Usage example + +```lua +local tp_smapi = lain.widget.contrib.tp_smapi() +local bat = tp_smapi.create_widget { + battery = "BAT0", + settings = function() + widget:set_markup(tpbat_now.n_perc[1] .. "%") + end +} + +bat.widget:connect_signal("mouse::enter", function () tp_smapi.show("BAT0") end) +bat.widget:connect_signal("mouse::leave", function () tp_smapi.hide() end) +``` diff --git a/lib/lain/wiki/watch.md b/lib/lain/wiki/watch.md new file mode 100644 index 0000000..ff18a5c --- /dev/null +++ b/lib/lain/wiki/watch.md @@ -0,0 +1,222 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Template for asynchronous watcher widgets. + +Executes an input command and makes the user feed a `wibox.widget` with the output. + +```lua +local mywatch = lain.widget.watch() +``` + +This has been implemented in Awesome 4.0 as [`awful.widget.watch`](https://awesomewm.org/doc/api/classes/awful.widget.watch.html). But while Awesome `watch` returns only the widget, Lain one returns a table including its timer and internal update function too. + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`widget` | Widget to feed | `wibox.widget` | `wibox.widget.textbox` +`timeout` | Refresh timeout seconds | number | 5 +`cmd` | The command to execute | string **or** table | `nil` +`nostart` | Widget timer doesn't start immediately | boolean | false +`stoppable` | Widget timer is stoppable | boolean | false +`settings` | User settings | function | see [Default `settings` function](https://github.com/lcpz/lain/wiki/watch#default-settings-function) + +If your command needs a shell, you need to set `cmd` as an array of 3 strings, where the first contains the shell, the second contains `-c`, and the third contains the actual command. Example: + +```lua +cmd = { awful.util.shell, "-c", "myactualcommand" } +``` + +`settings` can use the string `output`, which is the output of `cmd`. + +### Default `settings` function + +```lua +settings = function() widget:set_text(output) end +``` +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | input widget type or `wibox.widget.textbox` +`update` | Update `widget` | function +`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) or `nil` + +The `update` function can be used to refresh the widget before `timeout` expires. + +If `stoppable == true`, the widget will have an ad-hoc timer, which you can control though `timer` variable. + +## Use case examples + +### bitcoin + +```lua +-- Bitcoin to USD current price, using Coinbase V1 API +local bitcoin = lain.widget.watch({ + timeout = 43200, -- half day + stoppable = true, + cmd = "curl -m5 -s 'https://coinbase.com/api/v1/prices/buy'", + settings = function() + local btc, pos, err = require("lain.util").dkjson.decode(output, 1, nil) + local btc_price = (not err and btc and btc["subtotal"]["amount"]) or "N/A" + + -- customize here + widget:set_text(btc_price) + end +}) +``` + +### btrfs + +```lua +-- btrfs root df +local myrootfs = lain.widget.watch({ + timeout = 600, + cmd = "btrfs filesystem df -g /", + settings = function() + local total, used = string.match(output, "Data.-total=(%d+%.%d+)GiB.-used=(%d+%.%d+)GiB") + local percent_used = math.ceil((tonumber(used) / tonumber(total)) * 100) + + -- customize here + widget:set_text(" [/: " .. percent_used .. "%] ") + end +}) +``` + +### cmus + +```lua +-- cmus audio player +local cmus = lain.widget.watch({ + timeout = 2, + stoppable = true, + cmd = "cmus-remote -Q", + settings = function() + local cmus_now = { + state = "N/A", + artist = "N/A", + title = "N/A", + album = "N/A" + } + + for w in string.gmatch(output, "(.-)tag") do + a, b = w:match("(%w+) (.-)\n") + cmus_now[a] = b + end + + -- customize here + widget:set_text(cmus_now.artist .. " - " .. cmus_now.title) + end +}) +``` + +### maildir + +```lua +-- checks whether there are files in the "new" directories of a mail dirtree +local mailpath = "~/Mail" +local mymaildir = lain.widget.watch({ + timeout = 60, + stoppable = true, + cmd = { awful.util.shell, "-c", string.format("ls -1dr %s/*/new/*", mailpath) }, + settings = function() + local inbox_now = { digest = "" } + + for dir in output:gmatch(".-/(%w+)/new") do + inbox_now[dir] = 1 + for _ in output:gmatch(dir) do + inbox_now[dir] = inbox_now[dir] + 1 + end + if #inbox_now.digest > 0 then inbox_now.digest = inbox_now.digest .. ", " end + inbox_now.digest = inbox_now.digest .. string.format("%s (%d)", dir, inbox_now[dir]) + end + + -- customize here + widget:set_text("mail: " .. inbox_now.digest) + end +}) +``` + +### mpris + +```lua +-- infos from mpris clients such as spotify and VLC +-- based on https://github.com/acrisci/playerctl +local mpris = lain.widget.watch({ + cmd = "playerctl status && playerctl metadata", + timeout = 2, + stoppable = true, + settings = function() + local escape_f = require("awful.util").escape + local mpris_now = { + state = "N/A", + artist = "N/A", + title = "N/A", + art_url = "N/A", + album = "N/A", + album_artist = "N/A" + } + + mpris_now.state = string.match(output, "Playing") or + string.match(output, "Paused") or "N/A" + + for k, v in string.gmatch(output, "'[^:]+:([^']+)':[%s]<%[?'([^']+)'%]?>") + do + if k == "artUrl" then mpris_now.art_url = v + elseif k == "artist" then mpris_now.artist = escape_f(v) + elseif k == "title" then mpris_now.title = escape_f(v) + elseif k == "album" then mpris_now.album = escape_f(v) + elseif k == "albumArtist" then mpris_now.album_artist = escape_f(v) + end + end + + -- customize here + widget:set_text(mpris_now.artist .. " - " .. mpris_now.title) + end +}) +``` + +### upower + +```lua +-- battery infos from freedesktop upower +local mybattery = lain.widget.watch({ + timeout = 30, + cmd = { awful.util.shell, "-c", "upower -i /org/freedesktop/UPower/devices/battery_BAT | sed -n '/present/,/icon-name/p'" }, + settings = function() + local bat_now = { + present = "N/A", + state = "N/A", + warninglevel = "N/A", + energy = "N/A", + energyfull = "N/A", + energyrate = "N/A", + voltage = "N/A", + percentage = "N/A", + capacity = "N/A", + icon = "N/A" + } + + for k, v in string.gmatch(output, '([%a]+[%a|-]+):%s*([%a|%d]+[,|%a|%d]-)') do + if k == "present" then bat_now.present = v + elseif k == "state" then bat_now.state = v + elseif k == "warning-level" then bat_now.warninglevel = v + elseif k == "energy" then bat_now.energy = string.gsub(v, ",", ".") -- Wh + elseif k == "energy-full" then bat_now.energyfull = string.gsub(v, ",", ".") -- Wh + elseif k == "energy-rate" then bat_now.energyrate = string.gsub(v, ",", ".") -- W + elseif k == "voltage" then bat_now.voltage = string.gsub(v, ",", ".") -- V + elseif k == "percentage" then bat_now.percentage = tonumber(v) -- % + elseif k == "capacity" then bat_now.capacity = string.gsub(v, ",", ".") -- % + elseif k == "icon-name" then bat_now.icon = v + end + end + + -- customize here + widget:set_text("Bat: " .. bat_now.percentage .. " " .. bat_now.state) + end +}) +``` diff --git a/lib/lain/wiki/weather.md b/lib/lain/wiki/weather.md new file mode 100644 index 0000000..6052156 --- /dev/null +++ b/lib/lain/wiki/weather.md @@ -0,0 +1,133 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Provides current weather status widgets and X-days forecast pop-up notifications. + +Powered by OpenWeatherMap. Obtain a free API key [here](http://openweathermap.org/api) and set it as the `APPID` argument. + +By default, it uses [current](http://openweathermap.org/current) for current weather data and [forecast16](http://openweathermap.org/forecast16) for forecasts. + +```lua +local myweather = lain.widget.weather() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`APPID` | API key | String | `nil` +`timeout` | Refresh timeout seconds for current weather status | number | 900 (15 min) +`current_call` | Command to fetch weather status data from the API | string | see `default_current_call` +`forecast_call` | Command to fetch forecast data from the API | string | see `default_forecast_call` +`city_id` | API city code | number | not set +`units` | Temperature units system | string | "metric" +`lang` | API data localization | string | "en" +`cnt` | Forecast days interval | integer | 5 +`icons_path` | Icons path | string | `lain/icons/openweathermap` +`notification_preset` | Preset for notifications | table | empty table +`notification_text_fun` | Function to format forecast notifications | function | see `notification_text_fun` below +`weather_na_markup` | Markup to be used when weather textbox is not available | text | " N/A " +`followtag` | Display the notification on currently focused screen | boolean | false +`showpopup` | Display popups with mouse hovering | string, possible values: "on", "off" | "on" +`settings` | User settings | function | empty function +`widget` | Widget to render | function | `wibox.widget.textbox` + +- ``default_current_call`` + + `"curl -s 'http://api.openweathermap.org/data/2.5/weather?id=%s&units=%s&lang=%s&APPID=%s'"` + + You can rewrite it using any fetcher solution you like, or you can modify it in order to fetch data by city name, instead of ID: just replace `id` with `q`: + + `"curl -s 'http://api.openweathermap.org/data/2.5/weather?q=%s&units=%s&lang=%s&APPID=%s'"` + + and set `city_id` with your city name, for instance `city_id = "London,UK"`. + +- ``default_forecast_call`` + + `"curl -s 'http://api.openweathermap.org/data/2.5/forecast/daily?id=%s&units=%s&lang=%s&APPID=%s'"` + + Like above. + +- ``city_id`` + + An integer that defines the OpenWeatherMap ID code of your city. + To obtain it go to [OpenWeatherMap](http://openweathermap.org/) and query for your city in the top search bar. The link will look like this: + + http://openweathermap.org/city/2643743 + + your `city_id` is the number at the end. + +- ``units`` + + - For temperature in Fahrenheit use `units = "imperial"` + - For temperature in Celsius use `units = "metric"` (Lain default) + - For temperature in Kelvin use `units = "standard"` (OpenWeatherMap default) + +- ``lang`` + + See *Multilingual Support* section [here](http://openweathermap.org/current). + +- ``icons_path`` + + You can set your own icons path if you don't wish to use `lain/icons/openweathermap`. Just be sure that your icons are PNGs and named exactly like [OpenWeatherMap ones](http://openweathermap.org/weather-conditions). + +- ``notification_preset`` + + Notifications preset table. See [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the details. + +- ``notification_text_fun`` + ```lua + function (wn) + local day = os.date("%a %d", wn["dt"]) + local temp = math.floor(wn["main"]["temp"]) + local desc = wn["weather"][1]["description"] + + return string.format("%s: %s, %d ", day, desc, temp) + end + ``` + +- ``followtag`` + + With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen. + +- ``settings`` + + In your `settings` function, you can use `widget` variable to refer to the textbox, and the dictionary `weather_now` to refer to data retrieved by `current_call`. The dictionary is built with [dkjson library](http://dkolf.de/src/dkjson-lua.fsl/home), and its structure is defined [here](http://openweathermap.org/weather-data). + For instance, you can retrieve current weather status and temperature in this way: + ```lua + descr = weather_now["weather"][1]["description"]:lower() + units = math.floor(weather_now["main"]["temp"]) + ``` + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`icon` | The icon | `wibox.widget.imagebox` +`update` | Update `widget` | function +`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) +`timer_forecast` | The forecast notification timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html) + +## Functions + +You can attach the forecast notification to any widget like this: + +```lua +myweather.attach(obj) +``` + +Hovering over ``obj`` will display the notification. + +## Key bindings + +You can create a key binding for the weather pop-up like this: + +```lua +awful.key( { "Mod1" }, "w", function () myweather.show(5) end ) +``` + +Where the ``show`` argument is an integer defining timeout seconds. diff --git a/rc.lua b/rc.lua new file mode 100644 index 0000000..191c6ba --- /dev/null +++ b/rc.lua @@ -0,0 +1,49 @@ +local naughty = require('naughty') +local beautiful = require('beautiful') + +if awesome.startup_errors then + naughty.notify({ + preset = naughty.config.presets.critical, + title = 'Oops, there were errors during startup!', + text = awesome.startup_errors, + }) +end + +do + local in_error = false + + awesome.connect_signal('debug::error', function(err) + if in_error then return end + in_error = true + naughty.notify({ + preset = naughty.config.presets.critical, + title = 'Oops, an error happened!', + text = tostring(err), + }) + in_error = false + end) +end + +local conf_dir = require('src.util.path').conf_dir +package.path = (conf_dir .. '/lib/?/init.lua;') .. (conf_dir .. '/lib/?.lua;') .. package.path +package.cpath = (conf_dir .. '/build/?.so;') .. package.cpath + +require('awful.autofocus') +require('src.layouts') +require('src.client') +beautiful.init(require('src.theme')) +root.keys(require('src.global_keys')) + +screen.connect_signal('arrange', function(s) + local only_one = #s.tiled_clients == 1 + for _, c in pairs(s.clients) do + if c.no_border or (only_one and not c.floating or c.maximized or c.fullscreen) then + c.border_width = 0 + else + c.border_width = beautiful.border_width + end + end +end) + +local on_screen_connect = require('src.theme.screen') +require('awful').screen.connect_for_each_screen(function(s) on_screen_connect(s) end) diff --git a/rofi/everforest.rasi b/rofi/everforest.rasi new file mode 100644 index 0000000..a22321f --- /dev/null +++ b/rofi/everforest.rasi @@ -0,0 +1,26 @@ +/** + * + * Author : Aditya Shakya (adi1090x) + * Github : @adi1090x + * + * Colors + **/ + +/* +* { + background: #323D43FF; + background-alt: #3C474DFF; + foreground: #DAD1BEFF; + selected: #7FBBB3FF; + active: #A7C080FF; + urgent: #E67E80FF; +} +*/ +* { + background: #2b3339; + background-alt: #323d43; + foreground: #a7c080; + selected: #7fbbb3; + active: #a7c080; + urgent: #e67e80; +} diff --git a/rofi/kaomoji.sh b/rofi/kaomoji.sh new file mode 100755 index 0000000..ad1b488 --- /dev/null +++ b/rofi/kaomoji.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +current_wid=$(xdo id) +selection=$(rofi -i -dmenu -theme-str 'listview{columns: 6; lines: 11;}' -theme-str 'window {fullscreen: true;}' $@ < $(dirname $0)/kaomoji.txt) +kaomoji=$(echo $selection | sed "s|$(echo -e "\ufeff").*||") +echo -n "$kaomoji" | xclip -selection clipboard diff --git a/rofi/kaomoji.txt b/rofi/kaomoji.txt new file mode 100644 index 0000000..4caff7e --- /dev/null +++ b/rofi/kaomoji.txt @@ -0,0 +1,355 @@ +>.< Upset +>_> Looking +<( ･ｪ-)<} Bow and Arrow +<(;￣ ･￣) Scratching +<(^oo^)> Pig +<コ:彡 Squid +(#^.^#) Embarrassed +(#×_×) Dead +(>^_^)><(^o^<) Hugging +(>_<) Painful +( --)/ ==卍 Ninja Star +( -_-)旦~ Drinking +( ^_^)／ Waving +( `_)?(_' ) Dueling +( `_)乂(_' ) Arm wrestle +( ° ᴗ°)~ð Proposal +( ´-ω･)︻┻┳══━一 Sniper +( ˇ෴ˇ ) Hipster +( ˘ ³˘)♥ Kiss me +( ͡° ͜ʖ ͡°) Smiling +( • ∀•)っθΘʘ Hiding Easter eggs +( •_•)O °Q(•_• ) Playing Ping Pong +( ｀o´)_θ☆ Kicking +( ｀皿´)｡ﾐ/ Hitting +( ￣┏＿┓￣) Mustache +(( ＿ ＿)☆ ≡〇 Header +((((((^_^;) Evading +(((((^_^) Teleporting +(((༼•̫͡•༽))) Ghost +(((☎))) Phone +(* ￣)(￣ *) Kissing +(*@_＊#) Beaten Up +(*^o^)人(^o^*) Buddies +(*°∀°)=3 Infatuated +(*’(OO)’*) Piggy +(*≧m≦*) Enraged +(*▿▿* ƪ) Vampire +(*・)σσ(*゜O゜) Poking +(*・_・)ノ⌒* Throwing Away +(*￣m￣) Dissatisfied +(+.+)(-.-)(_ _) Falling Asleep +(+[__]∙:∙) PlayStation Portable +(- o - ) zzZ ☽ Sleepy +(-_-)# Girl +(-_ゞ Groggy +(-ε- ) Pucker up +(-□-)︵* Blowing a Kiss +(.〜◍`皿′◍〜.) Livid +(//_^) Emo +(/ω･＼) Peering +(:3 っ)っ Walrus +(;-_-)ノ Giving up +(;´ρ`) Yawning +(;´Д`) Giving Up +(;´༎ຶД༎ຶ`) Weeping +(=^_^=) Bunny +(=^ェ^=) Cat +(=^･ｪ･^=) Kitty +(^ _ ^)/~~ Goodbye +(^^)// Applause +(^_^) Laughing +(^o^) Singing +(^‿◕) Winking +(_ _)..ooOO Dreaming +(`_^) Wink +(o^-^o) Pikachu +(o´・Υ・)ﾉ･ Help +(o￣∇￣)=◯)`ν゜)･ Punching +(p_-) Thinking +(ToT) Crying +(V) (°,,,,°) (V) Zoidberg +(z_z~.) Tired +(~_(]=--Z(◡˘) Pie Fight +(¬_¬") Annoyed +(¬_¬ ) Neglected +(¬‿¬) Cunning +(¬､¬) Shifty +(°̥̥̥̥̥̥̥̥ᴗ°̥̥̥̥̥̥̥̥) Happy crying +(´>_●)メ(●_<｀) Sword Fighting +(´~`) Weary +(´∪`*) Friendly +(´╹〽╹`) Worried +(´・ω・)っ由 Gift +(´ー｀)┌ﾌｯ Golf Clap +(´･ω･`) Snubbing +(ò_ó) Furious +(ó ì_í)=óò=(ì_í ò) Bro Pound +(ɔˆ ³(ˆ⌣ˆc) Loving couple +(ɔ˘з˘)ɔ Romantic +(ʘ‿ʘ) Smile +(о＾ω＾о) Giggling +(ू˃̣̣̣̣̣̣︿˂̣̣̣̣̣̣ ू) Sobbing +(ಥ﹏ಥ) Devastated +(ง •̀_•́)ง Feisty +(ง •̀ゝ•́)ง Fighting +(๑´•.̫ • `๑) Blushing +(๑≖ิิ益≖ิ๑) Evil Laugh +(๑╹ڡ╹๑) Tasty +(•͡.•͡) Skeptical +(•ᴥ• )́`́'́`́'́⻍ Porcupine +(‥;) Depressed +(″･ิ_･ิ)っ Wait +(‾ʖ̫‾) Lethargic +(∩｀-´)⊃━☆ﾟ.*･｡ﾟ Wizard +(∩｀-´)⊃━☆ﾟ.*･｡ﾟ Magic Attack +(∿°○°)∿ ︵ ǝʌol Heartbroken +(≧∇≦)/ Joyful +(⊃‿⊂) Anticipation +(⊙_◎) Crazed +(⌒ ͜ʖ⌒)b Attentive +(⓪益⓪) Staring +(─‿‿─) Pleased +(╬☉Д⊙ฺ) Cyborg +(╯3╰) Kiss +(╯_╰) Bummed out +(╯°□°)╯︵ ʞooqǝɔɐɟ Flipping Facebook +(╯°□°)╯︵ ┻━┻ Flipping Table +(╯°□°）╯︵ ┻━┻ Flipping table +(╯˘ -˘ )╯ Praying +(╯ნ_㇁ნ)╯ Defeated +(╯‵Д′)╯ Scary +(▀̿Ĺ̯▀̿ ̿) Deal with it +(▰˘◡˘▰) Satisfied +(○｀д´)ﾉｼ Σ(っﾟДﾟ)っ Chasing +(●´ﾉω`)ｺ Whispering +(●∈∋●) Bird +(◐‿◑) Crazy +(◣_◢) Angry +(☄ฺ◣д◢)☄ฺ Scaring +(★▼▼)o┳*-- Shooting +(☉__☉”) Yikes +(♥_♥) In Love +(✖╭╮✖) Deceased +(。_°)☆ Punched +(。。;)＼(-_-) Comforting +(。･_･)ノ”【】 Painting +(っ^‿^)っ Kirby +(っ˘ڡ˘ς) Yummy +(っ⌒‿⌒)っ Hug +(づ￣ ³￣)づ Smooch +(シ_ _)シ Apology +(＊☉౪ ⊙｡)ﾉ Imbecile +(－‸ლ) Whoops +(／o^)/°⊥＼(^o＼) Volleyball +(／。＼) Frightened +(；^＿^)ッ☆(　゜o゜) Slapping +(；一_一) Ashamed +(＾▽＾) Cheerful +(｡▼皿▼) Darth Vader +(｡♥‿♥｡) Smitten +(｡･ˇдˇ･｡) Pompous +(ﾉ-o-)ﾉ 中 Olympic Hammer Throw +(ﾉ_ _)ﾉ Surrender +(ﾉﾟ0ﾟ)ﾉ~ Yoo- Hoo +(￣┏∞┓￣) Fu Manchu Man +(￣▼￣) Big Grin +(￣ー￣)//”” Clapping +(￣ー￣（＿　＿（ Nodding +---(o_　_)o Tripping +-_-* Frustrated +-_-; Anime Sweat Drop +-{'''|'''|'''|''']=[] Syringe +-ˆ ω ˆ- Kitten +.∵･(ﾟДﾟ) Scared +/( ＿0＿)￣θ☆≡≡○ Scissor Kick +/|\( ;,; )/|\ Bat +8(>_<)8 Jealous +:(¦) Frog +:-{ -__-: Stinky +:-Þ Teasing +:þ Playful +@( o･ω･)@ Monkey +[ ± _ ± ] Sick +[-_-]~ Ninja +[]゛７(∀゜*） Dialing +[^._.^]ﾉ彡 Nyan Cat +[¬º-°]¬ Zombie +[•.•ิ] Huh +\\(<.<|>.>)// Panicking +\m/d(^_^)b\m/ Rocking Out +\＿(´▽｀)♪＿/ Bathtub +^(#｀∀´)_Ψ Demon +^)_(^ Chubby +^-^ Happy +^;;^ Spider +^^ Blissful +^_^ Overjoyed +^_^/ High Five +^_^; Guilty +^o^ Mog +___ψ(‥ ) Studying +d(^_^)b Listening to Music +d-(^.^)z Thumbs Up +d^_^b DJ +L(´□｀L)  Oh No! +m( ﾟ皿ﾟ)m★━━ Laser +o(>< )o⌒* Mad +O(<>'<>)O Aang +o(^^o)(o^^)o Hopeful +o(^_-)O Boxer +o(^▽^)o Pumped +o(´^｀)o Reluctant +Q('.'Q) Put Em Up +T.T Sad +U=･ x ･=U Rabbit +uwu Happy Anime Face +U＾ェ＾U Puppy +v(^_^)v Victory +V=(° °)=V Crab +V●ᴥ●V Doggy +{{|└(>o< )┘|}} Up In Arms +{♥‿♥} Lovestruck +|̲̅̅●̲̅̅|̲̅̅=̲̅̅|̲̅̅●̲̅̅| Stereo +|д･) Hiding +|∴め ϖ め∴| SpongeBob SquarePants +¤\( `⌂´ )/¤ Lifting weights +¥[*.*]¥ Robot +¬.¬ Whatever +¯(°_o)/¯ Confused shrug +¯\(°_o)/¯ Confused +¯\_(ツ)_/¯ Shrugging +ƪ(˘⌣˘)ʃ Raise the roof +ƪ(˘▽˘ƪ) Worshiping +Ƹ̵̡Ӝ̵̨̄Ʒ Butterfly +ʕ •́؈•̀) Winnie the Pooh +ʕ •ᴥ•ʔ Koala +ʕʔ Bread +ʕु•̫͡•ʔु Bear cub +ʕ•͡ᴥ•ʔ Polar bear +ʘ‿ʘ Eager +˙ ͜ʟ˙ Content +ε-(´・｀) ﾌ Phew +ε=(☉_☉) Accidental farting +ε=ε=ε=┌(๑ʘ∀ʘ)┘ Sprinting +ε=┌( ≧▽)┘ Elated +ε=┌(^-^)┘ Skipping +ε=┏( >_<)┛ Running +ϵ( 'Θ' )϶ Fish +٩◔̯◔۶ Eye Roll With Hands Up +੯ू•́ू ໒꒱⁼³₌₃ Sonic the Hedgehog +੯ू‵ू ໒꒱ Poodle +ಠ_ಠ Disapproval +ಠ_ರೃ Monocle +ಠᴗಠ Scheming +ಥ_ಥ Bawling +๏-) Cyclops +༼ ༎ຶ ෴ ༎ຶ༽ Distraught +༼ つ ◕_◕ ༽つ Take my energy +༼ つ ◕_◕ ༽つ Gimme +༼ঢ_༽ঢ༽ Perplexed +༼ঢ_㇁ঢ༽ Bad hair day +ლ(´ڡ`ლ) Licking +ლ(ಠ益ಠ)ლ Anger +ლ(ಠ益ಠლ) But At What Cost +ᒄ₍⁽ˆ⁰ˆ⁾₎ᒃ♪♬ Frosty the Snowman +ᕕ( ᐛ )ᕗ Celebrating +ᕦ(ò_óˇ)ᕤ Flexing +ᕦ◉▿◉ᕤ Owl +ᕦ❍ᴗ❍ᕤ Muscular Person +ᘛ⁐̤ᕐᐷ Chameleon +ᡊ|◔じ◔|ᡊ Woody Allen +ᶘ ᵒᴥᵒᶅ Seal +‎(>o<)ρミ┳┷┳゜ Table Tennis +†_(ﾟｰﾟ*)β Exorcism +•:_:• Nagato +←～（o ｀▽´ )oΨ Satan +∊ಠ_ಠ∍ Distressed +∊♡_ᴥ_♡∍ Puppy Love +∋(°O°)∈ Blowfish +∋∞(●ﾟvﾟ)∞∈ Pigtails +⊂ •͡˘∠•͡˘ ⊃ Suspicious +⊂((・▽・))⊃ Hug me +⊂(^(工)^)⊃ Teddy bear +⊂(◜ᴥ◝)つ Teddy Bear +⊆☉ᴥ☉⊇ Bear +⊙▂⊙ Shocked +⋟^≏^⋞ Kitty Cat +⎰≀.☮-☮≀⎰ John Lennon +─=≡Σ(([ ⊐•̀⌂•́]⊐ Superhero +┌|°з°|┘ Cutting a rug +└(^o^ )Ｘ( ^o^)┘ Best buddies +└(^o^)┐ Grooving +└@(･ｪ･)@┐ Beefcake +┗( ●-﹏ ｀｡)づ Hurt +┗(･ω･;)┛ How Should I Know +┬─┬ノ( º _ ºノ) Putting Table Back +┬─┬︵/(.□.)╯ Table Flips You +┬┴┬┴┤(･_├┬┴┬┴ Snooper +┳┻┳° Ping Pong table +╹﹏╹ Cold +▼o･_･o▼ Hello +◔̯◔ Rolling Eyes +◖ර◞ʖ◟ර◗ Grandma +◖⎚∠⎚◗ Geek +◖㈠ ω ㈠◗ Panda +◤◡ᴥ◡◥ Dog +◦°˚\☺/˚°◦ Playing in the snow +◯０o。(ー。ー)y Smoking +☉ϖ☉ Lobster +♥‿♥ Enamored +♪(●′▽`)ﾉ Good Night +♪┏(・o･)┛♪ Dancing +♪～(￣ε￣；) Whistling +♫.(◠౪◠).♫ Jamming to music +✌(გ_㇁გ)✌ Ringo Starr +✌(◕‿-)✌ Peace +✖‿✖ Dead person +❆❅❉ Snowing +⨌⨀_⨀⨌ Benjamin Franklin +⪿ ↂ ˒̫̮ ↂ ⫀ Elton John +⫷ °⧭° ⫸ Clown +「(°ヘ°) Puzzled +〜〜(／￣▽)／　〜ф Chasing A Butterfly +ヘ（。□°）ヘ Psycho +ヽ( ★ω★)ノ Pumped up +ヽ(´Д｀ヽミノ´Д｀)ノ Frantic +ヽ(⌐■_■)ノ♪♬ Boogie down +ヽ(★ω★)ノ Excited +ヽ(ﾟДﾟ)ﾉ Freak Out +ヽ（´ー｀）┌ Mellow +ヾ(*￣O￣)ツ Yelling +ヾ(｀ε´)ﾉ Booing +㐈⦁ཽし⦁ཽ㐈 Larry David +且_(ﾟ◇ﾟ；)ノﾞ Waiter +꒡ᘦ̲꒡ Sleeping +（ つ Д ｀） Wiping Tears +（*・)｢｣｢｣ Magic Casting +（/｡＼) Shy +（´Д゜）/゜⌒。 Discarding +（　＾）／占~~~ Banksy +（　＾＾）人（＾＾　） Best Buds +（。_°☆＼(- – ) Punch +（。々°） Herp Derp +（・д・）｝ On The Phone +（人’∀’） Precious +（＾～＾） Meh +（＿ε＿） Kiss my butt +（￢з￢）σ Pointing +（￣□￣；） Surprised +（￣へ￣） Discontent +（￣～￣） Unimpressed +／人◕ ‿‿ ◕人＼ Kyubey +＝( ^o^)ノ___ｏ Bowling +＼(-_- ) Thank You +＼(^o)(^0^)(o^)／ Caroling +＼(＾O＾)／ Celebrate +＼(｀0´)／ Fed Up +＼（＾ ＾）／ Glad +＼（～Ｏ～）／ Good Morning +＿φ( °-°)/ Doing Homework +＿φ(°-°=) Doing homework +＿〆(。。) Writing +Ｃ:。ミ Octopus +～゜・_・゜～ Raving +｡◕‿◕｡ Gleeful diff --git a/rofi/launcher.rasi b/rofi/launcher.rasi new file mode 100644 index 0000000..f29307e --- /dev/null +++ b/rofi/launcher.rasi @@ -0,0 +1,176 @@ +/** + * + * Author : Aditya Shakya (adi1090x) + * Github : @adi1090x + * + * Rofi Theme File + * Rofi Version: 1.7.3 + **/ + +/*****----- Configuration -----*****/ +configuration { + modi: "drun"; + show-icons: true; + display-drun: ""; + drun-display-format: "{name}"; +} + +/*****----- Global Properties -----*****/ +@import "everforest.rasi" + +* { + font: "Iosevka Nerd Font 10"; +} + +/*****----- Main Window -----*****/ +window { + transparency: "real"; + location: center; + anchor: center; + fullscreen: true; + width: 100%; + height: 100%; + x-offset: 0px; + y-offset: 0px; + + enabled: true; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: black / 10%; + cursor: "default"; +} + +/*****----- Main Box -----*****/ +mainbox { + enabled: true; + spacing: 100px; + margin: 0px; + padding: 100px 100px; + border: 0px solid; + border-radius: 0px 0px 0px 0px; + border-color: @selected; + background-color: transparent; + children: [ "inputbar", "listview" ]; +} + +/*****----- Inputbar -----*****/ +inputbar { + enabled: true; + spacing: 10px; + margin: 0% 25%; + padding: 18px; + border: 0px solid; + border-radius: 10px; + border-color: @selected; + background-color: white / 5%; + text-color: @foreground; + children: [ "prompt", "entry" ]; +} + +prompt { + enabled: true; + background-color: transparent; + text-color: inherit; +} +textbox-prompt-colon { + enabled: true; + expand: false; + str: "::"; + background-color: transparent; + text-color: inherit; +} +entry { + enabled: true; + background-color: transparent; + text-color: inherit; + cursor: text; + placeholder: "Search"; + placeholder-color: inherit; +} + +/*****----- Listview -----*****/ +listview { + enabled: true; + columns: 12; + lines: 4; + cycle: true; + dynamic: true; + scrollbar: false; + layout: vertical; + reverse: false; + fixed-height: true; + fixed-columns: true; + + spacing: 0px; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: transparent; + text-color: @foreground; + cursor: "default"; +} +scrollbar { + handle-width: 5px ; + handle-color: @selected; + border-radius: 0px; + background-color: @background-alt; +} + +/*****----- Elements -----*****/ +element { + enabled: true; + spacing: 15px; + margin: 0px; + padding: 15px 10px; + border: 0px solid; + border-radius: 15px; + border-color: @selected; + background-color: transparent; + text-color: @foreground; + orientation: vertical; + cursor: pointer; +} +element normal.normal { + background-color: transparent; + text-color: @foreground; +} +element selected.normal { + background-color: white / 10%; + text-color: @foreground; +} +element-icon { + background-color: transparent; + text-color: inherit; + size: 64px; + cursor: inherit; +} +element-text { + background-color: transparent; + text-color: inherit; + highlight: inherit; + cursor: inherit; + vertical-align: 0.5; + horizontal-align: 0.5; +} + +/*****----- Message -----*****/ +error-message { + padding: 100px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: black / 10%; + text-color: @foreground; +} +textbox { + background-color: transparent; + text-color: @foreground; + vertical-align: 0.5; + horizontal-align: 0.0; + highlight: none; +} diff --git a/rofi/launcher_launcher.rasi b/rofi/launcher_launcher.rasi new file mode 100644 index 0000000..41737c7 --- /dev/null +++ b/rofi/launcher_launcher.rasi @@ -0,0 +1,310 @@ +/** + * + * Author : Aditya Shakya (adi1090x) + * Github : @adi1090x + * + * Rofi Theme File + * Rofi Version: 1.7.3 + **/ + +/*****----- Configuration -----*****/ +configuration { + modi: "drun"; + show-icons: false; + display-drun: ""; + display-run: ""; + display-filebrowser: ""; + display-window: ""; + drun-display-format: "{name}"; + window-format: "{w} · {c} · {t}"; +} + +/*****----- Global Properties -----*****/ +@import "everforest.rasi" + +* { + font: "JetBrains Mono Nerd Font 10"; +} + +* { + border-colour: var(selected); + handle-colour: var(foreground); + background-colour: var(background); + foreground-colour: var(foreground); + alternate-background: var(background-alt); + normal-background: var(background); + normal-foreground: var(foreground); + urgent-background: var(urgent); + urgent-foreground: var(background); + active-background: var(active); + active-foreground: var(background); + selected-normal-background: var(selected); + selected-normal-foreground: var(background); + selected-urgent-background: var(active); + selected-urgent-foreground: var(background); + selected-active-background: var(urgent); + selected-active-foreground: var(background); + alternate-normal-background: var(background); + alternate-normal-foreground: var(foreground); + alternate-urgent-background: var(urgent); + alternate-urgent-foreground: var(background); + alternate-active-background: var(active); + alternate-active-foreground: var(background); +} + +/*****----- Main Window -----*****/ +window { + /* properties for window widget */ + transparency: "real"; + location: center; + anchor: center; + fullscreen: false; + width: 500px; + x-offset: 0px; + y-offset: 0px; + + /* properties for all widgets */ + enabled: true; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + cursor: "default"; + /* Backgroud Colors */ + background-color: @background-colour; + /* Backgroud Image */ + //background-image: url("/path/to/image.png", none); + /* Simple Linear Gradient */ + //background-image: linear-gradient(red, orange, pink, purple); + /* Directional Linear Gradient */ + //background-image: linear-gradient(to bottom, pink, yellow, magenta); + /* Angle Linear Gradient */ + //background-image: linear-gradient(45, cyan, purple, indigo); +} + +/*****----- Main Box -----*****/ +mainbox { + enabled: true; + spacing: 10px; + margin: 0px; + padding: 20px; + border: 0px solid; + border-radius: 0px 0px 0px 0px; + border-color: @border-colour; + background-color: transparent; + children: [ "inputbar", "message", "listview", "mode-switcher" ]; +} + +/*****----- Inputbar -----*****/ +inputbar { + enabled: true; + spacing: 10px; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: transparent; + text-color: @foreground-colour; + children: [ "prompt", "entry" ]; +} + +prompt { + enabled: true; + background-color: inherit; + text-color: inherit; +} +textbox-prompt-colon { + enabled: true; + expand: false; + str: "::"; + background-color: inherit; + text-color: inherit; +} +entry { + enabled: true; + background-color: inherit; + text-color: inherit; + cursor: text; + placeholder: "search..."; + placeholder-color: inherit; +} +num-filtered-rows { + enabled: true; + expand: false; + background-color: inherit; + text-color: inherit; +} +textbox-num-sep { + enabled: true; + expand: false; + str: "/"; + background-color: inherit; + text-color: inherit; +} +num-rows { + enabled: true; + expand: false; + background-color: inherit; + text-color: inherit; +} +case-indicator { + enabled: true; + background-color: inherit; + text-color: inherit; +} + +/*****----- Listview -----*****/ +listview { + enabled: true; + columns: 2; + lines: 10; + cycle: true; + dynamic: true; + scrollbar: false; + layout: vertical; + reverse: false; + fixed-height: true; + fixed-columns: true; + + spacing: 5px; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: transparent; + text-color: @foreground-colour; + cursor: "default"; +} +scrollbar { + handle-width: 5px ; + handle-color: @handle-colour; + border-radius: 0px; + background-color: @alternate-background; +} + +/*****----- Elements -----*****/ +element { + enabled: true; + spacing: 8px; + margin: 0px; + padding: 8px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: transparent; + text-color: @foreground-colour; + cursor: pointer; +} +element normal.normal { + background-color: var(normal-background); + text-color: var(normal-foreground); +} +element normal.urgent { + background-color: var(urgent-background); + text-color: var(urgent-foreground); +} +element normal.active { + background-color: var(active-background); + text-color: var(active-foreground); +} +element selected.normal { + background-color: var(normal-foreground); + text-color: var(normal-background); +} +element selected.urgent { + background-color: var(selected-urgent-background); + text-color: var(selected-urgent-foreground); +} +element selected.active { + background-color: var(selected-active-background); + text-color: var(selected-active-foreground); +} +element alternate.normal { + background-color: var(alternate-normal-background); + text-color: var(alternate-normal-foreground); +} +element alternate.urgent { + background-color: var(alternate-urgent-background); + text-color: var(alternate-urgent-foreground); +} +element alternate.active { + background-color: var(alternate-active-background); + text-color: var(alternate-active-foreground); +} +element-icon { + background-color: transparent; + text-color: inherit; + size: 24px; + cursor: inherit; +} +element-text { + background-color: transparent; + text-color: inherit; + highlight: inherit; + cursor: inherit; + vertical-align: 0.5; + horizontal-align: 0.0; +} + +/*****----- Mode Switcher -----*****/ +mode-switcher{ + enabled: false; + spacing: 10px; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: transparent; + text-color: @foreground-colour; +} +button { + padding: 8px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: @alternate-background; + text-color: inherit; + cursor: pointer; +} +button selected { + background-color: var(normal-foreground); + text-color: var(normal-background); +} + +/*****----- Message -----*****/ +message { + enabled: true; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px 0px 0px 0px; + border-color: @border-colour; + background-color: transparent; + text-color: @foreground-colour; +} +textbox { + padding: 8px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: @alternate-background; + text-color: @foreground-colour; + vertical-align: 0.5; + horizontal-align: 0.0; + highlight: none; + placeholder-color: @foreground-colour; + blink: true; + markup: true; +} +error-message { + padding: 10px; + border: 0px solid; + border-radius: 0px; + border-color: @border-colour; + background-color: @background-colour; + text-color: @foreground-colour; +} diff --git a/rofi/launcher_launcher.sh b/rofi/launcher_launcher.sh new file mode 100755 index 0000000..30a0666 --- /dev/null +++ b/rofi/launcher_launcher.sh @@ -0,0 +1,44 @@ +#!/usr/bin/env bash + +# Options +power="Power menu" +ssh="SSH Connect" +window="Window switcher" +kaomoji="Kaomoji" + +# Rofi CMD +rofi_cmd() { + rofi -dmenu \ + -window-title "Launcher" \ + -i \ + -theme $HOME/.config/awesome/rofi/launcher_launcher.rasi \ + -theme-str 'listview {columns: 1;}' +} + +# Pass variables to rofi dmenu +run_rofi() { + echo -e "$power\n$ssh\n$window\n$kaomoji" | rofi_cmd +} + +# Actions +chosen="$(run_rofi)" +case ${chosen} in + $power) + $HOME/.config/awesome/rofi/powermenu.sh + ;; + $ssh) + rofi \ + -show ssh \ + -theme $HOME/.config/awesome/rofi/launcher_launcher.rasi + ;; + $window) + rofi \ + -show window \ + -theme $HOME/.config/awesome/rofi/launcher_launcher.rasi \ + -theme-str 'listview {columns: 1; lines: 10;}' + ;; + $kaomoji) + $HOME/.config/awesome/rofi/kaomoji.sh \ + -theme $HOME/.config/awesome/rofi/launcher_launcher.rasi + ;; +esac diff --git a/rofi/powermenu.rasi b/rofi/powermenu.rasi new file mode 100644 index 0000000..afa4ee5 --- /dev/null +++ b/rofi/powermenu.rasi @@ -0,0 +1,170 @@ +/** + * + * Author : Aditya Shakya (adi1090x) + * Github : @adi1090x + * + * Rofi Theme File + * Rofi Version: 1.7.3 + **/ + +/*****----- Configuration -----*****/ +configuration { + show-icons: false; +} + +/*****----- Global Properties -----*****/ +@import "everforest.rasi" + +* { + font: "JetBrains Mono Nerd Font 10"; +} + +/*****----- Main Window -----*****/ +window { + /* properties for window widget */ + transparency: "real"; + location: center; + anchor: center; + fullscreen: false; + width: 605px; + x-offset: 0px; + y-offset: 0px; + + /* properties for all widgets */ + enabled: true; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + cursor: "default"; + background-color: @background; +} + +/*****----- Main Box -----*****/ +mainbox { + enabled: true; + spacing: 10px; + margin: 0px; + padding: 20px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: transparent; + children: [ "inputbar", "message", "listview" ]; +} + +/*****----- Inputbar -----*****/ +inputbar { + enabled: true; + spacing: 10px; + margin: 0px; + padding: 0px; + border: 0px; + border-radius: 0px; + border-color: @selected; + background-color: transparent; + text-color: @foreground; + children: [ "textbox-prompt-colon", dummy, "prompt"]; +} + +dummy { + background-color: transparent; +} + +textbox-prompt-colon { + enabled: true; + expand: false; + str: ""; + padding: 10px 18px 10px 14px; + border-radius: 0px; + background-color: @urgent; + text-color: @background; +} +prompt { + enabled: true; + padding: 10px; + border-radius: 0px; + background-color: @active; + text-color: @background; +} + +/*****----- Message -----*****/ +message { + enabled: true; + margin: 0px; + padding: 10px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: @background-alt; + text-color: @foreground; +} +textbox { + background-color: inherit; + text-color: inherit; + vertical-align: 0.5; + horizontal-align: 0.5; + placeholder-color: @foreground; + blink: true; + markup: true; +} +error-message { + padding: 10px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: @background; + text-color: @foreground; +} + +/*****----- Listview -----*****/ +listview { + enabled: true; + columns: 5; + lines: 1; + cycle: true; + dynamic: true; + scrollbar: false; + layout: vertical; + reverse: false; + fixed-height: true; + fixed-columns: true; + + spacing: 10px; + margin: 0px; + padding: 0px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: transparent; + text-color: @foreground; + cursor: "default"; +} + +/*****----- Elements -----*****/ +element { + enabled: true; + spacing: 0px; + margin: 0px; + padding: 10px; + border: 0px solid; + border-radius: 0px; + border-color: @selected; + background-color: @background-alt; + text-color: @foreground; + cursor: pointer; +} +element-text { + background-color: transparent; + text-color: inherit; + cursor: inherit; + vertical-align: 0.5; + horizontal-align: 0.5; +} +element selected.normal { + border: 0px 2px 0px 2px; + border-radius: 0px; + background-color: var(selected); + text-color: var(background); +} diff --git a/rofi/powermenu.sh b/rofi/powermenu.sh new file mode 100755 index 0000000..a8ba02c --- /dev/null +++ b/rofi/powermenu.sh @@ -0,0 +1,94 @@ +#!/usr/bin/env bash + +## Author : Aditya Shakya (adi1090x) +## Github : @adi1090x +# +## Rofi : Power Menu +# +## Available Styles +# +## style-1 style-2 style-3 style-4 style-5 + +# CMDs +uptime="`uptime -p | sed -e 's/up //g'`" +host=`hostname` + +# Options +shutdown=' Shutdown' +reboot=' Reboot' +lock=' Lock' +suspend=' Suspend' +logout=' Logout' +yes=' Yes' +no=' No' + +# Rofi CMD +rofi_cmd() { + rofi -dmenu \ + -p "$host" \ + -mesg "Uptime: $uptime" \ + -theme $HOME/.config/awesome/rofi/powermenu.rasi +} + +# Confirmation CMD +confirm_cmd() { + rofi -theme-str 'window {location: center; anchor: center; fullscreen: false; width: 250px;}' \ + -theme-str 'mainbox {children: [ "message", "listview" ];}' \ + -theme-str 'listview {columns: 2; lines: 1;}' \ + -theme-str 'element-text {horizontal-align: 0.5;}' \ + -theme-str 'textbox {horizontal-align: 0.5;}' \ + -dmenu \ + -p 'Confirmation' \ + -mesg 'Are you Sure?' \ + -theme $HOME/.config/awesome/rofi/powermenu.rasi +} + +# Ask for confirmation +confirm_exit() { + echo -e "$yes\n$no" | confirm_cmd +} + +# Pass variables to rofi dmenu +run_rofi() { + echo -e "$lock\n$suspend\n$logout\n$reboot\n$shutdown" | rofi_cmd +} + +# Execute Command +run_cmd() { + selected="$(confirm_exit)" + if [[ "$selected" == "$yes" ]]; then + if [[ $1 == '--shutdown' ]]; then + systemctl poweroff + elif [[ $1 == '--reboot' ]]; then + systemctl reboot + elif [[ $1 == '--suspend' ]]; then + dm-tool lock + sleep 1 + systemctl suspend + elif [[ $1 == '--logout' ]]; then + awesome-client 'awesome.quit()' + fi + else + exit 0 + fi +} + +# Actions +chosen="$(run_rofi)" +case ${chosen} in + $shutdown) + run_cmd --shutdown + ;; + $reboot) + run_cmd --reboot + ;; + $lock) + dm-tool lock + ;; + $suspend) + run_cmd --suspend + ;; + $logout) + run_cmd --logout + ;; +esac diff --git a/settings.lua b/settings.lua new file mode 100644 index 0000000..598d3d4 --- /dev/null +++ b/settings.lua @@ -0,0 +1,6 @@ +return { + wallpaper = 'wall2.png', + + --show_battery = false, + --show_volume = true +} diff --git a/src/client/client_keys.lua b/src/client/client_keys.lua new file mode 100644 index 0000000..a9529a0 --- /dev/null +++ b/src/client/client_keys.lua @@ -0,0 +1,33 @@ +local gears = require('gears') +local awful = require('awful') +local naughty = require('naughty') +local globals = require('src.globals') +local constrain = require('libconstrain') + +local modkey = globals.modkey +local altkey = globals.altkey + +local keys = gears.table.join( + awful.key({ modkey }, 'f', function(c) c.fullscreen = not c.fullscreen c:raise() end, { description = 'toggle fullscreen', group = 'client' }), + awful.key({ modkey, 'Shift' }, 'c', function(c) c:kill() end, { description = 'close', group = 'client' }), + awful.key({ modkey, 'Shift', 'Control', altkey }, 'c', function(c) awesome.kill(c.pid, awesome.unix_signal['SIGKILL']) c:kill() end, { description = 'send sigkill', group = 'client' }), + awful.key({ modkey, 'Control' }, 'space', awful.client.floating.toggle, { description = 'toggle floating', group = 'client' }), + awful.key({ modkey }, 'o', function(c) c:move_to_screen() end, { description = 'move to next screen', group = 'client' }), + awful.key({ modkey }, 't', function(c) c.ontop = not c.ontop end, { description = 'toggle keep on top', group = 'client' }), + awful.key({ modkey }, 'n', function(c) c.minimized = true end, { description = 'minimize', group = 'client' }), + awful.key({ modkey }, 'm', function(c) c.maximized = not c.maximized c:raise() end, { description = '(un)maximize', group = 'client' }), + awful.key({ modkey, 'Control' }, 's', function(c) awful.titlebar.toggle(c) c:raise() end, { description = 'toggle titlebar', group = 'client' }), + awful.key({ modkey, 'Control' }, 'F10', function(c) naughty.notify({ text = constrain.toggle(c), timeout = 3 }) end, { description = 'toggle mouse constrain', group = 'client' }) +) + +local buttons = gears.table.join( + awful.button({}, 1, function(c) c:emit_signal('request::activate', 'mouse_click', { raise = true }) end), + awful.button({ modkey }, 1, function(c) c:emit_signal('request::activate', 'mouse_click', { raise = true }) awful.mouse.client.move(c) end), + awful.button({ modkey }, 3, function(c) c:emit_signal('request::activate', 'mouse_click', { raise = true }) awful.mouse.client.resize(c) end) +) + + +return { + keys = keys, + buttons = buttons +} diff --git a/src/client/init.lua b/src/client/init.lua new file mode 100644 index 0000000..5a56db8 --- /dev/null +++ b/src/client/init.lua @@ -0,0 +1,51 @@ +local awful = require('awful') +local beautiful = require('beautiful') +local gears = require('gears') +local wibox = require('wibox') + +require('src.client.rules') + +-- New client +client.connect_signal('manage', function(c) + if awesome.startup and not c.size_hints.user_position and not c.size_hints.program_position then + awful.placement.no_offscreen(c) + end +end) + +client.connect_signal('request::titlebars', function(c) + local buttons = gears.table.join( + awful.button({}, 1, function() c:emit_signal('request::activate', 'titlebar', { raise = true }) awful.mouse.client.move(c) end), + awful.button({}, 2, function() c:kill() end), + awful.button({}, 3, function() c:emit_signal('request::activate', 'titlebar', { raise = true }) awful.mouse.client.resize(c) end) + ) + + awful.titlebar(c, { size = 16 }):setup({ + { -- Left + awful.titlebar.widget.iconwidget(c), + buttons = buttons, + layout = wibox.layout.fixed.horizontal, + }, + { -- Middle + { -- Title + align = 'center', + widget = awful.titlebar.widget.titlewidget(c), + }, + buttons = buttons, + layout = wibox.layout.flex.horizontal, + }, + { -- Right + awful.titlebar.widget.floatingbutton(c), + awful.titlebar.widget.maximizedbutton(c), + awful.titlebar.widget.stickybutton(c), + awful.titlebar.widget.ontopbutton(c), + awful.titlebar.widget.closebutton(c), + layout = wibox.layout.fixed.horizontal(), + }, + layout = wibox.layout.align.horizontal, + }) + awful.titlebar.hide(c) +end) + +client.connect_signal('mouse::enter', function(c) c:emit_signal('request::activate', 'mouse_enter', { raise = false }) end) +client.connect_signal('focus', function(c) c.border_color = beautiful.border_focus end) +client.connect_signal('unfocus', function(c) c.border_color = beautiful.border_normal end) diff --git a/src/client/rules.lua b/src/client/rules.lua new file mode 100644 index 0000000..55a0ed2 --- /dev/null +++ b/src/client/rules.lua @@ -0,0 +1,51 @@ +local awful = require('awful') +local beautiful = require('beautiful') +local rules = require('ruled.client') +local cb = require('src.client.client_keys') + +rules.append_rules({ + { + rule = {}, + properties = { + border_width = beautiful.border_width, + border_color = beautiful.border_normal, + callback = awful.client.setslave, + focus = awful.client.focus.filter, + raise = true, + keys = cb.keys, + buttons = cb.buttons, + screen = awful.screen.preferred, + placement = awful.placement.no_overlap + awful.placement.no_offscreen, + size_hints_honor = false, + no_border = false, + titlebars_enabled = false + } + }, { + rule_any = { + class = { 'Tor Browser' }, + name = { 'Event Tester' }, + role = { + 'AlarmWindow', + 'ConfigManager', + 'pop-up' + } + }, + properties = { floating = true } + }, { + rule_any = { class = { 'firefox', 'factorio', 'Blender' } }, + properties = { opacity = 1, maximized = false, floating = false }, + }, { + rule = { class = 'mpv' }, + properties = { fullscreen = true }, + }, { + rule = { class = 'supcom-fa' }, + properties = { + floating = true, + border_width = 0, + x = 0, + y = 1080, + no_border = true, + } + }, + { rule_any = { type = { 'normal', 'dialog' } }, properties = { titlebars_enabled = true } }, +}) diff --git a/src/global_keys.lua b/src/global_keys.lua new file mode 100644 index 0000000..ca96529 --- /dev/null +++ b/src/global_keys.lua @@ -0,0 +1,136 @@ +local gears = require('gears') +local awful = require('awful') +local lain = require('lain') +local hotkeys_popup = require('awful.hotkeys_popup') +local globals = require('src.globals') + +local modkey = globals.modkey +local altkey = globals.altkey + +local mpris = require('src.util.mpris') +local volume = require('src.util.volume') + +local quake_terminal_name = 'QuakeTerminal' +local quake = lain.util.quake({ + followtag = true, + overlap = true, + + app = globals.terminal, + argname = '-t ' .. quake_terminal_name, + name = quake_terminal_name, + extra = '--class ' .. quake_terminal_name, + + vert = 'center', + horiz = 'center', + height = 0.6, + width = 0.6 +}) + +local function focus_bydirection(direction) + awful.client.focus.global_bydirection(direction) + if client.focus then + client.focus:raise() + end +end + +local globalkeys = gears.table.join( + ---- HOTKEYS ---- + awful.key({ modkey, altkey }, 'p', function() awful.spawn('flameshot gui') end, { description = 'screenshot', group = 'hotkeys' }), + awful.key({ modkey, altkey, 'Control' }, 'l', function() awful.spawn('dm-tool lock') end, { description = 'lock', group = 'hotkeys' }), + awful.key({ modkey }, 's', hotkeys_popup.show_help), + + + ---- TAG ---- + -- NAVIGATION + awful.key({ modkey }, 'Left', awful.tag.viewprev, { description = 'view previous', group = 'tag' }), + awful.key({ modkey }, 'Right', awful.tag.viewnext, { description = 'view next', group = 'tag' }), + + awful.key({ altkey }, 'Left', function() lain.util.tag_view_nonempty(-1) end, { description = 'view previous nonempty', group = 'tag' }), + awful.key({ altkey }, 'Right', function() lain.util.tag_view_nonempty(1) end, { description = 'view next nonempty', group = 'tag' }), + + -- CREATE/MOVE/DELETE + awful.key({ modkey, 'Shift' }, 'n', function() lain.util.add_tag() end, { description = 'add new tag', group = 'tag' }), + awful.key({ modkey, 'Shift' }, 'r', function() lain.util.rename_tag() end, { description = 'rename tag', group = 'tag' }), + awful.key({ modkey, 'Shift' }, 'Left', function() lain.util.move_tag(-1) end, { description = 'move tag to the left', group = 'tag' }), + awful.key({ modkey, 'Shift' }, 'Right', function() lain.util.move_tag(1) end, { description = 'move tag to the right', group = 'tag' }), + awful.key({ modkey, 'Shift' }, 'd', function() lain.util.delete_tag() end, { description = 'delete tag', group = 'tag' }), + + + ---- CLIENT ---- + awful.key({ altkey }, 'j', function() awful.client.focus.byidx(1) end, { description = 'focus next by index', group = 'client' }), + awful.key({ altkey }, 'k', function() awful.client.focus.byidx(-1) end, { description = 'focus previous by index', group = 'client' }), + + awful.key({ modkey }, 'h', function() focus_bydirection('left') end, { description = 'focus left', group = 'client' }), + awful.key({ modkey }, 'j', function() focus_bydirection('down') end, { description = 'focus down', group = 'client' }), + awful.key({ modkey }, 'k', function() focus_bydirection('up') end, { description = 'focus up', group = 'client' }), + awful.key({ modkey }, 'l', function() focus_bydirection('right') end, { description = 'focus right', group = 'client' }), + + awful.key({ modkey }, 'u', awful.client.urgent.jumpto, { description = 'jump to urgent client', group = 'client' }), + + awful.key({ modkey, 'Control' }, 'n', function() + local c = awful.client.restore() + if c then c:emit_signal('request::activate', 'key.unminimize', { raise = true }) end + end, { description = 'restore minimized', group = 'client' }), + + + ---- AWESOME ---- + awful.key({ modkey }, 'b', function() for s in screen do s.wibox.visible = not s.wibox.visible end end, { description = 'toggle wibox', group = 'awesome' }), + + awful.key({ modkey, 'Control' }, 'r', awesome.restart, { description = 'reload awesome', group = 'awesome' }), + awful.key({ modkey, 'Shift', 'Control' }, 'q', awesome.quit, { description = 'quit awesome', group = 'awesome' }), + + + ---- PROGRAMS ---- + awful.key({ modkey }, 'Return', function() awful.spawn(globals.terminal) end, { description = 'open a terminal', group = 'programs' }), + awful.key({ modkey, altkey }, 'Return', function() quake:toggle() end, { description = 'Dropdown terminal', group = 'programs' }), + awful.key({ modkey }, 'y', function() + awful.spawn('rofi -show drun -theme "' .. os.getenv('HOME') .. '/.config/awesome/rofi/launcher.rasi"') + end, { description = 'show rofi', group = 'launcher' }), + awful.key({ modkey, 'Shift' }, 'y', function() + awful.spawn(os.getenv('HOME') .. '/.config/awesome/rofi/launcher_launcher.sh') + end, { description = 'show rofi', group = 'launcher' }), + + ---- LAYOUT ---- + awful.key({ modkey, altkey }, 'l', function() awful.tag.incmwfact(0.05) end, { description = 'increase master width factor', group = 'layout' }), + awful.key({ modkey, altkey }, 'h', function() awful.tag.incmwfact(-0.05) end, { description = 'decrease master width factor', group = 'layout' }), + awful.key({ modkey, 'Shift' }, 'h', function() awful.tag.incnmaster(1, nil, true) end, { description = 'increase the number of master clients', group = 'layout' }), + awful.key({ modkey, 'Shift' }, 'l', function() awful.tag.incnmaster(-1, nil, true) end, { description = 'decrease the number of master clients', group = 'layout' }), + awful.key({ modkey, 'Control' }, 'h', function() awful.tag.incncol(1, nil, true) end, { description = 'increase the number of columns', group = 'layout' }), + awful.key({ modkey, 'Control' }, 'l', function() awful.tag.incncol(-1, nil, true) end, { description = 'decrease the number of columns', group = 'layout' }), + awful.key({ modkey }, 'space', function() awful.layout.inc(1) end, { description = 'select next', group = 'layout' }), + awful.key({ modkey, 'Shift' }, 'space', function() awful.layout.inc(-1) end, { description = 'select previous', group = 'layout' }), + + ---- AUDIO KEYS ---- + awful.key({}, "XF86AudioMute", volume.toggle_mute), + awful.key({}, "XF86AudioLowerVolume", volume.vol_down), + awful.key({}, "XF86AudioRaiseVolume", volume.vol_up), + awful.key({ 'Control' }, "XF86AudioMute", mpris.play_pause), + awful.key({ 'Control' }, "XF86AudioLowerVolume", mpris.previous), + awful.key({ 'Control' }, "XF86AudioRaiseVolume", mpris.skip) +) + +-- Bind all key numbers to tags. +for i = 1, 9 do + globalkeys = gears.table.join( + globalkeys, + -- View tag only. + awful.key({ modkey }, '#' .. i + 9, function() + local screen = awful.screen.focused() + local tag = screen.tags[i] + if tag then + tag:view_only() + end + end, { description = 'view tag #' .. i, group = 'tag' }), + -- Move client to tag. + awful.key({ modkey, 'Shift' }, '#' .. i + 9, function() + if client.focus then + local tag = client.focus.screen.tags[i] + if tag then + client.focus:move_to_tag(tag) + end + end + end, { description = 'move focused client to tag #' .. i, group = 'tag' }) + ) +end + +return globalkeys diff --git a/src/globals.lua b/src/globals.lua new file mode 100644 index 0000000..f4aaaa9 --- /dev/null +++ b/src/globals.lua @@ -0,0 +1,7 @@ +return { + modkey = 'Mod4', + altkey = 'Mod1', + terminal = 'alacritty', + cycle_prev = true, + editor = 'nvim', +} diff --git a/src/layouts.lua b/src/layouts.lua new file mode 100644 index 0000000..9863543 --- /dev/null +++ b/src/layouts.lua @@ -0,0 +1,19 @@ +local awful = require('awful') + +tag.connect_signal("request::default_layouts", function() + awful.layout.append_default_layouts({ + awful.layout.suit.fair, + awful.layout.suit.fair.horizontal, + awful.layout.suit.tile, + awful.layout.suit.tile.left, + awful.layout.suit.tile.bottom, + awful.layout.suit.tile.top, + awful.layout.suit.spiral, + awful.layout.suit.spiral.dwindle, + awful.layout.suit.max, + awful.layout.suit.max.fullscreen, + awful.layout.suit.magnifier, + awful.layout.suit.corner.nw, + awful.layout.suit.floating + }) +end) diff --git a/src/theme/init.lua b/src/theme/init.lua new file mode 100644 index 0000000..0161556 --- /dev/null +++ b/src/theme/init.lua @@ -0,0 +1,106 @@ +local dpi = require('beautiful.xresources').apply_dpi +local naughty = require('naughty') + +local confdir = require('src.util.path').conf_dir + +local function load_settings() + local status, settings = pcall(function() + return dofile(confdir .. '/settings.lua') + end) + if status then + return settings + else + naughty.notify({ + preset = naughty.config.presets.critical, + title = 'Error while parsing settings!', + text = settings, + }) + return {} + end +end + +local settings = load_settings() + +return { + confdir = confdir, + wallpaper = confdir .. '/wallpapers/' .. (settings['wallpaper'] or 'wall.png'), + font = 'Terminus 8', + font_mono = 'Mononoki Nerd Font Mono 10', + bg_normal = '#000000', + bg_focus = '#000000', + bg_urgent = '#000000', + fg_normal = '#aaaaaa', + fg_focus = '#ff8c00', + fg_urgent = '#af1d18', + fg_minimize = '#ffffff', + border_width = 1, + border_normal = '#1c2022', + border_focus = '#606060', + border_marked = '#3ca4d8', + menu_border_width = 1, + menu_width = dpi(130), + menu_submenu_icon = confdir .. '/icons/submenu.png', + menu_fg_normal = '#aaaaaa', + menu_fg_focus = '#ff8c00', + menu_bg_normal = '#050505dd', + menu_bg_focus = '#050505dd', + widget_cpu = confdir .. '/icons/info/cpu.png', + widget_mem = confdir .. '/icons/info/mem.png', + widget_netdown = confdir .. '/icons/info/download.png', + widget_netup = confdir .. '/icons/info/upload.png', + widget_bat_charge = confdir .. '/icons/info/batcharge.png', + widget_bat_empty = confdir .. '/icons/info/batempty.png', + widget_bat_low = confdir .. '/icons/info/batlow.png', + widget_bat_mid = confdir .. '/icons/info/batmid.png', + widget_bat_high = confdir .. '/icons/info/bathigh.png', + widget_bat_full = confdir .. '/icons/info/batfull.png', + widget_vol_mute = confdir .. '/icons/info/volmute.png', + widget_vol_low = confdir .. '/icons/info/vollow.png', + widget_vol_high = confdir .. '/icons/info/volhigh.png', + widget_play = confdir .. '/icons/info/play.png', + widget_pause = confdir .. '/icons/info/pause.png', + widget_stop = confdir .. '/icons/info/stop.png', + taglist_fg_focus = '#000000', + taglist_bg_focus = '#b3b3b3', + taglist_squares_unsel = confdir .. '/icons/usedtag.png', + taglist_squares_resize = true, + useless_gap = 0, + layout_tile = confdir .. '/icons/tile.png', + layout_tilegaps = confdir .. '/icons/tilegaps.png', + layout_tileleft = confdir .. '/icons/tileleft.png', + layout_tilebottom = confdir .. '/icons/tilebottom.png', + layout_tiletop = confdir .. '/icons/tiletop.png', + layout_fairv = confdir .. '/icons/fairv.png', + layout_fairh = confdir .. '/icons/fairh.png', + layout_spiral = confdir .. '/icons/spiral.png', + layout_dwindle = confdir .. '/icons/dwindle.png', + layout_max = confdir .. '/icons/max.png', + layout_fullscreen = confdir .. '/icons/fullscreen.png', + layout_magnifier = confdir .. '/icons/magnifier.png', + layout_floating = confdir .. '/icons/floating.png', + titlebar_close_button_normal = confdir .. '/icons/titlebar/close_normal.png', + titlebar_close_button_focus = confdir .. '/icons/titlebar/close_focus.png', + titlebar_minimize_button_normal = confdir .. '/icons/titlebar/minimize_normal.png', + titlebar_minimize_button_focus = confdir .. '/icons/titlebar/minimize_focus.png', + titlebar_ontop_button_normal_inactive = confdir .. '/icons/titlebar/ontop_normal_inactive.png', + titlebar_ontop_button_focus_inactive = confdir .. '/icons/titlebar/ontop_focus_inactive.png', + titlebar_ontop_button_normal_active = confdir .. '/icons/titlebar/ontop_normal_active.png', + titlebar_ontop_button_focus_active = confdir .. '/icons/titlebar/ontop_focus_active.png', + titlebar_sticky_button_normal_inactive = confdir .. '/icons/titlebar/sticky_normal_inactive.png', + titlebar_sticky_button_focus_inactive = confdir .. '/icons/titlebar/sticky_focus_inactive.png', + titlebar_sticky_button_normal_active = confdir .. '/icons/titlebar/sticky_normal_active.png', + titlebar_sticky_button_focus_active = confdir .. '/icons/titlebar/sticky_focus_active.png', + titlebar_floating_button_normal_inactive = confdir .. '/icons/titlebar/floating_normal_inactive.png', + titlebar_floating_button_focus_inactive = confdir .. '/icons/titlebar/floating_focus_inactive.png', + titlebar_floating_button_normal_active = confdir .. '/icons/titlebar/floating_normal_active.png', + titlebar_floating_button_focus_active = confdir .. '/icons/titlebar/floating_focus_active.png', + titlebar_maximized_button_normal_inactive = confdir .. '/icons/titlebar/maximized_normal_inactive.png', + titlebar_maximized_button_focus_inactive = confdir .. '/icons/titlebar/maximized_focus_inactive.png', + titlebar_maximized_button_normal_active = confdir .. '/icons/titlebar/maximized_normal_active.png', + titlebar_maximized_button_focus_active = confdir .. '/icons/titlebar/maximized_focus_active.png', + tasklist_fg_minimize = '#b3b3b3', + tasklist_bg_minimize = '#4d4d4d', + tasklist_plain_task_name = true, + tasklist_disable_icon = true, + systray_screen = settings.systray_screen or 1 +} diff --git a/src/theme/screen.lua b/src/theme/screen.lua new file mode 100644 index 0000000..bc087ba --- /dev/null +++ b/src/theme/screen.lua @@ -0,0 +1,83 @@ +local awful = require('awful') +local gears = require('gears') +local wibox = require('wibox') +local dpi = require('beautiful.xresources').apply_dpi +local theme = require('src.theme') +local widgets = require('src.widgets') + +local info_widgets = {} +for i = #widgets, 1, -1 do + table.insert(info_widgets, wibox.widget.separator({ orientation = 'vertical', forced_width = 9, thickness = 1, span_ratio = 0.7, color = theme.fg_normal })) + table.insert(info_widgets, widgets[i]) +end +info_widgets['layout'] = wibox.layout.fixed.horizontal + +local layout_buttons = gears.table.join( + awful.button({}, 1, function() awful.layout.inc(1) end), + awful.button({}, 2, function() awful.layout.set(awful.layout.layouts[1]) end), + awful.button({}, 3, function() awful.layout.inc(-1) end), + awful.button({}, 4, function() awful.layout.inc(1) end), + awful.button({}, 5, function() awful.layout.inc(-1) end) +) + +local taglist_buttons = gears.table.join( + awful.button({}, 1, function(t) t:view_only() end), + awful.button({ 'shift' }, 1, function(t) if client.focus then client.focus:move_to_tag(t) end end), + awful.button({}, 3, awful.tag.viewtoggle), + awful.button({ 'shift' }, 3, function(t) if client.focus then client.focus:toggle_tag(t) end end), + awful.button({}, 4, function(t) awful.tag.viewnext(t.screen) end), + awful.button({}, 5, function(t) awful.tag.viewprev(t.screen) end) +) + +local tasklist_buttons = gears.table.join( + awful.button({}, 1, function(c) c:emit_signal('request::activate', 'tasklist', { raise = true }) end) +) + +screen.connect_signal('property::geometry', function(s) gears.wallpaper.maximized(theme.wallpaper, s, true) end) + +return function(s) + gears.wallpaper.maximized(theme.wallpaper, s, true) + + awful.tag.new({'1', '2', '3', '4', '5'}, s, awful.layout.suit.fair) + + local tasklist = awful.widget.tasklist({ + screen = s, + filter = awful.widget.tasklist.filter.minimizedcurrenttags, + buttons = tasklist_buttons, + style = { shape = gears.shape.rectangle }, + layout = { + spacing = 5, + layout = wibox.layout.flex.horizontal, + }, + widget_template = { + { + { id = 'text_role', widget = wibox.widget.textbox }, + left = 10, + right = 10, + widget = wibox.container.margin, + }, + id = 'background_role', + widget = wibox.container.background, + }, + }) + + s.wibox = awful.wibar({ position = 'top', screen = s, height = dpi(19), bg = theme.bg_normal, fg = theme.fg_normal }) + + if s.index == theme.systray_screen then + local tray = wibox.widget.systray() + tray.screen = s + table.insert(info_widgets, 1, tray) + end + + s.wibox:setup({ + layout = wibox.layout.align.horizontal, + { + layout = wibox.layout.fixed.horizontal, + awful.widget.layoutbox({ screen = s, buttons = layout_buttons }), + awful.widget.taglist({ screen = s, filter = function() return true end, buttons = taglist_buttons}) + }, + wibox.container.margin(tasklist, 10, 10, 0, 0), + info_widgets, + { widget = wibox.container.margin, left = 50, { widget = wibox.widget.textbox } } + }) +end diff --git a/src/util/mpris.lua b/src/util/mpris.lua new file mode 100644 index 0000000..6b6fb8c --- /dev/null +++ b/src/util/mpris.lua @@ -0,0 +1,17 @@ +local function play_pause() + os.execute('playerctl play-pause') +end + +local function previous() + os.execute('playerctl previous') +end + +local function skip() + os.execute('playerctl next') +end + +return { + play_pause = play_pause, + skip = skip, + previous = previous +} diff --git a/src/util/path.lua b/src/util/path.lua new file mode 100644 index 0000000..504524f --- /dev/null +++ b/src/util/path.lua @@ -0,0 +1,7 @@ +local fs = require('gears.filesystem') + +print(awesome.conffile) + +return { + conf_dir = awesome.conffile:match('^(.+)/') +} \ No newline at end of file diff --git a/src/util/volume.lua b/src/util/volume.lua new file mode 100644 index 0000000..b3517bd --- /dev/null +++ b/src/util/volume.lua @@ -0,0 +1,23 @@ +local volume_changed_signal = 'volume_changed' + +local function toggle_mute() + os.execute('wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle') + awesome.emit_signal(volume_changed_signal) +end + +local function vol_up() + os.execute('wpctl set-volume @DEFAULT_AUDIO_SINK@ 1%+') + awesome.emit_signal(volume_changed_signal) +end + +local function vol_down() + os.execute('wpctl set-volume @DEFAULT_AUDIO_SINK@ 1%-') + awesome.emit_signal(volume_changed_signal) +end + +return { + volume_changed_signal = volume_changed_signal, + toggle_mute = toggle_mute, + vol_up = vol_up, + vol_down = vol_down, +} diff --git a/src/widgets/1_clock.lua b/src/widgets/1_clock.lua new file mode 100644 index 0000000..a2adcbe --- /dev/null +++ b/src/widgets/1_clock.lua @@ -0,0 +1,18 @@ +local theme = require('src.theme') +local lain = require('lain') +local wibox = require('wibox') + +os.setlocale(os.getenv('LANG')) -- to localize the clock +local clock = wibox.widget.textclock('%I:%M %a %d.%m') +clock.font = theme.font + +lain.widget.cal({ + attach_to = { clock }, + notification_preset = { + font = theme.font_mono, + fg = theme.fg_normal, + bg = theme.bg_normal + }, +}) + +return { clock } diff --git a/src/widgets/2_fs.lua b/src/widgets/2_fs.lua new file mode 100644 index 0000000..3fa8cc3 --- /dev/null +++ b/src/widgets/2_fs.lua @@ -0,0 +1,17 @@ +local awful = require('awful') +local lain = require('lain') +local theme = require('src.theme') + +local fs = lain.widget.fs({ + notification_preset = { font = theme.font_mono, fg = theme.fg_normal }, + settings = function() + -- luacheck: globals widget fs_now + widget:set_text( + fs_now['/'].percentage .. '% (' .. string.format('%.3f', fs_now['/'].free) .. ' ' .. fs_now['/'].units .. ' left)' + ) + end, +}) + +fs.widget:buttons(awful.button({}, 1, function() awful.spawn('krusader') end)) + +return { fs.widget } diff --git a/src/widgets/3_cpu.lua b/src/widgets/3_cpu.lua new file mode 100644 index 0000000..5b2b6e0 --- /dev/null +++ b/src/widgets/3_cpu.lua @@ -0,0 +1,11 @@ +local theme = require('src.theme') +local lain = require('lain') +local wibox = require('wibox') +local cpu = lain.widget.cpu({ + settings = function() + -- luacheck: globals widget cpu_now + widget:set_text(cpu_now.usage .. '%') + end, +}) + +return { wibox.layout.fixed.horizontal(wibox.widget.imagebox(theme.widget_cpu), cpu.widget) } diff --git a/src/widgets/4_mem.lua b/src/widgets/4_mem.lua new file mode 100644 index 0000000..a9a151d --- /dev/null +++ b/src/widgets/4_mem.lua @@ -0,0 +1,12 @@ +local wibox = require('wibox') +local lain = require('lain') +local theme = require('src.theme') + +local memory = lain.widget.mem({ + settings = function() + -- luacheck: globals widget mem_now + widget:set_text(mem_now.used .. 'M') + end, +}) + +return { wibox.layout.fixed.horizontal(wibox.widget.imagebox(theme.widget_mem), memory.widget) } diff --git a/src/widgets/5_vol.lua b/src/widgets/5_vol.lua new file mode 100644 index 0000000..709c12b --- /dev/null +++ b/src/widgets/5_vol.lua @@ -0,0 +1,52 @@ +local wibox = require('wibox') +local awful = require('awful') +local gears = require('gears') +local theme = require('src.theme') +local volume = require('src.util.volume') + +local volumeicon = wibox.widget.imagebox(theme.widget_vol_mute) +local volume_widget = wibox.widget.textbox() + +local function spawn_callback(stdout) + local volume_str = stdout:sub(9,12):gsub('[.]', '') + local mute = stdout:match('MUTED') + local level = tonumber(volume_str) + if level == nil then + volume_widget:set_markup('Waiting') + return + end + if mute then + volumeicon:set_image(theme.widget_vol_mute) + elseif level == 0 then + volumeicon:set_image(theme.widget_vol_mute) + elseif level <= 50 then + volumeicon:set_image(theme.widget_vol_low) + else + volumeicon:set_image(theme.widget_vol_high) + end + volume_widget:set_markup(level .. (mute and 'M' or '%')) +end + +local function timer_callback() + awful.spawn.easy_async('wpctl get-volume @DEFAULT_AUDIO_SINK@', spawn_callback) +end + +local volume_timer = gears.timer { + timeout = 30, + autostart = true, + call_now = true, + callback = timer_callback +} + +awesome.connect_signal(volume.volume_changed_signal, function() volume_timer:emit_signal('timeout') end) + +local volumebuttons = awful.util.table.join( + awful.button({}, 1, volume.toggle_mute), + awful.button({}, 4, volume.vol_up), + awful.button({}, 5, volume.vol_down) +) + +volume_widget:buttons(volumebuttons) +volumeicon:buttons(volumebuttons) + +return { wibox.layout.fixed.horizontal(volumeicon, volume_widget) } diff --git a/src/widgets/6_net.lua b/src/widgets/6_net.lua new file mode 100644 index 0000000..9a473f5 --- /dev/null +++ b/src/widgets/6_net.lua @@ -0,0 +1,17 @@ +local wibox = require('wibox') +local lain = require('lain') +local theme = require('src.theme') + +local netdowninfo = wibox.widget.textbox() +local netupinfo = lain.widget.net({ + settings = function() + -- luacheck: globals widget net_now + widget:set_text(net_now.sent) + netdowninfo:set_text(net_now.received) + end, +}) + +return { + wibox.layout.fixed.horizontal(wibox.widget.imagebox(theme.widget_netdown), netdowninfo), + wibox.layout.fixed.horizontal(wibox.widget.imagebox(theme.widget_netup), netupinfo.widget), +} diff --git a/src/widgets/7_mpris.lua b/src/widgets/7_mpris.lua new file mode 100644 index 0000000..55c2157 --- /dev/null +++ b/src/widgets/7_mpris.lua @@ -0,0 +1,77 @@ +local wibox = require('wibox') +local awful = require('awful') +local lgi = require('lgi') +local theme = require('src.theme') +local mpris = require('src.util.mpris') + +local mpris_icon = wibox.widget.imagebox(theme.widget_pause) +local mpris_widget = wibox.widget.textbox() + +local function variant_strip(v) + if not tostring(v):find("GLib%.Variant$") then + if type(v) == "table" and #v > 0 then + v.n = nil + end + return v + end + + if v:is_container() and not v:is_of_type(lgi.GLib.VariantType.VARIANT) then + local out = {} + local n_children = v:n_children() + local idx = 0 + + local is_dict = v:is_of_type(lgi.GLib.VariantType.DICTIONARY) + while idx < n_children do + local val = v:get_child_value(idx) + idx = idx + 1 + if is_dict then + local key = val[1] + local value = variant_strip(val[2]) + out[key] = variant_strip(value) + else + out[idx] = variant_strip(val) + end + end + + return out + else + return variant_strip(v.value) + end +end + +local function signal_cbk(_conn, _sender, _object_path, _interface_name, _signal_name, params, _user_data) + local data = variant_strip(params) + if type(data) ~= 'table' or type(data[2]) ~= 'table' then return end + data = data[2] + if data['PlaybackStatus'] then + if data['PlaybackStatus'] == 'Playing' then + mpris_icon:set_image(theme.widget_play) + elseif data['PlaybackStatus'] == 'Paused' then + mpris_icon:set_image(theme.widget_pause) + else + mpris_icon:set_image(theme.widget_stop) + mpris_widget.text = 'Nothing playing' + end + elseif data['Metadata'] then + data = data['Metadata'] + local title = data['xesam:title'] or '' + local artist = (data['xesam:artist'] or {})[1] or '' + mpris_widget.text = artist .. ' | ' .. title + end +end + +lgi.Gio.bus_get_sync(lgi.Gio.BusType.SESSION):signal_subscribe( + nil, 'org.freedesktop.DBus.Properties', 'PropertiesChanged', '/org/mpris/MediaPlayer2', + nil, lgi.Gio.DBusSignalFlags.NONE, signal_cbk +) + +local mpris_buttons = awful.util.table.join( + awful.button({}, 1, mpris.play_pause), + awful.button({}, 2, mpris.previous), + awful.button({}, 3, mpris.skip) +) + +mpris_icon:buttons(mpris_buttons) +mpris_widget:buttons(mpris_buttons) + +return { wibox.layout.fixed.horizontal(mpris_icon, mpris_widget) } diff --git a/src/widgets/init.lua b/src/widgets/init.lua new file mode 100644 index 0000000..23b6f24 --- /dev/null +++ b/src/widgets/init.lua @@ -0,0 +1,11 @@ +local gears = require('gears') + +return gears.table.join( + require('src.widgets.1_clock'), + require('src.widgets.2_fs'), + require('src.widgets.3_cpu'), + require('src.widgets.4_mem'), + require('src.widgets.5_vol'), + require('src.widgets.6_net'), + require('src.widgets.7_mpris') +) \ No newline at end of file diff --git a/unused/battery.lua b/unused/battery.lua new file mode 100644 index 0000000..d9441fd --- /dev/null +++ b/unused/battery.lua @@ -0,0 +1,35 @@ +local theme = require('theme.base_theme') +local lain = require('lain') +local wibox = require('wibox') + +local baticon = wibox.widget.imagebox(nil) +local bat = lain.widget.bat({ + settings = function() + -- luacheck: globals widget bat_now + if bat_now.ac_status == 1 or bat_now.perc == 'N/A' then + baticon:set_image(theme.widget_bat_charge) + elseif bat_now.perc < 5 then + baticon:set_image(theme.widget_bat_empty) + elseif bat_now.perc < 15 then + baticon:set_image(theme.widget_bat_low) + elseif bat_now.perc < 50 then + baticon:set_image(theme.widget_bat_mid) + elseif bat_now.perc < 95 then + baticon:set_image(theme.widget_bat_high) + else + baticon:set_image(theme.widget_bat_full) + end + local perc = bat_now.perc ~= 'N/A' and bat_now.perc .. '%' or bat_now.perc + + if bat_now.ac_status == 1 then + perc = perc .. ' plug' + end + + widget:set_text(perc) + end, +}) + +return { { + widget = wibox.layout.fixed.horizontal(baticon, bat.widget), + bg = '#f1af5f', +} } diff --git a/wallpapers/1658797980842330.jpg b/wallpapers/1658797980842330.jpg new file mode 100644 index 0000000..ac901cd Binary files /dev/null and b/wallpapers/1658797980842330.jpg differ diff --git a/wallpapers/wall.png b/wallpapers/wall.png new file mode 100644 index 0000000..fa84f0e Binary files /dev/null and b/wallpapers/wall.png differ diff --git a/wallpapers/wall2.png b/wallpapers/wall2.png new file mode 100644 index 0000000..308bebd Binary files /dev/null and b/wallpapers/wall2.png differ diff --git a/wallpapers/wall3.png b/wallpapers/wall3.png new file mode 100644 index 0000000..e68f99e Binary files /dev/null and b/wallpapers/wall3.png differ diff --git a/wallpapers/wall4.png b/wallpapers/wall4.png new file mode 100644 index 0000000..5fb0d34 Binary files /dev/null and b/wallpapers/wall4.png differ diff --git a/wallpapers/wall5.png b/wallpapers/wall5.png new file mode 100644 index 0000000..d682735 Binary files /dev/null and b/wallpapers/wall5.png differ diff --git a/wallpapers/wall6.png b/wallpapers/wall6.png new file mode 100644 index 0000000..d66c5ed Binary files /dev/null and b/wallpapers/wall6.png differ