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