From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id 6KyvLnDE82YEPgEAqHPOHw:P1 (envelope-from ) for ; Wed, 25 Sep 2024 08:06:08 +0000 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0.migadu.com with LMTPS id 6KyvLnDE82YEPgEAqHPOHw (envelope-from ) for ; Wed, 25 Sep 2024 10:06:08 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=debbugs.gnu.org header.s=debbugs-gnu-org header.b=c4ykPhhf; dkim=fail ("headers rsa verify failed") header.d=nanein.fr header.s=mail header.b="Bp27gp/2"; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gnu.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1727251568; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=P0uimh20OQOrL53XJSTysjmqEpPIVQJTbZvlPLgudBs=; b=DZQFVcTEGxbO0Wj6Q+DfN4xqTltDaHYNP8ZFkInB3kR33+vxLPXfvwsux0nUFVFg5Vuc4n NrjKYcQi1XS3NtV8kGtwZezem8dmbHytqVGtREcCLNkIBDxCLqCiGgwbTajegrOUnkJLoQ P316FCmH3XHJShZzwUWQFABwBkCD9hNiEX7sxZCGTkX8wASqaZHghjCRN5GnmW4hk7JFVX 8D19NvYMZkbHkoTSKJ6WyVeZxVPRWmsvx9nqep3ZZuvbyRf0XuO2aS990cEryRM44NilB4 Di6v7D1VrCU6XMP5gR5noKf1gxrPSjr8qgJIx5i1DNvLI9PruUh6aWK9X98QCA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1727251568; a=rsa-sha256; cv=none; b=V/x1JW8GXFnd3RGHdRjz5WWoIyAR5ieBYgk9cxS+NNwLfSYFP7C2HsY4EkdUfL3PBz4qgY K5B1T9+v7dAI1ebqoZMBX+sk3bIyDYkO+NXKyyr86h8xDotD2ioo5yqJOzGUgtcByYnRJK HWV3fPEIt0XpgSsOJNjM3XhJsCEvFyfAq387CRqX/nk5M0b7lymoWc13J71HrhOqiqmrDb VknsBlcIs1zdy3m7jN5O7nqDtqkmcLunIyVvg5CEDdYxzkhQ9SUbIANFflv7VRiTDkfSrB yp40wa7iLHVnWm4MC9nDwNkFRY1GZMD+7K/rRe2+ZRNK5QEEGqlC17HS3moQ5w== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=debbugs.gnu.org header.s=debbugs-gnu-org header.b=c4ykPhhf; dkim=fail ("headers rsa verify failed") header.d=nanein.fr header.s=mail header.b="Bp27gp/2"; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gnu.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 6E5AA1B671 for ; Wed, 25 Sep 2024 10:06:08 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1stN1t-0006TM-Ql; Wed, 25 Sep 2024 04:05:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1stN1l-0006LD-2P for guix-patches@gnu.org; Wed, 25 Sep 2024 04:05:37 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1stN1k-0004k5-92 for guix-patches@gnu.org; Wed, 25 Sep 2024 04:05:36 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:From:To:In-Reply-To:References:Subject; bh=TjZXywwLOeEbOa/XdF+Ww6eW9feJDpno/EizdvTdkkE=; b=c4ykPhhfEmhOGHjA0RvzaK98rOZIz4qJQDA0/5ZJzzTf2pZeG8Aq7hQqxCDM2sWm05NpVBmCb05wrZmangYiMg5o8JHQqL5Gnjxiue42y12CVIuifgPFWiA1mws4J6YvjZ2mGcb4EOALIAjTIT09OsHJb2PGi64QcpNwXoFiDeSGHsR3ZaizhV7+BPUKui0TuPC0sQSf5JN3BuwFAS1Ip+8QPurg72gEMlbD18mokVMFeNX8o6atNj29pMkTMka1q130HSR0WETpp++eapY/1fTeXVapFkeA3uVQ2QLkw5Z1YnOMjU0HiP8yIP8sPCt73JXE5t+qYFalzh+SVhygHw==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1stN29-0003zH-N1 for guix-patches@gnu.org; Wed, 25 Sep 2024 04:06:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#72714] [PATCH v6] home: services: Add 'home-sway-service-type'. References: <1e82e473639f21a2950a0827f156437ef1bc9c48.1724081442.git.ds-ac@nanein.fr> In-Reply-To: <1e82e473639f21a2950a0827f156437ef1bc9c48.1724081442.git.ds-ac@nanein.fr> Resent-From: Arnaud Daby-Seesaram Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 25 Sep 2024 08:06:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 72714 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 72714@debbugs.gnu.org Cc: Arnaud Daby-Seesaram Received: via spool by 72714-submit@debbugs.gnu.org id=B72714.172725153615293 (code B ref 72714); Wed, 25 Sep 2024 08:06:01 +0000 Received: (at 72714) by debbugs.gnu.org; 25 Sep 2024 08:05:36 +0000 Received: from localhost ([127.0.0.1]:44782 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1stN1i-0003vf-8y for submit@debbugs.gnu.org; Wed, 25 Sep 2024 04:05:36 -0400 Received: from nanein.fr ([185.230.78.41]:37864) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1stN1e-0003qN-Cz for 72714@debbugs.gnu.org; Wed, 25 Sep 2024 04:05:33 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nanein.fr; s=mail; t=1727251498; bh=dtLG4V4bjVQj0T67MJc7Uyx1wba8ToyRJykMWjcLUc4=; h=From:To:Cc:Subject:Date:From; b=Bp27gp/2GtXgQYmNYwEChVr5H97U4fDfjQWbreiPOEn2nKP2K/xnnnkvPVc0kOrCI hfYI6dSEzDFeDuq5wgn+feESe7+mR0Crs4wqtb1/MoIqFgPI4h/C83AwmiuI8MPfn9 EcS6ay42A11UI/BEGvHM78PWsOKiF62HByOMFpPKMvpBwo2UZt0R0eJG5n5EqiGk+Y Xgkn0UgC9T5VKFzOPHixDLxwZaDWycbGBHVHe4X1uRAzxWTNYk1FSHgFhMuWfbwWTF KD1QYbA5BdmEDsZDCop3glWwDqRGNUYQ37UmJYgCSweRH+nrEEVzZitdhB4MI5MrFv h50eBhaI3H5if/Sz2WVxPDvjiLfJGP26ZoN0e5dyUXxxTMVAxtcc+QS+IYRzAVODFe aLdId80CTPWkXpxkN8VTlkJeipExrf/VhS3I86wIILKPJhQ2pe3VLQwvPrYN4JXk68 wnUbzcGTIeoGyaZkxpbMVdpKmhI0hThVkeb/TMLYXnD5bAHhEFGaWfiNSMgfF0c/Kn POSLvN6X+hjE+N5Qetk93V41BP/+pWk5l/T5dT/YqkL3bkf3zpz0T1PGikPy2bDrW3 vOdmKQ1Rxp8YNoUv+mxfTe/d7Dyo7nxyrJTaw7EtnANY5K85TVvR6Ex/QXxJo0fOTp CLKdNDM8kPAeHGtHwXsA4NYk= Received: from arnaudGuixPortable.eduroam.net.au.dk (eduroam09.au.dk [185.45.22.146]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by nanein.fr (Postfix) with ESMTPSA id 57567140215; Wed, 25 Sep 2024 10:04:58 +0200 (CEST) Date: Wed, 25 Sep 2024 10:00:43 +0200 Message-ID: <20240925080442.13752-1-ds-ac@nanein.fr> X-Mailer: git-send-email 2.46.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-to: Arnaud Daby-Seesaram X-ACL-Warn: , Arnaud Daby-Seesaram via Guix-patches From: Arnaud Daby-Seesaram via Guix-patches via Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -7.02 X-Migadu-Queue-Id: 6E5AA1B671 X-Spam-Score: -7.02 X-TUID: PVLgRSyBHOGu * gnu/home/services/sway.scm: New file. (home-sway-service-type): New variable. (sway-configuration->file): New procedure. (sway-configuration): New configuration record. (sway-bar): New configuration record. (sway-output): New configuration record. (sway-input): New configuration record. (point): New configuration record. (sway-color): New configuration record. (sway-border-color): New configuration record. (sway-mode): New configuration record. (flatten): New procedure. * gnu/local.mk: Add gnu/home/services/sway.scm. * doc/guix.texi (Sway window manager): New node to document the above changes. --- I only send this version of the patch to provide the latest version of my code. I have checked that a few produced configuration files were valid sway files (with "sway -c"), but have not yet performed further testing on this version. Note: I have not proof-read the documentation; it might be a little behind on the code or contain misspellings. doc/guix.texi | 361 ++++++++++++++++++ gnu/home/services/sway.scm | 755 +++++++++++++++++++++++++++++++++++++ gnu/local.mk | 1 + 3 files changed, 1117 insertions(+) create mode 100644 gnu/home/services/sway.scm diff --git a/doc/guix.texi b/doc/guix.texi index 52e36e4354..dc7ab5884f 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -130,6 +130,7 @@ Copyright @copyright{} 2024 Richard Sent@* Copyright @copyright{} 2024 Dariqq@* Copyright @copyright{} 2024 Denis 'GNUtoo' Carikli@* Copyright @copyright{} 2024 Fabio Natali@* +Copyright @copyright{} 2024 Arnaud Daby-Seesaram@* Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -460,6 +461,7 @@ Home Services * Mail: Mail Home Services. Services for managing mail. * Messaging: Messaging Home Services. Services for managing messaging. * Media: Media Home Services. Services for managing media. +* Sway: Sway window manager. Setting up the Sway configuration. * Networking: Networking Home Services. Networking services. * Miscellaneous: Miscellaneous Home Services. More services. @@ -45196,6 +45198,7 @@ services)}. * Mail: Mail Home Services. Services for managing mail. * Messaging: Messaging Home Services. Services for managing messaging. * Media: Media Home Services. Services for managing media. +* Sway: Sway window manager. Setting up the Sway configuration. * Networking: Networking Home Services. Networking services. * Miscellaneous: Miscellaneous Home Services. More services. @end menu @@ -47110,6 +47113,364 @@ kodi} for more information. @end table @end deftp +@node Sway window manager +@subsection Sway window manager + +@cindex sway, Home Service +@cindex sway, configuration +The @code{(gnu home services sway)} module provides +@code{home-sway-service-type}, a home service to configure sway in a +declarative way. + +@quotation Note +This home service only sets up the configuration file and profile +packages for sway. It does @i{not} start sway in any way. If you want +to do so, you might be interested in using +@code{greetd-wlgreet-sway-session} instead. + +The function @code{sway-configuration->file} defined below can be used +to provide the value for the @emph{optional} @code{sway-configuration} +field of @code{greetd-wlgreet-sway-session}. +@end quotation + +@defvar sway-configuration->file +This function takes a @code{sway-configuration} record (defined below), +and returns a file-like object represented the serialized configuration. +@end defvar + +@defvar home-sway-service-type +This is a home service type to set up Sway. It takes care of: +@itemize +@item +providing a @file{~/.config/sway/config} file, +@item +adding sway-related packages to your profile. +@end itemize + +Here is an example of a service and its configuration that you could add +to the @code{services} field of your @code{home-environment}: + +@lisp +(service home-sway-service-type + (sway-configuration + (gestures + '((swipe:3:down . "move to scratchpad") + (swipe:3:up . "scratchpad show"))) + (outputs + (list (sway-output + (identifier '*) + (bg (file-append sway + "\ +/share/backgrounds/sway/Sway_Wallpaper_Blue_1920x1080.png"))))))) +@end lisp + +The above example describes a sway configuration in which +@itemize +@item +all monitors use a particular wallpaper whose @file{.png} is provided by +the @code{sway} package; +@item +swiping down (resp.@: up) with three fingers moves the active window to +the scratchpad (resp.@: shows/hides the scratchpad). +@end itemize +@end defvar + +@deftp {Data Type} sway-configuration +This configuration record describes the sway configuration +(see@ @cite{sway(5)}). Available fields are: + +@table @asis +@item @code{variables} (default: @code{%sway-default-variables}) +The value of this field is an association list in which keys are symbols +and values are strings or G-expressions (@pxref{G-Expressions}). + +Example: @code{'(mod . "Mod4")}. + +@item @code{keybindings} (default: @code{%sway-default-keybindings}) +This field describes keybindings for the @emph{default} mode. As above, +the value is an association list: keys are symbols and values are either +strings, G-expressions or file-append objects. + +Examples using: +@itemize +@item +a string: @code{'($mod+Return . "exec $term")} +@item +a G-exp: @code{`($mod+t . ,#~(string-append #$st "/bin/st"))} +@item +a file-append: @code{`($mod+t . ,(file-append st "/bin/st"))} +@end itemize + +@item @code{gestures} (default: @code{%sway-default-gestures}) +Similar to the previous field, but for finger-gestures. + +The following snippet allows to navigate through workspaces by swiping +right and left with three fingers: +@lisp +'((swipe:3:right . "workspace next_on_output") + (swipe:3:left . "workspace prev_on_output")) +@end lisp + +@item @code{packages} (default: @code{%sway-default-packages}) +This field describes a list of packages to add to the user profile. + +@item @code{inputs} (default: @code{'()}) +List of @code{sway-input} configuration records. + +@item @code{outputs} (default: @code{'()}) +List of @code{sway-output} configuration records. + +@item @code{bar} (optional) +Optional @code{sway-bar} configuration record to declare the sway-bar +configuration. + +@item @code{modes} (default: @code{'()}) +Optional list of @code{sway-mode} records (described below). + +@item @code{always-execs} (default: @code{'()}) +Programs to execute at startup time @i{and} after every configuration +reload. The value of this field is a list of strings or G-expressions. + +@item @code{execs} (default: @code{%sway-default-execs}) +Programs to execute at startup time. The value of this field is a list +of strings or G-expressions. + +The default value, @code{%sway-default-execs}, executes @code{swayidle} +in order to lock the screen after 5@ minutes of inactivity (displaying a +background distributed with Sway) and turn of the screen after +10@ minutes of inactivity. + +@item @code{extra-content} (default: @code{'()}) +Lines to add to the configuration file. The value of this field is a +list of strings or G-expressions. +@end table +@end deftp + +@deftp {Data Type} sway-input +@code{sway-input} records describe input blocks (see@ +@cite{sway-input(5)}). For example, the following snippet makes all +keyboards use a french layout, in which @kbd{capslock} has been remaped +to @kbd{ctrl}: +@lisp +(sway-input (identifier "type:keyboard") + (xkb-layout "fr") + (xkb-options '("ctrl:nocaps"))) +@end lisp + +Available fields for @code{sway-input} configuration records are: + +@table @asis +@item @code{identifier} (default: @code{'*}) +Identifier of the input. The field accepts symbols and strings. If a +string is used, it will be quoted in the generated configuration file. + +@item @code{xkb-layout} (optional) +Keyboard specific option. String providing a comma-separated keyboard +layout(s) to use. + +@item @code{xkb-model} (optional) +Keyboard specific option. String providing the keyboard model. + +@item @code{xkb-options} (optional) +Keyboard specific option. List of strings specifying additional xkb +options for the keyboard. + +@item @code{xkb-variant} (optional) +Keyboard specific option. String specifying the variant of the layout. + +@item @code{extra-content} (default: @code{'()}) +Lines to add to the input block. The value of this field is a list of +strings. +@end table +@end deftp + +@deftp {Data Type} sway-output +@code{sway-output} records describe sway outputs +(see@ @cite{sway-output(5)}). Available fields are: + +@table @asis +@item @code{identifier} (default: @code{'*}) +Identifier of the monitor. If the +@code{identifier} is a symbol, it is inserted as is; if it is a string, +it will be quoted in the configuration file. + +@item @code{resolution} (optional) +This string defines the resolution of the monitor. + +@item @code{position} (optional) +The (optional) value of this field must be a @code{point}. +Example: +@lisp +(position + (point (x 1920) + (y 0))) +@end lisp + +@item @code{bg} (optional) +This field accepts a file-like value representing the wallpaper to use +on this monitor. It will be used with the @code{fill} option. + +@quotation Note +If you have @code{librsvg} in your profile, it is possible to specify +the path to an SVG file. +@end quotation + +@item @code{extra-content} (default: @code{'()}) +List defining additional lines to add to the output configuration block. +Elements of the list must be either strings or G-expressions. +@end table +@end deftp + +@deftp {Data Type} sway-border-color + +@table @code +@item border +Color of the border. +@item background +Color of the background. +@item text +Color of the text. +@end table +@end deftp + +@deftp {Data Type} sway-color +@table @asis +@item @code{background} (optional string) +Background color of the bar. + +@item @code{statusline} (optional string) +Text color of the status line. + +@item @code{focused-background} (optional string) +Background color of the bar on the currently focused monitor. + +@item @code{focused-statusline} (optional string) +Text color of the statusline on the currently focused monitor. + +@item @code{focused-workspace} (optional @code{sway-border-color}) +Color scheme for focused workspaces. + +@item @code{active-workspace} (optional @code{sway-border-color}) +Colour scheme for active workspaces. + +@item @code{inactive-workspace} (optional @code{sway-border-color}) +Colour scheme for inactive workspaces. + +@item @code{urgent-workspace} (optional @code{sway-border-color}) +Colour scheme for workspaces containing ``urgent'' windows. + +@item @code{binding-mode} (optional @code{sway-border-color}) +Colour scheme for the binding mode indicator. +@end table +@end deftp + +@deftp {Data Type} sway-bar +Describes the Sway bar (see@ @cite{sway-bar(5)}). + +@table @asis +@item @code{identifier} (default: @code{'bar0}) +Identifier of the bar. The value must be a symbol. + +@item @code{position} (optional) +Specify the position of the bar. Accepted values are @code{'top} or +@code{'bottom}. + +@item @code{hidden-state} (optional) +Specify the apparence of the bar when it is hidden. Accepted values are +@code{'hide} or @code{show}. + +@item @code{binding-mode-indicator} (optional) +Boolean enabling or disabling the binding mode indicator. + +@item @code{colors} (optional) +An optional @code{sway-color} configuration record. + +@item @code{status-command} (default: @code{%sway-status-command}) +This field accept strings, G-expressions and executable file-like +values. The default value is a command (string) that prints the date +and time every second. + +Each line printed on @code{stdout} by this command (or script) will be +displayed on the status area of the bar. + +Below are a few examples using: +@itemize +@item +a string: @code{"while date +'%Y-%m-%d %X'; do sleep 1; done"}, +@item +a G-exp: +@lisp +#~(string-append "while " + #$coreutils "/bin/date" + " +'%Y-%m-%d %X'; do sleep 1; done") +@end lisp +@item +an executable file: +@lisp +(program-file + "sway-bar-status" + (with-imported-modules + (source-module-closure + '((ice-9 format) (srfi srfi-19))) + #~(begin + (use-modules (ice-9 format) + (srfi srfi-19)) + (let loop () + (let* ((date (date->string + (current-date) + "~d/~m/~Y (~a) ~H:~M:~S"))) + (format #t "~a~%~!" date) + (sleep 1) + (loop)))))) +@end lisp +@end itemize + +@item @code{mouse-bindings} (default: @code{'()}) +This field accepts an associative list. Keys are integers describing +mouse events. Values can be either strings, G-expressions or +file-append objects. + +The module @code{(gnu home services sway)} exports constants +@code{%ev-code-mouse-left}, @code{%ev-code-mouse-right} and +@code{%ev-code-mouse-scroll-click} whose values are integers +corresponding to left, right and scroll click respectively. For +example, with the @code{`((,%ev-code-mouse-left . ,(file-append st +"/bin/st")))}, left clicks in the status bar open the @code{st} +terminal. +@end table +@end deftp + +@deftp {Data Type} sway-mode +Describes a Sway mode. For example, the following snippet defines a +mockup of the resize mode of the default Sway configuration: +@example +(sway-mode + (mode-name "resize") + (keybindings + '(($left . "resize shrink width 10px") + ($right . "resize grow width 10px") + ($down . "resize grow height 10px") + ($up . "resize shrink height 10px") + (Return . "mode \"default\"") + (Escape . "mode \"default\"")))) +@end example + +@table @asis +@item @code{mode-name} (default: @code{"default"}) +Name of the mode. This field accepts strings. + +@item @code{keybindings} (default: @code{'()}) +This field describes keybindings. The value is an association list: +keys are symbols and values are either strings or G-expressions, as +above. + +@item @code{mouse-bindings} (default: @code{'()}) +Ditto, but keys are mouse events (integers). Constants +@code{%ev-code-mouse-*} described above can be used as helpers to define +mouse bindings. +@end table +@end deftp + @node Networking Home Services @subsection Networking Home Services diff --git a/gnu/home/services/sway.scm b/gnu/home/services/sway.scm new file mode 100644 index 0000000000..6e55fda5fc --- /dev/null +++ b/gnu/home/services/sway.scm @@ -0,0 +1,755 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2024 Arnaud Daby-Seesaram +;;; +;;; This file is part of GNU Guix. +;;; +;;; GNU Guix 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. +;;; +;;; GNU Guix 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 GNU Guix. If not, see . + +(define-module (gnu home services sway) + #:use-module (guix modules) + #:use-module (guix gexp) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-26) + #:use-module (ice-9 popen) + #:use-module (ice-9 format) + #:use-module (ice-9 match) + #:use-module (guix packages) + #:use-module (gnu services configuration) + #:use-module (gnu home services) + #:use-module (gnu packages freedesktop) + #:use-module (gnu packages xdisorg) + #:use-module (gnu packages image) + #:use-module (gnu packages gnome) + #:use-module (gnu packages wm) + #:use-module (gnu packages emacs) + #:use-module (gnu packages linux) + #:use-module (gnu packages base) + #:use-module (gnu packages suckless) + #:use-module (gnu packages glib) + #:export (;; Event codes + %ev-code-mouse-left + %ev-code-mouse-right + %ev-code-mouse-scroll-click + + ;; Configuration records. + sway-configuration + sway-bar + sway-output + sway-input + point + sway-color + sway-border-color + home-sway-service-type + sway-configuration->file + sway-mode + + ;; Default values. + %sway-default-variables + %sway-default-gestures + %sway-default-keybindings + %sway-default-status-command + %sway-default-execs + %sway-default-packages)) + +;; Helper function. +(define (flatten l) + (let loop ((lst (reverse l)) (acc '())) + (match lst + (() acc) + ((head . tail) + (loop tail (append head acc)))))) + + +;;; +;;; Default settings and useful constants. +;;; + +(define %ev-code-mouse-left 272) +(define %ev-code-mouse-right 273) +(define %ev-code-mouse-scroll-click 274) + +;; TODO: reduce this list to a minimal, and make sure that sway behaves well. +(define %sway-default-packages + (list sway swaybg)) + +;; TODO: Update default values to match current default configuration files of +;; sway. +(define %sway-default-variables + `((mod . "Mod4") + (left . "h") + (down . "j") + (up . "k") + (right . "l") + (term . ,(file-append st "/bin/st")) + (menu . ,#~(string-append + #$dmenu "/bin/dmenu_path | " + #$wmenu "/bin/wmenu | " + #$findutils "/bin/xargs " + #$sway "/bin/swaymsg exec --")))) + +(define %sway-default-gestures + '((swipe:3:right . "workspace next_on_output") + (swipe:3:left . "workspace prev_on_output") + (swipe:3:down . "move to scratchpad") + (swipe:3:up . "scratchpad show"))) + +(define %sway-default-keybindings + `(($mod+Return . "exec $term") + ($mod+Shift+q . "kill") + ($mod+d . "exec $menu") + ($mod+Shift+c . "reload") + ($mod+Shift+e + . ,#~(string-append + "exec " #$sway "/bin/swaynag -t warning -m 'You pressed the exit " + "shortcut. Do you really want to exit sway? This will end your " + "Wayland session.' -B 'Yes, exit sway' '" + #$sway "/bin/swaymsg exit'")) + ($mod+$left . "focus left") + ($mod+$down . "focus down") + ($mod+$up . "focus up") + ($mod+$right . "focus right") + ($mod+Left . "focus left") + ($mod+Down . "focus down") + ($mod+Up . "focus up") + ($mod+Right . "focus right") + ($mod+Shift+$left . "move left") + ($mod+Shift+$down . "move down") + ($mod+Shift+$up . "move up") + ($mod+Shift+$right . "move right") + ($mod+Shift+Left . "move left") + ($mod+Shift+Down . "move down") + ($mod+Shift+Up . "move up") + ($mod+Shift+Right . "move right") + ($mod+1 . "workspace number 1") + ($mod+2 . "workspace number 2") + ($mod+3 . "workspace number 3") + ($mod+4 . "workspace number 4") + ($mod+5 . "workspace number 5") + ($mod+6 . "workspace number 6") + ($mod+7 . "workspace number 7") + ($mod+8 . "workspace number 8") + ($mod+9 . "workspace number 9") + ($mod+0 . "workspace number 10") + ($mod+Shift+1 . "move container to workspace number 1") + ($mod+Shift+2 . "move container to workspace number 2") + ($mod+Shift+3 . "move container to workspace number 3") + ($mod+Shift+4 . "move container to workspace number 4") + ($mod+Shift+5 . "move container to workspace number 5") + ($mod+Shift+6 . "move container to workspace number 6") + ($mod+Shift+7 . "move container to workspace number 7") + ($mod+Shift+8 . "move container to workspace number 8") + ($mod+Shift+9 . "move container to workspace number 9") + ($mod+Shift+0 . "move container to workspace number 10") + ($mod+b . "splith") + ($mod+v . "splitv") + ($mod+s . "layout stacking") + ($mod+w . "layout tabbed") + ($mod+e . "layout toggle split") + ($mod+f . "fullscreen") + ($mod+Shift+space . "floating toggle") + ($mod+space . "focus mode_toggle") + ($mod+a . "focus parent") + ($mod+Shift+minus . "move scratchpad") + ($mod+minus . "scratchpad show") + ($mod+r . "mode \"resize\""))) + +(define %sway-default-status-command + "while date +'%Y-%m-%d %X'; do sleep 1; done") + +(define %sway-default-execs + (list + #~(string-append + #$swayidle "/bin/swayidle -w \\\n" + ;; 300: lock screen. + " timeout 300 '" #$swaylock "/bin/swaylock " + "--indicator-radius 75 " + "-i " #$sway "/share/backgrounds/sway/Sway_Wallpaper_Blue_1920x1080.png" + " -f -c 000000' \\\n" + ;; 600: lock + screen off. + " timeout 600 '" #$sway "/bin/swaymsg \"output * power off\"' \\\n" + ;; Resume + sleep. + " resume '" #$sway "/bin/swaymsg \"output * power on\"' \\\n" + " before-sleep '" #$swaylock "/bin/swaylock -f -c 000000'"))) + + +;;; +;;; Definition of configurations. +;;; + +(define (string-ish? s) + (or (gexp? s) + (file-append? s) + (string? s))) + +(define (list-of-string-ish? lst) + (every string-ish? lst)) + +(define (list-of-packages? lst) + (every package? lst)) + +(define (bar-position? p) + (member p '(top bottom))) + +(define (hidden-state? st) + (member st '(hide show))) + +(define (string-or-symbol? s) + (or (string? s) + (symbol? s))) + +(define (strings? lst) + (every string? lst)) + +(define (make-alist-predicate key? val?) + (lambda (lst) + (every + (lambda (item) + (match item + ((k . v) + (and (key? k) + (val? v))) + (_ #f))) + lst))) + +(define bindings? + (make-alist-predicate symbol? string-ish?)) + +(define mouse-bindings? + (make-alist-predicate integer? string-ish?)) + +(define (variables? lst) + (make-alist-predicate symbol? string-ish?)) + +(define-maybe string (no-serialization)) +(define-maybe strings (no-serialization)) + +(define-configuration/no-serialization sway-input + (identifier + (string-or-symbol '*) + "Identifier of the input.") + (xkb-layout + maybe-string + "Keyboard layout.") + (xkb-model + maybe-string + "Keyboard model.") + (xkb-options + maybe-strings + "Keyboard options.") + (xkb-variant + maybe-string + "Keyboard layout variant.") + (extra-content + (strings '()) + "Lines to add at the end of the configuration file.")) + +(define (sway-inputs? lst) + (every sway-input? lst)) + +(define-configuration/no-serialization sway-border-color + (border + string + "Border color.") + (background + string + "Background color.") + (text + string + "Text color.")) + +(define-maybe sway-border-color (no-serialization)) + +(define-configuration/no-serialization sway-color + (background + maybe-string + "Background color of the bar.") + (statusline + maybe-string + "Text color of the status line.") + (focused-background + maybe-string + "Background color of the bar on the currently focused monitor.") + (focused-statusline + maybe-string + "Text color of the statusline on the currently focused monitor.") + (focused-workspace + maybe-sway-border-color + "Color scheme for focused workspaces.") + (active-workspace + maybe-sway-border-color + "Color scheme for active workspaces.") + (inactive-workspace + maybe-sway-border-color + "Color scheme for inactive workspaces.") + (urgent-workspace + maybe-sway-border-color + "Color scheme for workspaces containing `urgent' windows.") + (binding-mode + maybe-sway-border-color + "Color scheme for the binding mode indicator.")) + +(define-maybe sway-color (no-serialization)) + +(define (status-command? c) + (or (string? c) + (file-like? c) + (gexp? c))) + +(define-maybe bar-position (no-serialization)) +(define-maybe hidden-state (no-serialization)) +(define-maybe status-command (no-serialization)) +(define-maybe boolean (no-serialization)) + +(define-configuration/no-serialization sway-bar + (identifier + (symbol 'bar0) + "Identifier of the bar.") + (position + maybe-bar-position + "Position of the bar.") + (hidden-state + maybe-hidden-state + "Hidden state.") + (binding-mode-indicator + maybe-boolean + "Binding indicator.") + (colors + maybe-sway-color + "Color palette of the bar.") + (status-command + maybe-status-command + "Status command. It must be file-like.") + (mouse-bindings + (mouse-bindings '()) + "Actions triggered by mouse events.") + (extra-content + (list-of-string-ish '()) + "Extra configuration lines.")) + +(define-maybe sway-bar (no-serialization)) + +(define-configuration/no-serialization point + (x integer "X coordinate.") + (y integer "Y coordinate.")) + +(define (file-like-or-gexp? f) + (or (file-like? f) + (gexp? f))) + +(define-maybe point (no-serialization)) +(define-maybe file-like-or-gexp (no-serialization)) + +(define-configuration/no-serialization sway-output + (identifier + (string-or-symbol '*) + "Identifier of the output.") + (resolution + maybe-string + "Mode of the monitor.") + (position + maybe-point + "Position of the monitor.") + (bg + maybe-file-like-or-gexp + "Background image.") + (extra-content + (list-of-string-ish '()) + "Extra lines.")) + +(define (sway-outputs? lst) + (every sway-output? lst)) + +(define-configuration/no-serialization sway-mode + (mode-name + (string "default") + "Name of the mode.") + (keybindings + (bindings '()) + "Keybindings.") + (mouse-bindings + (mouse-bindings '()) + "Mouse bindings.")) +;; TODO (not necessary for 72714): switch bindings. + +(define (sway-modes? lst) + (every sway-mode? lst)) + +(define-configuration/no-serialization sway-configuration + (keybindings + (bindings %sway-default-keybindings) + "Keybindings.") + (gestures + (bindings %sway-default-gestures) + "Gestures.") + (packages + (list-of-packages + %sway-default-packages) + "List of packages to add to the profile.") + (variables + (variables %sway-default-variables) + "Variables declared at the beginning of the file.") + (inputs + (sway-inputs '()) + "Inputs.") + (outputs + (sway-outputs '()) + "Outputs.") + (bar + maybe-sway-bar + "Bar configuration.") + (modes + (sway-modes '()) + "Additional modes.") + (always-execs + (list-of-string-ish '()) + "Programs to execute at startup time.") + (execs + (list-of-string-ish %sway-default-execs) + "Programs to execute at startup time.") + (extra-content + (list-of-string-ish '()) + "Lines to add at the end of the configuration file.")) + + +;;; +;;; Serialization functions. +;;; + +;; Helper functions. +(define* (add-line-if field value + #:key (serializer %unset-value) + (suffix %unset-value)) + (if (eq? %unset-value value) + %unset-value + #~(string-append #$field " " + #$(if (eq? serializer %unset-value) + value + (serializer value)) + #$(if (eq? suffix %unset-value) + "" + suffix)))) + +(define (add-block name content) + (let ((content (filter + (lambda (elt) (not (eq? elt %unset-value))) + content))) + (if (equal? content '()) + '() + (append + (list #~(cons 'begin-block #$name)) + content + (list #~'end-block))))) + +(define-syntax add-block* + (syntax-rules () + ((add-block* name elt ...) + (add-block name (append elt ...))))) + +(define (box str) + (let* ((len (string-length str)) + (line (make-string (+ 4 len) #\#))) + (list + line + (string-append "# " str " #") + line))) + +(define (heading str) + (let* ((len (string-length str)) + (line (make-string (+ 2 len) #\#))) + (list + "" + (string-append "# " str) + line))) + +(define-inlinable (serialize-binding binder key value) + #~(string-append #$binder #$key " " #$value)) + +(define (serialize-mouse-binding var) + (let* ((ev (car var)) + (ev-code (number->string ev)) + (command (cdr var))) + (serialize-binding "bindcode " ev-code command))) + +(define (serialize-keybinding var) + (let ((name (symbol->string (car var))) + (value (cdr var))) + (serialize-binding "bindsym " name value))) + +(define (serialize-gesture var) + (let ((name (symbol->string (car var))) + (value (cdr var))) + (serialize-binding "bindgesture " name value))) + +(define (serialize-variable var) + (let ((name (symbol->string (car var))) + (value (cdr var))) + (serialize-binding "set $" name value))) + +(define (serialize-exec b) + (if b + (lambda (exe) + #~(string-append "exec_always " #$exe)) + (lambda (exe) + #~(string-append "exec " #$exe)))) + +(define (serialize-output out) + (let* ((pre-ident (sway-output-identifier out)) + (ident (if (symbol? pre-ident) + (symbol->string pre-ident) + (string-append "\"" pre-ident "\""))) + (bg (sway-output-bg out)) + (resolution (sway-output-resolution out)) + (position (sway-output-position out)) + (extra-content (sway-output-extra-content out))) + (add-block + (string-append "output " ident) + (cons* + ;; Optional elements. + (add-line-if "bg" bg #:suffix " fill") + (add-line-if "resolution" resolution) + (add-line-if "position" position + #:serializer + (lambda (p) + (string-append (number->string (point-x p)) + " " + (number->string (point-x p))))) + ;; Extra-content: inlined as-is. + extra-content)))) + +(define (serialize-input input) + (let* ((pre-ident (sway-input-identifier input)) + (ident (if (symbol? pre-ident) + (symbol->string pre-ident) + (string-append "\"" pre-ident "\""))) + (xkb-layout (sway-input-xkb-layout input)) + (xkb-model (sway-input-xkb-model input)) + (xkb-variant (sway-input-xkb-variant input)) + (xkb-options (sway-input-xkb-options input)) + (extra-content (sway-input-extra-content input))) + (add-block + (string-append "input " ident) + (cons* + ;; Optional. + (add-line-if "xkb_layout" xkb-layout) + (add-line-if "xkb_model" xkb-model) + (add-line-if "xkb_variant" xkb-variant) + (add-line-if "xkb_options" xkb-options + #:serializer (lambda (l) (string-join l ","))) + ;; extra-content inlined as-is. + extra-content)))) + +(define (serialize-colors colors) + (define (border-serializer val) + (string-append (sway-border-color-border val) + " " (sway-border-color-background val) + " " (sway-border-color-text val))) + (if (eq? %unset-value colors) + '() + (let ((background (sway-color-background colors)) + (statusline (sway-color-statusline colors)) + (focused-background (sway-color-focused-background colors)) + (focused-statusline (sway-color-focused-statusline colors)) + (focused-workspace (sway-color-focused-workspace colors)) + (active-workspace (sway-color-active-workspace colors)) + (inactive-workspace (sway-color-inactive-workspace colors)) + (urgent-workspace (sway-color-urgent-workspace colors)) + (binding-mode (sway-color-binding-mode colors))) + (add-block + "colors" + (list + (add-line-if "background" background) + (add-line-if "statusline" statusline) + (add-line-if "focused_background" focused-background) + (add-line-if "focused_statusline" focused-statusline) + (add-line-if "focused_workspace" focused-workspace + #:serializer border-serializer) + (add-line-if "active_workspace" active-workspace + #:serializer border-serializer) + (add-line-if "inactive_workspace" inactive-workspace + #:serializer border-serializer) + (add-line-if "urgent_workspace" urgent-workspace + #:serializer border-serializer) + (add-line-if "binding_mode" binding-mode + #:serializer border-serializer)))))) + +(define (serialize-mode mode) + (let ((name (sway-mode-mode-name mode)) + (keys (sway-mode-keybindings mode)) + (clicks (sway-mode-mouse-bindings mode))) + (add-block* + (string-append "mode \"" name "\"") + (map serialize-keybinding keys) + (map serialize-mouse-binding clicks)))) + +(define (serialize-bar bar) + (define serialize-symbol + symbol->string) + (define (serialize-mode-indicator mi) + (if mi "yes" "no")) + + (let ((identifier (symbol->string (sway-bar-identifier bar))) + (position (sway-bar-position bar)) + (hidden-state (sway-bar-hidden-state bar)) + (status-command (sway-bar-status-command bar)) + (binding-mode-indicator (sway-bar-binding-mode-indicator bar)) + (mouse-bindings (sway-bar-mouse-bindings bar)) + (extra-content (sway-bar-extra-content bar)) + (colors (sway-bar-colors bar))) + (add-block* + (string-append "bar " identifier) + + (if (eq? colors %unset-value) + '() + (serialize-colors colors)) + (list + (add-line-if "position" position + #:serializer serialize-symbol) + (add-line-if "hidden_state" hidden-state + #:serializer serialize-symbol) + (add-line-if "status_command" status-command) + (add-line-if "binding_mode_indicator" binding-mode-indicator + #:serializer serialize-mode-indicator)) + ;; Key- and mouse-bindings and extra-content + (map serialize-mouse-binding mouse-bindings) + extra-content))) + +(define (sway-configuration->file conf) + (let* ((extra (sway-configuration-extra-content conf)) + (bar (sway-configuration-bar conf))) + + (with-imported-modules + (source-module-closure + '((ice-9 popen) (ice-9 match) (ice-9 format) (srfi srfi-1))) + (computed-file + "sway-config" + #~(begin + (use-modules (ice-9 format) (ice-9 popen) (ice-9 match) + (srfi srfi-1)) + + (let* ((file #$output) + (port (open-output-file #$output))) + + ;; Add the (indented) line "s" to the output file. + (define (line s) + (lambda (i) + (format port "~a~a~%" (make-string i #\ ) s) + i)) + + ;; Increase the indentation level by `i'. + ;; (define (indent i) + ;; (lambda (j) + ;; (+ i j))) + + ;; Begin a block "name" and adjust the indentation. + (define (begin-block name) + (lambda (i) + (format port "~a~a {~%" (make-string i #\ ) name) + (+ i 4))) + + ;; Ends an open block and adjust the indentation. + (define (end-block) + (lambda (i) + (let ((i (- i 4))) + (format port "~a}~%" (make-string i #\ )) + i))) + + ;; Helper function. The configuration is represented as a list + ;; of actions (alter the indentation level, add a line, ...). + ;; This function recognises the action and calls the right + ;; function among those defined above. + (define (serializer-dispatch-m arg) + (match arg + ;; Special cases: + ;; unused: ((? integer? arg) (indent arg)) + (('begin-block . str) (begin-block str)) + ('end-block (end-block)) + ;; Default case: `arg' is assumed to be a string. + (_ (line arg)))) + + (define (serializer-dispatch elt i) + ((serializer-dispatch-m elt) i)) + + (fold + ;; Dispatch function: depending on its argument, it will change + ;; the indentation level or add a line to the output file. + serializer-dispatch + + ;; Initial indentation level + 0 + + ;; List of lines or indentation modifiers. + (list + ;; Header. + #$@(box "Auto-generated configuration") + "# DO NOT EDIT MANUALLY." + + ;; Variables. + #$@(heading "Variables.") + #$@(map serialize-variable (sway-configuration-variables conf)) + + ;; Outputs. + #$@(heading "Outputs.") + #$@(flatten + (map serialize-output (sway-configuration-outputs conf))) + + ;; Inputs. + #$@(heading "Inputs.") + #$@(flatten + (map serialize-input (sway-configuration-inputs conf))) + + ;; Bar configuration: + ;; If the bar is unset, do not include anything. + #$@(if (eq? bar %unset-value) + '() + (append + (heading "Bar configuration.") + (serialize-bar bar))) + + ;; Keybindings. + #$@(heading "Keybindings.") + #$@(map serialize-keybinding + (sway-configuration-keybindings conf)) + ;; Gestures. + #$@(heading "Gestures.") + #$@(map serialize-gesture (sway-configuration-gestures conf)) + + ;; Modes. + #$@(heading "Modes.") + #$@(flatten + (map serialize-mode (sway-configuration-modes conf))) + + ;; Execs. + #$@(heading "Programs to execute (at startup).") + #$@(map (serialize-exec #f) (sway-configuration-execs conf)) + ;; Always-execs. + #$@(heading "Programs to execute (at startup & after reload).") + #$@(map (serialize-exec #t) (sway-configuration-execs conf)) + + ;; Extra-content. + #$@extra)))))))) + +(define (sway-configuration->files sway-conf) + `((".config/sway/config" ,(sway-configuration->file sway-conf)))) + +(define home-sway-service-type + (service-type + (name 'home-sway-config) + (extensions + (list (service-extension home-files-service-type + sway-configuration->files) + (service-extension home-profile-service-type + sway-configuration-packages))) + (description "Configure Sway by providing a file +@file{~/.config/sway/config}.") + (default-value (sway-configuration)))) diff --git a/gnu/local.mk b/gnu/local.mk index 8e7abc8a47..cda3ccd732 100644 --- a/gnu/local.mk +++ b/gnu/local.mk @@ -114,6 +114,7 @@ GNU_SYSTEM_MODULES = \ %D%/home/services/shepherd.scm \ %D%/home/services/sound.scm \ %D%/home/services/ssh.scm \ + %D%/home/services/sway.scm \ %D%/home/services/syncthing.scm \ %D%/home/services/mcron.scm \ %D%/home/services/utils.scm \ -- 2.46.0