about summary refs log tree commit diff stats
path: root/event.c
blob: c59385dc0d8bd260ab4b58067cbcebfc6bad9648 (plain) (blame)
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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
/*
 * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
 * See LICENSE file for license details.
 */
#include "dwm.h"
#include <stdlib.h>
#include <X11/keysym.h>
#include <X11/Xatom.h>

/* static */

typedef struct {
	unsigned long mod;
	KeySym keysym;
	void (*func)(Arg *arg);
	Arg arg;
} Key;

KEYS

#define CLEANMASK(mask) (mask & ~(numlockmask | LockMask))

static void
movemouse(Client *c) {
	int x1, y1, ocx, ocy, di;
	unsigned int dui;
	Window dummy;
	XEvent ev;

	ocx = c->x;
	ocy = c->y;
	if(XGrabPointer(dpy, root, False, MOUSEMASK, GrabModeAsync, GrabModeAsync,
			None, cursor[CurMove], CurrentTime) != GrabSuccess)
		return;
	XQueryPointer(dpy, root, &dummy, &dummy, &x1, &y1, &di, &di, &dui);
	for(;;) {
		XMaskEvent(dpy, MOUSEMASK | ExposureMask, &ev);
		switch (ev.type) {
		default:
			break;
		case Expose:
			handler[Expose](&ev);
			break;
		case MotionNotify:
			XSync(dpy, False);
			c->x = ocx + (ev.xmotion.x - x1);
			c->y = ocy + (ev.xmotion.y - y1);
			resize(c, False, TopLeft);
			break;
		case ButtonRelease:
			XUngrabPointer(dpy, CurrentTime);
			return;
		}
	}
}

static void
resizemouse(Client *c) {
	int ocx, ocy;
	int nw, nh;
	Corner sticky;
	XEvent ev;

	ocx = c->x;
	ocy = c->y;
	if(XGrabPointer(dpy, root, False, MOUSEMASK, GrabModeAsync, GrabModeAsync,
				None, cursor[CurResize], CurrentTime) != GrabSuccess)
		return;
	XWarpPointer(dpy, None, c->win, 0, 0, 0, 0, c->w, c->h);
	for(;;) {
		XMaskEvent(dpy, MOUSEMASK | ExposureMask, &ev);
		switch(ev.type) {
		default:
			break;
		case Expose:
			handler[Expose](&ev);
			break;
		case MotionNotify:
			XSync(dpy, False);
			if((nw = abs(ocx - ev.xmotion.x)))
				c->w = abs(ocx - ev.xmotion.x);
			if((nh = abs(ocy - ev.xmotion.y)))
				c->h = abs(ocy - ev.xmotion.y);
			c->x = (ocx <= ev.xmotion.x) ? ocx : ocx - c->w;
			c->y = (ocy <= ev.xmotion.y) ? ocy : ocy - c->h;
			if(ocx <= ev.xmotion.x)
				sticky = (ocy <= ev.xmotion.y) ? TopLeft : BotLeft;
			else
				sticky = (ocy <= ev.xmotion.y) ? TopRight : BotRight;
			resize(c, True, sticky);
			break;
		case ButtonRelease:
			XUngrabPointer(dpy, CurrentTime);
			return;
		}
	}
}

static void
buttonpress(XEvent *e) {
	int x;
	Arg a;
	Client *c;
	XButtonPressedEvent *ev = &e->xbutton;

	if(barwin == ev->window) {
		x = 0;
		for(a.i = 0; a.i < ntags; a.i++) {
			x += textw(tags[a.i]);
			if(ev->x < x) {
				if(ev->button == Button1) {
					if(ev->state & MODKEY)
						tag(&a);
					else
						view(&a);
				}
				else if(ev->button == Button3) {
					if(ev->state & MODKEY)
						toggletag(&a);
					else
						toggleview(&a);
				}
				return;
			}
		}
		if(ev->x < x + bmw) {
			if(ev->button == Button1)
				togglemode(NULL);
		}
	}
	else if((c = getclient(ev->window))) {
		focus(c);
		if(maximized || CLEANMASK(ev->state) != MODKEY)
			return;
		if(ev->button == Button1 && (arrange == dofloat || c->isfloat)) {
			restack(c);
			movemouse(c);
		}
		else if(ev->button == Button2)
			zoom(NULL);
		else if(ev->button == Button3 && (arrange == dofloat || c->isfloat)) {
			restack(c);
			resizemouse(c);
		}
	}
}

static void
synconfig(Client *c, int x, int y, int w, int h, unsigned int border) {
	XEvent synev;

	synev.type = ConfigureNotify;
	synev.xconfigure.display = dpy;
	synev.xconfigure.event = c->win;
	synev.xconfigure.window = c->win;
	synev.xconfigure.x = x;
	synev.xconfigure.y = y;
	synev.xconfigure.width = w;
	synev.xconfigure.height = h;
	synev.xconfigure.border_width = border;
	synev.xconfigure.above = None;
	XSendEvent(dpy, c->win, True, NoEventMask, &synev);
}

static void
configurerequest(XEvent *e) {
	unsigned long newmask;
	Client *c;
	XConfigureRequestEvent *ev = &e->xconfigurerequest;
	XWindowChanges wc;

	if((c = getclient(ev->window))) {
		if((c == sel) && !c->isfloat && (arrange != dofloat) && maximized) {
			synconfig(c, sx, sy + bh, sw - 2, sh - 2 - bh, ev->border_width);
			XSync(dpy, False);
			return;
		}
		gravitate(c, True);
		if(ev->value_mask & CWX)
			c->x = ev->x;
		if(ev->value_mask & CWY)
			c->y = ev->y;
		if(ev->value_mask & CWWidth)
			c->w = ev->width;
		if(ev->value_mask & CWHeight)
			c->h = ev->height;
		if(ev->value_mask & CWBorderWidth)
			c->border = ev->border_width;
		gravitate(c, False);
		wc.x = c->x;
		wc.y = c->y;
		wc.width = c->w;
		wc.height = c->h;
		newmask = ev->value_mask & (~(CWSibling | CWStackMode | CWBorderWidth));
		if(newmask)
			XConfigureWindow(dpy, c->win, newmask, &wc);
		else
			synconfig(c, c->x, c->y, c->w, c->h, c->border);
		XSync(dpy, False);
		if(c->isfloat)
			resize(c, False, TopLeft);
		else
			arrange(NULL);
	}
	else {
		wc.x = ev->x;
		wc.y = ev->y;
		wc.width = ev->width;
		wc.height = ev->height;
		wc.border_width = ev->border_width;
		wc.sibling = ev->above;
		wc.stack_mode = ev->detail;
		XConfigureWindow(dpy, ev->window, ev->value_mask, &wc);
		XSync(dpy, False);
	}
}

static void
destroynotify(XEvent *e) {
	Client *c;
	XDestroyWindowEvent *ev = &e->xdestroywindow;

	if((c = getclient(ev->window)))
		unmanage(c);
}

static void
enternotify(XEvent *e) {
	Client *c;
	XCrossingEvent *ev = &e->xcrossing;

	if(ev->mode != NotifyNormal || ev->detail == NotifyInferior)
		return;

	if((c = getclient(ev->window)) || (c = getctitle(ev->window)))
		focus(c);
	else if(ev->window == root) {
		issel = True;
		XSetInputFocus(dpy, root, RevertToPointerRoot, CurrentTime);
		drawall();
	}
}

static void
expose(XEvent *e) {
	Client *c;
	XExposeEvent *ev = &e->xexpose;

	if(ev->count == 0) {
		if(barwin == ev->window)
			drawstatus();
		else if((c = getctitle(ev->window)))
			drawtitle(c);
	}
}

static void
keypress(XEvent *e) {
	static unsigned int len = sizeof(key) / sizeof(key[0]);
	unsigned int i;
	KeySym keysym;
	XKeyEvent *ev = &e->xkey;

	keysym = XKeycodeToKeysym(dpy, (KeyCode)ev->keycode, 0);
	for(i = 0; i < len; i++) {
		if(keysym == key[i].keysym
			&& CLEANMASK(key[i].mod) == CLEANMASK(ev->state))
		{
			if(key[i].func)
				key[i].func(&key[i].arg);
			return;
		}
	}
}

static void
leavenotify(XEvent *e) {
	XCrossingEvent *ev = &e->xcrossing;

	if((ev->window == root) && !ev->same_screen) {
		issel = False;
		drawall();
	}
}

static void
mappingnotify(XEvent *e) {
	XMappingEvent *ev = &e->xmapping;

	XRefreshKeyboardMapping(ev);
	if(ev->request == MappingKeyboard)
		grabkeys();
}

static void
maprequest(XEvent *e) {
	static XWindowAttributes wa;
	XMapRequestEvent *ev = &e->xmaprequest;

	if(!XGetWindowAttributes(dpy, ev->window, &wa))
		return;

	if(wa.override_redirect) {
		XSelectInput(dpy, ev->window,
				(StructureNotifyMask | PropertyChangeMask));
		return;
	}

	if(!getclient(ev->window))
		manage(ev->window, &wa);
}

static void
propertynotify(XEvent *e) {
	Client *c;
	Window trans;
	XPropertyEvent *ev = &e->xproperty;

	if(ev->state == PropertyDelete)
		return; /* ignore */

	if((c = getclient(ev->window))) {
		if(ev->atom == wmatom[WMProtocols]) {
			c->proto = getproto(c->win);
			return;
		}
		switch (ev->atom) {
			default: break;
			case XA_WM_TRANSIENT_FOR:
				XGetTransientForHint(dpy, c->win, &trans);
				if(!c->isfloat && (c->isfloat = (trans != 0)))
					arrange(NULL);
				break;
			case XA_WM_NORMAL_HINTS:
				updatesize(c);
				break;
		}
		if(ev->atom == XA_WM_NAME || ev->atom == netatom[NetWMName]) {
			updatetitle(c);
			drawtitle(c);
		}
	}
}

static void
unmapnotify(XEvent *e) {
	Client *c;
	XUnmapEvent *ev = &e->xunmap;

	if((c = getclient(ev->window)))
		unmanage(c);
}

/* extern */

void (*handler[LASTEvent]) (XEvent *) = {
	[ButtonPress] = buttonpress,
	[ConfigureRequest] = configurerequest,
	[DestroyNotify] = destroynotify,
	[EnterNotify] = enternotify,
	[LeaveNotify] = leavenotify,
	[Expose] = expose,
	[KeyPress] = keypress,
	[MappingNotify] = mappingnotify,
	[MapRequest] = maprequest,
	[PropertyNotify] = propertynotify,
	[UnmapNotify] = unmapnotify
};

void
grabkeys() {
	static unsigned int len = sizeof(key) / sizeof(key[0]);
	unsigned int i;
	KeyCode code;

	XUngrabKey(dpy, AnyKey, AnyModifier, root);
	for(i = 0; i < len; i++) {
		code = XKeysymToKeycode(dpy, key[i].keysym);
		XGrabKey(dpy, code, key[i].mod, root, True,
				GrabModeAsync, GrabModeAsync);
		XGrabKey(dpy, code, key[i].mod | LockMask, root, True,
				GrabModeAsync, GrabModeAsync);
		XGrabKey(dpy, code, key[i].mod | numlockmask, root, True,
				GrabModeAsync, GrabModeAsync);
		XGrabKey(dpy, code, key[i].mod | numlockmask | LockMask, root, True,
				GrabModeAsync, GrabModeAsync);
	}
}

void
procevent() {
	XEvent ev;

	while(XPending(dpy)) {
		XNextEvent(dpy, &ev);
		if(handler[ev.type])
			(handler[ev.type])(&ev); /* call handler */
	}
}
ss="p">(paths_rel, path) + sep) ] if not paths: return None if len(paths) == 1: return start + paths[0] + sep return [start + dirname for dirname in paths] class chain(Command): """:chain <command1>; <command2>; ... Calls multiple commands at once, separated by semicolons. """ def execute(self): if not self.rest(1).strip(): self.fm.notify('Syntax: chain <command1>; <command2>; ...', bad=True) return for command in [s.strip() for s in self.rest(1).split(";")]: self.fm.execute_console(command) class shell(Command): escape_macros_for_shell = True def execute(self): if self.arg(1) and self.arg(1)[0] == '-': flags = self.arg(1)[1:] command = self.rest(2) else: flags = '' command = self.rest(1) if command: self.fm.execute_command(command, flags=flags) def tab(self, tabnum): from ranger.ext.get_executables import get_executables if self.arg(1) and self.arg(1)[0] == '-': command = self.rest(2) else: command = self.rest(1) start = self.line[0:len(self.line) - len(command)] try: position_of_last_space = command.rindex(" ") except ValueError: return (start + program + ' ' for program in get_executables() if program.startswith(command)) if position_of_last_space == len(command) - 1: selection = self.fm.thistab.get_selection() if len(selection) == 1: return self.line + selection[0].shell_escaped_basename + ' ' return self.line + '%s ' before_word, start_of_word = self.line.rsplit(' ', 1) return (before_word + ' ' + file.shell_escaped_basename for file in self.fm.thisdir.files or [] if file.shell_escaped_basename.startswith(start_of_word)) class open_with(Command): def execute(self): app, flags, mode = self._get_app_flags_mode(self.rest(1)) self.fm.execute_file( files=[f for f in self.fm.thistab.get_selection()], app=app, flags=flags, mode=mode) def tab(self, tabnum): return self._tab_through_executables() def _get_app_flags_mode(self, string): # pylint: disable=too-many-branches,too-many-statements """Extracts the application, flags and mode from a string. examples: "mplayer f 1" => ("mplayer", "f", 1) "atool 4" => ("atool", "", 4) "p" => ("", "p", 0) "" => None """ app = '' flags = '' mode = 0 split = string.split() if len(split) == 1: part = split[0] if self._is_app(part): app = part elif self._is_flags(part): flags = part elif self._is_mode(part): mode = part elif len(split) == 2: part0 = split[0] part1 = split[1] if self._is_app(part0): app = part0 if self._is_flags(part1): flags = part1 elif self._is_mode(part1): mode = part1 elif self._is_flags(part0): flags = part0 if self._is_mode(part1): mode = part1 elif self._is_mode(part0): mode = part0 if self._is_flags(part1): flags = part1 elif len(split) >= 3: part0 = split[0] part1 = split[1] part2 = split[2] if self._is_app(part0): app = part0 if self._is_flags(part1): flags = part1 if self._is_mode(part2): mode = part2 elif self._is_mode(part1): mode = part1 if self._is_flags(part2): flags = part2 elif self._is_flags(part0): flags = part0 if self._is_mode(part1): mode = part1 elif self._is_mode(part0): mode = part0 if self._is_flags(part1): flags = part1 return app, flags, int(mode) def _is_app(self, arg): return not self._is_flags(arg) and not arg.isdigit() @staticmethod def _is_flags(arg): from ranger.core.runner import ALLOWED_FLAGS return all(x in ALLOWED_FLAGS for x in arg) @staticmethod def _is_mode(arg): return all(x in '0123456789' for x in arg) class set_(Command): """:set <option name>=<python expression> Gives an option a new value. Use `:set <option>!` to toggle or cycle it, e.g. `:set flush_input!` """ name = 'set' # don't override the builtin set class def execute(self): name = self.arg(1) name, value, _, toggle = self.parse_setting_line_v2() if toggle: self.fm.toggle_option(name) else: self.fm.set_option_from_string(name, value) def tab(self, tabnum): # pylint: disable=too-many-return-statements from ranger.gui.colorscheme import get_all_colorschemes name, value, name_done = self.parse_setting_line() settings = self.fm.settings if not name: return sorted(self.firstpart + setting for setting in settings) if not value and not name_done: return sorted(self.firstpart + setting for setting in settings if setting.startswith(name)) if not value: value_completers = { "colorscheme": # Cycle through colorschemes when name, but no value is specified lambda: sorted(self.firstpart + colorscheme for colorscheme in get_all_colorschemes(self.fm)), "column_ratios": lambda: self.firstpart + ",".join(map(str, settings[name])), } def default_value_completer(): return self.firstpart + str(settings[name]) return value_completers.get(name, default_value_completer)() if bool in settings.types_of(name): if 'true'.startswith(value.lower()): return self.firstpart + 'True' if 'false'.startswith(value.lower()): return self.firstpart + 'False' # Tab complete colorscheme values if incomplete value is present if name == "colorscheme": return sorted(self.firstpart + colorscheme for colorscheme in get_all_colorschemes(self.fm) if colorscheme.startswith(value)) return None class setlocal(set_): """:setlocal path=<regular expression> <option name>=<python expression> Gives an option a new value. """ PATH_RE_DQUOTED = re.compile(r'^setlocal\s+path="(.*?)"') PATH_RE_SQUOTED = re.compile(r"^setlocal\s+path='(.*?)'") PATH_RE_UNQUOTED = re.compile(r'^path=(.*?)$') def _re_shift(self, match): if not match: return None path = os.path.expanduser(match.group(1)) for _ in range(len(path.split())): self.shift() return path def execute(self): path = self._re_shift(self.PATH_RE_DQUOTED.match(self.line)) if path is None: path = self._re_shift(self.PATH_RE_SQUOTED.match(self.line)) if path is None: path = self._re_shift(self.PATH_RE_UNQUOTED.match(self.arg(1))) if path is None and self.fm.thisdir: path = self.fm.thisdir.path if not path: return name, value, _ = self.parse_setting_line() self.fm.set_option_from_string(name, value, localpath=path) class setintag(set_): """:setintag <tag or tags> <option name>=<option value> Sets an option for directories that are tagged with a specific tag. """ def execute(self): tags = self.arg(1) self.shift() name, value, _ = self.parse_setting_line() self.fm.set_option_from_string(name, value, tags=tags) class default_linemode(Command): def execute(self): from ranger.container.fsobject import FileSystemObject if len(self.args) < 2: self.fm.notify( "Usage: default_linemode [path=<regexp> | tag=<tag(s)>] <linemode>", bad=True) # Extract options like "path=..." or "tag=..." from the command line arg1 = self.arg(1) method = "always" argument = None if arg1.startswith("path="): method = "path" argument = re.compile(arg1[5:]) self.shift() elif arg1.startswith("tag="): method = "tag" argument = arg1[4:] self.shift() # Extract and validate the line mode from the command line lmode = self.rest(1) if lmode not in FileSystemObject.linemode_dict: self.fm.notify( "Invalid linemode: %s; should be %s" % ( lmode, "/".join(FileSystemObject.linemode_dict)), bad=True, ) # Add the prepared entry to the fm.default_linemodes entry = [method, argument, lmode] self.fm.default_linemodes.appendleft(entry) # Redraw the columns if self.fm.ui.browser: for col in self.fm.ui.browser.columns: col.need_redraw = True def tab(self, tabnum): return (self.arg(0) + " " + lmode for lmode in self.fm.thisfile.linemode_dict.keys() if lmode.startswith(self.arg(1))) class quit(Command): # pylint: disable=redefined-builtin """:quit Closes the current tab, if there's only one tab. Otherwise quits if there are no tasks in progress. """ def _exit_no_work(self): if self.fm.loader.has_work(): self.fm.notify('Not quitting: Tasks in progress: Use `quit!` to force quit') else: self.fm.exit() def execute(self): if len(self.fm.tabs) >= 2: self.fm.tab_close() else: self._exit_no_work() class quit_bang(Command): """:quit! Closes the current tab, if there's only one tab. Otherwise force quits immediately. """ name = 'quit!' allow_abbrev = False def execute(self): if len(self.fm.tabs) >= 2: self.fm.tab_close() else: self.fm.exit() class quitall(Command): """:quitall Quits if there are no tasks in progress. """ def _exit_no_work(self): if self.fm.loader.has_work(): self.fm.notify('Not quitting: Tasks in progress: Use `quitall!` to force quit') else: self.fm.exit() def execute(self): self._exit_no_work() class quitall_bang(Command): """:quitall! Force quits immediately. """ name = 'quitall!' allow_abbrev = False def execute(self): self.fm.exit() class terminal(Command): """:terminal Spawns an "x-terminal-emulator" starting in the current directory. """ def execute(self): from ranger.ext.get_executables import get_term self.fm.run(get_term(), flags='f') class delete(Command): """:delete Tries to delete the selection or the files passed in arguments (if any). The arguments use a shell-like escaping. "Selection" is defined as all the "marked files" (by default, you can mark files with space or v). If there are no marked files, use the "current file" (where the cursor is) When attempting to delete non-empty directories or multiple marked files, it will require a confirmation. """ allow_abbrev = False escape_macros_for_shell = True def execute(self): import shlex from functools import partial def is_directory_with_files(path): return os.path.isdir(path) and not os.path.islink(path) and len(os.listdir(path)) > 0 if self.rest(1): files = shlex.split(self.rest(1)) many_files = (len(files) > 1 or is_directory_with_files(files[0])) else: cwd = self.fm.thisdir tfile = self.fm.thisfile if not cwd or not tfile: self.fm.notify("Error: no file selected for deletion!", bad=True) return # relative_path used for a user-friendly output in the confirmation. files = [f.relative_path for f in self.fm.thistab.get_selection()] many_files = (cwd.marked_items or is_directory_with_files(tfile.path)) confirm = self.fm.settings.confirm_on_delete if confirm != 'never' and (confirm != 'multiple' or many_files): self.fm.ui.console.ask( "Confirm deletion of: %s (y/N)" % ', '.join(files), partial(self._question_callback, files), ('n', 'N', 'y', 'Y'), ) else: # no need for a confirmation, just delete self.fm.delete(files) def tab(self, tabnum): return self._tab_directory_content() def _question_callback(self, files, answer): if answer == 'y' or answer == 'Y': self.fm.delete(files) class jump_non(Command): """:jump_non [-FLAGS...] Jumps to first non-directory if highlighted file is a directory and vice versa. Flags: -r Jump in reverse order -w Wrap around if reaching end of filelist """ def __init__(self, *args, **kwargs): super(jump_non, self).__init__(*args, **kwargs) flags, _ = self.parse_flags() self._flag_reverse = 'r' in flags self._flag_wrap = 'w' in flags @staticmethod def _non(fobj, is_directory): return fobj.is_directory if not is_directory else not fobj.is_directory def execute(self): tfile = self.fm.thisfile passed = False found_before = None found_after = None for fobj in self.fm.thisdir.files[::-1] if self._flag_reverse else self.fm.thisdir.files: if fobj.path == tfile.path: passed = True continue if passed: if self._non(fobj, tfile.is_directory): found_after = fobj.path break elif not found_before and self._non(fobj, tfile.is_directory): found_before = fobj.path if found_after: self.fm.select_file(found_after) elif self._flag_wrap and found_before: self.fm.select_file(found_before) class mark_tag(Command): """:mark_tag [<tags>] Mark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are marked. """ do_mark = True def execute(self): cwd = self.fm.thisdir tags = self.rest(1).replace(" ", "") if not self.fm.tags or not cwd.files: return for fileobj in cwd.files: try: tag = self.fm.tags.tags[fileobj.realpath] except KeyError: continue if not tags or tag in tags: cwd.mark_item(fileobj, val=self.do_mark) self.fm.ui.status.need_redraw = True self.fm.ui.need_redraw = True class console(Command): """:console <command> Open the console with the given command. """ def execute(self): position = None if self.arg(1)[0:2] == '-p': try: position = int(self.arg(1)[2:]) except ValueError: pass else: self.shift() self.fm.open_console(self.rest(1), position=position) class load_copy_buffer(Command): """:load_copy_buffer Load the copy buffer from datadir/copy_buffer """ copy_buffer_filename = 'copy_buffer' def execute(self): import sys from ranger.container.file import File from os.path import exists fname = self.fm.datapath(self.copy_buffer_filename) unreadable = IOError if sys.version_info[0] < 3 else OSError try: fobj = open(fname, 'r') except unreadable: return self.fm.notify( "Cannot open %s" % (fname or self.copy_buffer_filename), bad=True) self.fm.copy_buffer = set(File(g) for g in fobj.read().split("\n") if exists(g)) fobj.close() self.fm.ui.redraw_main_column() return None class save_copy_buffer(Command): """:save_copy_buffer Save the copy buffer to datadir/copy_buffer """ copy_buffer_filename = 'copy_buffer' def execute(self): import sys fname = None fname = self.fm.datapath(self.copy_buffer_filename) unwritable = IOError if sys.version_info[0] < 3 else OSError try: fobj = open(fname, 'w') except unwritable: return self.fm.notify("Cannot open %s" % (fname or self.copy_buffer_filename), bad=True) fobj.write("\n".join(fobj.path for fobj in self.fm.copy_buffer)) fobj.close() return None class unmark_tag(mark_tag): """:unmark_tag [<tags>] Unmark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are unmarked. """ do_mark = False class mkdir(Command): """:mkdir <dirname> Creates a directory with the name <dirname>. """ def execute(self): from os.path import join, expanduser, lexists from os import makedirs dirname = join(self.fm.thisdir.path, expanduser(self.rest(1))) if not lexists(dirname): makedirs(dirname) else: self.fm.notify("file/directory exists!", bad=True) def tab(self, tabnum): return self._tab_directory_content() class touch(Command): """:touch <fname> Creates a file with the name <fname>. """ def execute(self): from os.path import join, expanduser, lexists fname = join(self.fm.thisdir.path, expanduser(self.rest(1))) if not lexists(fname): open(fname, 'a').close() else: self.fm.notify("file/directory exists!", bad=True) def tab(self, tabnum): return self._tab_directory_content() class edit(Command): """:edit <filename> Opens the specified file in vim """ def execute(self): if not self.arg(1): self.fm.edit_file(self.fm.thisfile.path) else: self.fm.edit_file(self.rest(1)) def tab(self, tabnum): return self._tab_directory_content() class eval_(Command): """:eval [-q] <python code> Evaluates the python code. `fm' is a reference to the FM instance. To display text, use the function `p'. Examples: :eval fm :eval len(fm.directories) :eval p("Hello World!") """ name = 'eval' resolve_macros = False def execute(self): # The import is needed so eval() can access the ranger module import ranger # NOQA pylint: disable=unused-import,unused-variable if self.arg(1) == '-q': code = self.rest(2) quiet = True else: code = self.rest(1) quiet = False global cmd, fm, p, quantifier # pylint: disable=invalid-name,global-variable-undefined fm = self.fm cmd = self.fm.execute_console p = fm.notify quantifier = self.quantifier try: try: result = eval(code) # pylint: disable=eval-used except SyntaxError: exec(code) # pylint: disable=exec-used else: if result and not quiet: p(result) except Exception as err: # pylint: disable=broad-except fm.notify("The error `%s` was caused by evaluating the " "following code: `%s`" % (err, code), bad=True) class rename(Command): """:rename <newname> Changes the name of the currently highlighted file to <newname> """ def execute(self): from ranger.container.file import File from os import access new_name = self.rest(1) if not new_name: return self.fm.notify('Syntax: rename <newname>', bad=True) if new_name == self.fm.thisfile.relative_path: return None if access(new_name, os.F_OK): return self.fm.notify("Can't rename: file already exists!", bad=True) if self.fm.rename(self.fm.thisfile, new_name): file_new = File(new_name) self.fm.bookmarks.update_path(self.fm.thisfile.path, file_new) self.fm.tags.update_path(self.fm.thisfile.path, file_new.path) self.fm.thisdir.pointed_obj = file_new self.fm.thisfile = file_new return None def tab(self, tabnum): return self._tab_directory_content() class rename_append(Command): """:rename_append [-FLAGS...] Opens the console with ":rename <current file>" with the cursor positioned before the file extension. Flags: -a Position before all extensions -r Remove everything before extensions """ def __init__(self, *args, **kwargs): super(rename_append, self).__init__(*args, **kwargs) flags, _ = self.parse_flags() self._flag_ext_all = 'a' in flags self._flag_remove = 'r' in flags def execute(self): from ranger import MACRO_DELIMITER, MACRO_DELIMITER_ESC tfile = self.fm.thisfile relpath = tfile.relative_path.replace(MACRO_DELIMITER, MACRO_DELIMITER_ESC) basename = tfile.basename.replace(MACRO_DELIMITER, MACRO_DELIMITER_ESC) if basename.find('.') <= 0: self.fm.open_console('rename ' + relpath) return if self._flag_ext_all: pos_ext = re.search(r'[^.]+', basename).end(0) else: pos_ext = basename.rindex('.') pos = len(relpath) - len(basename) + pos_ext if self._flag_remove: relpath = relpath[:-len(basename)] + basename[pos_ext:] pos -= pos_ext self.fm.open_console('rename ' + relpath, position=(7 + pos)) class chmod(Command): """:chmod <octal number> Sets the permissions of the selection to the octal number. The octal number is between 0 and 777. The digits specify the permissions for the user, the group and others. A 1 permits execution, a 2 permits writing, a 4 permits reading. Add those numbers to combine them. So a 7 permits everything. """ def execute(self): mode_str = self.rest(1) if not mode_str: if not self.quantifier: self.fm.notify("Syntax: chmod <octal number>", bad=True) return mode_str = str(self.quantifier) try: mode = int(mode_str, 8) if mode < 0 or mode > 0o777: raise ValueError except ValueError: self.fm.notify("Need an octal number between 0 and 777!", bad=True) return for fobj in self.fm.thistab.get_selection(): try: os.chmod(fobj.path, mode) except OSError as ex: self.fm.notify(ex) # reloading directory. maybe its better to reload the selected # files only. self.fm.thisdir.content_outdated = True class bulkrename(Command): """:bulkrename This command opens a list of selected files in an external editor. After you edit and save the file, it will generate a shell script which does bulk renaming according to the changes you did in the file. This shell script is opened in an editor for you to review. After you close it, it will be executed. """ def execute(self): # pylint: disable=too-many-locals,too-many-statements import sys import tempfile from ranger.container.file import File from ranger.ext.shell_escape import shell_escape as esc py3 = sys.version_info[0] >= 3 # Create and edit the file list filenames = [f.relative_path for f in self.fm.thistab.get_selection()] listfile = tempfile.NamedTemporaryFile(delete=False) listpath = listfile.name if py3: listfile.write("\n".join(filenames).encode("utf-8")) else: listfile.write("\n".join(filenames)) listfile.close() self.fm.execute_file([File(listpath)], app='editor') listfile = open(listpath, 'r') new_filenames = listfile.read().split("\n") listfile.close() os.unlink(listpath) if all(a == b for a, b in zip(filenames, new_filenames)): self.fm.notify("No renaming to be done!") return # Generate script cmdfile = tempfile.NamedTemporaryFile() script_lines = [] script_lines.append("# This file will be executed when you close the editor.\n") script_lines.append("# Please double-check everything, clear the file to abort.\n") script_lines.extend("mv -vi -- %s %s\n" % (esc(old), esc(new)) for old, new in zip(filenames, new_filenames) if old != new) script_content = "".join(script_lines) if py3: cmdfile.write(script_content.encode("utf-8")) else: cmdfile.write(script_content) cmdfile.flush() # Open the script and let the user review it, then check if the script # was modified by the user self.fm.execute_file([File(cmdfile.name)], app='editor') cmdfile.seek(0) script_was_edited = (script_content != cmdfile.read()) # Do the renaming self.fm.run(['/bin/sh', cmdfile.name], flags='w') cmdfile.close() # Retag the files, but only if the script wasn't changed during review, # because only then we know which are the source and destination files. if not script_was_edited: tags_changed = False for old, new in zip(filenames, new_filenames): if old != new: oldpath = self.fm.thisdir.path + '/' + old newpath = self.fm.thisdir.path + '/' + new if oldpath in self.fm.tags: old_tag = self.fm.tags.tags[oldpath] self.fm.tags.remove(oldpath) self.fm.tags.tags[newpath] = old_tag tags_changed = True if tags_changed: self.fm.tags.dump() else: fm.notify("files have not been retagged") class relink(Command): """:relink <newpath> Changes the linked path of the currently highlighted symlink to <newpath> """ def execute(self): new_path = self.rest(1) tfile = self.fm.thisfile if not new_path: return self.fm.notify('Syntax: relink <newpath>', bad=True) if not tfile.is_link: return self.fm.notify('%s is not a symlink!' % tfile.relative_path, bad=True) if new_path == os.readlink(tfile.path): return None try: os.remove(tfile.path) os.symlink(new_path, tfile.path) except OSError as err: self.fm.notify(err) self.fm.reset() self.fm.thisdir.pointed_obj = tfile self.fm.thisfile = tfile return None def tab(self, tabnum): if not self.rest(1): return self.line + os.readlink(self.fm.thisfile.path) return self._tab_directory_content() class help_(Command): """:help Display ranger's manual page. """ name = 'help' def execute(self): def callback(answer): if answer == "q": return elif answer == "m": self.fm.display_help() elif answer == "c": self.fm.dump_commands() elif answer == "k": self.fm.dump_keybindings() elif answer == "s": self.fm.dump_settings() self.fm.ui.console.ask( "View [m]an page, [k]ey bindings, [c]ommands or [s]ettings? (press q to abort)", callback, list("mqkcs") ) class copymap(Command): """:copymap <keys> <newkeys1> [<newkeys2>...] Copies a "browser" keybinding from <keys> to <newkeys> """ context = 'browser' def execute(self): if not self.arg(1) or not self.arg(2): return self.fm.notify("Not enough arguments", bad=True) for arg in self.args[2:]: self.fm.ui.keymaps.copy(self.context, self.arg(1), arg) return None class copypmap(copymap): """:copypmap <keys> <newkeys1> [<newkeys2>...] Copies a "pager" keybinding from <keys> to <newkeys> """ context = 'pager' class copycmap(copymap): """:copycmap <keys> <newkeys1> [<newkeys2>...] Copies a "console" keybinding from <keys> to <newkeys> """ context = 'console' class copytmap(copymap): """:copycmap <keys> <newkeys1> [<newkeys2>...] Copies a "taskview" keybinding from <keys> to <newkeys> """ context = 'taskview' class unmap(Command): """:unmap <keys> [<keys2>, ...] Remove the given "browser" mappings """ context = 'browser' def execute(self): for arg in self.args[1:]: self.fm.ui.keymaps.unbind(self.context, arg) class cunmap(unmap): """:cunmap <keys> [<keys2>, ...] Remove the given "console" mappings """ context = 'browser' class punmap(unmap): """:punmap <keys> [<keys2>, ...] Remove the given "pager" mappings """ context = 'pager' class tunmap(unmap): """:tunmap <keys> [<keys2>, ...] Remove the given "taskview" mappings """ context = 'taskview' class map_(Command): """:map <keysequence> <command> Maps a command to a keysequence in the "browser" context. Example: map j move down map J move down 10 """ name = 'map' context = 'browser' resolve_macros = False def execute(self): if not self.arg(1) or not self.arg(2): self.fm.notify("Syntax: {0} <keysequence> <command>".format(self.get_name()), bad=True) return self.fm.ui.keymaps.bind(self.context, self.arg(1), self.rest(2)) class cmap(map_): """:cmap <keysequence> <command> Maps a command to a keysequence in the "console" context. Example: cmap <ESC> console_close cmap <C-x> console_type test """ context = 'console' class tmap(map_): """:tmap <keysequence> <command> Maps a command to a keysequence in the "taskview" context. """ context = 'taskview' class pmap(map_): """:pmap <keysequence> <command> Maps a command to a keysequence in the "pager" context. """ context = 'pager' class scout(Command): """:scout [-FLAGS...] <pattern> Swiss army knife command for searching, traveling and filtering files. Flags: -a Automatically open a file on unambiguous match -e Open the selected file when pressing enter -f Filter files that match the current search pattern -g Interpret pattern as a glob pattern -i Ignore the letter case of the files -k Keep the console open when changing a directory with the command -l Letter skipping; e.g. allow "rdme" to match the file "readme" -m Mark the matching files after pressing enter -M Unmark the matching files after pressing enter -p Permanent filter: hide non-matching files after pressing enter -r Interpret pattern as a regular expression pattern -s Smart case; like -i unless pattern contains upper case letters -t Apply filter and search pattern as you type -v Inverts the match Multiple flags can be combined. For example, ":scout -gpt" would create a :filter-like command using globbing. """ # pylint: disable=bad-whitespace AUTO_OPEN = 'a' OPEN_ON_ENTER = 'e' FILTER = 'f' SM_GLOB = 'g' IGNORE_CASE = 'i' KEEP_OPEN = 'k' SM_LETTERSKIP = 'l' MARK = 'm' UNMARK = 'M' PERM_FILTER = 'p' SM_REGEX = 'r' SMART_CASE = 's' AS_YOU_TYPE = 't' INVERT = 'v' # pylint: enable=bad-whitespace def __init__(self, *args, **kwargs): super(scout, self).__init__(*args, **kwargs) self._regex = None self.flags, self.pattern = self.parse_flags() def execute(self): # pylint: disable=too-many-branches thisdir = self.fm.thisdir flags = self.flags pattern = self.pattern regex = self._build_regex() count = self._count(move=True) self.fm.thistab.last_search = regex self.fm.set_search_method(order="search") if (self.MARK in flags or self.UNMARK in flags) and thisdir.files: value = flags.find(self.MARK) > flags.find(self.UNMARK) if self.FILTER in flags: for fobj in thisdir.files: thisdir.mark_item(fobj, value) else: for fobj in thisdir.files: if regex.search(fobj.relative_path): thisdir.mark_item(fobj, value) if self.PERM_FILTER in flags: thisdir.filter = regex if pattern else None # clean up: self.cancel() if self.OPEN_ON_ENTER in flags or \ (self.AUTO_OPEN in flags and count == 1): if pattern == '..': self.fm.cd(pattern) else: self.fm.move(right=1) if self.KEEP_OPEN in flags and thisdir != self.fm.thisdir: # reopen the console: if not pattern: self.fm.open_console(self.line) else: self.fm.open_console(self.line[0:-len(pattern)]) if self.quickly_executed and thisdir != self.fm.thisdir and pattern != "..": self.fm.block_input(0.5) def cancel(self): self.fm.thisdir.temporary_filter = None self.fm.thisdir.refilter() def quick(self): asyoutype = self.AS_YOU_TYPE in self.flags if self.FILTER in self.flags: self.fm.thisdir.temporary_filter = self._build_regex() if self.PERM_FILTER in self.flags and asyoutype: self.fm.thisdir.filter = self._build_regex() if self.FILTER in self.flags or self.PERM_FILTER in self.flags: self.fm.thisdir.refilter() if self._count(move=asyoutype) == 1 and self.AUTO_OPEN in self.flags: return True return False def tab(self, tabnum): self._count(move=True, offset=tabnum) def _build_regex(self): if self._regex is not None: return self._regex frmat = "%s" flags = self.flags pattern = self.pattern if pattern == ".": return re.compile("") # Handle carets at start and dollar signs at end separately if pattern.startswith('^'): pattern = pattern[1:] frmat = "^" + frmat if pattern.endswith('$'): pattern = pattern[:-1] frmat += "$" # Apply one of the search methods if self.SM_REGEX in flags: regex = pattern elif self.SM_GLOB in flags: regex = re.escape(pattern).replace("\\*", ".*").replace("\\?", ".") elif self.SM_LETTERSKIP in flags: regex = ".*".join(re.escape(c) for c in pattern) else: regex = re.escape(pattern) regex = frmat % regex # Invert regular expression if necessary if self.INVERT in flags: regex = "^(?:(?!%s).)*$" % regex # Compile Regular Expression # pylint: disable=no-member options = re.UNICODE if self.IGNORE_CASE in flags or self.SMART_CASE in flags and \ pattern.islower(): options |= re.IGNORECASE # pylint: enable=no-member try: self._regex = re.compile(regex, options) except re.error: self._regex = re.compile("") return self._regex def _count(self, move=False, offset=0): count = 0 cwd = self.fm.thisdir pattern = self.pattern if not pattern or not cwd.files: return 0 if pattern == '.': return 0 if pattern == '..': return 1 deq = deque(cwd.files) deq.rotate(-cwd.pointer - offset) i = offset regex = self._build_regex() for fsobj in deq: if regex.search(fsobj.relative_path): count += 1 if move and count == 1: cwd.move(to=(cwd.pointer + i) % len(cwd.files)) self.fm.thisfile = cwd.pointed_obj if count > 1: return count i += 1 return count == 1 class narrow(Command): """ :narrow Show only the files selected right now. If no files are selected, disable narrowing. """ def execute(self): if self.fm.thisdir.marked_items: selection = [f.basename for f in self.fm.thistab.get_selection()] self.fm.thisdir.narrow_filter = selection else: self.fm.thisdir.narrow_filter = None self.fm.thisdir.refilter() class filter_inode_type(Command): """ :filter_inode_type [dfl] Displays only the files of specified inode type. Parameters can be combined. d display directories f display files l display links """ def execute(self): if not self.arg(1): self.fm.thisdir.inode_type_filter = "" else: self.fm.thisdir.inode_type_filter = self.arg(1) self.fm.thisdir.refilter() class grep(Command): """:grep <string> Looks for a string in all marked files or directories """ def execute(self): if self.rest(1): action = ['grep', '--line-number'] action.extend(['-e', self.rest(1), '-r']) action.extend(f.path for f in self.fm.thistab.get_selection()) self.fm.execute_command(action, flags='p') class flat(Command): """ :flat <level> Flattens the directory view up to the specified level. -1 fully flattened 0 remove flattened view """ def execute(self): try: level_str = self.rest(1) level = int(level_str) except ValueError: level = self.quantifier if level is None: self.fm.notify("Syntax: flat <level>", bad=True) return if level < -1: self.fm.notify("Need an integer number (-1, 0, 1, ...)", bad=True) self.fm.thisdir.unload() self.fm.thisdir.flat = level self.fm.thisdir.load_content() # Version control commands # -------------------------------- class stage(Command): """ :stage Stage selected files for the corresponding version control system """ def execute(self): from ranger.ext.vcs import VcsError if self.fm.thisdir.vcs and self.fm.thisdir.vcs.track: filelist = [f.path for f in self.fm.thistab.get_selection()] try: self.fm.thisdir.vcs.action_add(filelist) except VcsError as ex: self.fm.notify('Unable to stage files: {0}'.format(ex)) self.fm.ui.vcsthread.process(self.fm.thisdir) else: self.fm.notify('Unable to stage files: Not in repository') class unstage(Command): """ :unstage Unstage selected files for the corresponding version control system """ def execute(self): from ranger.ext.vcs import VcsError if self.fm.thisdir.vcs and self.fm.thisdir.vcs.track: filelist = [f.path for f in self.fm.thistab.get_selection()] try: self.fm.thisdir.vcs.action_reset(filelist) except VcsError as ex: self.fm.notify('Unable to unstage files: {0}'.format(ex)) self.fm.ui.vcsthread.process(self.fm.thisdir) else: self.fm.notify('Unable to unstage files: Not in repository') # Metadata commands # -------------------------------- class prompt_metadata(Command): """ :prompt_metadata <key1> [<key2> [<key3> ...]] Prompt the user to input metadata for multiple keys in a row. """ _command_name = "meta" _console_chain = None def execute(self): prompt_metadata._console_chain = self.args[1:] self._process_command_stack() def _process_command_stack(self): if prompt_metadata._console_chain: key = prompt_metadata._console_chain.pop() self._fill_console(key) else: for col in self.fm.ui.browser.columns: col.need_redraw = True def _fill_console(self, key): metadata = self.fm.metadata.get_metadata(self.fm.thisfile.path) if key in metadata and metadata[key]: existing_value = metadata[key] else: existing_value = "" text = "%s %s %s" % (self._command_name, key, existing_value) self.fm.open_console(text, position=len(text)) class meta(prompt_metadata): """ :meta <key> [<value>] Change metadata of a file. Deletes the key if value is empty. """ def execute(self): key = self.arg(1) update_dict = dict() update_dict[key] = self.rest(2) selection = self.fm.thistab.get_selection() for fobj in selection: self.fm.metadata.set_metadata(fobj.path, update_dict) self._process_command_stack() def tab(self, tabnum): key = self.arg(1) metadata = self.fm.metadata.get_metadata(self.fm.thisfile.path) if key in metadata and metadata[key]: return [" ".join([self.arg(0), self.arg(1), metadata[key]])] return [self.arg(0) + " " + k for k in sorted(metadata) if k.startswith(self.arg(1))] class linemode(default_linemode): """ :linemode <mode> Change what is displayed as a filename. - "mode" may be any of the defined linemodes (see: ranger.core.linemode). "normal" is mapped to "filename". """ def execute(self): mode = self.arg(1) if mode == "normal": from ranger.core.linemode import DEFAULT_LINEMODE mode = DEFAULT_LINEMODE if mode not in self.fm.thisfile.linemode_dict: self.fm.notify("Unhandled linemode: `%s'" % mode, bad=True) return self.fm.thisdir.set_linemode_of_children(mode) # Ask the browsercolumns to redraw for col in self.fm.ui.browser.columns: col.need_redraw = True class yank(Command): """:yank [name|dir|path] Copies the file's name (default), directory or path into both the primary X selection and the clipboard. """ modes = { '': 'basename', 'name': 'basename', 'dir': 'dirname', 'path': 'path', } def execute(self): import subprocess def clipboards(): from ranger.ext.get_executables import get_executables clipboard_managers = { 'xclip': [ ['xclip'], ['xclip', '-selection', 'clipboard'], ], 'xsel': [ ['xsel'], ['xsel', '-b'], ], 'pbcopy': [ ['pbcopy'], ], } ordered_managers = ['pbcopy', 'xclip', 'xsel'] executables = get_executables() for manager in ordered_managers: if manager in executables: return clipboard_managers[manager] return [] clipboard_commands = clipboards() selection = self.get_selection_attr(self.modes[self.arg(1)]) new_clipboard_contents = "\n".join(selection) for command in clipboard_commands: process = subprocess.Popen(command, universal_newlines=True, stdin=subprocess.PIPE) process.communicate(input=new_clipboard_contents) def get_selection_attr(self, attr): return [getattr(item, attr) for item in self.fm.thistab.get_selection()] def tab(self, tabnum): return ( self.start(1) + mode for mode in sorted(self.modes.keys()) if mode )