summary refs log tree commit diff stats
path: root/doc/pydoc/ranger.ext.human_readable.html
Commit message (Collapse)AuthorAgeFilesLines
* updated pydochut2010-03-121-11/+12
|
* incremented version number and updated pydoc html files v1.0.3hut2010-02-161-3/+3
|
* updated pydoc documentationhut2010-01-131-1/+13
|
* moved pydoc pages to doc/pydochut2009-12-251-0/+31
afad7efdc'>^
2b82ef62 ^
e3093cb0 ^
23236d0c ^
01c8834f ^
23236d0c ^
0c0b9489 ^
0b8a9d79 ^
d309f218 ^


e19f9915 ^
d309f218 ^























0b8a9d79 ^

e19f9915 ^
0b8a9d79 ^

11ee0f3e ^
0b8a9d79 ^





e19f9915 ^
0b8a9d79 ^


d309f218 ^
0b8a9d79 ^
d309f218 ^

0c0b9489 ^
0c0b9489 ^
728fb838 ^
d88232a3 ^
0c0b9489 ^

728fb838 ^
0c0b9489 ^

2c1d2db0 ^
728fb838 ^
2c1d2db0 ^




4c05e43d ^
0c0b9489 ^
2c1d2db0 ^



20f94973 ^












e07cfa31 ^


20f94973 ^














e07cfa31 ^


0c0b9489 ^
728fb838 ^
0c0b9489 ^

f2d8598d ^

0c0b9489 ^
f2d8598d ^
7d6389d6 ^
0c0b9489 ^


728fb838 ^
f2d8598d ^
0c0b9489 ^

728fb838 ^
0c0b9489 ^

84701093 ^
728fb838 ^
356592fa ^
84701093 ^
356592fa ^


0c0b9489 ^
3201b163 ^
728fb838 ^
0c0b9489 ^
3201b163 ^

0c0b9489 ^
3201b163 ^
c25ba934 ^
e3093cb0 ^
0c0b9489 ^

728fb838 ^
0c0b9489 ^


728fb838 ^
d88232a3 ^
06aefcf5 ^
5715beca ^



















b91d7c34 ^
0926ec53 ^
5715beca ^
4b826595 ^











a78cfb7e ^
4b826595 ^


6f43de0a ^




e4572991 ^



6f43de0a ^
06aefcf5 ^










0c0b9489 ^
23236d0c ^
728fb838 ^
b4b0eb24 ^



728fb838 ^
ec5dfcb1 ^


0c0b9489 ^

23236d0c ^



0c0b9489 ^
01c8834f ^
728fb838 ^
01c8834f ^




0c0b9489 ^
01c8834f ^
0c0b9489 ^
7ec262f8 ^
728fb838 ^
d88232a3 ^
7ec262f8 ^
0c0b9489 ^
84701093 ^
728fb838 ^
84701093 ^

0c0b9489 ^

728fb838 ^
5599636d ^
0c0b9489 ^
84701093 ^
c7a28738 ^




84701093 ^



4e01caf1 ^


c7a28738 ^
0c0b9489 ^
728fb838 ^
d88232a3 ^
0c0b9489 ^
5599636d ^
0c0b9489 ^
1bc3dd59 ^
728fb838 ^
1bc3dd59 ^
0c0b9489 ^

728fb838 ^
0c0b9489 ^




728fb838 ^
0c0b9489 ^

e92fe17a ^






2b82ef62 ^
fa704bab ^

a808a661 ^


0c0b9489 ^
3868dfd0 ^




a808a661 ^
3868dfd0 ^

4ab0172d ^




31642154 ^

be868b98 ^
e57c337d ^
2672dccc ^
be868b98 ^

6f43de0a ^


31642154 ^




































4ab0172d ^
e07cfa31 ^

63f22638 ^

e07cfa31 ^
31642154 ^
6a5d09b8 ^



3201b163 ^
6a5d09b8 ^





9983328c ^














6a5d09b8 ^



1743e8b9 ^

fc972ea2 ^
6a5d09b8 ^
a8407dbf ^


a808a661 ^
fc972ea2 ^




6a5d09b8 ^
6a5d09b8 ^

fc972ea2 ^





a808a661 ^
fc972ea2 ^
a808a661 ^
fc972ea2 ^
6a5d09b8 ^
fc972ea2 ^










a808a661 ^
fc972ea2 ^
a808a661 ^
fc972ea2 ^


6a5d09b8 ^

78e9f323 ^
3201b163 ^
20e031cc ^
6a5d09b8 ^

2a64495f ^
7aca88d4 ^



6a5d09b8 ^


7aca88d4 ^

6a5d09b8 ^

7aca88d4 ^



2efce540 ^









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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500













                                                                          

             
                            
 
             
                                                         
                           
                                                    
                                   
                                
 
                                               
                               


                                                   
                                      























                                                                                

                                                            
                                                      

                                                     
                                                                     





                                                                                                 
                                                              


                                                         
                                                         
                                                                           

                                                     
 
                         
                                               
                                     

                       
                                      

                                  
                                                  
                                                           




                                                         
                                               
 



                                                                          












                                                              


                                                          














                                                              


                                                          
                                      
                                                            

                                                         

                                                        
                                                         
                                                            
                                


                                    
                                                                                   
                                                  

                                      
                                                             

                                          
                                    
                                                
                    
                                                                  


                                             
        
                                     
                                                                             
                                

                                              
                                              
                               
                                                                              
                                                                           

                                       
                                                        


                                             
                                                             
                                      
        



















                                                                                             
                                                             
                                       
        











                                                                   
                                     


                                             




                                                      



                                                                           
        










                                                               
 
                                            
                                  



                                                                               
 


                                                      

                                       



                                                            
        
                                       
                                                                               




                                                             
                              
                                                       
 
                                                    
                                                                      
                                                    
                                                          
 
                                                                         
                                                                          

                                                             

                                                  
                                                               
                                                                                
 
                                                                                   




                                                                            



                                       


                                                                
 
                                   
                                                     
                                              
                                                
                                                              
 
                                
                                       
                                       

                        
                                                                          




                                                
                                                            

                                                               






                                                                    
        

                                     


                                                                         
 




                                          
                            

                                  




                                                  

                                                      
                                               
                                        
                                     

                                        


                                                                        




































                                                                         
 

                                                          

                                                         
 
                                                                    



                                             
                                                   





                                                                                   














                                                                           



                                                                         

                                                                       
                                                   
 


                                    
                                                 




                                                  
                                

                                             





                                                                                
                                                                                      
                                                     
                                                                           
                                                  
                     










                                                                                                     
                                                                                               
                                                             
                                                                           


                                                                  

                         
                                                    
                                                   
                                              

                                          
                                                                                        



                                                                               


                                                                 

                                                                               

                              



                                                                       









                                                       
# 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.

import os
import shutil
from inspect import cleandoc

import ranger
from ranger.shared import EnvironmentAware, SettingsAware
from ranger import fsobject
from ranger.gui.widgets import console_mode as cmode
from ranger.applications import run
from ranger.fsobject import File

class Actions(EnvironmentAware, SettingsAware):
	search_method = 'ctime'
	search_forward = False

	def search(self, order=None, forward=True):
		original_order = order
		if self.search_forward:
			direction = bool(forward)
		else:
			direction = not bool(forward)

		if order is None:
			order = self.search_method
		else:
			self.set_search_method(order=order)

		if order in ('search', 'tag'):
			if order == 'search':
				arg = self.env.last_search
				if arg is None:
					return False
				if hasattr(arg, 'search'):
					fnc = lambda x: arg.search(x.basename)
				else:
					fnc = lambda x: arg in x.basename
			elif order == 'tag':
				fnc = lambda x: x.realpath in self.tags

			return self.env.pwd.search_fnc(fnc=fnc, forward=forward)

		elif order in ('size', 'mimetype', 'ctime'):
			pwd = self.env.pwd
			if original_order is not None:
				lst = list(pwd.files)
				if order == 'size':
					fnc = lambda item: -item.size
				elif order == 'mimetype':
					fnc = lambda item: item.mimetype
				elif order == 'ctime':
					fnc = lambda item: -int(item.stat and item.stat.st_ctime)
				lst.sort(key=fnc)
				pwd.set_cycle_list(lst)
				return pwd.cycle(forward=None)

			return pwd.cycle(forward=forward)

	def set_search_method(self, order, forward=True):
		if order in ('search', 'tag', 'size', 'mimetype', 'ctime'):
			self.search_method = order
			self.search_forward = forward

	def resize(self):
		"""Update the size of the UI"""
		self.ui.update_size()

	def exit(self):
		"""Exit the program"""
		raise SystemExit()

	def enter_dir(self, path, remember=False):
		"""Enter the directory at the given path"""
		if remember:
			pwd = self.env.pwd
			result = self.env.enter_dir(path)
			self.bookmarks.remember(pwd)
			return result
		return self.env.enter_dir(path)

	def cd(self, path, remember=True):
		"""enter the directory at the given path, remember=True"""
		self.enter_dir(path, remember)

	def tag_toggle(self, movedown=None):
		try:
			toggle = self.tags.toggle
		except AttributeError:
			return

		sel = self.env.get_selection()
		toggle(*tuple(map(lambda x: x.realpath, sel)))

		if movedown is None:
			movedown = len(sel) == 1
		if movedown:
			self.move_pointer(relative=1)

		if hasattr(self.ui, 'redraw_main_column'):
			self.ui.redraw_main_column()
	
	def tag_remove(self, movedown=None):
		try:
			remove = self.tags.remove
		except AttributeError:
			return

		sel = self.env.get_selection()
		remove(*tuple(map(lambda x: x.realpath, sel)))

		if movedown is None:
			movedown = len(sel) == 1
		if movedown:
			self.move_pointer(relative=1)

		if hasattr(self.ui, 'redraw_main_column'):
			self.ui.redraw_main_column()

	def enter_bookmark(self, key):
		"""Enter the bookmark with the name <key>"""
		try:
			destination = self.bookmarks[key]
			pwd = self.env.pwd
			if destination.path != pwd.path:
				self.bookmarks.enter(key)
				self.bookmarks.remember(pwd)
		except KeyError:
			pass

	def set_bookmark(self, key):
		"""Set the bookmark with the name <key> to the current directory"""
		self.bookmarks[key] = self.env.pwd

	def unset_bookmark(self, key):
		"""Delete the bookmark with the name <key>"""
		self.bookmarks.delete(key)

	def move_left(self, narg=1):
		"""Enter the parent directory"""
		try:
			directory = os.path.join(*(['..'] * narg))
		except:
			return
		self.env.enter_dir(directory)
	
	def move_right(self, mode=0):
		"""Enter the current directory or execute the current file"""
		cf = self.env.cf
		sel = self.env.get_selection()

		if not self.env.enter_dir(cf):
			if sel:
				if self.execute_file(sel, mode=mode) is False:
					self.open_console(cmode.OPEN_QUICK)

	def history_go(self, relative):
		"""Move back and forth in the history"""
		self.env.history_go(relative)
	
	def handle_mouse(self):
		"""Handle mouse-buttons if one was pressed"""
		self.ui.handle_mouse()
	
	def display_command_help(self, console_widget):
		if not hasattr(self.ui, 'open_pager'):
			return

		try:
			command = console_widget._get_cmd_class()
		except:
			self.notify("Feature not available!", bad=True)
			return

		if not command:
			self.notify("Command not found!", bad=True)
			return

		if not command.__doc__:
			self.notify("Command has no docstring. Try using python without -OO",
					bad=True)
			return

		pager = self.ui.open_pager()
		lines = cleandoc(command.__doc__).split('\n')
		pager.set_source(lines)
	
	def display_help(self, topic='index', narg=None):
		if not hasattr(self.ui, 'open_pager'):
			return

		from ranger.help import get_help, get_help_by_index

		if narg is not None:
			help_text = get_help_by_index(narg)
		else:
			help_text = get_help(topic)

		pager = self.ui.open_pager()
		pager.markup = 'help'
		lines = help_text.split('\n')
		pager.set_source(lines)

	def display_log(self):
		if not hasattr(self.ui, 'open_pager'):
			return

		pager = self.ui.open_pager()
		if self.log:
			pager.set_source(["Message Log:"] + list(self.log))
		else:
			pager.set_source(["Message Log:", "No messages!"])
	
	def display_file(self):
		if not hasattr(self.ui, 'open_embedded_pager'):
			return

		try:
			f = open(self.env.cf.path, 'r')
		except:
			pass
		else:
			pager = self.ui.open_embedded_pager()
			pager.set_source(f)

	def execute_file(self, files, **kw):
		"""Execute a file.
		app is the name of a method in Applications, without the "app_"
		flags is a string consisting of applications.ALLOWED_FLAGS
		mode is a positive integer.
		Both flags and mode specify how the program is run."""

		if isinstance(files, set):
			files = list(files)
		elif type(files) not in (list, tuple):
			files = [files]

		return run(fm=self, files=list(files), **kw)

	def execute_command(self, cmd, **kw):
		return run(fm=self, action=cmd, **kw)
	
	def edit_file(self, file=None):
		"""Calls execute_file with the current file and app='editor'"""
		if file is None:
			file = self.env.cf
		elif isinstance(file, str):
			file = File(os.path.expanduser(file))
		if file is None:
			return
		self.execute_file(file, app = 'editor')

	def open_console(self, mode=':', string=''):
		"""Open the console if the current UI supports that"""
		if hasattr(self.ui, 'open_console'):
			self.ui.open_console(mode, string)

	def move_pointer(self, relative = 0, absolute = None, narg=None):
		"""Move the pointer down by <relative> or to <absolute>"""
		self.env.pwd.move(relative=relative,
				absolute=absolute, narg=narg)

	def move_pointer_by_pages(self, relative):
		"""Move the pointer down by <relative> pages"""
		self.env.pwd.move(relative=int(relative * self.env.termsize[0]))

	def move_pointer_by_percentage(self, relative=0, absolute=None, narg=None):
		"""Move the pointer down by <relative>% or to <absolute>%"""
		try:
			factor = len(self.env.pwd) / 100.0
		except:
			return

		if narg is not None:
			absolute = narg

		self.env.pwd.move(
				relative=int(relative * factor),
				absolute=int(absolute * factor))

	def scroll(self, relative):
		"""Scroll down by <relative> lines"""
		if hasattr(self.ui, 'scroll'):
			self.ui.scroll(relative)
			self.env.cf = self.env.pwd.pointed_obj

	def redraw_window(self):
		"""Redraw the window"""
		self.ui.redraw_window()

	def reset(self):
		"""Reset the filemanager, clearing the directory buffer"""
		old_path = self.env.pwd.path
		self.env.directories = {}
		self.enter_dir(old_path)

	def toggle_boolean_option(self, string):
		"""Toggle a boolean option named <string>"""
		if isinstance(self.env.settings[string], bool):
			self.env.settings[string] ^= True

	def sort(self, func=None, reverse=None):
		if reverse is not None:
			self.env.settings['reverse'] = bool(reverse)

		if func is not None:
			self.env.settings['sort'] = str(func)
	
	def force_load_preview(self):
		cf = self.env.cf
		if hasattr(cf, 'unload') and hasattr(cf, 'load_content'):
			cf.unload()
			cf.load_content()

	def reload_cwd(self):
		try:
			cwd = self.env.pwd
		except:
			pass
		cwd.unload()
		cwd.load_content()

	def set_filter(self, fltr):
		try:
			self.env.pwd.filter = fltr
		except:
			pass
	
	def notify(self, text, duration=4, bad=False):
		if isinstance(text, Exception):
			if ranger.debug:
				raise
			text = str(text)
			bad = True
		self.log.appendleft(text)
		if hasattr(self.ui, 'notify'):
			self.ui.notify(text, duration=duration, bad=bad)
	
	def mark(self, all=False, toggle=False, val=None, movedown=None):
		"""
		A wrapper for the directory.mark_xyz functions.

		Arguments:
		all - change all files of the current directory at once?
		toggle - toggle the marked-status?
		val - mark or unmark?
		"""

		if self.env.pwd is None:
			return

		pwd = self.env.pwd

		if movedown is None:
			movedown = not all

		if val is None and toggle is False:
			return

		if all:
			if toggle:
				pwd.toggle_all_marks()
			else:
				pwd.mark_all(val)
		else:
			item = self.env.cf
			if item is not None:
				if toggle:
					pwd.toggle_mark(item)
				else:
					pwd.mark_item(item, val)

		if movedown:
			self.move_pointer(relative=1)

		if hasattr(self.ui, 'redraw_main_column'):
			self.ui.redraw_main_column()
		if hasattr(self.ui, 'status'):
			self.ui.status.need_redraw = True

	# ------------------------------------ filesystem operations

	def copy(self):
		"""Copy the selected items"""

		selected = self.env.get_selection()
		self.env.copy = set(f for f in selected if f in self.env.pwd.files)
		self.env.cut = False
	
	def cut(self):
		self.copy()
		self.env.cut = True
	
	def paste_symlink(self):
		from os import symlink, getcwd
		from os.path import join

		copied_files = self.env.copy

		if not copied_files:
			return

		for f in copied_files:
			try:
				symlink(f.path, join(getcwd(), f.basename))
			except Exception as x:
				self.notify(x)

	def paste(self):
		"""Paste the selected items into the current directory"""
		from os.path import join, isdir
		from ranger.ext import shutil_generatorized as shutil_g
		from ranger.fsobject.loader import LoadableObject
		copied_files = tuple(self.env.copy)

		if not copied_files:
			return

		original_path = self.env.pwd.path
		try:
			one_file = copied_files[0]
		except:
			one_file = None

		if self.env.cut:
			self.env.copy.clear()
			self.env.cut = False
			if len(copied_files) == 1:
				descr = "moving: " + one_file.path
			else:
				descr = "moving files from: " + one_file.dirname
			def generate():
				for f in copied_files:
					for _ in shutil_g.move(f.path, original_path):
						yield
				pwd = self.env.get_directory(original_path)
				pwd.load_content()
		else:
			if len(copied_files) == 1:
				descr = "copying: " + one_file.path
			else:
				descr = "copying files from: " + one_file.dirname
			def generate():
				for f in self.env.copy:
					if isdir(f.path):
						for _ in shutil_g.copytree(f.path,
								join(self.env.pwd.path, f.basename)):
							yield
					else:
						for _ in shutil_g.copy2(f.path, original_path):
							yield
				pwd = self.env.get_directory(original_path)
				pwd.load_content()

		self.loader.add(LoadableObject(generate(), descr))

	def delete(self):
		self.notify("Deleting!", duration=1)
		selected = self.env.get_selection()
		self.env.copy -= set(selected)
		if selected:
			for f in selected:
				if os.path.isdir(f.path) and not os.path.islink(f.path):
					try:
						shutil.rmtree(f.path)
					except OSError as err:
						self.notify(str(err), bad=True)
				else:
					try:
						os.remove(f.path)
					except OSError as err:
						self.notify(str(err), bad=True)
	
	def mkdir(self, name):
		try:
			os.mkdir(os.path.join(self.env.pwd.path, name))
		except OSError as err:
			self.notify(str(err), bad=True)

	
	def rename(self, src, dest):
		if hasattr(src, 'path'):
			src = src.path

		try:
			os.rename(src, dest)
		except OSError as err:
			self.notify(str(err), bad=True)