Working on theme support
This commit is contained in:
Michael Lazar
370
rtv/theme.py
Normal file
370
rtv/theme.py
Normal file
@@ -0,0 +1,370 @@
|
||||
import codecs
|
||||
import configparser
|
||||
import curses
|
||||
import logging
|
||||
import os
|
||||
|
||||
from .config import THEMES, DEFAULT_THEMES
|
||||
from .exceptions import ConfigError
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Theme(object):
|
||||
|
||||
ATTRIBUTE_CODES = {
|
||||
'': curses.A_NORMAL,
|
||||
'bold': curses.A_BOLD,
|
||||
'reverse': curses.A_REVERSE,
|
||||
'underline': curses.A_UNDERLINE,
|
||||
'standout': curses.A_STANDOUT
|
||||
}
|
||||
|
||||
COLOR_CODES = {
|
||||
'default': -1,
|
||||
'black': curses.COLOR_BLACK,
|
||||
'red': curses.COLOR_RED,
|
||||
'green': curses.COLOR_GREEN,
|
||||
'yellow': curses.COLOR_YELLOW,
|
||||
'blue': curses.COLOR_BLUE,
|
||||
'magenta': curses.COLOR_MAGENTA,
|
||||
'cyan': curses.COLOR_CYAN,
|
||||
'light_gray': curses.COLOR_WHITE,
|
||||
'dark_gray': 8,
|
||||
'bright_red': 9,
|
||||
'bright_green': 10,
|
||||
'bright_yellow': 11,
|
||||
'bright_blue': 12,
|
||||
'bright_magenta': 13,
|
||||
'bright_cyan': 14,
|
||||
'white': 15,
|
||||
}
|
||||
|
||||
# Add keywords for the 256 ansi color codes
|
||||
for i in range(256):
|
||||
COLOR_CODES['ansi_{0}'.format(i)] = i
|
||||
|
||||
# For compatibility with as many terminals as possible, the default theme
|
||||
# can only use the 8 basic colors with the default background.
|
||||
DEFAULT_THEME = {
|
||||
'bar_level_1': (curses.COLOR_MAGENTA, -1, curses.A_NORMAL),
|
||||
'bar_level_2': (curses.COLOR_CYAN, -1, curses.A_NORMAL),
|
||||
'bar_level_3': (curses.COLOR_GREEN, -1, curses.A_NORMAL),
|
||||
'bar_level_4': (curses.COLOR_YELLOW, -1, curses.A_NORMAL),
|
||||
'comment_author': (curses.COLOR_BLUE, -1, curses.A_BOLD),
|
||||
'comment_author_self': (curses.COLOR_GREEN, -1, curses.A_BOLD),
|
||||
'comment_count': (-1, -1, curses.A_NORMAL),
|
||||
'comment_text': (-1, -1, curses.A_NORMAL),
|
||||
'created': (-1, -1, curses.A_NORMAL),
|
||||
'cursor': (-1, -1, curses.A_REVERSE),
|
||||
'default': (-1, -1, curses.A_NORMAL),
|
||||
'downvote': (curses.COLOR_RED, -1, curses.A_BOLD),
|
||||
'gold': (curses.COLOR_YELLOW, -1, curses.A_BOLD),
|
||||
'help_bar': (curses.COLOR_CYAN, -1, curses.A_BOLD | curses.A_REVERSE),
|
||||
'hidden_comment_expand': (-1, -1, curses.A_BOLD),
|
||||
'hidden_comment_text': (-1, -1, curses.A_NORMAL),
|
||||
'multireddit_name': (curses.COLOR_YELLOW, -1, curses.A_BOLD),
|
||||
'multireddit_text': (-1, -1, curses.A_NORMAL),
|
||||
'neutral_vote': (-1, -1, curses.A_BOLD),
|
||||
'notice_info': (-1, -1, curses.A_NORMAL),
|
||||
'notice_loading': (-1, -1, curses.A_NORMAL),
|
||||
'notice_error': (curses.COLOR_RED, -1, curses.A_NORMAL),
|
||||
'notice_success': (curses.COLOR_GREEN, -1, curses.A_NORMAL),
|
||||
'nsfw': (curses.COLOR_RED, -1, curses.A_BOLD),
|
||||
'order_bar': (curses.COLOR_YELLOW, -1, curses.A_BOLD),
|
||||
'order_selected': (curses.COLOR_YELLOW, -1, curses.A_BOLD | curses.A_REVERSE),
|
||||
'prompt': (curses.COLOR_CYAN, -1, curses.A_BOLD | curses.A_REVERSE),
|
||||
'saved': (curses.COLOR_GREEN, -1, curses.A_NORMAL),
|
||||
'score': (-1, -1, curses.A_NORMAL),
|
||||
'separator': (-1, -1, curses.A_BOLD),
|
||||
'stickied': (curses.COLOR_GREEN, -1, curses.A_NORMAL),
|
||||
'subscription_name': (curses.COLOR_YELLOW, -1, curses.A_BOLD),
|
||||
'subscription_text': (-1, -1, curses.A_NORMAL),
|
||||
'submission_author': (curses.COLOR_GREEN, -1, curses.A_NORMAL),
|
||||
'submission_flair': (curses.COLOR_RED, -1, curses.A_NORMAL),
|
||||
'submission_subreddit': (curses.COLOR_YELLOW, -1, curses.A_NORMAL),
|
||||
'submission_text': (-1, -1, curses.A_NORMAL),
|
||||
'submission_title': (-1, -1, curses.A_BOLD),
|
||||
'title_bar': (curses.COLOR_CYAN, -1, curses.A_BOLD | curses.A_REVERSE),
|
||||
'upvote': (curses.COLOR_GREEN, -1, curses.A_BOLD),
|
||||
'url': (curses.COLOR_BLUE, -1, curses.A_UNDERLINE),
|
||||
'url_seen': (curses.COLOR_MAGENTA, -1, curses.A_UNDERLINE),
|
||||
'user_flair': (curses.COLOR_YELLOW, -1, curses.A_BOLD)
|
||||
}
|
||||
|
||||
def __init__(self, name='default', elements=None, monochrome=False):
|
||||
"""
|
||||
Params:
|
||||
name (str): A unique string that describes the theme
|
||||
elements (dict): The theme's element map, should be in the same
|
||||
format as Theme.DEFAULT_THEME.
|
||||
monochrome (bool): If true, force all color pairs to use the
|
||||
terminal's default foreground/background color.
|
||||
"""
|
||||
|
||||
self.elements = self.DEFAULT_THEME.copy()
|
||||
if elements:
|
||||
self.elements.update(elements)
|
||||
|
||||
self.name = name
|
||||
self.monochrome = monochrome
|
||||
self._color_pair_map = None
|
||||
self._attribute_map = None
|
||||
|
||||
self.required_color_pairs = 0
|
||||
self.required_colors = 0
|
||||
|
||||
if not self.monochrome:
|
||||
colors, color_pairs = set(), set()
|
||||
for fg, bg, _ in self.elements.values():
|
||||
colors.add(fg)
|
||||
colors.add(bg)
|
||||
color_pairs.add((fg, bg))
|
||||
|
||||
# Don't count the default fg/bg as a color pair
|
||||
color_pairs.discard((-1, -1))
|
||||
self.required_color_pairs = len(color_pairs)
|
||||
|
||||
# Determine which color set the terminal needs to
|
||||
# support in order to be able to use the theme
|
||||
self.required_colors = None
|
||||
for marker in [0, 8, 16, 256]:
|
||||
if max(colors) < marker:
|
||||
self.required_colors = marker
|
||||
break
|
||||
|
||||
def bind_curses(self):
|
||||
"""
|
||||
Bind the theme's colors to curses's internal color pair map.
|
||||
|
||||
This method must be called once (after curses has been initialized)
|
||||
before any element attributes can be accessed. Color codes and other
|
||||
special attributes will be mixed bitwise into a single value that
|
||||
can be understood by curses.
|
||||
"""
|
||||
self._color_pair_map = {}
|
||||
self._attribute_map = {}
|
||||
|
||||
for element, item in self.elements.items():
|
||||
fg, bg, attrs = item
|
||||
|
||||
color_pair = (fg, bg)
|
||||
if not self.monochrome and color_pair != (-1, -1):
|
||||
# Curses limits the number of available color pairs, so we
|
||||
# need to reuse them if there are multiple elements with the
|
||||
# same foreground and background.
|
||||
if color_pair not in self._color_pair_map:
|
||||
# Index 0 is reserved by curses for the default color
|
||||
index = len(self._color_pair_map) + 1
|
||||
curses.init_pair(index, color_pair[0], color_pair[1])
|
||||
self._color_pair_map[color_pair] = curses.color_pair(index)
|
||||
attrs |= self._color_pair_map[color_pair]
|
||||
|
||||
self._attribute_map[element] = attrs
|
||||
|
||||
def get(self, val):
|
||||
"""
|
||||
Returns the curses attribute code for the given element.
|
||||
"""
|
||||
if self._attribute_map is None:
|
||||
raise RuntimeError('Attempted to access theme attribute before '
|
||||
'calling initialize_curses_theme()')
|
||||
return self._attribute_map[val]
|
||||
|
||||
def get_bar_level(self, indentation_level):
|
||||
"""
|
||||
Helper method for loading the bar format given the indentation level.
|
||||
"""
|
||||
|
||||
levels = ['bar_level_1', 'bar_level_2', 'bar_level_3', 'bar_level_4']
|
||||
level = levels[indentation_level % len(levels)]
|
||||
return self.get(level)
|
||||
|
||||
@classmethod
|
||||
def list_themes(cls, path=THEMES):
|
||||
"""
|
||||
Compile all of the themes configuration files in the search path.
|
||||
"""
|
||||
|
||||
themes = {'invalid': {}, 'custom': {}, 'default': {}}
|
||||
for container, theme_path in [
|
||||
(themes['custom'], path),
|
||||
(themes['default'], DEFAULT_THEMES)]:
|
||||
|
||||
if os.path.isdir(theme_path):
|
||||
for filename in os.listdir(theme_path):
|
||||
if not filename.endswith('.cfg'):
|
||||
continue
|
||||
|
||||
filepath = os.path.join(theme_path, filename)
|
||||
name = filename[:-4]
|
||||
try:
|
||||
# Make sure the theme is valid
|
||||
theme = cls.from_file(filepath)
|
||||
except Exception as e:
|
||||
themes['invalid'][name] = e
|
||||
else:
|
||||
container[name] = theme
|
||||
|
||||
return themes
|
||||
|
||||
@classmethod
|
||||
def print_themes(cls, path=THEMES):
|
||||
"""
|
||||
Prints a human-readable summary of all of the installed themes to stdout.
|
||||
|
||||
This is intended to be used as a command-line utility, outside of the
|
||||
main curses display loop.
|
||||
"""
|
||||
themes = cls.list_themes(path=path)
|
||||
|
||||
print('\nInstalled ({0}):'.format(path))
|
||||
custom_themes = sorted(themes['custom'].items())
|
||||
if custom_themes:
|
||||
for name, theme in custom_themes:
|
||||
print(' {0:<20}[requires {1} colors]'.format(
|
||||
name, theme.required_colors))
|
||||
else:
|
||||
print(' (empty)')
|
||||
|
||||
print('\nBuilt-in:')
|
||||
default_themes = sorted(themes['default'].items())
|
||||
for name, theme in default_themes:
|
||||
print(' {0:<20}[requires {1} colors]'.format(
|
||||
name, theme.required_colors))
|
||||
|
||||
invalid_themes = sorted(themes['invalid'].items())
|
||||
if invalid_themes:
|
||||
print('\nWARNING: Some themes had problems loading:')
|
||||
for name, error in invalid_themes:
|
||||
print(' {0:<20}{1!r}'.format(name, error))
|
||||
|
||||
print('')
|
||||
|
||||
@classmethod
|
||||
def from_name(cls, name, monochrome=False, path=THEMES):
|
||||
"""
|
||||
Search for the given theme on the filesystem and attempt to load it.
|
||||
|
||||
Directories will be checked in a pre-determined order. If the name is
|
||||
provided as an absolute file path, it will be loaded directly.
|
||||
"""
|
||||
|
||||
filenames = [
|
||||
name,
|
||||
os.path.join(path, '{0}.cfg'.format(name)),
|
||||
os.path.join(DEFAULT_THEMES, '{0}.cfg'.format(name))]
|
||||
|
||||
for filename in filenames:
|
||||
if os.path.isfile(filename):
|
||||
return cls.from_file(filename, monochrome)
|
||||
|
||||
raise ConfigError('Could not find theme named "{0}"'.format(name))
|
||||
|
||||
@classmethod
|
||||
def from_file(cls, filename, monochrome=False):
|
||||
"""
|
||||
Load a theme from the specified configuration file.
|
||||
"""
|
||||
|
||||
try:
|
||||
config = configparser.ConfigParser()
|
||||
with codecs.open(filename, encoding='utf-8') as fp:
|
||||
config.readfp(fp)
|
||||
except configparser.ParsingError as e:
|
||||
raise ConfigError(e.message)
|
||||
|
||||
if not config.has_section('theme'):
|
||||
raise ConfigError(
|
||||
'Error loading {0}:\n'
|
||||
' missing [theme] section'.format(filename))
|
||||
|
||||
theme_name = os.path.basename(filename)
|
||||
theme_name, _ = os.path.splitext(theme_name)
|
||||
|
||||
elements = {}
|
||||
if config.has_section('theme'):
|
||||
for element, line in config.items('theme'):
|
||||
if element not in cls.DEFAULT_THEME:
|
||||
# Could happen if using a new config with an older version
|
||||
# of the software
|
||||
continue
|
||||
elements[element] = cls._parse_line(element, line, filename)
|
||||
|
||||
return cls(theme_name, elements, monochrome)
|
||||
|
||||
@classmethod
|
||||
def _parse_line(cls, element, line, filename=None):
|
||||
"""
|
||||
Parse a single line from a theme file.
|
||||
|
||||
Format:
|
||||
<element>: <foreground> <background> <attributes>
|
||||
"""
|
||||
|
||||
items = line.split()
|
||||
if len(items) == 2:
|
||||
fg, bg, attrs = items[0], items[1], ''
|
||||
elif len(items) == 3:
|
||||
fg, bg, attrs = items
|
||||
else:
|
||||
raise ConfigError(
|
||||
'Error loading {0}, invalid line:\n'
|
||||
' {1} = {2}'.format(filename, element, line))
|
||||
|
||||
if fg.startswith('#'):
|
||||
fg = cls.rgb_to_ansi(fg)
|
||||
if bg.startswith('#'):
|
||||
bg = cls.rgb_to_ansi(bg)
|
||||
|
||||
fg_code = cls.COLOR_CODES.get(fg)
|
||||
if fg_code is None:
|
||||
raise ConfigError(
|
||||
'Error loading {0}, invalid <foreground>:\n'
|
||||
' {1} = {2}'.format(filename, element, line))
|
||||
|
||||
bg_code = cls.COLOR_CODES.get(bg)
|
||||
if bg_code is None:
|
||||
raise ConfigError(
|
||||
'Error loading {0}, invalid <background>:\n'
|
||||
' {1} = {2}'.format(filename, element, line))
|
||||
|
||||
attrs_code = curses.A_NORMAL
|
||||
for attr in attrs.split('+'):
|
||||
attr_code = cls.ATTRIBUTE_CODES.get(attr)
|
||||
if attr_code is None:
|
||||
raise ConfigError(
|
||||
'Error loading {0}, invalid <attributes>:\n'
|
||||
' {1} = {2}'.format(filename, element, line))
|
||||
attrs_code |= attr_code
|
||||
|
||||
return fg_code, bg_code, attrs_code
|
||||
|
||||
@staticmethod
|
||||
def rgb_to_ansi(color):
|
||||
"""
|
||||
Converts hex RGB to the 6x6x6 xterm color space
|
||||
|
||||
Args:
|
||||
color (str): RGB color string in the format "#RRGGBB"
|
||||
|
||||
Returns:
|
||||
str: ansi color string in the format "ansi_n", where n
|
||||
is between 16 and 230
|
||||
|
||||
Reference:
|
||||
https://github.com/chadj2/bash-ui/blob/master/COLORS.md
|
||||
"""
|
||||
|
||||
if color[0] != '#' or len(color) != 7:
|
||||
return None
|
||||
|
||||
try:
|
||||
r = round(int(color[1:3], 16) / 51.0) # Normalize between 0-5
|
||||
g = round(int(color[3:5], 16) / 51.0)
|
||||
b = round(int(color[5:7], 16) / 51.0)
|
||||
n = 36 * r + 6 * g + b + 16
|
||||
return 'ansi_{0}'.format(n)
|
||||
|
||||
except ValueError:
|
||||
return None
|
||||
Reference in New Issue
Block a user