(define-ibuffer-column): Add :summarizer property.
[bpt/emacs.git] / lisp / ibuffer.el
CommitLineData
25d2f683
CW
1;;; ibuffer.el --- operate on buffers like dired
2
30c93a61 3;; Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
25d2f683
CW
4
5;; Author: Colin Walters <walters@verbum.org>
6;; Created: 8 Sep 2000
25d2f683 7;; Keywords: buffer, convenience
25d2f683
CW
8
9;; This file is not currently part of GNU Emacs.
10
11;; This program is free software; you can redistribute it and/or
12;; modify it under the terms of the GNU General Public License as
13;; published by the Free Software Foundation; either version 2, or (at
14;; your option) any later version.
15
16;; This program is distributed in the hope that it will be useful, but
17;; WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19;; General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
22;; along with this program ; see the file COPYING. If not, write to
23;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24;; Boston, MA 02111-1307, USA.
25
26;;; Commentary:
27
28;; ibuffer.el is an advanced replacement for the `buffer-menu' which
29;; is normally distributed with Emacs. Its interface is intended to
30;; be analogous to that of Dired.
31
32;;; Code:
33
34(eval-when-compile
35 (require 'cl)
36 (require 'ibuf-macs)
37 (require 'dired))
38
39;;; Compatibility
40(eval-and-compile
41 (if (fboundp 'window-list)
42 (defun ibuffer-window-list ()
43 (window-list nil 'nomini))
44 (defun ibuffer-window-list ()
45 (let ((ibuffer-window-list-result nil))
46 (walk-windows #'(lambda (win) (push win ibuffer-window-list-result)) 'nomini)
47 (nreverse ibuffer-window-list-result))))
48
49 (cond ((boundp 'global-font-lock-mode)
50 (defsubst ibuffer-use-fontification ()
51 (when (boundp 'font-lock-mode)
52 font-lock-mode)))
53 ((boundp 'font-lock-auto-fontify)
54 (defsubst ibuffer-use-fontification ()
55 font-lock-auto-fontify))
56 (t
57 (defsubst ibuffer-use-fontification ()
58 nil))))
59
60(defgroup ibuffer nil
61 "An advanced replacement for `buffer-menu'.
62
63Ibuffer allows you to operate on buffers in a manner much like Dired.
64Operations include sorting, marking by regular expression, and
65the ability to filter the displayed buffers by various criteria."
25d2f683
CW
66 :group 'convenience)
67
68(defcustom ibuffer-formats '((mark modified read-only " " (name 16 16 :left :elide)
69 " " (size 6 -1 :right)
70 " " (mode 16 16 :right :elide) " " filename)
71 (mark " " (name 16 -1) " " filename))
72 "A list of ways to display buffer lines.
73
74With Ibuffer, you are not limited to displaying just certain
75attributes of a buffer such as size, name, and mode in a particular
76fashion. Through this variable, you can completely customize and
77control the appearance of an Ibuffer buffer. See also
78`define-ibuffer-column', which allows you to define your own columns
79for display.
80
81This variable has the form
2e4fae7d 82 ((COLUMN COLUMN ...) (COLUMN COLUMN ...) ...)
25d2f683
CW
83Each element in `ibuffer-formats' should be a list containing COLUMN
84specifiers. A COLUMN can be any of the following:
85
86 SYMBOL - A symbol naming the column. Predefined columns are:
87 mark modified read-only name size mode process filename
88 When you define your own columns using `define-ibuffer-column', just
89 use their name like the predefined columns here. This entry can
90 also be a function of two arguments, which should return a string.
91 The first argument is the buffer object, and the second is the mark
92 on that buffer.
93 or
94 \"STRING\" - A literal string to display.
95 or
96 (SYMBOL MIN-SIZE MAX-SIZE &optional ALIGN ELIDE) - SYMBOL is a
97 symbol naming the column, and MIN-SIZE and MAX-SIZE are integers (or
98 functions of no arguments returning an integer) which constrict the
99 size of a column. If MAX-SIZE is -1, there is no upper bound. The
100 default values are 0 and -1, respectively. If MIN-SIZE is negative,
101 use the end of the string. The optional element ALIGN describes the
102 alignment of the column; it can be :left, :center or :right. The
103 optional element ELIDE describes whether or not to elide the column
104 if it is too long; valid values are :elide and nil. The default is
105 nil (don't elide).
106
107Some example of valid entries in `ibuffer-formats', with
108description (also, feel free to try them out, and experiment with your
109own!):
110
111 (mark \" \" name)
112 This format just displays the current mark (if any) and the name of
113 the buffer, separated by a space.
114 (mark modified read-only \" \" (name 16 16 :left) \" \" (size 6 -1 :right))
115 This format displays the current mark (if any), its modification and
116 read-only status, as well as the name of the buffer and its size. In
117 this format, the name is restricted to 16 characters (longer names
523304ed 118 will be truncated, and shorter names will be padded with spaces), and
25d2f683
CW
119 the name is also aligned to the right. The size of the buffer will
120 be padded with spaces up to a minimum of six characters, but there is
121 no upper limit on its size. The size will also be aligned to the
122 right.
123
124Thus, if you wanted to use these two formats, add
125
126 (setq ibuffer-formats '((mark \" \" name)
127 (mark modified read-only
128 (name 16 16 :left) (size 6 -1 :right))))
129
130to your ~/.emacs file.
131
132Using \\[ibuffer-switch-format], you can rotate the display between
133the specified formats in the list."
134 :type '(repeat sexp)
135 :group 'ibuffer)
136
137(defcustom ibuffer-always-compile-formats (featurep 'bytecomp)
138 "If non-nil, then use the byte-compiler to optimize `ibuffer-formats'.
139This will increase the redisplay speed, at the cost of loading the
140elisp byte-compiler."
141 :type 'boolean
142 :group 'ibuffer)
143
144(defcustom ibuffer-fontification-alist
145 `((10 buffer-read-only font-lock-reference-face)
146 (15 (string-match "^*" (buffer-name)) font-lock-keyword-face)
147 (20 (string-match "^ " (buffer-name)) font-lock-warning-face)
148 (25 (memq major-mode '(help-mode apropos-mode info-mode)) font-lock-comment-face)
149 (30 (eq major-mode 'dired-mode) font-lock-function-name-face))
150 "An alist describing how to fontify buffers.
151Each element should be of the form (PRIORITY FORM FACE), where
152PRIORITY is an integer, FORM is an arbitrary form to evaluate in the
153buffer, and FACE is the face to use for fontification. If the FORM
154evaluates to non-nil, then FACE will be put on the buffer name. The
155element with the highest PRIORITY takes precedence."
156 :type '(repeat
157 (list (integer :tag "Priority")
158 (sexp :tag "Test Form")
159 face))
160 :group 'ibuffer)
161
162(defcustom ibuffer-use-other-window nil
163 "If non-nil, display the Ibuffer in another window by default."
164 :type 'boolean
165 :group 'ibuffer)
166
167(defcustom ibuffer-default-shrink-to-minimum-size nil
168 "If non-nil, minimize the size of the Ibuffer window by default."
169 :type 'boolean
170 :group 'ibuffer)
171(defvar ibuffer-shrink-to-minimum-size nil)
172
3eda3649
CW
173(defcustom ibuffer-truncate-lines t
174 "If non-nil, do not display continuation lines."
175 :type 'boolean
176 :group 'ibuffer)
177
25d2f683
CW
178(defcustom ibuffer-case-fold-search case-fold-search
179 "If non-nil, ignore case when searching."
180 :type 'boolean
181 :group 'ibuffer)
182
183(defcustom ibuffer-default-sorting-mode 'recency
184 "The criteria by which to sort the buffers.
185
186Note that this variable is local to each ibuffer buffer. Thus, you
187can have multiple ibuffer buffers open, each with a different sorted
188view of the buffers."
189 :type '(choice (const :tag "Last view time" :value recency)
190 (const :tag "Lexicographic" :value alphabetic)
191 (const :tag "Buffer size" :value size)
192 (const :tag "Major mode" :value major-mode))
193 :group 'ibuffer)
194(defvar ibuffer-sorting-mode nil)
195
196(defcustom ibuffer-default-sorting-reversep nil
197 "If non-nil, reverse the default sorting order."
198 :type 'boolean
199 :group 'ibuffer)
200(defvar ibuffer-sorting-reversep nil)
201
202(defcustom ibuffer-elide-long-columns nil
203 "If non-nil, then elide column entries which exceed their max length.
204This variable is deprecated; use the :elide argument of
205`ibuffer-formats' to elide just certain columns."
206 :type 'boolean
207 :group 'ibuffer)
208
209(defcustom ibuffer-eliding-string "..."
210 "The string to use for eliding long columns."
211 :type 'string
212 :group 'ibuffer)
213
214(defcustom ibuffer-maybe-show-predicates `(,(lambda (buf)
215 (and (string-match "^ " (buffer-name buf))
216 (null buffer-file-name))))
217 "A list of predicates (a regexp or function) for buffers to display conditionally.
218If a regexp, then it will be matched against the buffer's name.
219If a function, it will be called with the buffer as an argument, and
220should return non-nil if this buffer should be shown.
221
222Viewing of buffers hidden because of these predicates is enabled by
223giving a non-nil prefix argument to `ibuffer-update'. Note that this
224specialized filtering occurs before real filtering."
225 :type '(repeat (choice regexp function))
226 :group 'ibuffer)
227
228(defvar ibuffer-current-format nil)
229
230(defcustom ibuffer-modified-char ?*
231 "The character to display for modified buffers."
232 :type 'character
233 :group 'ibuffer)
234
235(defcustom ibuffer-read-only-char ?%
236 "The character to display for read-only buffers."
237 :type 'character
238 :group 'ibuffer)
239
240(defcustom ibuffer-marked-char ?>
241 "The character to display for marked buffers."
242 :type 'character
243 :group 'ibuffer)
244
245(defcustom ibuffer-deletion-char ?D
246 "The character to display for buffers marked for deletion."
247 :type 'character
248 :group 'ibuffer)
249
250(defcustom ibuffer-expert nil
251 "If non-nil, don't ask for confirmation of \"dangerous\" operations."
252 :type 'boolean
253 :group 'ibuffer)
254
255(defcustom ibuffer-view-ibuffer nil
256 "If non-nil, display the current Ibuffer buffer itself.
257Note that this has a drawback - the data about the current Ibuffer
258buffer will most likely be inaccurate. This includes modification
259state, size, etc."
260 :type 'boolean
261 :group 'ibuffer)
262
263(defcustom ibuffer-always-show-last-buffer nil
264 "If non-nil, always display the previous buffer. This variable
265takes precedence over filtering, and even
266`ibuffer-never-show-predicates'."
267 :type '(choice (const :tag "Always" :value t)
268 (const :tag "Never" :value nil)
269 (const :tag "Always except minibuffer" :value :nomini))
270 :group 'ibuffer)
271
272(defcustom ibuffer-use-header-line (boundp 'header-line-format)
273 "If non-nil, display a header line containing current filters.
274This feature only works on Emacs 21 or later."
275 :type 'boolean
276 :group 'ibuffer)
277
278(defcustom ibuffer-default-directory nil
279 "The default directory to use for a new ibuffer buffer.
2e4fae7d 280If nil, inherit the directory of the buffer in which `ibuffer' was
25d2f683
CW
281called. Otherwise, this variable should be a string naming a
282directory, like `default-directory'."
283 :type '(choice (const :tag "Inherit" :value nil)
284 string)
285 :group 'ibuffer)
286
287(defcustom ibuffer-hooks nil
288 "Hooks run when `ibuffer' is called."
289 :type 'hook
290 :group 'ibuffer)
291
292(defcustom ibuffer-mode-hooks nil
293 "Hooks run upon entry into `ibuffer-mode'."
294 :type 'hook
295 :group 'ibuffer)
296
297(defcustom ibuffer-marked-face 'font-lock-warning-face
298 "Face used for displaying marked buffers."
299 :type 'face
300 :group 'ibuffer)
301
302(defcustom ibuffer-deletion-face 'font-lock-type-face
303 "Face used for displaying buffers marked for deletion."
304 :type 'face
305 :group 'ibuffer)
306
307(defcustom ibuffer-title-face 'font-lock-type-face
308 "Face used for the title string."
309 :type 'face
310 :group 'ibuffer)
311
312(defcustom ibuffer-directory-abbrev-alist nil
313 "An alist of file name abbreviations like `directory-abbrev-alist'."
314 :type '(repeat (cons :format "%v"
315 :value ("" . "")
316 (regexp :tag "From")
317 (regexp :tag "To")))
318 :group 'ibuffer)
319
320(defvar ibuffer-mode-map nil)
321(defvar ibuffer-mode-operate-map nil)
322(unless ibuffer-mode-map
323 (let ((map (make-sparse-keymap))
324 (operate-map (make-sparse-keymap "Operate")))
325 (define-key map (kbd "0") 'digit-argument)
326 (define-key map (kbd "1") 'digit-argument)
327 (define-key map (kbd "2") 'digit-argument)
328 (define-key map (kbd "3") 'digit-argument)
329 (define-key map (kbd "4") 'digit-argument)
330 (define-key map (kbd "5") 'digit-argument)
331 (define-key map (kbd "6") 'digit-argument)
332 (define-key map (kbd "7") 'digit-argument)
333 (define-key map (kbd "8") 'digit-argument)
334 (define-key map (kbd "9") 'digit-argument)
335
336 (define-key map (kbd "m") 'ibuffer-mark-forward)
337 (define-key map (kbd "t") 'ibuffer-toggle-marks)
338 (define-key map (kbd "u") 'ibuffer-unmark-forward)
339 (define-key map (kbd "=") 'ibuffer-diff-with-file)
340 (define-key map (kbd "j") 'ibuffer-jump-to-buffer)
341 (define-key map (kbd "DEL") 'ibuffer-unmark-backward)
342 (define-key map (kbd "M-DEL") 'ibuffer-unmark-all)
343 (define-key map (kbd "* *") 'ibuffer-unmark-all)
344 (define-key map (kbd "* M") 'ibuffer-mark-by-mode)
345 (define-key map (kbd "* m") 'ibuffer-mark-modified-buffers)
346 (define-key map (kbd "* u") 'ibuffer-mark-unsaved-buffers)
347 (define-key map (kbd "* s") 'ibuffer-mark-special-buffers)
348 (define-key map (kbd "* r") 'ibuffer-mark-read-only-buffers)
349 (define-key map (kbd "* /") 'ibuffer-mark-dired-buffers)
350 (define-key map (kbd "* e") 'ibuffer-mark-dissociated-buffers)
351 (define-key map (kbd "* h") 'ibuffer-mark-help-buffers)
352 (define-key map (kbd ".") 'ibuffer-mark-old-buffers)
353
354 (define-key map (kbd "d") 'ibuffer-mark-for-delete)
355 (define-key map (kbd "C-d") 'ibuffer-mark-for-delete-backwards)
356 (define-key map (kbd "k") 'ibuffer-mark-for-delete)
357 (define-key map (kbd "x") 'ibuffer-do-kill-on-deletion-marks)
358
359 ;; immediate operations
360 (define-key map (kbd "n") 'ibuffer-forward-line)
361 (define-key map (kbd "SPC") 'forward-line)
362 (define-key map (kbd "p") 'ibuffer-backward-line)
363 (define-key map (kbd "M-}") 'ibuffer-forward-next-marked)
364 (define-key map (kbd "M-{") 'ibuffer-backwards-next-marked)
365 (define-key map (kbd "l") 'ibuffer-redisplay)
366 (define-key map (kbd "g") 'ibuffer-update)
367 (define-key map "`" 'ibuffer-switch-format)
368 (define-key map "-" 'ibuffer-add-to-tmp-hide)
369 (define-key map "+" 'ibuffer-add-to-tmp-show)
370 (define-key map "b" 'ibuffer-bury-buffer)
371 (define-key map (kbd ",") 'ibuffer-toggle-sorting-mode)
372 (define-key map (kbd "s i") 'ibuffer-invert-sorting)
373 (define-key map (kbd "s a") 'ibuffer-do-sort-by-alphabetic)
374 (define-key map (kbd "s v") 'ibuffer-do-sort-by-recency)
375 (define-key map (kbd "s s") 'ibuffer-do-sort-by-size)
376 (define-key map (kbd "s m") 'ibuffer-do-sort-by-major-mode)
377
378 (define-key map (kbd "/ m") 'ibuffer-filter-by-mode)
379 (define-key map (kbd "/ n") 'ibuffer-filter-by-name)
380 (define-key map (kbd "/ c") 'ibuffer-filter-by-content)
381 (define-key map (kbd "/ e") 'ibuffer-filter-by-predicate)
382 (define-key map (kbd "/ f") 'ibuffer-filter-by-filename)
383 (define-key map (kbd "/ >") 'ibuffer-filter-by-size-gt)
384 (define-key map (kbd "/ <") 'ibuffer-filter-by-size-lt)
385 (define-key map (kbd "/ r") 'ibuffer-switch-to-saved-filters)
386 (define-key map (kbd "/ a") 'ibuffer-add-saved-filters)
387 (define-key map (kbd "/ x") 'ibuffer-delete-saved-filters)
388 (define-key map (kbd "/ d") 'ibuffer-decompose-filter)
389 (define-key map (kbd "/ s") 'ibuffer-save-filters)
390 (define-key map (kbd "/ p") 'ibuffer-pop-filter)
391 (define-key map (kbd "/ !") 'ibuffer-negate-filter)
392 (define-key map (kbd "/ t") 'ibuffer-exchange-filters)
393 (define-key map (kbd "/ TAB") 'ibuffer-exchange-filters)
394 (define-key map (kbd "/ o") 'ibuffer-or-filter)
395 (define-key map (kbd "/ /") 'ibuffer-filter-disable)
396
397 (define-key map (kbd "q") 'ibuffer-quit)
398 (define-key map (kbd "h") 'describe-mode)
399 (define-key map (kbd "?") 'describe-mode)
400
401 (define-key map (kbd "% n") 'ibuffer-mark-by-name-regexp)
402 (define-key map (kbd "% m") 'ibuffer-mark-by-mode-regexp)
403 (define-key map (kbd "% f") 'ibuffer-mark-by-file-name-regexp)
404
405 (define-key map (kbd "C-t") 'ibuffer-visit-tags-table)
406
407 (define-key map (kbd "|") 'ibuffer-do-shell-command-pipe)
408 (define-key map (kbd "!") 'ibuffer-do-shell-command-file)
409 (define-key map (kbd "~") 'ibuffer-do-toggle-modified)
410 ;; marked operations
411 (define-key map (kbd "A") 'ibuffer-do-view)
412 (define-key map (kbd "D") 'ibuffer-do-delete)
413 (define-key map (kbd "E") 'ibuffer-do-eval)
414 (define-key map (kbd "F") 'ibuffer-do-shell-command-file)
415 (define-key map (kbd "I") 'ibuffer-do-query-replace-regexp)
416 (define-key map (kbd "H") 'ibuffer-do-view-other-frame)
417 (define-key map (kbd "N") 'ibuffer-do-shell-command-pipe-replace)
418 (define-key map (kbd "M") 'ibuffer-do-toggle-modified)
419 (define-key map (kbd "O") 'ibuffer-do-occur)
420 (define-key map (kbd "P") 'ibuffer-do-print)
421 (define-key map (kbd "Q") 'ibuffer-do-query-replace)
422 (define-key map (kbd "R") 'ibuffer-do-rename-uniquely)
423 (define-key map (kbd "S") 'ibuffer-do-save)
424 (define-key map (kbd "T") 'ibuffer-do-toggle-read-only)
425 (define-key map (kbd "U") 'ibuffer-do-replace-regexp)
426 (define-key map (kbd "V") 'ibuffer-do-revert)
427 (define-key map (kbd "W") 'ibuffer-do-view-and-eval)
428 (define-key map (kbd "X") 'ibuffer-do-shell-command-pipe)
429
430 (define-key map (kbd "k") 'ibuffer-do-kill-lines)
431 (define-key map (kbd "w") 'ibuffer-copy-filename-as-kill)
432
433 (define-key map (kbd "RET") 'ibuffer-visit-buffer)
434 (define-key map (kbd "e") 'ibuffer-visit-buffer)
435 (define-key map (kbd "f") 'ibuffer-visit-buffer)
436 (define-key map (kbd "C-x C-f") 'ibuffer-find-file)
437 (define-key map (kbd "o") 'ibuffer-visit-buffer-other-window)
438 (define-key map (kbd "C-o") 'ibuffer-visit-buffer-other-window-noselect)
439 (define-key map (kbd "M-o") 'ibuffer-visit-buffer-1-window)
440 (define-key map (kbd "v") 'ibuffer-do-view)
441 (define-key map (kbd "C-x v") 'ibuffer-do-view-horizontally)
442 (define-key map (kbd "C-c C-a") 'ibuffer-auto-mode)
443 (define-key map (kbd "C-x 4 RET") 'ibuffer-visit-buffer-other-window)
444 (define-key map (kbd "C-x 5 RET") 'ibuffer-visit-buffer-other-frame)
445
446 (define-key map [menu-bar view]
447 (cons "View" (make-sparse-keymap "View")))
448
449 (define-key-after map [menu-bar view visit-buffer]
450 '(menu-item "View this buffer" ibuffer-visit-buffer))
451 (define-key-after map [menu-bar view visit-buffer-other-window]
452 '(menu-item "View (other window)" ibuffer-visit-buffer-other-window))
453 (define-key-after map [menu-bar view visit-buffer-other-frame]
454 '(menu-item "View (other frame)" ibuffer-visit-buffer-other-frame))
455 (define-key-after map [menu-bar view ibuffer-update]
456 '(menu-item "Update" ibuffer-update
457 :help "Regenerate the list of buffers"))
458 (define-key-after map [menu-bar view switch-format]
459 '(menu-item "Switch display format" ibuffer-switch-format
460 :help "Toggle between available values of `ibuffer-formats'"))
461
462 (define-key-after map [menu-bar view dashes]
463 '("--"))
464
465 (define-key-after map [menu-bar view sort]
466 (cons "Sort" (make-sparse-keymap "Sort")))
467
468 (define-key-after map [menu-bar view sort do-sort-by-major-mode]
469 '(menu-item "Sort by major mode" ibuffer-do-sort-by-major-mode
470 :help "Sort by the alphabetic order of the buffer's major mode"))
471 (define-key-after map [menu-bar view sort do-sort-by-size]
472 '(menu-item "Sort by buffer size" ibuffer-do-sort-by-size
473 :help "Sort by the size of the buffer"))
474 (define-key-after map [menu-bar view sort do-sort-by-alphabetic]
475 '(menu-item "Sort lexicographically" ibuffer-do-sort-by-alphabetic
476 :help "Sort by the alphabetic order of buffer name"))
477 (define-key-after map [menu-bar view sort do-sort-by-recency]
478 '(menu-item "Sort by view time" ibuffer-do-sort-by-recency
479 :help "Sort by the last time the buffer was displayed"))
480 (define-key-after map [menu-bar view sort invert-sorting]
481 '(menu-item "Reverse sorting order" ibuffer-invert-sorting))
482 (define-key-after map [menu-bar view sort toggle-sorting-mode]
483 '(menu-item "Switch sorting mode" ibuffer-toggle-sorting-mode
484 :help "Switch between the various sorting criteria"))
485
486 (define-key-after map [menu-bar view filter]
487 (cons "Filter" (make-sparse-keymap "Filter")))
488
489 (define-key-after map [menu-bar view filter filter-disable]
490 '(menu-item "Disable all filtering" ibuffer-filter-disable))
491 (define-key-after map [menu-bar view filter filter-by-mode]
492 '(menu-item "Add filter by major mode..." ibuffer-filter-by-mode
493 :help "Show only buffers in a major mode"))
494 (define-key-after map [menu-bar view filter filter-by-name]
495 '(menu-item "Add filter by buffer name..." ibuffer-filter-by-name
496 :help "Show only buffers whose name matches a regexp"))
497 (define-key-after map [menu-bar view filter filter-by-filename]
498 '(menu-item "Add filter by filename..." ibuffer-filter-by-filename
499 :help "Show only buffers whose filename matches a regexp"))
500 (define-key-after map [menu-bar view filter filter-by-size-lt]
501 '(menu-item "Add filter by size less than..." ibuffer-filter-by-size-lt
502 :help "Show only buffers of size less than..."))
503 (define-key-after map [menu-bar view filter filter-by-size-gt]
504 '(menu-item "Add filter by size greater than..." ibuffer-filter-by-size-gt
505 :help "Show only buffers of size greater than..."))
506 (define-key-after map [menu-bar view filter filter-by-content]
507 '(menu-item "Add filter by content (regexp)..." ibuffer-filter-by-content
508 :help "Show only buffers containing a regexp"))
509 (define-key-after map [menu-bar view filter filter-by-predicate]
510 '(menu-item "Add filter by Lisp predicate..." ibuffer-filter-by-predicate
511 :help "Show only buffers for which a predicate is true"))
512 (define-key-after map [menu-bar view filter pop-filter]
513 '(menu-item "Remove top filter" ibuffer-pop-filter))
514 (define-key-after map [menu-bar view filter or-filter]
515 '(menu-item "OR top two filters" ibuffer-or-filter
516 :help "Create a new filter which is the logical OR of the top two filters"))
517 (define-key-after map [menu-bar view filter negate-filter]
518 '(menu-item "Negate top filter" ibuffer-negate-filter))
519 (define-key-after map [menu-bar view filter decompose-filter]
520 '(menu-item "Decompose top filter" ibuffer-decompose-filter
521 :help "Break down a complex filter like OR or NOT"))
522 (define-key-after map [menu-bar view filter exchange-filters]
523 '(menu-item "Swap top two filters" ibuffer-exchange-filters))
524 (define-key-after map [menu-bar view filter save-filters]
525 '(menu-item "Save current filters permanently..." ibuffer-save-filters
526 :help "Use a mnemnonic name to store current filter stack"))
527 (define-key-after map [menu-bar view filter switch-to-saved-filters]
528 '(menu-item "Restore permanently saved filters..." ibuffer-switch-to-saved-filters
529 :help "Replace current filters with a saved stack"))
530 (define-key-after map [menu-bar view filter add-saved-filters]
531 '(menu-item "Add to permanently saved filters..." ibuffer-add-saved-filters
532 :help "Include current filters in an already saved stack"))
533 (define-key-after map [menu-bar view filter delete-saved-filters]
534 '(menu-item "Delete permanently saved filters..." ibuffer-delete-saved-filters
535 :help "Remove stack of filters from saved list"))
536 (define-key-after map [menu-bar view dashes2]
537 '("--"))
538 (define-key-after map [menu-bar view diff-with-file]
539 '(menu-item "Diff with file" ibuffer-diff-with-file
540 :help "View the differences between this buffer and its file"))
541 (define-key-after map [menu-bar view auto-mode]
542 '(menu-item "Toggle Auto Mode" ibuffer-auto-mode
543 :help "Attempt to automatically update the Ibuffer buffer"))
544 (define-key-after map [menu-bar view customize]
545 '(menu-item "Customize Ibuffer" (lambda () (interactive)
546 (customize-group 'ibuffer))
547 :help "Use Custom to customize Ibuffer"))
548
549 (define-key-after map [menu-bar mark]
550 (cons "Mark" (make-sparse-keymap "Mark")))
551
552 (define-key-after map [menu-bar mark toggle-marks]
553 '(menu-item "Toggle marks" ibuffer-toggle-marks
554 :help "Unmark marked buffers, and mark unmarked buffers"))
555 (define-key-after map [menu-bar mark mark-forward]
556 '(menu-item "Mark" ibuffer-mark-forward
557 :help "Mark the buffer at point"))
558 (define-key-after map [menu-bar mark unmark-forward]
559 '(menu-item "Unmark" ibuffer-unmark-forward
560 :help "Unmark the buffer at point"))
561 (define-key-after map [menu-bar mark mark-by-mode]
562 '(menu-item "Mark by mode..." ibuffer-mark-by-mode
563 :help "Mark all buffers in a particular major mode"))
564 (define-key-after map [menu-bar mark mark-modified-buffers]
565 '(menu-item "Mark modified buffers" ibuffer-mark-modified-buffers
566 :help "Mark all buffers which have been modified"))
567 (define-key-after map [menu-bar mark mark-unsaved-buffers]
568 '(menu-item "Mark unsaved buffers" ibuffer-mark-unsaved-buffers
569 :help "Mark all buffers which have a file and are modified"))
570 (define-key-after map [menu-bar mark mark-read-only-buffers]
571 '(menu-item "Mark read-only buffers" ibuffer-mark-read-only-buffers
572 :help "Mark all buffers which are read-only"))
573 (define-key-after map [menu-bar mark mark-special-buffers]
574 '(menu-item "Mark special buffers" ibuffer-mark-special-buffers
575 :help "Mark all buffers whose name begins with a *"))
576 (define-key-after map [menu-bar mark mark-dired-buffers]
577 '(menu-item "Mark dired buffers" ibuffer-mark-dired-buffers
578 :help "Mark buffers in dired-mode"))
579 (define-key-after map [menu-bar mark mark-dissociated-buffers]
580 '(menu-item "Mark dissociated buffers" ibuffer-mark-dissociated-buffers
581 :help "Mark buffers with a non-existent associated file"))
582 (define-key-after map [menu-bar mark mark-help-buffers]
583 '(menu-item "Mark help buffers" ibuffer-mark-help-buffers
584 :help "Mark buffers in help-mode"))
585 (define-key-after map [menu-bar mark mark-old-buffers]
586 '(menu-item "Mark old buffers" ibuffer-mark-old-buffers
587 :help "Mark buffers which have not been viewed recently"))
588 (define-key-after map [menu-bar mark unmark-all]
589 '(menu-item "Unmark All" ibuffer-unmark-all))
590
591 (define-key-after map [menu-bar mark dashes]
592 '("--"))
593
594 (define-key-after map [menu-bar mark mark-by-name-regexp]
595 '(menu-item "Mark by buffer name (regexp)..." ibuffer-mark-by-name-regexp
596 :help "Mark buffers whose name matches a regexp"))
597 (define-key-after map [menu-bar mark mark-by-mode-regexp]
598 '(menu-item "Mark by major mode (regexp)..." ibuffer-mark-by-mode-regexp
599 :help "Mark buffers whose major mode name matches a regexp"))
600 (define-key-after map [menu-bar mark mark-by-file-name-regexp]
601 '(menu-item "Mark by file name (regexp)..." ibuffer-mark-by-file-name-regexp
602 :help "Mark buffers whose file name matches a regexp"))
603
604 ;; Operate map is added later
605
606 (define-key-after operate-map [do-view]
607 '(menu-item "View" ibuffer-do-view))
608 (define-key-after operate-map [do-view-other-frame]
609 '(menu-item "View (separate frame)" ibuffer-do-view-other-frame))
610 (define-key-after operate-map [do-save]
611 '(menu-item "Save" ibuffer-do-save))
612 (define-key-after operate-map [do-replace-regexp]
613 '(menu-item "Replace (regexp)..." ibuffer-do-replace-regexp
614 :help "Replace text inside marked buffers"))
615 (define-key-after operate-map [do-query-replace]
616 '(menu-item "Query Replace..." ibuffer-do-query-replace
617 :help "Replace text in marked buffers, asking each time"))
618 (define-key-after operate-map [do-query-replace-regexp]
619 '(menu-item "Query Replace (regexp)..." ibuffer-do-query-replace-regexp
620 :help "Replace text in marked buffers by regexp, asking each time"))
621 (define-key-after operate-map [do-print]
622 '(menu-item "Print" ibuffer-do-print))
623 (define-key-after operate-map [do-toggle-modified]
624 '(menu-item "Toggle modification flag" ibuffer-do-toggle-modified))
625 (define-key-after operate-map [do-revert]
626 '(menu-item "Revert" ibuffer-do-revert
627 :help "Revert marked buffers to their associated file"))
628 (define-key-after operate-map [do-rename-uniquely]
629 '(menu-item "Rename Uniquely" ibuffer-do-rename-uniquely
630 :help "Rename marked buffers to a new, unique name"))
631 (define-key-after operate-map [do-delete]
632 '(menu-item "Kill" ibuffer-do-delete))
633 (define-key-after operate-map [do-occur]
634 '(menu-item "List lines matching..." ibuffer-do-occur
635 :help "View all lines in marked buffers matching a regexp"))
636 (define-key-after operate-map [do-shell-command-pipe]
637 '(menu-item "Pipe to shell command..." ibuffer-do-shell-command-pipe
638 :help "For each marked buffer, send its contents to a shell command"))
639 (define-key-after operate-map [do-shell-command-pipe-replace]
640 '(menu-item "Pipe to shell command (replace)..." ibuffer-do-shell-command-pipe-replace
641 :help "For each marked buffer, replace its contents with output of shell command"))
642 (define-key-after operate-map [do-shell-command-file]
643 '(menu-item "Shell command on buffer's file..." ibuffer-do-shell-command-file
644 :help "For each marked buffer, run a shell command with its file as argument"))
645 (define-key-after operate-map [do-eval]
646 '(menu-item "Eval..." ibuffer-do-eval
647 :help "Evaluate a Lisp form in each marked buffer"))
648 (define-key-after operate-map [do-view-and-eval]
649 '(menu-item "Eval (viewing buffer)..." ibuffer-do-view-and-eval
650 :help "Evaluate a Lisp form in each marked buffer while viewing it"))
651
652 (setq ibuffer-mode-map map
653 ibuffer-mode-operate-map operate-map)))
654
655(defvar ibuffer-name-map nil)
656(unless ibuffer-name-map
657 (let ((map (make-sparse-keymap)))
658 (set-keymap-parent map ibuffer-mode-map)
659 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
660 (define-key map [(mouse-2)] 'ibuffer-mouse-visit-buffer)
661 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
662 (setq ibuffer-name-map map)))
663
664(defvar ibuffer-mode-name-map nil)
665(unless ibuffer-mode-name-map
666 (let ((map (make-sparse-keymap)))
667 (set-keymap-parent map ibuffer-mode-map)
668 (define-key map [(mouse-2)] 'ibuffer-mouse-filter-by-mode)
669 (define-key map (kbd "RET") 'ibuffer-interactive-filter-by-mode)
670 (setq ibuffer-mode-name-map map)))
671
672;; quiet the byte-compiler
673(defvar ibuffer-mode-operate-menu nil)
674(defvar ibuffer-mode-mark-menu nil)
675(defvar ibuffer-mode-view-menu nil)
676
677(defvar ibuffer-mode-hooks nil)
678
679(defvar ibuffer-delete-window-on-quit nil
680 "Whether or not to delete the window upon exiting `ibuffer'.")
681
682(defvar ibuffer-did-modification nil)
683
684(defvar ibuffer-sorting-functions-alist nil
685 "An alist of functions which describe how to sort buffers.
686
687Note: You most likely do not want to modify this variable directly;
688use `define-ibuffer-sorter' instead.
689
690The alist elements are constructed like (NAME DESCRIPTION FUNCTION)
691Where NAME is a symbol describing the sorting method, DESCRIPTION is a
692short string which will be displayed in the minibuffer and menu, and
693FUNCTION is a function of two arguments, which will be the buffers to
694compare.")
695
696;;; Utility functions
697(defun ibuffer-columnize-and-insert-list (list &optional pad-width)
698 "Insert LIST into the current buffer in as many columns as possible.
699The maximum number of columns is determined by the current window
700width and the longest string in LIST."
701 (unless pad-width
702 (setq pad-width 3))
703 (let ((width (window-width))
704 (max (+ (apply #'max (mapcar #'length list))
705 pad-width)))
706 (let ((columns (/ width max)))
707 (when (zerop columns)
708 (setq columns 1))
709 (while list
710 (dotimes (i (1- columns))
711 (insert (concat (car list) (make-string (- max (length (car list)))
712 ? )))
713 (setq list (cdr list)))
714 (when (not (null list))
715 (insert (pop list)))
716 (insert "\n")))))
717
718(defun ibuffer-accumulate-lines (count)
719 (save-excursion
720 (let ((forwardp (> count 0))
721 (result nil))
722 (while (not (or (zerop count)
723 (if forwardp
724 (eobp)
725 (bobp))))
726 (if forwardp
727 (decf count)
728 (incf count))
729 (push
730 (buffer-substring
731 (line-beginning-position)
732 (line-end-position))
733 result)
734 (forward-line (if forwardp 1 -1)))
735 (nreverse result))))
736
737(defsubst ibuffer-current-mark ()
738 (cadr (get-text-property (line-beginning-position)
739 'ibuffer-properties)))
740
741(defun ibuffer-mouse-toggle-mark (event)
742 "Toggle the marked status of the buffer chosen with the mouse."
743 (interactive "e")
744 (unwind-protect
745 (save-excursion
746 (mouse-set-point event)
747 (let ((mark (ibuffer-current-mark)))
748 (setq buffer-read-only nil)
749 (if (eq mark ibuffer-marked-char)
750 (ibuffer-set-mark ? )
751 (ibuffer-set-mark ibuffer-marked-char))))
752 (setq buffer-read-only t)))
753
754(defun ibuffer-find-file (file &optional wildcards)
755 "Like `find-file', but default to the directory of the buffer at point."
756 (interactive
757 (let ((default-directory (let ((buf (ibuffer-current-buffer)))
758 (if (buffer-live-p buf)
759 (with-current-buffer buf
760 default-directory)
761 default-directory))))
762 (list (read-file-name "Find file: " default-directory)
763 current-prefix-arg)))
764 (find-file file wildcards))
765
766(defun ibuffer-mouse-visit-buffer (event)
767 "Visit the buffer chosen with the mouse."
768 (interactive "e")
769 (switch-to-buffer
770 (save-excursion
771 (mouse-set-point event)
772 (ibuffer-current-buffer))))
773
774(defun ibuffer-mouse-popup-menu (event)
775 "Display a menu of operations."
776 (interactive "e")
777 (let ((origline (count-lines (point-min) (point))))
778 (unwind-protect
779 (progn
780 (setq buffer-read-only nil)
781 (ibuffer-save-marks
782 ;; hm. we could probably do this in a better fashion
783 (ibuffer-unmark-all ?\r)
784 (setq buffer-read-only nil)
785 (mouse-set-point event)
786 (ibuffer-set-mark ibuffer-marked-char)
787 (setq buffer-read-only nil)
788 (save-excursion
789 (popup-menu ibuffer-mode-operate-map))))
790 (progn
791 (setq buffer-read-only t)
792 (goto-line (1+ origline))))))
793
794(defun ibuffer-backward-line (&optional arg)
795 "Move backwards ARG lines, wrapping around the list if necessary."
796 (interactive "P")
797 (unless arg
798 (setq arg 1))
799 (beginning-of-line)
800 (while (> arg 0)
801 (forward-line -1)
802 (when (get-text-property (point) 'ibuffer-title)
803 (goto-char (point-max))
804 (forward-line -1)
805 (setq arg 0))
806 (setq arg (1- arg))))
807
808(defun ibuffer-forward-line (&optional arg)
809 "Move forward ARG lines, wrapping around the list if necessary."
810 (interactive "P")
811 (unless arg
812 (setq arg 1))
813 (beginning-of-line)
814 (if (< arg 0)
815 (ibuffer-backward-line (- arg))
816 (progn
817 (when (get-text-property (point) 'ibuffer-title)
818 ;; If we're already on the title, moving past it counts as
819 ;; moving a line.
820 (decf arg)
821 (while (and (get-text-property (point) 'ibuffer-title)
822 (not (eobp)))
823 (forward-line 1)))
824 (while (> arg 0)
825 (forward-line 1)
826 (when (eobp)
827 (goto-char (point-min)))
828 (while (and (get-text-property (point) 'ibuffer-title)
829 (not (eobp)))
830 (forward-line 1))
831 (setq arg (1- arg))))))
832
833(defun ibuffer-visit-buffer ()
834 "Visit the buffer on this line."
835 (interactive)
836 (let ((buf (ibuffer-current-buffer)))
837 (unless (buffer-live-p buf)
838 (error "Buffer %s has been killed!" buf))
839 (bury-buffer (current-buffer))
840 (switch-to-buffer buf)))
841
842(defun ibuffer-visit-buffer-other-window (&optional noselect)
843 "Visit the buffer on this line in another window."
844 (interactive)
845 (let ((buf (ibuffer-current-buffer)))
846 (unless (buffer-live-p buf)
847 (error "Buffer %s has been killed!" buf))
848 (bury-buffer (current-buffer))
849 (if noselect
850 (let ((curwin (selected-window)))
851 (pop-to-buffer buf)
852 (select-window curwin))
853 (switch-to-buffer-other-window buf))))
854
855(defun ibuffer-visit-buffer-other-window-noselect ()
856 "Visit the buffer on this line in another window, but don't select it."
857 (interactive)
858 (ibuffer-visit-buffer-other-window t))
859
860(defun ibuffer-visit-buffer-other-frame ()
861 "Visit the buffer on this line in another frame."
862 (interactive)
863 (let ((buf (ibuffer-current-buffer)))
864 (unless (buffer-live-p buf)
865 (error "Buffer %s has been killed!" buf))
866 (bury-buffer (current-buffer))
867 (switch-to-buffer-other-frame buf)))
868
869(defun ibuffer-visit-buffer-1-window ()
870 "Visit the buffer on this line, and delete other windows."
871 (interactive)
872 (let ((buf (ibuffer-current-buffer)))
873 (unless (buffer-live-p buf)
874 (error "Buffer %s has been killed!" buf))
875 (switch-to-buffer buf)
876 (delete-other-windows)))
877
878(defun ibuffer-bury-buffer ()
879 "Bury the buffer on this line."
880 (interactive)
881 (let ((buf (ibuffer-current-buffer))
882 (line (+ 1 (count-lines 1 (point)))))
883 (unless (buffer-live-p buf)
884 (error "Buffer %s has been killed!" buf))
885 (bury-buffer buf)
886 (ibuffer-update nil t)
887 (goto-line line)))
888
889(defun ibuffer-visit-tags-table ()
890 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
891 (interactive)
892 (let ((file (buffer-file-name (ibuffer-current-buffer))))
893 (if file
894 (visit-tags-table file)
895 (error "Specified buffer has no file"))))
896
897(defun ibuffer-do-view (&optional other-frame)
898 "View marked buffers, or the buffer on the current line.
899If optional argument OTHER-FRAME is non-nil, then display each
900marked buffer in a new frame. Otherwise, display each buffer as
901a new window in the current frame, splitting vertically."
902 (interactive)
903 (ibuffer-do-view-1 (if other-frame 'other-frame 'vertically)))
904
905(defun ibuffer-do-view-horizontally (&optional other-frame)
906 "As `ibuffer-do-view', but split windows horizontally."
907 (interactive)
908 (ibuffer-do-view-1 (if other-frame 'other-frame 'horizontally)))
909
910(defun ibuffer-do-view-1 (type)
911 (let ((marked-bufs (ibuffer-get-marked-buffers)))
912 (when (null marked-bufs)
913 (setq marked-bufs (list (ibuffer-current-buffer))))
914 (unless (and (eq type 'other-frame)
915 (not ibuffer-expert)
916 (> (length marked-bufs) 3)
917 (not (y-or-n-p (format "Really create a new frame for %s buffers? "
918 (length marked-bufs)))))
919 (set-buffer-modified-p nil)
920 (delete-other-windows)
921 (switch-to-buffer (pop marked-bufs))
922 (let ((height (/ (1- (if (eq type 'horizontally) (frame-width)
923 (frame-height)))
924 (1+ (length marked-bufs)))))
925 (mapcar (if (eq type 'other-frame)
926 #'(lambda (buf)
927 (let ((curframe (selected-frame)))
928 (select-frame (new-frame))
929 (switch-to-buffer buf)
930 (select-frame curframe)))
931 #'(lambda (buf)
932 (split-window nil height (eq type 'horizontally))
933 (other-window 1)
934 (switch-to-buffer buf)))
935 marked-bufs)))))
936
937(defun ibuffer-do-view-other-frame ()
938 "View each of the marked buffers in a separate frame."
939 (interactive)
940 (ibuffer-do-view t))
941
942(defsubst ibuffer-map-marked-lines (func)
943 (prog1 (ibuffer-map-on-mark ibuffer-marked-char func)
944 (ibuffer-redisplay t)))
945
946(defun ibuffer-shrink-to-fit (&optional owin)
947 (fit-window-to-buffer nil (when owin (/ (frame-height)
948 (length (window-list (selected-frame)))))))
949
950(defun ibuffer-confirm-operation-on (operation names)
951 "Display a buffer asking whether to perform OPERATION on NAMES."
952 (or ibuffer-expert
953 (if (= (length names) 1)
954 (y-or-n-p (format "Really %s buffer %s? " operation (car names)))
955 (let ((buf (get-buffer-create "*Ibuffer confirmation*")))
956 (with-current-buffer buf
957 (setq buffer-read-only nil)
958 (erase-buffer)
959 (ibuffer-columnize-and-insert-list names)
960 (goto-char (point-min))
961 (setq buffer-read-only t))
962 (let ((lastwin (car (last (ibuffer-window-list)))))
963 ;; Now attempt to display the buffer...
964 (save-window-excursion
965 (select-window lastwin)
966 ;; The window might be too small to split; in that case,
967 ;; try a few times to increase its size before giving up.
968 (let ((attempts 0)
969 (trying t))
970 (while trying
971 (condition-case err
972 (progn
973 (split-window)
974 (setq trying nil))
975 (error
976 ;; Handle a failure
977 (if (or (> (incf attempts) 4)
978 (and (stringp (cadr err))
979 ;; This definitely falls in the ghetto hack category...
980 (not (string-match "too small" (cadr err)))))
981 (apply #'signal err)
982 (enlarge-window 3))))))
983 ;; This part doesn't work correctly sometimes under XEmacs.
984 (select-window (next-window))
985 (switch-to-buffer buf)
986 (unwind-protect
987 (progn
988 (fit-window-to-buffer)
989 (y-or-n-p (format "Really %s %d buffers? "
990 operation (length names))))
991 (kill-buffer buf))))))))
992
993(defsubst ibuffer-map-lines-nomodify (function)
994 "As `ibuffer-map-lines', but don't set the modification flag."
995 (ibuffer-map-lines function t))
996
997(defun ibuffer-buffer-names-with-mark (mark)
998 (let ((ibuffer-buffer-names-with-mark-result nil))
999 (ibuffer-map-lines-nomodify
1000 #'(lambda (buf mk beg end)
1001 (when (char-equal mark mk)
1002 (push (buffer-name buf)
1003 ibuffer-buffer-names-with-mark-result))))
1004 ibuffer-buffer-names-with-mark-result))
1005
1006(defsubst ibuffer-marked-buffer-names ()
1007 (ibuffer-buffer-names-with-mark ibuffer-marked-char))
1008
1009(defsubst ibuffer-deletion-marked-buffer-names ()
1010 (ibuffer-buffer-names-with-mark ibuffer-deletion-char))
1011
1012(defun ibuffer-count-marked-lines (&optional all)
1013 (if all
1014 (ibuffer-map-lines-nomodify
1015 #'(lambda (buf mark beg end)
1016 (not (char-equal mark ? ))))
1017 (ibuffer-map-lines-nomodify
1018 #'(lambda (buf mark beg end)
1019 (char-equal mark ibuffer-marked-char)))))
1020
1021(defsubst ibuffer-count-deletion-lines ()
1022 (ibuffer-map-lines-nomodify
1023 #'(lambda (buf mark beg end)
1024 (char-equal mark ibuffer-deletion-char))))
1025
1026(defsubst ibuffer-map-deletion-lines (func)
1027 (ibuffer-map-on-mark ibuffer-deletion-char func))
1028
1029(define-ibuffer-op save ()
1030 "Save marked buffers as with `save-buffer'."
1031 (:complex t
1032 :opstring "saved"
1033 :modifier-p :maybe)
1034 (when (buffer-modified-p buf)
1035 (if (not (with-current-buffer buf
1036 buffer-file-name))
1037 ;; handle the case where we're prompted
1038 ;; for a file name
1039 (save-window-excursion
1040 (switch-to-buffer buf)
1041 (save-buffer))
1042 (with-current-buffer buf
1043 (save-buffer))))
1044 t)
1045
1046(define-ibuffer-op toggle-modified ()
1047 "Toggle modification flag of marked buffers."
1048 (:opstring "(un)marked as modified"
1049 :modifier-p t)
1050 (set-buffer-modified-p (not (buffer-modified-p))))
1051
1052(define-ibuffer-op toggle-read-only ()
1053 "Toggle read only status in marked buffers."
1054 (:opstring "toggled read only status in"
1055 :modifier-p t)
1056 (toggle-read-only))
1057
1058(define-ibuffer-op delete ()
1059 "Kill marked buffers as with `kill-this-buffer'."
1060 (:opstring "killed"
1061 :active-opstring "kill"
1062 :dangerous t
1063 :complex t
1064 :modifier-p t)
1065 (if (kill-buffer buf)
1066 'kill
1067 nil))
1068
1069(define-ibuffer-op kill-on-deletion-marks ()
1070 "Kill buffers marked for deletion as with `kill-this-buffer'."
1071 (:opstring "killed"
1072 :active-opstring "kill"
1073 :dangerous t
1074 :complex t
1075 :mark :deletion
1076 :modifier-p t)
1077 (if (kill-buffer buf)
1078 'kill
1079 nil))
1080
1081(defun ibuffer-unmark-all (mark)
1082 "Unmark all buffers with mark MARK."
1083 (interactive "cRemove marks (RET means all):")
1084 (if (= (ibuffer-count-marked-lines t) 0)
1085 (message "No buffers marked; use 'm' to mark a buffer")
1086 (cond
1087 ((char-equal mark ibuffer-marked-char)
1088 (ibuffer-map-marked-lines
1089 #'(lambda (buf mark beg end)
1090 (ibuffer-set-mark-1 ? )
1091 t)))
1092 ((char-equal mark ibuffer-deletion-char)
1093 (ibuffer-map-deletion-lines
1094 #'(lambda (buf mark beg end)
1095 (ibuffer-set-mark-1 ? )
1096 t)))
1097 (t
1098 (ibuffer-map-lines
1099 #'(lambda (buf mark beg end)
1100 (when (not (char-equal mark ? ))
1101 (ibuffer-set-mark-1 ? ))
1102 t)))))
1103 (ibuffer-redisplay t))
1104
1105(defun ibuffer-toggle-marks ()
1106 "Toggle which buffers are marked.
1107In other words, unmarked buffers become marked, and marked buffers
1108become unmarked."
1109 (interactive)
1110 (let ((count
1111 (ibuffer-map-lines
1112 #'(lambda (buf mark beg end)
1113 (cond ((eq mark ibuffer-marked-char)
1114 (ibuffer-set-mark-1 ? )
1115 nil)
1116 ((eq mark ? )
1117 (ibuffer-set-mark-1 ibuffer-marked-char)
1118 t)
1119 (t
1120 nil))))))
1121 (message "%s buffers marked" count))
1122 (ibuffer-redisplay t))
1123
1124(defun ibuffer-mark-forward (arg)
1125 "Mark the buffer on this line, and move forward ARG lines."
1126 (interactive "P")
1127 (ibuffer-mark-interactive arg ibuffer-marked-char 1))
1128
1129(defun ibuffer-unmark-forward (arg)
1130 "Unmark the buffer on this line, and move forward ARG lines."
1131 (interactive "P")
1132 (ibuffer-mark-interactive arg ? 1))
1133
1134(defun ibuffer-unmark-backward (arg)
1135 "Unmark the buffer on this line, and move backward ARG lines."
1136 (interactive "P")
1137 (ibuffer-mark-interactive arg ? -1))
1138
1139(defun ibuffer-mark-interactive (arg mark movement)
1140 (assert (eq major-mode 'ibuffer-mode))
1141 (unless arg
1142 (setq arg 1))
1143 (while (and (get-text-property (line-beginning-position)
1144 'ibuffer-title)
1145 (not (eobp)))
1146 (forward-line 1))
1147
1148 (let ((inhibit-read-only t))
1149 (while (> arg 0)
1150 (ibuffer-set-mark mark)
1151 (forward-line movement)
1152 (when (or (get-text-property (line-beginning-position)
1153 'ibuffer-title)
1154 (eobp))
1155 (forward-line (- movement))
1156 (setq arg 0))
1157 (setq arg (1- arg)))))
1158
1159(defun ibuffer-set-mark (mark)
1160 (assert (eq major-mode 'ibuffer-mode))
1161 (let ((inhibit-read-only t))
1162 (ibuffer-set-mark-1 mark)
1163 (setq ibuffer-did-modification t)
1164 (ibuffer-redisplay-current)))
1165
1166(defun ibuffer-set-mark-1 (mark)
1167 (let ((beg (line-beginning-position))
1168 (end (line-end-position)))
1169 (put-text-property beg end 'ibuffer-properties
1170 (list (ibuffer-current-buffer)
1171 mark))))
1172
1173(defun ibuffer-mark-for-delete (arg)
1174 "Mark the buffers on ARG lines forward for deletion."
1175 (interactive "P")
1176 (ibuffer-mark-interactive arg ibuffer-deletion-char 1))
1177
1178(defun ibuffer-mark-for-delete-backwards (arg)
1179 "Mark the buffers on ARG lines backward for deletion."
1180 (interactive "P")
1181 (ibuffer-mark-interactive arg ibuffer-deletion-char -1))
1182
1183(defun ibuffer-current-buffer (&optional must-be-live)
1184 (let ((buf (car (get-text-property (line-beginning-position)
1185 'ibuffer-properties))))
1186 (when (and must-be-live
1187 (not (buffer-live-p buf)))
1188 (error "Buffer %s has been killed!" buf))
1189 buf))
523304ed
CW
1190
1191(defun ibuffer-active-formats-name ()
1192 (if (boundp 'ibuffer-filter-format-alist)
1193 (let ((ret nil))
1194 (dolist (filter ibuffer-filtering-qualifiers ret)
1195 (let ((val (assq (car filter) ibuffer-filter-format-alist)))
1196 (when val
1197 (setq ret (car filter)))))
1198 (if ret
1199 ret
1200 :ibuffer-formats))
1201 :ibuffer-formats))
1202
1203(defun ibuffer-current-formats (uncompiledp)
1204 (let* ((name (ibuffer-active-formats-name)))
1205 (ibuffer-check-formats)
1206 (if (eq name :ibuffer-formats)
1207 (if uncompiledp
1208 ibuffer-formats
1209 ibuffer-compiled-formats)
1210 (cadr (assq name
1211 (if uncompiledp
1212 ibuffer-filter-format-alist
1213 ibuffer-compiled-filter-formats))))))
1214
1215(defun ibuffer-current-format (&optional uncompiledp)
25d2f683
CW
1216 (or ibuffer-current-format
1217 (setq ibuffer-current-format 0))
523304ed 1218 (nth ibuffer-current-format (ibuffer-current-formats uncompiledp)))
25d2f683
CW
1219
1220(defun ibuffer-expand-format-entry (form)
1221 (if (or (consp form)
1222 (symbolp form))
1223 (let ((sym (intern (concat "ibuffer-make-column-"
1224 (symbol-name (if (consp form)
1225 (car form)
1226 form))))))
1227 (unless (or (fboundp sym)
1228 (assq sym ibuffer-inline-columns))
1229 (error "Unknown column %s in ibuffer-formats" form))
1230 (let (min max align elide)
1231 (if (consp form)
1232 (setq min (or (nth 1 form) 0)
1233 max (or (nth 2 form) -1)
1234 align (or (nth 3 form) :left)
1235 elide (or (nth 4 form) nil))
1236 (setq min 0
1237 max -1
1238 align :left
1239 elide nil))
1240 (list sym min max align elide)))
1241 form))
1242
1243(defun ibuffer-compile-make-eliding-form (strvar elide from-end-p)
1244 (let ((ellipsis (if (ibuffer-use-fontification)
1245 (propertize ibuffer-eliding-string 'face 'bold)
1246 ibuffer-eliding-string)))
1247 (if (or elide ibuffer-elide-long-columns)
1248 `(if (> strlen 5)
1249 ,(if from-end-p
1250 `(concat ,ellipsis
1251 (substring ,strvar
1252 (length ibuffer-eliding-string)))
1253 `(concat
1254 (substring ,strvar 0 (- strlen ,(length ellipsis)))
1255 ,ellipsis))
1256 ,strvar)
1257 strvar)))
1258
1259(defun ibuffer-compile-make-substring-form (strvar maxvar from-end-p)
1260 (if from-end-p
1261 `(substring str
1262 (- strlen ,maxvar))
1263 `(substring ,strvar 0 ,maxvar)))
1264
1265(defun ibuffer-compile-make-format-form (strvar widthform alignment)
1266 (let* ((left `(make-string tmp2 ? ))
1267 (right `(make-string (- tmp1 tmp2) ? )))
1268 `(progn
1269 (setq tmp1 ,widthform
1270 tmp2 (/ tmp1 2))
1271 ,(case alignment
1272 (:right `(concat ,left ,right ,strvar))
1273 (:center `(concat ,left ,strvar ,right))
1274 (:left `(concat ,strvar ,left ,right))
1275 (t (error "Invalid alignment %s" alignment))))))
1276
1277(defun ibuffer-compile-format (format)
1278 (let ((result nil)
1279 str-used
1280 tmp1-used tmp2-used global-strlen-used)
1281 (dolist (form format)
1282 (push
1283 (if (stringp form)
1284 `(insert ,form)
1285 (let* ((form (ibuffer-expand-format-entry form))
1286 (sym (nth 0 form))
1287 (min (nth 1 form))
1288 (max (nth 2 form))
1289 (align (nth 3 form))
1290 (elide (nth 4 form)))
1291 (let* ((from-end-p (when (minusp min)
1292 (setq min (- min))
1293 t))
1294 (letbindings nil)
1295 (outforms nil)
1296 minform
1297 maxform
1298 min-used max-used strlen-used)
1299 (when (or (not (integerp min)) (>= min 0))
1300 (setq min-used t)
1301 (setq str-used t strlen-used t global-strlen-used t
1302 tmp1-used t tmp2-used t)
1303 (setq minform `(progn
1304 (setq str
1305 ,(ibuffer-compile-make-format-form
1306 'str
1307 `(- ,(if (integerp min)
1308 min
1309 'min)
1310 strlen)
1311 align)))))
1312 (when (or (not (integerp max)) (> max 0))
1313 (setq str-used t max-used t)
1314 (setq maxform `(progn
1315 (setq str
1316 ,(ibuffer-compile-make-substring-form
1317 'str
1318 (if (integerp max)
1319 max
1320 'max)
1321 from-end-p))
1322 (setq strlen (length str))
1323 (setq str
1324 ,(ibuffer-compile-make-eliding-form 'str
1325 elide
1326 from-end-p)))))
1327 (let ((callform (ibuffer-aif (assq sym ibuffer-inline-columns)
1328 (nth 1 it)
1329 `(,sym buffer mark)))
1330 (mincompform `(< strlen ,(if (integerp min)
1331 min
1332 'min)))
1333 (maxcompform `(> strlen ,(if (integerp max)
1334 max
1335 'max))))
1336 (if (or min-used max-used)
1337 (progn
1338 (when (and min-used (not (integerp min)))
1339 (push `(min ,min) letbindings))
1340 (when (and max-used (not (integerp max)))
1341 (push `(max ,max) letbindings))
1342 (push
1343 (if (and min-used max-used)
1344 `(if ,mincompform
1345 ,minform
1346 (if ,maxcompform
1347 ,maxform))
1348 (if min-used
1349 `(when ,mincompform
1350 ,minform)
1351 `(when ,maxcompform
1352 ,maxform)))
1353 outforms)
1354 (push (append
1355 `(setq str ,callform)
1356 (when strlen-used
1357 `(strlen (length str))))
1358 outforms)
1359 (setq outforms
1360 (append outforms `((insert str)))))
1361 (push `(insert ,callform) outforms))
1362 `(let ,letbindings
1363 ,@outforms)))))
1364 result))
1365 (setq result
1366 (funcall (if (or ibuffer-always-compile-formats
1367 (featurep 'bytecomp))
1368 #'byte-compile
1369 #'identity)
1370 (nconc (list 'lambda '(buffer mark))
d99b259b 1371 `((let ,(append (when str-used
25d2f683
CW
1372 '(str))
1373 (when global-strlen-used
1374 '(strlen))
1375 (when tmp1-used
1376 '(tmp1))
1377 (when tmp2-used
1378 '(tmp2)))
1379 ,@(nreverse result))))))))
1380
1381(defvar ibuffer-compiled-formats nil)
1382(defvar ibuffer-cached-formats nil)
1383(defvar ibuffer-cached-eliding-string nil)
1384(defvar ibuffer-cached-elide-long-columns 0)
1385
1386(defun ibuffer-recompile-formats ()
1387 "Recompile `ibuffer-formats'."
1388 (interactive)
1389 (setq ibuffer-compiled-formats
523304ed
CW
1390 (mapcar #'ibuffer-compile-format ibuffer-formats))
1391 (when (boundp 'ibuffer-filter-format-alist)
1392 (setq ibuffer-compiled-filter-formats
1393 (mapcar #'(lambda (entry)
1394 (cons (car entry)
1395 (mapcar #'(lambda (formats)
1396 (mapcar #'ibuffer-compile-format formats))
1397 (cdr entry))))
1398 ibuffer-filter-format-alist))))
25d2f683
CW
1399
1400(defun ibuffer-check-formats ()
523304ed
CW
1401 (when (null ibuffer-formats)
1402 (error "No formats!"))
25d2f683
CW
1403 (when (or (null ibuffer-compiled-formats)
1404 (null ibuffer-cached-formats)
523304ed 1405 (not (eq ibuffer-cached-formats ibuffer-formats))
25d2f683
CW
1406 (null ibuffer-cached-eliding-string)
1407 (not (equal ibuffer-cached-eliding-string ibuffer-eliding-string))
1408 (eql 0 ibuffer-cached-elide-long-columns)
1409 (not (eql ibuffer-cached-elide-long-columns
523304ed
CW
1410 ibuffer-elide-long-columns))
1411 (not (eq ibuffer-cached-filter-formats
1412 ibuffer-filter-format-alist))
1413 (and ibuffer-filter-format-alist
1414 (null ibuffer-compiled-filter-formats)))
25d2f683
CW
1415 (message "Formats have changed, recompiling...")
1416 (ibuffer-recompile-formats)
1417 (setq ibuffer-cached-formats ibuffer-formats
1418 ibuffer-cached-eliding-string ibuffer-eliding-string
523304ed
CW
1419 ibuffer-cached-elide-long-columns ibuffer-elide-long-columns
1420 ibuffer-cached-filter-formats ibuffer-filter-format-alist)
25d2f683
CW
1421 (message "Formats have changed, recompiling...done")))
1422
1423(defvar ibuffer-inline-columns nil)
1424
1425(define-ibuffer-column mark (:name " " :inline t)
1426 (string mark))
1427
1428(define-ibuffer-column read-only (:name "R" :inline t)
1429 (if buffer-read-only
1430 "%"
1431 " "))
1432
1433(define-ibuffer-column modified (:name "M" :inline t)
1434 (if (buffer-modified-p)
1435 (string ibuffer-modified-char)
1436 " "))
1437
1438(define-ibuffer-column name (:inline t
1439 :props
1440 ('mouse-face 'highlight 'keymap ibuffer-name-map
1441 'ibuffer-name-column t
1442 'help-echo "mouse-1: mark this buffer\nmouse-2: select this buffer\nmouse-3: operate on this buffer"))
1443 (buffer-name))
1444
1445(define-ibuffer-column size (:inline t)
1446 (format "%s" (buffer-size)))
1447
1448(define-ibuffer-column mode (:inline t
1449 :props
1450 ('mouse-face 'highlight
1451 'keymap ibuffer-mode-name-map
1452 'help-echo "mouse-2: filter by this mode"))
1453 (format "%s" mode-name))
1454
1455(define-ibuffer-column process ()
1456 (let ((proc (get-buffer-process buffer)))
523304ed
CW
1457 (if proc
1458 (format "(%s %s)" proc (process-status proc))
1459 "none")))
25d2f683
CW
1460
1461(define-ibuffer-column filename ()
1462 (let ((directory-abbrev-alist ibuffer-directory-abbrev-alist))
1463 (abbreviate-file-name
1464 (or buffer-file-name
1465 (and (boundp 'dired-directory)
1466 dired-directory)
1467 ""))))
1468
1469(defun ibuffer-format-column (str width alignment)
1470 (let ((left (make-string (/ width 2) ? ))
1471 (right (make-string (- width (/ width 2)) ? )))
1472 (case alignment
1473 (:right (concat left right str))
1474 (:center (concat left str right))
1475 (t (concat str left right)))))
1476
1477(defun ibuffer-fontify-region-function (beg end &optional verbose)
1478 (when verbose (message "Fontifying..."))
1479 (let ((inhibit-read-only t))
1480 (save-excursion
1481 (goto-char beg)
1482 (beginning-of-line)
1483 (while (< (point) end)
1484 (if (get-text-property (point) 'ibuffer-title-header)
1485 (put-text-property (point) (line-end-position) 'face ibuffer-title-face)
1486 (unless (get-text-property (point) 'ibuffer-title)
1487 (multiple-value-bind (buf mark)
1488 (get-text-property (point) 'ibuffer-properties)
1489 (let* ((namebeg (next-single-property-change (point) 'ibuffer-name-column
1490 nil (line-end-position)))
1491 (nameend (next-single-property-change namebeg 'ibuffer-name-column
1492 nil (line-end-position))))
1493 (put-text-property namebeg
1494 nameend
1495 'face
1496 (cond ((char-equal mark ibuffer-marked-char)
1497 ibuffer-marked-face)
1498 ((char-equal mark ibuffer-deletion-char)
1499 ibuffer-deletion-face)
1500 (t
1501 (let ((level -1)
1502 result)
1503 (dolist (e ibuffer-fontification-alist result)
1504 (when (and (> (car e) level)
1505 (with-current-buffer buf
1506 (eval (cadr e))))
1507 (setq level (car e)
1508 result
1509 (if (symbolp (caddr e))
1510 (if (facep (caddr e))
1511 (caddr e)
1512 (symbol-value (caddr e)))))))))))))))
1513 (forward-line 1))))
1514 (when verbose (message "Fontifying...done")))
1515
1516(defun ibuffer-unfontify-region-function (beg end)
1517 (let ((inhibit-read-only t))
1518 (remove-text-properties beg end '(face nil))))
1519
1520(defun ibuffer-insert-buffer-line (buffer mark format)
1521 "Insert a line describing BUFFER and MARK using FORMAT."
1522 (assert (eq major-mode 'ibuffer-mode))
1523 (let ((beg (point)))
1524 ;; Here we inhibit `syntax-ppss-after-change-function' and other
1525 ;; things font-lock uses. Otherwise, updating is slowed down dramatically.
1526 (funcall format buffer mark)
1527 (put-text-property beg (point) 'ibuffer-properties (list buffer mark))
1528 (insert "\n")
1529 (goto-char beg)))
1530
1531(defun ibuffer-redisplay-current ()
1532 (assert (eq major-mode 'ibuffer-mode))
1533 (when (eobp)
1534 (forward-line -1))
1535 (beginning-of-line)
1536 (let ((buf (ibuffer-current-buffer)))
1537 (when buf
1538 (let ((mark (ibuffer-current-mark)))
1539 (delete-region (point) (1+ (line-end-position)))
1540 (ibuffer-insert-buffer-line
1541 buf mark
1542 (ibuffer-current-format))
1543 (when ibuffer-shrink-to-minimum-size
1544 (ibuffer-shrink-to-fit))))))
1545
1546(defun ibuffer-map-on-mark (mark func)
1547 (ibuffer-map-lines
1548 #'(lambda (buf mk beg end)
1549 (if (char-equal mark mk)
1550 (funcall func buf mark beg end)
1551 nil))))
1552
1553(defun ibuffer-map-lines (function &optional nomodify)
1554 "Call FUNCTION for each buffer in an ibuffer.
1555Don't set the ibuffer modification flag iff NOMODIFY is non-nil.
1556
1557 FUNCTION is called with four arguments: the buffer object itself, the
1558current mark symbol, and the beginning and ending line positions."
1559 (assert (eq major-mode 'ibuffer-mode))
1560 (let ((curline (count-lines (point-min)
1561 (line-beginning-position)))
1562 (deleted-lines-count 0)
1563 (ibuffer-map-lines-total 0)
1564 (ibuffer-map-lines-count 0))
1565 (unwind-protect
1566 (progn
1567 (setq buffer-read-only nil)
1568 (goto-char (point-min))
1569 (while (and (get-text-property (point) 'ibuffer-title)
1570 (not (eobp)))
1571 (forward-line 1))
1572 (while (not (eobp))
1573 (let ((result
1574 (if (buffer-live-p (ibuffer-current-buffer))
1575 (save-excursion
1576 (funcall function
1577 (ibuffer-current-buffer)
1578 (ibuffer-current-mark)
1579 (line-beginning-position)
1580 (1+ (line-end-position))))
1581 ;; Kill the line if the buffer is dead
1582 'kill)))
1583 ;; A given mapping function should return:
1584 ;; `nil' if it chose not to affect the buffer
1585 ;; `kill' means the remove line from the buffer list
1586 ;; `t' otherwise
1587 (incf ibuffer-map-lines-total)
1588 (cond ((null result)
1589 (forward-line 1))
1590 ((eq result 'kill)
1591 (delete-region (line-beginning-position)
1592 (1+ (line-end-position)))
1593 (incf deleted-lines-count)
1594 (incf ibuffer-map-lines-count))
1595 (t
1596 (incf ibuffer-map-lines-count)
1597 (forward-line 1)))))
1598 ibuffer-map-lines-count)
1599 (progn
1600 (setq buffer-read-only t)
1601 (unless nomodify
1602 (set-buffer-modified-p nil))
1603 (goto-line (- (1+ curline) deleted-lines-count))))))
1604
1605(defun ibuffer-get-marked-buffers ()
1606 "Return a list of buffer objects currently marked."
1607 (delq nil
1608 (mapcar #'(lambda (e)
1609 (when (eq (cdr e) ibuffer-marked-char)
1610 (car e)))
1611 (ibuffer-current-state-list))))
1612
1613(defun ibuffer-current-state-list (&optional include-lines)
1614 "Return a list like (BUF . MARK) of all buffers in an ibuffer.
1615If optional argument INCLUDE-LINES is non-nil, return a list like
1616 (BUF MARK BEGPOS)."
1617 (let ((ibuffer-current-state-list-tmp '()))
1618 ;; ah, if only we had closures. I bet this will mysteriously
1619 ;; break later. Don't blame me.
1620 (ibuffer-map-lines-nomodify
1621 (if include-lines
1622 #'(lambda (buf mark beg end)
1623 (when (buffer-live-p buf)
1624 (push (list buf mark beg) ibuffer-current-state-list-tmp)))
1625 #'(lambda (buf mark beg end)
1626 (when (buffer-live-p buf)
1627 (push (cons buf mark) ibuffer-current-state-list-tmp)))))
1628 (nreverse ibuffer-current-state-list-tmp)))
1629
1630(defsubst ibuffer-canonicalize-state-list (bmarklist)
1631 "Order BMARKLIST in the same way as the current buffer list."
1632 (delq nil
1633 (mapcar #'(lambda (buf) (assq buf bmarklist)) (buffer-list))))
1634
1635(defun ibuffer-current-buffers-with-marks ()
1636 "Return a list like (BUF . MARK) of all open buffers."
1637 (let ((bufs (ibuffer-current-state-list)))
1638 (mapcar #'(lambda (buf) (let ((e (assq buf bufs)))
1639 (if e
1640 e
1641 (cons buf ? ))))
1642 (buffer-list))))
1643
1644(defun ibuffer-buf-matches-predicates (buf predicates)
1645 (let ((hit nil)
1646 (name (buffer-name buf)))
1647 (dolist (pred predicates)
1648 (when (if (stringp pred)
1649 (string-match pred name)
1650 (funcall pred buf))
1651 (setq hit t)))
1652 hit))
1653
1654(defun ibuffer-filter-buffers (ibuffer-buf last bmarklist all)
1655 (let ((ext-loaded (featurep 'ibuf-ext)))
1656 (delq nil
1657 (mapcar
1658 ;; element should be like (BUFFER . MARK)
1659 #'(lambda (e)
1660 (let* ((buf (car e)))
1661 (when
1662 ;; This takes precedence over anything else
1663 (or (and ibuffer-always-show-last-buffer
1664 (eq last buf))
1665 (funcall (if ext-loaded
1666 #'ibuffer-ext-visible-p
1667 #'ibuffer-visible-p)
1668 buf all ibuffer-buf))
1669 e)))
1670 bmarklist))))
1671
1672(defun ibuffer-visible-p (buf all &optional ibuffer-buf)
1673 (and (or all
1674 (not
1675 (ibuffer-buf-matches-predicates buf ibuffer-maybe-show-predicates)))
1676 (or ibuffer-view-ibuffer
1677 (and ibuffer-buf
1678 (not (eq ibuffer-buf buf))))))
1679
1680;; This function is a special case; it's not defined by
1681;; `ibuffer-define-sorter'.
1682(defun ibuffer-do-sort-by-recency ()
1683 "Sort the buffers by last view time."
1684 (interactive)
1685 (setq ibuffer-sorting-mode 'recency)
1686 (ibuffer-redisplay t))
1687
1688(defun ibuffer-update-format ()
1689 (when (null ibuffer-current-format)
1690 (setq ibuffer-current-format 0))
1691 (when (null ibuffer-formats)
1692 (error "Ibuffer error: no formats!")))
1693
1694(defun ibuffer-switch-format ()
1695 "Switch the current display format."
1696 (interactive)
1697 (assert (eq major-mode 'ibuffer-mode))
1698 (unless (consp ibuffer-formats)
1699 (error "Ibuffer error: No formats!"))
1700 (setq ibuffer-current-format
80a06d64 1701 (if (>= ibuffer-current-format (1- (length (ibuffer-current-formats nil))))
25d2f683
CW
1702 0
1703 (1+ ibuffer-current-format)))
1704 (ibuffer-update-format)
1705 (ibuffer-redisplay t))
1706
1707(defun ibuffer-update-title (format)
1708 (assert (eq major-mode 'ibuffer-mode))
1709 ;; Don't do funky font-lock stuff here
1710 (let ((after-change-functions nil))
1711 (if (get-text-property (point-min) 'ibuffer-title)
1712 (delete-region (point-min)
1713 (next-single-property-change
1714 (point-min) 'ibuffer-title)))
1715 (goto-char (point-min))
1716 (put-text-property
1717 (point)
1718 (progn
1719 (let ((opos (point)))
1720 ;; Insert the title names.
1721 (dolist (element (mapcar #'ibuffer-expand-format-entry format))
1722 (insert
1723 (if (stringp element)
1724 element
1725 (let ((sym (car element))
1726 (min (cadr element))
1727 ;; (max (caddr element))
1728 (align (cadddr element)))
1729 ;; Ignore a negative min when we're inserting the title
1730 (when (minusp min)
1731 (setq min (- min)))
1732 (let* ((name (or (get sym 'ibuffer-column-name)
1733 (error "Unknown column %s in ibuffer-formats" sym)))
1734 (len (length name)))
1735 (prog1
1736 (if (< len min)
1737 (ibuffer-format-column name
1738 (- min len)
1739 align)
1740 name)))))))
1741 (put-text-property opos (point) 'ibuffer-title-header t)
1742 (insert "\n")
1743 ;; Add the underlines
1744 (let ((str (save-excursion
1745 (forward-line -1)
1746 (beginning-of-line)
1747 (buffer-substring (point) (line-end-position)))))
1748 (apply #'insert (mapcar
1749 #'(lambda (c)
1750 (if (not (or (char-equal c ? )
1751 (char-equal c ?\n)))
1752 ?-
1753 ? ))
1754 str)))
1755 (insert "\n"))
1756 (point))
1757 'ibuffer-title t)))
1758
1759(defun ibuffer-update-mode-name ()
1760 (setq mode-name (format "Ibuffer by %s" (if ibuffer-sorting-mode
1761 ibuffer-sorting-mode
1762 "recency")))
1763 (when ibuffer-sorting-reversep
1764 (setq mode-name (concat mode-name " [rev]")))
1765 (when (and (featurep 'ibuf-ext)
1766 ibuffer-auto-mode)
1767 (setq mode-name (concat mode-name " (Auto)")))
1768 (let ((result ""))
1769 (when (featurep 'ibuf-ext)
1770 (dolist (qualifier ibuffer-filtering-qualifiers)
1771 (setq result
1772 (concat result (ibuffer-format-qualifier qualifier))))
1773 (if ibuffer-use-header-line
1774 (setq header-line-format
1775 (when ibuffer-filtering-qualifiers
1776 (replace-regexp-in-string "%" "%%"
1777 (concat mode-name result))))
1778 (progn
1779 (setq mode-name (concat mode-name result))
1780 (when (boundp 'header-line-format)
1781 (setq header-line-format nil)))))))
1782
1783(defun ibuffer-redisplay (&optional silent)
1784 "Redisplay the current list of buffers.
1785
1786This does not show new buffers; use `ibuffer-update' for that.
1787
1788If SILENT is non-`nil', do not generate progress messages."
1789 (interactive)
1790 (unless silent
1791 (message "Redisplaying current buffer list..."))
1792 (let ((blist (ibuffer-current-state-list)))
1793 (when (null blist)
1794 (if (and (featurep 'ibuf-ext)
1795 ibuffer-filtering-qualifiers)
1796 (message "No buffers! (note: filtering in effect)")
1797 (error "No buffers!")))
1798 (ibuffer-insert-buffers-and-marks blist t)
1799 (ibuffer-update-mode-name)
1800 (unless silent
1801 (message "Redisplaying current buffer list...done"))))
1802
1803(defun ibuffer-update (arg &optional silent)
1804 "Regenerate the list of all buffers.
1805
1806Display buffers whose name matches one of `ibuffer-maybe-show-predicates'
1807iff arg ARG is non-nil.
1808
1809Do not display messages if SILENT is non-nil."
1810 (interactive "P")
1811 (let* ((bufs (buffer-list))
1812 (blist (ibuffer-filter-buffers
1813 (current-buffer)
1814 (if (and
1815 (cadr bufs)
1816 (eq ibuffer-always-show-last-buffer
1817 :nomini)
1818 ;; This is a hack.
1819 (string-match " \\*Minibuf"
1820 (buffer-name (cadr bufs))))
1821 (caddr bufs)
1822 (cadr bufs))
1823 (ibuffer-current-buffers-with-marks)
1824 arg)))
1825 (when (null blist)
1826 (if (and (featurep 'ibuf-ext)
1827 ibuffer-filtering-qualifiers)
1828 (message "No buffers! (note: filtering in effect)")
1829 (error "No buffers!")))
1830 (unless silent
1831 (message "Updating buffer list..."))
1832 (ibuffer-insert-buffers-and-marks blist
1833 arg)
1834 (ibuffer-update-mode-name)
1835 (unless silent
1836 (message "Updating buffer list...done")))
1837 (if (eq ibuffer-shrink-to-minimum-size 'onewindow)
1838 (ibuffer-shrink-to-fit t)
1839 (when ibuffer-shrink-to-minimum-size
1840 (ibuffer-shrink-to-fit)))
1841 (ibuffer-forward-line 0))
1842
1843(defun ibuffer-insert-buffers-and-marks (bmarklist &optional all)
1844 (assert (eq major-mode 'ibuffer-mode))
1845 (let ((--ibuffer-insert-buffers-and-marks-format
1846 (ibuffer-current-format))
1847 (orig (count-lines (point-min) (point)))
1848 ;; Inhibit font-lock caching tricks, since we're modifying the
1849 ;; entire buffer at once
1850 (after-change-functions nil))
1851 (unwind-protect
1852 (progn
1853 (setq buffer-read-only nil)
1854 (erase-buffer)
1855 (ibuffer-update-format)
1856 (let ((entries
1857 (let* ((sortdat (assq ibuffer-sorting-mode
1858 ibuffer-sorting-functions-alist))
1859 (func (caddr sortdat)))
1860 (let ((result
1861 ;; actually sort the buffers
1862 (if (and sortdat func)
1863 (sort bmarklist func)
1864 bmarklist)))
1865 ;; perhaps reverse the sorted buffer list
1866 (if ibuffer-sorting-reversep
1867 result
1868 (nreverse result))))))
1869 (dolist (entry entries)
1870 (ibuffer-insert-buffer-line
1871 (car entry)
1872 (cdr entry)
1873 --ibuffer-insert-buffers-and-marks-format)))
523304ed 1874 (ibuffer-update-title (ibuffer-current-format t)))
25d2f683
CW
1875 (setq buffer-read-only t)
1876 (set-buffer-modified-p ibuffer-did-modification)
1877 (setq ibuffer-did-modification nil)
1878 (goto-line (1+ orig)))))
1879
1880(defun ibuffer-quit ()
1881 "Quit this `ibuffer' session.
1882Delete the current window iff `ibuffer-delete-window-on-quit' is non-nil."
1883 (interactive)
1884 (if ibuffer-delete-window-on-quit
1885 (progn
1886 (bury-buffer)
1887 (unless (= (count-windows) 1)
1888 (delete-window)))
1889 (bury-buffer)))
1890
1891;;;###autoload
1892(defun ibuffer-list-buffers (&optional files-only)
1893 "Display a list of buffers, in another window.
1894If optional argument FILES-ONLY is non-nil, then add a filter for
1895buffers which are visiting a file."
1896 (interactive "P")
1897 (ibuffer t nil (when files-only
1898 '((filename . ".*"))) t))
1899
1900;;;###autoload
1901(defun ibuffer-other-window (&optional files-only)
1902 "Like `ibuffer', but displayed in another window by default.
1903If optional argument FILES-ONLY is non-nil, then add a filter for
1904buffers which are visiting a file."
1905 (interactive "P")
1906 (ibuffer t nil (when files-only
1907 '((filename . ".*")))))
1908
1909;;;###autoload
1910(defun ibuffer (&optional other-window-p name qualifiers noselect shrink)
1911 "Begin using `ibuffer' to edit a list of buffers.
1912Type 'h' after entering ibuffer for more information.
1913
1914Optional argument OTHER-WINDOW-P says to use another window.
1915Optional argument NAME specifies the name of the buffer; it defaults
1916to \"*Ibuffer*\".
1917Optional argument QUALIFIERS is an initial set of filtering qualifiers
1918to use; see `ibuffer-filtering-qualifiers'.
1919Optional argument NOSELECT means don't select the Ibuffer buffer.
1920Optional argument SHRINK means shrink the buffer to minimal size. The
1921special value `onewindow' means always use another window."
1922 (interactive "P")
5b2977e4
RS
1923
1924 ;; The individual functions are lazy-loaded, via byte-compile-dynamic,
1925 ;; so we may as well load the file unconditionally now.
1926 (require 'ibuf-ext)
1927
25d2f683
CW
1928 (when ibuffer-use-other-window
1929 (setq other-window-p (not other-window-p)))
1930 (let* ((buf (get-buffer-create (or name "*Ibuffer*")))
1931 (already-in (eq (current-buffer) buf))
1932 (need-update nil))
1933 (if other-window-p
1934 (funcall (if noselect #'(lambda (buf) (display-buffer buf t)) #'pop-to-buffer) buf)
1935 (funcall (if noselect #'display-buffer #'switch-to-buffer) buf))
1936 (with-current-buffer buf
1937 (let ((owin (selected-window)))
1938 (unwind-protect
1939 (progn
1940 ;; We switch to the buffer's window in order to be able
1941 ;; to modify the value of point
1942 (select-window (get-buffer-window buf))
1943 (unless (eq major-mode 'ibuffer-mode)
1944 (ibuffer-mode)
1945 (setq need-update t))
1946 (when (ibuffer-use-fontification)
1947 (require 'font-lock))
1948 (setq ibuffer-delete-window-on-quit other-window-p)
1949 (when shrink
1950 (setq ibuffer-shrink-to-minimum-size shrink))
1951 (when qualifiers
1952 (setq ibuffer-filtering-qualifiers qualifiers))
1953 (ibuffer-update nil)
1954 (unwind-protect
1955 (progn
1956 (setq buffer-read-only nil)
1957 (run-hooks 'ibuffer-hooks))
1958 (setq buffer-read-only t))
1959 (unless ibuffer-expert
1960 (message "Commands: m, u, t, RET, g, k, S, D, Q; q to quit; h for help")))
1961 (select-window owin))))))
1962
1963(defun ibuffer-mode ()
1964 "A major mode for viewing a list of buffers.
1965In ibuffer, you can conveniently perform many operations on the
1966currently open buffers, in addition to filtering your view to a
1967particular subset of them, and sorting by various criteria.
1968
1969Operations on marked buffers:
1970
1971 '\\[ibuffer-do-save]' - Save the marked buffers
1972 '\\[ibuffer-do-view]' - View the marked buffers in this frame.
1973 '\\[ibuffer-do-view-other-frame]' - View the marked buffers in another frame.
1974 '\\[ibuffer-do-revert]' - Revert the marked buffers.
1975 '\\[ibuffer-do-toggle-read-only]' - Toggle read-only state of marked buffers.
1976 '\\[ibuffer-do-delete]' - Kill the marked buffers.
1977 '\\[ibuffer-do-replace-regexp]' - Replace by regexp in each of the marked
1978 buffers.
1979 '\\[ibuffer-do-query-replace]' - Query replace in each of the marked buffers.
1980 '\\[ibuffer-do-query-replace-regexp]' - As above, with a regular expression.
1981 '\\[ibuffer-do-print]' - Print the marked buffers.
1982 '\\[ibuffer-do-occur]' - List lines in all marked buffers which match
1983 a given regexp (like the function `occur').
1984 '\\[ibuffer-do-shell-command-pipe]' - Pipe the contents of the marked
1985 buffers to a shell command.
1986 '\\[ibuffer-do-shell-command-pipe-replace]' - Replace the contents of the marked
1987 buffers with the output of a shell command.
1988 '\\[ibuffer-do-shell-command-file]' - Run a shell command with the
1989 buffer's file as an argument.
1990 '\\[ibuffer-do-eval]' - Evaluate a form in each of the marked buffers. This
1991 is a very flexible command. For example, if you want to make all
1992 of the marked buffers read only, try using (toggle-read-only 1) as
1993 the input form.
1994 '\\[ibuffer-do-view-and-eval]' - As above, but view each buffer while the form
1995 is evaluated.
1996 '\\[ibuffer-do-kill-lines]' - Remove the marked lines from the *Ibuffer* buffer,
1997 but don't kill the associated buffer.
1998 '\\[ibuffer-do-kill-on-deletion-marks]' - Kill all buffers marked for deletion.
1999
2000Marking commands:
2001
2002 '\\[ibuffer-mark-forward]' - Mark the buffer at point.
2003 '\\[ibuffer-toggle-marks]' - Unmark all currently marked buffers, and mark
2004 all unmarked buffers.
2005 '\\[ibuffer-unmark-forward]' - Unmark the buffer at point.
2006 '\\[ibuffer-unmark-backward]' - Unmark the buffer at point, and move to the
2007 previous line.
2008 '\\[ibuffer-unmark-all]' - Unmark all marked buffers.
2009 '\\[ibuffer-mark-by-mode]' - Mark buffers by major mode.
2010 '\\[ibuffer-mark-unsaved-buffers]' - Mark all \"unsaved\" buffers.
2011 This means that the buffer is modified, and has an associated file.
2012 '\\[ibuffer-mark-modified-buffers]' - Mark all modified buffers,
2013 regardless of whether or not they have an associated file.
2014 '\\[ibuffer-mark-special-buffers]' - Mark all buffers whose name begins and
2015 ends with '*'.
2016 '\\[ibuffer-mark-dissociated-buffers]' - Mark all buffers which have
2017 an associated file, but that file doesn't currently exist.
2018 '\\[ibuffer-mark-read-only-buffers]' - Mark all read-only buffers.
2019 '\\[ibuffer-mark-dired-buffers]' - Mark buffers in `dired' mode.
2020 '\\[ibuffer-mark-help-buffers]' - Mark buffers in `help-mode', `apropos-mode', etc.
2021 '\\[ibuffer-mark-old-buffers]' - Mark buffers older than `ibuffer-old-time'.
2022 '\\[ibuffer-mark-for-delete]' - Mark the buffer at point for deletion.
2023 '\\[ibuffer-mark-by-name-regexp]' - Mark buffers by their name, using a regexp.
2024 '\\[ibuffer-mark-by-mode-regexp]' - Mark buffers by their major mode, using a regexp.
2025 '\\[ibuffer-mark-by-file-name-regexp]' - Mark buffers by their filename, using a regexp.
2026
2027Filtering commands:
2028
2029 '\\[ibuffer-filter-by-mode]' - Add a filter by major mode.
2030 '\\[ibuffer-filter-by-name]' - Add a filter by buffer name.
2031 '\\[ibuffer-filter-by-content]' - Add a filter by buffer content.
2032 '\\[ibuffer-filter-by-filename]' - Add a filter by filename.
2033 '\\[ibuffer-filter-by-size-gt]' - Add a filter by buffer size.
2034 '\\[ibuffer-filter-by-size-lt]' - Add a filter by buffer size.
2035 '\\[ibuffer-filter-by-predicate]' - Add a filter by an arbitrary Lisp predicate.
2036 '\\[ibuffer-save-filters]' - Save the current filters with a name.
2037 '\\[ibuffer-switch-to-saved-filters]' - Switch to previously saved filters.
2038 '\\[ibuffer-add-saved-filters]' - Add saved filters to current filters.
2039 '\\[ibuffer-or-filter]' - Replace the top two filters with their logical OR.
2040 '\\[ibuffer-pop-filter]' - Remove the top filter.
2041 '\\[ibuffer-negate-filter]' - Invert the logical sense of the top filter.
2042 '\\[ibuffer-decompose-filter]' - Break down the topmost filter.
2043 '\\[ibuffer-filter-disable]' - Remove all filtering currently in effect.
2044
2045Sorting commands:
2046
2047 '\\[ibuffer-toggle-sorting-mode]' - Rotate between the various sorting modes.
2048 '\\[ibuffer-invert-sorting]' - Reverse the current sorting order.
2049 '\\[ibuffer-do-sort-by-alphabetic]' - Sort the buffers lexicographically.
2050 '\\[ibuffer-do-sort-by-recency]' - Sort the buffers by last viewing time.
2051 '\\[ibuffer-do-sort-by-size]' - Sort the buffers by size.
2052 '\\[ibuffer-do-sort-by-major-mode]' - Sort the buffers by major mode.
2053
2054Other commands:
2055
2056 '\\[ibuffer-switch-format]' - Change the current display format.
2057 '\\[forward-line]' - Move point to the next line.
2058 '\\[previous-line]' - Move point to the previous line.
2059 '\\[ibuffer-update]' - As above, but add new buffers to the list.
2060 '\\[ibuffer-quit]' - Bury the Ibuffer buffer.
2061 '\\[describe-mode]' - This help.
2062 '\\[ibuffer-diff-with-file]' - View the differences between this buffer
2063 and its associated file.
2064 '\\[ibuffer-visit-buffer]' - View the buffer on this line.
2065 '\\[ibuffer-visit-buffer-other-window]' - As above, but in another window.
2066 '\\[ibuffer-visit-buffer-other-window-noselect]' - As both above, but don't select
2067 the new window.
2068 '\\[ibuffer-bury-buffer]' - Bury (not kill!) the buffer on this line.
2069
2070Information on Filtering:
2071
2072 You can filter your ibuffer view via different critera. Each Ibuffer
2073buffer has its own stack of active filters. For example, suppose you
2074are working on an Emacs Lisp project. You can create an Ibuffer
2075buffer displays buffers in just `emacs-lisp' modes via
2076'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET'. In this case, there
2077is just one entry on the filtering stack.
2078
2079You can also combine filters. The various filtering commands push a
2080new filter onto the stack, and the filters combine to show just
2081buffers which satisfy ALL criteria on the stack. For example, suppose
2082you only want to see buffers in `emacs-lisp' mode, whose names begin
2083with \"gnus\". You can accomplish this via:
2084'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET
2085\\[ibuffer-filter-by-name] ^gnus RET'.
2086
2087Additionally, you can OR the top two filters together with
2088'\\[ibuffer-or-filters]'. To see all buffers in either
2089`emacs-lisp-mode' or `lisp-interaction-mode', type:
2090
2091'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET \\[ibuffer-filter-by-mode] lisp-interaction-mode RET \\[ibuffer-or-filters]'.
2092
2093Filters can also be saved and restored using mnemonic names: see the
2094functions `ibuffer-save-filters' and `ibuffer-switch-to-saved-filters'.
2095
2096To remove the top filter on the stack, use '\\[ibuffer-pop-filter]', and
2097to disable all filtering currently in effect, use
2098'\\[ibuffer-filter-disable]'."
2099 (kill-all-local-variables)
2100 (use-local-map ibuffer-mode-map)
2101 (setq major-mode 'ibuffer-mode)
2102 (setq mode-name "Ibuffer")
2103 (setq buffer-read-only t)
2104 (buffer-disable-undo)
3eda3649 2105 (setq truncate-lines ibuffer-truncate-lines)
25d2f683
CW
2106 ;; This makes things less ugly for Emacs 21 users with a non-nil
2107 ;; `show-trailing-whitespace'.
2108 (setq show-trailing-whitespace nil)
2109 ;; Dummy font-lock-defaults to make font-lock turn on. We want this
2110 ;; so we know when to enable ibuffer's internal fontification.
2111 (set (make-local-variable 'font-lock-defaults)
2112 '(nil t nil nil nil
2113 (font-lock-fontify-region-function . ibuffer-fontify-region-function)
2114 (font-lock-unfontify-region-function . ibuffer-unfontify-region-function)))
2115 (set (make-local-variable 'revert-buffer-function)
2116 #'ibuffer-update)
2117 (set (make-local-variable 'ibuffer-sorting-mode)
2118 ibuffer-default-sorting-mode)
2119 (set (make-local-variable 'ibuffer-sorting-reversep)
2120 ibuffer-default-sorting-reversep)
2121 (set (make-local-variable 'ibuffer-shrink-to-minimum-size)
2122 ibuffer-default-shrink-to-minimum-size)
2123 (set (make-local-variable 'ibuffer-filtering-qualifiers) nil)
2124 (set (make-local-variable 'ibuffer-compiled-formats) nil)
2125 (set (make-local-variable 'ibuffer-cached-formats) nil)
2126 (set (make-local-variable 'ibuffer-cached-eliding-string) nil)
2127 (set (make-local-variable 'ibuffer-cached-elide-long-columns) nil)
2128 (set (make-local-variable 'ibuffer-current-format) nil)
2129 (set (make-local-variable 'ibuffer-did-modifiction) nil)
2130 (set (make-local-variable 'ibuffer-delete-window-on-quit) nil)
2131 (set (make-local-variable 'ibuffer-did-modification) nil)
2132 (when (featurep 'ibuf-ext)
2133 (set (make-local-variable 'ibuffer-tmp-hide-regexps) nil)
2134 (set (make-local-variable 'ibuffer-tmp-show-regexps) nil))
2135 (define-key ibuffer-mode-map [menu-bar edit] 'undefined)
2136 (define-key ibuffer-mode-map [menu-bar operate] (cons "Operate" ibuffer-mode-operate-map))
2137 (ibuffer-update-format)
2138 (when ibuffer-default-directory
2139 (setq default-directory ibuffer-default-directory))
2140 (run-hooks 'ibuffer-mode-hooks)
2141 ;; called after mode hooks to allow the user to add filters
2142 (ibuffer-update-mode-name))
2143
2144(provide 'ibuffer)
2145
2146;; Local Variables:
2147;; coding: iso-8859-1
2148;; End:
2149
2150;;; ibuffer.el ends here