(appt-disp-window): Move minibuffer check
[emacs.git] / lisp / proced.el
blob85980c8e311fc7af5fb239ba0dc5242f28afde7c
1 ;;; proced.el --- operate on system processes like dired
3 ;; Copyright (C) 2008 Free Software Foundation, Inc.
5 ;; Author: Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
6 ;; Keywords: Processes, Unix
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Proced makes an Emacs buffer containing a listing of the current
26 ;; system processes. You can use the normal Emacs commands to move around
27 ;; in this buffer, and special Proced commands to operate on the processes
28 ;; listed. See `proced-mode' for getting started.
30 ;; To do:
31 ;; - interactive temporary customizability of flags in `proced-grammar-alist'
32 ;; - allow "sudo kill PID", "renice PID"
34 ;; Wishlist
35 ;; - tree view like pstree(1)
37 ;;; Code:
39 (require 'time-date) ; for `with-decoded-time-value'
41 (defgroup proced nil
42 "Proced mode."
43 :group 'processes
44 :group 'unix
45 :prefix "proced-")
47 (defcustom proced-signal-function 'signal-process
48 "Name of signal function.
49 It can be an elisp function (usually `signal-process') or a string specifying
50 the external command (usually \"kill\")."
51 :group 'proced
52 :type '(choice (function :tag "function")
53 (string :tag "command")))
55 (defcustom proced-signal-list
56 '( ;; signals supported on all POSIX compliant systems
57 ("HUP (1. Hangup)")
58 ("INT (2. Terminal interrupt)")
59 ("QUIT (3. Terminal quit)")
60 ("ABRT (6. Process abort)")
61 ("KILL (9. Kill - cannot be caught or ignored)")
62 ("ALRM (14. Alarm Clock)")
63 ("TERM (15. Termination)")
64 ;; POSIX 1003.1-2001
65 ;; Which systems do not support these signals so that we can
66 ;; exclude them from `proced-signal-list'?
67 ("CONT (Continue executing)")
68 ("STOP (Stop executing / pause - cannot be caught or ignored)")
69 ("TSTP (Terminal stop / pause)"))
70 "List of signals, used for minibuffer completion."
71 :group 'proced
72 :type '(repeat (string :tag "signal")))
74 ;; For which attributes can we use a fixed width of the output field?
75 ;; A fixed width speeds up formatting, yet it can make
76 ;; `proced-grammar-alist' system-dependent.
77 ;; (If proced runs like top(1) we want it to be fast.)
79 ;; If it is impossible / unlikely that an attribute has the same value
80 ;; for two processes, then sorting can be based on one ordinary (fast)
81 ;; predicate like `<'. Otherwise, a list of proced predicates can be used
82 ;; to refine the sort.
84 ;; It would be neat if one could temporarily override the following
85 ;; predefined rules.
86 (defcustom proced-grammar-alist
87 '( ;; attributes defined in `system-process-attributes'
88 (euid "EUID" "%d" right proced-< nil (euid pid) (nil t nil))
89 (user "USER" nil left proced-string-lessp nil (user pid) (nil t nil))
90 (egid "EGID" "%d" right proced-< nil (egid euid pid) (nil t nil))
91 (group "GROUP" nil left proced-string-lessp nil (group user pid) (nil t nil))
92 (comm "COMMAND" nil left proced-string-lessp nil (comm pid) (nil t nil))
93 (state "STAT" nil left proced-string-lessp nil (state pid) (nil t nil))
94 (ppid "PPID" "%d" right proced-< nil (ppid pid) (nil t nil))
95 (pgrp "PGRP" "%d" right proced-< nil (pgrp euid pid) (nil t nil))
96 (sess "SESS" "%d" right proced-< nil (sess pid) (nil t nil))
97 (ttname "TTY" proced-format-ttname left proced-string-lessp nil (ttname pid) (nil t nil))
98 (tpgid "TPGID" "%d" right proced-< nil (tpgid pid) (nil t nil))
99 (minflt "MINFLT" "%d" right proced-< nil (minflt pid) (nil t t))
100 (majflt "MAJFLT" "%d" right proced-< nil (majflt pid) (nil t t))
101 (cminflt "CMINFLT" "%d" right proced-< nil (cminflt pid) (nil t t))
102 (cmajflt "CMAJFLT" "%d" right proced-< nil (cmajflt pid) (nil t t))
103 (utime "UTIME" proced-format-time right proced-time-lessp t (utime pid) (nil t t))
104 (stime "STIME" proced-format-time right proced-time-lessp t (stime pid) (nil t t))
105 (cutime "CUTIME" proced-format-time right proced-time-lessp t (cutime pid) (nil t t))
106 (cstime "CSTIME" proced-format-time right proced-time-lessp t (cstime pid) (nil t t))
107 (pri "PR" "%d" right proced-< t (pri pid) (nil t t))
108 (nice "NI" "%3d" 3 proced-< t (nice pid) (t t nil))
109 (thcount "THCOUNT" "%d" right proced-< t (thcount pid) (nil t t))
110 (start "START" proced-format-start 6 proced-time-lessp nil (start pid) (t t nil))
111 (vsize "VSIZE" "%d" right proced-< t (vsize pid) (nil t t))
112 (rss "RSS" "%d" right proced-< t (rss pid) (nil t t))
113 (etime "ETIME" proced-format-time right proced-time-lessp t (etime pid) (nil t t))
114 (pcpu "%CPU" "%.1f" right proced-< t (pcpu pid) (nil t t))
115 (pmem "%MEM" "%.1f" right proced-< t (pmem pid) (nil t t))
116 (args "ARGS" proced-format-args left proced-string-lessp nil (args pid) (nil t nil))
118 ;; attributes defined by proced (see `proced-process-attributes')
119 (pid "PID" "%d" right proced-< nil (pid) (t t nil))
120 ;; time: sum of utime and stime
121 (time "TIME" proced-format-time right proced-time-lessp t (time pid) (nil t t))
122 ;; ctime: sum of cutime and cstime
123 (ctime "CTIME" proced-format-time right proced-time-lessp t (ctime pid) (nil t t)))
124 "Alist of rules for handling Proced attributes.
126 Each element has the form
128 (KEY NAME FORMAT JUSTIFY PREDICATE REVERSE SORT-SCHEME REFINE-FLAGS).
130 Symbol KEY is the car of a process attribute.
132 String NAME appears in the header line.
134 FORMAT specifies the format for displaying the attribute values.
135 It can be a string passed to `format'. It can be a function called
136 with one argument, the value of the attribute. Nil means take as is.
138 If JUSTIFY is an integer, its modulus gives the width of the attribute
139 values formatted with FORMAT. If JUSTIFY is positive, NAME appears
140 right-justified, otherwise it appears left-justified. If JUSTIFY is 'left
141 or 'right, the field width is calculated from all field values in the listing.
142 If JUSTIFY is 'left, the field values are formatted left-justified and
143 right-justified otherwise.
145 PREDICATE is the predicate for sorting and filtering the process listing
146 based on attribute KEY. PREDICATE takes two arguments P1 and P2,
147 the corresponding attribute values of two processes. PREDICATE should
148 return 'equal if P1 has same rank like P2. Any other non-nil value says
149 that P1 is \"less than\" P2, or nil if not.
151 REVERSE is non-nil if the sort order is opposite to the order defined
152 by PREDICATE.
154 SORT-SCHEME is a list (KEY1 KEY2 ...) defining a hierarchy of rules
155 for sorting the process listing. KEY1, KEY2, ... are KEYs appearing as cars
156 of `proced-grammar-alist'. First the PREDICATE of KEY1 is evaluated.
157 If it yields non-equal, it defines the sort order for the corresponding
158 processes. If it evaluates to 'equal the PREDICATE of KEY2 is evaluated, etc.
160 REFINE-FLAGS is a list (LESS-B EQUAL-B LARGER-B) used by the command
161 `proced-refine' (see there) to refine the listing based on attribute KEY.
162 This command compares the value of attribute KEY of every process with
163 the value of attribute KEY of the process at the position of point
164 using PREDICATE.
165 If PREDICATE yields non-nil, the process is accepted if LESS-B is non-nil.
166 If PREDICATE yields 'equal, the process is accepted if EQUAL-B is non-nil.
167 If PREDICATE yields nil, the process is accepted if LARGER-B is non-nil."
168 :group 'proced
169 :type '(repeat (list :tag "Attribute"
170 (symbol :tag "Key")
171 (string :tag "Header")
172 (choice :tag "Format"
173 (const :tag "None" nil)
174 (string :tag "Format String")
175 (function :tag "Formatting Function"))
176 (choice :tag "Justification"
177 (const :tag "left" left)
178 (const :tag "right" right)
179 (integer :tag "width"))
180 (function :tag "Predicate")
181 (boolean :tag "Reverse Sort Order")
182 (repeat :tag "Sort Scheme" (symbol :tag "Key"))
183 (list :tag "Refine Flags"
184 (boolean :tag "Less")
185 (boolean :tag "Equal")
186 (boolean :tag "Larger")))))
188 (defcustom proced-custom-attributes nil
189 "List of functions defining custom attributes.
190 This variable extends the functionality of `proced-process-attributes'.
191 Each function is called with one argument, the list of attributes
192 of a system process. It returns a cons cell of the form (KEY . VALUE)
193 like `system-process-attributes'. This cons cell is appended to the list
194 returned by `proced-process-attributes'.
195 If the function returns nil, the value is ignored."
196 :group 'proced
197 :type '(repeat (function :tag "Attribute")))
199 ;; Formatting and sorting rules are defined "per attribute". If formatting
200 ;; and / or sorting should use more than one attribute, it appears more
201 ;; transparent to define a new derived attribute, so that formatting and
202 ;; sorting can use them consistently. (Are there exceptions to this rule?
203 ;; Would it be advantageous to have yet more general methods available?)
204 ;; Sorting can also be based on attributes that are invisible in the listing.
206 (defcustom proced-format-alist
207 '((short user pid pcpu pmem start time args)
208 (medium user pid pcpu pmem vsize rss ttname state start time args)
209 (long user euid group pid pri nice pcpu pmem vsize rss ttname state
210 start time args)
211 (verbose user euid group egid pid ppid pgrp sess comm pri nice pcpu pmem
212 state thcount vsize rss ttname tpgid minflt majflt cminflt cmajflt
213 start time utime stime ctime cutime cstime etime args))
214 "Alist of formats of listing.
215 The car of each element is a symbol, the name of the format.
216 The cdr is a list of keys appearing in `proced-grammar-alist'."
217 :group 'proced
218 :type '(alist :key-type (symbol :tag "Format Name")
219 :value-type (repeat :tag "Keys" (symbol :tag ""))))
221 (defcustom proced-format 'short
222 "Current format of Proced listing.
223 It can be the car of an element of `proced-format-alist'.
224 It can also be a list of keys appearing in `proced-grammar-alist'."
225 :group 'proced
226 :type '(choice (symbol :tag "Format Name")
227 (repeat :tag "Keys" (symbol :tag ""))))
228 (make-variable-buffer-local 'proced-format)
230 ;; FIXME: is there a better name for filter `user' that does not coincide
231 ;; with an attribute key?
232 (defcustom proced-filter-alist
233 `((user (user . ,(concat "\\`" (user-real-login-name) "\\'")))
234 (user-running (user . ,(concat "\\`" (user-real-login-name) "\\'"))
235 (state . "\\`[Rr]\\'"))
236 (all)
237 (all-running (state . "\\`[Rr]\\'"))
238 (emacs (fun-all . (lambda (list)
239 (proced-filter-children list ,(emacs-pid))))))
240 "Alist of process filters.
241 The car of each element is a symbol, the name of the filter.
242 The cdr is a list of elementary filters that are applied to every process.
243 A process is displayed if it passes all elementary filters of a selected
244 filter.
246 An elementary filter can be one of the following:
247 \(KEY . REGEXP) If value of attribute KEY matches REGEXP,
248 accept this process.
249 \(KEY . FUN) Apply function FUN to attribute KEY. Accept this process,
250 if FUN returns non-nil.
251 \(function . FUN) For each process, apply function FUN to list of attributes
252 of each. Accept the process if FUN returns non-nil.
253 \(fun-all . FUN) Apply function FUN to entire process list.
254 FUN must return the filtered list."
255 :group 'proced
256 :type '(repeat (cons :tag "Filter"
257 (symbol :tag "Filter Name")
258 (repeat :tag "Filters"
259 (choice (cons :tag "Key . Regexp" (symbol :tag "Key") regexp)
260 (cons :tag "Key . Function" (symbol :tag "Key") function)
261 (cons :tag "Function" (const :tag "Key: function" function) function)
262 (cons :tag "Fun-all" (const :tag "Key: fun-all" fun-all) function))))))
264 (defcustom proced-filter 'user
265 "Current filter of proced listing.
266 It can be the car of an element of `proced-filter-alist'.
267 It can also be a list of elementary filters as in the cdrs of the elements
268 of `proced-filter-alist'."
269 :group 'proced
270 :type '(choice (symbol :tag "Filter Name")
271 (repeat :tag "Filters"
272 (choice (cons :tag "Key . Regexp" (symbol :tag "Key") regexp)
273 (cons :tag "Key . Function" (symbol :tag "Key") function)
274 (cons :tag "Function" (const :tag "Key: function" function) function)
275 (cons :tag "Fun-all" (const :tag "Key: fun-all" fun-all) function)))))
276 (make-variable-buffer-local 'proced-filter)
278 (defcustom proced-sort 'pcpu
279 "Current sort scheme for proced listing.
280 It must be the KEY of an element of `proced-grammar-alist'.
281 It can also be a list of KEYs as in the SORT-SCHEMEs of the elements
282 of `proced-grammar-alist'."
283 :group 'proced
284 :type '(choice (symbol :tag "Sort Scheme")
285 (repeat :tag "Key List" (symbol :tag "Key"))))
286 (make-variable-buffer-local 'proced-format)
288 (defcustom proced-goal-attribute 'args
289 "If non-nil, key of the attribute that defines the `goal-column'."
290 :group 'proced
291 :type '(choice (const :tag "none" nil)
292 (symbol :tag "key")))
294 (defcustom proced-timer-interval 5
295 "Time interval in seconds for auto updating Proced buffers."
296 :group 'proced
297 :type 'integer)
299 (defcustom proced-timer-flag nil
300 "Non-nil for auto update of a Proced buffer.
301 Can be changed interactively via `proced-toggle-timer-flag'."
302 :group 'proced
303 :type 'boolean)
304 (make-variable-buffer-local 'proced-timer-flag)
306 ;; Internal variables
308 (defvar proced-process-alist nil
309 "Alist of processes displayed by Proced.
310 The car of each element is the PID, and the cdr is a list of
311 cons pairs, see `proced-process-attributes'.")
312 (make-variable-buffer-local 'proced-process-alist)
314 (defvar proced-sort-internal nil
315 "Sort scheme for listing (internal format).")
317 (defvar proced-marker-char ?* ; the answer is 42
318 "In proced, the current mark character.")
320 ;; Faces and font-lock code taken from dired,
321 ;; but face variables are deprecated for new code.
322 (defgroup proced-faces nil
323 "Faces used by Proced."
324 :group 'proced
325 :group 'faces)
327 (defface proced-mark
328 '((t (:inherit font-lock-constant-face)))
329 "Face used for proced marks."
330 :group 'proced-faces)
332 (defface proced-marked
333 '((t (:inherit font-lock-warning-face)))
334 "Face used for marked processes."
335 :group 'proced-faces)
337 (defface proced-sort-header
338 '((t (:inherit font-lock-keyword-face)))
339 "Face used for header of attribute used for sorting."
340 :group 'proced-faces)
342 (defvar proced-re-mark "^[^ \n]"
343 "Regexp matching a marked line.
344 Important: the match ends just after the marker.")
346 (defvar proced-header-line nil
347 "Headers in Proced buffer as a string.")
348 (make-variable-buffer-local 'proced-header-line)
350 (defvar proced-process-tree nil
351 "Process tree of listing (internal variable).")
353 (defvar proced-timer nil
354 "Stores if Proced timer is already installed.")
356 (defvar proced-log-buffer "*Proced log*"
357 "Name of Proced Log buffer.")
359 (defconst proced-help-string
360 "(n)ext, (p)revious, (m)ark, (u)nmark, (k)ill, (q)uit (type ? for more help)"
361 "Help string for proced.")
363 (defconst proced-header-help-echo
364 "mouse-1, mouse-2: sort by attribute %s%s (%s)"
365 "Help string shown when mouse is over a sortable header.")
367 (defconst proced-field-help-echo
368 "mouse-2, RET: refine by attribute %s %s"
369 "Help string shown when mouse is over a refinable field.")
371 (defvar proced-font-lock-keywords
372 `(;; (Any) proced marks.
373 (,proced-re-mark . 'proced-mark)
374 ;; Processes marked with `proced-marker-char'
375 ;; Should we make sure that only certain attributes are font-locked?
376 (,(concat "^[" (char-to-string proced-marker-char) "]")
377 ".+" (proced-move-to-goal-column) nil (0 'proced-marked))))
379 (defvar proced-mode-map
380 (let ((km (make-sparse-keymap)))
381 ;; moving
382 (define-key km " " 'proced-next-line)
383 (define-key km "n" 'next-line)
384 (define-key km "p" 'previous-line)
385 (define-key km "\C-n" 'next-line)
386 (define-key km "\C-p" 'previous-line)
387 (define-key km "\C-?" 'previous-line)
388 (define-key km [down] 'next-line)
389 (define-key km [up] 'previous-line)
390 ;; marking
391 (define-key km "d" 'proced-mark) ; Dired compatibility ("delete")
392 (define-key km "m" 'proced-mark)
393 (define-key km "u" 'proced-unmark)
394 (define-key km "\177" 'proced-unmark-backward)
395 (define-key km "M" 'proced-mark-all)
396 (define-key km "U" 'proced-unmark-all)
397 (define-key km "t" 'proced-toggle-marks)
398 (define-key km "C" 'proced-mark-children)
399 (define-key km "P" 'proced-mark-parents)
400 ;; filtering
401 (define-key km "f" 'proced-filter-interactive)
402 (define-key km [mouse-2] 'proced-refine)
403 (define-key km "\C-m" 'proced-refine)
404 ;; sorting
405 (define-key km "sc" 'proced-sort-pcpu)
406 (define-key km "sm" 'proced-sort-pmem)
407 (define-key km "sp" 'proced-sort-pid)
408 (define-key km "ss" 'proced-sort-start)
409 (define-key km "sS" 'proced-sort-interactive)
410 (define-key km "st" 'proced-sort-time)
411 (define-key km "su" 'proced-sort-user)
412 ;; similar to `Buffer-menu-sort-by-column'
413 (define-key km [header-line mouse-1] 'proced-sort-header)
414 (define-key km [header-line mouse-2] 'proced-sort-header)
415 ;; formatting
416 (define-key km "F" 'proced-format-interactive)
417 ;; operate
418 (define-key km "o" 'proced-omit-processes)
419 (define-key km "x" 'proced-send-signal) ; Dired compatibility
420 (define-key km "k" 'proced-send-signal) ; kill processes
421 ;; misc
422 (define-key km "g" 'revert-buffer) ; Dired compatibility
423 (define-key km "h" 'describe-mode)
424 (define-key km "?" 'proced-help)
425 (define-key km "q" 'quit-window)
426 (define-key km [remap undo] 'proced-undo)
427 (define-key km [remap advertised-undo] 'proced-undo)
429 "Keymap for proced commands.")
431 (easy-menu-define
432 proced-menu proced-mode-map "Proced Menu"
433 `("Proced"
434 ["Mark" proced-mark
435 :help "Mark Current Process"]
436 ["Unmark" proced-unmark
437 :help "Unmark Current Process"]
438 ["Mark All" proced-mark-all
439 :help "Mark All Processes"]
440 ["Unmark All" proced-unmark-all
441 :help "Unmark All Process"]
442 ["Toggle Marks" proced-toggle-marks
443 :help "Marked Processes Become Unmarked, and Vice Versa"]
444 ["Mark Children" proced-mark-children
445 :help "Mark Current Process and its Children"]
446 ["Mark Parents" proced-mark-parents
447 :help "Mark Current Process and its Parents"]
448 "--"
449 ("Filters"
450 :help "Select Filter for Process Listing"
451 ,@(mapcar (lambda (el)
452 (let ((filter (car el)))
453 `[,(symbol-name filter)
454 (proced-filter-interactive ',filter)
455 :style radio
456 :selected (eq proced-filter ',filter)]))
457 proced-filter-alist))
458 ("Sorting"
459 :help "Select Sort Scheme"
460 ["Sort..." proced-sort-interactive
461 :help "Sort Process List"]
462 "--"
463 ["Sort by %CPU" proced-sort-pcpu]
464 ["Sort by %MEM" proced-sort-pmem]
465 ["Sort by PID" proced-sort-pid]
466 ["Sort by START" proced-sort-start]
467 ["Sort by TIME" proced-sort-time]
468 ["Sort by USER" proced-sort-user])
469 ("Formats"
470 :help "Select Format for Process Listing"
471 ,@(mapcar (lambda (el)
472 (let ((format (car el)))
473 `[,(symbol-name format)
474 (proced-format-interactive ',format)
475 :style radio
476 :selected (eq proced-format ',format)]))
477 proced-format-alist))
478 "--"
479 ["Omit Marked Processes" proced-omit-processes
480 :help "Omit Marked Processes in Process Listing."]
481 "--"
482 ["Revert" revert-buffer
483 :help "Revert Process Listing"]
484 ["Auto Update" proced-toggle-timer-flag
485 :style radio
486 :selected (eval proced-timer-flag)
487 :help "Auto Update of Proced Buffer"]
488 ["Send signal" proced-send-signal
489 :help "Send Signal to Marked Processes"]))
491 ;; helper functions
492 (defun proced-marker-regexp ()
493 "Return regexp matching `proced-marker-char'."
494 ;; `proced-marker-char' must appear in column zero
495 (concat "^" (regexp-quote (char-to-string proced-marker-char))))
497 (defun proced-success-message (action count)
498 "Display success message for ACTION performed for COUNT processes."
499 (message "%s %s process%s" action count (if (= 1 count) "" "es")))
501 ;; Unlike dired, we do not define our own commands for vertical motion.
502 ;; If `goal-column' is set, `next-line' and `previous-line' are fancy
503 ;; commands to satisfy our modest needs. If `proced-goal-attribute'
504 ;; and/or `goal-column' are not set, `next-line' and `previous-line'
505 ;; are really what we need to preserve the column of point.
506 ;; We use `proced-move-to-goal-column' for "non-interactive" cases only
507 ;; to get a well-defined position of point.
509 (defun proced-move-to-goal-column ()
510 "Move to `goal-column' if non-nil. Return position of point."
511 (beginning-of-line)
512 (unless (eobp)
513 (if goal-column
514 (forward-char goal-column)
515 (forward-char 2)))
516 (point))
518 (defun proced-header-line ()
519 "Return header line for Proced buffer."
520 (list (propertize " " 'display '(space :align-to 0))
521 (replace-regexp-in-string ;; preserve text properties
522 "\\(%\\)" "\\1\\1" (substring proced-header-line (window-hscroll)))))
524 (defun proced-pid-at-point ()
525 "Return pid of system process at point.
526 Return nil if point is not on a process line."
527 (save-excursion
528 (beginning-of-line)
529 (if (looking-at "^. .")
530 (get-text-property (match-end 0) 'proced-pid))))
532 ;; proced mode
534 (define-derived-mode proced-mode nil "Proced"
535 "Mode for displaying UNIX system processes and sending signals to them.
536 Type \\[proced] to start a Proced session. In a Proced buffer
537 type \\<proced-mode-map>\\[proced-mark] to mark a process for later commands.
538 Type \\[proced-send-signal] to send signals to marked processes.
540 The initial content of a listing is defined by the variable `proced-filter'
541 and the variable `proced-format'.
542 The variable `proced-filter' specifies which system processes are displayed.
543 The variable `proced-format' specifies which attributes are displayed for
544 each process. Type \\[proced-filter-interactive] and \\[proced-format-interactive]
545 to change the values of `proced-filter' and `proced-format'.
546 The current value of the variable `proced-filter' is indicated in the
547 mode line.
549 The sort order of Proced listings is defined by the variable `proced-sort'.
550 Type \\[proced-sort-interactive] or click on a header in the header line
551 to change the sort scheme. The current sort scheme is indicated in the
552 mode line, using \"+\" or \"-\" for ascending or descending sort order.
554 An existing Proced listing can be refined by typing \\[proced-refine]
555 with point on the attribute of a process. If point is on the attribute ATTR,
556 this compares the value of ATTR of every process with the value of ATTR
557 of the process at the position of point. See `proced-refine' for details.
558 Refining an existing listing does not update the variable `proced-filter'.
560 The attribute-specific rules for formatting, filtering, sorting, and refining
561 are defined in `proced-grammar-alist'.
563 \\{proced-mode-map}"
564 (abbrev-mode 0)
565 (auto-fill-mode 0)
566 (setq buffer-read-only t
567 truncate-lines t
568 header-line-format '(:eval (proced-header-line)))
569 (add-hook 'post-command-hook 'force-mode-line-update nil t)
570 (set (make-local-variable 'revert-buffer-function) 'proced-revert)
571 (set (make-local-variable 'font-lock-defaults)
572 '(proced-font-lock-keywords t nil nil beginning-of-line))
573 (if (and (not proced-timer) proced-timer-interval)
574 (setq proced-timer
575 (run-at-time t proced-timer-interval 'proced-timer))))
577 (defvar proced-available nil
578 "Non-nil means Proced is known to work on this system.")
580 ;; Proced mode is suitable only for specially formatted data.
581 (put 'proced-mode 'mode-class 'special)
583 ;;;###autoload
584 (defun proced (&optional arg)
585 "Generate a listing of UNIX system processes.
586 If invoked with optional ARG the window displaying the process
587 information will be displayed but not selected.
589 See `proced-mode' for a description of features available in Proced buffers."
590 (interactive "P")
591 (or proced-available
592 (setq proced-available (not (null (list-system-processes))))
593 (error "Proced is not available on this system"))
594 (let ((buffer (get-buffer-create "*Proced*")) new)
595 (set-buffer buffer)
596 (setq new (zerop (buffer-size)))
597 (if new (proced-mode))
598 (if (or new arg)
599 (proced-update t))
600 (if arg
601 (display-buffer buffer)
602 (pop-to-buffer buffer)
603 (message
604 (substitute-command-keys
605 "Type \\<proced-mode-map>\\[quit-window] to quit, \\[proced-help] for help")))))
607 (defun proced-timer ()
608 "Auto-update Proced buffers using `run-at-time'."
609 (dolist (buf (buffer-list))
610 (with-current-buffer buf
611 (if (and (eq major-mode 'proced-mode)
612 proced-timer-flag)
613 (proced-update t t)))))
615 (defun proced-toggle-timer-flag (arg)
616 "Change whether this Proced buffer is updated automatically.
617 With prefix ARG, update this buffer automatically if ARG is positive,
618 otherwise do not update. Sets the variable `proced-timer-flag'.
619 The time interval for updates is specified via `proced-timer-interval'."
620 (interactive (list (or current-prefix-arg 'toggle)))
621 (setq proced-timer-flag
622 (cond ((eq arg 'toggle) (not proced-timer-flag))
623 (arg (> (prefix-numeric-value arg) 0))
624 (t (not proced-timer-flag))))
625 (message "`proced-timer-flag' set to %s" proced-timer-flag))
627 (defun proced-mark (&optional count)
628 "Mark the current (or next COUNT) processes."
629 (interactive "p")
630 (proced-do-mark t count))
632 (defun proced-unmark (&optional count)
633 "Unmark the current (or next COUNT) processes."
634 (interactive "p")
635 (proced-do-mark nil count))
637 (defun proced-unmark-backward (&optional count)
638 "Unmark the previous (or COUNT previous) processes."
639 ;; Analogous to `dired-unmark-backward',
640 ;; but `ibuffer-unmark-backward' behaves different.
641 (interactive "p")
642 (proced-do-mark nil (- (or count 1))))
644 (defun proced-do-mark (mark &optional count)
645 "Mark the current (or next COUNT) processes using MARK."
646 (or count (setq count 1))
647 (let ((backward (< count 0))
648 buffer-read-only)
649 (setq count (1+ (if (<= 0 count) count
650 (min (1- (line-number-at-pos)) (abs count)))))
651 (beginning-of-line)
652 (while (not (or (zerop (setq count (1- count))) (eobp)))
653 (proced-insert-mark mark backward))
654 (proced-move-to-goal-column)))
656 (defun proced-mark-all ()
657 "Mark all processes.
658 If `transient-mark-mode' is turned on and the region is active,
659 mark the region."
660 (interactive)
661 (proced-do-mark-all t))
663 (defun proced-unmark-all ()
664 "Unmark all processes.
665 If `transient-mark-mode' is turned on and the region is active,
666 unmark the region."
667 (interactive)
668 (proced-do-mark-all nil))
670 (defun proced-do-mark-all (mark)
671 "Mark all processes using MARK.
672 If `transient-mark-mode' is turned on and the region is active,
673 mark the region."
674 (let ((count 0) end buffer-read-only)
675 (save-excursion
676 (if (use-region-p)
677 ;; Operate even on those lines that are only partially a part
678 ;; of region. This appears most consistent with
679 ;; `proced-move-to-goal-column'.
680 (progn (setq end (save-excursion
681 (goto-char (region-end))
682 (unless (looking-at "^") (forward-line))
683 (point)))
684 (goto-char (region-beginning))
685 (unless (looking-at "^") (beginning-of-line)))
686 (goto-char (point-min))
687 (setq end (point-max)))
688 (while (< (point) end)
689 (setq count (1+ count))
690 (proced-insert-mark mark))
691 (proced-success-message "Marked" count))))
693 (defun proced-toggle-marks ()
694 "Toggle marks: marked processes become unmarked, and vice versa."
695 (interactive)
696 (let ((mark-re (proced-marker-regexp))
697 buffer-read-only)
698 (save-excursion
699 (goto-char (point-min))
700 (while (not (eobp))
701 (cond ((looking-at mark-re)
702 (proced-insert-mark nil))
703 ((looking-at " ")
704 (proced-insert-mark t))
706 (forward-line 1)))))))
708 (defun proced-insert-mark (mark &optional backward)
709 "If MARK is non-nil, insert `proced-marker-char'.
710 If BACKWARD is non-nil, move one line backwards before inserting the mark.
711 Otherwise move one line forward after inserting the mark."
712 (if backward (forward-line -1))
713 (insert (if mark proced-marker-char ?\s))
714 (delete-char 1)
715 (unless backward (forward-line)))
717 (defun proced-mark-children (ppid &optional omit-ppid)
718 "Mark child processes of process PPID.
719 Also mark process PPID unless prefix OMIT-PPID is non-nil."
720 (interactive (list (proced-pid-at-point) current-prefix-arg))
721 (proced-mark-process-alist
722 (proced-filter-children proced-process-alist ppid omit-ppid)))
724 (defun proced-mark-parents (cpid &optional omit-cpid)
725 "Mark parent processes of process CPID.
726 Also mark CPID unless prefix OMIT-CPID is non-nil."
727 (interactive (list (proced-pid-at-point) current-prefix-arg))
728 (proced-mark-process-alist
729 (proced-filter-parents proced-process-alist cpid omit-cpid)))
731 (defun proced-mark-process-alist (process-alist &optional quiet)
732 (let ((count 0))
733 (if process-alist
734 (let (buffer-read-only)
735 (save-excursion
736 (goto-char (point-min))
737 (while (not (eobp))
738 (when (assq (proced-pid-at-point) process-alist)
739 (insert proced-marker-char)
740 (delete-char 1)
741 (setq count (1+ count)))
742 (forward-line)))))
743 (unless quiet
744 (proced-success-message "Marked" count))))
746 ;; Mostly analog of `dired-do-kill-lines'.
747 ;; However, for negative args the target lines of `dired-do-kill-lines'
748 ;; include the current line, whereas `dired-mark' for negative args operates
749 ;; on the preceding lines. Here we are consistent with `dired-mark'.
750 (defun proced-omit-processes (&optional arg quiet)
751 "Omit marked processes.
752 With prefix ARG, omit that many lines starting with the current line.
753 \(A negative argument omits backward.)
754 If `transient-mark-mode' is turned on and the region is active,
755 omit the processes in region.
756 If QUIET is non-nil suppress status message.
757 Returns count of omitted lines."
758 (interactive "P")
759 (let ((mark-re (proced-marker-regexp))
760 (count 0)
761 buffer-read-only)
762 (cond ((use-region-p) ;; Omit active region
763 (let ((lines (count-lines (region-beginning) (region-end))))
764 (save-excursion
765 (goto-char (region-beginning))
766 (while (< count lines)
767 (proced-omit-process)
768 (setq count (1+ count))))))
769 ((not arg) ;; Omit marked lines
770 (save-excursion
771 (goto-char (point-min))
772 (while (and (not (eobp))
773 (re-search-forward mark-re nil t))
774 (proced-omit-process)
775 (setq count (1+ count)))))
776 ((< 0 arg) ;; Omit forward
777 (while (and (not (eobp)) (< count arg))
778 (proced-omit-process)
779 (setq count (1+ count))))
780 ((< arg 0) ;; Omit backward
781 (while (and (not (bobp)) (< count (- arg)))
782 (forward-line -1)
783 (proced-omit-process)
784 (setq count (1+ count)))))
785 (unless (zerop count) (proced-move-to-goal-column))
786 (unless quiet (proced-success-message "Omitted" count))
787 count))
789 (defun proced-omit-process ()
790 "Omit process from listing point is on.
791 Update `proced-process-alist' accordingly."
792 (setq proced-process-alist
793 (assq-delete-all (proced-pid-at-point) proced-process-alist))
794 (delete-region (line-beginning-position)
795 (save-excursion (forward-line) (point))))
797 ;;; Filtering
799 (defun proced-filter (process-alist filter-list)
800 "Apply FILTER-LIST to PROCESS-ALIST.
801 Return the filtered process list."
802 (if (symbolp filter-list)
803 (setq filter-list (cdr (assq filter-list proced-filter-alist))))
804 (dolist (filter filter-list)
805 (let (new-alist)
806 (cond ( ;; apply function to entire process list
807 (eq (car filter) 'fun-all)
808 (setq new-alist (funcall (cdr filter) process-alist)))
809 ( ;; apply predicate to each list of attributes
810 (eq (car filter) 'function)
811 (dolist (process process-alist)
812 (if (funcall (car filter) (cdr process))
813 (push process new-alist))))
814 (t ;; apply predicate to specified attribute
815 (let ((fun (if (stringp (cdr filter))
816 `(lambda (val)
817 (string-match ,(cdr filter) val))
818 (cdr filter)))
819 value)
820 (dolist (process process-alist)
821 (setq value (cdr (assq (car filter) (cdr process))))
822 (if (and value (funcall fun value))
823 (push process new-alist))))))
824 (setq process-alist new-alist)))
825 process-alist)
827 (defun proced-filter-interactive (scheme)
828 "Filter Proced buffer using SCHEME.
829 When called interactively, an empty string means nil, i.e., no filtering.
830 Set variable `proced-filter' to SCHEME. Revert listing."
831 (interactive
832 (let ((scheme (completing-read "Filter: "
833 proced-filter-alist nil t)))
834 (list (if (string= "" scheme) nil (intern scheme)))))
835 ;; only update if necessary
836 (unless (eq proced-filter scheme)
837 (setq proced-filter scheme)
838 (proced-update t)))
840 (defun proced-process-tree (process-alist)
841 "Return process tree for PROCESS-ALIST.
842 The process tree is an alist with elements (PPID PID1 PID2 ...).
843 PPID is a parent PID. PID1, PID2, ... are the child processes of PPID.
844 The list of children does not include grandchildren."
845 (let (children-list ppid cpids)
846 (dolist (process process-alist children-list)
847 (setq ppid (cdr (assq 'ppid (cdr process))))
848 (if ppid
849 (setq children-list
850 (if (setq cpids (assq ppid children-list))
851 (cons (cons ppid (cons (car process) (cdr cpids)))
852 (assq-delete-all ppid children-list))
853 (cons (list ppid (car process))
854 children-list)))))))
856 (defun proced-filter-children (process-alist ppid &optional omit-ppid)
857 "For PROCESS-ALIST return list of child processes of PPID.
858 This list includes PPID unless OMIT-PPID is non-nil."
859 (let ((proced-process-tree (proced-process-tree process-alist))
860 new-alist)
861 (dolist (pid (proced-children-pids ppid))
862 (push (assq pid process-alist) new-alist))
863 (if omit-ppid
864 (assq-delete-all ppid new-alist)
865 new-alist)))
867 ;; helper function
868 (defun proced-children-pids (ppid)
869 "Return list of children PIDs of PPID (including PPID)."
870 (let ((cpids (cdr (assq ppid proced-process-tree))))
871 (if cpids
872 (cons ppid (apply 'append (mapcar 'proced-children-pids cpids)))
873 (list ppid))))
875 (defun proced-filter-parents (process-alist pid &optional omit-pid)
876 "For PROCESS-ALIST return list of parent processes of PID.
877 This list includes CPID unless OMIT-CPID is non-nil."
878 (let ((parent-list (unless omit-pid (list (assq pid process-alist)))))
879 (while (setq pid (cdr (assq 'ppid (cdr (assq pid process-alist)))))
880 (push (assq pid process-alist) parent-list))
881 parent-list))
883 ;; Refining
885 ;; Filters are used to select the processes in a new listing.
886 ;; Refiners are used to narrow down further (interactively) the processes
887 ;; in an existing listing.
889 (defun proced-refine (&optional event)
890 "Refine Proced listing by comparing with the attribute value at point.
891 Optional EVENT is the location of the Proced field.
893 If point is on the attribute ATTR, this command compares the value of ATTR
894 of every process with the value of ATTR of the process at the position
895 of point. One can select processes for which the value of ATTR is
896 \"less than\", \"equal\", and / or \"larger\" than ATTR of the process
897 point is on.
899 The predicate for the comparison of two ATTR values is defined
900 in `proced-grammar-alist'. For each return value of the predicate
901 a refine flag is defined in `proced-grammar-alist'. A process is included
902 in the new listing if the refine flag for the return value of the predicate
903 is non-nil.
904 The help-echo string for `proced-refine' uses \"+\" or \"-\" to indicate
905 the current values of the refine flags.
907 This command refines an already existing process listing based initially
908 on the variable `proced-filter'. It does not change this variable.
909 It does not revert the listing. If you frequently need a certain refinement,
910 consider defining a new filter in `proced-filter-alist'."
911 (interactive (list last-input-event))
912 (if event (posn-set-point (event-end event)))
913 (let ((key (get-text-property (point) 'proced-key))
914 (pid (get-text-property (point) 'proced-pid)))
915 (if (and key pid)
916 (let* ((grammar (assq key proced-grammar-alist))
917 (predicate (nth 4 grammar))
918 (refiner (nth 7 grammar))
919 (ref (cdr (assq key (cdr (assq pid proced-process-alist)))))
920 val new-alist)
921 (when ref
922 (dolist (process proced-process-alist)
923 (setq val (funcall predicate (cdr (assq key (cdr process))) ref))
924 (if (cond ((not val) (nth 2 refiner))
925 ((eq val 'equal) (nth 1 refiner))
926 (val (car refiner)))
927 (push process new-alist)))
928 (setq proced-process-alist new-alist)
929 ;; Do not revert listing.
930 (proced-update)))
931 (message "No refiner defined here."))))
933 ;; Proced predicates for sorting and filtering are based on a three-valued
934 ;; logic:
935 ;; Predicates take two arguments P1 and P2, the corresponding attribute
936 ;; values of two processes. Predicates should return 'equal if P1 has
937 ;; same rank like P2. Any other non-nil value says that P1 is "less than" P2,
938 ;; or nil if not.
940 (defun proced-< (num1 num2)
941 "Return t if NUM1 less than NUM2.
942 Return `equal' if NUM1 equals NUM2. Return nil if NUM1 greater than NUM2."
943 (if (= num1 num2)
944 'equal
945 (< num1 num2)))
947 (defun proced-string-lessp (s1 s2)
948 "Return t if string S1 is less than S2 in lexicographic order.
949 Return `equal' if S1 and S2 have identical contents.
950 Return nil otherwise."
951 (if (string= s1 s2)
952 'equal
953 (string-lessp s1 s2)))
955 (defun proced-time-lessp (t1 t2)
956 "Return t if time value T1 is less than time value T2.
957 Return `equal' if T1 equals T2. Return nil otherwise."
958 (with-decoded-time-value ((high1 low1 micro1 t1)
959 (high2 low2 micro2 t2))
960 (cond ((< high1 high2))
961 ((< high2 high1) nil)
962 ((< low1 low2))
963 ((< low2 low1) nil)
964 ((< micro1 micro2))
965 ((< micro2 micro1) nil)
966 (t 'equal))))
968 ;;; Sorting
970 (defsubst proced-xor (b1 b2)
971 "Return the logical exclusive or of args B1 and B2."
972 (and (or b1 b2)
973 (not (and b1 b2))))
975 (defun proced-sort-p (p1 p2)
976 "Predicate for sorting processes P1 and P2."
977 (if (not (cdr proced-sort-internal))
978 ;; only one predicate: fast scheme
979 (let* ((sorter (car proced-sort-internal))
980 (k1 (cdr (assq (car sorter) (cdr p1))))
981 (k2 (cdr (assq (car sorter) (cdr p2)))))
982 ;; if the attributes are undefined, we should really abort sorting
983 (if (and k1 k2)
984 (proced-xor (funcall (nth 1 sorter) k1 k2)
985 (nth 2 sorter))))
986 (let ((sort-list proced-sort-internal) sorter predicate k1 k2)
987 (catch 'done
988 (while (setq sorter (pop sort-list))
989 (setq k1 (cdr (assq (car sorter) (cdr p1)))
990 k2 (cdr (assq (car sorter) (cdr p2)))
991 predicate
992 (if (and k1 k2)
993 (funcall (nth 1 sorter) k1 k2)))
994 (if (not (eq predicate 'equal))
995 (throw 'done (proced-xor predicate (nth 2 sorter)))))
996 (eq t predicate)))))
998 (defun proced-sort (process-alist sorter)
999 "Sort PROCESS-ALIST using scheme SORTER.
1000 Return the sorted process list."
1001 ;; translate SORTER into a list of lists (KEY PREDICATE REVERSE)
1002 (setq proced-sort-internal
1003 (mapcar (lambda (arg)
1004 (let ((grammar (assq arg proced-grammar-alist)))
1005 (list arg (nth 4 grammar) (nth 5 grammar))))
1006 (cond ((listp sorter) sorter)
1007 ((and (symbolp sorter)
1008 (nth 6 (assq sorter proced-grammar-alist))))
1009 ((symbolp sorter) (list sorter))
1010 (t (error "Sorter undefined %s" sorter)))))
1011 (if proced-sort-internal
1012 (sort process-alist 'proced-sort-p)
1013 process-alist))
1015 (defun proced-sort-interactive (scheme &optional revert)
1016 "Sort Proced buffer using SCHEME.
1017 When called interactively, an empty string means nil, i.e., no sorting.
1018 With prefix REVERT non-nil revert listing.
1020 Set variable `proced-sort' to SCHEME. The current sort scheme is displayed
1021 in the mode line, using \"+\" or \"-\" for ascending or descending order."
1022 (interactive
1023 (let ((scheme (completing-read "Sort attribute: "
1024 proced-grammar-alist nil t)))
1025 (list (if (string= "" scheme) nil (intern scheme))
1026 current-prefix-arg)))
1027 ;; only update if necessary
1028 (when (or (not (eq proced-sort scheme)) revert)
1029 (setq proced-sort scheme)
1030 (proced-update revert)))
1032 (defun proced-sort-pcpu (&optional revert)
1033 "Sort Proced buffer by percentage CPU time (%CPU)."
1034 (interactive "P")
1035 (proced-sort-interactive 'pcpu revert))
1037 (defun proced-sort-pmem (&optional revert)
1038 "Sort Proced buffer by percentage memory usage (%MEM)."
1039 (interactive "P")
1040 (proced-sort-interactive 'pmem))
1042 (defun proced-sort-pid (&optional revert)
1043 "Sort Proced buffer by PID."
1044 (interactive "P")
1045 (proced-sort-interactive 'pid revert))
1047 (defun proced-sort-start (&optional revert)
1048 "Sort Proced buffer by time the command started (START)."
1049 (interactive "P")
1050 (proced-sort-interactive 'start revert))
1052 (defun proced-sort-time (&optional revert)
1053 "Sort Proced buffer by CPU time (TIME)."
1054 (interactive "P")
1055 (proced-sort-interactive 'time revert))
1057 (defun proced-sort-user (&optional revert)
1058 "Sort Proced buffer by USER."
1059 (interactive "P")
1060 (proced-sort-interactive 'user revert))
1062 (defun proced-sort-header (event &optional revert)
1063 "Sort Proced listing based on an attribute.
1064 EVENT is a mouse event with starting position in the header line.
1065 It is converted in the corresponding attribute key.
1066 This command updates the variable `proced-sort'."
1067 (interactive "e\nP")
1068 (let ((start (event-start event))
1069 col key)
1070 (save-selected-window
1071 (select-window (posn-window start))
1072 (setq col (+ (1- (car (posn-actual-col-row start)))
1073 (window-hscroll)))
1074 (when (and (<= 0 col) (< col (length proced-header-line)))
1075 (setq key (get-text-property col 'proced-key proced-header-line))
1076 (if key
1077 (proced-sort-interactive key revert)
1078 (message "No sorter defined here."))))))
1080 ;;; Formating
1082 (defun proced-format-time (time)
1083 "Format time interval TIME."
1084 (let* ((ftime (float-time time))
1085 (days (truncate ftime 86400))
1086 (ftime (mod ftime 86400))
1087 (hours (truncate ftime 3600))
1088 (ftime (mod ftime 3600))
1089 (minutes (truncate ftime 60))
1090 (seconds (mod ftime 60)))
1091 (cond ((< 0 days)
1092 (format "%d-%02d:%02d:%02d" days hours minutes seconds))
1093 ((< 0 hours)
1094 (format "%02d:%02d:%02d" hours minutes seconds))
1096 (format "%02d:%02d" minutes seconds)))))
1098 (defun proced-format-start (start)
1099 "Format time START.
1100 The return string is always 6 characters wide."
1101 (let ((d-start (decode-time start))
1102 (d-current (decode-time)))
1103 (cond ( ;; process started in previous years
1104 (< (nth 5 d-start) (nth 5 d-current))
1105 (format-time-string " %Y" start))
1106 ;; process started today
1107 ((and (= (nth 3 d-start) (nth 3 d-current))
1108 (= (nth 4 d-start) (nth 4 d-current)))
1109 (format-time-string " %H:%M" start))
1110 (t ;; process started this year
1111 (format-time-string "%b %e" start)))))
1113 (defun proced-format-ttname (ttname)
1114 "Format attribute TTNAME, omitting path \"/dev/\"."
1115 ;; Does this work for all systems?
1116 (substring ttname (if (string-match "\\`/dev/" ttname)
1117 (match-end 0) 0)))
1119 (defun proced-format-args (args)
1120 "Format attribute ARGS.
1121 Replace newline characters by \"^J\" (two characters)."
1122 (replace-regexp-in-string "\n" "^J" args))
1124 (defun proced-format (process-alist format)
1125 "Display PROCESS-ALIST using FORMAT."
1126 (if (symbolp format)
1127 (setq format (cdr (assq format proced-format-alist))))
1128 (insert (make-string (length process-alist) ?\n))
1129 (let ((whitespace " ") header-list grammar)
1130 ;; Loop over all attributes
1131 (while (setq grammar (pop format))
1132 (if (symbolp grammar)
1133 (setq grammar (assq grammar proced-grammar-alist)))
1134 (let* ((key (car grammar))
1135 (fun (cond ((stringp (nth 2 grammar))
1136 `(lambda (arg) (format ,(nth 2 grammar) arg)))
1137 ((not (nth 2 grammar)) 'identity)
1138 ( t (nth 2 grammar))))
1139 (whitespace (if format whitespace ""))
1140 ;; Text properties:
1141 ;; We use the text property `proced-key' to store in each
1142 ;; field the corresponding key.
1143 ;; Of course, the sort predicate appearing in help-echo
1144 ;; is only part of the story. But it gives the main idea.
1145 (hprops `(proced-key ,key mouse-face highlight
1146 help-echo ,(format proced-header-help-echo
1147 (if (nth 5 grammar) "-" "+")
1148 (nth 1 grammar)
1149 (if (nth 5 grammar) "descending" "ascending"))))
1150 (fprops `(proced-key ,key mouse-face highlight
1151 help-echo ,(format proced-field-help-echo
1152 (nth 1 grammar)
1153 (mapconcat (lambda (s)
1154 (if s "+" "-"))
1155 (nth 7 grammar) ""))))
1156 value)
1158 ;; highlight the header of the sort column
1159 (if (eq key proced-sort)
1160 (setq hprops (append '(face proced-sort-header) hprops)))
1161 (goto-char (point-min))
1162 (cond ( ;; fixed width of output field
1163 (numberp (nth 3 grammar))
1164 (dolist (process process-alist)
1165 (end-of-line)
1166 (setq value (cdr (assq key (cdr process))))
1167 (insert (if value
1168 (apply 'propertize (funcall fun value) fprops)
1169 (make-string (abs (nth 3 grammar)) ?\s))
1170 whitespace)
1171 (forward-line))
1172 (push (format (concat "%" (number-to-string (nth 3 grammar)) "s")
1173 (apply 'propertize (nth 1 grammar) hprops))
1174 header-list))
1176 ( ;; last field left-justified
1177 (and (not format) (eq 'left (nth 3 grammar)))
1178 (dolist (process process-alist)
1179 (end-of-line)
1180 (setq value (cdr (assq key (cdr process))))
1181 (if value (insert (apply 'propertize (funcall fun value) fprops)))
1182 (forward-line))
1183 (push (apply 'propertize (nth 1 grammar) hprops) header-list))
1185 (t ;; calculated field width
1186 (let ((width (length (nth 1 grammar)))
1187 field-list value)
1188 (dolist (process process-alist)
1189 (setq value (cdr (assq key (cdr process))))
1190 (if value
1191 (setq value (apply 'propertize (funcall fun value) fprops)
1192 width (max width (length value))
1193 field-list (cons value field-list))
1194 (push "" field-list)))
1195 (let ((afmt (concat "%" (if (eq 'left (nth 3 grammar)) "-" "")
1196 (number-to-string width) "s")))
1197 (push (format afmt (apply 'propertize (nth 1 grammar) hprops))
1198 header-list)
1199 (dolist (value (nreverse field-list))
1200 (end-of-line)
1201 (insert (format afmt value) whitespace)
1202 (forward-line))))))))
1204 ;; final cleanup
1205 (goto-char (point-min))
1206 (dolist (process process-alist)
1207 ;; We use the text property `proced-pid' to store in each line
1208 ;; the corresponding pid
1209 (put-text-property (point) (line-end-position) 'proced-pid (car process))
1210 (forward-line))
1211 ;; Set header line
1212 (setq proced-header-line
1213 (mapconcat 'identity (nreverse header-list) whitespace))
1214 (if (string-match "[ \t]+$" proced-header-line)
1215 (setq proced-header-line (substring proced-header-line 0
1216 (match-beginning 0))))
1217 ;; (delete-trailing-whitespace)
1218 (goto-char (point-min))
1219 (while (re-search-forward "[ \t\r]+$" nil t)
1220 (delete-region (match-beginning 0) (match-end 0)))))
1222 (defun proced-format-interactive (scheme &optional revert)
1223 "Format Proced buffer using SCHEME.
1224 When called interactively, an empty string means nil, i.e., no formatting.
1225 Set variable `proced-format' to SCHEME.
1226 With prefix REVERT non-nil revert listing."
1227 (interactive
1228 (let ((scheme (completing-read "Format: "
1229 proced-format-alist nil t)))
1230 (list (if (string= "" scheme) nil (intern scheme))
1231 current-prefix-arg)))
1232 ;; only update if necessary
1233 (when (or (not (eq proced-format scheme)) revert)
1234 (setq proced-format scheme)
1235 (proced-update revert)))
1237 ;; generate listing
1239 (defun proced-process-attributes ()
1240 "Return alist of attributes for each system process.
1241 This alist can be customized via `proced-custom-attributes'."
1242 (mapcar (lambda (pid)
1243 (let* ((attributes (system-process-attributes pid))
1244 (utime (cdr (assq 'utime attributes)))
1245 (stime (cdr (assq 'stime attributes)))
1246 (cutime (cdr (assq 'cutime attributes)))
1247 (cstime (cdr (assq 'cstime attributes)))
1248 attr)
1249 (setq attributes
1250 (append (list (cons 'pid pid))
1251 (if (and utime stime)
1252 (list (cons 'time (time-add utime stime))))
1253 (if (and cutime cstime)
1254 (list (cons 'ctime (time-add cutime cstime))))
1255 attributes))
1256 (dolist (fun proced-custom-attributes)
1257 (if (setq attr (funcall fun attributes))
1258 (push attr attributes)))
1259 (cons pid attributes)))
1260 (list-system-processes)))
1262 (defun proced-update (&optional revert quiet)
1263 "Update the `proced' process information. Preserves point and marks.
1264 With prefix REVERT non-nil, revert listing.
1265 Suppress status information if QUIET is nil."
1266 ;; This is the main function that generates and updates the process listing.
1267 (interactive "P")
1268 (setq revert (or revert (not proced-process-alist)))
1269 (or quiet (message (if revert "Updating process information..."
1270 "Updating process display...")))
1271 (if revert ;; evaluate all processes
1272 (setq proced-process-alist (proced-process-attributes)))
1273 ;; filtering and sorting
1274 (setq proced-process-alist
1275 (proced-sort (proced-filter proced-process-alist
1276 proced-filter) proced-sort))
1278 ;; It is useless to keep undo information if we revert, filter, or
1279 ;; refine the listing so that `proced-process-alist' has changed.
1280 ;; We could keep the undo information if we only re-sort the buffer.
1281 ;; Would that be useful? Re-re-sorting is easy, too.
1282 (if (consp buffer-undo-list)
1283 (setq buffer-undo-list nil))
1284 (let ((buffer-undo-list t)
1285 ;; If point is on a field, we try to return point to that field.
1286 ;; Otherwise we try to return to the same column
1287 (old-pos (let ((pid (proced-pid-at-point))
1288 (key (get-text-property (point) 'proced-key)))
1289 (list pid key ; can both be nil
1290 (if key
1291 (if (get-text-property (1- (point)) 'proced-key)
1292 (- (point) (previous-single-property-change
1293 (point) 'proced-key))
1295 (current-column)))))
1296 buffer-read-only mp-list)
1297 ;; remember marked processes (whatever the mark was)
1298 (goto-char (point-min))
1299 (while (re-search-forward "^\\(\\S-\\)" nil t)
1300 (push (cons (save-match-data (proced-pid-at-point))
1301 (match-string-no-properties 1)) mp-list))
1303 ;; generate listing
1304 (erase-buffer)
1305 (proced-format proced-process-alist proced-format)
1306 (goto-char (point-min))
1307 (while (not (eobp))
1308 (insert " ")
1309 (forward-line))
1310 (setq proced-header-line (concat " " proced-header-line))
1311 (if revert (set-buffer-modified-p nil))
1313 ;; set `goal-column'
1314 (let ((grammar (assq proced-goal-attribute proced-grammar-alist)))
1315 (setq goal-column ;; set to nil if no match
1316 (if (and grammar
1317 (not (zerop (buffer-size)))
1318 (string-match (regexp-quote (nth 1 grammar))
1319 proced-header-line))
1320 (if (nth 3 grammar)
1321 (match-beginning 0)
1322 (match-end 0)))))
1324 ;; Restore process marks and buffer position (if possible).
1325 ;; Sometimes this puts point in the middle of the proced buffer
1326 ;; where it is not interesting. Is there a better / more flexible solution?
1327 (goto-char (point-min))
1328 (let (pid mark new-pos)
1329 (if (or mp-list (car old-pos))
1330 (while (not (eobp))
1331 (setq pid (proced-pid-at-point))
1332 (when (setq mark (assq pid mp-list))
1333 (insert (cdr mark))
1334 (delete-char 1)
1335 (beginning-of-line))
1336 (when (eq (car old-pos) pid)
1337 (if (nth 1 old-pos)
1338 (let ((limit (line-end-position)) pos)
1339 (while (and (not new-pos)
1340 (setq pos (next-property-change (point) nil limit)))
1341 (goto-char pos)
1342 (when (eq (nth 1 old-pos)
1343 (get-text-property (point) 'proced-key))
1344 (forward-char (min (nth 2 old-pos)
1345 (- (next-property-change (point))
1346 (point))))
1347 (setq new-pos (point))))
1348 (unless new-pos
1349 ;; we found the process, but the field of point
1350 ;; is not listed anymore
1351 (setq new-pos (proced-move-to-goal-column))))
1352 (setq new-pos (min (+ (line-beginning-position) (nth 2 old-pos))
1353 (line-end-position)))))
1354 (forward-line)))
1355 (if new-pos
1356 (goto-char new-pos)
1357 (goto-char (point-min))
1358 (proced-move-to-goal-column)))
1359 ;; update modeline
1360 ;; Does the long `mode-name' clutter the modeline? It would be nice
1361 ;; to have some other location for displaying the values of the various
1362 ;; flags that affect the behavior of proced (flags one might want
1363 ;; to change on the fly). Where??
1364 (setq mode-name
1365 (concat "Proced"
1366 (if proced-filter
1367 (concat ": " (symbol-name proced-filter))
1369 (if proced-sort
1370 (let* ((key (if (listp proced-sort) (car proced-sort)
1371 proced-sort))
1372 (grammar (assq key proced-grammar-alist)))
1373 (concat " by " (if (nth 5 grammar) "-" "+")
1374 (nth 1 grammar)))
1375 "")))
1376 (force-mode-line-update)
1377 ;; done
1378 (or quiet (input-pending-p)
1379 (message (if revert "Updating process information...done."
1380 "Updating process display...done.")))))
1382 (defun proced-revert (&rest args)
1383 "Analog of `revert-buffer'."
1384 (proced-update t))
1386 ;; I do not want to reinvent the wheel. Should we rename `dired-pop-to-buffer'
1387 ;; and move it to window.el so that proced and ibuffer can easily use it, too?
1388 ;; What about functions like `appt-disp-window' that use
1389 ;; `shrink-window-if-larger-than-buffer'?
1390 (autoload 'dired-pop-to-buffer "dired")
1392 (defun proced-send-signal (&optional signal)
1393 "Send a SIGNAL to the marked processes.
1394 If no process is marked, operate on current process.
1395 SIGNAL may be a string (HUP, INT, TERM, etc.) or a number.
1396 If SIGNAL is nil display marked processes and query interactively for SIGNAL."
1397 (interactive)
1398 (let ((regexp (proced-marker-regexp))
1399 process-alist)
1400 ;; collect marked processes
1401 (save-excursion
1402 (goto-char (point-min))
1403 (while (re-search-forward regexp nil t)
1404 (push (cons (proced-pid-at-point)
1405 ;; How much info should we collect here?
1406 (substring (match-string-no-properties 0) 2))
1407 process-alist)))
1408 (setq process-alist
1409 (if process-alist
1410 (nreverse process-alist)
1411 ;; take current process
1412 (list (cons (proced-pid-at-point)
1413 (buffer-substring-no-properties
1414 (+ 2 (line-beginning-position))
1415 (line-end-position))))))
1416 (unless signal
1417 ;; Display marked processes (code taken from `dired-mark-pop-up').
1418 (let ((bufname " *Marked Processes*")
1419 (header-line (substring-no-properties proced-header-line)))
1420 (with-current-buffer (get-buffer-create bufname)
1421 (setq truncate-lines t
1422 proced-header-line header-line ; inherit header line
1423 header-line-format '(:eval (proced-header-line)))
1424 (add-hook 'post-command-hook 'force-mode-line-update nil t)
1425 (erase-buffer)
1426 (dolist (process process-alist)
1427 (insert " " (cdr process) "\n"))
1428 (save-window-excursion
1429 (dired-pop-to-buffer bufname) ; all we need
1430 (let* ((completion-ignore-case t)
1431 (pnum (if (= 1 (length process-alist))
1432 "1 process"
1433 (format "%d processes" (length process-alist))))
1434 ;; The following is an ugly hack. Is there a better way
1435 ;; to help people like me to remember the signals and
1436 ;; their meanings?
1437 (tmp (completing-read (concat "Send signal [" pnum
1438 "] (default TERM): ")
1439 proced-signal-list
1440 nil nil nil nil "TERM")))
1441 (setq signal (if (string-match "^\\(\\S-+\\)\\s-" tmp)
1442 (match-string 1 tmp) tmp))))))
1443 ;; send signal
1444 (let ((count 0)
1445 failures)
1446 ;; Why not always use `signal-process'? See
1447 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-03/msg02955.html
1448 (if (functionp proced-signal-function)
1449 ;; use built-in `signal-process'
1450 (let ((signal (if (stringp signal)
1451 (if (string-match "\\`[0-9]+\\'" signal)
1452 (string-to-number signal)
1453 (make-symbol signal))
1454 signal))) ; number
1455 (dolist (process process-alist)
1456 (condition-case err
1457 (if (zerop (funcall
1458 proced-signal-function (car process) signal))
1459 (setq count (1+ count))
1460 (proced-log "%s\n" (cdr process))
1461 (push (cdr process) failures))
1462 (error ;; catch errors from failed signals
1463 (proced-log "%s\n" err)
1464 (proced-log "%s\n" (cdr process))
1465 (push (cdr process) failures)))))
1466 ;; use external system call
1467 (let ((signal (concat "-" (if (numberp signal)
1468 (number-to-string signal) signal))))
1469 (dolist (process process-alist)
1470 (with-temp-buffer
1471 (condition-case err
1472 (if (zerop (call-process
1473 proced-signal-function nil t nil
1474 signal (number-to-string (car process))))
1475 (setq count (1+ count))
1476 (proced-log (current-buffer))
1477 (proced-log "%s\n" (cdr process))
1478 (push (cdr process) failures))
1479 (error ;; catch errors from failed signals
1480 (proced-log (current-buffer))
1481 (proced-log "%s\n" (cdr process))
1482 (push (cdr process) failures)))))))
1483 (if failures
1484 ;; Proced error message are not always very precise.
1485 ;; Can we issue a useful one-line summary in the
1486 ;; message area (using FAILURES) if only one signal failed?
1487 (proced-log-summary
1488 signal
1489 (format "%d of %d signal%s failed"
1490 (length failures) (length process-alist)
1491 (if (= 1 (length process-alist)) "" "s")))
1492 (proced-success-message "Sent signal to" count)))
1493 ;; final clean-up
1494 (run-hooks 'proced-after-send-signal-hook))))
1496 ;; similar to `dired-why'
1497 (defun proced-why ()
1498 "Pop up a buffer with error log output from Proced.
1499 A group of errors from a single command ends with a formfeed.
1500 Thus, use \\[backward-page] to find the beginning of a group of errors."
1501 (interactive)
1502 (if (get-buffer proced-log-buffer)
1503 (save-selected-window
1504 ;; move `proced-log-buffer' to the front of the buffer list
1505 (select-window (display-buffer (get-buffer proced-log-buffer)))
1506 (setq truncate-lines t)
1507 (set-buffer-modified-p nil)
1508 (setq buffer-read-only t)
1509 (goto-char (point-max))
1510 (forward-line -1)
1511 (backward-page 1)
1512 (recenter 0))))
1514 ;; similar to `dired-log'
1515 (defun proced-log (log &rest args)
1516 "Log a message or the contents of a buffer.
1517 If LOG is a string and there are more args, it is formatted with
1518 those ARGS. Usually the LOG string ends with a \\n.
1519 End each bunch of errors with (proced-log t signal):
1520 this inserts the current time, buffer and signal at the start of the page,
1521 and \f (formfeed) at the end."
1522 (let ((obuf (current-buffer)))
1523 (with-current-buffer (get-buffer-create proced-log-buffer)
1524 (goto-char (point-max))
1525 (let (buffer-read-only)
1526 (cond ((stringp log)
1527 (insert (if args
1528 (apply 'format log args)
1529 log)))
1530 ((bufferp log)
1531 (insert-buffer-substring log))
1532 ((eq t log)
1533 (backward-page 1)
1534 (unless (bolp)
1535 (insert "\n"))
1536 (insert (current-time-string)
1537 "\tBuffer `" (buffer-name obuf) "', "
1538 (format "signal `%s'\n" (car args)))
1539 (goto-char (point-max))
1540 (insert "\f\n")))))))
1542 ;; similar to `dired-log-summary'
1543 (defun proced-log-summary (signal string)
1544 "State a summary of SIGNAL's failures, in echo area and log buffer.
1545 STRING is an overall summary of the failures."
1546 (message "Signal %s: %s--type ? for details" signal string)
1547 ;; Log a summary describing a bunch of errors.
1548 (proced-log (concat "\n" string "\n"))
1549 (proced-log t signal))
1551 (defun proced-help ()
1552 "Provide help for the `proced' user."
1553 (interactive)
1554 (proced-why)
1555 (if (eq last-command 'proced-help)
1556 (describe-mode)
1557 (message proced-help-string)))
1559 (defun proced-undo ()
1560 "Undo in a proced buffer.
1561 This doesn't recover killed processes, it just undoes changes in the proced
1562 buffer. You can use it to recover marks."
1563 (interactive)
1564 (let (buffer-read-only)
1565 (undo))
1566 (message "Change in Proced buffer undone.
1567 Killed processes cannot be recovered by Emacs."))
1569 (provide 'proced)
1571 ;; arch-tag: a6e312ad-9032-45aa-972d-31a8cfc545af
1572 ;;; proced.el ends here