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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
010-03-10 17:53:14 +0100
committer hut <hut@lavabit.com> 2010-03-12 00:46:46 +0100
added documentation on how colorschemes work' href='/akspecs/ranger/commit/doc/colorschemes.txt?h=v1.7.1&id=efdc7b16e9f422f2d95271e6d4bf64dd9a03ea33'>efdc7b16 ^
|
|
Colorschemes
============
This text explains colorschemes and how they work.
Context Tags
------------
Context Tags provide information about the context. If the tag
"in_titlebar" is set, you probably want to know about the color
of a part of the titlebar now.
There are a number of context tags, specified in /ranger/gui/context.py
in the constant CONTEXT_KEYS.
A Context object, defined in the same file, contains attributes with
the names of all tags, whose values are either True or False.
Implementation in the GUI Classes
---------------------------------
The class CursesShortcuts in the file /ranger/gui/curses_shortcuts.py
defines the methods color(*tags), color_at(y, x, wid, *tags) and
color_reset(). This class is a superclass of Displayable, so these
methods are available almost everywhere.
Something like color("in_titlebar", "directory") will be called to
get the color of directories in the titlebar. This creates a
ranger.gui.context.Context object, sets its attributes "in_titlebar" and
"directory" to True, leaves the others as False, and passes it to the
colorscheme's use(context) method.
The Color Scheme
----------------
A colorscheme should be a subclass of ranger.gui.ColorScheme and
define the method use(context). By looking at the context, this use-method
has to determine a 3-tuple of integers: (foreground, background, attribute)
and return it.
foreground and background are integers representing colors,
attribute is another integer with each bit representing one attribute.
These integers are interpreted by the used terminal emulator.
Abbreviations for colors and attributes are defined in ranger.gui.color.
Two attributes can be combined via bitwise OR: bold | reverse
Once the color for a set of tags is determined, it will be cached by
default. If you want more dynamic colorschemes (such as a different
color for very large files), you will need to dig into the source code,
perhaps add an own tag and modify the draw-method of the widget to use
that tag.
Run tc_colorscheme to check if your colorschemes are valid.
Specify a Colorscheme
---------------------
Colorschemes are searched for in these directories:
~/.config/ranger/colorschemes/
/path/to/ranger/colorschemes/
To specify which colorscheme to use, define the variable "colorscheme"
in your options.py:
colorscheme = "default"
This means, use the colorscheme contained in
either ~/.config/ranger/colorschemes/default.py or
/path/to/ranger/colorschemes/default.py.
Adapt a colorscheme
-------------------
You may want to adapt a colorscheme to your needs without having
a complete copy of it, but rather the changes only. Say, you
want the exact same colors as in the default colorscheme, but
the directories to be green rather than blue, because you find the
blue hard to read.
This is done in the jungle colorscheme ranger/colorschemes/jungle,
check it out for implementation details. In short, I made a subclass
of the default scheme, set the initial colors to the result of the
default use() method and modified the colors how I wanted.
This has the obvious advantage that you need to write less, which
results in less maintainance work and a greater chance that your colorscheme
will work with future versions of ranger.
|