1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
# This file is part of ranger, the console file manager.
# License: GNU GPL version 3, see the file "AUTHORS" for details.
"""Colorschemes define colors for specific contexts.
Generally, this works by passing a set of keywords (strings) to
the colorscheme.get() method to receive the tuple (fg, bg, attr).
fg, bg are the foreground and background colors and attr is the attribute.
The values are specified in ranger.gui.color.
A colorscheme must...
1. be inside either of these directories:
~/.config/ranger/colorschemes/
path/to/ranger/colorschemes/
2. be a subclass of ranger.gui.colorscheme.ColorScheme
3. implement a use(self, context) method which returns (fg, bg, attr).
context is a struct which contains all entries of CONTEXT_KEYS,
associated with either True or False.
Define which colorscheme in your settings (e.g. ~/.config/ranger/rc.conf):
set colorscheme yourschemename
"""
from __future__ import (absolute_import, division, print_function)
import os.path
from curses import color_pair
import ranger
from ranger.gui.color import get_color
from ranger.gui.context import Context
from ranger.core.main import allow_access_to_confdir
from ranger.ext.cached_function import cached_function
from ranger.ext.iter_tools import flatten
class ColorSchemeError(Exception):
pass
class ColorScheme(object):
"""This is the class that colorschemes must inherit from.
it defines the get() method, which returns the color tuple
which fits to the given keys.
"""
@cached_function
def get(self, *keys):
"""Returns the (fg, bg, attr) for the given keys.
Using this function rather than use() will cache all
colors for faster access.
"""
context = Context(keys)
color = self.use(context)
if len(color) != 3 or not all(isinstance(value, int) for value in color):
raise ValueError("Bad Value from colorscheme. Need "
"a tuple of (foreground_color, background_color, attribute).")
return color
@cached_function
def get_attr(self, *keys):
"""Returns the curses attribute for the specified keys
Ready to use for curses.setattr()
"""
fg, bg, attr = self.get(*flatten(keys))
return attr | color_pair(get_color(fg, bg))
@staticmethod
def use(_):
"""Use the colorscheme to determine the (fg, bg, attr) tuple.
Override this method in your own colorscheme.
"""
return (-1, -1, 0)
def _colorscheme_name_to_class(signal): # pylint: disable=too-many-branches
# Find the colorscheme. First look in ~/.config/ranger/colorschemes,
# then at RANGERDIR/colorschemes. If the file contains a class
# named Scheme, it is used. Otherwise, an arbitrary other class
# is picked.
if isinstance(signal.value, ColorScheme):
return
if not signal.value:
signal.value = 'default'
scheme_name = signal.value
usecustom = not ranger.args.clean
def exists(colorscheme):
return os.path.exists(colorscheme + '.py') or os.path.exists(colorscheme + '.pyc')
def is_scheme(cls):
try:
return issubclass(cls, ColorScheme)
except TypeError:
return False
# create ~/.config/ranger/colorschemes/__init__.py if it doesn't exist
if usecustom:
if os.path.exists(signal.fm.confpath('colorschemes')):
initpy = signal.fm.confpath('colorschemes', '__init__.py')
if not os.path.exists(initpy):
open(initpy, 'a').close()
if usecustom and \
exists(signal.fm.confpath('colorschemes', scheme_name)):
scheme_supermodule = 'colorschemes'
elif exists(signal.fm.relpath('colorschemes', scheme_name)):
scheme_supermodule = 'ranger.colorschemes'
usecustom = False
else:
scheme_supermodule = None # found no matching file.
if scheme_supermodule is None:
if signal.previous and isinstance(signal.previous, ColorScheme):
signal.value = signal.previous
else:
signal.value = ColorScheme()
raise ColorSchemeError("Cannot locate colorscheme `%s'" % scheme_name)
else:
if usecustom:
allow_access_to_confdir(ranger.args.confdir, True)
scheme_module = getattr(
__import__(scheme_supermodule, globals(), locals(), [scheme_name], 0), scheme_name)
if usecustom:
allow_access_to_confdir(ranger.args.confdir, False)
if hasattr(scheme_module, 'Scheme') and is_scheme(scheme_module.Scheme):
signal.value = scheme_module.Scheme()
else:
for var in scheme_module.__dict__.values():
if var != ColorScheme and is_scheme(var):
signal.value = var()
break
else:
raise ColorSchemeError("The module contains no valid colorscheme!")
def get_all_colorschemes():
colorschemes = set()
# Load colorscheme names from main ranger/colorschemes dir
for item in os.listdir(ranger.RANGERDIR + '/colorschemes'):
if not item.startswith('__'):
colorschemes.add(item.rsplit('.', 1)[0])
# Load colorscheme names from ~/.config/ranger/colorschemes if dir exists
if os.path.isdir(os.path.expanduser(ranger.CONFDIR + '/colorschemes')):
for item in os.listdir(os.path.expanduser(
ranger.CONFDIR + '/colorschemes')):
if not item.startswith('__'):
colorschemes.add(item.rsplit('.', 1)[0])
return list(sorted(colorschemes))
|