diff --git a/home-manager/dots/senpai/highlight b/home-manager/dots/senpai/highlight index d5e33cf..bc0f432 100755 --- a/home-manager/dots/senpai/highlight +++ b/home-manager/dots/senpai/highlight @@ -3,4 +3,4 @@ escape() { printf "%s" "$1" | sed 's#\#\\#g' } -notify-desktop "[$BUFFER] $SENDER" "$(escape "$MESSAGE")" +notify-send "[$BUFFER] $SENDER" "$(escape "$MESSAGE")" diff --git a/packages/river-bsp-layout/.gitignore b/packages/river-bsp-layout/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/packages/river-bsp-layout/.gitignore @@ -0,0 +1 @@ +/target diff --git a/packages/river-bsp-layout/Cargo.lock b/packages/river-bsp-layout/Cargo.lock new file mode 100644 index 0000000..bd44689 --- /dev/null +++ b/packages/river-bsp-layout/Cargo.lock @@ -0,0 +1,472 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "aho-corasick" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6748e8def348ed4d14996fa801f4122cd763fff530258cdc03f64b25f89d3a5a" +dependencies = [ + "memchr", +] + +[[package]] +name = "anstream" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f58811cfac344940f1a400b6e6231ce35171f614f26439e80f8c1465c5cc0c" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15c4c2c83f81532e5845a733998b6971faca23490340a418e9b72a3ec9de12ea" + +[[package]] +name = "anstyle-parse" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "938874ff5980b03a87c5524b3ae5b59cf99b1d6bc836848df7bc5ada9643c333" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca11d4be1bab0c8bc8734a9aa7bf4ee8316d462a08c6ac5052f888fef5b494b" +dependencies = [ + "windows-sys", +] + +[[package]] +name = "anstyle-wincon" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "58f54d10c6dfa51283a066ceab3ec1ab78d13fae00aa49243a45e4571fb79dfd" +dependencies = [ + "anstyle", + "windows-sys", +] + +[[package]] +name = "autocfg" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "clap" +version = "4.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d5f1946157a96594eb2d2c10eb7ad9a2b27518cb3000209dec700c35df9197d" +dependencies = [ + "clap_builder", + "clap_derive", + "once_cell", +] + +[[package]] +name = "clap_builder" +version = "4.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78116e32a042dd73c2901f0dc30790d20ff3447f3e3472fad359e8c3d282bcd6" +dependencies = [ + "anstream", + "anstyle", + "clap_lex", + "strsim", +] + +[[package]] +name = "clap_derive" +version = "4.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c9fd1a5729c4548118d7d70ff234a44868d00489a4b6597b0b020918a0e91a1a" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "clap_lex" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd7cc57abe963c6d3b9d8be5b06ba7c8957a930305ca90304f24ef040aa6f961" + +[[package]] +name = "colorchoice" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" + +[[package]] +name = "convert_case" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec182b0ca2f35d8fc196cf3404988fd8b8c739a4d270ff118a398feb0cbec1ca" +dependencies = [ + "unicode-segmentation", +] + +[[package]] +name = "equivalent" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88bffebc5d80432c9b140ee17875ff173a8ab62faad5b257da912bd2f6c1c0a1" + +[[package]] +name = "hashbrown" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2c6201b9ff9fd90a5a3bac2e56a830d0caa509576f0e503818ee82c181b3437a" + +[[package]] +name = "heck" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" + +[[package]] +name = "indexmap" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5477fe2230a79769d8dc68e0eabf5437907c0457a5614a9e8dddb67f65eb65d" +dependencies = [ + "equivalent", + "hashbrown", +] + +[[package]] +name = "libc" +version = "0.2.147" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4668fb0ea861c1df094127ac5f1da3409a82116a4ba74fca2e58ef927159bb3" + +[[package]] +name = "log" +version = "0.4.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b06a4cde4c0f271a446782e3eff8de789548ce57dbc8eca9292c27f4a42004b4" + +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + +[[package]] +name = "memoffset" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5de893c32cde5f383baa4c04c5d6dbdd735cfd4a794b0debdb2bb1b421da5ff4" +dependencies = [ + "autocfg", +] + +[[package]] +name = "nix" +version = "0.26.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfdda3d196821d6af13126e40375cdf7da646a96114af134d5f417a9a1dc8e1a" +dependencies = [ + "bitflags", + "cfg-if", + "libc", + "memoffset", + "static_assertions", +] + +[[package]] +name = "once_cell" +version = "1.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d" + +[[package]] +name = "proc-macro-crate" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f4c021e1093a56626774e81216a4ce732a735e5bad4868a03f3ed65ca0c3919" +dependencies = [ + "once_cell", + "toml_edit", +] + +[[package]] +name = "proc-macro2" +version = "1.0.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b368fba921b0dce7e60f5e04ec15e565b3303972b42bcfde1d0713b881959eb" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quick-xml" +version = "0.29.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "81b9228215d82c7b61490fec1de287136b5de6f5700f6e58ea9ad61a7964ca51" +dependencies = [ + "memchr", +] + +[[package]] +name = "quote" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b9ab9c7eadfd8df19006f1cf1a4aed13540ed5cbc047010ece5826e10825488" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "regex" +version = "1.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12de2eff854e5fa4b1295edd650e227e9d8fb0c9e90b12e7f36d6a6811791a29" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49530408a136e16e5b486e883fbb6ba058e8e4e8ae6621a77b048b314336e629" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.7.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dbb5fb1acd8a1a18b3dd5be62d25485eb770e05afb408a9627d14d451bae12da" + +[[package]] +name = "river-bsp-layout" +version = "1.1.1" +dependencies = [ + "clap", + "regex", + "river-layout-toolkit", +] + +[[package]] +name = "river-layout-toolkit" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7bd322da0212ac776c0096a3ff7727b4169eb4dac2dca21c6e12505b9dce8d3" +dependencies = [ + "log", + "thiserror", + "wayrs-client", +] + +[[package]] +name = "static_assertions" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" + +[[package]] +name = "strsim" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" + +[[package]] +name = "syn" +version = "2.0.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2efbeae7acf4eabd6bcdcbd11c92f45231ddda7539edc7806bd1a04a03b24616" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "thiserror" +version = "1.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "978c9a314bd8dc99be594bc3c175faaa9794be04a5a5e153caba6915336cebac" +dependencies = [ + "thiserror-impl", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9456a42c5b0d803c8cd86e73dd7cc9edd429499f37a3550d286d5e86720569f" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "toml_datetime" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7cda73e2f1397b1262d6dfdcef8aafae14d1de7748d66822d3bfeeb6d03e5e4b" + +[[package]] +name = "toml_edit" +version = "0.19.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "266f016b7f039eec8a1a80dfe6156b633d208b9fccca5e4db1d6775b0c4e34a7" +dependencies = [ + "indexmap", + "toml_datetime", + "winnow", +] + +[[package]] +name = "unicode-ident" +version = "1.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b15811caf2415fb889178633e7724bad2509101cde276048e013b9def5e51fa0" + +[[package]] +name = "unicode-segmentation" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1dd624098567895118886609431a7c3b8f516e41d30e0643f03d94592a147e36" + +[[package]] +name = "utf8parse" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" + +[[package]] +name = "wayrs-client" +version = "0.10.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b6f89c575e1d2c7e2a3dec9edb025fffdec377dbdc60942f90edb6cfc7ef715" +dependencies = [ + "nix", + "thiserror", + "wayrs-scanner", +] + +[[package]] +name = "wayrs-scanner" +version = "0.10.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8267a5e3ec9d13e8b4d24d0643aac9492faeac8769cdae71930998430e057a99" +dependencies = [ + "convert_case", + "proc-macro-crate", + "proc-macro2", + "quick-xml", + "quote", + "syn", +] + +[[package]] +name = "windows-sys" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +dependencies = [ + "windows-targets", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "winnow" +version = "0.4.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca0ace3845f0d96209f0375e6d367e3eb87eb65d27d445bdc9f1843a26f39448" +dependencies = [ + "memchr", +] diff --git a/packages/river-bsp-layout/Cargo.toml b/packages/river-bsp-layout/Cargo.toml new file mode 100644 index 0000000..b6250f0 --- /dev/null +++ b/packages/river-bsp-layout/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "river-bsp-layout" +version = "1.1.1" +edition = "2021" +author = "AJ Reifsnyder " +about = "Binary space partitioned layout for the tiling Wayland compositor River." +license = "GPL-3.0" +description = "Binary space partitioned layout for the tiling Wayland compositor River." +homepage = "https://github.com/areif-dev/river-bsp-layout" +repository = "https://github.com/areif-dev/river-bsp-layout" +readme = "README.md" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +clap = { version = "4.4", features = ["derive"] } +regex = "1.9" +river-layout-toolkit = "0.1" diff --git a/packages/river-bsp-layout/LICENSE b/packages/river-bsp-layout/LICENSE new file mode 100644 index 0000000..a9e237d --- /dev/null +++ b/packages/river-bsp-layout/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + River BSP Layout is a layout generator that tiles windows in a grid + Copyright (C) 2023 AJ Reifsnyder + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + River BSP Layout Copyright (C) 2023 AJ Reifsnyder + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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. But first, please read +. diff --git a/packages/river-bsp-layout/README.md b/packages/river-bsp-layout/README.md new file mode 100644 index 0000000..cc09a11 --- /dev/null +++ b/packages/river-bsp-layout/README.md @@ -0,0 +1,70 @@ +# river-bsp-layout + +Custom River layout manager that creates a Binary Space Partition / Grid layout using river-layout-toolkit + +3 Window Example: +``` ++----------------+----------------+ +| | | +| | | +| +----------------+ +| | | +| | | ++----------------+----------------+ +``` + +4 Window Example: +``` ++----------------+----------------+ +| | | +| | | ++----------------+----------------+ +| | | +| | | ++----------------+----------------+ +``` + +## Installing + +```bash +cargo install river-bsp-layout --locked +``` + +## Building + +* Make sure you have `cargo` installed. The recommended means of installation is with `rustup.sh` from https://www.rust-lang.org/tools/install +* Clone this repo with `git clone https://github.com/areif-dev/river-bsp-layout` +* Enter the cloned directory `cd river-bsp-layout` +* run `cargo build --release` +* Move the compiled binary from `target/release/river-bsp-layout` to any directory in your `$PATH` + * With `cargo` installed, one option would be to move the the binary to `$HOME/.cargo/bin` + +## CLI + +`river-bsp-layout` currently accepts two options: +* `--inner-gap` or `-i`: Number of pixels to place between each adjacent container + * Defaults to 5 +* `--outer-gap` or `-o`: Number of pixels to place between the edge of the display and the edge of each container + * Defaults to 5 + +## riverctl Commands + +`river-bsp-layout` supports two commands sent from `riverctl send-layout-cmd`: +* `riverctl send-layout-cmd bsp-layout "outer-gap #"` will change the outer gap to `#` if `#` is a positive integer +* `riverctl send-layout-cmd bsp-layout "inner-gap #"` will change the inner gap to `#` if `#` is a positive integer + +## Starting from River init + +Assuming you are using a default `bash` init script, replace the following lines at the end of the file + +```bash +riverctl default-layout rivertile +rivertile -view-padding 6 -outer-padding 6 & +``` + +with + +```bash +riverctl default-layout bsp-layout +river-bsp-layout --inner-gap 10 --outer-gap 10 & +``` diff --git a/packages/river-bsp-layout/default.nix b/packages/river-bsp-layout/default.nix new file mode 100644 index 0000000..d544087 --- /dev/null +++ b/packages/river-bsp-layout/default.nix @@ -0,0 +1,9 @@ +{ pkgs ? import { } }: +let manifest = (pkgs.lib.importTOML ./Cargo.toml).package; +in +pkgs.rustPlatform.buildRustPackage rec { + pname = manifest.name; + version = manifest.version; + cargoLock.lockFile = ./Cargo.lock; + src = pkgs.lib.cleanSource ./.; +} diff --git a/packages/river-bsp-layout/depends.md b/packages/river-bsp-layout/depends.md new file mode 100644 index 0000000..a833eb0 --- /dev/null +++ b/packages/river-bsp-layout/depends.md @@ -0,0 +1,75 @@ +The following open source libraries are used by River BSP Layout: + +- `clap` - https://github.com/clap-rs/clap + +Copyright (c) Individual contributors + +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. + +- `regex` - https://github.com/rust-lang/regex + +Copyright (c) 2014 The Rust Project Developers + +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. + +- `river-layout-toolkit` - https://github.com/MaxVerevkin/river-layout-toolkit + +MIT License + +Copyright (c) 2022 Max Verevkin + +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. diff --git a/packages/river-bsp-layout/flake.nix b/packages/river-bsp-layout/flake.nix new file mode 100644 index 0000000..93c28b8 --- /dev/null +++ b/packages/river-bsp-layout/flake.nix @@ -0,0 +1,20 @@ +# river-bsp-layout.url = "github:areif-dev/river-bsp-layout"; +{ + description = "river-bsp-layout"; + inputs = { + nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; + }; + outputs = { self, nixpkgs }: + let + supportedSystems = [ "x86_64-linux" ]; + forAllSystems = nixpkgs.lib.genAttrs supportedSystems; + pkgsFor = nixpkgs.legacyPackages; + in { + packages = forAllSystems (system: { + default = pkgsFor.${system}.callPackage ./default.nix { }; + }); + devShells = forAllSystems (system: { + default = pkgsFor.${system}.callPackage ./shell.nix { }; + }); + }; +} diff --git a/packages/river-bsp-layout/shell.nix b/packages/river-bsp-layout/shell.nix new file mode 100644 index 0000000..02d34b0 --- /dev/null +++ b/packages/river-bsp-layout/shell.nix @@ -0,0 +1,11 @@ +{ pkgs ? import { } }: +pkgs.mkShell { + # Get dependencies from the main package + inputsFrom = [ (pkgs.callPackage ./default.nix { }) ]; + # Additional tooling + buildInputs = with pkgs; [ + rust-analyzer # LSP Server + rustfmt # Formatter + clippy # Linter + ]; +} diff --git a/packages/river-bsp-layout/src/lib.rs b/packages/river-bsp-layout/src/lib.rs new file mode 100644 index 0000000..24eb95a --- /dev/null +++ b/packages/river-bsp-layout/src/lib.rs @@ -0,0 +1,561 @@ +use regex::Regex; +use river_layout_toolkit::{GeneratedLayout, Layout, Rectangle}; +use std::fmt::Display; + +/// Wrapper for errors relating to the creation or operation of a `BSPLayout` +#[non_exhaustive] +#[derive(Debug)] +pub enum BSPLayoutError { + + /// Encountered when a failure occurs in `user_cmd` + CmdError(String), +} + +impl Display for BSPLayoutError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{:?}", self) + } +} + +impl std::error::Error for BSPLayoutError {} + +/// Create a Binary Space Partitioned layout. Specifically, this layout recursively +/// divides the screen in half. The split will alternate between vertical and horizontal +/// based on which side of the container is longer. This will result in a grid like +/// layout with more-or-less equal sized windows even distributed across the screen +pub struct BSPLayout { + + /// Number of pixels to put between the edge of the display and each window + pub outer_gap: u32, + + /// Number of pixels to put between the inside edge of adjacent windows + pub inner_gap: u32, +} + +impl BSPLayout { + + /// Initialize a new instance of BSPLayout with given inner and outer gaps + /// + /// # Arguments + /// + /// * `outer_gap` - Number of pixels to put between the edge of the display and the outside + /// edge of the nearest windows + /// + /// * `inner_gap` - Number of pixels to put between the inside edge of adjacent windows + /// + /// # Returns + /// + /// A new `BSPLayout` + pub fn new(outer_gap: u32, inner_gap: u32) -> BSPLayout { + BSPLayout { + outer_gap, + inner_gap, + } + } + + /// Perform the recursive division by two to evenly divide the screen as best + /// as possible + /// + /// # Arguments + /// + /// * `origin_x` - The x position of the top left of the space to be divided + /// relative to the entire display. For example, if you are dividing the entire + /// display, then the top left corner is 0, 0. If you are dividing the right + /// half of a 1920x1080 monitor, then the top left corner would be at 960, 0 + /// + /// * `origin_y` - The y position of the top left of the space to be divided + /// relative to the entire display. For example, if you are dividing the entire + /// display, then the top left corner is 0, 0. If you are dividing the bottom + /// half of a 1920x1080 monitor, then the top left corner would be at 0, 540 + /// + /// * `canvas_width` - The width in pixels of the area being divided. If you + /// are dividing all of a 1920x1080 monitor, then the `canvas_width` would be 1920. + /// If you are dividing the right half of the monitor, then the width is 960. + /// + /// * `canvas_height` - The height in pixels of the area being divided. If you + /// are dividing all of a 1920x1080 monitor, then the height would be 1080. + /// If you are dividing the bottom half of the monitor, then the height is 540. + /// + /// * `view_count` - How many windows / containers / apps / division the function + /// needs to make in total. + /// + /// # Returns + /// + /// A `GeneratedLayout` with `view_count` cells evenly distributed across the screen + /// in a grid + fn handle_layout_helper( + &self, + origin_x: i32, + origin_y: i32, + canvas_width: u32, + canvas_height: u32, + view_count: u32, + ) -> GeneratedLayout { + let mut layout = GeneratedLayout { + layout_name: "bsp-layout".to_string(), + views: Vec::with_capacity(view_count as usize), + }; + + // Exit condition. When there is only one window left, it should take up the + // entire available canvas + if view_count == 1 { + layout.views.push(Rectangle { + x: origin_x, + y: origin_y, + width: canvas_width, + height: canvas_height, + }); + + return layout; + } + + let half_view_count = view_count / 2; + let views_remaining = view_count % 2; // In case there are odd number of views + + let h1_width: u32; + let h1_height: u32; + + let h2_width: u32; + let h2_height: u32; + let h2_x: i32; + let h2_y: i32; + + if canvas_width >= canvas_height { + /* Vertical Split */ + + // In case the width of the area is odd, add one extra pixel if needed + h1_width = + canvas_width / 2 + canvas_width % 2 - self.inner_gap / 2 - self.inner_gap % 2; + h1_height = canvas_height; + + h2_width = canvas_width / 2 - self.inner_gap / 2; + h2_height = canvas_height; + h2_x = h1_width as i32 + origin_x + self.inner_gap as i32; + h2_y = origin_y; + } else { + /* Horizontal Split */ + + h1_width = canvas_width; + h1_height = + canvas_height / 2 + canvas_height % 2 - self.inner_gap / 2 - self.inner_gap % 2; + + h2_width = canvas_width; + + // In case the width of the area is odd, add one extra pixel if needed + h2_height = canvas_height / 2 - self.inner_gap / 2; + h2_x = origin_x; + h2_y = h1_height as i32 + origin_y + self.inner_gap as i32; + } + + /* Recursively split the two halves of the window */ + let mut first_half = + self.handle_layout_helper(origin_x, origin_y, h1_width, h1_height, half_view_count); + + let mut sec_half = self.handle_layout_helper( + h2_x, + h2_y, + h2_width, + h2_height, + half_view_count + views_remaining, + ); + + layout.views.append(&mut first_half.views); + layout.views.append(&mut sec_half.views); + + layout + } +} + +impl Layout for BSPLayout { + type Error = BSPLayoutError; + + const NAMESPACE: &'static str = "bsp-layout"; + + /// Handle commands passed to the layout with `send-layout-cmd`. Currently supports + /// "outer-gap #" and "inner-gap #", which will set set the outer and inner gaps + /// of the window at runtime + /// + /// # Examples + /// + /// ``` + /// use river_bsp_layout::BSPLayout; + /// use river_layout_toolkit::Layout; + /// + /// // Initialize layout with 0 gaps + /// let mut bsp = BSPLayout::new(0, 0); + /// + /// // Set gap between windows and the monitor edge to be 5 pixels + /// let res = bsp.user_cmd("outer-gap 5".to_string(), None, "eDP-1").unwrap(); + /// assert_eq!(bsp.outer_gap, 5); + /// ``` + /// + /// # Errors + /// + /// Will return `BSPLayoutError::CmdError` if an unrecognized command is passed + /// or if an invalid argument is passed to a valid command. + fn user_cmd( + &mut self, + _cmd: String, + _tags: Option, + _output: &str, + ) -> Result<(), Self::Error> { + let outer_re = Regex::new(r"^outer-gap \d+$").unwrap(); + let inner_re = Regex::new(r"^inner-gap \d+$").unwrap(); + + if outer_re.is_match(&_cmd) { + let new_gap_str = match _cmd.split(" ").last() { + Some(s) => s, + None => { + return Err(BSPLayoutError::CmdError( + "outer-gap missing argument".to_string(), + )); + } + }; + let new_gap = match new_gap_str.parse::() { + Ok(i) => i, + Err(_) => { + return Err(BSPLayoutError::CmdError( + "Could not parse u32 from outer-gap argument".to_string(), + )); + } + }; + + self.outer_gap = new_gap; + } else if inner_re.is_match(&_cmd) { + let new_gap_str = match _cmd.split(" ").last() { + Some(s) => s, + None => { + return Err(BSPLayoutError::CmdError( + "inner-gap missing argument".to_string(), + )) + } + }; + let new_gap = match new_gap_str.parse::() { + Ok(i) => i, + Err(_) => { + return Err(BSPLayoutError::CmdError( + "Could not parse u32 from inner-gap argument".to_string(), + )) + } + }; + + self.inner_gap = new_gap; + } else { + return Err(BSPLayoutError::CmdError(format!( + "Command not recognized: {}", + _cmd + ))); + } + Ok(()) + } + + /// Create the geometry for the `BSPLayout` + /// + /// # Arguments + /// + /// * `view_count` - The number of views / windows / containers to divide the screen into + /// * `usable_width` - How many pixels wide the whole display is + /// * `usable_height` - How many pixels tall the whole display is + /// * `_tags` - Int representing which tags are currently active based on which + /// bit is toggled + /// * `_output` - The name of the output to generate the layout on + /// + /// # Examples + /// + /// ``` + /// use river_bsp_layout::BSPLayout; + /// use river_layout_toolkit::Layout; + /// + /// let mut bsp = BSPLayout::new(10, 10); + /// bsp.generate_layout(2, 1920, 1080, 0b000000001, "eDP-1").unwrap(); + /// ``` + fn generate_layout( + &mut self, + view_count: u32, + usable_width: u32, + usable_height: u32, + _tags: u32, + _output: &str, + ) -> Result { + let layout = self.handle_layout_helper( + self.outer_gap as i32, + self.outer_gap as i32, + usable_width - self.outer_gap * 2, + usable_height - self.outer_gap * 2, + view_count, + ); + Ok(layout) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_handle_layout_helper_one_container() { + let bsp = BSPLayout::new(0, 0); + let layout = bsp.handle_layout_helper(0, 0, 1920, 1080, 1); + + assert_eq!(layout.views.len(), 1); + let first_view = layout.views.get(0).unwrap(); + assert_eq!( + ( + first_view.x, + first_view.y, + first_view.width, + first_view.height + ), + (0, 0, 1920, 1080) + ); + } + + #[test] + fn test_handle_layout_helper_two_containers() { + let bsp = BSPLayout::new(0, 0); + let layout = bsp.handle_layout_helper(0, 0, 1920, 1080, 2); + + assert_eq!(layout.views.len(), 2); + let first_view = layout.views.get(0).unwrap(); + assert_eq!( + ( + first_view.x, + first_view.y, + first_view.width, + first_view.height + ), + (0, 0, 960, 1080) + ); + + let second_view = layout.views.get(1).unwrap(); + assert_eq!( + ( + second_view.x, + second_view.y, + second_view.width, + second_view.height + ), + (960, 0, 960, 1080) + ); + } + + #[test] + fn test_handle_layout_helper_three_containers() { + let bsp = BSPLayout::new(0, 0); + let layout = bsp.handle_layout_helper(0, 0, 1920, 1080, 3); + + assert_eq!(layout.views.len(), 3); + let first_view = layout.views.get(0).unwrap(); + assert_eq!( + ( + first_view.x, + first_view.y, + first_view.width, + first_view.height + ), + (0, 0, 960, 1080) + ); + + let second_view = layout.views.get(1).unwrap(); + assert_eq!( + ( + second_view.x, + second_view.y, + second_view.width, + second_view.height + ), + (960, 0, 960, 540) + ); + + let third_view = layout.views.get(2).unwrap(); + assert_eq!( + ( + third_view.x, + third_view.y, + third_view.width, + third_view.height + ), + (960, 540, 960, 540) + ); + } + + #[test] + fn test_handle_layout_helper_four_containers() { + let bsp = BSPLayout::new(0, 0); + let layout = bsp.handle_layout_helper(0, 0, 1920, 1080, 4); + + assert_eq!(layout.views.len(), 4); + let first_view = layout.views.get(0).unwrap(); + assert_eq!( + ( + first_view.x, + first_view.y, + first_view.width, + first_view.height + ), + (0, 0, 960, 540) + ); + + let second_view = layout.views.get(1).unwrap(); + assert_eq!( + ( + second_view.x, + second_view.y, + second_view.width, + second_view.height + ), + (0, 540, 960, 540) + ); + + let third_view = layout.views.get(2).unwrap(); + assert_eq!( + ( + third_view.x, + third_view.y, + third_view.width, + third_view.height + ), + (960, 0, 960, 540) + ); + + let fourth_view = layout.views.get(3).unwrap(); + assert_eq!( + ( + fourth_view.x, + fourth_view.y, + fourth_view.width, + fourth_view.height + ), + (960, 540, 960, 540) + ); + } + + #[test] + fn test_generate_layout_no_gaps() { + let mut bsp = BSPLayout::new(0, 0); + let layout = bsp.generate_layout(4, 1920, 1080, 1, "eDP-1").unwrap(); + + assert_eq!(layout.views.len(), 4); + let first_view = layout.views.get(0).unwrap(); + assert_eq!( + ( + first_view.x, + first_view.y, + first_view.width, + first_view.height + ), + (0, 0, 960, 540) + ); + + let second_view = layout.views.get(1).unwrap(); + assert_eq!( + ( + second_view.x, + second_view.y, + second_view.width, + second_view.height + ), + (0, 540, 960, 540) + ); + + let third_view = layout.views.get(2).unwrap(); + assert_eq!( + ( + third_view.x, + third_view.y, + third_view.width, + third_view.height + ), + (960, 0, 960, 540) + ); + + let fourth_view = layout.views.get(3).unwrap(); + assert_eq!( + ( + fourth_view.x, + fourth_view.y, + fourth_view.width, + fourth_view.height + ), + (960, 540, 960, 540) + ); + } + + #[test] + fn test_generate_layout_with_gaps() { + let mut bsp = BSPLayout::new(10, 20); + let layout = bsp.generate_layout(4, 1920, 1080, 1, "eDP-1").unwrap(); + + assert_eq!(layout.views.len(), 4); + let first_view = layout.views.get(0).unwrap(); + assert_eq!( + ( + first_view.x, + first_view.y, + first_view.width, + first_view.height + ), + (10, 10, 940, 520) + ); + + let second_view = layout.views.get(1).unwrap(); + assert_eq!( + ( + second_view.x, + second_view.y, + second_view.width, + second_view.height + ), + (10, 550, 940, 520) + ); + + let third_view = layout.views.get(2).unwrap(); + assert_eq!( + ( + third_view.x, + third_view.y, + third_view.width, + third_view.height + ), + (970, 10, 940, 520) + ); + + let fourth_view = layout.views.get(3).unwrap(); + assert_eq!( + ( + fourth_view.x, + fourth_view.y, + fourth_view.width, + fourth_view.height + ), + (970, 550, 940, 520) + ); + } + + #[test] + fn test_send_outer_gaps() { + let mut bsp = BSPLayout::new(0, 0); + bsp.user_cmd("outer-gap 5".to_string(), None, "eDP-1") + .unwrap(); + + assert_eq!(bsp.inner_gap, 0); + assert_eq!(bsp.outer_gap, 5); + } + + #[test] + fn test_send_inner_gaps() { + let mut bsp = BSPLayout::new(0, 0); + bsp.user_cmd("inner-gap 5".to_string(), None, "eDP-1") + .unwrap(); + + assert_eq!(bsp.inner_gap, 5); + assert_eq!(bsp.outer_gap, 0); + } + + #[test] + fn test_invalid_user_command() { + let mut bsp = BSPLayout::new(0, 0); + let res = bsp.user_cmd("foo-bar 5678".to_string(), None, "eDP-1"); + assert!(res.is_err()); + } +} diff --git a/packages/river-bsp-layout/src/main.rs b/packages/river-bsp-layout/src/main.rs new file mode 100644 index 0000000..9a6f60f --- /dev/null +++ b/packages/river-bsp-layout/src/main.rs @@ -0,0 +1,24 @@ +use clap::Parser; +use river_bsp_layout::BSPLayout; +use river_layout_toolkit::run; + +/// Layout manager for Wayland tiling compositor River. Creates a grid like Binary Space +/// Partitioned layout where each window is made as equal in size as possible while still +/// occupying all available space in the display +#[derive(Parser, Debug)] +#[command(author, version, about, long_about = None)] +struct Cli { + /// The size of the gap between adjacent windows. In pixels + #[arg(short, long, default_value_t = 5)] + inner_gap: u32, + + /// The size of the gap between windows and the edge of the screen. In pixels + #[arg(short, long, default_value_t = 5)] + outer_gap: u32, +} + +fn main() { + let cli = Cli::parse(); + let layout = BSPLayout::new(cli.outer_gap, cli.inner_gap); + run(layout).unwrap(); +}