tmux_styler.Styler

  1"""
  2Styler object for styling tmux.
  3"""
  4
  5import json
  6import os
  7from typing import Dict, List
  8from enum import Enum
  9
 10from .ContextVars import ContextVar
 11from .Statusbar.Statusbar import *
 12
 13
 14class PaneBorder(Enum):
 15    OFF = "off"
 16    TOP = "top"
 17    BOTTOM = "bottom"
 18
 19    def __str__(self):
 20        return self.value
 21
 22
 23class PaneBorderLineStyle(Enum):
 24    """
 25    Pane border type/style.
 26
 27    - SINGLE: single lines using ACS or UTF-8 characters
 28    - DOUBLE: double lines using UTF-8 characters
 29    - HEAVY: heavy lines using UTF-8 characters
 30    - SIMPLE: simple ASCII characters
 31    - NUMBER: the pane number
 32
 33    DOUBLE and HEAVY will fall back to standard ACS line
 34    drawing when UTF-8 is not supported.
 35    """
 36    SINGLE = "single"
 37    DOUBLE = "double"
 38    HEAVY = "heavy"
 39    SIMPLE = "simple"
 40    NUMBER = "number"
 41
 42    def __str__(self):
 43        return self.value
 44
 45
 46class Styler:
 47    """
 48    Styler for tmux.
 49    """
 50
 51    status_bar: Statusbar | None = None
 52    """
 53    Statusbar object for styling the status bar.
 54    """
 55
 56    renumber_windows: bool = True
 57    """
 58    Whether to renumber windows automatically when a window is closed. Defaults to True.
 59    """
 60
 61    auto_rename_window: bool = True
 62    """
 63    Whether to automatically rename windows. Defaults to True.
 64    """
 65
 66    _auto_rename_window_content: str = str(ContextVar.PANE_CURRENT_COMMAND)
 67
 68    @property
 69    def auto_rename_window_content(cls) -> str | ContextVar | List[ContextVar | str]:
 70        """
 71        What to rename windows to. Defaults to `ContextVar.PANE_CURRENT_COMMAND`.
 72        """
 73        return cls._auto_rename_window_content
 74
 75    @auto_rename_window_content.setter
 76    def auto_rename_window_content(cls, value: str | ContextVar | List[ContextVar | str]):
 77        if isinstance(value, List):
 78            cls._auto_rename_window_content = "".join(map(str, value))
 79        else:
 80            cls._auto_rename_window_content = str(value)
 81
 82    pane_border: PaneBorder = PaneBorder.TOP
 83    """
 84    Pane border position or off. Defaults to `PaneBorder.TOP`.
 85    """
 86
 87    pane_border_line_style: PaneBorderLineStyle = PaneBorderLineStyle.SINGLE
 88    """
 89    Pane border line type/style. Defaults to `PaneBorderLineStyle.SINGLE`.
 90    """
 91
 92    pane_border_content: str | ContextVar | List[ContextVar | str] = [
 93        ContextVar.PANE_INDEX, " ", ContextVar.PANE_CURRENT_COMMAND]
 94    """
 95    Pane border content. Defaults to `[ContextVar.PANE_INDEX, " ", ContextVar.PANE_CURRENT_COMMAND]`,
 96    which will display the pane index, a space, and the currently running command e.g. "1 nvim".
 97    """
 98
 99    current_command_max_depth: int = 1
100    """
101    Whenever `ContextVar.PANE_CURRENT_COMMAND` is used, this is the maximum depth to search for the
102    currently running command in the process tree. Defaults to 1.
103
104    Useful to change when you are commonly running processes/commands that spawn other processes
105    e.g. you use fig for terminal command completion, tmux given a depth of 1 only looks at 
106    first process spawned by a pane's root process. In this case tmux will see fig at depth 0
107    and report it's child process, which would just be a shell (zsh/bash/etc), so tmux will always 
108    show the shell as the current command. Setting this to 2 will show the command/process below 
109    the shell e.g. python or node or an editor.
110
111    If you aren't using fig than a depth of 1 is probably fine as the "root" process tmux sees will
112    be the shell and the child process will be the command you are currently running.
113    """
114
115    current_command_glyph: bool = True
116    """
117    Whether to show a glyph corresponding to the current command whenever `ContextVar.PANE_CURRENT_COMMAND`
118    is used. Requires a Nerd Font/Patched Font. Defaults to True.
119    """
120
121    current_command_glyphs: Dict[str, str] | None = None
122    """
123    Add or change glyphs for `ContextVar.PANE_CURRENT_COMMAND`. Common processes are already included by default.
124    common editors (vim/neovim, emacs), common language interpreters/runtimes/compilers (clang/gcc, python, 
125    node, rust, go, etc.), common tools (git, less, docker), shells (bash, zsh, fish, etc.) and many more.
126
127    If you want to add a glyph for a process or change a default, pass a dictionary mapping process names to glyphs.
128
129    e.g. if you want to use a different icon for "node":
130    ```python
131    styler = Styler()
132    styler.current_command_glyphs = {"node": "󰇷"}
133    ```
134    """
135
136    def style(self):
137        """
138        Style tmux. Call at the end of your config file to style tmux.
139        """
140        current_dir = os.path.dirname(os.path.abspath(__file__))
141        path = os.path.join(current_dir, ".user")
142        # create the .user directory if it doesn't exist
143        if not os.path.exists(path):
144            os.mkdir(path)
145
146        # Save the segment data as JSON
147        if self.status_bar:
148            with open(os.path.join(path, "segment_data.json"), "w") as f:
149                f.write(json.dumps(self.status_bar.segment_data))
150
151        # Pickle the statusbar object
152        if self.status_bar:
153            with open(os.path.join(path, "statusbar.pickle"), "wb") as f:
154                f.write(self.status_bar._Statusbar__pickle())
155
156        # Save the current command glyphs/settings as JSON
157        if self.current_command_max_depth < 1:
158            self.current_command_max_depth = 1
159        with open(os.path.join(path, "command_settings.json"), "w") as f:
160            f.write(json.dumps({
161                "glyphs": self.current_command_glyphs,
162                "glyph": self.current_command_glyph,
163                "max_depth": self.current_command_max_depth,
164            }))
165
166        #  Pane border content to string
167        if isinstance(self.pane_border_content, List):
168            self.pane_border_content = "".join(
169                map(str, self.pane_border_content))
170        else:
171            self.pane_border_content = str(self.pane_border_content)
172        self.pane_border_content = f" {self.pane_border_content} "
173
174        commands = [
175            # Load commands for the statusbar
176            *self.status_bar._Statusbar__commands(),
177
178            # Auto rename windows
179            f'tmux set -g automatic-rename {"on" if self.auto_rename_window else "off"}',
180            # Renumber windows
181            f'tmux set -g renumber-windows {"on" if self.renumber_windows else "off"}',
182            # Auto rename format
183            f'tmux set -g automatic-rename-format "{self._auto_rename_window_content}"',
184
185            # Pane border
186            f'tmux set -g pane-border-status "{self.pane_border}"',
187            # Pane border style
188            f'tmux set -g pane-border-line "{self.pane_border_line_style}"',
189            # Pane border content
190            f'tmux set -g pane-border-format "{self.pane_border_content}"',
191
192            # Term Colors
193            'tmux set -g default-terminal "screen-256color"',
194        ]
195
196        for command in commands:
197            proc = subprocess.Popen(command, shell=True,
198                                    stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
199            proc.wait()
200            proc.terminate()