tmux_styler.Style

  1"""
  2tmux styling options.
  3"""
  4
  5from enum import Enum
  6from typing import List
  7from tmux_styler.Colors import Color
  8
  9
 10class TextAttributes(Enum):
 11    """
 12    Text attributes to apply to text.
 13
 14    Attributes:
 15    -----------
 16    `ACS`: Use the terminal alternate character set.
 17
 18    `BRIGHT`: Make the text brighter.
 19    
 20    `BOLD`: Make the text bold.
 21    
 22    `DIM`: Make the text dimmer.
 23    
 24    `UNDERSCORE`: Underline the text.
 25    
 26    `BLINK`: Make the text blink.
 27    
 28    `REVERSE`: Reverse the background and text colors.
 29    
 30    `HIDDEN`: Hide the text.
 31    
 32    `ITALICS`: Make the text italicized.
 33    
 34    `OVERLINE`: Overline the text.
 35    
 36    `STRIKETHROUGH`: Draw a line through the text.
 37    
 38    `DOUBLE_UNDERSCORE`: Double underline the text.
 39    
 40    `CURLY_UNDERSCORE`: Curly underline the text.
 41    
 42    `DOTTED_UNDERSCORE`: Dotted underline the text.
 43    
 44    `DASHED_UNDERSCORE`: Dashed underline the text.
 45    """
 46
 47    ACS = "acs"
 48    """The terminal alternate character set."""
 49    BRIGHT = "bright"
 50    """Make the text brighter."""
 51    BOLD = "bold"
 52    """Make the text bold."""
 53    DIM = "dim"
 54    """Make the text dimmer."""
 55    UNDERSCORE = "underscore"
 56    """Underline the text."""
 57    BLINK = "blink"
 58    """Make the text blink."""
 59    REVERSE = "reverse"
 60    """Reverse the background and text colors."""
 61    HIDDEN = "hidden"
 62    """Hide the text."""
 63    ITALICS = "italics"
 64    """Make the text italicized."""
 65    OVERLINE = "overline"
 66    """Overline the text."""
 67    STRIKETHROUGH = "strikethrough"
 68    """Draw a line through the text."""
 69    DOUBLE_UNDERSCORE = "double-underscore"
 70    """Double underline the text."""
 71    CURLY_UNDERSCORE = "curly-underscore"
 72    """Curly underline the text."""
 73    DOTTED_UNDERSCORE = "dotted-underscore"
 74    """Dotted underline the text."""
 75    DASHED_UNDERSCORE = "dashed-underscore"
 76    """Dashed underline the text."""
 77
 78    def __str__(self):
 79        """
 80        Returns the string representation of the attribute.
 81        """
 82        return self.value
 83
 84
 85class Style:
 86    """
 87    Represents a tmux style.
 88
 89    Attributes:
 90    -----------
 91    `fg`: Color | None
 92        The foreground color, none will default to the inherited color. (default: None)
 93
 94    `bg`: Color | None
 95        The background color, none will default to the inherited color. (default: None)
 96
 97    `attrs`: List[TextAttributes] | None
 98        The text attributes to apply to the text. (default: None)
 99
100    `unset_attrs`: List[TextAttributes] | None
101        The text attributes to unset from the text. This will override any attributes
102        set in attrs. You may want to unset attributes that you've set by default. (default: None)
103    """
104
105    def __init__(self, bg: Color | None = None, fg: Color | None = None,  attrs: List[TextAttributes] | None = None, unset_attrs: List[TextAttributes] | None = None):
106        """
107        Creates a style for use with tmux.
108        """
109        self.fg = fg
110        self.bg = bg
111        self.attrs = attrs
112        self.unset_attrs = unset_attrs
113
114    def __str__(self) -> str:
115        """
116        Returns the format string representation of the entire style.
117        """
118        bg = "" if self.bg is None else "bg={}".format(self.bg)
119        fg = "" if self.fg is None else "fg={}".format(self.fg)
120        attrs = "" if self.attrs is None else f"{' '.join(map(str, self.attrs))}"
121        unset_attrs = "" if self.unset_attrs is None else f"{' '.join(map(lambda x: f'no{str(x)}', self.unset_attrs))}"
122        return ",".join(
123            filter(lambda x: x != "", [fg, bg, attrs, unset_attrs]))
124
125    def apply(self) -> str:
126        """
127        Returns a string that applies all of the attributes in the style (attrs, unset_attrs, and alignment).
128        """
129        attrs = "" if self.attrs is None else f"{' '.join(map(str, self.attrs))}"
130        unset_attrs = "" if self.unset_attrs is None else f"{' '.join(map(lambda x: f'no{str(x)}', self.unset_attrs))}"
131        return ",".join(
132            filter(lambda x: x != "", [attrs, unset_attrs]))