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
|
# Copyright (c) 2009, 2010 hut <hut@lavabit.com>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""
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:
~/.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 to use by having this to your options.py:
from ranger import colorschemes
colorscheme = colorschemes.filename
If your colorscheme-file contains more than one colorscheme, specify it with:
colorscheme = colorschemes.filename.classname
"""
from ranger.ext.openstruct import OpenStruct
CONTEXT_KEYS = [ 'reset', 'error',
'in_browser', 'in_statusbar', 'in_titlebar', 'in_console',
'in_pager', 'in_taskview',
'directory', 'file', 'hostname',
'executable', 'media', 'link',
'video', 'audio', 'image', 'media', 'document', 'container',
'selected', 'empty', 'main_column', 'message', 'background',
'good', 'bad',
'space', 'permissions', 'owner', 'group', 'mtime', 'nlink',
'scroll', 'all', 'bot', 'top', 'percentage',
'marked', 'tagged', 'tag_marker',
'help_markup',
'seperator', 'key', 'special',
'title', 'text', 'highlight', 'bars', 'quotes',
'keybuffer']
class ColorScheme(object):
"""
This is the class that colorschemes must inherit from.
it defines get()
it defines the get() method, which returns the color tuple
which fits to the given keys.
"""
def __init__(self):
self.cache = {}
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.
"""
try:
return self.cache[keys]
except KeyError:
context = OpenStruct()
for key in CONTEXT_KEYS:
context[key] = (key in keys)
# add custom error messages for broken colorschemes
color = self.use(context)
self.cache[keys] = color
return color
def get_attr(self, *keys):
"""
Returns the curses attribute for the specified keys
Ready to use for curses.setattr()
"""
from curses import color_pair
from ranger.gui.color import get_color
fg, bg, attr = self.get(*keys)
return attr | color_pair(get_color(fg, bg))
def use(self, context):
"""
Use the colorscheme to determine the (fg, bg, attr) tuple.
This is a dummy function which always returns default_colors.
Override this in your custom colorscheme!
"""
from ranger.gui.color import default_colors
return default_colors
|