home-manager/modules/services/window-managers/fluxbox.nix

{ config, lib, pkgs, ... }:

with lib;

let

  cfg = config.xsession.windowManager.fluxbox;

in {
  meta.maintainers = [ maintainers.AndersonTorres ];

  options = {
    xsession.windowManager.fluxbox = {
      enable = mkEnableOption "Fluxbox window manager";

      package = mkOption {
        type = types.package;
        default = pkgs.fluxbox;
        defaultText = literalExpression "pkgs.fluxbox";
        description = "Package to use for running Fluxbox WM.";
      };

      init = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Init configuration for Fluxbox, written to
          <filename>~/.fluxbox/init</filename>. Look at the
          <citerefentry>
          <refentrytitle>fluxbox</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry> manpage for details.
        '';
      };

      apps = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Apps configuration for Fluxbox, written to
          <filename>~/.fluxbox/apps</filename>. Look at the
          <citerefentry><refentrytitle>fluxbox</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry> manpage for details.
        '';
      };

      keys = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Keyboard shortcuts configuration for Fluxbox, written to
          <filename>~/.fluxbox/keys</filename>. Look at the
          <citerefentry><refentrytitle>fluxbox-keys</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry> manpage for details.
        '';
      };

      menu = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Menu configuration for Fluxbox, written to
          <filename>~/.fluxbox/menu</filename>. Look at the
          <citerefentry><refentrytitle>fluxbox-menu</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry> manpage for details.
        '';
      };

      slitlist = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Slitlist configuration for Fluxbox, written to
          <filename>~/.fluxbox/slitlist</filename>. Look at the
          <citerefentry><refentrytitle>fluxbox</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry> manpage for details.
        '';
      };

      windowmenu = mkOption {
        type = types.lines;
        default = "";
        description = ''
          Window menu configuration for Fluxbox, written to
          <filename>~/.fluxbox/windowmenu</filename>. Look at the
          <citerefentry><refentrytitle>fluxbox-menu</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry>
          manpage for details.
        '';
      };

      extraCommandLineArgs = mkOption {
        type = with types; listOf str;
        default = [ ];
        example = [ "-log" "/tmp/fluxbox.log" ];
        description = ''
          Extra command line arguments to pass to <command>fluxbox</command>.
          Look at the
          <citerefentry><refentrytitle>fluxbox</refentrytitle>
          <manvolnum>1</manvolnum></citerefentry> manpage for details.
        '';
      };
    };
  };

  config = mkIf cfg.enable {
    assertions = [
      (hm.assertions.assertPlatform "xsession.windowManager.fluxbox" pkgs
        platforms.linux)
    ];

    home.packages = [ cfg.package ];

    home.file = {
      ".fluxbox/init" = mkIf (cfg.init != "") { text = cfg.init; };
      ".fluxbox/apps" = mkIf (cfg.apps != "") { text = cfg.apps; };
      ".fluxbox/keys" = mkIf (cfg.keys != "") { text = cfg.keys; };
      ".fluxbox/menu" = mkIf (cfg.menu != "") { text = cfg.menu; };
      ".fluxbox/slitlist" = mkIf (cfg.slitlist != "") { text = cfg.slitlist; };
      ".fluxbox/windowmenu" =
        mkIf (cfg.windowMenu != "") { text = cfg.windowmenu; };
    };

    xsession.windowManager.command = concatStringsSep " "
      ([ "${cfg.package}/bin/fluxbox" ]
        ++ escapeShellArgs (remove "" cfg.extraCommandLineArgs));
  };
}