diff --git a/config/apps.lua b/config/apps.lua index 43885cf..93718e0 100644 --- a/config/apps.lua +++ b/config/apps.lua @@ -24,6 +24,8 @@ return { }, -- List of apps to start once on start-up run_on_start_up = { + 'telegram-desktop', + 'signal-desktop', -- 'compton --config ' .. filesystem.get_configuration_dir() .. '/configuration/compton.conf', 'nm-applet --indicator', -- wifi 'pa-applet', -- shows an audiocontrol applet in systray when installed. @@ -33,12 +35,15 @@ return { -- 'scream -u -p 4011 -i virbr1', -- scream audio sink 'numlock on', -- enable numlock 'feh --randomize --bg-fill ~/.wallpapers/*', - -- '/usr/bin/variety', <-- mayby turn it on again + '/usr/bin/variety', --<-- mayby turn it on again + 'kdeconnect-app', + -- 'echo keepassMasterPassword | keepassxc --pw-stdin ~/.config/.kp/Passwords.kdbx', + 'gnome-keyring-query get keepass | keepassxc --pw-stdin ~/.config/.kp/Passwords.kdbx', -- '/usr/lib/policykit-1-gnome/polkit-gnome-authentication-agent-1 & eval $(gnome-keyring-daemon -s --components=pkcs11,secrets,ssh,gpg)', -- credential manager - --KDE '/usr/lib/x86_64-linux-gnu/libexec/polkit-kde-authentication-agent-1 & eval $(gnome-keyring-daemon -s --components=pkcs11,secrets,ssh,gpg)', -- credential manager + -- KDE '/usr/lib/x86_64-linux-gnu/libexec/polkit-kde-authentication-agent-1 & eval $(gnome-keyring-daemon -s --components=pkcs11,secrets,ssh,gpg)', -- credential manager -- MATE'/usr/lib/mate-polkit/polkit-mate-authentication-agent-1 & eval $(gnome-keyring-daemon -s --components=pkcs11,secrets,ssh,gpg)', -- credential manager - -- 'flameshot', + 'flameshot', -- 'synology-drive -minimized', -- 'steam -silent', -- 'telegram-desktop', diff --git a/config/keys/bindings/hotkeys.lua b/config/keys/bindings/hotkeys.lua index f4190bc..a4789f8 100644 --- a/config/keys/bindings/hotkeys.lua +++ b/config/keys/bindings/hotkeys.lua @@ -93,6 +93,6 @@ local hotkeys = awful.util.table.join( end, {description = 'next background', group = group} ) -) - +) + return hotkeys diff --git a/config/tags/init.lua b/config/tags/init.lua index b2938b5..3cd1bad 100644 --- a/config/tags/init.lua +++ b/config/tags/init.lua @@ -3,7 +3,7 @@ local gears = require('gears') local beautiful = require('beautiful') local defaultApp = require('config.apps') -local icons = require('theme.icons') +local icons = require('themes.icons') _G.screens = {1} -- checks if there are as many screens as I want to have. diff --git a/lain/.gitmodules b/lain/.gitmodules new file mode 100644 index 0000000..d95bcb5 --- /dev/null +++ b/lain/.gitmodules @@ -0,0 +1,3 @@ +[submodule "lain.wiki"] + path = wiki + url = https://github.com/lcpz/lain.wiki.git diff --git a/lain/ISSUE_TEMPLATE.md b/lain/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..e9dcc0b --- /dev/null +++ b/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/lain/LICENSE b/lain/LICENSE new file mode 100644 index 0000000..23cb790 --- /dev/null +++ b/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/lain/README.rst b/lain/README.rst new file mode 100644 index 0000000..098f6bc --- /dev/null +++ b/lain/README.rst @@ -0,0 +1,39 @@ +Lain +==== + +------------------------------------------------- +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_. Read the wiki_ for all the info. + +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't 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 you code works and does not break other parts of the module. + +- You eventually update ``wiki`` submodule with a thorough section. + +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 +.. _wiki: https://github.com/lcpz/lain/wiki +.. _lain.helpers: https://github.com/lcpz/lain/blob/master/helpers.lua diff --git a/lain/helpers.lua b/lain/helpers.lua new file mode 100644 index 0000000..4d75f7b --- /dev/null +++ b/lain/helpers.lua @@ -0,0 +1,203 @@ +--[[ + + 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 table = { sort = table.sort } + +-- 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(table, key) + local module = rawget(table, key) + return module or require(table._NAME .. '.' .. key) +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, stderr, reason, 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, stderr, reason, 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 + + table.sort(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 + +-- creates 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/lain/icons/cal/white/1.png b/lain/icons/cal/white/1.png new file mode 100644 index 0000000..a0faa20 Binary files /dev/null and b/lain/icons/cal/white/1.png differ diff --git a/lain/icons/cal/white/10.png b/lain/icons/cal/white/10.png new file mode 100644 index 0000000..7d9343b Binary files /dev/null and b/lain/icons/cal/white/10.png differ diff --git a/lain/icons/cal/white/11.png b/lain/icons/cal/white/11.png new file mode 100644 index 0000000..7af5e99 Binary files /dev/null and b/lain/icons/cal/white/11.png differ diff --git a/lain/icons/cal/white/12.png b/lain/icons/cal/white/12.png new file mode 100644 index 0000000..b164f85 Binary files /dev/null and b/lain/icons/cal/white/12.png differ diff --git a/lain/icons/cal/white/13.png b/lain/icons/cal/white/13.png new file mode 100644 index 0000000..fef74f3 Binary files /dev/null and b/lain/icons/cal/white/13.png differ diff --git a/lain/icons/cal/white/14.png b/lain/icons/cal/white/14.png new file mode 100644 index 0000000..d747a6b Binary files /dev/null and b/lain/icons/cal/white/14.png differ diff --git a/lain/icons/cal/white/15.png b/lain/icons/cal/white/15.png new file mode 100644 index 0000000..64418a6 Binary files /dev/null and b/lain/icons/cal/white/15.png differ diff --git a/lain/icons/cal/white/16.png b/lain/icons/cal/white/16.png new file mode 100644 index 0000000..8b86700 Binary files /dev/null and b/lain/icons/cal/white/16.png differ diff --git a/lain/icons/cal/white/17.png b/lain/icons/cal/white/17.png new file mode 100644 index 0000000..033b5ff Binary files /dev/null and b/lain/icons/cal/white/17.png differ diff --git a/lain/icons/cal/white/18.png b/lain/icons/cal/white/18.png new file mode 100644 index 0000000..0cf1c24 Binary files /dev/null and b/lain/icons/cal/white/18.png differ diff --git a/lain/icons/cal/white/19.png b/lain/icons/cal/white/19.png new file mode 100644 index 0000000..bfd3530 Binary files /dev/null and b/lain/icons/cal/white/19.png differ diff --git a/lain/icons/cal/white/2.png b/lain/icons/cal/white/2.png new file mode 100644 index 0000000..e7f3fa4 Binary files /dev/null and b/lain/icons/cal/white/2.png differ diff --git a/lain/icons/cal/white/20.png b/lain/icons/cal/white/20.png new file mode 100644 index 0000000..9a5a1fb Binary files /dev/null and b/lain/icons/cal/white/20.png differ diff --git a/lain/icons/cal/white/21.png b/lain/icons/cal/white/21.png new file mode 100644 index 0000000..266ab9f Binary files /dev/null and b/lain/icons/cal/white/21.png differ diff --git a/lain/icons/cal/white/22.png b/lain/icons/cal/white/22.png new file mode 100644 index 0000000..f486289 Binary files /dev/null and b/lain/icons/cal/white/22.png differ diff --git a/lain/icons/cal/white/23.png b/lain/icons/cal/white/23.png new file mode 100644 index 0000000..244dceb Binary files /dev/null and b/lain/icons/cal/white/23.png differ diff --git a/lain/icons/cal/white/24.png b/lain/icons/cal/white/24.png new file mode 100644 index 0000000..0ce1c75 Binary files /dev/null and b/lain/icons/cal/white/24.png differ diff --git a/lain/icons/cal/white/25.png b/lain/icons/cal/white/25.png new file mode 100644 index 0000000..48d279c Binary files /dev/null and b/lain/icons/cal/white/25.png differ diff --git a/lain/icons/cal/white/26.png b/lain/icons/cal/white/26.png new file mode 100644 index 0000000..7535855 Binary files /dev/null and b/lain/icons/cal/white/26.png differ diff --git a/lain/icons/cal/white/27.png b/lain/icons/cal/white/27.png new file mode 100644 index 0000000..2aa9074 Binary files /dev/null and b/lain/icons/cal/white/27.png differ diff --git a/lain/icons/cal/white/28.png b/lain/icons/cal/white/28.png new file mode 100644 index 0000000..0201976 Binary files /dev/null and b/lain/icons/cal/white/28.png differ diff --git a/lain/icons/cal/white/29.png b/lain/icons/cal/white/29.png new file mode 100644 index 0000000..9305b9b Binary files /dev/null and b/lain/icons/cal/white/29.png differ diff --git a/lain/icons/cal/white/3.png b/lain/icons/cal/white/3.png new file mode 100644 index 0000000..f1eb5de Binary files /dev/null and b/lain/icons/cal/white/3.png differ diff --git a/lain/icons/cal/white/30.png b/lain/icons/cal/white/30.png new file mode 100644 index 0000000..1ba61aa Binary files /dev/null and b/lain/icons/cal/white/30.png differ diff --git a/lain/icons/cal/white/31.png b/lain/icons/cal/white/31.png new file mode 100644 index 0000000..e9a873b Binary files /dev/null and b/lain/icons/cal/white/31.png differ diff --git a/lain/icons/cal/white/4.png b/lain/icons/cal/white/4.png new file mode 100644 index 0000000..ee1ed6a Binary files /dev/null and b/lain/icons/cal/white/4.png differ diff --git a/lain/icons/cal/white/5.png b/lain/icons/cal/white/5.png new file mode 100644 index 0000000..466aa71 Binary files /dev/null and b/lain/icons/cal/white/5.png differ diff --git a/lain/icons/cal/white/6.png b/lain/icons/cal/white/6.png new file mode 100644 index 0000000..0a7bf4d Binary files /dev/null and b/lain/icons/cal/white/6.png differ diff --git a/lain/icons/cal/white/7.png b/lain/icons/cal/white/7.png new file mode 100644 index 0000000..e971951 Binary files /dev/null and b/lain/icons/cal/white/7.png differ diff --git a/lain/icons/cal/white/8.png b/lain/icons/cal/white/8.png new file mode 100644 index 0000000..cb03d0b Binary files /dev/null and b/lain/icons/cal/white/8.png differ diff --git a/lain/icons/cal/white/9.png b/lain/icons/cal/white/9.png new file mode 100644 index 0000000..fca554a Binary files /dev/null and b/lain/icons/cal/white/9.png differ diff --git a/lain/icons/layout/default/cascade.png b/lain/icons/layout/default/cascade.png new file mode 100644 index 0000000..292a057 Binary files /dev/null and b/lain/icons/layout/default/cascade.png differ diff --git a/lain/icons/layout/default/cascadetile.png b/lain/icons/layout/default/cascadetile.png new file mode 100644 index 0000000..ba30f43 Binary files /dev/null and b/lain/icons/layout/default/cascadetile.png differ diff --git a/lain/icons/layout/default/cascadetilew.png b/lain/icons/layout/default/cascadetilew.png new file mode 100644 index 0000000..d15eb70 Binary files /dev/null and b/lain/icons/layout/default/cascadetilew.png differ diff --git a/lain/icons/layout/default/cascadew.png b/lain/icons/layout/default/cascadew.png new file mode 100644 index 0000000..da64bd6 Binary files /dev/null and b/lain/icons/layout/default/cascadew.png differ diff --git a/lain/icons/layout/default/centerfair.png b/lain/icons/layout/default/centerfair.png new file mode 100644 index 0000000..188c243 Binary files /dev/null and b/lain/icons/layout/default/centerfair.png differ diff --git a/lain/icons/layout/default/centerfairw.png b/lain/icons/layout/default/centerfairw.png new file mode 100644 index 0000000..ed4bcf5 Binary files /dev/null and b/lain/icons/layout/default/centerfairw.png differ diff --git a/lain/icons/layout/default/centerwork.png b/lain/icons/layout/default/centerwork.png new file mode 100644 index 0000000..51e06bc Binary files /dev/null and b/lain/icons/layout/default/centerwork.png differ diff --git a/lain/icons/layout/default/centerworkh.png b/lain/icons/layout/default/centerworkh.png new file mode 100644 index 0000000..c59092f Binary files /dev/null and b/lain/icons/layout/default/centerworkh.png differ diff --git a/lain/icons/layout/default/centerworkhw.png b/lain/icons/layout/default/centerworkhw.png new file mode 100644 index 0000000..7820f8c Binary files /dev/null and b/lain/icons/layout/default/centerworkhw.png differ diff --git a/lain/icons/layout/default/centerworkw.png b/lain/icons/layout/default/centerworkw.png new file mode 100644 index 0000000..85e6996 Binary files /dev/null and b/lain/icons/layout/default/centerworkw.png differ diff --git a/lain/icons/layout/default/termfair.png b/lain/icons/layout/default/termfair.png new file mode 100644 index 0000000..06226c1 Binary files /dev/null and b/lain/icons/layout/default/termfair.png differ diff --git a/lain/icons/layout/default/termfairw.png b/lain/icons/layout/default/termfairw.png new file mode 100644 index 0000000..0a8b576 Binary files /dev/null and b/lain/icons/layout/default/termfairw.png differ diff --git a/lain/icons/layout/zenburn/cascade.png b/lain/icons/layout/zenburn/cascade.png new file mode 100644 index 0000000..fbe4fac Binary files /dev/null and b/lain/icons/layout/zenburn/cascade.png differ diff --git a/lain/icons/layout/zenburn/cascadetile.png b/lain/icons/layout/zenburn/cascadetile.png new file mode 100644 index 0000000..2e03a80 Binary files /dev/null and b/lain/icons/layout/zenburn/cascadetile.png differ diff --git a/lain/icons/layout/zenburn/centerfair.png b/lain/icons/layout/zenburn/centerfair.png new file mode 100644 index 0000000..75dc993 Binary files /dev/null and b/lain/icons/layout/zenburn/centerfair.png differ diff --git a/lain/icons/layout/zenburn/centerwork.png b/lain/icons/layout/zenburn/centerwork.png new file mode 100644 index 0000000..af7a863 Binary files /dev/null and b/lain/icons/layout/zenburn/centerwork.png differ diff --git a/lain/icons/layout/zenburn/centerworkh.png b/lain/icons/layout/zenburn/centerworkh.png new file mode 100644 index 0000000..88019b3 Binary files /dev/null and b/lain/icons/layout/zenburn/centerworkh.png differ diff --git a/lain/icons/layout/zenburn/termfair.png b/lain/icons/layout/zenburn/termfair.png new file mode 100644 index 0000000..f7640b5 Binary files /dev/null and b/lain/icons/layout/zenburn/termfair.png differ diff --git a/lain/icons/mail.png b/lain/icons/mail.png new file mode 100644 index 0000000..9c0c7a3 Binary files /dev/null and b/lain/icons/mail.png differ diff --git a/lain/icons/no_net.png b/lain/icons/no_net.png new file mode 100644 index 0000000..3613372 Binary files /dev/null and b/lain/icons/no_net.png differ diff --git a/lain/icons/openweathermap/01d.png b/lain/icons/openweathermap/01d.png new file mode 100644 index 0000000..569965e Binary files /dev/null and b/lain/icons/openweathermap/01d.png differ diff --git a/lain/icons/openweathermap/01n.png b/lain/icons/openweathermap/01n.png new file mode 100644 index 0000000..ce5b135 Binary files /dev/null and b/lain/icons/openweathermap/01n.png differ diff --git a/lain/icons/openweathermap/02d.png b/lain/icons/openweathermap/02d.png new file mode 100644 index 0000000..2ba9799 Binary files /dev/null and b/lain/icons/openweathermap/02d.png differ diff --git a/lain/icons/openweathermap/02n.png b/lain/icons/openweathermap/02n.png new file mode 100644 index 0000000..12e4283 Binary files /dev/null and b/lain/icons/openweathermap/02n.png differ diff --git a/lain/icons/openweathermap/03d.png b/lain/icons/openweathermap/03d.png new file mode 100644 index 0000000..1cf0e9d Binary files /dev/null and b/lain/icons/openweathermap/03d.png differ diff --git a/lain/icons/openweathermap/03n.png b/lain/icons/openweathermap/03n.png new file mode 100644 index 0000000..89a42b8 Binary files /dev/null and b/lain/icons/openweathermap/03n.png differ diff --git a/lain/icons/openweathermap/04d.png b/lain/icons/openweathermap/04d.png new file mode 100644 index 0000000..e7fb67f Binary files /dev/null and b/lain/icons/openweathermap/04d.png differ diff --git a/lain/icons/openweathermap/04n.png b/lain/icons/openweathermap/04n.png new file mode 100644 index 0000000..e7fb67f Binary files /dev/null and b/lain/icons/openweathermap/04n.png differ diff --git a/lain/icons/openweathermap/09d.png b/lain/icons/openweathermap/09d.png new file mode 100644 index 0000000..cfa066a Binary files /dev/null and b/lain/icons/openweathermap/09d.png differ diff --git a/lain/icons/openweathermap/09n.png b/lain/icons/openweathermap/09n.png new file mode 100644 index 0000000..cfa066a Binary files /dev/null and b/lain/icons/openweathermap/09n.png differ diff --git a/lain/icons/openweathermap/10d.png b/lain/icons/openweathermap/10d.png new file mode 100644 index 0000000..712d0c8 Binary files /dev/null and b/lain/icons/openweathermap/10d.png differ diff --git a/lain/icons/openweathermap/10n.png b/lain/icons/openweathermap/10n.png new file mode 100644 index 0000000..712d0c8 Binary files /dev/null and b/lain/icons/openweathermap/10n.png differ diff --git a/lain/icons/openweathermap/11d.png b/lain/icons/openweathermap/11d.png new file mode 100644 index 0000000..3b62f7c Binary files /dev/null and b/lain/icons/openweathermap/11d.png differ diff --git a/lain/icons/openweathermap/11n.png b/lain/icons/openweathermap/11n.png new file mode 100644 index 0000000..3b62f7c Binary files /dev/null and b/lain/icons/openweathermap/11n.png differ diff --git a/lain/icons/openweathermap/13d.png b/lain/icons/openweathermap/13d.png new file mode 100644 index 0000000..e265b01 Binary files /dev/null and b/lain/icons/openweathermap/13d.png differ diff --git a/lain/icons/openweathermap/13n.png b/lain/icons/openweathermap/13n.png new file mode 100644 index 0000000..e265b01 Binary files /dev/null and b/lain/icons/openweathermap/13n.png differ diff --git a/lain/icons/openweathermap/50d.png b/lain/icons/openweathermap/50d.png new file mode 100644 index 0000000..905ace3 Binary files /dev/null and b/lain/icons/openweathermap/50d.png differ diff --git a/lain/icons/openweathermap/50n.png b/lain/icons/openweathermap/50n.png new file mode 100644 index 0000000..905ace3 Binary files /dev/null and b/lain/icons/openweathermap/50n.png differ diff --git a/lain/icons/openweathermap/README.md b/lain/icons/openweathermap/README.md new file mode 100644 index 0000000..f908fbd --- /dev/null +++ b/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/lain/icons/openweathermap/na.png b/lain/icons/openweathermap/na.png new file mode 100644 index 0000000..1cc5132 Binary files /dev/null and b/lain/icons/openweathermap/na.png differ diff --git a/lain/icons/taskwarrior.png b/lain/icons/taskwarrior.png new file mode 100644 index 0000000..c64fe86 Binary files /dev/null and b/lain/icons/taskwarrior.png differ diff --git a/lain/init.lua b/lain/init.lua new file mode 100644 index 0000000..b59d5dd --- /dev/null +++ b/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/lain/lain-git.rockspec b/lain/lain-git.rockspec new file mode 100644 index 0000000..3f1c2d5 --- /dev/null +++ b/lain/lain-git.rockspec @@ -0,0 +1,27 @@ +package = "lain" +version = "git" +source = { + url = "https://github.com/lcpz/lain", + tag = "git" +} +description = { + summary = "Layout, widgets and utilities for Awesome WM", + detailed = [[ + Successor of awesome-vain, this module provides alternative layouts, asynchronous widgets and utility functions for Awesome WM. + + Dependencies: curl (for IMAP, MPD and weather widgets); Glib >= 2.54 (for filesystems widget). + ]], + homepage = "https://github.com/lcpz/lain", + license = "GPL-2.0" +} +dependencies = { + "lua >= 5.1", + "awesome >= 4.0", + "Glib >= 2.54", + "curl" +} +supported_platforms = { "linux" } +build = { + type = "builtin", + modules = { lain = "init.lua" } +} diff --git a/lain/layout/cascade.lua b/lain/layout/cascade.lua new file mode 100644 index 0000000..cbc3877 --- /dev/null +++ b/lain/layout/cascade.lua @@ -0,0 +1,172 @@ +--[[ + + 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/lain/layout/centerwork.lua b/lain/layout/centerwork.lua new file mode 100644 index 0000000..cb83709 --- /dev/null +++ b/lain/layout/centerwork.lua @@ -0,0 +1,135 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2016, Henrik Antonsson + * (c) 2015, Joerg Jaspert + * (c) 2014, projektile + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local floor, max, screen = math.floor, math.max, 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 c, g = cls[1], {} + + -- 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[c] = g + + -- Auxiliary clients + if #cls <= 1 then return end + for i = 2, #cls do + local c, g = cls[i], {} + 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[c] = g + end +end + +function centerwork.arrange(p) + return arrange(p, centerwork) +end + +function centerwork.horizontal.arrange(p) + return arrange(p, centerwork.horizontal) +end + +return centerwork diff --git a/lain/layout/init.lua b/lain/layout/init.lua new file mode 100644 index 0000000..6478b06 --- /dev/null +++ b/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/lain/layout/termfair.lua b/lain/layout/termfair.lua new file mode 100644 index 0000000..f57f715 --- /dev/null +++ b/lain/layout/termfair.lua @@ -0,0 +1,239 @@ +--[[ + + 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 = { ceil = math.ceil, + floor = math.floor, + max = math.max } +local screen = screen +local tonumber = tonumber + +local termfair = { name = "termfair" } +termfair.center = { name = "centerfair" } + +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 + + 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 now + -- one above it is created. Like this: + + -- (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 | + -- +---+---+---+ +---+---+---+ +---+---+---+ + + -- 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) + + 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 == "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 | + -- +---+---+---+ +---+---+---+ + + -- How many vertical columns? Read from nmaster on the tag. + local num_x = tonumber(termfair.center.nmaster) or t.master_count + local ncol = tonumber(termfair.center.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 #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 j = 0, (num_y[i]-2) do + local 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 + local 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.arrange(p) + return do_fair(p, "west") +end + +return termfair diff --git a/lain/util/dkjson.lua b/lain/util/dkjson.lua new file mode 100644 index 0000000..89aa2e1 --- /dev/null +++ b/lain/util/dkjson.lua @@ -0,0 +1,713 @@ +-- Module options: +local always_try_using_lpeg = true +local register_global_module_table = false +local global_module_name = 'json' + +--[==[ + +David Kolf's JSON module for Lua 5.1/5.2 + +Version 2.5 + + +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-2013 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, rawset = + pairs, type, tostring, tonumber, getmetatable, setmetatable, rawset +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.5" } + +if register_global_module_table then + _G[global_module_name] = json +end + +local _ENV = nil -- blocking globals in Lua 5.2 + +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 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 len = strlen (str) + 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 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 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"\"" + Err "unterminated 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 npos + local t, nt = {}, 0 + repeat + obj, cont, npos = pegmatch (ArrayContent, str, pos, nullval, state) + if not npos then break end + pos = npos + nt = nt + 1 + t[nt] = obj + until cont == 'last' + return pos, setmetatable (t, state.arraymeta) + end + + local function parseobject (str, pos, nullval, state) + local obj, key, cont + local npos + local t = {} + repeat + key, obj, cont, npos = pegmatch (ObjectContent, str, pos, nullval, state) + if not npos then break end + pos = npos + t[key] = obj + until cont == 'last' + return pos, setmetatable (t, state.objectmeta) + end + + local Array = P"[" * g.Cmt (g.Carg(1) * g.Carg(2), parsearray) * Space * (P"]" + Err "']' expected") + local Object = P"{" * g.Cmt (g.Carg(1) * g.Carg(2), parseobject) * Space * (P"}" + Err "'}' expected") + local Value = Space * (Array + Object + SimpleValue) + local ExpectedValue = Value + Space * Err "value expected" + ArrayContent = Value * Space * (P"," * g.Cc'cont' + g.Cc'last') * g.Cp() + local Pair = g.Cg (Space * String * Space * (P":" + Err "colon expected") * ExpectedValue) + ObjectContent = Pair * Space * (P"," * g.Cc'cont' + g.Cc'last') * g.Cp() + local DecodeValue = ExpectedValue * g.Cp () + + function json.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 + + -- use this function only once: + json.use_lpeg = function () return json end + + json.using_lpeg = true + + return json -- so you can get the module using json = require "dkjson".use_lpeg() +end + +if always_try_using_lpeg then + pcall (json.use_lpeg) +end + +return json diff --git a/lain/util/init.lua b/lain/util/init.lua new file mode 100644 index 0000000..8b8e719 --- /dev/null +++ b/lain/util/init.lua @@ -0,0 +1,167 @@ +--[[ + + 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 k, 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) + local s = sc or awful.screen.focused() + + for i = 1, #s.tags do + awful.tag.viewidx(direction, s) + if #s.clients > 0 then + return + end + end +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) + local scr = awful.screen.focused() + scr.selected_tag.gap = scr.selected_tag.gap + tonumber(thatmuch) + awful.layout.arrange(scr) +end + +return setmetatable(util, { __index = wrequire }) diff --git a/lain/util/markup.lua b/lain/util/markup.lua new file mode 100644 index 0000000..9801331 --- /dev/null +++ b/lain/util/markup.lua @@ -0,0 +1,66 @@ +--[[ + + Licensed under MIT License + * (c) 2013, Luca CPZ + * (c) 2009, Uli Schlachter + * (c) 2009, Majic + +--]] + +local string = { format = string.format } +local setmetatable = setmetatable + +-- Lain markup util submodule +-- lain.util.markup +local markup = { fg = {}, bg = {} } + +-- Convenience tags. +function markup.bold(text) return '' .. text .. '' end +function markup.italic(text) return '' .. text .. '' end +function markup.strike(text) return '' .. text .. '' end +function markup.underline(text) return '' .. text .. '' end +function markup.monospace(text) return '' .. text .. '' end +function markup.big(text) return '' .. text .. '' end +function markup.small(text) return '' .. text .. '' end + +-- Set the font. +function markup.font(font, text) + return '' .. text ..'' +end + +-- Set the foreground. +function markup.fg.color(color, text) + return '' .. text .. '' +end + +-- Set the background. +function markup.bg.color(color, text) + return '' .. text .. '' +end + +-- Set foreground and background. +function markup.color(fg, bg, text) + return string.format('%s', fg, bg, text) +end + +-- Set font and foreground. +function markup.fontfg(font, fg, text) + return string.format('%s', font, fg, text) +end + +-- Set font and background. +function markup.fontbg(font, bg, text) + return string.format('%s', font, bg, text) +end + +-- Set font, foreground and background. +function markup.fontcolor(font, fg, bg, text) + return string.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/lain/util/menu_iterator.lua b/lain/util/menu_iterator.lua new file mode 100644 index 0000000..0ea4e0e --- /dev/null +++ b/lain/util/menu_iterator.lua @@ -0,0 +1,144 @@ +--[[ + + 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 util = require("lain.util") +local atable = require("awful.util").table +local assert = assert +local pairs = pairs +local tconcat = table.concat +local unpack = unpack + +local state = { cid = nil } + +local function naughty_destroy_callback(reason) + local 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) + local timeout = timeout or 4 -- default timeout for each menu entry + local icon = icon or nil -- icon to display on the menu + + -- Build the list of choices + if not state.index then + 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/lain/util/quake.lua b/lain/util/quake.lua new file mode 100644 index 0000000..e323732 --- /dev/null +++ b/lain/util/quake.lua @@ -0,0 +1,171 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2016, Luca CPZ + * (c) 2015, unknown + +--]] + +local awful = require("awful") +local capi = { client = client } + +local math = { floor = math.floor } +local string = { format = string.format } + +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 + 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 + client:geometry(self.geometry[self.screen] 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:raise() + self.last_tag = self.screen.selected_tag + client:tags({self.screen.selected_tag}) + capi.client.focus = client + else + client.hidden = true + local ctags = client:tags() + for i, t in pairs(ctags) do + ctags[i] = nil + end + client:tags(ctags) + end + + return client +end + +function quake:compute_size() + -- skip if we already have a geometry for this screen + if not self.geometry[self.screen] then + local geom + if not self.overlap then + geom = screen[self.screen].workarea + else + geom = screen[self.screen].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] = { x = x, y = y, width = width, height = height } + end + return self.geometry[self.screen] +end + +function quake:new(config) + local conf = config or {} + + conf.app = conf.app or "xterm" -- application to spawn + conf.name = conf.name or "QuakeDD" -- window name + conf.argname = conf.argname or "-name %s" -- how to specify window name + conf.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 + + 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 + +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 + +return setmetatable(quake, { __call = function(_, ...) return quake:new(...) end }) diff --git a/lain/util/separators.lua b/lain/util/separators.lua new file mode 100644 index 0000000..29d3005 --- /dev/null +++ b/lain/util/separators.lua @@ -0,0 +1,101 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2015, Luca CPZ + * (c) 2015, plotnikovanton + +--]] + +local wibox = require("wibox") +local gears = require("gears") + +-- Lain Cairo separators util submodule +-- lain.util.separators +local separators = { height = 0, width = 9 } + +-- [[ Arrow + +-- Right +function separators.arrow_right(col1, col2) + local widget = wibox.widget.base.make_widget() + + widget.fit = function(m, w, h) + return separators.width, separators.height + end + + widget.draw = function(mycross, wibox, cr, width, height) + if col2 ~= "alpha" then + cr:set_source_rgb(gears.color.parse_color(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 col1 ~= "alpha" then + cr:set_source_rgb(gears.color.parse_color(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.fit = function(m, w, h) + return separators.width, separators.height + end + + widget.draw = function(mycross, wibox, cr, width, height) + if col1 ~= "alpha" then + cr:set_source_rgb(gears.color.parse_color(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 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_rgb(gears.color.parse_color(col2)) + cr:fill() + end + end + + return widget +end + +-- ]] + +return separators diff --git a/lain/widget/alsa.lua b/lain/widget/alsa.lua new file mode 100644 index 0000000..2d4891d --- /dev/null +++ b/lain/widget/alsa.lua @@ -0,0 +1,54 @@ +--[[ + + 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 = { match = string.match, + format = string.format } + +-- ALSA volume +-- lain.widget.alsa + +local function factory(args) + local alsa = { widget = wibox.widget.textbox() } + local args = args or {} + 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]*)") + 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/lain/widget/alsabar.lua b/lain/widget/alsabar.lua new file mode 100644 index 0000000..557e97b --- /dev/null +++ b/lain/widget/alsabar.lua @@ -0,0 +1,152 @@ +--[[ + + 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 = { modf = math.modf } +local string = { format = string.format, + match = string.match, + rep = string.rep } +local type, tonumber = type, 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" + } + + local 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 ticks = args.ticks or false + local ticks_size = args.ticks_size or 7 + + 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 = {} + 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 { + forced_height = height, + forced_width = width, + color = alsabar.colors.unmute, + background_color = alsabar.colors.background, + margins = 1, + paddings = 1, + 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 + -- 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 + + int = math.modf((alsabar._current_level / 100) * tot) + preset.text = string.format("[%s%s]", string.rep("|", int), + string.rep(" ", tot - int)) + + 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/lain/widget/bat.lua b/lain/widget/bat.lua new file mode 100644 index 0000000..34d63e5 --- /dev/null +++ b/lain/widget/bat.lua @@ -0,0 +1,200 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local first_line = require("lain.helpers").first_line +local newtimer = require("lain.helpers").newtimer +local naughty = require("naughty") +local wibox = require("wibox") +local math = { abs = math.abs, + floor = math.floor, + log10 = math.log10, + min = math.min } +local string = { format = string.format } +local ipairs = ipairs +local tonumber = tonumber + +-- Battery infos +-- lain.widget.bat + +local function factory(args) + local bat = { widget = wibox.widget.textbox() } + local args = args or {} + local timeout = args.timeout or 30 + local batteries = args.batteries or (args.battery and {args.battery}) or {"BAT0"} + local ac = args.ac or "AC0" + local notify = args.notify or "on" + local n_perc = args.n_perc or { 5, 15 } + local settings = args.settings or function() 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" + } + + bat_now.n_status = {} + bat_now.n_perc = {} + for i = 1, #batteries do + bat_now.n_status[i] = "N/A" + bat_now.n_perc[i] = 0 + end + + -- used to notify full charge only once before discharging + local fullnotification = false + + function bat.update() + 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 pspath = "/sys/class/power_supply/" + + for i, battery in ipairs(batteries) do + local bstr = pspath .. battery + local present = 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(first_line(bstr .. "/current_now")) + local rate_voltage = tonumber(first_line(bstr .. "/voltage_now")) + local rate_power = tonumber(first_line(bstr .. "/power_now")) + + -- energy_now(P)[uWh], charge_now(I)[uAh] + local energy_now = tonumber(first_line(bstr .. "/energy_now") or + first_line(bstr .. "/charge_now")) + + -- energy_full(P)[uWh], charge_full(I)[uAh] + local energy_full = tonumber(first_line(bstr .. "/energy_full") or + first_line(bstr .. "/charge_full")) + + local energy_percentage = tonumber(first_line(bstr .. "/capacity")) or + math.floor((energy_now / energy_full) * 100) + + bat_now.n_status[i] = first_line(bstr .. "/status") or "N/A" + bat_now.n_perc[i] = energy_percentage or bat_now.n_perc[i] + + 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) + end + end + + -- 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] + 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(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 not fullnotification then + bat.id = naughty.notify({ + preset = bat_notification_charged_preset, + replaces_id = bat.id + }).id + fullnotification = true + end + end + end + + newtimer("batteries", timeout, bat.update) + + return bat +end + +return factory diff --git a/lain/widget/calendar.lua b/lain/widget/calendar.lua new file mode 100644 index 0000000..84b025d --- /dev/null +++ b/lain/widget/calendar.lua @@ -0,0 +1,127 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +local helpers = require("lain.helpers") +local markup = require("lain.util.markup") +local awful = require("awful") +local naughty = require("naughty") +local mouse = mouse +local os = { date = os.date } +local string = { format = string.format, + gsub = string.gsub } +local ipairs = ipairs +local tonumber = tonumber +local setmetatable = setmetatable + +-- Calendar notification +-- lain.widget.calendar +local calendar = { offset = 0 } + +function calendar.hide() + if not calendar.notification then return end + naughty.destroy(calendar.notification) + calendar.notification = nil +end + +function calendar.show(t_out, inc_offset, scr) + local f, offs = nil, inc_offset or 0 + + calendar.notification_preset.screen = scr or (calendar.followtag and awful.screen.focused()) or 1 + calendar.offset = calendar.offset + offs + + local current_month = (offs == 0 or calendar.offset == 0) + + if current_month then -- today highlighted + calendar.offset = 0 + calendar.icon = calendar.icons:len() > 0 and string.format("%s%s.png", calendar.icons, tonumber(os.date("%d"))) + f = calendar.cal + else -- no current month showing, no day to highlight + local month = tonumber(os.date("%m")) + local year = tonumber(os.date("%Y")) + + month = month + calendar.offset + + while month > 12 do + month = month - 12 + year = year + 1 + end + + while month < 1 do + month = month + 12 + year = year - 1 + end + + calendar.icon = nil + f = string.format("%s %s %s", calendar.cal, month, year) + end + + helpers.async(f, function(ws) + local fg, bg = calendar.notification_preset.fg, calendar.notification_preset.bg + calendar.notification_preset.text = ws:gsub("%c%[%d+[m]?%s?%d+%c%[%d+[m]?", + markup.bold(markup.color(bg, fg, os.date("%e")))):gsub("[\n%s]*$", "") + + local widget_focused = true + + if t_out == 0 and mouse.current_widgets then + widget_focused = false + for i, widget in ipairs(calendar.attach_to) do + for _,v in ipairs(mouse.current_widgets) do + if widget == v then + widget_focused = true + break + end + end + end + end + + if widget_focused then + calendar.hide() + calendar.notification = naughty.notify({ + preset = calendar.notification_preset, + icon = calendar.icon, + timeout = t_out or calendar.notification_preset.timeout or 5 + }) + end + end) +end + +function calendar.hover_on() calendar.show(0) end +function calendar.hover_off() calendar.hide() end +function calendar.prev() calendar.show(0, -1) end +function calendar.next() calendar.show(0, 1) end + +function calendar.attach(widget) + widget:connect_signal("mouse::enter", calendar.hover_on) + widget:connect_signal("mouse::leave", calendar.hover_off) + widget:buttons(awful.util.table.join( + awful.button({}, 1, calendar.prev), + awful.button({}, 3, calendar.next), + awful.button({}, 2, calendar.hover_on), + awful.button({}, 4, calendar.prev), + awful.button({}, 5, calendar.next))) +end + +local function factory(args) + local args = args or {} + calendar.cal = args.cal or "/usr/bin/cal" + calendar.attach_to = args.attach_to or {} + calendar.followtag = args.followtag or false + calendar.icons = args.icons or helpers.icons_dir .. "cal/white/" + calendar.notification_preset = args.notification_preset + + if not calendar.notification_preset then + calendar.notification_preset = { + font = "Monospace 10", + fg = "#FFFFFF", + bg = "#000000" + } + end + + for i, widget in ipairs(calendar.attach_to) do calendar.attach(widget) end +end + +return setmetatable(calendar, { __call = function(_, ...) return factory(...) end }) diff --git a/lain/widget/contrib/init.lua b/lain/widget/contrib/init.lua new file mode 100644 index 0000000..9e863a5 --- /dev/null +++ b/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/lain/widget/contrib/kbdlayout.lua b/lain/widget/contrib/kbdlayout.lua new file mode 100644 index 0000000..5a503ab --- /dev/null +++ b/lain/widget/contrib/kbdlayout.lua @@ -0,0 +1,77 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2015, Dario Gjorgjevski + +--]] + +local helpers = require("lain.helpers") +local awful = require("awful") +local wibox = require("wibox") +local string = { format = string.format, + match = string.match } +local execute = os.execute +local setmetatable = setmetatable + +-- Keyboard layout switcher +-- lain.widget.contrib.kblayout + +local function factory(args) + local kbdlayout = { widget = wibox.widget.textbox() } + local args = args or {} + local layouts = args.layouts or {} + local settings = args.settings or function () end + local add_us_secondary = true + local timeout = args.timeout or 5 + local idx = 1 + + if args.add_us_secondary == false then add_us_secondary = false end + + local function kbd_run_settings(layout, variant) + kbdlayout_now = { + layout = string.match(layout, "[^,]+"), -- Make sure to match the primary layout only. + variant = variant + } + widget = kbdlayout.widget + settings() + end + + function kbdlayout.update() + helpers.async("setxkbmap -query", function(status) + kbd_run_settings(string.match(status, "layout:%s*([^\n]*)"), + string.match(status, "variant:%s*([^\n]*)")) + end) + end + + function kbdlayout.set(i) + if #layouts == 0 then return end + idx = ((i - 1) % #layouts) + 1 -- Make sure to wrap around as needed. + local to_execute = "setxkbmap " .. layouts[idx].layout + + if add_us_secondary and not string.match(layouts[idx].layout, ",?us,?") then + to_execute = to_execute .. ",us" + end + + if layouts[idx].variant then + to_execute = to_execute .. " " .. layouts[idx].variant + end + + if execute(to_execute) then + kbd_run_settings(layouts[idx].layout, layouts[idx].variant) + end + end + + function kbdlayout.next() kbdlayout.set(idx + 1) end + function kbdlayout.prev() kbdlayout.set(idx - 1) end + + -- Mouse bindings + kbdlayout.widget:buttons(awful.util.table.join( + awful.button({ }, 1, function () kbdlayout.next() end), + awful.button({ }, 3, function () kbdlayout.prev() end))) + + helpers.newtimer("kbdlayout", timeout, kbdlayout.update) + + return kbdlayout +end + +return factory diff --git a/lain/widget/contrib/moc.lua b/lain/widget/contrib/moc.lua new file mode 100644 index 0000000..027cec3 --- /dev/null +++ b/lain/widget/contrib/moc.lua @@ -0,0 +1,97 @@ +--[[ + + 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 = { getenv = os.getenv } +local string = { format = string.format, + gmatch = string.gmatch } + +-- MOC audio player +-- lain.widget.contrib.moc + +local function factory(args) + local moc = { widget = wibox.widget.textbox() } + local args = args or {} + 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/lain/widget/contrib/redshift.lua b/lain/widget/contrib/redshift.lua new file mode 100644 index 0000000..7b54611 --- /dev/null +++ b/lain/widget/contrib/redshift.lua @@ -0,0 +1,53 @@ +--[[ + + Licensed under GNU General Public License v2 + * (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/lain/widget/contrib/task.lua b/lain/widget/contrib/task.lua new file mode 100644 index 0000000..7de1967 --- /dev/null +++ b/lain/widget/contrib/task.lua @@ -0,0 +1,97 @@ +--[[ + + 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 +local string = { format = string.format, gsub = string.gsub } + +-- 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) + + if task.followtag then + task.notification_preset.screen = awful.screen.focused() + elseif scr then + task.notification_preset.screen = scr + end + + 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) + local 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/lain/widget/contrib/tpbat/init.lua b/lain/widget/contrib/tpbat/init.lua new file mode 100644 index 0000000..e9675ef --- /dev/null +++ b/lain/widget/contrib/tpbat/init.lua @@ -0,0 +1,161 @@ +--[[ + + tpbat.lua + Battery status widget for ThinkPad laptops that use SMAPI + lain.widget.contrib.tpbat + + More on tp_smapi: http://www.thinkwiki.org/wiki/Tp_smapi + + Licensed under GNU General Public License v2 + * (c) 2013, Conor Heine + * (c) 2013, Luca CPZ + * (c) 2010-2012, Peter Hofmann + +--]] + +local debug = { getinfo = debug.getinfo } +local newtimer = require("lain.helpers").newtimer +local first_line = require("lain.helpers").first_line +local naughty = require("naughty") +local wibox = require("wibox") +local string = { format = string.format } +local math = { floor = math.floor } +local tostring = tostring +local setmetatable = setmetatable +package.path = debug.getinfo(1,"S").source:match[[^@?(.*[\/])[^\/]-$]] .. "?.lua;" .. package.path +local smapi = require("smapi") + +-- ThinkPad SMAPI-enabled battery info widget +-- lain.widget.contrib.tpbat +local tpbat = {} + +function tpbat.hide() + if not tpbat.notification then return end + naughty.destroy(tpbat.notification) + tpbat.notification = nil +end + +function tpbat.show(t_out) + tpbat.hide() + + local bat = tpbat.bat + + if bat == nil or not bat:installed() then return end + + local t_out = t_out or 0 + local mfgr = bat:get('manufacturer') or "no_mfgr" + local model = bat:get('model') or "no_model" + local chem = bat:get('chemistry') or "no_chem" + local status = bat:get('state') or "nil" + local time = bat:remaining_time() + local msg = "\t" + + if status ~= "idle" and status ~= "nil" then + if time == "N/A" then + msg = "...Calculating time remaining..." + else + msg = time .. (status == "charging" and " until charged" or " remaining") + end + else + msg = "On AC Power" + end + + local str = string.format("%s : %s %s (%s)\n", bat.name, mfgr, model, chem) + .. string.format("\n%s \t\t\t %s", status:upper(), msg) + + tpbat.notification = naughty.notify({ + text = str, + timeout = t_out, + screen = client.focus and client.focus.screen or 1 + }) +end + +function tpbat.register(args) + local args = args or {} + local timeout = args.timeout or 30 + local battery = args.battery or "BAT0" + local settings = args.settings or function() end + + tpbat.bat = smapi:battery(battery) -- Create a new battery + local bat = tpbat.bat + + tpbat.widget = wibox.widget.textbox() + + bat_notification_low_preset = { + title = "Battery low", + text = "Plug the cable!", + timeout = 15, + fg = "#202020", + bg = "#CDCDCD" + } + + bat_notification_critical_preset = { + title = "Battery exhausted", + text = "Shutdown imminent", + timeout = 15, + fg = "#000000", + bg = "#FFFFFF" + } + + if bat:get('state') == nil + then + local n = naughty.notify({ + preset = bat_notification_low_preset, + title = "SMAPI Battery Warning: Unable to read battery state!", + text = "This widget is intended for ThinkPads. Is tp_smapi installed? Check your configs & paths.", + screen = client.focus and client.focus.screen or 1 + }) + end + + function tpbat.update() + bat_now = { + status = "Not present", + perc = "N/A", + time = "N/A", + watt = "N/A" + } + + if bat:installed() + then + bat_now.status = bat:status() or "N/A" + bat_now.perc = bat:percent() + bat_now.time = bat:remaining_time() + -- bat_now.watt = string.format("%.2fW", (VOLTS * AMPS) / 1e12) + + -- notifications for low and critical states (when discharging) + if bat_now.status == "discharging" + then + if bat_now.perc <= 5 + then + tpbat.id = naughty.notify({ + preset = bat_notification_critical_preset, + replaces_id = tpbat.id, + screen = client.focus and client.focus.screen or 1 + }).id + elseif bat_now.perc <= 15 + then + tpbat.id = naughty.notify({ + preset = bat_notification_low_preset, + replaces_id = tpbat.id, + screen = client.focus and client.focus.screen or 1 + }).id + end + end + + bat_now.perc = tostring(bat_now.perc) + end + + widget = tpbat.widget + + settings() + end + + newtimer("tpbat-" .. bat.name, timeout, tpbat.update) + + widget:connect_signal('mouse::enter', function () tpbat.show() end) + widget:connect_signal('mouse::leave', function () tpbat.hide() end) + + return tpbat +end + +return setmetatable(tpbat, { __call = function(_, ...) return tpbat.register(...) end }) diff --git a/lain/widget/contrib/tpbat/smapi.lua b/lain/widget/contrib/tpbat/smapi.lua new file mode 100644 index 0000000..a8867e4 --- /dev/null +++ b/lain/widget/contrib/tpbat/smapi.lua @@ -0,0 +1,98 @@ +--[[ + + smapi.lua + Interface with thinkpad battery information + + Licensed under GNU General Public License v2 + * (c) 2013, Conor Heine + +--]] + +local first_line = require("lain.helpers").first_line + +local string = { format = string.format } +local tonumber = tonumber +local setmetatable = setmetatable + +local smapi = {} +local apipath = "/sys/devices/platform/smapi" + +-- Most are readable values, but some can be written to (not implemented, yet?) +local readable = { + barcoding = true, + charging_max_current = true, + charging_max_voltage = true, + chemistry = true, + current_avg = true, + current_now = true, + cycle_count = true, + design_capacity = true, + design_voltage = true, + dump = true, + first_use_date = true, + force_discharge = false, + group0_voltage = true, + group1_voltage = true, + group2_voltage = true, + group3_voltage = true, + inhibit_charge_minutes = false, + installed = true, + last_full_capacity = true, + manufacture_date = true, + manufacturer = true, + model = true, + power_avg = true, + power_now = true, + remaining_capacity = true, + remaining_charging_time = true, + remaining_percent = true, + remaining_percent_error = true, + remaining_running_time = true, + remaining_running_time_now = true, + serial = true, + start_charge_thresh = false, + state = true, + stop_charge_thresh = false, + temperature = true, + voltage = true +} + +function smapi:battery(name) + local bat = {} + + bat.name = name + bat.path = apipath .. "/" .. name + + function bat:get(item) + return self.path ~= nil and readable[item] and first_line(self.path .. "/" .. item) or nil + end + + function bat:installed() + return self:get("installed") == "1" + end + + function bat:status() + return self:get('state') + end + + -- Remaining time can either be time until battery dies or time until charging completes + function bat:remaining_time() + local time_val = bat_now.status == 'discharging' and 'remaining_running_time' or 'remaining_charging_time' + local mins_left = self:get(time_val) + + if not mins_left:find("^%d+") then return "N/A" end + + local hrs = math.floor(mins_left / 60) + local min = mins_left % 60 + + return string.format("%02d:%02d", hrs, min) + end + + function bat:percent() + return tonumber(self:get("remaining_percent")) + end + + return setmetatable(bat, {__metatable = false, __newindex = false}) +end + +return smapi diff --git a/lain/widget/cpu.lua b/lain/widget/cpu.lua new file mode 100644 index 0000000..6c6e77a --- /dev/null +++ b/lain/widget/cpu.lua @@ -0,0 +1,78 @@ +--[[ + + 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 = { ceil = math.ceil } +local string = { format = string.format, + gmatch = string.gmatch } +local tostring = tostring + +-- CPU usage +-- lain.widget.cpu + +local function factory(args) + local cpu = { core = {}, widget = wibox.widget.textbox() } + local args = args or {} + 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. + local times = helpers.lines_match("cpu","/proc/stat") + + for index,time in pairs(times) 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((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/lain/widget/fs.lua b/lain/widget/fs.lua new file mode 100644 index 0000000..358d4dd --- /dev/null +++ b/lain/widget/fs.lua @@ -0,0 +1,142 @@ +--[[ + + 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 math = math +local string = string +local tconcat = table.concat +local tonumber = tonumber +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) + local fs = { + widget = 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() + fs.notification_preset.screen = fs.followtag and focused() or scr or 1 + fs.notification = naughty.notify { + preset = fs.notification_preset, + timeout = seconds or 5 + } + end + + local args = args or {} + local timeout = args.timeout or 600 + local partition = args.partition + 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 + + function fs.update() + local notifytable = { [1] = string.format("%-10s %-5s %s\t%s\t\n", "path", "used", "free", "size") } + local pathlen = 10 + fs_now = {} + + 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, math.floor(units)), + used = used / math.pow(1024, math.floor(units)), + free = free / math.pow(1024, math.floor(units)) + } + + if fs_now[path].percentage > 0 then -- don't notify unused file systems + notifytable[#notifytable+1] = string.format("\n%-10s %-5s %.2f\t%.2f\t%s", path, + fs_now[path].percentage .. "%", fs_now[path].free, fs_now[path].size, + fs_now[path].units) + + pathlen = math.max(pathlen, #path) + end + end + end + end + + widget = fs.widget + settings() + + if partition and fs_now[partition] and fs_now[partition].used >= 99 then + if not helpers.get_map(partition) then + naughty.notify { + preset = naughty.config.presets.critical, + title = "Warning", + text = partition .. " is full", + } + helpers.set_map(partition, true) + else + helpers.set_map(partition, false) + end + end + + if pathlen > 10 then -- formatting aesthetics + for i = 1, #notifytable do + local pathspaces = notifytable[i]:match("/%w*[/%w*]*%s*") or notifytable[i]:match("path%s*") + notifytable[i] = notifytable[i]:gsub(pathspaces, pathspaces .. string.rep(" ", pathlen - 10) .. "\t") + end + end + + fs.notification_preset.text = tconcat(notifytable) + 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/lain/widget/imap.lua b/lain/widget/imap.lua new file mode 100644 index 0000000..7c13223 --- /dev/null +++ b/lain/widget/imap.lua @@ -0,0 +1,85 @@ +--[[ + + 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 = { format = string.format, + gsub = string.gsub } +local type = type +local tonumber = tonumber + +-- Mail IMAP check +-- lain.widget.imap + +local function factory(args) + local imap = { widget = wibox.widget.textbox() } + local args = args or {} + 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 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 'SEARCH (UNSEEN)'" + + if not server or not mail or not password then return end + + 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 + local p = password() + end + end + + function update() + mail_notification_preset = { + icon = helpers.icons_dir .. "mail.png", + position = "top_left" + } + + if followtag then + mail_notification_preset.screen = awful.screen.focused() + end + + curl = string.format("%s --url imaps://%s:%s/INBOX -u %s:%q %s -k", + head_command, server, port, mail, password, request) + + helpers.async(curl, function(f) + _, mailcount = string.gsub(f, "%d+", "") + widget = imap.widget + settings() + + if notify == "on" and mailcount >= 1 and mailcount > helpers.get_map(mail) then + if mailcount == 1 then + nt = mail .. " has one new message" + else + nt = mail .. " has " .. mailcount .. " new messages" + end + naughty.notify { preset = mail_notification_preset, text = nt } + end + + helpers.set_map(mail, mailcount) + end) + + end + + imap.timer = helpers.newtimer(mail, timeout, update, true, true) + + return imap +end + +return factory diff --git a/lain/widget/init.lua b/lain/widget/init.lua new file mode 100644 index 0000000..57b86bb --- /dev/null +++ b/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/lain/widget/mem.lua b/lain/widget/mem.lua new file mode 100644 index 0000000..3dcae2b --- /dev/null +++ b/lain/widget/mem.lua @@ -0,0 +1,50 @@ +--[[ + + 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) + local mem = { widget = wibox.widget.textbox() } + local args = args or {} + 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/lain/widget/mpd.lua b/lain/widget/mpd.lua new file mode 100644 index 0000000..ff45179 --- /dev/null +++ b/lain/widget/mpd.lua @@ -0,0 +1,134 @@ +--[[ + + 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 = { getenv = os.getenv } +local string = { format = string.format, + gmatch = string.gmatch, + match = string.match } + +-- MPD infos +-- lain.widget.mpd + +local function factory(args) + local mpd = { widget = wibox.widget.textbox() } + local args = args or {} + 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" + } + + 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" + 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/lain/widget/net.lua b/lain/widget/net.lua new file mode 100644 index 0000000..987f047 --- /dev/null +++ b/lain/widget/net.lua @@ -0,0 +1,113 @@ +--[[ + + 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 = { format = string.format, match = string.match } + +-- Network infos +-- lain.widget.net + +local function factory(args) + local net = { widget = wibox.widget.textbox(), devices = {} } + local args = args or {} + 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 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_device() + 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_device() 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("%.1f", dev_now.sent) + dev_now.received = string.format("%.1f", 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" and string.match(dev_now.carrier, "1") then + dev_now.wifi = true + dev_now.signal = tonumber(string.match(helpers.lines_from("/proc/net/wireless")[3], "(%-%d+%.)")) or nil + end + + if eth_state == "on" and helpers.first_line(string.format("/sys/class/net/%s/uevent", dev)) ~= "DEVTYPE=wlan" and string.match(dev_now.carrier, "1") then + dev_now.ethernet = true + 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("%.1f", net_now.sent) + net_now.received = string.format("%.1f", net_now.received) + + widget = net.widget + settings() + end + + helpers.newtimer("network", timeout, net.update) + + return net +end + +return factory diff --git a/lain/widget/pulse.lua b/lain/widget/pulse.lua new file mode 100644 index 0000000..d37e83a --- /dev/null +++ b/lain/widget/pulse.lua @@ -0,0 +1,59 @@ +--[[ + + 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 = { gmatch = string.gmatch, + match = string.match, + format = string.format } +local type = type + +-- PulseAudio volume +-- lain.widget.pulse + +local function factory(args) + local pulse = { widget = wibox.widget.textbox(), device = "N/A" } + local args = args or {} + 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/lain/widget/pulsebar.lua b/lain/widget/pulsebar.lua new file mode 100644 index 0000000..158e639 --- /dev/null +++ b/lain/widget/pulsebar.lua @@ -0,0 +1,162 @@ +--[[ + + 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 = { modf = math.modf } +local string = { format = string.format, + match = string.match, + gmatch = string.gmatch, + rep = string.rep } +local type, tonumber = type, tonumber + +-- PulseAudio volume bar +-- lain.widget.pulsebar + +local function factory(args) + local pulsebar = { + colors = { + background = "#000000", + mute = "#EB8F8F", + unmute = "#A4CE8A" + }, + + _current_level = 0, + _mute = "no", + device = "N/A" + } + + local 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.heigth or 1 + local ticks = args.ticks or false + local ticks_size = args.ticks_size or 7 + + 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 { + forced_height = height, + forced_width = width, + color = pulsebar.colors.unmute, + background_color = pulsebar.colors.background, + margins = 1, + paddings = 1, + 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 + else + pulsebar._mute = "no" + pulsebar.tooltip:set_text(string.format("%s %s: %s", pulsebar.devicetype, pulsebar.device, volu)) + pulsebar.bar.color = pulsebar.colors.unmute + 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 + + int = math.modf((pulsebar._current_level / 100) * tot) + preset.text = string.format("[%s%s]", string.rep("|", int), + string.rep(" ", tot - int)) + + 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", pulsebar.sink), timeout, pulsebar.update) + + return pulsebar +end + +return factory diff --git a/lain/widget/sysload.lua b/lain/widget/sysload.lua new file mode 100644 index 0000000..adf3e03 --- /dev/null +++ b/lain/widget/sysload.lua @@ -0,0 +1,38 @@ +--[[ + + 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) + local sysload = { widget = wibox.widget.textbox() } + local args = args or {} + 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/lain/widget/temp.lua b/lain/widget/temp.lua new file mode 100644 index 0000000..3c93252 --- /dev/null +++ b/lain/widget/temp.lua @@ -0,0 +1,41 @@ +--[[ + + Licensed under GNU General Public License v2 + * (c) 2013, Luca CPZ + +--]] + +local helpers = require("lain.helpers") +local wibox = require("wibox") +local open = io.open +local tonumber = tonumber + +-- coretemp +-- lain.widget.temp + +local function factory(args) + local temp = { widget = wibox.widget.textbox() } + local args = args or {} + local timeout = args.timeout or 2 + local tempfile = args.tempfile or "/sys/class/thermal/thermal_zone0/temp" + local settings = args.settings or function() end + + function temp.update() + local f = open(tempfile) + if f then + coretemp_now = tonumber(f:read("*all")) / 1000 + f:close() + else + coretemp_now = "N/A" + end + + widget = temp.widget + settings() + end + + helpers.newtimer("coretemp", timeout, temp.update) + + return temp +end + +return factory diff --git a/lain/widget/weather.lua b/lain/widget/weather.lua new file mode 100644 index 0000000..a9b886a --- /dev/null +++ b/lain/widget/weather.lua @@ -0,0 +1,158 @@ +--[[ + + 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, os, string, tonumber = math, os, string, tonumber + +-- OpenWeatherMap +-- current weather and X-days forecast +-- lain.widget.weather + +local function factory(args) + local weather = { widget = wibox.widget.textbox() } + local args = args or {} + local APPID = args.APPID or "3e321f9414eaedbfab34983bda77a66e" -- lain's default + local timeout = args.timeout or 60 * 15 -- 15 min + local timeout_forecast = args.timeout or 60 * 60 * 24 -- 24 hrs + local current_call = args.current_call or "curl -s 'http://api.openweathermap.org/data/2.5/weather?id=%s&units=%s&lang=%s&APPID=%s'" + local forecast_call = args.forecast_call or "curl -s 'http://api.openweathermap.org/data/2.5/forecast/daily?id=%s&units=%s&lang=%s&cnt=%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 date_cmd = args.date_cmd or "date -u -d @%d +'%%a %%d'" + 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 tmin = math.floor(wn["temp"]["min"]) + local tmax = math.floor(wn["temp"]["max"]) + local desc = wn["weather"][1]["description"] + return string.format("%s: %s, %d - %d ", day, desc, tmin, tmax) + 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(t_out) + 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({ + text = weather.notification_text, + icon = weather.icon_path, + timeout = t_out, + preset = notification_preset + }) + 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, cnt, APPID) + helpers.async(cmd, function(f) + local pos, err + weather_now, pos, 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"] 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 pos, err, icon + weather_now, pos, 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() -- local time + local loc_m = os.time { year = os.date("%Y"), month = os.date("%m"), day = os.date("%d"), hour = 0 } -- local time from midnight + local loc_d = os.date("*t", loc_now) -- table YMDHMS for current local time (for TZ calculation) + local utc_d = os.date("!*t", loc_now) -- table YMDHMS for current UTC time + local utc_now = os.time(utc_d) -- UTC time now + local offdt = (loc_d.isdst and 1 or 0) * 3600 + 100 * (loc_d.min - utc_d.min) / 60 -- DST offset + local offset = os.difftime(loc_now, utc_now) + (loc_d.isdst and 1 or 0) * 3600 + 100 * (loc_d.min - utc_d.min) / 60 -- TZ offset (including DST) + local offday = (offset < 0 and -86400) or 86400 -- 24 hour correction value (+86400 or -86400) + + -- if current UTC time is earlier then local midnight -> positive offset (negative otherwise) + if offset * (loc_m - utc_now + offdt) > 0 then + sunrise = sunrise + offday -- Shift sunset and sunrise times by 24 hours + sunset = sunset + offday + end + + 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/lain/wiki/Home.md b/lain/wiki/Home.md new file mode 100644 index 0000000..95ef586 --- /dev/null +++ b/lain/wiki/Home.md @@ -0,0 +1,43 @@ +Welcome to the Lain wiki! + +If you spot a typo or have a suggestion, 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) +GLib >= 2.54 | `fs` widget | Pure Awesome/Lua implementation. + +The second dependency will be removed once all major distros update their Gio/Glib versions. + +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/aajjbb/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/lain/wiki/Layouts.md b/lain/wiki/Layouts.md new file mode 100644 index 0000000..0286d4b --- /dev/null +++ b/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/lain/wiki/Utilities.md b/lain/wiki/Utilities.md new file mode 100644 index 0000000..3763af2 --- /dev/null +++ b/lain/wiki/Utilities.md @@ -0,0 +1,330 @@ +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). + +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 +------ + +Mades markup easier. + +```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. + +The function takes an integer argument, being the amount of pixel to add/remove to gaps. + +You could use it with these keybindings: + +```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`, or you could use it like this: + +```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 XRandR 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 `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 } +} +``` \ No newline at end of file diff --git a/lain/wiki/Widgets.md b/lain/wiki/Widgets.md new file mode 100644 index 0000000..0b628c7 --- /dev/null +++ b/lain/wiki/Widgets.md @@ -0,0 +1,56 @@ +# 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`, while 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 +``` + +If you want to see some applications, check [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) +- [calendar](https://github.com/lcpz/lain/wiki/calendar) +- [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) + +## Users contributed + +- [kbdlayout](https://github.com/lcpz/lain/wiki/kbdlayout) +- [moc](https://github.com/lcpz/lain/wiki/moc) +- [redshift](https://github.com/lcpz/lain/wiki/redshift) +- [task](https://github.com/lcpz/lain/wiki/task) +- [tpbat](https://github.com/lcpz/lain/wiki/tpbat) diff --git a/lain/wiki/_Footer.md b/lain/wiki/_Footer.md new file mode 100644 index 0000000..b64f13b --- /dev/null +++ b/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/lain/wiki/_Sidebar.md b/lain/wiki/_Sidebar.md new file mode 100644 index 0000000..cbfa7e2 --- /dev/null +++ b/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) \ No newline at end of file diff --git a/lain/wiki/alsa.md b/lain/wiki/alsa.md new file mode 100644 index 0000000..fca7530 --- /dev/null +++ b/lain/wiki/alsa.md @@ -0,0 +1,136 @@ +## 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 + +`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 + awful.spawn(string.format("%s set %s 100%%", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 3, function() -- right click + awful.spawn(string.format("%s set %s toggle", volume.cmd, volume.togglechannel or volume.channel)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + awful.spawn(string.format("%s set %s 1%%+", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + awful.spawn(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"`. diff --git a/lain/wiki/alsabar.md b/lain/wiki/alsabar.md new file mode 100644 index 0000000..856bfa8 --- /dev/null +++ b/lain/wiki/alsabar.md @@ -0,0 +1,100 @@ +## 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 | integer | 63 +`height` | Bar height | integer | 1 +`ticks` | Set bar ticks on | boolean | false +`ticks_size` | Ticks size | integer | 7 +`cmd` | ALSA mixer command | string | "amixer" +`channel` | Mixer channel | string | "Master" +`togglechannel` | Toggle channel | string | `nil` +`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 `command = "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. + +`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 + awful.spawn(string.format("%s set %s 100%%", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 3, function() -- right click + awful.spawn(string.format("%s set %s toggle", volume.cmd, volume.togglechannel or volume.channel)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + awful.spawn(string.format("%s set %s 1%%+", volume.cmd, volume.channel)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + awful.spawn(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/lain/wiki/bat.md b/lain/wiki/bat.md new file mode 100644 index 0000000..e58cb8b --- /dev/null +++ b/lain/wiki/bat.md @@ -0,0 +1,101 @@ +## 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 +`battery` | Single battery id | string | "BAT0" +`batteries` | Multiple batteries id table | table of strings | `{"BAT0"}` +`ac` | AC | string | "AC0" +`notify` | Show notification popups | string | "on" +`n_perc` | Percentages assumed for critical and low battery levels | table of integers | `{5, 15}` +`settings` | User settings | function | empty function + +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*"}`. Of course, if you have multiple batteries, you need to use the latter option. + +To disable notifications, set `notify` to `"off"`. + +`settings` can use the `bat_now` table, which contains the following strings: + +- `status`, battery 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-th battery charge percentage (like above); +- `time`, time remaining until charge if charging, until discharge if discharging (HH:SS string or "N/A"); +- `watt`, battery watts (float with 2 decimals). + +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. + +## Notes +* Another common identifier for `ac` is `ACAD`. +* If your widget is always on "N/A" with default settings, and you have a single battery, then `BAT0` is not your battery file. Locate the right one in `/sys/class/power_supply/` and set `battery` properly. For instance, with `BAT1`: + + ```lua + batwidget = lain.widget.bat({ + battery = "BAT1", + -- [...] + }) + + ``` +* Alternatively, you can try the `upower` widget [here](https://awesomewm.org/recipes/watch). diff --git a/lain/wiki/calendar.md b/lain/wiki/calendar.md new file mode 100644 index 0000000..dba8fc3 --- /dev/null +++ b/lain/wiki/calendar.md @@ -0,0 +1,105 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Attaches a calendar notification to a widget. + +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). + +```lua +local calendar = lain.widget.calendar() +``` + +- Left click / scroll down: switch to previous month. +- Right click / scroll up: switch to next month. + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`cal` | custom call for `cal` | string | "/usr/bin/cal" +`attach_to` | Array of widgets | array | empty array +`followtag` | Display the notification on currently focused screen | boolean | false +`icons` | Path to calendar icons | string | [lain/icons/cal/white](https://github.com/lcpz/lain/tree/master) +`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/lcpz/lain/wiki/calendar#default-notification_preset) + +You can reset `cal` any way you like (using `-w` to display weeks as well, for instance). If the current day is not highlighted, you can reset `cal` to also include the proper coloring flag. For instance, under Arch Linux it's `/usr/bin/cal --color=always`, while under Ubuntu it's `/usr/bin/cal -h`. + +You can set `attach_to` as the array of widgets to which you want to attach the calendar, for instance: + +```lua +lain.widget.calendar({ + `attach_to = { mywidget1, mywidget2, ... }`, + -- [...] +}) +``` + +The notification will show an icon of the current day number, and output from ``cal`` with current day highlighted. + +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 the widget you want to attach the calendar to: `calendar.attach(widget)`. + +## Keybindings + +You can call the notification with a key binding like this: + +```lua +awful.key({ altkey }, "c", function () + calendar:show(7) +end), +``` + +where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds. + +You can also call it defining a notification screen with a third argument like this: + +```lua +awful.key({ altkey }, "c", function () + calendar:show(7, 0, my_scr_number) +end), +``` + +## Notes + +* Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output. +* In case current day is not being highlighted in notifications, try setting `cal` specifying your environment. For instance: `cal = "/usr/bin/env TERM=linux /usr/bin/cal --your-coloring-flag-here"`. +* If you want to [disable notification icon](https://github.com/lcpz/lain/pull/351), set `icons = ""` in the input table. +* In order to have [khal](https://github.com/pimutils/khal) agenda output combined with the widget you can use this script as `cal`: + + ```shell + #!/bin/bash + days=3 # days to show + cal_flag="--color=always" # colorizing flag + if [ $# -eq 0 ]; then + awk '{max = 21} + FNR==NR{s1[FNR]=$0; next}{s2[FNR]=$0} + END { format = "%-" max "s\t%-" max "s\n"; + numlines=(NR-FNR)>FNR?NR-FNR:FNR; + for (i=1; i<=numlines; i++) { printf format, s1[i]?s1[i]:"", s2[i]?s2[i]:"" } + }' <(/usr/bin/cal $cal_flag) <(/usr/bin/khal list today $(date -d "+$days days" "+%d.%m.%Y")) + else + /usr/bin/cal $@ + fi + ``` diff --git a/lain/wiki/cpu.md b/lain/wiki/cpu.md new file mode 100644 index 0000000..c13d05a --- /dev/null +++ b/lain/wiki/cpu.md @@ -0,0 +1,30 @@ +## 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 + +`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/lain/wiki/fs.md b/lain/wiki/fs.md new file mode 100644 index 0000000..b6c91b9 --- /dev/null +++ b/lain/wiki/fs.md @@ -0,0 +1,81 @@ +## 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` +`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 + +`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. \ No newline at end of file diff --git a/lain/wiki/imap.md b/lain/wiki/imap.md new file mode 100644 index 0000000..118eeeb --- /dev/null +++ b/lain/wiki/imap.md @@ -0,0 +1,94 @@ +## 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 + +while the optional are: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`port` | IMAP port | integer | 993 +`timeout` | Refresh timeout (in seconds) | integer | 60 +`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 + +The reason why `is_plain` is false by default is to discourage the habit of storing passwords in plain. + +So, you can set your password in plain like this: + +```lua +myimapcheck = lain.widget.imap({ + is_plain = true, + password = "mymailpassword", + -- [...] +}) +``` + +and you'll have the same security provided by `~/.netrc`. + +**Or you can use a password manager**, like [spm](https://notabug.org/kl3/spm) or [pass](https://www.passwordstore.org): + +```lua +myimapcheck = lain.widget.imap({ + password = function() + -- return the output of "spm show mymail" + end, + -- [...] +}) +``` + +When `is_plain == false` (default), `password` can be either a string, a table or a function: the widget will execute it asynchronously in the first two cases. + +`settings` can use the value `mailcount`, an integer greater or equal to zero, and 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` is 0 either if there are no new mails or credentials are invalid, so make sure you get the right settings. + +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. + +## 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. diff --git a/lain/wiki/kbdlayout.md b/lain/wiki/kbdlayout.md new file mode 100644 index 0000000..c32e9b8 --- /dev/null +++ b/lain/wiki/kbdlayout.md @@ -0,0 +1,75 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows and controls keyboard layouts and variants using `setxkbmap`. This is a simpler but asynchronous alternative to [awful.widget.kbdlayout](https://awesomewm.org/apidoc/classes/awful.widget.keyboardlayout.html). + +```lua +local mykbdlayout = lain.widget.contrib.kbdlayout() +``` + +Left/right click switches to next/previous keyboard layout. + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`layouts` | Keyboard layouts and variants to switch between | table | `nil` +`add_us_secondary` | Whether to add `us` as a secondary layout | boolean | true +`timeout` | Refresh timeout (in seconds) | integer | 10 +`settings` | User settings | function | empty function + +- `layouts` + + A table (array) which contains tables with keys indicating layout and (optionally) variant. This argument is **mandatory**. + +- `add_us_secondary` + + A boolean controlling whether to add `us` as a secondary layout. This is needed in order for keyboard shortcuts to work in certain applications, i.e. Firefox, while using a non-US keyboard layout. + +- `timeout` + + An integer which determines the interval at which the widget will be updated, in case the keyboard layout was changed by other means. + +- `settings` + + A "callback" function in which the user is expected to set the text widget up. The widget itself is available as the global variable `widget`, while layout information is available as `kbdlayout_now`. `kbdlayout_now` contains two keys, `layout` containing the primary layout, and `variant`, containing the variant. If there is no variant, `variant` is `nil`. + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget (textbox) | `wibox.widget.textbox` +`update` | Function to update the widget and call `settings` | function +`set` | Function taking an index as an argument to manually set the layout given by that index | function +`next` | Change to the next layout | function +`prev` | Change to the prev layout | function + +The textbox can be added to the layout via standard means. + +By default, left-clicking the textbox calls `next`, and right-clicking calls `prev`. You can set up additional key- or mouse-bindings. See the example below. + +## Example + +```lua +-- Switch between US Dvorak and DE layouts. +mykbdlayout = lain.widget.contrib.kbdlayout({ + layouts = { { layout = "us", variant = "dvorak" }, + { layout = "de" } }, + settings = function() + if kbdlayout_now.variant then + widget:set_text(string.format("%s/%s", kbdlayout_now.layout, + kbdlayout_now.variant)) + else + widget:set_text(kbdlayout_now.layout) + end + end +}) + +-- [...] + +-- Add key binding (traditional Alt+Shift switching) +awful.key({ "Mod1" }, "Shift_L", function () mykbdlayout.next() end), +``` diff --git a/lain/wiki/mem.md b/lain/wiki/mem.md new file mode 100644 index 0000000..2755586 --- /dev/null +++ b/lain/wiki/mem.md @@ -0,0 +1,33 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Shows memory status (in MiB). + +```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 + +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 + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function \ No newline at end of file diff --git a/lain/wiki/moc.md b/lain/wiki/moc.md new file mode 100644 index 0000000..f626c73 --- /dev/null +++ b/lain/wiki/moc.md @@ -0,0 +1,122 @@ +## 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 + +\* 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 () + awful.spawn.with_shell("mocp -G") + moc.update() + end), +awful.key({ altkey, "Control" }, "Down", + function () + awful.spawn.with_shell("mocp -s") + moc.update() + end), +awful.key({ altkey, "Control" }, "Left", + function () + awful.spawn.with_shell("mocp -r") + moc.update() + end), +awful.key({ altkey, "Control" }, "Right", + function () + awful.spawn.with_shell("mocp -f") + 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/lain/wiki/mpd.md b/lain/wiki/mpd.md new file mode 100644 index 0000000..4e22ce5 --- /dev/null +++ b/lain/wiki/mpd.md @@ -0,0 +1,172 @@ +## 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 popups | string | "on" +`followtag` | Notification behaviour | boolean | false +`settings` | User settings | function | empty function + +\* 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 `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) + +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. + +## Keybindings + +You can control the widget with keybindings 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 keybinding 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 + +### 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 keybinding 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/lain/wiki/net.md b/lain/wiki/net.md new file mode 100644 index 0000000..1bc10f0 --- /dev/null +++ b/lain/wiki/net.md @@ -0,0 +1,115 @@ +## 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 array of strings (multiple interfaces) | autodetected +`units` | Units | integer | 1024 (kilobytes) +`notify` | Display "no carrier" notifications | string | "on" +`wifi_state` | Get wifi connection status | string | "off" +`eth_state` | Get ethernet connection status | string | "off" +`screen` | Notifications screen | integer | 1 +`settings` | User settings | function | empty function + +`iface` can be a string or an array 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 same attributes as the old api for each interface. More on this in the "Multiple devices" section below. + +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 array and should not be relied upon (deprecated). + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | 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.widgets.net { + settings = function() + widget:set_markup(net_now.sent) + netdowninfo:set_markup(net_now.received) + end +} +``` +### Wifi connection + signal strength indicator and ethernet connection 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 +} +``` diff --git a/lain/wiki/pulse.md b/lain/wiki/pulse.md new file mode 100644 index 0000000..f19d4dd --- /dev/null +++ b/lain/wiki/pulse.md @@ -0,0 +1,135 @@ +## 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#L26) +`settings` | User settings | function | empty function + +`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 dinamically, you can define it as a function which returns a command string. + +If sed doesn't work, you can try with a grep variant: + +```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 + awful.spawn(string.format("pactl set-sink-volume %d 100%%", volume.device)) + volume.update() + end), + awful.button({}, 3, function() -- right click + awful.spawn(string.format("pactl set-sink-mute %d toggle", volume.device)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + awful.spawn(string.format("pactl set-sink-volume %d +1%%", volume.device)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + awful.spawn(string.format("pactl set-sink-volume %d -1%%", volume.device)) + volume.update() + end) +)) +``` + +## Keybindings + +```lua +-- PulseAudio volume control +awful.key({ altkey }, "Up", + function () + os.execute(string.format("pactl set-sink-volume %d +1%%", volume.device)) + volume.update() + end), +awful.key({ altkey }, "Down", + function () + os.execute(string.format("pactl set-sink-volume %d -1%%", volume.device)) + volume.update() + end), +awful.key({ altkey }, "m", + function () + os.execute(string.format("pactl set-sink-mute %d toggle", volume.device)) + volume.update() + end), +awful.key({ altkey, "Control" }, "m", + function () + os.execute(string.format("pactl set-sink-volume %d 100%%", volume.device)) + volume.update() + end), +awful.key({ altkey, "Control" }, "0", + function () + os.execute(string.format("pactl set-sink-volume %d 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/lain/wiki/pulsebar.md b/lain/wiki/pulsebar.md new file mode 100644 index 0000000..ab884aa --- /dev/null +++ b/lain/wiki/pulsebar.md @@ -0,0 +1,89 @@ +## 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 | integer | 63 +`height` | Bar height | integer | 1 +`ticks` | Set bar ticks on | boolean | false +`ticks_size` | Ticks size | integer | 7 +`colors` | Bar colors | table | see [default colors](https://github.com/lcpz/lain/wiki/pulsebar#default-colors) +`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 + awful.spawn(string.format("pactl set-sink-volume %d 100%%", volume.device)) + volume.update() + end), + awful.button({}, 3, function() -- right click + awful.spawn(string.format("pactl set-sink-mute %d toggle", volume.device)) + volume.update() + end), + awful.button({}, 4, function() -- scroll up + awful.spawn(string.format("pactl set-sink-volume %d +1%%", volume.device)) + volume.update() + end), + awful.button({}, 5, function() -- scroll down + awful.spawn(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/lain/wiki/redshift.md b/lain/wiki/redshift.md new file mode 100644 index 0000000..b83ad3a --- /dev/null +++ b/lain/wiki/redshift.md @@ -0,0 +1,100 @@ +### 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.widget` 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 + myredshift_text:set_markup(markup(beautiful.bg_normal, "R")) + else + myredshift_text:set_markup(markup(beautiful.fg_normal, "R")) + end + myredshift.checked = active + end +) +``` + +Then add the `myredshift_stack` widget 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), +``` \ No newline at end of file diff --git a/lain/wiki/sysload.md b/lain/wiki/sysload.md new file mode 100644 index 0000000..6fb1c04 --- /dev/null +++ b/lain/wiki/sysload.md @@ -0,0 +1,27 @@ +## 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 + +`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/lain/wiki/task.md b/lain/wiki/task.md new file mode 100644 index 0000000..af53a6a --- /dev/null +++ b/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/lain/wiki/temp.md b/lain/wiki/temp.md new file mode 100644 index 0000000..3857d92 --- /dev/null +++ b/lain/wiki/temp.md @@ -0,0 +1,32 @@ +## 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 | 2 +`tempfile` | Path of file which stores core temperature value | string | "/sys/class/thermal/thermal_zone0/temp" +`settings` | User settings | function | empty function + +`settings` can use the string `coretemp_now`, which means current core temperature, expressed in Celsius (linux standard). + +## Output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function + +## Note + +Depending on the architecture, note that your temp files location [might vary](https://github.com/lcpz/lain/issues/84#issuecomment-72751763). \ No newline at end of file diff --git a/lain/wiki/tpbat.md b/lain/wiki/tpbat.md new file mode 100644 index 0000000..4b0c1b4 --- /dev/null +++ b/lain/wiki/tpbat.md @@ -0,0 +1,30 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi). + +Includes hover notification with more details. + +```lua +local mytpbat = lain.widget.contrib.tpbat() +``` + +## Input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) | integer | 30 +`battery` | Single battery id | string | "BAT0" +`settings` | User settings | function | empty function + +## 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. \ No newline at end of file diff --git a/lain/wiki/weather.md b/lain/wiki/weather.md new file mode 100644 index 0000000..5d0fd3a --- /dev/null +++ b/lain/wiki/weather.md @@ -0,0 +1,149 @@ +## Usage + +[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage) + +### Description + +Provides current weather status widgets and X-days forecast popup notifications. + +Powered by [OpenWeatherMap](http://openweathermap.org/api) API. + +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 +--- | --- | --- | --- +`timeout` | Refresh timeout (in seconds) for current weather status | integer | 900 (15 min) +`timeout_forecast` | Refresh timeout (in seconds) for forecast notification | integer | 86400 (24 hrs) +`current_call` | Command to fetch weather status data from the API | string | see `default_current_call` below +`forecast_call` | Command to fetch forecast data from the API | string | see `default_forecast_call` below +`city_id` | API city code | integer | not set +`units` | Temperature units system | string | "metric" +`lang` | API data localization | string | "en" +`cnt` | Forecast days interval | integer | 5 +`date_cmd` | Forecast notification format style | string | "date -u -d @%d +'%%a %%d'" +`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 + +- ``default_current_call`` + + `"curl -s 'http://api.openweathermap.org/data/2.5/weather?id=%s&units=%s&lang=%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'"` + + 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&cnt=%s'"` + + Like above. + If you want to use [forecast5](http://openweathermap.org/forecast5), use this API call string: + `http://api.openweathermap.org/data/2.5/forecast?id=%s&units=%s&lang=%s&cnt=%s` + +- ``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). + +- ``cnt`` + + Determines how many days to show in the forecast notification. Up to 16 if you use [forecast16](http://openweathermap.org/forecast16) (default), and up to 5 if you use [forecast5](http://openweathermap.org/forecast5). + +- ``date_cmd`` + + OpenWeatherMap time is in UNIX format, so this variable uses `date` to determine how each line in the forecast notification is formatted. Default looks like this: + + day #daynumber: forecast, temp_min - temp_max + + see `man date` for your customizations. + +- ``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 = string.gsub(read_pipe(string.format(date_cmd, wn["dt"])), "\n", "") + local tmin = math.floor(wn["temp"]["min"]) + local tmax = math.floor(wn["temp"]["max"]) + local desc = wn["weather"][1]["description"] + + return string.format("%s: %s, %d - %d ", day, desc, tmin, tmax) + end + ``` + See [here](https://github.com/lcpz/lain/issues/186#issuecomment-203400918) for a complete customization example. + +- ``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. + +## Keybindings + +You can create a keybinding for the weather popup like this: + +```lua +awful.key( { "Mod1" }, "w", function () myweather.show(5) end ) +``` + +where ``show`` argument is an integer defining timeout seconds. diff --git a/rc.lua b/rc.lua index 85d0497..c79811c 100644 --- a/rc.lua +++ b/rc.lua @@ -7,7 +7,7 @@ require('config.layouts') require("config.tags") require("config.client") require('module.auto-start') -require('layout') +-- require('layout') -- If LuaRocks is installed, make sure that packages installed through it are @@ -22,6 +22,15 @@ require("awful.autofocus") local wibox = require("wibox") -- Theme handling library local beautiful = require("beautiful") +-- Variable definitions +local themes = { + "default", -- 1 + "darkblue" -- 2 +} +-- Choose the theme +local theme_num = 1 +local theme_path = string.format("%s/.config/awesome/themes/%s/theme.lua", os.getenv("HOME"), themes[theme_num]) +beautiful.init(theme_path) -- Notification library local naughty = require("naughty") local menubar = require("menubar") @@ -34,16 +43,16 @@ _G.root.keys(require('config.keys.global')) -- {{{ Error handling --- Check if awesome encountered an error during startup and fell back to --- another config (This code will only ever execute for the fallback config) -if awesome.startup_errors then + -- Check if awesome encountered an error during startup and fell back to + -- another config (This code will only ever execute for the fallback config) + if awesome.startup_errors then naughty.notify({ preset = naughty.config.presets.critical, title = "Oops, there were errors during startup!", text = awesome.startup_errors }) -end + end --- Handle runtime errors after startup -do + -- Handle runtime errors after startup + do local in_error = false awesome.connect_signal("debug::error", function (err) -- Make sure we don't go into an endless error loop @@ -55,16 +64,16 @@ do text = tostring(err) }) in_error = false end) -end + end -- }}} -- {{{ Mouse bindings -root.buttons(gears.table.join( - awful.button({ }, 3, function () widget.menu:toggle() end), - awful.button({ }, 4, awful.tag.viewnext), - awful.button({ }, 5, awful.tag.viewprev) -)) + root.buttons(gears.table.join( + awful.button({ }, 3, function () widget.menu:toggle() end), + awful.button({ }, 4, awful.tag.viewnext), + awful.button({ }, 5, awful.tag.viewprev) + )) -- }}} -- {{{ Signals @@ -129,4 +138,4 @@ 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) --- }}} \ No newline at end of file +-- }}} diff --git a/themes/darkblue/icons/apps/chrome.png b/themes/darkblue/icons/apps/chrome.png new file mode 100644 index 0000000..2c76f3e Binary files /dev/null and b/themes/darkblue/icons/apps/chrome.png differ diff --git a/themes/darkblue/icons/apps/idea.png b/themes/darkblue/icons/apps/idea.png new file mode 100644 index 0000000..f6c7ba6 Binary files /dev/null and b/themes/darkblue/icons/apps/idea.png differ diff --git a/themes/darkblue/icons/apps/pycharm.png b/themes/darkblue/icons/apps/pycharm.png new file mode 100644 index 0000000..3967e21 Binary files /dev/null and b/themes/darkblue/icons/apps/pycharm.png differ diff --git a/themes/darkblue/icons/apps/teamviewer.png b/themes/darkblue/icons/apps/teamviewer.png new file mode 100644 index 0000000..a4b5cd2 Binary files /dev/null and b/themes/darkblue/icons/apps/teamviewer.png differ diff --git a/themes/darkblue/icons/apps/vivaldi.png b/themes/darkblue/icons/apps/vivaldi.png new file mode 100644 index 0000000..b5bf31c Binary files /dev/null and b/themes/darkblue/icons/apps/vivaldi.png differ diff --git a/themes/darkblue/icons/apps/webstorm.png b/themes/darkblue/icons/apps/webstorm.png new file mode 100644 index 0000000..2862df7 Binary files /dev/null and b/themes/darkblue/icons/apps/webstorm.png differ diff --git a/themes/darkblue/icons/awesome.png b/themes/darkblue/icons/awesome.png new file mode 100644 index 0000000..4cabb6c Binary files /dev/null and b/themes/darkblue/icons/awesome.png differ diff --git a/themes/darkblue/icons/display/1.png b/themes/darkblue/icons/display/1.png new file mode 100755 index 0000000..f9ce2a3 Binary files /dev/null and b/themes/darkblue/icons/display/1.png differ diff --git a/themes/darkblue/icons/display/10.png b/themes/darkblue/icons/display/10.png new file mode 100755 index 0000000..9483603 Binary files /dev/null and b/themes/darkblue/icons/display/10.png differ diff --git a/themes/darkblue/icons/display/11.png b/themes/darkblue/icons/display/11.png new file mode 100755 index 0000000..756b5d8 Binary files /dev/null and b/themes/darkblue/icons/display/11.png differ diff --git a/themes/darkblue/icons/display/12.png b/themes/darkblue/icons/display/12.png new file mode 100755 index 0000000..fba597b Binary files /dev/null and b/themes/darkblue/icons/display/12.png differ diff --git a/themes/darkblue/icons/display/13.png b/themes/darkblue/icons/display/13.png new file mode 100755 index 0000000..642c906 Binary files /dev/null and b/themes/darkblue/icons/display/13.png differ diff --git a/themes/darkblue/icons/display/14.png b/themes/darkblue/icons/display/14.png new file mode 100755 index 0000000..d50888a Binary files /dev/null and b/themes/darkblue/icons/display/14.png differ diff --git a/themes/darkblue/icons/display/15.png b/themes/darkblue/icons/display/15.png new file mode 100755 index 0000000..b1b907b Binary files /dev/null and b/themes/darkblue/icons/display/15.png differ diff --git a/themes/darkblue/icons/display/16.png b/themes/darkblue/icons/display/16.png new file mode 100755 index 0000000..a669444 Binary files /dev/null and b/themes/darkblue/icons/display/16.png differ diff --git a/themes/darkblue/icons/display/17.png b/themes/darkblue/icons/display/17.png new file mode 100755 index 0000000..b1bbc00 Binary files /dev/null and b/themes/darkblue/icons/display/17.png differ diff --git a/themes/darkblue/icons/display/2.png b/themes/darkblue/icons/display/2.png new file mode 100755 index 0000000..f65d050 Binary files /dev/null and b/themes/darkblue/icons/display/2.png differ diff --git a/themes/darkblue/icons/display/3.png b/themes/darkblue/icons/display/3.png new file mode 100755 index 0000000..581c6a8 Binary files /dev/null and b/themes/darkblue/icons/display/3.png differ diff --git a/themes/darkblue/icons/display/4.png b/themes/darkblue/icons/display/4.png new file mode 100755 index 0000000..2de978b Binary files /dev/null and b/themes/darkblue/icons/display/4.png differ diff --git a/themes/darkblue/icons/display/5.png b/themes/darkblue/icons/display/5.png new file mode 100755 index 0000000..584c58f Binary files /dev/null and b/themes/darkblue/icons/display/5.png differ diff --git a/themes/darkblue/icons/display/6.png b/themes/darkblue/icons/display/6.png new file mode 100755 index 0000000..1913bba Binary files /dev/null and b/themes/darkblue/icons/display/6.png differ diff --git a/themes/darkblue/icons/display/7.png b/themes/darkblue/icons/display/7.png new file mode 100755 index 0000000..8a2785d Binary files /dev/null and b/themes/darkblue/icons/display/7.png differ diff --git a/themes/darkblue/icons/display/8.png b/themes/darkblue/icons/display/8.png new file mode 100755 index 0000000..6dec474 Binary files /dev/null and b/themes/darkblue/icons/display/8.png differ diff --git a/themes/darkblue/icons/display/9.png b/themes/darkblue/icons/display/9.png new file mode 100755 index 0000000..125ac2e Binary files /dev/null and b/themes/darkblue/icons/display/9.png differ diff --git a/themes/darkblue/icons/display/o1.png b/themes/darkblue/icons/display/o1.png new file mode 100755 index 0000000..705f124 Binary files /dev/null and b/themes/darkblue/icons/display/o1.png differ diff --git a/themes/darkblue/icons/display/o10.png b/themes/darkblue/icons/display/o10.png new file mode 100755 index 0000000..287cad6 Binary files /dev/null and b/themes/darkblue/icons/display/o10.png differ diff --git a/themes/darkblue/icons/display/o11.png b/themes/darkblue/icons/display/o11.png new file mode 100755 index 0000000..476199d Binary files /dev/null and b/themes/darkblue/icons/display/o11.png differ diff --git a/themes/darkblue/icons/display/o12.png b/themes/darkblue/icons/display/o12.png new file mode 100755 index 0000000..e1aaa80 Binary files /dev/null and b/themes/darkblue/icons/display/o12.png differ diff --git a/themes/darkblue/icons/display/o13.png b/themes/darkblue/icons/display/o13.png new file mode 100755 index 0000000..d08fba1 Binary files /dev/null and b/themes/darkblue/icons/display/o13.png differ diff --git a/themes/darkblue/icons/display/o14.png b/themes/darkblue/icons/display/o14.png new file mode 100755 index 0000000..a7a2121 Binary files /dev/null and b/themes/darkblue/icons/display/o14.png differ diff --git a/themes/darkblue/icons/display/o15.png b/themes/darkblue/icons/display/o15.png new file mode 100755 index 0000000..15c5c54 Binary files /dev/null and b/themes/darkblue/icons/display/o15.png differ diff --git a/themes/darkblue/icons/display/o16.png b/themes/darkblue/icons/display/o16.png new file mode 100755 index 0000000..3545cf5 Binary files /dev/null and b/themes/darkblue/icons/display/o16.png differ diff --git a/themes/darkblue/icons/display/o17.png b/themes/darkblue/icons/display/o17.png new file mode 100755 index 0000000..f8d48e4 Binary files /dev/null and b/themes/darkblue/icons/display/o17.png differ diff --git a/themes/darkblue/icons/display/o2.png b/themes/darkblue/icons/display/o2.png new file mode 100755 index 0000000..186f296 Binary files /dev/null and b/themes/darkblue/icons/display/o2.png differ diff --git a/themes/darkblue/icons/display/o3.png b/themes/darkblue/icons/display/o3.png new file mode 100755 index 0000000..332a9af Binary files /dev/null and b/themes/darkblue/icons/display/o3.png differ diff --git a/themes/darkblue/icons/display/o4.png b/themes/darkblue/icons/display/o4.png new file mode 100755 index 0000000..f355ff5 Binary files /dev/null and b/themes/darkblue/icons/display/o4.png differ diff --git a/themes/darkblue/icons/display/o5.png b/themes/darkblue/icons/display/o5.png new file mode 100755 index 0000000..22d60f0 Binary files /dev/null and b/themes/darkblue/icons/display/o5.png differ diff --git a/themes/darkblue/icons/display/o6.png b/themes/darkblue/icons/display/o6.png new file mode 100755 index 0000000..354dcd1 Binary files /dev/null and b/themes/darkblue/icons/display/o6.png differ diff --git a/themes/darkblue/icons/display/o7.png b/themes/darkblue/icons/display/o7.png new file mode 100755 index 0000000..64f528a Binary files /dev/null and b/themes/darkblue/icons/display/o7.png differ diff --git a/themes/darkblue/icons/display/o8.png b/themes/darkblue/icons/display/o8.png new file mode 100755 index 0000000..1645212 Binary files /dev/null and b/themes/darkblue/icons/display/o8.png differ diff --git a/themes/darkblue/icons/display/o9.png b/themes/darkblue/icons/display/o9.png new file mode 100755 index 0000000..f7a2a12 Binary files /dev/null and b/themes/darkblue/icons/display/o9.png differ diff --git a/themes/darkblue/icons/layouts/centerwork.png b/themes/darkblue/icons/layouts/centerwork.png new file mode 100644 index 0000000..b94a3a0 Binary files /dev/null and b/themes/darkblue/icons/layouts/centerwork.png differ diff --git a/themes/darkblue/icons/layouts/cornerne.png b/themes/darkblue/icons/layouts/cornerne.png new file mode 100644 index 0000000..566bad9 Binary files /dev/null and b/themes/darkblue/icons/layouts/cornerne.png differ diff --git a/themes/darkblue/icons/layouts/cornernw.png b/themes/darkblue/icons/layouts/cornernw.png new file mode 100644 index 0000000..198ccf4 Binary files /dev/null and b/themes/darkblue/icons/layouts/cornernw.png differ diff --git a/themes/darkblue/icons/layouts/cornerse.png b/themes/darkblue/icons/layouts/cornerse.png new file mode 100644 index 0000000..5d841f5 Binary files /dev/null and b/themes/darkblue/icons/layouts/cornerse.png differ diff --git a/themes/darkblue/icons/layouts/cornersw.png b/themes/darkblue/icons/layouts/cornersw.png new file mode 100644 index 0000000..583ce08 Binary files /dev/null and b/themes/darkblue/icons/layouts/cornersw.png differ diff --git a/themes/darkblue/icons/layouts/dwindle.png b/themes/darkblue/icons/layouts/dwindle.png new file mode 100644 index 0000000..a050ddd Binary files /dev/null and b/themes/darkblue/icons/layouts/dwindle.png differ diff --git a/themes/darkblue/icons/layouts/fairh.png b/themes/darkblue/icons/layouts/fairh.png new file mode 100644 index 0000000..9471a0d Binary files /dev/null and b/themes/darkblue/icons/layouts/fairh.png differ diff --git a/themes/darkblue/icons/layouts/fairv.png b/themes/darkblue/icons/layouts/fairv.png new file mode 100644 index 0000000..7b532cc Binary files /dev/null and b/themes/darkblue/icons/layouts/fairv.png differ diff --git a/themes/darkblue/icons/layouts/floating.png b/themes/darkblue/icons/layouts/floating.png new file mode 100644 index 0000000..fed7c72 Binary files /dev/null and b/themes/darkblue/icons/layouts/floating.png differ diff --git a/themes/darkblue/icons/layouts/fullscreen.png b/themes/darkblue/icons/layouts/fullscreen.png new file mode 100644 index 0000000..b351d83 Binary files /dev/null and b/themes/darkblue/icons/layouts/fullscreen.png differ diff --git a/themes/darkblue/icons/layouts/magnifier.png b/themes/darkblue/icons/layouts/magnifier.png new file mode 100644 index 0000000..2a2ce8a Binary files /dev/null and b/themes/darkblue/icons/layouts/magnifier.png differ diff --git a/themes/darkblue/icons/layouts/max.png b/themes/darkblue/icons/layouts/max.png new file mode 100644 index 0000000..fd6ee1e Binary files /dev/null and b/themes/darkblue/icons/layouts/max.png differ diff --git a/themes/darkblue/icons/layouts/spiral.png b/themes/darkblue/icons/layouts/spiral.png new file mode 100644 index 0000000..00ba970 Binary files /dev/null and b/themes/darkblue/icons/layouts/spiral.png differ diff --git a/themes/darkblue/icons/layouts/termfair.png b/themes/darkblue/icons/layouts/termfair.png new file mode 100644 index 0000000..4375e14 Binary files /dev/null and b/themes/darkblue/icons/layouts/termfair.png differ diff --git a/themes/darkblue/icons/layouts/tile.png b/themes/darkblue/icons/layouts/tile.png new file mode 100644 index 0000000..ebae5ad Binary files /dev/null and b/themes/darkblue/icons/layouts/tile.png differ diff --git a/themes/darkblue/icons/layouts/tilebottom.png b/themes/darkblue/icons/layouts/tilebottom.png new file mode 100644 index 0000000..c814e54 Binary files /dev/null and b/themes/darkblue/icons/layouts/tilebottom.png differ diff --git a/themes/darkblue/icons/layouts/tileleft.png b/themes/darkblue/icons/layouts/tileleft.png new file mode 100644 index 0000000..4670988 Binary files /dev/null and b/themes/darkblue/icons/layouts/tileleft.png differ diff --git a/themes/darkblue/icons/layouts/tiletop.png b/themes/darkblue/icons/layouts/tiletop.png new file mode 100644 index 0000000..14e7b93 Binary files /dev/null and b/themes/darkblue/icons/layouts/tiletop.png differ diff --git a/themes/darkblue/icons/status/cloud.png b/themes/darkblue/icons/status/cloud.png new file mode 100644 index 0000000..9a031b0 Binary files /dev/null and b/themes/darkblue/icons/status/cloud.png differ diff --git a/themes/darkblue/icons/status/warning.png b/themes/darkblue/icons/status/warning.png new file mode 100644 index 0000000..2ab5a15 Binary files /dev/null and b/themes/darkblue/icons/status/warning.png differ diff --git a/themes/darkblue/icons/submenu.png b/themes/darkblue/icons/submenu.png new file mode 100755 index 0000000..e9a6b7c Binary files /dev/null and b/themes/darkblue/icons/submenu.png differ diff --git a/themes/darkblue/icons/titlebar/close_focus.png b/themes/darkblue/icons/titlebar/close_focus.png new file mode 100644 index 0000000..0b45a1a Binary files /dev/null and b/themes/darkblue/icons/titlebar/close_focus.png differ diff --git a/themes/darkblue/icons/titlebar/floating_focus_active.png b/themes/darkblue/icons/titlebar/floating_focus_active.png new file mode 100644 index 0000000..57ba0d5 Binary files /dev/null and b/themes/darkblue/icons/titlebar/floating_focus_active.png differ diff --git a/themes/darkblue/icons/titlebar/floating_focus_inactive.png b/themes/darkblue/icons/titlebar/floating_focus_inactive.png new file mode 100644 index 0000000..d0a50de Binary files /dev/null and b/themes/darkblue/icons/titlebar/floating_focus_inactive.png differ diff --git a/themes/darkblue/icons/titlebar/maximized_focus_active.png b/themes/darkblue/icons/titlebar/maximized_focus_active.png new file mode 100644 index 0000000..a3a27c2 Binary files /dev/null and b/themes/darkblue/icons/titlebar/maximized_focus_active.png differ diff --git a/themes/darkblue/icons/titlebar/maximized_focus_inactive.png b/themes/darkblue/icons/titlebar/maximized_focus_inactive.png new file mode 100644 index 0000000..ef4ec7d Binary files /dev/null and b/themes/darkblue/icons/titlebar/maximized_focus_inactive.png differ diff --git a/themes/darkblue/icons/titlebar/ontop_focus_active.png b/themes/darkblue/icons/titlebar/ontop_focus_active.png new file mode 100644 index 0000000..31e6052 Binary files /dev/null and b/themes/darkblue/icons/titlebar/ontop_focus_active.png differ diff --git a/themes/darkblue/icons/titlebar/ontop_focus_inactive.png b/themes/darkblue/icons/titlebar/ontop_focus_inactive.png new file mode 100644 index 0000000..c8baf31 Binary files /dev/null and b/themes/darkblue/icons/titlebar/ontop_focus_inactive.png differ diff --git a/themes/darkblue/icons/titlebar/sticky_focus_active.png b/themes/darkblue/icons/titlebar/sticky_focus_active.png new file mode 100644 index 0000000..90e08f1 Binary files /dev/null and b/themes/darkblue/icons/titlebar/sticky_focus_active.png differ diff --git a/themes/darkblue/icons/titlebar/sticky_focus_inactive.png b/themes/darkblue/icons/titlebar/sticky_focus_inactive.png new file mode 100644 index 0000000..73ffa3e Binary files /dev/null and b/themes/darkblue/icons/titlebar/sticky_focus_inactive.png differ diff --git a/themes/darkblue/icons/widgets/ac.png b/themes/darkblue/icons/widgets/ac.png new file mode 100644 index 0000000..967a3f6 Binary files /dev/null and b/themes/darkblue/icons/widgets/ac.png differ diff --git a/themes/darkblue/icons/widgets/battery.png b/themes/darkblue/icons/widgets/battery.png new file mode 100644 index 0000000..0569da0 Binary files /dev/null and b/themes/darkblue/icons/widgets/battery.png differ diff --git a/themes/darkblue/icons/widgets/battery_empty.png b/themes/darkblue/icons/widgets/battery_empty.png new file mode 100644 index 0000000..67647a3 Binary files /dev/null and b/themes/darkblue/icons/widgets/battery_empty.png differ diff --git a/themes/darkblue/icons/widgets/battery_low.png b/themes/darkblue/icons/widgets/battery_low.png new file mode 100644 index 0000000..6d21c20 Binary files /dev/null and b/themes/darkblue/icons/widgets/battery_low.png differ diff --git a/themes/darkblue/icons/widgets/battery_medium.png b/themes/darkblue/icons/widgets/battery_medium.png new file mode 100644 index 0000000..28f0bc4 Binary files /dev/null and b/themes/darkblue/icons/widgets/battery_medium.png differ diff --git a/themes/darkblue/icons/widgets/battery_no.png b/themes/darkblue/icons/widgets/battery_no.png new file mode 100644 index 0000000..297e9c4 Binary files /dev/null and b/themes/darkblue/icons/widgets/battery_no.png differ diff --git a/themes/darkblue/icons/widgets/clock.png b/themes/darkblue/icons/widgets/clock.png new file mode 100644 index 0000000..577f899 Binary files /dev/null and b/themes/darkblue/icons/widgets/clock.png differ diff --git a/themes/darkblue/icons/widgets/clock1.png b/themes/darkblue/icons/widgets/clock1.png new file mode 100644 index 0000000..8e6476f Binary files /dev/null and b/themes/darkblue/icons/widgets/clock1.png differ diff --git a/themes/darkblue/icons/widgets/cpu.png b/themes/darkblue/icons/widgets/cpu.png new file mode 100644 index 0000000..1cf9cdb Binary files /dev/null and b/themes/darkblue/icons/widgets/cpu.png differ diff --git a/themes/darkblue/icons/widgets/mem.png b/themes/darkblue/icons/widgets/mem.png new file mode 100644 index 0000000..b4d6ff1 Binary files /dev/null and b/themes/darkblue/icons/widgets/mem.png differ diff --git a/themes/darkblue/icons/widgets/ssd.png b/themes/darkblue/icons/widgets/ssd.png new file mode 100644 index 0000000..14caac8 Binary files /dev/null and b/themes/darkblue/icons/widgets/ssd.png differ diff --git a/themes/darkblue/icons/widgets/temp.png b/themes/darkblue/icons/widgets/temp.png new file mode 100644 index 0000000..4ffd33a Binary files /dev/null and b/themes/darkblue/icons/widgets/temp.png differ diff --git a/themes/darkblue/icons/widgets/vol.png b/themes/darkblue/icons/widgets/vol.png new file mode 100644 index 0000000..5856b35 Binary files /dev/null and b/themes/darkblue/icons/widgets/vol.png differ diff --git a/themes/darkblue/icons/widgets/vol.svg b/themes/darkblue/icons/widgets/vol.svg new file mode 100644 index 0000000..2d599f2 --- /dev/null +++ b/themes/darkblue/icons/widgets/vol.svg @@ -0,0 +1,84 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/themes/darkblue/icons/widgets/vol_low.png b/themes/darkblue/icons/widgets/vol_low.png new file mode 100644 index 0000000..4b8ee62 Binary files /dev/null and b/themes/darkblue/icons/widgets/vol_low.png differ diff --git a/themes/darkblue/icons/widgets/vol_low.svg b/themes/darkblue/icons/widgets/vol_low.svg new file mode 100644 index 0000000..76c23f5 --- /dev/null +++ b/themes/darkblue/icons/widgets/vol_low.svg @@ -0,0 +1,78 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/themes/darkblue/icons/widgets/vol_mute.png b/themes/darkblue/icons/widgets/vol_mute.png new file mode 100644 index 0000000..1b98349 Binary files /dev/null and b/themes/darkblue/icons/widgets/vol_mute.png differ diff --git a/themes/darkblue/icons/widgets/vol_mute.svg b/themes/darkblue/icons/widgets/vol_mute.svg new file mode 100644 index 0000000..8388cb8 --- /dev/null +++ b/themes/darkblue/icons/widgets/vol_mute.svg @@ -0,0 +1,82 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/themes/darkblue/icons/widgets/vol_no.png b/themes/darkblue/icons/widgets/vol_no.png new file mode 100644 index 0000000..ac41716 Binary files /dev/null and b/themes/darkblue/icons/widgets/vol_no.png differ diff --git a/themes/darkblue/icons/widgets/vol_no.svg b/themes/darkblue/icons/widgets/vol_no.svg new file mode 100644 index 0000000..39ef63d --- /dev/null +++ b/themes/darkblue/icons/widgets/vol_no.svg @@ -0,0 +1,94 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/themes/darkblue/screenshots/screen1.5.png b/themes/darkblue/screenshots/screen1.5.png new file mode 100644 index 0000000..65f1597 Binary files /dev/null and b/themes/darkblue/screenshots/screen1.5.png differ diff --git a/themes/darkblue/screenshots/screen1.png b/themes/darkblue/screenshots/screen1.png new file mode 100644 index 0000000..c831492 Binary files /dev/null and b/themes/darkblue/screenshots/screen1.png differ diff --git a/themes/darkblue/screenshots/screen2.png b/themes/darkblue/screenshots/screen2.png new file mode 100644 index 0000000..1ba4767 Binary files /dev/null and b/themes/darkblue/screenshots/screen2.png differ diff --git a/themes/darkblue/screenshots/screen3.png b/themes/darkblue/screenshots/screen3.png new file mode 100644 index 0000000..21530a9 Binary files /dev/null and b/themes/darkblue/screenshots/screen3.png differ diff --git a/themes/darkblue/screenshots/screen4.png b/themes/darkblue/screenshots/screen4.png new file mode 100644 index 0000000..2a44939 Binary files /dev/null and b/themes/darkblue/screenshots/screen4.png differ diff --git a/themes/darkblue/screenshots/screen5.png b/themes/darkblue/screenshots/screen5.png new file mode 100644 index 0000000..d982773 Binary files /dev/null and b/themes/darkblue/screenshots/screen5.png differ diff --git a/themes/darkblue/theme.lua b/themes/darkblue/theme.lua new file mode 100644 index 0000000..400ebd1 --- /dev/null +++ b/themes/darkblue/theme.lua @@ -0,0 +1,553 @@ +local gears = require("gears") +local lain = require("lain") +local awful = require("awful") +local wibox = require("wibox") +local os, math, string = os, math, string + +require('themes.default.layout') + +local theme = {} +theme.dir = os.getenv("HOME") .. "/.config/awesome/themes/darkblue" +theme.wallpaper = theme.dir .. "/wallpapers/wall_0.png" +theme.font = "Meslo LGS Regular 10" +theme.taglist_font = "Meslo LGS Bold 10" +theme.tasklist_font = "Terminus 10" + +theme.bg_normal = "#32302f" +theme.fg_normal = "#a89984" +theme.bg_focus = "#32302f" +theme.fg_focus = "#232323" +theme.bg_urgent = "#C92132" +theme.fg_urgent = "#282828" + +theme.fg_widget = "#32302f" + +theme.taglist_bg_focus = "#4e9699" +theme.taglist_fg_focus = "#282828" +theme.taglist_bg_occupied = "#2b5355" +theme.taglist_fg_occupied = "#282828" +theme.taglist_bg_empty = "#32302f" +theme.taglist_fg_empty = "#ebdbb2" +theme.taglist_bg_urgent = "#C92132" +theme.taglist_fg_urgent = "#282828" + +theme.tasklist_bg_normal = "#32302f" +theme.tasklist_fg_normal = "#ebdbb2" +theme.tasklist_bg_focus = "#32302f" +theme.tasklist_fg_focus = "#ebdbb2" +theme.tasklist_bg_urgent = "#C92132" +theme.tasklist_fg_urgent = "#32302f" + +theme.border_width = 5 +theme.border_normal = "#32302f" +theme.border_focus = "#3f3f3f" +theme.border_marked = "#CC9393" + +theme.titlebar_bg_normal = "#3f3f3f" +theme.titlebar_fg_normal = "#282828" + +theme.titlebar_bg_focus = "#2b5355" +theme.titlebar_fg_focus = "#282828" + +theme.menu_height = 16 +theme.menu_width = 140 + +theme.notification_font = "Meslo LGS Regular 12" +theme.notification_bg = theme.bg_normal +theme.notification_fg = theme.fg_normal +theme.notification_border_width = 0 +theme.notification_border_color = theme.bg_normal +theme.notification_shape = gears.shape.infobubble +theme.notification_opacity = 1 +theme.notification_margin = 30 +--theme.warning = theme.dir .. "/icons/status/warning.png" +--theme.notification_width = 300 +--theme.notification_height = 200 + +theme.menu_submenu_icon = theme.dir .. "/icons/submenu.png" +theme.awesome_icon = theme.dir .. "/icons/awesome.png" + +-- Layout icons +theme.layout_tile = theme.dir .. "/icons/layouts/tile.png" +theme.layout_tileleft = theme.dir .. "/icons/layouts/tileleft.png" +theme.layout_tilebottom = theme.dir .. "/icons/layouts/tilebottom.png" +theme.layout_tiletop = theme.dir .. "/icons/layouts/tiletop.png" +theme.layout_fairv = theme.dir .. "/icons/layouts/fairv.png" +theme.layout_fairh = theme.dir .. "/icons/layouts/fairh.png" +theme.layout_spiral = theme.dir .. "/icons/layouts/spiral.png" +theme.layout_centerwork = theme.dir .. "/icons/layouts/centerwork.png" +theme.layout_dwindle = theme.dir .. "/icons/layouts/dwindle.png" +theme.layout_max = theme.dir .. "/icons/layouts/max.png" +theme.layout_fullscreen = theme.dir .. "/icons/layouts/fullscreen.png" +theme.layout_magnifier = theme.dir .. "/icons/layouts/magnifier.png" +theme.layout_floating = theme.dir .. "/icons/layouts/floating.png" + +--Widget icons +theme.widget_ac = theme.dir .. "/icons/widgets/ac.png" +theme.widget_battery = theme.dir .. "/icons/widgets/battery.png" +theme.widget_battery_medium = theme.dir .. "/icons/widgets/battery_medium.png" +theme.widget_battery_low = theme.dir .. "/icons/widgets/battery_low.png" +theme.widget_battery_empty = theme.dir .. "/icons/widgets/battery_empty.png" +theme.widget_battery_no = theme.dir .. "/icons/widgets/battery_no.png" + +theme.widget_mem = theme.dir .. "/icons/widgets/mem.png" +theme.widget_cpu = theme.dir .. "/icons/widgets/cpu.png" +theme.widget_temp = theme.dir .. "/icons/widgets/temp.png" +theme.widget_net = theme.dir .. "/icons/widgets/net.png" +theme.widget_hdd = theme.dir .. "/icons/widgets/ssd.png" +theme.widget_clock = theme.dir .. "/icons/widgets/clock.png" +theme.widget_music = theme.dir .. "/icons/widgets/note.png" +theme.widget_music_on = theme.dir .. "/icons/widgets/note_on.png" +theme.widget_music_pause = theme.dir .. "/icons/widgets/pause.png" +theme.widget_music_stop = theme.dir .. "/icons/widgets/stop.png" + +theme.widget_vol = theme.dir .. "/icons/widgets/vol.png" +theme.widget_vol_low = theme.dir .. "/icons/widgets/vol_low.png" +theme.widget_vol_no = theme.dir .. "/icons/widgets/vol_no.png" +theme.widget_vol_mute = theme.dir .. "/icons/widgets/vol_mute.png" + +theme.tasklist_plain_task_name = true +theme.tasklist_disable_icon = true +theme.useless_gap = 7 + +theme.titlebar_close_button_focus = theme.dir .. "/icons/titlebar/close_focus.png" + +theme.titlebar_ontop_button_focus_active = theme.dir .. "/icons/titlebar/ontop_focus_active.png" +--theme.titlebar_ontop_button_normal_active = theme.dir .. "/icons/titlebar/ontop_normal_active.png" + +theme.titlebar_ontop_button_focus_inactive = theme.dir .. "/icons/titlebar/ontop_focus_inactive.png" +--theme.titlebar_ontop_button_normal_inactive = theme.dir .. "/icons/titlebar/ontop_normal_inactive.png" + +theme.titlebar_sticky_button_focus_active = theme.dir .. "/icons/titlebar/sticky_focus_active.png" +--theme.titlebar_sticky_button_normal_active = theme.dir .. "/icons/titlebar/sticky_normal_active.png" + +theme.titlebar_sticky_button_focus_inactive = theme.dir .. "/icons/titlebar/sticky_focus_inactive.png" +--theme.titlebar_sticky_button_normal_inactive = theme.dir .. "/icons/titlebar/sticky_normal_inactive.png" + +theme.titlebar_floating_button_focus_active = theme.dir .. "/icons/titlebar/floating_focus_active.png" +--theme.titlebar_floating_button_normal_active = theme.dir .. "/icons/titlebar/floating_normal_active.png" + +theme.titlebar_floating_button_focus_inactive = theme.dir .. "/icons/titlebar/floating_focus_inactive.png" +--theme.titlebar_floating_button_normal_inactive = theme.dir .. "/icons/titlebar/floating_normal_inactive.png" + +theme.titlebar_maximized_button_focus_active = theme.dir .. "/icons/titlebar/maximized_focus_active.png" +--theme.titlebar_maximized_button_normal_active = theme.dir .. "/icons/titlebar/maximized_normal_active.png" + +theme.titlebar_maximized_button_focus_inactive = theme.dir .. "/icons/titlebar/maximized_focus_inactive.png" +--theme.titlebar_maximized_button_normal_inactive = theme.dir .. "/icons/titlebar/maximized_normal_inactive.png" + +-- Application icons +theme.chrome = theme.dir .. "/icons/apps/chrome.png" +theme.webstorm = theme.dir .. "/icons/apps/webstorm.png" +theme.idea = theme.dir .. "/icons/apps/idea.png" +theme.pycharm = theme.dir .. "/icons/apps/pycharm.png" +theme.teamviewer = theme.dir .. "/icons/apps/teamviewer.png" +theme.vivaldi = theme.dir .. "/icons/apps/vivaldi.png" + +-- colors +theme.green = "#00b159" +theme.red = "#d64d4d" +theme.yellow = "#cc9c00" +theme.blue = "#428bca" +theme.darkred = "#c92132" +theme.darkgreen = "#4d7358" +theme.darkyellow = "#f18e38" +theme.gray = "#5e5e5e" +theme.violet = "#8c8ccd" +theme.pink = "#B85C8A" +theme.black = theme.bg_normal + +-- Panel +local markup = lain.util.markup + +theme.w1 = theme.dir .. "/icons/display/1.png" +theme.w2 = theme.dir .. "/icons/display/2.png" +theme.w3 = theme.dir .. "/icons/display/3.png" +theme.w4 = theme.dir .. "/icons/display/4.png" +theme.w5 = theme.dir .. "/icons/display/5.png" +theme.w6 = theme.dir .. "/icons/display/6.png" +theme.w7 = theme.dir .. "/icons/display/7.png" +theme.w8 = theme.dir .. "/icons/display/8.png" +theme.w9 = theme.dir .. "/icons/display/9.png" +theme.w10 = theme.dir .. "/icons/display/10.png" +theme.w11 = theme.dir .. "/icons/display/11.png" +theme.w12 = theme.dir .. "/icons/display/12.png" +theme.w13 = theme.dir .. "/icons/display/13.png" +theme.w14 = theme.dir .. "/icons/display/14.png" +theme.w15 = theme.dir .. "/icons/display/15.png" +theme.w16 = theme.dir .. "/icons/display/16.png" +theme.w17 = theme.dir .. "/icons/display/17.png" + +w1 = wibox.widget.imagebox(theme.w1) +w2 = wibox.widget.imagebox(theme.w2) +w3 = wibox.widget.imagebox(theme.w3) +w4 = wibox.widget.imagebox(theme.w4) +w5 = wibox.widget.imagebox(theme.w5) +w6 = wibox.widget.imagebox(theme.w6) +w7 = wibox.widget.imagebox(theme.w7) +w8 = wibox.widget.imagebox(theme.w8) +w9 = wibox.widget.imagebox(theme.w9) +w10 = wibox.widget.imagebox(theme.w10) +w11 = wibox.widget.imagebox(theme.w11) +w12 = wibox.widget.imagebox(theme.w12) +w13 = wibox.widget.imagebox(theme.w13) +w14 = wibox.widget.imagebox(theme.w14) +w15 = wibox.widget.imagebox(theme.w15) +w16 = wibox.widget.imagebox(theme.w16) +w17 = wibox.widget.imagebox(theme.w17) + +-- Widgets +local clock_icon = wibox.widget.imagebox(theme.widget_clock) +local clock = awful.widget.textclock(" %a %d %b %H:%M ") +local clock_widget = wibox.container.background(wibox.container.margin(wibox.widget {clock_icon, clock, layout = wibox.layout.align.horizontal }, 0, 1), theme.violet) + +-- Calendar +local calendar = lain.widget.calendar({ + cal = "cal --color=always", + attach_to = { clock_widget }, + notification_preset = { + font = "Meslo LGS Regular 10", + fg = theme.fg_normal, + bg = theme.bg_normal + } +}) + +-- Battery +local bat_icon = wibox.widget.imagebox(theme.widget_battery) +local batspr_l = wibox.widget.imagebox(theme.w8) +local batspr_r = wibox.widget.imagebox(theme.w9) +local bat = lain.widget.bat({ + battery = "BAT0", + timeout = 1, + notify = "on", + n_perc = {5,15}, + settings = function() + bat_notification_low_preset = { + title = "Battery low", + text = "Plug the cable!", + timeout = 15, + fg = "#232323", + bg = "#f18e38" + } + bat_notification_critical_preset = { + title = "Battery exhausted", + text = "Shutdown imminent", + timeout = 15, + fg = "#232323", + bg = "#c92132" + } + + if bat_now.status ~= "N/A" then + if bat_now.status == "Charging" then + bat_icon:set_image(theme.widget_ac) + batspr_l:set_image(theme.w12) + batspr_r:set_image(theme.w10) + widget:set_markup(markup.font(theme.font, markup.bg.color(theme.blue, markup.fg.color(theme.fg_widget," +" .. bat_now.perc .. "% [" .. bat_now.watt .. "W][" .. bat_now.time .. "]")))) + elseif bat_now.status == "Full" then + bat_icon:set_image(theme.widget_ac) + batspr_l:set_image(theme.w8) + batspr_r:set_image(theme.w9) + widget:set_markup(markup.font(theme.font, markup.fg.color("#232323", " ~" .. bat_now.perc .. "% [" .. bat_now.watt .. "W][" .. bat_now.time .. "]"))) + elseif tonumber(bat_now.perc) <= 35 then + bat_icon:set_image(theme.widget_battery_empty) + batspr_l:set_image(theme.w13) + batspr_r:set_image(theme.w11) + widget:set_markup(markup.font(theme.font, markup.bg.color(theme.red, markup.fg.color(theme.fg_widget, " -" .. bat_now.perc .. "% [" .. bat_now.watt .. "W][" .. bat_now.time .. "]")))) + elseif tonumber(bat_now.perc) <= 70 then + bat_icon:set_image(theme.widget_battery_medium) + batspr_l:set_image(theme.w16) + batspr_r:set_image(theme.w14) + widget:set_markup(markup.font(theme.font, markup.bg.color(theme.yellow, markup.fg.color(theme.fg_widget, " -" .. bat_now.perc .. "% [" .. bat_now.watt .. "W][" .. bat_now.time .. "]")))) + elseif tonumber(bat_now.perc) <= 90 then + bat_icon:set_image(theme.widget_battery) + batspr_l:set_image(theme.w17) + batspr_r:set_image(theme.w15) + widget:set_markup(markup.font(theme.font, markup.bg.color(theme.green, markup.fg.color(theme.fg_widget, " -" .. bat_now.perc .. "% [" .. bat_now.watt .. "W][" .. bat_now.time .. "]")))) + else + bat_icon:set_image(theme.widget_battery) + batspr_l:set_image(theme.w12) + batspr_r:set_image(theme.w10) + widget:set_markup(markup.font(theme.font, markup.bg.color(theme.blue, markup.fg.color(theme.fg_widget, " -" .. bat_now.perc .. "% [" .. bat_now.watt .. "W][" .. bat_now.time .. "]")))) + end + else + widget:set_markup(markup.font(theme.font, markup.bg.color(theme.red, markup.fg.color(theme.fg_widget, " AC ")))) + bat_icon:set_image(theme.widget_battery_no) + batspr_l:set_image(theme.w13) + batspr_r:set_image(theme.w11) + end + end +}) + +-- Battery +local batbar = wibox.widget { + forced_height = 1, + forced_width = 45, + color = "#232323", + background_color = "#232323", + margins = 1, + paddings = 1, + ticks = true, + ticks_size = 5, + widget = wibox.widget.progressbar, +} + +local batupd = lain.widget.bat({ + battery = "BAT0", + timeout = 1, + settings = function() + if bat_now.status ~= "N/A" then + if bat_now.status == "Charging" then + batbar:set_color(theme.blue) + elseif bat_now.status == "Full" then + batbar:set_color(theme.gray) + elseif tonumber(bat_now.perc) <= 35 then + batbar:set_color(theme.red) + elseif tonumber(bat_now.perc) <= 70 then + batbar:set_color(theme.yellow) + elseif tonumber(bat_now.perc) <= 90 then + batbar:set_color(theme.green) + else + batbar:set_color(theme.blue) + end + batbar:set_value(bat_now.perc / 100) + else + return + end + end +}) +local batbg = wibox.container.background(batbar, "#474747", gears.shape.rectangle) +local bat_widget = wibox.container.margin(batbg, 2, 7, 4, 4) + +--local battery_widget = wibox.container.background(wibox.container.margin(wibox.widget { bat_icon, bat_widget, bat.widget, layout = wibox.layout.align.horizontal }, 1, 1), theme.gray) +local battery_widget1 = wibox.container.background(wibox.container.margin(wibox.widget { bat_icon, bat_widget, layout = wibox.layout.align.horizontal }, 1, 1), theme.gray) +local battery_widget2 = wibox.container.background(wibox.container.margin(wibox.widget { batspr_l, bat.widget, batspr_r, layout = wibox.layout.align.horizontal }, 0, 0), theme.gray) + +-- MEM +local mem_icon = wibox.widget.imagebox(theme.widget_mem) +local mem = lain.widget.mem({ + settings = function() + widget:set_markup(markup.font(theme.font, markup.fg.color(theme.fg_widget, " " .. mem_now.used .. "MB [" .. mem_now.perc .. "%]"))) + end +}) +local mem_widget = wibox.container.background(wibox.container.margin(wibox.widget { mem_icon, mem.widget, layout = wibox.layout.align.horizontal }, 0, 0), theme.pink) + + +-- CPU +local cpu_icon = wibox.widget.imagebox(theme.widget_cpu) +local cpu = lain.widget.cpu({ + settings = function() + widget:set_markup(markup.font(theme.font, markup.fg.color(theme.fg_widget, " " .. cpu_now.usage .. "% "))) + end +}) +local cpu_widget = wibox.container.background(wibox.container.margin(wibox.widget { cpu_icon, cpu.widget, layout = wibox.layout.align.horizontal }, 0, 0), theme.blue) + + +-- Coretemp (lain, average) +local temp_icon = wibox.widget.imagebox(theme.widget_temp) +local temp = lain.widget.temp({ + settings = function() + widget:set_markup(markup.font(theme.font, markup.fg.color(theme.fg_widget, " " .. coretemp_now .. "° "))) + end +}) +local temp_widget = wibox.container.background(wibox.container.margin(wibox.widget { temp_icon, temp.widget, layout = wibox.layout.align.horizontal }, 0, 0), theme.red) + + +-- FS +local fs_icon = wibox.widget.imagebox(theme.widget_hdd) +local fs = lain.widget.fs({ + notification_preset = { fg = theme.fg_normal, bg = theme.bg_normal, font = theme.fs_font }, + settings = function() + local fsp = string.format(" %3.2f %s ", fs_now["/home"].free, fs_now["/home"].units) + widget:set_markup(markup.font(theme.font, markup.fg.color(theme.fg_widget, fsp))) + end +}) +local fs_widget = wibox.container.background(wibox.container.margin(wibox.widget { fs_icon, fs.widget, layout = wibox.layout.align.horizontal }, 0, 0), theme.yellow) + +-- ALSA volume bar +local vol_icon = wibox.widget.imagebox(theme.widget_vol) +theme.volume = lain.widget.alsabar({ + width = 45, border_width = 0, ticks = true, ticks_size = 5, + notification_preset = { font = theme.font }, + --togglechannel = "IEC958,3", + settings = function() + if volume_now.status == "off" then + vol_icon:set_image(theme.widget_vol_mute) + elseif volume_now.level == 0 then + vol_icon:set_image(theme.widget_vol_no) + elseif volume_now.level <= 50 then + vol_icon:set_image(theme.widget_vol_low) + else + vol_icon:set_image(theme.widget_vol) + end + end, + colors = { + background = theme.bg_normal, + mute = red, + unmute = "#5cb85c" + } +}) +theme.volume.tooltip.wibox.fg = theme.fg_widget +theme.volume.bar:buttons(awful.util.table.join ( + awful.button({}, 1, function() + awful.spawn.with_shell(string.format("%s -e alsamixer", awful.util.terminal)) + end), + awful.button({}, 2, function() + awful.spawn(string.format("%s set %s 100%%", theme.volume.cmd, theme.volume.channel)) + theme.volume.update() + end), + awful.button({}, 3, function() + awful.spawn(string.format("%s set %s toggle", theme.volume.cmd, theme.volume.togglechannel or theme.volume.channel)) + theme.volume.update() + end), + awful.button({}, 4, function() + awful.spawn(string.format("%s set %s 1%%+", theme.volume.cmd, theme.volume.channel)) + theme.volume.update() + end), + awful.button({}, 5, function() + awful.spawn(string.format("%s set %s 1%%-", theme.volume.cmd, theme.volume.channel)) + theme.volume.update() + end) +)) +local volumebg = wibox.container.background(theme.volume.bar, "#888888", gears.shape.rectangle) +local vol_widget = wibox.container.margin(volumebg, 2, 7, 4, 4) +local volume_widget = wibox.container.background(wibox.container.margin(wibox.widget { vol_icon, vol_widget, layout = wibox.layout.align.horizontal }, 0, 0), theme.blue) + +-- Keyboard layout switcher +-- kbdwidget = wibox.widget.textbox() +-- kbdwidget.border_width = 0 +-- kbdwidget.border_color = theme.bg_normal +-- kbdwidget.font = theme.font +-- kbdwidget:set_markup(" Eng ") + +-- kbdstrings = {[0] = " Eng ", +-- [1] = " Rus "} + +-- dbus.request_name("session", "ru.gentoo.kbdd") +-- dbus.add_match("session", "interface='ru.gentoo.kbdd',member='layoutChanged'") +-- dbus.connect_signal("ru.gentoo.kbdd", function(...) +-- local data = {...} +-- local layout = data[2] +-- kbdwidget:set_markup("" .. kbdstrings[layout] .. "") +-- end +-- ) +-- local kbd_widget = wibox.container.background(wibox.container.margin(wibox.widget { kbdwidget, layout = wibox.layout.align.horizontal }, 0, 0, 0, 0), theme.green) + +kbd_widget = awful.widget.keyboardlayout:new() +local kbd_widget = wibox.container.background(wibox.container.margin(wibox.widget { kbd_widget, layout = wibox.layout.align.horizontal }, 0, 0, 0, 0), theme.green) + +-- -- Chrome_button +local chrome_button = awful.widget.button({ image = theme.chrome }) +chrome_button:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.util.spawn("google-chrome-stable") end) +)) +-- vivaldi_button +local vivaldi_button = awful.widget.button({ image = theme.vivaldi }) +vivaldi_button:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.util.spawn("vivaldi-snapshot") end) +)) +-- webstorm_button +webstorm_button = awful.widget.button({ image = theme.webstorm }) +webstorm_button:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.util.spawn("webstorm") end) +)) +-- idea_button +idea_button = awful.widget.button({ image = theme.idea }) +idea_button:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.util.spawn("intellij-idea-ultimate-edition") end) +)) +-- pycharm_button +pycharm_button = awful.widget.button({ image = theme.pycharm }) +pycharm_button:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.util.spawn("pycharm") end) +)) +-- teamviewer_button +teamviewer_button = awful.widget.button({ image = theme.teamviewer }) +teamviewer_button:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.util.spawn("teamviewer") end) +)) + +function theme.connect(s) + -- Quake application + s.quake = lain.util.quake({ app = awful.util.terminal }) + + -- If wallpaper is a function, call it with the screen + local wallpaper = theme.wallpaper + if type(wallpaper) == "function" then + wallpaper = wallpaper(s) + end + gears.wallpaper.maximized(wallpaper, 1, true) + + -- Tags + --awful.tag(awful.util.tagnames, s, awful.layout.layouts[1]) + layout = { awful.layout.layouts[1], awful.layout.layouts[1], awful.layout.layouts[1], awful.layout.layouts[3], awful.layout.layouts[3], awful.layout.layouts[5]} + awful.tag({ " ", " >_ ", " web ", " & ", " etc ", " # " }, s, layout) + + -- Create a promptbox for each screen + s.mypromptbox = awful.widget.prompt() + -- Create an imagebox widget which will contains an icon indicating which layout we're using. + -- We need one layoutbox per screen. + s.mylayoutbox = awful.widget.layoutbox(s) + s.mylayoutbox:buttons(awful.util.table.join( + awful.button({ }, 1, function () awful.layout.inc( 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))) + -- Create a taglist widget + s.mytaglist = awful.widget.taglist(s, awful.widget.taglist.filter.all, awful.util.taglist_buttons) + + -- Create a tasklist widget + --s.mytasklist = awful.widget.tasklist(s, awful.widget.tasklist.filter.currenttags, awful.util.tasklist_buttons) + + -- Create the wibox + s.mywibox = awful.wibar({ position = "top", screen = s, height = 16, bg = theme.bg_normal, fg = theme.fg_focus, }) + + -- Add widgets to the wibox + s.mywibox:setup { + layout = wibox.layout.align.horizontal, + { -- Left widgets + layout = wibox.layout.fixed.horizontal, + s.mytaglist, + s.mypromptbox, + chrome_button, + idea_button, + pycharm_button, + webstorm_button, + teamviewer_button, + vivaldi_button, + }, + --s.mytasklist, -- Middle widget + nil, + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + wibox.widget.systray(), + -- Keyboard + w1, + kbd_widget, + -- Volume + w2, + volume_widget, + -- Fs widget + w3, + fs_widget, + -- Temp + w4, + temp_widget, + -- CPU widget + w5, + cpu_widget, + -- Mem widget + w6, + mem_widget, + -- Battery widget + w7, + battery_widget1, + battery_widget2, + -- Clock + clock_widget, + -- Layout box + s.mylayoutbox, + }, + } +end + +return theme diff --git a/themes/darkblue/wallpapers/wall_0.png b/themes/darkblue/wallpapers/wall_0.png new file mode 100644 index 0000000..c1c25e8 Binary files /dev/null and b/themes/darkblue/wallpapers/wall_0.png differ diff --git a/themes/darkblue/wallpapers/wall_1.png b/themes/darkblue/wallpapers/wall_1.png new file mode 100644 index 0000000..1b0b8f9 Binary files /dev/null and b/themes/darkblue/wallpapers/wall_1.png differ diff --git a/themes/darkblue/wallpapers/wall_2.png b/themes/darkblue/wallpapers/wall_2.png new file mode 100644 index 0000000..b63d5be Binary files /dev/null and b/themes/darkblue/wallpapers/wall_2.png differ diff --git a/layout/init.lua b/themes/default/layout/init.lua similarity index 89% rename from layout/init.lua rename to themes/default/layout/init.lua index bf3c389..c915def 100644 --- a/layout/init.lua +++ b/themes/default/layout/init.lua @@ -3,7 +3,7 @@ local awful = require("awful") local wibox = require("wibox") local beautiful = require("beautiful") local widget = require("widget") -local top_panel = require("layout.top-panel") +local top_panel = require("themes.default.layout.top-panel") -- {{{ Variable definitions diff --git a/layout/top-panel.lua b/themes/default/layout/top-panel.lua similarity index 100% rename from layout/top-panel.lua rename to themes/default/layout/top-panel.lua diff --git a/themes/default/theme.lua b/themes/default/theme.lua new file mode 100644 index 0000000..0bc4526 --- /dev/null +++ b/themes/default/theme.lua @@ -0,0 +1,141 @@ +-- If LuaRocks is installed, make sure that packages installed through it are +-- found (e.g. lgi). If LuaRocks is not installed, do nothing. +pcall(require, "luarocks.loader") + +require("awful.autofocus") +-- Enable hotkeys help widget for VIM and other apps +-- when client with a matching name is opened: +require("awful.hotkeys_popup.keys") +require('themes.default.layout') + +--------------------------- +-- Default awesome theme -- +--------------------------- + +local theme_assets = require("beautiful.theme_assets") +local xresources = require("beautiful.xresources") +local dpi = xresources.apply_dpi + +local gfs = require("gears.filesystem") +local themes_path = gfs.get_themes_dir() + +local theme = {} + +theme.font = "sans 8" + +theme.bg_normal = "#222222" +theme.bg_focus = "#535d6c" +theme.bg_urgent = "#ff0000" +theme.bg_minimize = "#444444" +theme.bg_systray = theme.bg_normal + +theme.fg_normal = "#aaaaaa" +theme.fg_focus = "#ffffff" +theme.fg_urgent = "#ffffff" +theme.fg_minimize = "#ffffff" + +theme.useless_gap = dpi(0) +theme.border_width = dpi(1) +theme.border_normal = "#000000" +theme.border_focus = "#535d6c" +theme.border_marked = "#91231c" + +-- There are other variable sets +-- overriding the default one when +-- defined, the sets are: +-- taglist_[bg|fg]_[focus|urgent|occupied|empty|volatile] +-- tasklist_[bg|fg]_[focus|urgent] +-- titlebar_[bg|fg]_[normal|focus] +-- tooltip_[font|opacity|fg_color|bg_color|border_width|border_color] +-- mouse_finder_[color|timeout|animate_timeout|radius|factor] +-- prompt_[fg|bg|fg_cursor|bg_cursor|font] +-- hotkeys_[bg|fg|border_width|border_color|shape|opacity|modifiers_fg|label_bg|label_fg|group_margin|font|description_font] +-- Example: +--theme.taglist_bg_focus = "#ff0000" + +-- Generate taglist squares: +local taglist_square_size = dpi(4) +theme.taglist_squares_sel = theme_assets.taglist_squares_sel( + taglist_square_size, theme.fg_normal +) +theme.taglist_squares_unsel = theme_assets.taglist_squares_unsel( + taglist_square_size, theme.fg_normal +) + +-- Variables set for theming notifications: +-- notification_font +-- notification_[bg|fg] +-- notification_[width|height|margin] +-- notification_[border_color|border_width|shape|opacity] + +-- Variables set for theming the menu: +-- menu_[bg|fg]_[normal|focus] +-- menu_[border_color|border_width] +theme.menu_submenu_icon = themes_path.."default/submenu.png" +theme.menu_height = dpi(15) +theme.menu_width = dpi(100) + +-- You can add as many variables as +-- you wish and access them by using +-- beautiful.variable in your rc.lua +--theme.bg_widget = "#cc0000" + +-- Define the image to load +theme.titlebar_close_button_normal = themes_path.."default/titlebar/close_normal.png" +theme.titlebar_close_button_focus = themes_path.."default/titlebar/close_focus.png" + +theme.titlebar_minimize_button_normal = themes_path.."default/titlebar/minimize_normal.png" +theme.titlebar_minimize_button_focus = themes_path.."default/titlebar/minimize_focus.png" + +theme.titlebar_ontop_button_normal_inactive = themes_path.."default/titlebar/ontop_normal_inactive.png" +theme.titlebar_ontop_button_focus_inactive = themes_path.."default/titlebar/ontop_focus_inactive.png" +theme.titlebar_ontop_button_normal_active = themes_path.."default/titlebar/ontop_normal_active.png" +theme.titlebar_ontop_button_focus_active = themes_path.."default/titlebar/ontop_focus_active.png" + +theme.titlebar_sticky_button_normal_inactive = themes_path.."default/titlebar/sticky_normal_inactive.png" +theme.titlebar_sticky_button_focus_inactive = themes_path.."default/titlebar/sticky_focus_inactive.png" +theme.titlebar_sticky_button_normal_active = themes_path.."default/titlebar/sticky_normal_active.png" +theme.titlebar_sticky_button_focus_active = themes_path.."default/titlebar/sticky_focus_active.png" + +theme.titlebar_floating_button_normal_inactive = themes_path.."default/titlebar/floating_normal_inactive.png" +theme.titlebar_floating_button_focus_inactive = themes_path.."default/titlebar/floating_focus_inactive.png" +theme.titlebar_floating_button_normal_active = themes_path.."default/titlebar/floating_normal_active.png" +theme.titlebar_floating_button_focus_active = themes_path.."default/titlebar/floating_focus_active.png" + +theme.titlebar_maximized_button_normal_inactive = themes_path.."default/titlebar/maximized_normal_inactive.png" +theme.titlebar_maximized_button_focus_inactive = themes_path.."default/titlebar/maximized_focus_inactive.png" +theme.titlebar_maximized_button_normal_active = themes_path.."default/titlebar/maximized_normal_active.png" +theme.titlebar_maximized_button_focus_active = themes_path.."default/titlebar/maximized_focus_active.png" + +theme.wallpaper = themes_path.."default/background.png" + +-- You can use your own layout icons like this: +theme.layout_fairh = themes_path.."default/layouts/fairhw.png" +theme.layout_fairv = themes_path.."default/layouts/fairvw.png" +theme.layout_floating = themes_path.."default/layouts/floatingw.png" +theme.layout_magnifier = themes_path.."default/layouts/magnifierw.png" +theme.layout_max = themes_path.."default/layouts/maxw.png" +theme.layout_fullscreen = themes_path.."default/layouts/fullscreenw.png" +theme.layout_tilebottom = themes_path.."default/layouts/tilebottomw.png" +theme.layout_tileleft = themes_path.."default/layouts/tileleftw.png" +theme.layout_tile = themes_path.."default/layouts/tilew.png" +theme.layout_tiletop = themes_path.."default/layouts/tiletopw.png" +theme.layout_spiral = themes_path.."default/layouts/spiralw.png" +theme.layout_dwindle = themes_path.."default/layouts/dwindlew.png" +theme.layout_cornernw = themes_path.."default/layouts/cornernww.png" +theme.layout_cornerne = themes_path.."default/layouts/cornernew.png" +theme.layout_cornersw = themes_path.."default/layouts/cornersww.png" +theme.layout_cornerse = themes_path.."default/layouts/cornersew.png" + +-- Generate Awesome icon: +theme.awesome_icon = theme_assets.awesome_icon( + theme.menu_height, theme.bg_focus, theme.fg_focus +) + +-- Define the icon theme for application icons. If not set then the icons +-- from /usr/share/icons and /usr/share/icons/hicolor will be used. +theme.icon_theme = nil + +return theme + +-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 \ No newline at end of file diff --git a/theme/icons/discord.svg b/themes/icons/discord.svg similarity index 100% rename from theme/icons/discord.svg rename to themes/icons/discord.svg diff --git a/theme/icons/init.lua b/themes/icons/init.lua similarity index 93% rename from theme/icons/init.lua rename to themes/icons/init.lua index 1054c79..2200d30 100644 --- a/theme/icons/init.lua +++ b/themes/icons/init.lua @@ -1,4 +1,4 @@ -local dir = os.getenv('HOME') .. '/.config/awesome/theme/icons' +local dir = os.getenv('HOME') .. '/.config/awesome/themes/icons' return { --tags diff --git a/theme/icons/signal.svg b/themes/icons/signal.svg similarity index 100% rename from theme/icons/signal.svg rename to themes/icons/signal.svg diff --git a/theme/icons/telegram.svg b/themes/icons/telegram.svg similarity index 100% rename from theme/icons/telegram.svg rename to themes/icons/telegram.svg diff --git a/theme/icons/terminal.svg b/themes/icons/terminal.svg similarity index 100% rename from theme/icons/terminal.svg rename to themes/icons/terminal.svg diff --git a/theme/icons/tunderbird.svg b/themes/icons/tunderbird.svg similarity index 100% rename from theme/icons/tunderbird.svg rename to themes/icons/tunderbird.svg diff --git a/theme/icons/vivaldi.svg b/themes/icons/vivaldi.svg similarity index 100% rename from theme/icons/vivaldi.svg rename to themes/icons/vivaldi.svg diff --git a/theme/init.lua b/themes/init.lua similarity index 100% rename from theme/init.lua rename to themes/init.lua