em-unix.el 37.7 KB
Newer Older
1
;;; em-unix.el --- UNIX command aliases
Gerd Moellmann's avatar
Gerd Moellmann committed
2

3
;; Copyright (C) 1999-2011  Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
4

Gerd Moellmann's avatar
Gerd Moellmann committed
5 6
;; Author: John Wiegley <johnw@gnu.org>

Gerd Moellmann's avatar
Gerd Moellmann committed
7 8
;; This file is part of GNU Emacs.

9
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
10
;; it under the terms of the GNU General Public License as published by
11 12
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
13 14 15 16 17 18 19

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
20
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
21

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
;;; Commentary:

;; This file contains implementations of several UNIX command in Emacs
;; Lisp, for several reasons:
;;
;;   1) it makes them available on all platforms where the Lisp
;;      functions used are available
;;
;;   2) it makes their functionality accessible and modified by the
;;      Lisp programmer.
;;
;;   3) it allows Eshell to refrain from having to invoke external
;;      processes for common operations.

;;; Code:
Gerd Moellmann's avatar
Gerd Moellmann committed
37

38
(require 'eshell)
Michael Albinus's avatar
Michael Albinus committed
39 40
(require 'esh-opt)
(require 'pcomplete)
Gerd Moellmann's avatar
Gerd Moellmann committed
41

42 43
;;;###autoload
(eshell-defgroup eshell-unix nil
Gerd Moellmann's avatar
Gerd Moellmann committed
44 45 46 47 48 49 50 51 52 53 54 55
  "This module defines many of the more common UNIX utilities as
aliases implemented in Lisp.  These include mv, ln, cp, rm, etc.  If
the user passes arguments which are too complex, or are unrecognized
by the Lisp variant, the external version will be called (if
available).  The only reason not to use them would be because they are
usually much slower.  But in several cases their tight integration
with Eshell makes them more versatile than their traditional cousins
\(such as being able to use `kill' to kill Eshell background processes
by name)."
  :tag "UNIX commands in Lisp"
  :group 'eshell-module)

56
(defcustom eshell-unix-load-hook nil
Glenn Morris's avatar
Glenn Morris committed
57
  "A list of functions to run when `eshell-unix' is loaded."
58
  :version "24.1"			; removed eshell-unix-initialize
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61 62
  :type 'hook
  :group 'eshell-unix)

(defcustom eshell-plain-grep-behavior nil
Glenn Morris's avatar
Glenn Morris committed
63
  "If non-nil, standalone \"grep\" commands will behave normally.
Gerd Moellmann's avatar
Gerd Moellmann committed
64 65 66 67 68 69
Standalone in this context means not redirected, and not on the
receiving side of a command pipeline."
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-no-grep-available (not (eshell-search-path "grep"))
Glenn Morris's avatar
Glenn Morris committed
70
  "If non-nil, no grep is available on the current machine."
Gerd Moellmann's avatar
Gerd Moellmann committed
71 72 73 74
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-plain-diff-behavior nil
Glenn Morris's avatar
Glenn Morris committed
75
  "If non-nil, standalone \"diff\" commands will behave normally.
Gerd Moellmann's avatar
Gerd Moellmann committed
76 77 78 79 80
Standalone in this context means not redirected, and not on the
receiving side of a command pipeline."
  :type 'boolean
  :group 'eshell-unix)

81
(defcustom eshell-plain-locate-behavior (featurep 'xemacs)
Glenn Morris's avatar
Glenn Morris committed
82
  "If non-nil, standalone \"locate\" commands will behave normally.
Gerd Moellmann's avatar
Gerd Moellmann committed
83 84 85 86 87 88
Standalone in this context means not redirected, and not on the
receiving side of a command pipeline."
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-rm-removes-directories nil
Glenn Morris's avatar
Glenn Morris committed
89
  "If non-nil, `rm' will remove directory entries.
Gerd Moellmann's avatar
Gerd Moellmann committed
90 91 92 93 94
Otherwise, `rmdir' is required."
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-rm-interactive-query (= (user-uid) 0)
Glenn Morris's avatar
Glenn Morris committed
95
  "If non-nil, `rm' will query before removing anything."
Gerd Moellmann's avatar
Gerd Moellmann committed
96 97 98 99
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-mv-interactive-query (= (user-uid) 0)
Glenn Morris's avatar
Glenn Morris committed
100
  "If non-nil, `mv' will query before overwriting anything."
Gerd Moellmann's avatar
Gerd Moellmann committed
101 102 103 104
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-mv-overwrite-files t
Glenn Morris's avatar
Glenn Morris committed
105
  "If non-nil, `mv' will overwrite files without warning."
Gerd Moellmann's avatar
Gerd Moellmann committed
106 107 108 109
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-cp-interactive-query (= (user-uid) 0)
Glenn Morris's avatar
Glenn Morris committed
110
  "If non-nil, `cp' will query before overwriting anything."
Gerd Moellmann's avatar
Gerd Moellmann committed
111 112 113 114
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-cp-overwrite-files t
Glenn Morris's avatar
Glenn Morris committed
115
  "If non-nil, `cp' will overwrite files without warning."
Gerd Moellmann's avatar
Gerd Moellmann committed
116 117 118 119
  :type 'boolean
  :group 'eshell-unix)

(defcustom eshell-ln-interactive-query (= (user-uid) 0)
Glenn Morris's avatar
Glenn Morris committed
120
  "If non-nil, `ln' will query before overwriting anything."
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122 123
  :type 'boolean
  :group 'eshell-unix)

John Wiegley's avatar
John Wiegley committed
124
(defcustom eshell-ln-overwrite-files nil
Glenn Morris's avatar
Glenn Morris committed
125
  "If non-nil, `ln' will overwrite files without warning."
Gerd Moellmann's avatar
Gerd Moellmann committed
126 127 128
  :type 'boolean
  :group 'eshell-unix)

John Wiegley's avatar
John Wiegley committed
129
(defcustom eshell-default-target-is-dot nil
Glenn Morris's avatar
Glenn Morris committed
130
  "If non-nil, the default destination for cp, mv or ln is `.'."
John Wiegley's avatar
John Wiegley committed
131 132 133
  :type 'boolean
  :group 'eshell-unix)

134
(defcustom eshell-du-prefer-over-ange nil
Glenn Morris's avatar
Glenn Morris committed
135
  "Use Eshell's du in ange-ftp remote directories.
136
Otherwise, Emacs will attempt to use rsh to invoke du on the remote machine."
137 138 139
  :type 'boolean
  :group 'eshell-unix)

Gerd Moellmann's avatar
Gerd Moellmann committed
140 141 142 143 144 145
;;; Functions:

(defun eshell-unix-initialize ()
  "Initialize the UNIX support/emulation code."
  (when (eshell-using-module 'eshell-cmpl)
    (add-hook 'pcomplete-try-first-hook
John Wiegley's avatar
John Wiegley committed
146 147 148 149
	      'eshell-complete-host-reference nil t))
  (make-local-variable 'eshell-complex-commands)
  (setq eshell-complex-commands
	(append '("grep" "egrep" "fgrep" "agrep" "glimpse" "locate"
150
		  "cat" "time" "cp" "mv" "make" "du" "diff" "su" "sudo")
John Wiegley's avatar
John Wiegley committed
151
		eshell-complex-commands)))
Gerd Moellmann's avatar
Gerd Moellmann committed
152 153 154 155 156

(defalias 'eshell/date     'current-time-string)
(defalias 'eshell/basename 'file-name-nondirectory)
(defalias 'eshell/dirname  'file-name-directory)

157 158 159 160
(defvar em-interactive)
(defvar em-preview)
(defvar em-recursive)
(defvar em-verbose)
Gerd Moellmann's avatar
Gerd Moellmann committed
161 162 163 164 165

(defun eshell/man (&rest args)
  "Invoke man, flattening the arguments appropriately."
  (funcall 'man (apply 'eshell-flatten-and-stringify args)))

166 167
(put 'eshell/man 'eshell-no-numeric-conversions t)

168
(defun eshell/info (&rest args)
169
  "Run the info command in-frame with the same behavior as command-line `info', ie:
170 171 172 173 174
  'info'           => goes to top info window
  'info arg1'      => IF arg1 is a file, then visits arg1
  'info arg1'      => OTHERWISE goes to top info window and then menu item arg1
  'info arg1 arg2' => does action for arg1 (either visit-file or menu-item) and then menu item arg2
  etc."
175
  (eval-and-compile (require 'info))
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  (let ((file (cond
                ((not (stringp (car args)))
                 nil)
                ((file-exists-p (expand-file-name (car args)))
                 (expand-file-name (car args)))
                ((file-exists-p (concat (expand-file-name (car args)) ".info"))
                 (concat (expand-file-name (car args)) ".info")))))

    ;; If the first arg is a file, then go to that file's Top node
    ;; Otherwise, go to the global directory
    (if file
      (progn
        (setq args (cdr args))
        (Info-find-node file "Top"))
      (Info-directory))

    ;; Treat all remaining args as menu references
    (while args
      (Info-menu (car args))
      (setq args (cdr args)))))

Gerd Moellmann's avatar
Gerd Moellmann committed
197
(defun eshell-remove-entries (path files &optional top-level)
John Wiegley's avatar
John Wiegley committed
198
  "From PATH, remove all of the given FILES, perhaps interactively."
Gerd Moellmann's avatar
Gerd Moellmann committed
199 200 201 202 203 204 205
  (while files
    (if (string-match "\\`\\.\\.?\\'"
		      (file-name-nondirectory (car files)))
	(if top-level
	    (eshell-error "rm: cannot remove `.' or `..'\n"))
      (if (and (file-directory-p (car files))
	       (not (file-symlink-p (car files))))
206
	  (progn
207
	    (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
208 209 210
		(eshell-printn (format "rm: removing directory `%s'"
				       (car files))))
	    (unless
211 212
		(or em-preview
		    (and em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
213 214 215
			 (not (y-or-n-p
			       (format "rm: remove directory `%s'? "
				       (car files))))))
216
	      (eshell-funcalln 'delete-directory (car files) t t)))
217
	(if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
218 219
	    (eshell-printn (format "rm: removing file `%s'"
				   (car files))))
220 221
	(unless (or em-preview
		    (and em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
222 223 224
			 (not (y-or-n-p
			       (format "rm: remove `%s'? "
				       (car files))))))
225
	  (eshell-funcalln 'delete-file (car files) t))))
Gerd Moellmann's avatar
Gerd Moellmann committed
226 227 228 229 230 231 232 233 234 235 236 237
    (setq files (cdr files))))

(defun eshell/rm (&rest args)
  "Implementation of rm in Lisp.
This is implemented to call either `delete-file', `kill-buffer',
`kill-process', or `unintern', depending on the nature of the
argument."
  (setq args (eshell-flatten-list args))
  (eshell-eval-using-options
   "rm" args
   '((?h "help" nil nil "show this usage screen")
     (?f "force" nil force-removal "force removal")
238 239 240
     (?i "interactive" nil em-interactive "prompt before any removal")
     (?n "preview" nil em-preview "don't change anything on disk")
     (?r "recursive" nil em-recursive
Gerd Moellmann's avatar
Gerd Moellmann committed
241
	 "remove the contents of directories recursively")
242 243
     (?R nil nil em-recursive "(same)")
     (?v "verbose" nil em-verbose "explain what is being done")
Gerd Moellmann's avatar
Gerd Moellmann committed
244 245 246 247 248
     :preserve-args
     :external "rm"
     :show-usage
     :usage "[OPTION]... FILE...
Remove (unlink) the FILE(s).")
249 250 251 252
   (unless em-interactive
     (setq em-interactive eshell-rm-interactive-query))
   (if (and force-removal em-interactive)
       (setq em-interactive nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
253 254 255 256 257 258 259 260
   (while args
     (let ((entry (if (stringp (car args))
		      (directory-file-name (car args))
		    (if (numberp (car args))
			(number-to-string (car args))
		      (car args)))))
       (cond
	((bufferp entry)
261
	 (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
262
	     (eshell-printn (format "rm: removing buffer `%s'" entry)))
263 264
	 (unless (or em-preview
		     (and em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
265 266 267
			  (not (y-or-n-p (format "rm: delete buffer `%s'? "
						 entry)))))
	   (eshell-funcalln 'kill-buffer entry)))
John Wiegley's avatar
John Wiegley committed
268
	((eshell-processp entry)
269
	 (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
270
	     (eshell-printn (format "rm: killing process `%s'" entry)))
271 272
	 (unless (or em-preview
		     (and em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275 276
			  (not (y-or-n-p (format "rm: kill process `%s'? "
						 entry)))))
	   (eshell-funcalln 'kill-process entry)))
	((symbolp entry)
277
	 (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
278 279
	     (eshell-printn (format "rm: uninterning symbol `%s'" entry)))
	 (unless
280 281
	     (or em-preview
		 (and em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
282 283 284 285 286 287
		      (not (y-or-n-p (format "rm: unintern symbol `%s'? "
					     entry)))))
	   (eshell-funcalln 'unintern entry)))
	((stringp entry)
	 (if (and (file-directory-p entry)
		  (not (file-symlink-p entry)))
288
	     (if (or em-recursive
Gerd Moellmann's avatar
Gerd Moellmann committed
289
		     eshell-rm-removes-directories)
290 291
		 (if (or em-preview
			 (not em-interactive)
Gerd Moellmann's avatar
Gerd Moellmann committed
292 293 294 295 296 297 298 299 300
			 (y-or-n-p
			  (format "rm: descend into directory `%s'? "
				  entry)))
		     (eshell-remove-entries nil (list entry) t))
	       (eshell-error (format "rm: %s: is a directory\n" entry)))
	   (eshell-remove-entries nil (list entry) t)))))
     (setq args (cdr args)))
   nil))

301 302
(put 'eshell/rm 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316
(defun eshell/mkdir (&rest args)
  "Implementation of mkdir in Lisp."
  (eshell-eval-using-options
   "mkdir" args
   '((?h "help" nil nil "show this usage screen")
     :external "mkdir"
     :show-usage
     :usage "[OPTION] DIRECTORY...
Create the DIRECTORY(ies), if they do not already exist.")
   (while args
     (eshell-funcalln 'make-directory (car args))
     (setq args (cdr args)))
   nil))

317 318
(put 'eshell/mkdir 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332
(defun eshell/rmdir (&rest args)
  "Implementation of rmdir in Lisp."
  (eshell-eval-using-options
   "rmdir" args
   '((?h "help" nil nil "show this usage screen")
     :external "rmdir"
     :show-usage
     :usage "[OPTION] DIRECTORY...
Remove the DIRECTORY(ies), if they are empty.")
   (while args
     (eshell-funcalln 'delete-directory (car args))
     (setq args (cdr args)))
   nil))

333 334
(put 'eshell/rmdir 'eshell-no-numeric-conversions t)

335
(defvar no-dereference)
Gerd Moellmann's avatar
Gerd Moellmann committed
336 337 338 339 340

(defvar eshell-warn-dot-directories t)

(defun eshell-shuffle-files (command action files target func deep &rest args)
  "Shuffle around some filesystem entries, using FUNC to do the work."
341
  (let ((attr-target (eshell-file-attributes target))
Gerd Moellmann's avatar
Gerd Moellmann committed
342
	(is-dir (or (file-directory-p target)
343
		    (and em-preview (not eshell-warn-dot-directories))))
Gerd Moellmann's avatar
Gerd Moellmann committed
344
	attr)
345
    (if (and (not em-preview) (not is-dir)
Gerd Moellmann's avatar
Gerd Moellmann committed
346 347 348 349 350 351 352 353 354 355 356 357
	     (> (length files) 1))
	(error "%s: when %s multiple files, last argument must be a directory"
	       command action))
    (while files
      (setcar files (directory-file-name (car files)))
      (cond
       ((string-match "\\`\\.\\.?\\'"
		      (file-name-nondirectory (car files)))
	(if eshell-warn-dot-directories
	    (eshell-error (format "%s: %s: omitting directory\n"
				  command (car files)))))
       ((and attr-target
358 359
	     (or (not (eshell-under-windows-p))
		 (eq system-type 'ms-dos))
360 361
	     (setq attr (eshell-file-attributes (car files)))
	     (nth 10 attr-target) (nth 10 attr)
362 363
	     ;; Use equal, not -, since the inode and the device could
	     ;; cons cells.
364
	     (equal (nth 10 attr-target) (nth 10 attr))
365
	     (nth 11 attr-target) (nth 11 attr)
366
	     (equal (nth 11 attr-target) (nth 11 attr)))
Gerd Moellmann's avatar
Gerd Moellmann committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
	(eshell-error (format "%s: `%s' and `%s' are the same file\n"
			      command (car files) target)))
       (t
	(let ((source (car files))
	      (target (if is-dir
			  (expand-file-name
			   (file-name-nondirectory (car files)) target)
			target))
	      link)
	  (if (and (file-directory-p source)
		   (or (not no-dereference)
		       (not (file-symlink-p source)))
		   (not (memq func '(make-symbolic-link
				     add-name-to-file))))
	      (if (and (eq func 'copy-file)
382
		       (not em-recursive))
Gerd Moellmann's avatar
Gerd Moellmann committed
383 384 385 386 387
		  (eshell-error (format "%s: %s: omitting directory\n"
					command (car files)))
		(let (eshell-warn-dot-directories)
		  (if (and (not deep)
			   (eq func 'rename-file)
388 389 390 391 392 393 394 395 396 397
			   ;; Use equal, since the device might be a
			   ;; cons cell.
			   (equal (nth 11 (eshell-file-attributes
					   (file-name-directory
					    (directory-file-name
					     (expand-file-name source)))))
				  (nth 11 (eshell-file-attributes
					   (file-name-directory
					    (directory-file-name
					     (expand-file-name target)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
398 399
		      (apply 'eshell-funcalln func source target args)
		  (unless (file-directory-p target)
400
		    (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
401 402 403
			(eshell-printn
			 (format "%s: making directory %s"
				 command target)))
404
		    (unless em-preview
Gerd Moellmann's avatar
Gerd Moellmann committed
405
		      (eshell-funcalln 'make-directory target)))
John Wiegley's avatar
John Wiegley committed
406 407 408 409 410 411 412 413
		  (apply 'eshell-shuffle-files
			 command action
			 (mapcar
			  (function
			   (lambda (file)
			     (concat source "/" file)))
			  (directory-files source))
			 target func t args)
Gerd Moellmann's avatar
Gerd Moellmann committed
414
		  (when (eq func 'rename-file)
415
		    (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418
			(eshell-printn
			 (format "%s: deleting directory %s"
				 command source)))
419
		    (unless em-preview
Gerd Moellmann's avatar
Gerd Moellmann committed
420
		      (eshell-funcalln 'delete-directory source))))))
421
	    (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
422 423
		(eshell-printn (format "%s: %s -> %s" command
				       source target)))
424
	    (unless em-preview
Gerd Moellmann's avatar
Gerd Moellmann committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
	      (if (and no-dereference
		       (setq link (file-symlink-p source)))
		  (progn
		    (apply 'eshell-funcalln 'make-symbolic-link
			   link target args)
		    (if (eq func 'rename-file)
			(if (and (file-directory-p source)
				 (not (file-symlink-p source)))
			    (eshell-funcalln 'delete-directory source)
			  (eshell-funcalln 'delete-file source))))
		(apply 'eshell-funcalln func source target args)))))))
      (setq files (cdr files)))))

(defun eshell-shorthand-tar-command (command args)
  "Rewrite `cp -v dir a.tar.gz' to `tar cvzf a.tar.gz dir'."
  (let* ((archive (car (last args)))
	 (tar-args
	  (cond ((string-match "z2" archive) "If")
		((string-match "gz" archive) "zf")
		((string-match "\\(az\\|Z\\)" archive) "Zf")
		(t "f"))))
    (if (file-exists-p archive)
	(setq tar-args (concat "u" tar-args))
      (setq tar-args (concat "c" tar-args)))
449
    (if em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
450 451 452 453 454 455 456 457 458 459
	(setq tar-args (concat "v" tar-args)))
    (if (equal command "mv")
	(setq tar-args (concat "--remove-files -" tar-args)))
    ;; truncate the archive name from the arguments
    (setcdr (last args 2) nil)
    (throw 'eshell-replace-command
	   (eshell-parse-command
	    (format "tar %s %s" tar-args archive) args))))

;; this is to avoid duplicating code...
John Wiegley's avatar
John Wiegley committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
(defmacro eshell-mvcpln-template (command action func query-var
					  force-var &optional preserve)
  `(let ((len (length args)))
     (if (or (= len 0)
	     (and (= len 1) (null eshell-default-target-is-dot)))
	 (error "%s: missing destination file or directory" ,command))
     (if (= len 1)
	 (nconc args '(".")))
     (setq args (eshell-stringify-list (eshell-flatten-list args)))
     (if (and ,(not (equal command "ln"))
	      (string-match eshell-tar-regexp (car (last args)))
	      (or (> (length args) 2)
		  (and (file-directory-p (car args))
		       (or (not no-dereference)
			   (not (file-symlink-p (car args)))))))
	 (eshell-shorthand-tar-command ,command args)
       (let ((target (car (last args)))
	     ange-cache)
	 (setcdr (last args 2) nil)
	 (eshell-shuffle-files
	  ,command ,action args target ,func nil
	  ,@(append
482
	     `((if (and (or em-interactive
John Wiegley's avatar
John Wiegley committed
483 484 485 486 487 488
			    ,query-var)
			(not force))
		   1 (or force ,force-var)))
	     (if preserve
		 (list preserve)))))
       nil)))
Gerd Moellmann's avatar
Gerd Moellmann committed
489 490 491 492 493 494 495

(defun eshell/mv (&rest args)
  "Implementation of mv in Lisp."
  (eshell-eval-using-options
   "mv" args
   '((?f "force" nil force
	 "remove existing destinations, never prompt")
496
     (?i "interactive" nil em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
497
	 "request confirmation if target already exists")
498
     (?n "preview" nil em-preview
Gerd Moellmann's avatar
Gerd Moellmann committed
499
	 "don't change anything on disk")
500
     (?v "verbose" nil em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
501 502
	 "explain what is being done")
     (nil "help" nil nil "show this usage screen")
John Wiegley's avatar
John Wiegley committed
503
     :preserve-args
Gerd Moellmann's avatar
Gerd Moellmann committed
504 505 506 507 508 509 510
     :external "mv"
     :show-usage
     :usage "[OPTION]... SOURCE DEST
   or: mv [OPTION]... SOURCE... DIRECTORY
Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.
\[OPTION] DIRECTORY...")
   (let ((no-dereference t))
John Wiegley's avatar
John Wiegley committed
511 512 513
     (eshell-mvcpln-template "mv" "moving" 'rename-file
			     eshell-mv-interactive-query
			     eshell-mv-overwrite-files))))
Gerd Moellmann's avatar
Gerd Moellmann committed
514

515 516
(put 'eshell/mv 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
517 518 519 520 521 522 523 524 525 526
(defun eshell/cp (&rest args)
  "Implementation of cp in Lisp."
  (eshell-eval-using-options
   "cp" args
   '((?a "archive" nil archive
	 "same as -dpR")
     (?d "no-dereference" nil no-dereference
	 "preserve links")
     (?f "force" nil force
	 "remove existing destinations, never prompt")
527
     (?i "interactive" nil em-interactive
Gerd Moellmann's avatar
Gerd Moellmann committed
528
	 "request confirmation if target already exists")
529
     (?n "preview" nil em-preview
Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532
	 "don't change anything on disk")
     (?p "preserve" nil preserve
	 "preserve file attributes if possible")
533
     (?R "recursive" nil em-recursive
Gerd Moellmann's avatar
Gerd Moellmann committed
534
	 "copy directories recursively")
535
     (?v "verbose" nil em-verbose
Gerd Moellmann's avatar
Gerd Moellmann committed
536 537
	 "explain what is being done")
     (nil "help" nil nil "show this usage screen")
John Wiegley's avatar
John Wiegley committed
538
     :preserve-args
Gerd Moellmann's avatar
Gerd Moellmann committed
539 540 541 542 543 544
     :external "cp"
     :show-usage
     :usage "[OPTION]... SOURCE DEST
   or:  cp [OPTION]... SOURCE... DIRECTORY
Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.")
   (if archive
545
       (setq preserve t no-dereference t em-recursive t))
John Wiegley's avatar
John Wiegley committed
546 547 548
   (eshell-mvcpln-template "cp" "copying" 'copy-file
			   eshell-cp-interactive-query
			   eshell-cp-overwrite-files preserve)))
Gerd Moellmann's avatar
Gerd Moellmann committed
549

550 551
(put 'eshell/cp 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
552 553 554 555 556 557 558
(defun eshell/ln (&rest args)
  "Implementation of ln in Lisp."
  (eshell-eval-using-options
   "ln" args
   '((?h "help" nil nil "show this usage screen")
     (?s "symbolic" nil symbolic
	 "make symbolic links instead of hard links")
559
     (?i "interactive" nil em-interactive
John Wiegley's avatar
John Wiegley committed
560
	 "request confirmation if target already exists")
Gerd Moellmann's avatar
Gerd Moellmann committed
561
     (?f "force" nil force "remove existing destinations, never prompt")
562
     (?n "preview" nil em-preview
Gerd Moellmann's avatar
Gerd Moellmann committed
563
	 "don't change anything on disk")
564
     (?v "verbose" nil em-verbose "explain what is being done")
John Wiegley's avatar
John Wiegley committed
565
     :preserve-args
Gerd Moellmann's avatar
Gerd Moellmann committed
566 567 568 569 570 571 572 573
     :external "ln"
     :show-usage
     :usage "[OPTION]... TARGET [LINK_NAME]
   or:  ln [OPTION]... TARGET... DIRECTORY
Create a link to the specified TARGET with optional LINK_NAME.  If there is
more than one TARGET, the last argument must be a directory;  create links
in DIRECTORY to each TARGET.  Create hard links by default, symbolic links
with '--symbolic'.  When creating hard links, each TARGET must exist.")
John Wiegley's avatar
John Wiegley committed
574 575 576 577 578 579 580
   (let ((no-dereference t))
     (eshell-mvcpln-template "ln" "linking"
			     (if symbolic
				 'make-symbolic-link
			       'add-name-to-file)
			     eshell-ln-interactive-query
			     eshell-ln-overwrite-files))))
Gerd Moellmann's avatar
Gerd Moellmann committed
581

582 583
(put 'eshell/ln 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
584
(defun eshell/cat (&rest args)
585 586 587
  "Implementation of cat in Lisp.
If in a pipeline, or the file is not a regular file, directory or
symlink, then revert to the system's definition of cat."
John Wiegley's avatar
John Wiegley committed
588
  (setq args (eshell-stringify-list (eshell-flatten-list args)))
589 590
  (if (or eshell-in-pipeline-p
	  (catch 'special
591
	    (dolist (arg args)
592 593 594 595 596 597
	      (unless (or (and (stringp arg)
			       (> (length arg) 0)
			       (eq (aref arg 0) ?-))
			  (let ((attrs (eshell-file-attributes arg)))
			    (and attrs (memq (aref (nth 8 attrs) 0)
					     '(?d ?l ?-)))))
598 599 600 601 602 603 604 605
		(throw 'special t)))))
      (let ((ext-cat (eshell-search-path "cat")))
	(if ext-cat
	    (throw 'eshell-replace-command
		   (eshell-parse-command ext-cat args))
	  (if eshell-in-pipeline-p
	      (error "Eshell's `cat' does not work in pipelines")
	    (error "Eshell's `cat' cannot display one of the files given"))))
Gerd Moellmann's avatar
Gerd Moellmann committed
606 607 608 609 610 611 612 613
    (eshell-init-print-buffer)
    (eshell-eval-using-options
     "cat" args
     '((?h "help" nil nil "show this usage screen")
       :external "cat"
       :show-usage
       :usage "[OPTION] FILE...
Concatenate FILE(s), or standard input, to standard output.")
614
     (dolist (file args)
Gerd Moellmann's avatar
Gerd Moellmann committed
615 616 617 618
       (if (string= file "-")
	   (throw 'eshell-external
		  (eshell-external-command "cat" args))))
     (let ((curbuf (current-buffer)))
619
       (dolist (file args)
Gerd Moellmann's avatar
Gerd Moellmann committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633
	 (with-temp-buffer
	   (insert-file-contents file)
	   (goto-char (point-min))
	   (while (not (eobp))
	     (let ((str (buffer-substring
			 (point) (min (1+ (line-end-position))
				      (point-max)))))
	       (with-current-buffer curbuf
		 (eshell-buffered-print str)))
	     (forward-line)))))
     (eshell-flush)
     ;; if the file does not end in a newline, do not emit one
     (setq eshell-ensure-newline-p nil))))

634 635
(put 'eshell/cat 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
636 637 638 639 640 641 642 643 644 645 646 647
;; special front-end functions for compilation-mode buffers

(defun eshell/make (&rest args)
  "Use `compile' to do background makes."
  (if (and eshell-current-subjob-p
	   (eshell-interactive-output-p))
      (let ((compilation-process-setup-function
	     (list 'lambda nil
		   (list 'setq 'process-environment
			 (list 'quote (eshell-copy-environment))))))
	(compile (concat "make " (eshell-flatten-and-stringify args))))
    (throw 'eshell-replace-command
John Wiegley's avatar
John Wiegley committed
648 649
	   (eshell-parse-command "*make" (eshell-stringify-list
					  (eshell-flatten-list args))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
650

651 652
(put 'eshell/make 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
653 654 655 656 657 658 659 660 661 662
(defun eshell-occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char (marker-position pos))))

(defun eshell-occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
663
  (let (pos)
664
    (with-current-buffer (window-buffer (posn-window (event-end event)))
Gerd Moellmann's avatar
Gerd Moellmann committed
665 666
      (save-excursion
	(goto-char (posn-point (event-end event)))
667
	(setq pos (occur-mode-find-occurrence))))
Gerd Moellmann's avatar
Gerd Moellmann committed
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    (pop-to-buffer (marker-buffer pos))
    (goto-char (marker-position pos))))

(defun eshell-poor-mans-grep (args)
  "A poor version of grep that opens every file and uses `occur'.
This eats up memory, since it leaves the buffers open (to speed future
searches), and it's very slow.  But, if your system has no grep
available..."
  (save-selected-window
    (let ((default-dir default-directory))
      (with-current-buffer (get-buffer-create "*grep*")
	(let ((inhibit-read-only t)
	      (default-directory default-dir))
	  (erase-buffer)
	  (occur-mode)
John Wiegley's avatar
John Wiegley committed
683 684
	  (let ((files (eshell-stringify-list
			(eshell-flatten-list (cdr args))))
Gerd Moellmann's avatar
Gerd Moellmann committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
		(inhibit-redisplay t)
		string)
	    (when (car args)
	      (if (get-buffer "*Occur*")
		  (kill-buffer (get-buffer "*Occur*")))
	      (setq string nil)
	      (while files
		(with-current-buffer (find-file-noselect (car files))
		  (save-excursion
		    (ignore-errors
		      (occur (car args))))
		  (if (get-buffer "*Occur*")
		      (with-current-buffer (get-buffer "*Occur*")
			(setq string (buffer-string))
			(kill-buffer (current-buffer)))))
		(if string (insert string))
		(setq string nil
		      files (cdr files)))))
	  (local-set-key [mouse-2] 'eshell-occur-mode-mouse-goto)
	  (local-set-key [(control ?c) (control ?c)]
			 'eshell-occur-mode-goto-occurrence)
	  (local-set-key [(control ?m)]
			 'eshell-occur-mode-goto-occurrence)
	  (local-set-key [return] 'eshell-occur-mode-goto-occurrence)
	  (pop-to-buffer (current-buffer) t)
	  (goto-char (point-min))
	  (resize-temp-buffer-window))))))

(defun eshell-grep (command args &optional maybe-use-occur)
  "Generic service function for the various grep aliases.
It calls Emacs' grep utility if the command is not redirecting output,
and if it's not part of a command pipeline.  Otherwise, it calls the
external command."
  (if (and maybe-use-occur eshell-no-grep-available)
      (eshell-poor-mans-grep args)
    (if (or eshell-plain-grep-behavior
	    (not (and (eshell-interactive-output-p)
		      (not eshell-in-pipeline-p)
		      (not eshell-in-subcommand-p))))
	(throw 'eshell-replace-command
John Wiegley's avatar
John Wiegley committed
725
	       (eshell-parse-command (concat "*" command)
John Wiegley's avatar
John Wiegley committed
726 727
				     (eshell-stringify-list
				      (eshell-flatten-list args))))
728
      (let* ((args (mapconcat 'identity
Gerd Moellmann's avatar
Gerd Moellmann committed
729
			      (mapcar 'shell-quote-argument
John Wiegley's avatar
John Wiegley committed
730 731
				      (eshell-stringify-list
				       (eshell-flatten-list args)))
Gerd Moellmann's avatar
Gerd Moellmann committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
			      " "))
	     (cmd (progn
		    (set-text-properties 0 (length args)
					 '(invisible t) args)
		    (format "%s -n %s" command args)))
	     compilation-scroll-output)
	(grep cmd)))))

(defun eshell/grep (&rest args)
  "Use Emacs grep facility instead of calling external grep."
  (eshell-grep "grep" args t))

(defun eshell/egrep (&rest args)
  "Use Emacs grep facility instead of calling external egrep."
  (eshell-grep "egrep" args t))

(defun eshell/fgrep (&rest args)
  "Use Emacs grep facility instead of calling external fgrep."
  (eshell-grep "fgrep" args t))

(defun eshell/agrep (&rest args)
  "Use Emacs grep facility instead of calling external agrep."
  (eshell-grep "agrep" args))

(defun eshell/glimpse (&rest args)
  "Use Emacs grep facility instead of calling external glimpse."
  (let (null-device)
    (eshell-grep "glimpse" (append '("-z" "-y") args))))

;; completions rules for some common UNIX commands

(defsubst eshell-complete-hostname ()
  "Complete a command that wants a hostname for an argument."
  (pcomplete-here (eshell-read-host-names)))

(defun eshell-complete-host-reference ()
  "If there is a host reference, complete it."
  (let ((arg (pcomplete-actual-arg))
	index)
    (when (setq index (string-match "@[a-z.]*\\'" arg))
      (setq pcomplete-stub (substring arg (1+ index))
	    pcomplete-last-completion-raw t)
      (throw 'pcomplete-completions (eshell-read-host-names)))))

(defalias 'pcomplete/ftp    'eshell-complete-hostname)
(defalias 'pcomplete/ncftp  'eshell-complete-hostname)
(defalias 'pcomplete/ping   'eshell-complete-hostname)
(defalias 'pcomplete/rlogin 'eshell-complete-hostname)

(defun pcomplete/telnet ()
  (require 'pcmpl-unix)
  (pcomplete-opt "xl(pcmpl-unix-user-names)")
  (eshell-complete-hostname))

(defun pcomplete/rsh ()
  "Complete `rsh', which, after the user and hostname, is like xargs."
  (require 'pcmpl-unix)
  (pcomplete-opt "l(pcmpl-unix-user-names)")
  (eshell-complete-hostname)
  (pcomplete-here (funcall pcomplete-command-completion-function))
  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
	       pcomplete-default-completion-function)))

(defalias 'pcomplete/ssh 'pcomplete/rsh)

797 798 799 800 801 802 803 804
(defvar block-size)
(defvar by-bytes)
(defvar dereference-links)
(defvar grand-total)
(defvar human-readable)
(defvar max-depth)
(defvar only-one-filesystem)
(defvar show-all)
Gerd Moellmann's avatar
Gerd Moellmann committed
805 806 807 808 809 810 811 812 813 814 815 816 817

(defsubst eshell-du-size-string (size)
  (let* ((str (eshell-printable-size size human-readable block-size t))
	 (len (length str)))
    (concat str (if (< len 8)
		    (make-string (- 8 len) ? )))))

(defun eshell-du-sum-directory (path depth)
  "Summarize PATH, and its member directories."
  (let ((entries (eshell-directory-files-and-attributes path))
	(size 0.0))
    (while entries
      (unless (string-match "\\`\\.\\.?\\'" (caar entries))
818
	(let* ((entry (concat path "/"
Gerd Moellmann's avatar
Gerd Moellmann committed
819 820 821 822 823
			      (caar entries)))
	       (symlink (and (stringp (cadr (car entries)))
			     (cadr (car entries)))))
	  (unless (or (and symlink (not dereference-links))
		      (and only-one-filesystem
John Wiegley's avatar
John Wiegley committed
824 825
			   (/= only-one-filesystem
			       (nth 12 (car entries)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
	    (if symlink
		(setq entry symlink))
	    (setq size
		  (+ size
		     (if (eq t (cadr (car entries)))
			 (eshell-du-sum-directory entry (1+ depth))
		       (let ((file-size (nth 8 (car entries))))
			 (prog1
			     file-size
			   (if show-all
			       (eshell-print
				(concat (eshell-du-size-string file-size)
					entry "\n")))))))))))
      (setq entries (cdr entries)))
    (if (or (not max-depth)
	    (= depth max-depth)
	    (= depth 0))
	(eshell-print (concat (eshell-du-size-string size)
			      (directory-file-name path) "\n")))
    size))

(defun eshell/du (&rest args)
John Wiegley's avatar
John Wiegley committed
848
  "Implementation of \"du\" in Lisp, passing ARGS."
849
  (setq args (if args
John Wiegley's avatar
John Wiegley committed
850
		 (eshell-stringify-list (eshell-flatten-list args))
851 852 853 854
	       '(".")))
  (let ((ext-du (eshell-search-path "du")))
    (if (and ext-du
	     (not (catch 'have-ange-path
855
		    (dolist (arg args)
856 857
		      (if (string-equal
			   (file-remote-p (expand-file-name arg) 'method) "ftp")
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
			  (throw 'have-ange-path t))))))
	(throw 'eshell-replace-command
	       (eshell-parse-command ext-du args))
      (eshell-eval-using-options
       "du" args
       '((?a "all" nil show-all
	     "write counts for all files, not just directories")
	 (nil "block-size" t block-size
	      "use SIZE-byte blocks (i.e., --block-size SIZE)")
	 (?b "bytes" nil by-bytes
	     "print size in bytes")
	 (?c "total" nil grand-total
	     "produce a grand total")
	 (?d "max-depth" t max-depth
	     "display data only this many levels of data")
	 (?h "human-readable" 1024 human-readable
	     "print sizes in human readable format")
	 (?H "is" 1000 human-readable
	     "likewise, but use powers of 1000 not 1024")
	 (?k "kilobytes" 1024 block-size
	     "like --block-size 1024")
	 (?L "dereference" nil dereference-links
	     "dereference all symbolic links")
	 (?m "megabytes" 1048576 block-size
	     "like --block-size 1048576")
	 (?s "summarize" 0 max-depth
	     "display only a total for each argument")
	 (?x "one-file-system" nil only-one-filesystem
	     "skip directories on different filesystems")
	 (nil "help" nil nil
	      "show this usage screen")
	 :external "du"
	 :usage "[OPTION]... FILE...
Gerd Moellmann's avatar
Gerd Moellmann committed
891
Summarize disk usage of each FILE, recursively for directories.")
892 893 894
       (unless by-bytes
	 (setq block-size (or block-size 1024)))
       (if (and max-depth (stringp max-depth))
895
	   (setq max-depth (string-to-number max-depth)))
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
       ;; filesystem support means nothing under Windows
       (if (eshell-under-windows-p)
	   (setq only-one-filesystem nil))
       (let ((size 0.0) ange-cache)
	 (while args
	   (if only-one-filesystem
	       (setq only-one-filesystem
		     (nth 11 (eshell-file-attributes
			      (file-name-as-directory (car args))))))
	   (setq size (+ size (eshell-du-sum-directory
			       (directory-file-name (car args)) 0)))
	   (setq args (cdr args)))
	 (if grand-total
	     (eshell-print (concat (eshell-du-size-string size)
				   "total\n"))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
911 912 913 914

(defvar eshell-time-start nil)

(defun eshell-show-elapsed-time ()
915
  (let ((elapsed (format "%.3f secs\n" (- (float-time) eshell-time-start))))
Gerd Moellmann's avatar
Gerd Moellmann committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
    (set-text-properties 0 (length elapsed) '(face bold) elapsed)
    (eshell-interactive-print elapsed))
  (remove-hook 'eshell-post-command-hook 'eshell-show-elapsed-time t))

(defun eshell/time (&rest args)
  "Implementation of \"time\" in Lisp."
  (let ((time-args (copy-alist args))
	(continue t)
	last-arg)
    (while (and continue args)
      (if (not (string-match "^-" (car args)))
	  (progn
	    (if last-arg
		(setcdr last-arg nil)
	      (setq args '("")))
	    (setq continue nil))
	(setq last-arg args
	      args (cdr args))))
    (eshell-eval-using-options
     "time" args
     '((?h "help" nil nil "show this usage screen")
       :external "time"
       :show-usage
       :usage "COMMAND...
Show wall-clock time elapsed during execution of COMMAND.")
941
     (setq eshell-time-start (float-time))
Gerd Moellmann's avatar
Gerd Moellmann committed
942 943 944
     (add-hook 'eshell-post-command-hook 'eshell-show-elapsed-time nil t)
     ;; after setting
     (throw 'eshell-replace-command
945 946 947 948
	    (eshell-parse-command (car time-args)
;;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2007-08/msg00205.html
				  (eshell-stringify-list
				   (eshell-flatten-list (cdr time-args))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
949

950 951 952
(defun eshell/whoami (&rest args)
  "Make \"whoami\" Tramp aware."
  (or (file-remote-p default-directory 'user) (user-login-name)))
Gerd Moellmann's avatar
Gerd Moellmann committed
953 954 955 956 957 958 959 960 961

(defvar eshell-diff-window-config nil)

(defun eshell-diff-quit ()
  "Restore the window configuration previous to diff'ing."
  (interactive)
  (if eshell-diff-window-config
      (set-window-configuration eshell-diff-window-config)))

962 963
(defun nil-blank-string (string)
  "Return STRING, or nil if STRING contains only non-blank characters."
964
  (cond
965 966
    ((string-match "[^[:blank:]]" string) string)
    (nil)))
967

Gerd Moellmann's avatar
Gerd Moellmann committed
968 969
(defun eshell/diff (&rest args)
  "Alias \"diff\" to call Emacs `diff' function."
John Wiegley's avatar
John Wiegley committed
970
  (let ((orig-args (eshell-stringify-list (eshell-flatten-list args))))
John Wiegley's avatar
John Wiegley committed
971 972 973 974 975 976
    (if (or eshell-plain-diff-behavior
	    (not (and (eshell-interactive-output-p)
		      (not eshell-in-pipeline-p)
		      (not eshell-in-subcommand-p))))
	(throw 'eshell-replace-command
	       (eshell-parse-command "*diff" orig-args))
977
      (setq args (copy-sequence orig-args))
John Wiegley's avatar
John Wiegley committed
978 979 980 981 982 983 984 985 986 987 988
      (if (< (length args) 2)
	  (throw 'eshell-replace-command
		 (eshell-parse-command "*diff" orig-args)))
      (let ((old (car (last args 2)))
	    (new (car (last args)))
	    (config (current-window-configuration)))
	(if (= (length args) 2)
	    (setq args nil)
	  (setcdr (last args 3) nil))
	(with-current-buffer
	    (condition-case err
989 990
		(diff old new
		      (nil-blank-string (eshell-flatten-and-stringify args)))
John Wiegley's avatar
John Wiegley committed
991 992 993 994
	      (error
	       (throw 'eshell-replace-command
		      (eshell-parse-command "*diff" orig-args))))
	  (when (fboundp 'diff-mode)
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
	    (make-local-variable 'compilation-finish-functions)
	    (add-hook
	     'compilation-finish-functions
	     `(lambda (buff msg)
		(with-current-buffer buff
		  (diff-mode)
		  (set (make-local-variable 'eshell-diff-window-config)
		       ,config)
		  (local-set-key [?q] 'eshell-diff-quit)
		  (if (fboundp 'turn-on-font-lock-if-enabled)
		      (turn-on-font-lock-if-enabled))
		  (goto-char (point-min))))))
	  (pop-to-buffer (current-buffer))))))
  nil)
Gerd Moellmann's avatar
Gerd Moellmann committed
1009

1010 1011
(put 'eshell/diff 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
1012 1013 1014 1015 1016 1017 1018 1019 1020
(defun eshell/locate (&rest args)
  "Alias \"locate\" to call Emacs `locate' function."
  (if (or eshell-plain-locate-behavior
	  (not (and (eshell-interactive-output-p)
		    (not eshell-in-pipeline-p)
		    (not eshell-in-subcommand-p)))
	  (and (stringp (car args))
	       (string-match "^-" (car args))))
      (throw 'eshell-replace-command
John Wiegley's avatar
John Wiegley committed
1021 1022
	     (eshell-parse-command "*locate" (eshell-stringify-list
					      (eshell-flatten-list args))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1023 1024 1025 1026
    (save-selected-window
      (let ((locate-history-list (list (car args))))
	(locate-with-filter (car args) (cadr args))))))

1027 1028
(put 'eshell/locate 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
1029 1030 1031
(defun eshell/occur (&rest args)
  "Alias \"occur\" to call Emacs `occur' function."
  (let ((inhibit-read-only t))
John Wiegley's avatar
John Wiegley committed
1032 1033 1034
    (if (> (length args) 2)
	(error "usage: occur: (REGEXP &optional NLINES)")
      (apply 'occur args))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1035

1036 1037
(put 'eshell/occur 'eshell-no-numeric-conversions t)

1038 1039 1040 1041 1042
;; Pacify the byte-compiler.
(defvar tramp-default-proxies-alist)

(defun eshell/su (&rest args)
  "Alias \"su\" to call Tramp."
Michael Albinus's avatar
Michael Albinus committed
1043
  (require 'tramp)
1044
  (setq args (eshell-stringify-list (eshell-flatten-list args)))
Michael Albinus's avatar
Michael Albinus committed
1045
  (let ((orig-args (copy-tree args)))
1046
    (eshell-eval-using-options
Michael Albinus's avatar
Michael Albinus committed
1047
     "su" args
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
     '((?h "help" nil nil "show this usage screen")
       (?l "login" nil login "provide a login environment")
       (?  nil nil login "provide a login environment")
       :usage "[- | -l | --login] [USER]
Become another USER during a login session.")
     (throw 'eshell-replace-command
	    (let ((user "root")
		  (host (or (file-remote-p default-directory 'host)
			    "localhost"))
		  (dir (or (file-remote-p default-directory 'localname)
Michael Albinus's avatar
Michael Albinus committed
1058
			   (expand-file-name default-directory))))
1059
	      (dolist (arg args)
1060
		(if (string-equal arg "-") (setq login t) (setq user arg)))
Michael Albinus's avatar
Michael Albinus committed
1061 1062
	      ;; `eshell-eval-using-options' does not handle "-".
	      (if (member "-" orig-args) (setq login t))
1063
	      (if login (setq dir "~/"))
1064
	      (if (and (file-remote-p default-directory)
Michael Albinus's avatar
Michael Albinus committed
1065 1066 1067 1068 1069
		       (or
			(not (string-equal
			      "su" (file-remote-p default-directory 'method)))
			(not (string-equal
			      user (file-remote-p default-directory 'user)))))
1070 1071 1072 1073
		  (add-to-list
		   'tramp-default-proxies-alist
		   (list host user (file-remote-p default-directory))))
	      (eshell-parse-command
1074
	       "cd" (list (format "/su:%s@%s:%s" user host dir))))))))
1075 1076 1077 1078 1079

(put 'eshell/su 'eshell-no-numeric-conversions t)

(defun eshell/sudo (&rest args)
  "Alias \"sudo\" to call Tramp."
Michael Albinus's avatar
Michael Albinus committed
1080
  (require 'tramp)
1081
  (setq args (eshell-stringify-list (eshell-flatten-list args)))
Michael Albinus's avatar
Michael Albinus committed
1082
  (let ((orig-args (copy-tree args)))
1083 1084 1085 1086 1087 1088 1089 1090
    (eshell-eval-using-options
     "sudo" args
     '((?h "help" nil nil "show this usage screen")
       (?u "user" t user "execute a command as another USER")
       :show-usage
       :usage "[(-u | --user) USER] COMMAND
Execute a COMMAND as the superuser or another USER.")
     (throw 'eshell-external
Michael Albinus's avatar
Michael Albinus committed
1091 1092 1093 1094 1095 1096 1097 1098 1099
	    (let ((user (or user "root"))
		  (host (or (file-remote-p default-directory 'host)
			    "localhost"))
		  (dir (or (file-remote-p default-directory 'localname)
			   (expand-file-name default-directory))))
	      ;; `eshell-eval-using-options' reads options of COMMAND.
	      (while (and (stringp (car orig-args))
			  (member (car orig-args) '("-u" "--user")))
		(setq orig-args (cddr orig-args)))
1100
	      (if (and (file-remote-p default-directory)
Michael Albinus's avatar
Michael Albinus committed
1101 1102 1103 1104 1105
		       (or
			(not (string-equal
			      "sudo" (file-remote-p default-directory 'method)))
			(not (string-equal
			      user (file-remote-p default-directory 'user)))))
1106 1107 1108
		  (add-to-list
		   'tramp-default-proxies-alist
		   (list host user (file-remote-p default-directory))))
1109
	      (let ((default-directory (format "/sudo:%s@%s:%s" user host dir)))
Michael Albinus's avatar
Michael Albinus committed
1110
		(eshell-named-command (car orig-args) (cdr orig-args))))))))
1111 1112 1113

(put 'eshell/sudo 'eshell-no-numeric-conversions t)

1114
(provide 'em-unix)
Gerd Moellmann's avatar
Gerd Moellmann committed
1115

1116 1117 1118 1119
;; Local Variables:
;; generated-autoload-file: "esh-groups.el"
;; End:

Gerd Moellmann's avatar
Gerd Moellmann committed
1120
;;; em-unix.el ends here