(file-remote-p): Docstring fix.
[emacs.git] / lisp / ibuffer.el
blob7c6da00cf0f2779aa383f51dcd8d5b46af0bfb40
1 ;;; ibuffer.el --- operate on buffers like dired
3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Colin Walters <walters@verbum.org>
7 ;; Maintainer: John Paul Wallington <jpw@gnu.org>
8 ;; Created: 8 Sep 2000
9 ;; Keywords: buffer, convenience
11 ;; This file is part of GNU Emacs.
13 ;; This program is free software; you can redistribute it and/or
14 ;; modify it under the terms of the GNU General Public License as
15 ;; published by the Free Software Foundation; either version 3, or (at
16 ;; your option) any later version.
18 ;; This program is distributed in the hope that it will be useful, but
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 ;; General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program ; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; ibuffer.el is an advanced replacement for the `buffer-menu' which
31 ;; is normally distributed with Emacs. Its interface is intended to
32 ;; be analogous to that of Dired.
34 ;;; Code:
36 (eval-when-compile
37 (require 'cl)
38 (require 'ibuf-macs)
39 (require 'dired))
41 (require 'font-core)
43 ;; These come from ibuf-ext.el, which can not be require'd at compile time
44 ;; because it has a recursive dependency on ibuffer.el
45 (defvar ibuffer-auto-mode)
46 (defvar ibuffer-cached-filter-formats)
47 (defvar ibuffer-compiled-filter-formats)
48 (defvar ibuffer-filter-format-alist)
49 (defvar ibuffer-filter-group-kill-ring)
50 (defvar ibuffer-filter-groups)
51 (defvar ibuffer-filtering-qualifiers)
52 (defvar ibuffer-hidden-filter-groups)
53 (defvar ibuffer-inline-columns)
54 (defvar ibuffer-show-empty-filter-groups)
55 (defvar ibuffer-tmp-hide-regexps)
56 (defvar ibuffer-tmp-show-regexps)
58 (declare-function ibuffer-mark-on-buffer "ibuf-ext"
59 (func &optional ibuffer-mark-on-buffer-mark group))
60 (declare-function ibuffer-format-qualifier "ibuf-ext" (qualifier))
61 (declare-function ibuffer-generate-filter-groups "ibuf-ext"
62 (bmarklist &optional noempty nodefault))
63 (declare-function ibuffer-format-filter-group-data "ibuf-ext" (filter))
65 (defgroup ibuffer nil
66 "An advanced replacement for `buffer-menu'.
68 Ibuffer allows you to operate on buffers in a manner much like Dired.
69 Operations include sorting, marking by regular expression, and
70 the ability to filter the displayed buffers by various criteria."
71 :version "22.1"
72 :group 'convenience)
74 (defcustom ibuffer-formats '((mark modified read-only " " (name 18 18 :left :elide)
75 " " (size 9 -1 :right)
76 " " (mode 16 16 :left :elide) " " filename-and-process)
77 (mark " " (name 16 -1) " " filename))
78 "A list of ways to display buffer lines.
80 With Ibuffer, you are not limited to displaying just certain
81 attributes of a buffer such as size, name, and mode in a particular
82 order. Through this variable, you can completely customize and
83 control the appearance of an Ibuffer buffer. See also
84 `define-ibuffer-column', which allows you to define your own columns
85 for display.
87 This variable has the form
88 ((COLUMN COLUMN ...) (COLUMN COLUMN ...) ...)
89 Each element in `ibuffer-formats' should be a list containing COLUMN
90 specifiers. A COLUMN can be any of the following:
92 SYMBOL - A symbol naming the column. Predefined columns are:
93 mark modified read-only name size mode process filename
94 When you define your own columns using `define-ibuffer-column', just
95 use their name like the predefined columns here. This entry can
96 also be a function of two arguments, which should return a string.
97 The first argument is the buffer object, and the second is the mark
98 on that buffer.
100 \"STRING\" - A literal string to display.
102 (SYMBOL MIN-SIZE MAX-SIZE &optional ALIGN ELIDE) - SYMBOL is a
103 symbol naming the column, and MIN-SIZE and MAX-SIZE are integers (or
104 functions of no arguments returning an integer) which constrict the
105 size of a column. If MAX-SIZE is -1, there is no upper bound. The
106 default values are 0 and -1, respectively. If MIN-SIZE is negative,
107 use the end of the string. The optional element ALIGN describes the
108 alignment of the column; it can be :left, :center or :right. The
109 optional element ELIDE describes whether or not to elide the column
110 if it is too long; valid values are :elide and nil. The default is
111 nil (don't elide).
113 Some example of valid entries in `ibuffer-formats', with
114 description (also, feel free to try them out, and experiment with your
115 own!):
117 (mark \" \" name)
118 This format just displays the current mark (if any) and the name of
119 the buffer, separated by a space.
120 (mark modified read-only \" \" (name 16 16 :left) \" \" (size 6 -1 :right))
121 This format displays the current mark (if any), its modification and
122 read-only status, as well as the name of the buffer and its size. In
123 this format, the name is restricted to 16 characters (longer names
124 will be truncated, and shorter names will be padded with spaces), and
125 the name is also aligned to the left. The size of the buffer will
126 be padded with spaces up to a minimum of six characters, but there is
127 no upper limit on its size. The size will also be aligned to the
128 right.
130 Thus, if you wanted to use these two formats, add
132 (setq ibuffer-formats '((mark \" \" name)
133 (mark modified read-only
134 (name 16 16 :left) (size 6 -1 :right))))
136 to your ~/.emacs file.
138 Using \\[ibuffer-switch-format], you can rotate the display between
139 the specified formats in the list."
140 :type '(repeat sexp)
141 :group 'ibuffer)
143 (defcustom ibuffer-always-compile-formats (featurep 'bytecomp)
144 "If non-nil, then use the byte-compiler to optimize `ibuffer-formats'.
145 This will increase the redisplay speed, at the cost of loading the
146 elisp byte-compiler."
147 :type 'boolean
148 :group 'ibuffer)
150 (defcustom ibuffer-fontification-alist
151 `((10 buffer-read-only font-lock-constant-face)
152 (15 (and buffer-file-name
153 (string-match ibuffer-compressed-file-name-regexp
154 buffer-file-name))
155 font-lock-doc-face)
156 (20 (string-match "^*" (buffer-name)) font-lock-keyword-face)
157 (25 (and (string-match "^ " (buffer-name))
158 (null buffer-file-name))
159 italic)
160 (30 (memq major-mode ibuffer-help-buffer-modes) font-lock-comment-face)
161 (35 (eq major-mode 'dired-mode) font-lock-function-name-face))
162 "An alist describing how to fontify buffers.
163 Each element should be of the form (PRIORITY FORM FACE), where
164 PRIORITY is an integer, FORM is an arbitrary form to evaluate in the
165 buffer, and FACE is the face to use for fontification. If the FORM
166 evaluates to non-nil, then FACE will be put on the buffer name. The
167 element with the highest PRIORITY takes precedence.
169 If you change this variable, you must kill the Ibuffer buffer and
170 recreate it for the change to take effect."
171 :type '(repeat
172 (list (integer :tag "Priority")
173 (sexp :tag "Test Form")
174 face))
175 :group 'ibuffer)
177 (defcustom ibuffer-use-other-window nil
178 "If non-nil, display Ibuffer in another window by default."
179 :type 'boolean
180 :group 'ibuffer)
182 (defcustom ibuffer-default-shrink-to-minimum-size nil
183 "If non-nil, minimize the size of the Ibuffer window by default."
184 :type 'boolean
185 :group 'ibuffer)
186 (defvar ibuffer-shrink-to-minimum-size nil)
188 (defcustom ibuffer-display-summary t
189 "If non-nil, summarize Ibuffer columns."
190 :type 'boolean
191 :group 'ibuffer)
193 (defcustom ibuffer-truncate-lines t
194 "If non-nil, do not display continuation lines."
195 :type 'boolean
196 :group 'ibuffer)
198 (defcustom ibuffer-case-fold-search case-fold-search
199 "If non-nil, ignore case when searching."
200 :type 'boolean
201 :group 'ibuffer)
203 (defcustom ibuffer-default-sorting-mode 'recency
204 "The criteria by which to sort the buffers.
206 Note that this variable is local to each Ibuffer buffer. Thus, you
207 can have multiple Ibuffer buffers open, each with a different sorted
208 view of the buffers."
209 :type '(choice (const :tag "Last view time" :value recency)
210 (const :tag "Lexicographic" :value alphabetic)
211 (const :tag "Buffer size" :value size)
212 (const :tag "File name" :value filename/process)
213 (const :tag "Major mode" :value major-mode))
214 :group 'ibuffer)
215 (defvar ibuffer-sorting-mode nil)
217 (defcustom ibuffer-default-sorting-reversep nil
218 "If non-nil, reverse the default sorting order."
219 :type 'boolean
220 :group 'ibuffer)
221 (defvar ibuffer-sorting-reversep nil)
223 (defcustom ibuffer-elide-long-columns nil
224 "If non-nil, then elide column entries which exceed their max length."
225 :type 'boolean
226 :group 'ibuffer)
227 (make-obsolete-variable 'ibuffer-elide-long-columns
228 "use the :elide argument of `ibuffer-formats'."
229 "22.1")
231 (defcustom ibuffer-eliding-string "..."
232 "The string to use for eliding long columns."
233 :type 'string
234 :group 'ibuffer)
236 (defcustom ibuffer-maybe-show-predicates `(,(lambda (buf)
237 (and (string-match "^ " (buffer-name buf))
238 (null buffer-file-name))))
239 "A list of predicates for buffers to display conditionally.
241 A predicate can be a regexp or a function.
242 If a regexp, then it will be matched against the buffer's name.
243 If a function, it will be called with the buffer as an argument, and
244 should return non-nil if this buffer should be shown.
246 Viewing of buffers hidden because of these predicates may be customized
247 via `ibuffer-default-display-maybe-show-predicates' and is toggled by
248 giving a non-nil prefix argument to `ibuffer-update'.
249 Note that this specialized filtering occurs before real filtering."
250 :type '(repeat (choice regexp function))
251 :group 'ibuffer)
253 (defcustom ibuffer-default-display-maybe-show-predicates nil
254 "Non-nil means show buffers that match `ibuffer-maybe-show-predicates'."
255 :type 'boolean
256 :group 'ibuffer)
258 (defvar ibuffer-display-maybe-show-predicates nil)
260 (defvar ibuffer-current-format nil)
262 (defcustom ibuffer-movement-cycle t
263 "If non-nil, then forward and backwards movement commands cycle."
264 :type 'boolean
265 :group 'ibuffer)
267 (defcustom ibuffer-modified-char ?*
268 "The character to display for modified buffers."
269 :type 'character
270 :group 'ibuffer)
272 (defcustom ibuffer-read-only-char ?%
273 "The character to display for read-only buffers."
274 :type 'character
275 :group 'ibuffer)
277 (defcustom ibuffer-marked-char ?>
278 "The character to display for marked buffers."
279 :type 'character
280 :group 'ibuffer)
282 (defcustom ibuffer-deletion-char ?D
283 "The character to display for buffers marked for deletion."
284 :type 'character
285 :group 'ibuffer)
287 (defcustom ibuffer-expert nil
288 "If non-nil, don't ask for confirmation of \"dangerous\" operations."
289 :type 'boolean
290 :group 'ibuffer)
292 (defcustom ibuffer-view-ibuffer nil
293 "If non-nil, display the current Ibuffer buffer itself.
294 Note that this has a drawback - the data about the current Ibuffer
295 buffer will most likely be inaccurate. This includes modification
296 state, size, etc."
297 :type 'boolean
298 :group 'ibuffer)
300 (defcustom ibuffer-always-show-last-buffer nil
301 "If non-nil, always display the previous buffer.
302 This variable takes precedence over filtering, and even
303 `ibuffer-never-show-predicates'."
304 :type '(choice (const :tag "Always" :value t)
305 (const :tag "Never" :value nil)
306 (const :tag "Always except minibuffer" :value :nomini))
307 :group 'ibuffer)
309 (defcustom ibuffer-jump-offer-only-visible-buffers nil
310 "If non-nil, only offer buffers visible in the Ibuffer buffer
311 in completion lists of the `ibuffer-jump-to-buffer' command."
312 :type 'boolean
313 :group 'ibuffer)
315 (defcustom ibuffer-use-header-line (boundp 'header-line-format)
316 "If non-nil, display a header line containing current filters."
317 :type 'boolean
318 :group 'ibuffer)
320 (defcustom ibuffer-default-directory nil
321 "The default directory to use for a new Ibuffer buffer.
322 If nil, inherit the directory of the buffer in which `ibuffer' was
323 called. Otherwise, this variable should be a string naming a
324 directory, like `default-directory'."
325 :type '(choice (const :tag "Inherit" :value nil)
326 string)
327 :group 'ibuffer)
329 (defcustom ibuffer-help-buffer-modes
330 '(help-mode apropos-mode Info-mode Info-edit-mode)
331 "List of \"Help\" major modes."
332 :type '(repeat function)
333 :group 'ibuffer)
335 (defcustom ibuffer-compressed-file-name-regexp
336 "\\.\\(arj\\|bgz\\|bz2\\|gz\\|lzh\\|taz\\|tgz\\|zip\\|z\\)$"
337 "Regexp to match compressed file names."
338 :type 'regexp
339 :group 'ibuffer)
341 (defcustom ibuffer-hook nil
342 "Hook run when `ibuffer' is called."
343 :type 'hook
344 :group 'ibuffer)
345 (define-obsolete-variable-alias 'ibuffer-hooks
346 'ibuffer-hook "22.1")
348 (defcustom ibuffer-mode-hook nil
349 "Hook run upon entry into `ibuffer-mode'."
350 :type 'hook
351 :group 'ibuffer)
352 (define-obsolete-variable-alias 'ibuffer-mode-hooks
353 'ibuffer-mode-hook "22.1")
355 (defcustom ibuffer-load-hook nil
356 "Hook run when Ibuffer is loaded."
357 :type 'hook
358 :group 'ibuffer)
360 (defcustom ibuffer-marked-face 'font-lock-warning-face
361 "Face used for displaying marked buffers."
362 :type 'face
363 :group 'ibuffer)
365 (defcustom ibuffer-deletion-face 'font-lock-type-face
366 "Face used for displaying buffers marked for deletion."
367 :type 'face
368 :group 'ibuffer)
370 (defcustom ibuffer-title-face 'font-lock-type-face
371 "Face used for the title string."
372 :type 'face
373 :group 'ibuffer)
375 (defcustom ibuffer-filter-group-name-face 'bold
376 "Face used for displaying filtering group names."
377 :type 'face
378 :group 'ibuffer)
380 (defcustom ibuffer-directory-abbrev-alist nil
381 "An alist of file name abbreviations like `directory-abbrev-alist'."
382 :type '(repeat (cons :format "%v"
383 :value ("" . "")
384 (regexp :tag "From")
385 (regexp :tag "To")))
386 :group 'ibuffer)
389 (defvar ibuffer-mode-map nil)
390 (defvar ibuffer-mode-operate-map nil)
391 (defvar ibuffer-mode-groups-popup nil)
392 (unless ibuffer-mode-map
393 (let ((map (make-sparse-keymap))
394 (operate-map (make-sparse-keymap "Operate"))
395 (groups-map (make-sparse-keymap "Filter Groups")))
396 (define-key map (kbd "0") 'digit-argument)
397 (define-key map (kbd "1") 'digit-argument)
398 (define-key map (kbd "2") 'digit-argument)
399 (define-key map (kbd "3") 'digit-argument)
400 (define-key map (kbd "4") 'digit-argument)
401 (define-key map (kbd "5") 'digit-argument)
402 (define-key map (kbd "6") 'digit-argument)
403 (define-key map (kbd "7") 'digit-argument)
404 (define-key map (kbd "8") 'digit-argument)
405 (define-key map (kbd "9") 'digit-argument)
407 (define-key map (kbd "m") 'ibuffer-mark-forward)
408 (define-key map (kbd "t") 'ibuffer-toggle-marks)
409 (define-key map (kbd "u") 'ibuffer-unmark-forward)
410 (define-key map (kbd "=") 'ibuffer-diff-with-file)
411 (define-key map (kbd "j") 'ibuffer-jump-to-buffer)
412 (define-key map (kbd "M-g") 'ibuffer-jump-to-buffer)
413 (define-key map (kbd "DEL") 'ibuffer-unmark-backward)
414 (define-key map (kbd "M-DEL") 'ibuffer-unmark-all)
415 (define-key map (kbd "* *") 'ibuffer-unmark-all)
416 (define-key map (kbd "* M") 'ibuffer-mark-by-mode)
417 (define-key map (kbd "* m") 'ibuffer-mark-modified-buffers)
418 (define-key map (kbd "* u") 'ibuffer-mark-unsaved-buffers)
419 (define-key map (kbd "* s") 'ibuffer-mark-special-buffers)
420 (define-key map (kbd "* r") 'ibuffer-mark-read-only-buffers)
421 (define-key map (kbd "* /") 'ibuffer-mark-dired-buffers)
422 (define-key map (kbd "* e") 'ibuffer-mark-dissociated-buffers)
423 (define-key map (kbd "* h") 'ibuffer-mark-help-buffers)
424 (define-key map (kbd "* z") 'ibuffer-mark-compressed-file-buffers)
425 (define-key map (kbd ".") 'ibuffer-mark-old-buffers)
427 (define-key map (kbd "d") 'ibuffer-mark-for-delete)
428 (define-key map (kbd "C-d") 'ibuffer-mark-for-delete-backwards)
429 (define-key map (kbd "k") 'ibuffer-mark-for-delete)
430 (define-key map (kbd "x") 'ibuffer-do-kill-on-deletion-marks)
432 ;; immediate operations
433 (define-key map (kbd "n") 'ibuffer-forward-line)
434 (define-key map (kbd "<down>") 'ibuffer-forward-line)
435 (define-key map (kbd "SPC") 'forward-line)
436 (define-key map (kbd "p") 'ibuffer-backward-line)
437 (define-key map (kbd "<up>") 'ibuffer-backward-line)
438 (define-key map (kbd "M-}") 'ibuffer-forward-next-marked)
439 (define-key map (kbd "M-{") 'ibuffer-backwards-next-marked)
440 (define-key map (kbd "l") 'ibuffer-redisplay)
441 (define-key map (kbd "g") 'ibuffer-update)
442 (define-key map "`" 'ibuffer-switch-format)
443 (define-key map "-" 'ibuffer-add-to-tmp-hide)
444 (define-key map "+" 'ibuffer-add-to-tmp-show)
445 (define-key map "b" 'ibuffer-bury-buffer)
446 (define-key map (kbd ",") 'ibuffer-toggle-sorting-mode)
447 (define-key map (kbd "s i") 'ibuffer-invert-sorting)
448 (define-key map (kbd "s a") 'ibuffer-do-sort-by-alphabetic)
449 (define-key map (kbd "s v") 'ibuffer-do-sort-by-recency)
450 (define-key map (kbd "s s") 'ibuffer-do-sort-by-size)
451 (define-key map (kbd "s f") 'ibuffer-do-sort-by-filename/process)
452 (define-key map (kbd "s m") 'ibuffer-do-sort-by-major-mode)
454 (define-key map (kbd "/ m") 'ibuffer-filter-by-mode)
455 (define-key map (kbd "/ M") 'ibuffer-filter-by-used-mode)
456 (define-key map (kbd "/ n") 'ibuffer-filter-by-name)
457 (define-key map (kbd "/ c") 'ibuffer-filter-by-content)
458 (define-key map (kbd "/ e") 'ibuffer-filter-by-predicate)
459 (define-key map (kbd "/ f") 'ibuffer-filter-by-filename)
460 (define-key map (kbd "/ >") 'ibuffer-filter-by-size-gt)
461 (define-key map (kbd "/ <") 'ibuffer-filter-by-size-lt)
462 (define-key map (kbd "/ r") 'ibuffer-switch-to-saved-filters)
463 (define-key map (kbd "/ a") 'ibuffer-add-saved-filters)
464 (define-key map (kbd "/ x") 'ibuffer-delete-saved-filters)
465 (define-key map (kbd "/ d") 'ibuffer-decompose-filter)
466 (define-key map (kbd "/ s") 'ibuffer-save-filters)
467 (define-key map (kbd "/ p") 'ibuffer-pop-filter)
468 (define-key map (kbd "/ !") 'ibuffer-negate-filter)
469 (define-key map (kbd "/ t") 'ibuffer-exchange-filters)
470 (define-key map (kbd "/ TAB") 'ibuffer-exchange-filters)
471 (define-key map (kbd "/ o") 'ibuffer-or-filter)
472 (define-key map (kbd "/ g") 'ibuffer-filters-to-filter-group)
473 (define-key map (kbd "/ P") 'ibuffer-pop-filter-group)
474 (define-key map (kbd "/ D") 'ibuffer-decompose-filter-group)
475 (define-key map (kbd "/ /") 'ibuffer-filter-disable)
477 (define-key map (kbd "M-n") 'ibuffer-forward-filter-group)
478 (define-key map (kbd "<right>") 'ibuffer-forward-filter-group)
479 (define-key map (kbd "M-p") 'ibuffer-backward-filter-group)
480 (define-key map (kbd "<left>") 'ibuffer-backward-filter-group)
481 (define-key map (kbd "M-j") 'ibuffer-jump-to-filter-group)
482 (define-key map (kbd "C-k") 'ibuffer-kill-line)
483 (define-key map (kbd "C-y") 'ibuffer-yank)
484 (define-key map (kbd "/ S") 'ibuffer-save-filter-groups)
485 (define-key map (kbd "/ R") 'ibuffer-switch-to-saved-filter-groups)
486 (define-key map (kbd "/ X") 'ibuffer-delete-saved-filter-groups)
487 (define-key map (kbd "/ \\") 'ibuffer-clear-filter-groups)
489 (define-key map (kbd "q") 'ibuffer-quit)
490 (define-key map (kbd "h") 'describe-mode)
491 (define-key map (kbd "?") 'describe-mode)
493 (define-key map (kbd "% n") 'ibuffer-mark-by-name-regexp)
494 (define-key map (kbd "% m") 'ibuffer-mark-by-mode-regexp)
495 (define-key map (kbd "% f") 'ibuffer-mark-by-file-name-regexp)
497 (define-key map (kbd "C-t") 'ibuffer-visit-tags-table)
499 (define-key map (kbd "|") 'ibuffer-do-shell-command-pipe)
500 (define-key map (kbd "!") 'ibuffer-do-shell-command-file)
501 (define-key map (kbd "~") 'ibuffer-do-toggle-modified)
502 ;; marked operations
503 (define-key map (kbd "A") 'ibuffer-do-view)
504 (define-key map (kbd "D") 'ibuffer-do-delete)
505 (define-key map (kbd "E") 'ibuffer-do-eval)
506 (define-key map (kbd "F") 'ibuffer-do-shell-command-file)
507 (define-key map (kbd "I") 'ibuffer-do-query-replace-regexp)
508 (define-key map (kbd "H") 'ibuffer-do-view-other-frame)
509 (define-key map (kbd "N") 'ibuffer-do-shell-command-pipe-replace)
510 (define-key map (kbd "M") 'ibuffer-do-toggle-modified)
511 (define-key map (kbd "O") 'ibuffer-do-occur)
512 (define-key map (kbd "P") 'ibuffer-do-print)
513 (define-key map (kbd "Q") 'ibuffer-do-query-replace)
514 (define-key map (kbd "R") 'ibuffer-do-rename-uniquely)
515 (define-key map (kbd "S") 'ibuffer-do-save)
516 (define-key map (kbd "T") 'ibuffer-do-toggle-read-only)
517 (define-key map (kbd "U") 'ibuffer-do-replace-regexp)
518 (define-key map (kbd "V") 'ibuffer-do-revert)
519 (define-key map (kbd "W") 'ibuffer-do-view-and-eval)
520 (define-key map (kbd "X") 'ibuffer-do-shell-command-pipe)
522 (define-key map (kbd "k") 'ibuffer-do-kill-lines)
523 (define-key map (kbd "w") 'ibuffer-copy-filename-as-kill)
525 (define-key map (kbd "RET") 'ibuffer-visit-buffer)
526 (define-key map (kbd "e") 'ibuffer-visit-buffer)
527 (define-key map (kbd "f") 'ibuffer-visit-buffer)
528 (define-key map (kbd "C-x C-f") 'ibuffer-find-file)
529 (define-key map (kbd "o") 'ibuffer-visit-buffer-other-window)
530 (define-key map (kbd "C-o") 'ibuffer-visit-buffer-other-window-noselect)
531 (define-key map (kbd "M-o") 'ibuffer-visit-buffer-1-window)
532 (define-key map (kbd "v") 'ibuffer-do-view)
533 (define-key map (kbd "C-x v") 'ibuffer-do-view-horizontally)
534 (define-key map (kbd "C-c C-a") 'ibuffer-auto-mode)
535 (define-key map (kbd "C-x 4 RET") 'ibuffer-visit-buffer-other-window)
536 (define-key map (kbd "C-x 5 RET") 'ibuffer-visit-buffer-other-frame)
538 (define-key map [menu-bar view]
539 (cons "View" (make-sparse-keymap "View")))
541 (define-key-after map [menu-bar view visit-buffer]
542 '(menu-item "View this buffer" ibuffer-visit-buffer))
543 (define-key-after map [menu-bar view visit-buffer-other-window]
544 '(menu-item "View (other window)" ibuffer-visit-buffer-other-window))
545 (define-key-after map [menu-bar view visit-buffer-other-frame]
546 '(menu-item "View (other frame)" ibuffer-visit-buffer-other-frame))
547 (define-key-after map [menu-bar view ibuffer-update]
548 '(menu-item "Update" ibuffer-update
549 :help "Regenerate the list of buffers"))
550 (define-key-after map [menu-bar view switch-format]
551 '(menu-item "Switch display format" ibuffer-switch-format
552 :help "Toggle between available values of `ibuffer-formats'"))
554 (define-key-after map [menu-bar view dashes]
555 '("--"))
557 (define-key-after map [menu-bar view sort]
558 (cons "Sort" (make-sparse-keymap "Sort")))
560 (define-key-after map [menu-bar view sort do-sort-by-major-mode]
561 '(menu-item "Sort by major mode" ibuffer-do-sort-by-major-mode))
562 (define-key-after map [menu-bar view sort do-sort-by-size]
563 '(menu-item "Sort by buffer size" ibuffer-do-sort-by-size))
564 (define-key-after map [menu-bar view sort do-sort-by-alphabetic]
565 '(menu-item "Sort lexicographically" ibuffer-do-sort-by-alphabetic
566 :help "Sort by the alphabetic order of buffer name"))
567 (define-key-after map [menu-bar view sort do-sort-by-recency]
568 '(menu-item "Sort by view time" ibuffer-do-sort-by-recency
569 :help "Sort by the last time the buffer was displayed"))
570 (define-key-after map [menu-bar view sort dashes]
571 '("--"))
572 (define-key-after map [menu-bar view sort invert-sorting]
573 '(menu-item "Reverse sorting order" ibuffer-invert-sorting))
574 (define-key-after map [menu-bar view sort toggle-sorting-mode]
575 '(menu-item "Switch sorting mode" ibuffer-toggle-sorting-mode
576 :help "Switch between the various sorting criteria"))
578 (define-key-after map [menu-bar view filter]
579 (cons "Filter" (make-sparse-keymap "Filter")))
581 (define-key-after map [menu-bar view filter filter-disable]
582 '(menu-item "Disable all filtering" ibuffer-filter-disable
583 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
584 (define-key-after map [menu-bar view filter filter-by-mode]
585 '(menu-item "Add filter by major mode..." ibuffer-filter-by-mode))
586 (define-key-after map [menu-bar view filter filter-by-mode]
587 '(menu-item "Add filter by major mode in use..." ibuffer-filter-by-used-mode))
588 (define-key-after map [menu-bar view filter filter-by-name]
589 '(menu-item "Add filter by buffer name..." ibuffer-filter-by-name))
590 (define-key-after map [menu-bar view filter filter-by-filename]
591 '(menu-item "Add filter by filename..." ibuffer-filter-by-filename))
592 (define-key-after map [menu-bar view filter filter-by-size-lt]
593 '(menu-item "Add filter by size less than..." ibuffer-filter-by-size-lt))
594 (define-key-after map [menu-bar view filter filter-by-size-gt]
595 '(menu-item "Add filter by size greater than..." ibuffer-filter-by-size-gt))
596 (define-key-after map [menu-bar view filter filter-by-content]
597 '(menu-item "Add filter by content (regexp)..." ibuffer-filter-by-content))
598 (define-key-after map [menu-bar view filter filter-by-predicate]
599 '(menu-item "Add filter by Lisp predicate..." ibuffer-filter-by-predicate))
600 (define-key-after map [menu-bar view filter pop-filter]
601 '(menu-item "Remove top filter" ibuffer-pop-filter
602 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
603 (define-key-after map [menu-bar view filter or-filter]
604 '(menu-item "OR top two filters" ibuffer-or-filter
605 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
606 (cdr ibuffer-filtering-qualifiers))
607 :help "Create a new filter which is the logical OR of the top two filters"))
608 (define-key-after map [menu-bar view filter negate-filter]
609 '(menu-item "Negate top filter" ibuffer-negate-filter
610 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
611 (define-key-after map [menu-bar view filter decompose-filter]
612 '(menu-item "Decompose top filter" ibuffer-decompose-filter
613 :enable (and (featurep 'ibuf-ext) (memq (car ibuffer-filtering-qualifiers) '(or saved not)))
614 :help "Break down a complex filter like OR or NOT"))
615 (define-key-after map [menu-bar view filter exchange-filters]
616 '(menu-item "Swap top two filters" ibuffer-exchange-filters
617 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
618 (cdr ibuffer-filtering-qualifiers))))
619 (define-key-after map [menu-bar view filter save-filters]
620 '(menu-item "Save current filters permanently..." ibuffer-save-filters
621 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)
622 :help "Use a mnemnonic name to store current filter stack"))
623 (define-key-after map [menu-bar view filter switch-to-saved-filters]
624 '(menu-item "Restore permanently saved filters..." ibuffer-switch-to-saved-filters
625 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filters)
626 :help "Replace current filters with a saved stack"))
627 (define-key-after map [menu-bar view filter add-saved-filters]
628 '(menu-item "Add to permanently saved filters..." ibuffer-add-saved-filters
629 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)
630 :help "Include already saved stack with current filters"))
631 (define-key-after map [menu-bar view filter delete-saved-filters]
632 '(menu-item "Delete permanently saved filters..."
633 ibuffer-delete-saved-filters
634 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filters)))
636 ;; Filter groups
638 (define-key-after groups-map [filters-to-filter-group]
639 '(menu-item "Create filter group from current filters..."
640 ibuffer-filters-to-filter-group
641 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
642 (define-key-after groups-map [forward-filter-group]
643 '(menu-item "Move point to the next filter group"
644 ibuffer-forward-filter-group))
645 (define-key-after groups-map [backward-filter-group]
646 '(menu-item "Move point to the previous filter group"
647 ibuffer-backward-filter-group))
648 (define-key-after groups-map [jump-to-filter-group]
649 '(menu-item "Move point to a specific filter group..."
650 ibuffer-jump-to-filter-group))
651 (define-key-after groups-map [kill-filter-group]
652 '(menu-item "Kill filter group named..."
653 ibuffer-kill-filter-group
654 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
655 (define-key-after groups-map [yank-filter-group]
656 '(menu-item "Yank last killed filter group before..."
657 ibuffer-yank-filter-group
658 :enable (and (featurep 'ibuf-ext) ibuffer-filter-group-kill-ring)))
659 (define-key-after groups-map [pop-filter-group]
660 '(menu-item "Remove top filter group"
661 ibuffer-pop-filter-group
662 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
663 (define-key-after groups-map [clear-filter-groups]
664 '(menu-item "Remove all filter groups"
665 ibuffer-clear-filter-groups
666 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
667 (define-key-after groups-map [pop-filter-group]
668 '(menu-item "Decompose filter group..."
669 ibuffer-pop-filter-group
670 :help "\"Unmake\" a filter group"
671 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
672 (define-key-after groups-map [save-filter-groups]
673 '(menu-item "Save current filter groups permanently..."
674 ibuffer-save-filter-groups
675 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)
676 :help "Use a mnemnonic name to store current filter groups"))
677 (define-key-after groups-map [switch-to-saved-filter-groups]
678 '(menu-item "Restore permanently saved filters..."
679 ibuffer-switch-to-saved-filter-groups
680 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filter-groups)
681 :help "Replace current filters with a saved stack"))
682 (define-key-after groups-map [delete-saved-filter-groups]
683 '(menu-item "Delete permanently saved filter groups..."
684 ibuffer-delete-saved-filter-groups
685 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filter-groups)))
686 (define-key-after groups-map [set-filter-groups-by-mode]
687 '(menu-item "Set current filter groups to filter by mode"
688 ibuffer-set-filter-groups-by-mode))
690 (define-key-after map [menu-bar view filter-groups]
691 (cons "Filter Groups" groups-map))
693 (define-key-after map [menu-bar view dashes2]
694 '("--"))
695 (define-key-after map [menu-bar view diff-with-file]
696 '(menu-item "Diff with file" ibuffer-diff-with-file
697 :help "View the differences between this buffer and its file"))
698 (define-key-after map [menu-bar view auto-mode]
699 '(menu-item "Toggle Auto Mode" ibuffer-auto-mode
700 :help "Attempt to automatically update the Ibuffer buffer"))
701 (define-key-after map [menu-bar view customize]
702 '(menu-item "Customize Ibuffer" ibuffer-customize
703 :help "Use Custom to customize Ibuffer"))
705 (define-key-after map [menu-bar mark]
706 (cons "Mark" (make-sparse-keymap "Mark")))
708 (define-key-after map [menu-bar mark toggle-marks]
709 '(menu-item "Toggle marks" ibuffer-toggle-marks
710 :help "Unmark marked buffers, and mark unmarked buffers"))
711 (define-key-after map [menu-bar mark mark-forward]
712 '(menu-item "Mark" ibuffer-mark-forward
713 :help "Mark the buffer at point"))
714 (define-key-after map [menu-bar mark unmark-forward]
715 '(menu-item "Unmark" ibuffer-unmark-forward
716 :help "Unmark the buffer at point"))
717 (define-key-after map [menu-bar mark mark-by-mode]
718 '(menu-item "Mark by mode..." ibuffer-mark-by-mode
719 :help "Mark all buffers in a particular major mode"))
720 (define-key-after map [menu-bar mark mark-modified-buffers]
721 '(menu-item "Mark modified buffers" ibuffer-mark-modified-buffers
722 :help "Mark all buffers which have been modified"))
723 (define-key-after map [menu-bar mark mark-unsaved-buffers]
724 '(menu-item "Mark unsaved buffers" ibuffer-mark-unsaved-buffers
725 :help "Mark all buffers which have a file and are modified"))
726 (define-key-after map [menu-bar mark mark-read-only-buffers]
727 '(menu-item "Mark read-only buffers" ibuffer-mark-read-only-buffers
728 :help "Mark all buffers which are read-only"))
729 (define-key-after map [menu-bar mark mark-special-buffers]
730 '(menu-item "Mark special buffers" ibuffer-mark-special-buffers
731 :help "Mark all buffers whose name begins with a *"))
732 (define-key-after map [menu-bar mark mark-dired-buffers]
733 '(menu-item "Mark dired buffers" ibuffer-mark-dired-buffers
734 :help "Mark buffers in dired-mode"))
735 (define-key-after map [menu-bar mark mark-dissociated-buffers]
736 '(menu-item "Mark dissociated buffers" ibuffer-mark-dissociated-buffers
737 :help "Mark buffers with a non-existent associated file"))
738 (define-key-after map [menu-bar mark mark-help-buffers]
739 '(menu-item "Mark help buffers" ibuffer-mark-help-buffers
740 :help "Mark buffers in help-mode"))
741 (define-key-after map [menu-bar mark mark-compressed-file-buffers]
742 '(menu-item "Mark compressed file buffers" ibuffer-mark-compressed-file-buffers
743 :help "Mark buffers which have a file that is compressed"))
744 (define-key-after map [menu-bar mark mark-old-buffers]
745 '(menu-item "Mark old buffers" ibuffer-mark-old-buffers
746 :help "Mark buffers which have not been viewed recently"))
747 (define-key-after map [menu-bar mark unmark-all]
748 '(menu-item "Unmark All" ibuffer-unmark-all))
750 (define-key-after map [menu-bar mark dashes]
751 '("--"))
753 (define-key-after map [menu-bar mark mark-by-name-regexp]
754 '(menu-item "Mark by buffer name (regexp)..." ibuffer-mark-by-name-regexp
755 :help "Mark buffers whose name matches a regexp"))
756 (define-key-after map [menu-bar mark mark-by-mode-regexp]
757 '(menu-item "Mark by major mode (regexp)..." ibuffer-mark-by-mode-regexp
758 :help "Mark buffers whose major mode name matches a regexp"))
759 (define-key-after map [menu-bar mark mark-by-file-name-regexp]
760 '(menu-item "Mark by file name (regexp)..." ibuffer-mark-by-file-name-regexp
761 :help "Mark buffers whose file name matches a regexp"))
763 ;; Operate map is added later
765 (define-key-after operate-map [do-view]
766 '(menu-item "View" ibuffer-do-view))
767 (define-key-after operate-map [do-view-other-frame]
768 '(menu-item "View (separate frame)" ibuffer-do-view-other-frame))
769 (define-key-after operate-map [do-save]
770 '(menu-item "Save" ibuffer-do-save))
771 (define-key-after operate-map [do-replace-regexp]
772 '(menu-item "Replace (regexp)..." ibuffer-do-replace-regexp
773 :help "Replace text inside marked buffers"))
774 (define-key-after operate-map [do-query-replace]
775 '(menu-item "Query Replace..." ibuffer-do-query-replace
776 :help "Replace text in marked buffers, asking each time"))
777 (define-key-after operate-map [do-query-replace-regexp]
778 '(menu-item "Query Replace (regexp)..." ibuffer-do-query-replace-regexp
779 :help "Replace text in marked buffers by regexp, asking each time"))
780 (define-key-after operate-map [do-print]
781 '(menu-item "Print" ibuffer-do-print))
782 (define-key-after operate-map [do-toggle-modified]
783 '(menu-item "Toggle modification flag" ibuffer-do-toggle-modified))
784 (define-key-after operate-map [do-revert]
785 '(menu-item "Revert" ibuffer-do-revert
786 :help "Revert marked buffers to their associated file"))
787 (define-key-after operate-map [do-rename-uniquely]
788 '(menu-item "Rename Uniquely" ibuffer-do-rename-uniquely
789 :help "Rename marked buffers to a new, unique name"))
790 (define-key-after operate-map [do-delete]
791 '(menu-item "Kill" ibuffer-do-delete))
792 (define-key-after operate-map [do-occur]
793 '(menu-item "List lines matching..." ibuffer-do-occur
794 :help "View all lines in marked buffers matching a regexp"))
795 (define-key-after operate-map [do-shell-command-pipe]
796 '(menu-item "Pipe to shell command..." ibuffer-do-shell-command-pipe
797 :help "For each marked buffer, send its contents to a shell command"))
798 (define-key-after operate-map [do-shell-command-pipe-replace]
799 '(menu-item "Pipe to shell command (replace)..." ibuffer-do-shell-command-pipe-replace
800 :help "For each marked buffer, replace its contents with output of shell command"))
801 (define-key-after operate-map [do-shell-command-file]
802 '(menu-item "Shell command on buffer's file..." ibuffer-do-shell-command-file
803 :help "For each marked buffer, run a shell command with its file as argument"))
804 (define-key-after operate-map [do-eval]
805 '(menu-item "Eval..." ibuffer-do-eval
806 :help "Evaluate a Lisp form in each marked buffer"))
807 (define-key-after operate-map [do-view-and-eval]
808 '(menu-item "Eval (viewing buffer)..." ibuffer-do-view-and-eval
809 :help "Evaluate a Lisp form in each marked buffer while viewing it"))
811 (setq ibuffer-mode-map map
812 ibuffer-mode-operate-map operate-map
813 ibuffer-mode-groups-popup (copy-keymap groups-map))))
815 (define-key ibuffer-mode-groups-popup [kill-filter-group]
816 '(menu-item "Kill filter group"
817 ibuffer-kill-line
818 :enable (and (featurep 'ibuf-ext)
819 ibuffer-filter-groups)))
820 (define-key ibuffer-mode-groups-popup [yank-filter-group]
821 '(menu-item "Yank last killed filter group"
822 ibuffer-yank
823 :enable (and (featurep 'ibuf-ext)
824 ibuffer-filter-group-kill-ring)))
826 (defvar ibuffer-name-map
827 (let ((map (make-sparse-keymap)))
828 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
829 (define-key map [(mouse-2)] 'ibuffer-mouse-visit-buffer)
830 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
831 map))
833 (defvar ibuffer-filename/process-header-map
834 (let ((map (make-sparse-keymap)))
835 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-filename/process)
836 map))
838 (defvar ibuffer-mode-name-map
839 (let ((map (make-sparse-keymap)))
840 (define-key map [(mouse-2)] 'ibuffer-mouse-filter-by-mode)
841 (define-key map (kbd "RET") 'ibuffer-interactive-filter-by-mode)
842 map))
844 (defvar ibuffer-name-header-map
845 (let ((map (make-sparse-keymap)))
846 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-alphabetic)
847 map))
849 (defvar ibuffer-size-header-map
850 (let ((map (make-sparse-keymap)))
851 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-size)
852 map))
854 (defvar ibuffer-mode-header-map
855 (let ((map (make-sparse-keymap)))
856 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-major-mode)
857 map))
859 (defvar ibuffer-mode-filter-group-map
860 (let ((map (make-sparse-keymap)))
861 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
862 (define-key map [(mouse-2)] 'ibuffer-mouse-toggle-filter-group)
863 (define-key map (kbd "RET") 'ibuffer-toggle-filter-group)
864 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
865 map))
867 (defvar ibuffer-restore-window-config-on-quit nil
868 "If non-nil, restore previous window configuration upon exiting `ibuffer'.")
870 (defvar ibuffer-prev-window-config nil
871 "Window configuration before starting Ibuffer.")
873 (defvar ibuffer-did-modification nil)
875 (defvar ibuffer-compiled-formats nil)
876 (defvar ibuffer-cached-formats nil)
877 (defvar ibuffer-cached-eliding-string nil)
878 (defvar ibuffer-cached-elide-long-columns 0)
880 (defvar ibuffer-sorting-functions-alist nil
881 "An alist of functions which describe how to sort buffers.
883 Note: You most likely do not want to modify this variable directly;
884 use `define-ibuffer-sorter' instead.
886 The alist elements are constructed like (NAME DESCRIPTION FUNCTION)
887 Where NAME is a symbol describing the sorting method, DESCRIPTION is a
888 short string which will be displayed in the minibuffer and menu, and
889 FUNCTION is a function of two arguments, which will be the buffers to
890 compare.")
892 ;;; Utility functions
893 (defun ibuffer-columnize-and-insert-list (list &optional pad-width)
894 "Insert LIST into the current buffer in as many columns as possible.
895 The maximum number of columns is determined by the current window
896 width and the longest string in LIST."
897 (unless pad-width
898 (setq pad-width 3))
899 (let ((width (window-width))
900 (max (+ (apply #'max (mapcar #'length list))
901 pad-width)))
902 (let ((columns (/ width max)))
903 (when (zerop columns)
904 (setq columns 1))
905 (while list
906 (dotimes (i (1- columns))
907 (insert (concat (car list) (make-string (- max (length (car list)))
908 ?\s)))
909 (setq list (cdr list)))
910 (when (not (null list))
911 (insert (pop list)))
912 (insert "\n")))))
914 (defsubst ibuffer-current-mark ()
915 (cadr (get-text-property (line-beginning-position)
916 'ibuffer-properties)))
918 (defun ibuffer-mouse-toggle-mark (event)
919 "Toggle the marked status of the buffer chosen with the mouse."
920 (interactive "e")
921 (unwind-protect
922 (let ((pt (save-excursion
923 (mouse-set-point event)
924 (point))))
925 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
926 (ibuffer-toggle-marks it)
927 (goto-char pt)
928 (let ((mark (ibuffer-current-mark)))
929 (setq buffer-read-only nil)
930 (if (eq mark ibuffer-marked-char)
931 (ibuffer-set-mark ?\s)
932 (ibuffer-set-mark ibuffer-marked-char)))))
933 (setq buffer-read-only t)))
935 (defun ibuffer-find-file (file &optional wildcards)
936 "Like `find-file', but default to the directory of the buffer at point."
937 (interactive
938 (let ((default-directory (let ((buf (ibuffer-current-buffer)))
939 (if (buffer-live-p buf)
940 (with-current-buffer buf
941 default-directory)
942 default-directory))))
943 (list (read-file-name "Find file: " default-directory)
944 t)))
945 (find-file file wildcards))
947 (defun ibuffer-mouse-visit-buffer (event)
948 "Visit the buffer chosen with the mouse."
949 (interactive "e")
950 (switch-to-buffer
951 (save-excursion
952 (mouse-set-point event)
953 (ibuffer-current-buffer t))))
955 (defun ibuffer-mouse-popup-menu (event)
956 "Display a menu of operations."
957 (interactive "e")
958 (let ((eventpt (posn-point (event-end event)))
959 (origpt (point)))
960 (unwind-protect
961 (if (get-text-property eventpt 'ibuffer-filter-group-name)
962 (progn
963 (goto-char eventpt)
964 (popup-menu ibuffer-mode-groups-popup))
965 (let ((inhibit-read-only t))
966 (ibuffer-save-marks
967 ;; hm. we could probably do this in a better fashion
968 (ibuffer-unmark-all ?\r)
969 (save-excursion
970 (goto-char eventpt)
971 (ibuffer-set-mark ibuffer-marked-char))
972 (save-excursion
973 (popup-menu ibuffer-mode-operate-map)))))
974 (setq buffer-read-only t)
975 (if (= eventpt (point))
976 (goto-char origpt)))))
978 (defun ibuffer-skip-properties (props direction)
979 (while (and (not (eobp))
980 (let ((hit nil))
981 (dolist (prop props hit)
982 (when (get-text-property (point) prop)
983 (setq hit t)))))
984 (forward-line direction)
985 (beginning-of-line)))
987 (defun ibuffer-customize ()
988 "Begin customizing Ibuffer interactively."
989 (interactive)
990 (customize-group 'ibuffer))
992 (defun ibuffer-backward-line (&optional arg skip-group-names)
993 "Move backwards ARG lines, wrapping around the list if necessary."
994 (interactive "P")
995 (or arg (setq arg 1))
996 (beginning-of-line)
997 (while (> arg 0)
998 (forward-line -1)
999 (when (and ibuffer-movement-cycle
1000 (or (get-text-property (point) 'ibuffer-title)
1001 (and skip-group-names
1002 (get-text-property (point)
1003 'ibuffer-filter-group-name))))
1004 (goto-char (point-max))
1005 (beginning-of-line))
1006 (ibuffer-skip-properties (append '(ibuffer-summary)
1007 (when skip-group-names
1008 '(ibuffer-filter-group-name)))
1010 ;; Handle the special case of no buffers.
1011 (when (get-text-property (point) 'ibuffer-title)
1012 (forward-line 1)
1013 (setq arg 1))
1014 (decf arg)))
1016 (defun ibuffer-forward-line (&optional arg skip-group-names)
1017 "Move forward ARG lines, wrapping around the list if necessary."
1018 (interactive "P")
1019 (or arg (setq arg 1))
1020 (beginning-of-line)
1021 (when (and ibuffer-movement-cycle
1022 (or (eobp)
1023 (get-text-property (point) 'ibuffer-summary)))
1024 (goto-char (point-min)))
1025 (when (or (get-text-property (point) 'ibuffer-title)
1026 (and skip-group-names
1027 (get-text-property (point) 'ibuffer-filter-group-name)))
1028 (when (> arg 0)
1029 (decf arg))
1030 (ibuffer-skip-properties (append '(ibuffer-title)
1031 (when skip-group-names
1032 '(ibuffer-filter-group-name)))
1034 (if (< arg 0)
1035 (ibuffer-backward-line (- arg))
1036 (while (> arg 0)
1037 (forward-line 1)
1038 (when (and ibuffer-movement-cycle
1039 (or (eobp)
1040 (get-text-property (point) 'ibuffer-summary)))
1041 (goto-char (point-min)))
1042 (decf arg)
1043 (ibuffer-skip-properties (append '(ibuffer-title)
1044 (when skip-group-names
1045 '(ibuffer-filter-group-name)))
1046 1))))
1048 (defun ibuffer-visit-buffer (&optional single)
1049 "Visit the buffer on this line.
1050 If optional argument SINGLE is non-nil, then also ensure there is only
1051 one window."
1052 (interactive "P")
1053 (let ((buf (ibuffer-current-buffer t)))
1054 (bury-buffer (current-buffer))
1055 (switch-to-buffer buf)
1056 (when single
1057 (delete-other-windows))))
1059 (defun ibuffer-visit-buffer-other-window (&optional noselect)
1060 "Visit the buffer on this line in another window."
1061 (interactive)
1062 (let ((buf (ibuffer-current-buffer t)))
1063 (bury-buffer (current-buffer))
1064 (if noselect
1065 (let ((curwin (selected-window)))
1066 (pop-to-buffer buf)
1067 (select-window curwin))
1068 (switch-to-buffer-other-window buf))))
1070 (defun ibuffer-visit-buffer-other-window-noselect ()
1071 "Visit the buffer on this line in another window, but don't select it."
1072 (interactive)
1073 (ibuffer-visit-buffer-other-window t))
1075 (defun ibuffer-visit-buffer-other-frame ()
1076 "Visit the buffer on this line in another frame."
1077 (interactive)
1078 (let ((buf (ibuffer-current-buffer t)))
1079 (bury-buffer (current-buffer))
1080 (switch-to-buffer-other-frame buf)))
1082 (defun ibuffer-visit-buffer-1-window ()
1083 "Visit the buffer on this line, and delete other windows."
1084 (interactive)
1085 (ibuffer-visit-buffer t))
1087 (defun ibuffer-bury-buffer ()
1088 "Bury the buffer on this line."
1089 (interactive)
1090 (let ((buf (ibuffer-current-buffer t))
1091 (line (+ 1 (count-lines 1 (point)))))
1092 (bury-buffer buf)
1093 (ibuffer-update nil t)
1094 (goto-line line)))
1096 (defun ibuffer-visit-tags-table ()
1097 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
1098 (interactive)
1099 (let ((file (buffer-file-name (ibuffer-current-buffer t))))
1100 (if file
1101 (visit-tags-table file)
1102 (error "Specified buffer has no file"))))
1104 (defun ibuffer-do-view (&optional other-frame)
1105 "View marked buffers, or the buffer on the current line.
1106 If optional argument OTHER-FRAME is non-nil, then display each
1107 marked buffer in a new frame. Otherwise, display each buffer as
1108 a new window in the current frame, splitting vertically."
1109 (interactive)
1110 (ibuffer-do-view-1 (if other-frame 'other-frame 'vertically)))
1112 (defun ibuffer-do-view-horizontally (&optional other-frame)
1113 "As `ibuffer-do-view', but split windows horizontally."
1114 (interactive)
1115 (ibuffer-do-view-1 (if other-frame 'other-frame 'horizontally)))
1117 (defun ibuffer-do-view-1 (type)
1118 (let ((marked-bufs (ibuffer-get-marked-buffers)))
1119 (when (null marked-bufs)
1120 (setq marked-bufs (list (ibuffer-current-buffer t))))
1121 (unless (and (eq type 'other-frame)
1122 (not ibuffer-expert)
1123 (> (length marked-bufs) 3)
1124 (not (y-or-n-p (format "Really create a new frame for %s buffers? "
1125 (length marked-bufs)))))
1126 (set-buffer-modified-p nil)
1127 (delete-other-windows)
1128 (switch-to-buffer (pop marked-bufs))
1129 (let ((height (/ (1- (if (eq type 'horizontally) (frame-width)
1130 (frame-height)))
1131 (1+ (length marked-bufs)))))
1132 (mapcar (if (eq type 'other-frame)
1133 #'(lambda (buf)
1134 (let ((curframe (selected-frame)))
1135 (select-frame (make-frame))
1136 (switch-to-buffer buf)
1137 (select-frame curframe)))
1138 #'(lambda (buf)
1139 (split-window nil height (eq type 'horizontally))
1140 (other-window 1)
1141 (switch-to-buffer buf)))
1142 marked-bufs)))))
1144 (defun ibuffer-do-view-other-frame ()
1145 "View each of the marked buffers in a separate frame."
1146 (interactive)
1147 (ibuffer-do-view t))
1149 (defsubst ibuffer-map-marked-lines (func)
1150 (prog1 (ibuffer-map-on-mark ibuffer-marked-char func)
1151 (ibuffer-redisplay t)))
1153 (defun ibuffer-shrink-to-fit (&optional owin)
1154 (fit-window-to-buffer nil (when owin (/ (frame-height)
1155 (length (window-list (selected-frame)))))))
1157 (defun ibuffer-confirm-operation-on (operation names)
1158 "Display a buffer asking whether to perform OPERATION on NAMES."
1159 (or ibuffer-expert
1160 (if (= (length names) 1)
1161 (y-or-n-p (format "Really %s buffer %s? " operation (car names)))
1162 (let ((buf (get-buffer-create "*Ibuffer confirmation*")))
1163 (with-current-buffer buf
1164 (setq buffer-read-only nil)
1165 (erase-buffer)
1166 (ibuffer-columnize-and-insert-list names)
1167 (goto-char (point-min))
1168 (setq buffer-read-only t))
1169 (let ((lastwin (car (last (window-list nil 'nomini)))))
1170 ;; Now attempt to display the buffer...
1171 (save-window-excursion
1172 (select-window lastwin)
1173 ;; The window might be too small to split; in that case,
1174 ;; try a few times to increase its size before giving up.
1175 (let ((attempts 0)
1176 (trying t))
1177 (while trying
1178 (condition-case err
1179 (progn
1180 (split-window)
1181 (setq trying nil))
1182 (error
1183 ;; Handle a failure
1184 (if (or (> (incf attempts) 4)
1185 (and (stringp (cadr err))
1186 ;; This definitely falls in the
1187 ;; ghetto hack category...
1188 (not (string-match "too small" (cadr err)))))
1189 (apply #'signal err)
1190 (enlarge-window 3))))))
1191 (select-window (next-window))
1192 (switch-to-buffer buf)
1193 (unwind-protect
1194 (progn
1195 (fit-window-to-buffer)
1196 (y-or-n-p (format "Really %s %d buffers? "
1197 operation (length names))))
1198 (kill-buffer buf))))))))
1200 (defsubst ibuffer-map-lines-nomodify (function)
1201 "As `ibuffer-map-lines', but don't set the modification flag."
1202 (ibuffer-map-lines function t))
1204 (defun ibuffer-buffer-names-with-mark (mark)
1205 (let ((ibuffer-buffer-names-with-mark-result nil))
1206 (ibuffer-map-lines-nomodify
1207 #'(lambda (buf mk)
1208 (when (char-equal mark mk)
1209 (push (buffer-name buf)
1210 ibuffer-buffer-names-with-mark-result))))
1211 ibuffer-buffer-names-with-mark-result))
1213 (defsubst ibuffer-marked-buffer-names ()
1214 (ibuffer-buffer-names-with-mark ibuffer-marked-char))
1216 (defsubst ibuffer-deletion-marked-buffer-names ()
1217 (ibuffer-buffer-names-with-mark ibuffer-deletion-char))
1219 (defun ibuffer-count-marked-lines (&optional all)
1220 (if all
1221 (ibuffer-map-lines-nomodify
1222 #'(lambda (buf mark)
1223 (not (char-equal mark ?\s))))
1224 (ibuffer-map-lines-nomodify
1225 #'(lambda (buf mark)
1226 (char-equal mark ibuffer-marked-char)))))
1228 (defsubst ibuffer-count-deletion-lines ()
1229 (ibuffer-map-lines-nomodify
1230 #'(lambda (buf mark)
1231 (char-equal mark ibuffer-deletion-char))))
1233 (defsubst ibuffer-map-deletion-lines (func)
1234 (ibuffer-map-on-mark ibuffer-deletion-char func))
1236 (define-ibuffer-op ibuffer-do-save ()
1237 "Save marked buffers as with `save-buffer'."
1238 (:complex t
1239 :opstring "saved"
1240 :modifier-p :maybe)
1241 (when (buffer-modified-p buf)
1242 (if (not (with-current-buffer buf
1243 buffer-file-name))
1244 ;; handle the case where we're prompted
1245 ;; for a file name
1246 (save-window-excursion
1247 (switch-to-buffer buf)
1248 (save-buffer))
1249 (with-current-buffer buf
1250 (save-buffer))))
1253 (define-ibuffer-op ibuffer-do-toggle-modified ()
1254 "Toggle modification flag of marked buffers."
1255 (:opstring "(un)marked as modified"
1256 :modifier-p t)
1257 (set-buffer-modified-p (not (buffer-modified-p))))
1259 (define-ibuffer-op ibuffer-do-toggle-read-only ()
1260 "Toggle read only status in marked buffers."
1261 (:opstring "toggled read only status in"
1262 :modifier-p t)
1263 (toggle-read-only))
1265 (define-ibuffer-op ibuffer-do-delete ()
1266 "Kill marked buffers as with `kill-this-buffer'."
1267 (:opstring "killed"
1268 :active-opstring "kill"
1269 :dangerous t
1270 :complex t
1271 :modifier-p t)
1272 (if (kill-buffer buf)
1273 'kill
1274 nil))
1276 (define-ibuffer-op ibuffer-do-kill-on-deletion-marks ()
1277 "Kill buffers marked for deletion as with `kill-this-buffer'."
1278 (:opstring "killed"
1279 :active-opstring "kill"
1280 :dangerous t
1281 :complex t
1282 :mark :deletion
1283 :modifier-p t)
1284 (if (kill-buffer buf)
1285 'kill
1286 nil))
1288 (defun ibuffer-unmark-all (mark)
1289 "Unmark all buffers with mark MARK."
1290 (interactive "cRemove marks (RET means all):")
1291 (if (= (ibuffer-count-marked-lines t) 0)
1292 (message "No buffers marked; use 'm' to mark a buffer")
1293 (cond
1294 ((char-equal mark ibuffer-marked-char)
1295 (ibuffer-map-marked-lines
1296 #'(lambda (buf mark)
1297 (ibuffer-set-mark-1 ?\s)
1298 t)))
1299 ((char-equal mark ibuffer-deletion-char)
1300 (ibuffer-map-deletion-lines
1301 #'(lambda (buf mark)
1302 (ibuffer-set-mark-1 ?\s)
1303 t)))
1305 (ibuffer-map-lines
1306 #'(lambda (buf mark)
1307 (when (not (char-equal mark ?\s))
1308 (ibuffer-set-mark-1 ?\s))
1309 t)))))
1310 (ibuffer-redisplay t))
1312 (defun ibuffer-toggle-marks (&optional group)
1313 "Toggle which buffers are marked.
1314 In other words, unmarked buffers become marked, and marked buffers
1315 become unmarked.
1316 If point is on a group name, then this function operates on that
1317 group."
1318 (interactive)
1319 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
1320 (setq group it))
1321 (let ((count
1322 (ibuffer-map-lines
1323 #'(lambda (buf mark)
1324 (cond ((eq mark ibuffer-marked-char)
1325 (ibuffer-set-mark-1 ?\s)
1326 nil)
1327 ((eq mark ?\s)
1328 (ibuffer-set-mark-1 ibuffer-marked-char)
1331 nil)))
1332 nil group)))
1333 (message "%s buffers marked" count))
1334 (ibuffer-redisplay t))
1336 (defun ibuffer-mark-forward (arg)
1337 "Mark the buffer on this line, and move forward ARG lines.
1338 If point is on a group name, this function operates on that group."
1339 (interactive "P")
1340 (ibuffer-mark-interactive arg ibuffer-marked-char 1))
1342 (defun ibuffer-unmark-forward (arg)
1343 "Unmark the buffer on this line, and move forward ARG lines.
1344 If point is on a group name, this function operates on that group."
1345 (interactive "P")
1346 (ibuffer-mark-interactive arg ?\s 1))
1348 (defun ibuffer-unmark-backward (arg)
1349 "Unmark the buffer on this line, and move backward ARG lines.
1350 If point is on a group name, this function operates on that group."
1351 (interactive "P")
1352 (ibuffer-mark-interactive arg ?\s -1))
1354 (defun ibuffer-mark-interactive (arg mark movement)
1355 (assert (eq major-mode 'ibuffer-mode))
1356 (or arg (setq arg 1))
1357 (ibuffer-forward-line 0)
1358 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
1359 (progn
1360 (require 'ibuf-ext)
1361 (ibuffer-mark-on-buffer #'identity mark it))
1362 (ibuffer-forward-line 0 t)
1363 (let ((inhibit-read-only t))
1364 (while (> arg 0)
1365 (ibuffer-set-mark mark)
1366 (ibuffer-forward-line movement t)
1367 (setq arg (1- arg))))))
1369 (defun ibuffer-set-mark (mark)
1370 (assert (eq major-mode 'ibuffer-mode))
1371 (let ((inhibit-read-only t))
1372 (ibuffer-set-mark-1 mark)
1373 (setq ibuffer-did-modification t)
1374 (ibuffer-redisplay-current)
1375 (beginning-of-line)))
1377 (defun ibuffer-set-mark-1 (mark)
1378 (let ((beg (line-beginning-position))
1379 (end (line-end-position)))
1380 (put-text-property beg end 'ibuffer-properties
1381 (list (ibuffer-current-buffer)
1382 mark))))
1384 (defun ibuffer-mark-for-delete (arg)
1385 "Mark the buffers on ARG lines forward for deletion.
1386 If point is on a group name, this function operates on that group."
1387 (interactive "P")
1388 (ibuffer-mark-interactive arg ibuffer-deletion-char 1))
1390 (defun ibuffer-mark-for-delete-backwards (arg)
1391 "Mark the buffers on ARG lines backward for deletion.
1392 If point is on a group name, this function operates on that group."
1393 (interactive "P")
1394 (ibuffer-mark-interactive arg ibuffer-deletion-char -1))
1396 (defun ibuffer-current-buffer (&optional must-be-live)
1397 (let ((buf (car (get-text-property (line-beginning-position)
1398 'ibuffer-properties))))
1399 (when must-be-live
1400 (if (bufferp buf)
1401 (unless (buffer-live-p buf)
1402 (error "Buffer %s has been killed; %s" buf (substitute-command-keys "use `\\[ibuffer-update]' to update")))
1403 (error "No buffer on this line")))
1404 buf))
1406 (defun ibuffer-active-formats-name ()
1407 (if (boundp 'ibuffer-filter-format-alist)
1408 (let ((ret nil))
1409 (dolist (filter ibuffer-filtering-qualifiers ret)
1410 (let ((val (assq (car filter) ibuffer-filter-format-alist)))
1411 (when val
1412 (setq ret (car filter)))))
1413 (if ret
1415 :ibuffer-formats))
1416 :ibuffer-formats))
1418 (defun ibuffer-current-formats (uncompiledp)
1419 (let* ((name (ibuffer-active-formats-name)))
1420 (ibuffer-check-formats)
1421 (if (eq name :ibuffer-formats)
1422 (if uncompiledp
1423 ibuffer-formats
1424 ibuffer-compiled-formats)
1425 (cadr (assq name
1426 (if uncompiledp
1427 ibuffer-filter-format-alist
1428 ibuffer-compiled-filter-formats))))))
1430 (defun ibuffer-current-format (&optional uncompiledp)
1431 (or ibuffer-current-format
1432 (setq ibuffer-current-format 0))
1433 (nth ibuffer-current-format (ibuffer-current-formats uncompiledp)))
1435 (defun ibuffer-expand-format-entry (form)
1436 (if (or (consp form)
1437 (symbolp form))
1438 (let ((sym (intern (concat "ibuffer-make-column-"
1439 (symbol-name (if (consp form)
1440 (car form)
1441 form))))))
1442 (unless (or (fboundp sym)
1443 (assq sym ibuffer-inline-columns))
1444 (error "Unknown column %s in ibuffer-formats" form))
1445 (let (min max align elide)
1446 (if (consp form)
1447 (setq min (or (nth 1 form) 0)
1448 max (or (nth 2 form) -1)
1449 align (or (nth 3 form) :left)
1450 elide (or (nth 4 form) nil))
1451 (setq min 0
1452 max -1
1453 align :left
1454 elide nil))
1455 (list sym min max align elide)))
1456 form))
1458 (defun ibuffer-compile-make-eliding-form (strvar elide from-end-p)
1459 (let ((ellipsis (propertize ibuffer-eliding-string 'font-lock-face 'bold)))
1460 (if (or elide (with-no-warnings ibuffer-elide-long-columns))
1461 `(if (> strlen 5)
1462 ,(if from-end-p
1463 `(concat ,ellipsis
1464 (substring ,strvar
1465 (length ibuffer-eliding-string)))
1466 `(concat
1467 (substring ,strvar 0 (- strlen ,(length ellipsis)))
1468 ,ellipsis))
1469 ,strvar)
1470 strvar)))
1472 (defun ibuffer-compile-make-substring-form (strvar maxvar from-end-p)
1473 (if from-end-p
1474 `(substring str
1475 (- strlen ,maxvar))
1476 `(substring ,strvar 0 ,maxvar)))
1478 (defun ibuffer-compile-make-format-form (strvar widthform alignment)
1479 (let* ((left `(make-string tmp2 ?\s))
1480 (right `(make-string (- tmp1 tmp2) ?\s)))
1481 `(progn
1482 (setq tmp1 ,widthform
1483 tmp2 (/ tmp1 2))
1484 ,(case alignment
1485 (:right `(concat ,left ,right ,strvar))
1486 (:center `(concat ,left ,strvar ,right))
1487 (:left `(concat ,strvar ,left ,right))
1488 (t (error "Invalid alignment %s" alignment))))))
1490 (defun ibuffer-compile-format (format)
1491 (let ((result nil)
1492 ;; We use these variables to keep track of which variables
1493 ;; inside the generated function we need to bind, since
1494 ;; binding variables in Emacs takes time.
1495 str-used tmp1-used tmp2-used global-strlen-used)
1496 (dolist (form format)
1497 (push
1498 ;; Generate a form based on a particular format entry, like
1499 ;; " ", mark, or (mode 16 16 :right).
1500 (if (stringp form)
1501 ;; It's a string; all we need to do is insert it.
1502 `(insert ,form)
1503 (let* ((form (ibuffer-expand-format-entry form))
1504 (sym (nth 0 form))
1505 (min (nth 1 form))
1506 (max (nth 2 form))
1507 (align (nth 3 form))
1508 (elide (nth 4 form)))
1509 (let* ((from-end-p (when (minusp min)
1510 (setq min (- min))
1512 (letbindings nil)
1513 (outforms nil)
1514 minform
1515 maxform
1516 min-used max-used strlen-used)
1517 (when (or (not (integerp min)) (>= min 0))
1518 ;; This is a complex case; they want it limited to a
1519 ;; minimum size.
1520 (setq min-used t)
1521 (setq str-used t strlen-used t global-strlen-used t
1522 tmp1-used t tmp2-used t)
1523 ;; Generate code to limit the string to a minimum size.
1524 (setq minform `(progn
1525 (setq str
1526 ,(ibuffer-compile-make-format-form
1527 'str
1528 `(- ,(if (integerp min)
1530 'min)
1531 strlen)
1532 align)))))
1533 (when (or (not (integerp max)) (> max 0))
1534 (setq str-used t max-used t)
1535 ;; Generate code to limit the string to a maximum size.
1536 (setq maxform `(progn
1537 (setq str
1538 ,(ibuffer-compile-make-substring-form
1539 'str
1540 (if (integerp max)
1542 'max)
1543 from-end-p))
1544 (setq strlen (length str))
1545 (setq str
1546 ,(ibuffer-compile-make-eliding-form 'str
1547 elide
1548 from-end-p)))))
1549 ;; Now, put these forms together with the rest of the code.
1550 (let ((callform
1551 ;; Is this an "inline" column? This means we have
1552 ;; to get the code from the
1553 ;; `ibuffer-inline-columns' alist and insert it
1554 ;; into our generated code. Otherwise, we just
1555 ;; generate a call to the column function.
1556 (ibuffer-aif (assq sym ibuffer-inline-columns)
1557 (nth 1 it)
1558 `(,sym buffer mark)))
1559 ;; You're not expected to understand this. Hell, I
1560 ;; don't even understand it, and I wrote it five
1561 ;; minutes ago.
1562 (insertgenfn (ibuffer-aif (get sym 'ibuffer-column-summarizer)
1563 ;; I really, really wish Emacs Lisp had closures.
1564 (lambda (arg sym)
1565 `(insert
1566 (let ((ret ,arg))
1567 (put ',sym 'ibuffer-column-summary
1568 (cons ret (get ',sym 'ibuffer-column-summary)))
1569 ret)))
1570 (lambda (arg sym)
1571 `(insert ,arg))))
1572 (mincompform `(< strlen ,(if (integerp min)
1574 'min)))
1575 (maxcompform `(> strlen ,(if (integerp max)
1577 'max))))
1578 (if (or min-used max-used)
1579 ;; The complex case, where we have to limit the
1580 ;; form to a maximum or minimum size.
1581 (progn
1582 (when (and min-used (not (integerp min)))
1583 (push `(min ,min) letbindings))
1584 (when (and max-used (not (integerp max)))
1585 (push `(max ,max) letbindings))
1586 (push
1587 (if (and min-used max-used)
1588 `(if ,mincompform
1589 ,minform
1590 (if ,maxcompform
1591 ,maxform))
1592 (if min-used
1593 `(when ,mincompform
1594 ,minform)
1595 `(when ,maxcompform
1596 ,maxform)))
1597 outforms)
1598 (push (append
1599 `(setq str ,callform)
1600 (when strlen-used
1601 `(strlen (length str))))
1602 outforms)
1603 (setq outforms
1604 (append outforms (list (funcall insertgenfn 'str sym)))))
1605 ;; The simple case; just insert the string.
1606 (push (funcall insertgenfn callform sym) outforms))
1607 ;; Finally, return a `let' form which binds the
1608 ;; variables in `letbindings', and contains all the
1609 ;; code in `outforms'.
1610 `(let ,letbindings
1611 ,@outforms)))))
1612 result))
1613 (setq result
1614 ;; We don't want to unconditionally load the byte-compiler.
1615 (funcall (if (or ibuffer-always-compile-formats
1616 (featurep 'bytecomp))
1617 #'byte-compile
1618 #'identity)
1619 ;; Here, we actually create a lambda form which
1620 ;; inserts all the generated forms for each entry
1621 ;; in the format string.
1622 (nconc (list 'lambda '(buffer mark))
1623 `((let ,(append (when str-used
1624 '(str))
1625 (when global-strlen-used
1626 '(strlen))
1627 (when tmp1-used
1628 '(tmp1))
1629 (when tmp2-used
1630 '(tmp2)))
1631 ,@(nreverse result))))))))
1633 (defun ibuffer-recompile-formats ()
1634 "Recompile `ibuffer-formats'."
1635 (interactive)
1636 (setq ibuffer-compiled-formats
1637 (mapcar #'ibuffer-compile-format ibuffer-formats))
1638 (when (boundp 'ibuffer-filter-format-alist)
1639 (setq ibuffer-compiled-filter-formats
1640 (mapcar #'(lambda (entry)
1641 (cons (car entry)
1642 (mapcar #'(lambda (formats)
1643 (mapcar #'ibuffer-compile-format formats))
1644 (cdr entry))))
1645 ibuffer-filter-format-alist))))
1647 (defun ibuffer-clear-summary-columns (format)
1648 (dolist (form format)
1649 (ibuffer-awhen (and (consp form)
1650 (get (car form) 'ibuffer-column-summarizer))
1651 (put (car form) 'ibuffer-column-summary nil))))
1653 (defun ibuffer-check-formats ()
1654 (when (null ibuffer-formats)
1655 (error "No formats!"))
1656 (let ((ext-loaded (featurep 'ibuf-ext)))
1657 (when (or (null ibuffer-compiled-formats)
1658 (null ibuffer-cached-formats)
1659 (not (eq ibuffer-cached-formats ibuffer-formats))
1660 (null ibuffer-cached-eliding-string)
1661 (not (equal ibuffer-cached-eliding-string ibuffer-eliding-string))
1662 (eql 0 ibuffer-cached-elide-long-columns)
1663 (not (eql ibuffer-cached-elide-long-columns
1664 (with-no-warnings ibuffer-elide-long-columns)))
1665 (and ext-loaded
1666 (not (eq ibuffer-cached-filter-formats
1667 ibuffer-filter-format-alist))
1668 (and ibuffer-filter-format-alist
1669 (null ibuffer-compiled-filter-formats))))
1670 (message "Formats have changed, recompiling...")
1671 (ibuffer-recompile-formats)
1672 (setq ibuffer-cached-formats ibuffer-formats
1673 ibuffer-cached-eliding-string ibuffer-eliding-string
1674 ibuffer-cached-elide-long-columns (with-no-warnings ibuffer-elide-long-columns))
1675 (when ext-loaded
1676 (setq ibuffer-cached-filter-formats ibuffer-filter-format-alist))
1677 (message "Formats have changed, recompiling...done"))))
1679 (defvar ibuffer-inline-columns nil)
1681 (define-ibuffer-column mark (:name " " :inline t)
1682 (string mark))
1684 (define-ibuffer-column read-only (:name "R" :inline t)
1685 (if buffer-read-only
1686 (string ibuffer-read-only-char)
1687 " "))
1689 (define-ibuffer-column modified (:name "M" :inline t)
1690 (if (buffer-modified-p)
1691 (string ibuffer-modified-char)
1692 " "))
1694 (define-ibuffer-column name
1695 (:inline t
1696 :header-mouse-map ibuffer-name-header-map
1697 :props
1698 ('mouse-face 'highlight 'keymap ibuffer-name-map
1699 'ibuffer-name-column t
1700 'help-echo '(if tooltip-mode
1701 "mouse-1: mark this buffer\nmouse-2: select this buffer\nmouse-3: operate on this buffer"
1702 "mouse-1: mark buffer mouse-2: select buffer mouse-3: operate"))
1703 :summarizer
1704 (lambda (strings)
1705 (let ((bufs (length strings)))
1706 (cond ((zerop bufs) "No buffers")
1707 ((= 1 bufs) "1 buffer")
1708 (t (format "%s buffers" bufs))))))
1709 (propertize (buffer-name) 'font-lock-face (ibuffer-buffer-name-face buffer mark)))
1711 (define-ibuffer-column size
1712 (:inline t
1713 :header-mouse-map ibuffer-size-header-map
1714 :summarizer
1715 (lambda (column-strings)
1716 (let ((total 0))
1717 (dolist (string column-strings)
1718 (setq total
1719 ;; like, ewww ...
1720 (+ (float (string-to-number string))
1721 total)))
1722 (format "%.0f" total))))
1723 (format "%s" (buffer-size)))
1725 (define-ibuffer-column mode
1726 (:inline t
1727 :header-mouse-map ibuffer-mode-header-map
1728 :props
1729 ('mouse-face 'highlight
1730 'keymap ibuffer-mode-name-map
1731 'help-echo "mouse-2: filter by this mode"))
1732 (format-mode-line mode-name nil nil (current-buffer)))
1734 (define-ibuffer-column process
1735 (:summarizer
1736 (lambda (strings)
1737 (let ((total (length (delete "" strings))))
1738 (cond ((zerop total) "No processes")
1739 ((= 1 total) "1 process")
1740 (t (format "%d processes" total))))))
1741 (ibuffer-aif (get-buffer-process buffer)
1742 (format "(%s %s)" it (process-status it))
1743 ""))
1745 (define-ibuffer-column filename
1746 (:summarizer
1747 (lambda (strings)
1748 (let ((total (length (delete "" strings))))
1749 (cond ((zerop total) "No files")
1750 ((= 1 total) "1 file")
1751 (t (format "%d files" total))))))
1752 (let ((directory-abbrev-alist ibuffer-directory-abbrev-alist))
1753 (abbreviate-file-name
1754 (or buffer-file-name
1755 (and (boundp 'dired-directory)
1756 (if (stringp dired-directory)
1757 dired-directory
1758 (car dired-directory)))
1759 ""))))
1761 (define-ibuffer-column filename-and-process
1762 (:name "Filename/Process"
1763 :header-mouse-map ibuffer-filename/process-header-map
1764 :summarizer
1765 (lambda (strings)
1766 (setq strings (delete "" strings))
1767 (let ((procs 0)
1768 (files 0))
1769 (dolist (string strings)
1770 (if (string-match "\\(\?:\\`(\[\[:ascii:\]\]\+)\\)" string)
1771 (progn (setq procs (1+ procs))
1772 (if (< (match-end 0) (length string))
1773 (setq files (1+ files))))
1774 (setq files (1+ files))))
1775 (concat (cond ((zerop files) "No files")
1776 ((= 1 files) "1 file")
1777 (t (format "%d files" files)))
1778 ", "
1779 (cond ((zerop procs) "no processes")
1780 ((= 1 procs) "1 process")
1781 (t (format "%d processes" procs)))))))
1782 (let ((proc (get-buffer-process buffer))
1783 (filename (ibuffer-make-column-filename buffer mark)))
1784 (if proc
1785 (concat (propertize (format "(%s %s)" proc (process-status proc))
1786 'font-lock-face 'italic)
1787 (if (> (length filename) 0)
1788 (format " %s" filename)
1789 ""))
1790 filename)))
1792 (defun ibuffer-format-column (str width alignment)
1793 (let ((left (make-string (/ width 2) ?\s))
1794 (right (make-string (- width (/ width 2)) ?\s)))
1795 (case alignment
1796 (:right (concat left right str))
1797 (:center (concat left str right))
1798 (t (concat str left right)))))
1800 (defun ibuffer-buffer-name-face (buf mark)
1801 (cond ((char-equal mark ibuffer-marked-char)
1802 ibuffer-marked-face)
1803 ((char-equal mark ibuffer-deletion-char)
1804 ibuffer-deletion-face)
1806 (let ((level -1)
1807 result)
1808 (dolist (e ibuffer-fontification-alist result)
1809 (when (and (> (car e) level)
1810 (with-current-buffer buf
1811 (eval (nth 1 e))))
1812 (setq level (car e)
1813 result (nth 2 e))))))))
1815 (defun ibuffer-insert-buffer-line (buffer mark format)
1816 "Insert a line describing BUFFER and MARK using FORMAT."
1817 (assert (eq major-mode 'ibuffer-mode))
1818 (let ((beg (point)))
1819 (funcall format buffer mark)
1820 (put-text-property beg (point) 'ibuffer-properties (list buffer mark)))
1821 (insert "\n"))
1823 ;; This function knows a bit too much of the internals. It would be
1824 ;; nice if it was all abstracted away.
1825 (defun ibuffer-redisplay-current ()
1826 (assert (eq major-mode 'ibuffer-mode))
1827 (when (eobp)
1828 (forward-line -1))
1829 (beginning-of-line)
1830 (let ((curformat (mapcar #'ibuffer-expand-format-entry
1831 (ibuffer-current-format t))))
1832 (ibuffer-clear-summary-columns curformat)
1833 (let ((buf (ibuffer-current-buffer)))
1834 (when buf
1835 (let ((mark (ibuffer-current-mark)))
1836 (save-excursion
1837 (delete-region (point) (1+ (line-end-position)))
1838 (ibuffer-insert-buffer-line
1839 buf mark
1840 (ibuffer-current-format)))
1841 (when ibuffer-shrink-to-minimum-size
1842 (ibuffer-shrink-to-fit)))))))
1844 (defun ibuffer-map-on-mark (mark func)
1845 (ibuffer-map-lines
1846 #'(lambda (buf mk)
1847 (if (char-equal mark mk)
1848 (funcall func buf mark)
1849 nil))))
1851 (defun ibuffer-map-lines (function &optional nomodify group)
1852 "Call FUNCTION for each buffer.
1853 Set the ibuffer modification flag unless NOMODIFY is non-nil.
1855 If optional argument GROUP is non-nil, then only call FUNCTION on
1856 buffers in filtering group GROUP.
1858 FUNCTION is called with two arguments:
1859 the buffer object itself and the current mark symbol."
1860 (assert (eq major-mode 'ibuffer-mode))
1861 (ibuffer-forward-line 0)
1862 (let* ((orig-target-line (1+ (count-lines (save-excursion
1863 (goto-char (point-min))
1864 (ibuffer-forward-line 0)
1865 (point))
1866 (point))))
1867 (target-line-offset orig-target-line)
1868 (ibuffer-map-lines-total 0)
1869 (ibuffer-map-lines-count 0))
1870 (unwind-protect
1871 (progn
1872 (setq buffer-read-only nil)
1873 (goto-char (point-min))
1874 (ibuffer-forward-line 0 t)
1875 (while (and (not (eobp))
1876 (not (get-text-property (point) 'ibuffer-summary))
1877 (progn
1878 (ibuffer-forward-line 0 t)
1879 (and (not (eobp))
1880 (not (get-text-property (point) 'ibuffer-summary)))))
1881 (let ((result
1882 (if (buffer-live-p (ibuffer-current-buffer))
1883 (when (or (null group)
1884 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group)
1885 (equal group it)))
1886 (save-excursion
1887 (funcall function
1888 (ibuffer-current-buffer)
1889 (ibuffer-current-mark))))
1890 ;; Kill the line if the buffer is dead
1891 'kill)))
1892 ;; A given mapping function should return:
1893 ;; `nil' if it chose not to affect the buffer
1894 ;; `kill' means the remove line from the buffer list
1895 ;; `t' otherwise
1896 (incf ibuffer-map-lines-total)
1897 (cond ((null result)
1898 (forward-line 1))
1899 ((eq result 'kill)
1900 (delete-region (line-beginning-position)
1901 (1+ (line-end-position)))
1902 (incf ibuffer-map-lines-count)
1903 (when (< ibuffer-map-lines-total
1904 orig-target-line)
1905 (decf target-line-offset)))
1907 (incf ibuffer-map-lines-count)
1908 (forward-line 1)))))
1909 ibuffer-map-lines-count)
1910 (progn
1911 (setq buffer-read-only t)
1912 (unless nomodify
1913 (set-buffer-modified-p nil))
1914 (goto-char (point-min))
1915 (ibuffer-forward-line 0)
1916 (ibuffer-forward-line (1- target-line-offset))))))
1918 (defun ibuffer-get-marked-buffers ()
1919 "Return a list of buffer objects currently marked."
1920 (delq nil
1921 (mapcar #'(lambda (e)
1922 (when (eq (cdr e) ibuffer-marked-char)
1923 (car e)))
1924 (ibuffer-current-state-list))))
1926 (defun ibuffer-current-state-list (&optional pos)
1927 "Return a list like (BUF . MARK) of all buffers in an ibuffer.
1928 If POS is non-nil, return a list like (BUF MARK POINT), where POINT is
1929 the value of point at the beginning of the line for that buffer."
1930 (let ((ibuffer-current-state-list-tmp '()))
1931 ;; ah, if only we had closures. I bet this will mysteriously
1932 ;; break later. Don't blame me.
1933 (if pos
1934 (ibuffer-map-lines-nomodify
1935 #'(lambda (buf mark)
1936 (when (buffer-live-p buf)
1937 (push (list buf mark (point)) ibuffer-current-state-list-tmp))))
1938 (ibuffer-map-lines-nomodify
1939 #'(lambda (buf mark)
1940 (when (buffer-live-p buf)
1941 (push (cons buf mark) ibuffer-current-state-list-tmp)))))
1942 (nreverse ibuffer-current-state-list-tmp)))
1944 (defun ibuffer-current-buffers-with-marks (curbufs)
1945 "Return a list like (BUF . MARK) of all open buffers."
1946 (let ((bufs (ibuffer-current-state-list)))
1947 (mapcar #'(lambda (buf) (let ((e (assq buf bufs)))
1948 (if e
1950 (cons buf ?\s))))
1951 curbufs)))
1953 (defun ibuffer-buf-matches-predicates (buf predicates)
1954 (let ((hit nil)
1955 (name (buffer-name buf)))
1956 (dolist (pred predicates)
1957 (when (if (stringp pred)
1958 (string-match pred name)
1959 (funcall pred buf))
1960 (setq hit t)))
1961 hit))
1963 (defun ibuffer-filter-buffers (ibuffer-buf last bmarklist all)
1964 (let ((ext-loaded (featurep 'ibuf-ext)))
1965 (delq nil
1966 (mapcar
1967 ;; element should be like (BUFFER . MARK)
1968 #'(lambda (e)
1969 (let* ((buf (car e)))
1970 (when
1971 ;; This takes precedence over anything else
1972 (or (and ibuffer-always-show-last-buffer
1973 (eq last buf))
1974 (funcall (if ext-loaded
1975 #'ibuffer-ext-visible-p
1976 #'ibuffer-visible-p)
1977 buf all ibuffer-buf))
1978 e)))
1979 bmarklist))))
1981 (defun ibuffer-visible-p (buf all &optional ibuffer-buf)
1982 (and (or all
1983 (not
1984 (ibuffer-buf-matches-predicates buf ibuffer-maybe-show-predicates)))
1985 (or ibuffer-view-ibuffer
1986 (and ibuffer-buf
1987 (not (eq ibuffer-buf buf))))))
1989 ;; This function is a special case; it's not defined by
1990 ;; `define-ibuffer-sorter'.
1991 (defun ibuffer-do-sort-by-recency ()
1992 "Sort the buffers by last view time."
1993 (interactive)
1994 (setq ibuffer-sorting-mode 'recency)
1995 (ibuffer-update nil t))
1997 (defun ibuffer-update-format ()
1998 (when (null ibuffer-current-format)
1999 (setq ibuffer-current-format 0))
2000 (when (null ibuffer-formats)
2001 (error "Ibuffer error: no formats!")))
2003 (defun ibuffer-switch-format ()
2004 "Switch the current display format."
2005 (interactive)
2006 (assert (eq major-mode 'ibuffer-mode))
2007 (unless (consp ibuffer-formats)
2008 (error "Ibuffer error: No formats!"))
2009 (setq ibuffer-current-format
2010 (if (>= ibuffer-current-format (1- (length (ibuffer-current-formats nil))))
2012 (1+ ibuffer-current-format)))
2013 (ibuffer-update-format)
2014 (ibuffer-redisplay t))
2016 (defun ibuffer-update-title-and-summary (format)
2017 (assert (eq major-mode 'ibuffer-mode))
2018 ;; Don't do funky font-lock stuff here
2019 (let ((after-change-functions nil))
2020 (if (get-text-property (point-min) 'ibuffer-title)
2021 (delete-region (point-min)
2022 (next-single-property-change
2023 (point-min) 'ibuffer-title)))
2024 (goto-char (point-min))
2025 (add-text-properties
2026 (point)
2027 (progn
2028 (let ((opos (point)))
2029 ;; Insert the title names.
2030 (dolist (element format)
2031 (insert
2032 (if (stringp element)
2033 element
2034 (let ((sym (car element))
2035 (min (cadr element))
2036 ;; (max (caddr element))
2037 (align (cadddr element)))
2038 ;; Ignore a negative min when we're inserting the title
2039 (when (minusp min)
2040 (setq min (- min)))
2041 (let* ((name (or (get sym 'ibuffer-column-name)
2042 (error "Unknown column %s in ibuffer-formats" sym)))
2043 (len (length name))
2044 (hmap (get sym 'header-mouse-map))
2045 (strname (if (< len min)
2046 (ibuffer-format-column name
2047 (- min len)
2048 align)
2049 name)))
2050 (when hmap
2051 (setq
2052 strname
2053 (propertize strname 'mouse-face 'highlight 'keymap hmap)))
2054 strname)))))
2055 (add-text-properties opos (point) `(ibuffer-title-header t))
2056 (insert "\n")
2057 ;; Add the underlines
2058 (let ((str (save-excursion
2059 (forward-line -1)
2060 (beginning-of-line)
2061 (buffer-substring (point) (line-end-position)))))
2062 (apply #'insert (mapcar
2063 #'(lambda (c)
2064 (if (not (or (char-equal c ?\s)
2065 (char-equal c ?\n)))
2067 ?\s))
2068 str)))
2069 (insert "\n"))
2070 (point))
2071 `(ibuffer-title t font-lock-face ,ibuffer-title-face))
2072 ;; Now, insert the summary columns.
2073 (goto-char (point-max))
2074 (if (get-text-property (1- (point-max)) 'ibuffer-summary)
2075 (delete-region (previous-single-property-change
2076 (point-max) 'ibuffer-summary)
2077 (point-max)))
2078 (if ibuffer-display-summary
2079 (add-text-properties
2080 (point)
2081 (progn
2082 (insert "\n")
2083 (dolist (element format)
2084 (insert
2085 (if (stringp element)
2086 (make-string (length element) ?\s)
2087 (let ((sym (car element)))
2088 (let ((min (cadr element))
2089 ;; (max (caddr element))
2090 (align (cadddr element)))
2091 ;; Ignore a negative min when we're inserting the title
2092 (when (minusp min)
2093 (setq min (- min)))
2094 (let* ((summary (if (get sym 'ibuffer-column-summarizer)
2095 (funcall (get sym 'ibuffer-column-summarizer)
2096 (get sym 'ibuffer-column-summary))
2097 (make-string (length (get sym 'ibuffer-column-name))
2098 ?\s)))
2099 (len (length summary)))
2100 (if (< len min)
2101 (ibuffer-format-column summary
2102 (- min len)
2103 align)
2104 summary)))))))
2105 (point))
2106 `(ibuffer-summary t)))))
2109 (defun ibuffer-redisplay (&optional silent)
2110 "Redisplay the current list of buffers.
2111 This does not show new buffers; use `ibuffer-update' for that.
2113 If optional arg SILENT is non-nil, do not display progress messages."
2114 (interactive)
2115 (ibuffer-forward-line 0)
2116 (unless silent
2117 (message "Redisplaying current buffer list..."))
2118 (let ((blist (ibuffer-current-state-list)))
2119 (when (null blist)
2120 (if (and (featurep 'ibuf-ext)
2121 (or ibuffer-filtering-qualifiers ibuffer-hidden-filter-groups))
2122 (message "No buffers! (note: filtering in effect)")
2123 (error "No buffers!")))
2124 (ibuffer-redisplay-engine blist t)
2125 (unless silent
2126 (message "Redisplaying current buffer list...done"))
2127 (ibuffer-forward-line 0)))
2129 (defun ibuffer-update (arg &optional silent)
2130 "Regenerate the list of all buffers.
2132 Prefix arg non-nil means to toggle whether buffers that match
2133 `ibuffer-maybe-show-predicates' should be displayed.
2135 If optional arg SILENT is non-nil, do not display progress messages."
2136 (interactive "P")
2137 (if arg
2138 (setq ibuffer-display-maybe-show-predicates
2139 (not ibuffer-display-maybe-show-predicates)))
2140 (ibuffer-forward-line 0)
2141 (let* ((bufs (buffer-list))
2142 (blist (ibuffer-filter-buffers
2143 (current-buffer)
2144 (if (and
2145 (cadr bufs)
2146 (eq ibuffer-always-show-last-buffer
2147 :nomini)
2148 (minibufferp (cadr bufs)))
2149 (caddr bufs)
2150 (cadr bufs))
2151 (ibuffer-current-buffers-with-marks bufs)
2152 ibuffer-display-maybe-show-predicates)))
2153 (when (null blist)
2154 (if (and (featurep 'ibuf-ext)
2155 ibuffer-filtering-qualifiers)
2156 (message "No buffers! (note: filtering in effect)")
2157 (error "No buffers!")))
2158 (unless silent
2159 (message "Updating buffer list..."))
2160 (ibuffer-redisplay-engine blist arg)
2161 (unless silent
2162 (message "Updating buffer list...done")))
2163 (if (eq ibuffer-shrink-to-minimum-size 'onewindow)
2164 (ibuffer-shrink-to-fit t)
2165 (when ibuffer-shrink-to-minimum-size
2166 (ibuffer-shrink-to-fit)))
2167 (ibuffer-forward-line 0))
2169 (defun ibuffer-sort-bufferlist (bmarklist)
2170 (let* ((sortdat (assq ibuffer-sorting-mode
2171 ibuffer-sorting-functions-alist))
2172 (func (caddr sortdat)))
2173 (let ((result
2174 ;; actually sort the buffers
2175 (if (and sortdat func)
2176 (sort bmarklist func)
2177 bmarklist)))
2178 ;; perhaps reverse the sorted buffer list
2179 (if ibuffer-sorting-reversep
2180 (nreverse result)
2181 result))))
2183 (defun ibuffer-insert-filter-group (name display-name filter-string format bmarklist)
2184 (add-text-properties
2185 (point)
2186 (progn
2187 (insert "[ " display-name " ]")
2188 (point))
2189 `(ibuffer-filter-group-name
2190 ,name
2191 font-lock-face ,ibuffer-filter-group-name-face
2192 keymap ,ibuffer-mode-filter-group-map
2193 mouse-face highlight
2194 help-echo ,(let ((echo '(if tooltip-mode
2195 "mouse-1: toggle marks in this group\nmouse-2: hide/show this filtering group"
2196 "mouse-1: toggle marks mouse-2: hide/show")))
2197 (if (> (length filter-string) 0)
2198 `(concat ,filter-string
2199 (if tooltip-mode "\n" " ")
2200 ,echo)
2201 echo))))
2202 (insert "\n")
2203 (when bmarklist
2204 (put-text-property
2205 (point)
2206 (progn
2207 (dolist (entry bmarklist)
2208 (ibuffer-insert-buffer-line (car entry) (cdr entry) format))
2209 (point))
2210 'ibuffer-filter-group
2211 name)))
2213 (defun ibuffer-redisplay-engine (bmarklist &optional ignore)
2214 (assert (eq major-mode 'ibuffer-mode))
2215 (let* ((--ibuffer-insert-buffers-and-marks-format
2216 (ibuffer-current-format))
2217 (--ibuffer-expanded-format (mapcar #'ibuffer-expand-format-entry
2218 (ibuffer-current-format t)))
2219 (orig (count-lines (point-min) (point)))
2220 ;; Inhibit font-lock caching tricks, since we're modifying the
2221 ;; entire buffer at once
2222 (after-change-functions nil)
2223 (ext-loaded (featurep 'ibuf-ext))
2224 (bgroups (if ext-loaded
2225 (ibuffer-generate-filter-groups bmarklist)
2226 (list (cons "Default" bmarklist)))))
2227 (ibuffer-clear-summary-columns --ibuffer-expanded-format)
2228 (unwind-protect
2229 (progn
2230 (setq buffer-read-only nil)
2231 (erase-buffer)
2232 (ibuffer-update-format)
2233 (dolist (group (nreverse bgroups))
2234 (let* ((name (car group))
2235 (disabled (and ext-loaded
2236 (member name ibuffer-hidden-filter-groups)))
2237 (bmarklist (cdr group)))
2238 (unless (and (null bmarklist)
2239 (not disabled)
2240 ext-loaded
2241 (null ibuffer-show-empty-filter-groups))
2242 (ibuffer-insert-filter-group
2243 name
2244 (if disabled (concat name " ...") name)
2245 (if ext-loaded
2246 (ibuffer-format-filter-group-data name)
2248 --ibuffer-insert-buffers-and-marks-format
2249 (if disabled
2251 (ibuffer-sort-bufferlist bmarklist))))))
2252 (ibuffer-update-title-and-summary --ibuffer-expanded-format))
2253 (setq buffer-read-only t)
2254 (set-buffer-modified-p ibuffer-did-modification)
2255 (setq ibuffer-did-modification nil)
2256 (goto-line (1+ orig)))))
2258 (defun ibuffer-quit ()
2259 "Quit this `ibuffer' session.
2260 Try to restore the previous window configuration if
2261 `ibuffer-restore-window-config-on-quit' is non-nil."
2262 (interactive)
2263 (if ibuffer-restore-window-config-on-quit
2264 (progn
2265 (bury-buffer)
2266 (unless (= (count-windows) 1)
2267 (set-window-configuration ibuffer-prev-window-config)))
2268 (bury-buffer)))
2270 ;;;###autoload
2271 (defun ibuffer-list-buffers (&optional files-only)
2272 "Display a list of buffers, in another window.
2273 If optional argument FILES-ONLY is non-nil, then add a filter for
2274 buffers which are visiting a file."
2275 (interactive "P")
2276 (ibuffer t nil (when files-only
2277 '((filename . ".*"))) t))
2279 ;;;###autoload
2280 (defun ibuffer-other-window (&optional files-only)
2281 "Like `ibuffer', but displayed in another window by default.
2282 If optional argument FILES-ONLY is non-nil, then add a filter for
2283 buffers which are visiting a file."
2284 (interactive "P")
2285 (ibuffer t nil (when files-only
2286 '((filename . ".*")))))
2288 ;;;###autoload
2289 (defun ibuffer (&optional other-window-p name qualifiers noselect
2290 shrink filter-groups formats)
2291 "Begin using Ibuffer to edit a list of buffers.
2292 Type 'h' after entering ibuffer for more information.
2294 All arguments are optional.
2295 OTHER-WINDOW-P says to use another window.
2296 NAME specifies the name of the buffer (defaults to \"*Ibuffer*\").
2297 QUALIFIERS is an initial set of filtering qualifiers to use;
2298 see `ibuffer-filtering-qualifiers'.
2299 NOSELECT means don't select the Ibuffer buffer.
2300 SHRINK means shrink the buffer to minimal size. The special
2301 value `onewindow' means always use another window.
2302 FILTER-GROUPS is an initial set of filtering groups to use;
2303 see `ibuffer-filter-groups'.
2304 FORMATS is the value to use for `ibuffer-formats'.
2305 If specified, then the variable `ibuffer-formats' will have
2306 that value locally in this buffer."
2307 (interactive "P")
2308 (when ibuffer-use-other-window
2309 (setq other-window-p t))
2310 (setq ibuffer-prev-window-config (current-window-configuration))
2311 (let ((buf (get-buffer-create (or name "*Ibuffer*"))))
2312 (if other-window-p
2313 (funcall (if noselect #'(lambda (buf) (display-buffer buf t)) #'pop-to-buffer) buf)
2314 (funcall (if noselect #'display-buffer #'switch-to-buffer) buf))
2315 (with-current-buffer buf
2316 (save-selected-window
2317 ;; We switch to the buffer's window in order to be able
2318 ;; to modify the value of point
2319 (select-window (get-buffer-window buf 0))
2320 (or (eq major-mode 'ibuffer-mode)
2321 (ibuffer-mode))
2322 (setq ibuffer-restore-window-config-on-quit other-window-p)
2323 (when shrink
2324 (setq ibuffer-shrink-to-minimum-size shrink))
2325 (when qualifiers
2326 (require 'ibuf-ext)
2327 (setq ibuffer-filtering-qualifiers qualifiers))
2328 (when filter-groups
2329 (require 'ibuf-ext)
2330 (setq ibuffer-filter-groups filter-groups))
2331 (when formats
2332 (set (make-local-variable 'ibuffer-formats) formats))
2333 (ibuffer-update nil)
2334 ;; Skip the group name by default.
2335 (ibuffer-forward-line 0 t)
2336 (unwind-protect
2337 (progn
2338 (setq buffer-read-only nil)
2339 (run-hooks 'ibuffer-hook))
2340 (setq buffer-read-only t))
2341 (unless ibuffer-expert
2342 (message "Commands: m, u, t, RET, g, k, S, D, Q; q to quit; h for help"))))))
2344 (put 'ibuffer-mode 'mode-class 'special)
2345 (defun ibuffer-mode ()
2346 "A major mode for viewing a list of buffers.
2347 In Ibuffer, you can conveniently perform many operations on the
2348 currently open buffers, in addition to filtering your view to a
2349 particular subset of them, and sorting by various criteria.
2351 Operations on marked buffers:
2353 '\\[ibuffer-do-save]' - Save the marked buffers
2354 '\\[ibuffer-do-view]' - View the marked buffers in this frame.
2355 '\\[ibuffer-do-view-other-frame]' - View the marked buffers in another frame.
2356 '\\[ibuffer-do-revert]' - Revert the marked buffers.
2357 '\\[ibuffer-do-toggle-read-only]' - Toggle read-only state of marked buffers.
2358 '\\[ibuffer-do-delete]' - Kill the marked buffers.
2359 '\\[ibuffer-do-replace-regexp]' - Replace by regexp in each of the marked
2360 buffers.
2361 '\\[ibuffer-do-query-replace]' - Query replace in each of the marked buffers.
2362 '\\[ibuffer-do-query-replace-regexp]' - As above, with a regular expression.
2363 '\\[ibuffer-do-print]' - Print the marked buffers.
2364 '\\[ibuffer-do-occur]' - List lines in all marked buffers which match
2365 a given regexp (like the function `occur').
2366 '\\[ibuffer-do-shell-command-pipe]' - Pipe the contents of the marked
2367 buffers to a shell command.
2368 '\\[ibuffer-do-shell-command-pipe-replace]' - Replace the contents of the marked
2369 buffers with the output of a shell command.
2370 '\\[ibuffer-do-shell-command-file]' - Run a shell command with the
2371 buffer's file as an argument.
2372 '\\[ibuffer-do-eval]' - Evaluate a form in each of the marked buffers. This
2373 is a very flexible command. For example, if you want to make all
2374 of the marked buffers read only, try using (toggle-read-only 1) as
2375 the input form.
2376 '\\[ibuffer-do-view-and-eval]' - As above, but view each buffer while the form
2377 is evaluated.
2378 '\\[ibuffer-do-kill-lines]' - Remove the marked lines from the *Ibuffer* buffer,
2379 but don't kill the associated buffer.
2380 '\\[ibuffer-do-kill-on-deletion-marks]' - Kill all buffers marked for deletion.
2382 Marking commands:
2384 '\\[ibuffer-mark-forward]' - Mark the buffer at point.
2385 '\\[ibuffer-toggle-marks]' - Unmark all currently marked buffers, and mark
2386 all unmarked buffers.
2387 '\\[ibuffer-unmark-forward]' - Unmark the buffer at point.
2388 '\\[ibuffer-unmark-backward]' - Unmark the buffer at point, and move to the
2389 previous line.
2390 '\\[ibuffer-unmark-all]' - Unmark all marked buffers.
2391 '\\[ibuffer-mark-by-mode]' - Mark buffers by major mode.
2392 '\\[ibuffer-mark-unsaved-buffers]' - Mark all \"unsaved\" buffers.
2393 This means that the buffer is modified, and has an associated file.
2394 '\\[ibuffer-mark-modified-buffers]' - Mark all modified buffers,
2395 regardless of whether or not they have an associated file.
2396 '\\[ibuffer-mark-special-buffers]' - Mark all buffers whose name begins and
2397 ends with '*'.
2398 '\\[ibuffer-mark-dissociated-buffers]' - Mark all buffers which have
2399 an associated file, but that file doesn't currently exist.
2400 '\\[ibuffer-mark-read-only-buffers]' - Mark all read-only buffers.
2401 '\\[ibuffer-mark-dired-buffers]' - Mark buffers in `dired' mode.
2402 '\\[ibuffer-mark-help-buffers]' - Mark buffers in `help-mode', `apropos-mode', etc.
2403 '\\[ibuffer-mark-old-buffers]' - Mark buffers older than `ibuffer-old-time'.
2404 '\\[ibuffer-mark-for-delete]' - Mark the buffer at point for deletion.
2405 '\\[ibuffer-mark-by-name-regexp]' - Mark buffers by their name, using a regexp.
2406 '\\[ibuffer-mark-by-mode-regexp]' - Mark buffers by their major mode, using a regexp.
2407 '\\[ibuffer-mark-by-file-name-regexp]' - Mark buffers by their filename, using a regexp.
2409 Filtering commands:
2411 '\\[ibuffer-filter-by-mode]' - Add a filter by major mode.
2412 '\\[ibuffer-filter-by-used-mode]' - Add a filter by major mode now in use.
2413 '\\[ibuffer-filter-by-name]' - Add a filter by buffer name.
2414 '\\[ibuffer-filter-by-content]' - Add a filter by buffer content.
2415 '\\[ibuffer-filter-by-filename]' - Add a filter by filename.
2416 '\\[ibuffer-filter-by-size-gt]' - Add a filter by buffer size.
2417 '\\[ibuffer-filter-by-size-lt]' - Add a filter by buffer size.
2418 '\\[ibuffer-filter-by-predicate]' - Add a filter by an arbitrary Lisp predicate.
2419 '\\[ibuffer-save-filters]' - Save the current filters with a name.
2420 '\\[ibuffer-switch-to-saved-filters]' - Switch to previously saved filters.
2421 '\\[ibuffer-add-saved-filters]' - Add saved filters to current filters.
2422 '\\[ibuffer-or-filter]' - Replace the top two filters with their logical OR.
2423 '\\[ibuffer-pop-filter]' - Remove the top filter.
2424 '\\[ibuffer-negate-filter]' - Invert the logical sense of the top filter.
2425 '\\[ibuffer-decompose-filter]' - Break down the topmost filter.
2426 '\\[ibuffer-filter-disable]' - Remove all filtering currently in effect.
2428 Filter group commands:
2430 '\\[ibuffer-filters-to-filter-group]' - Create filter group from filters.
2431 '\\[ibuffer-pop-filter-group]' - Remove top filter group.
2432 '\\[ibuffer-forward-filter-group]' - Move to the next filter group.
2433 '\\[ibuffer-backward-filter-group]' - Move to the previous filter group.
2434 '\\[ibuffer-clear-filter-groups]' - Remove all active filter groups.
2435 '\\[ibuffer-save-filter-groups]' - Save the current groups with a name.
2436 '\\[ibuffer-switch-to-saved-filter-groups]' - Restore previously saved groups.
2437 '\\[ibuffer-delete-saved-filter-groups]' - Delete previously saved groups.
2439 Sorting commands:
2441 '\\[ibuffer-toggle-sorting-mode]' - Rotate between the various sorting modes.
2442 '\\[ibuffer-invert-sorting]' - Reverse the current sorting order.
2443 '\\[ibuffer-do-sort-by-alphabetic]' - Sort the buffers lexicographically.
2444 '\\[ibuffer-do-sort-by-filename/process]' - Sort the buffers by the file name.
2445 '\\[ibuffer-do-sort-by-recency]' - Sort the buffers by last viewing time.
2446 '\\[ibuffer-do-sort-by-size]' - Sort the buffers by size.
2447 '\\[ibuffer-do-sort-by-major-mode]' - Sort the buffers by major mode.
2449 Other commands:
2451 '\\[ibuffer-update]' - Regenerate the list of all buffers.
2452 Prefix arg means to toggle whether buffers that match
2453 `ibuffer-maybe-show-predicates' should be displayed.
2455 '\\[ibuffer-switch-format]' - Change the current display format.
2456 '\\[forward-line]' - Move point to the next line.
2457 '\\[previous-line]' - Move point to the previous line.
2458 '\\[ibuffer-quit]' - Bury the Ibuffer buffer.
2459 '\\[describe-mode]' - This help.
2460 '\\[ibuffer-diff-with-file]' - View the differences between this buffer
2461 and its associated file.
2462 '\\[ibuffer-visit-buffer]' - View the buffer on this line.
2463 '\\[ibuffer-visit-buffer-other-window]' - As above, but in another window.
2464 '\\[ibuffer-visit-buffer-other-window-noselect]' - As both above, but don't select
2465 the new window.
2466 '\\[ibuffer-bury-buffer]' - Bury (not kill!) the buffer on this line.
2468 ** Information on Filtering:
2470 You can filter your ibuffer view via different critera. Each Ibuffer
2471 buffer has its own stack of active filters. For example, suppose you
2472 are working on an Emacs Lisp project. You can create an Ibuffer
2473 buffer displays buffers in just `emacs-lisp' modes via
2474 '\\[ibuffer-filter-by-mode] emacs-lisp-mode RET'. In this case, there
2475 is just one entry on the filtering stack.
2477 You can also combine filters. The various filtering commands push a
2478 new filter onto the stack, and the filters combine to show just
2479 buffers which satisfy ALL criteria on the stack. For example, suppose
2480 you only want to see buffers in `emacs-lisp' mode, whose names begin
2481 with \"gnus\". You can accomplish this via:
2482 '\\[ibuffer-filter-by-mode] emacs-lisp-mode RET
2483 \\[ibuffer-filter-by-name] ^gnus RET'.
2485 Additionally, you can OR the top two filters together with
2486 '\\[ibuffer-or-filters]'. To see all buffers in either
2487 `emacs-lisp-mode' or `lisp-interaction-mode', type:
2489 '\\[ibuffer-filter-by-mode] emacs-lisp-mode RET \\[ibuffer-filter-by-mode] lisp-interaction-mode RET \\[ibuffer-or-filters]'.
2491 Filters can also be saved and restored using mnemonic names: see the
2492 functions `ibuffer-save-filters' and `ibuffer-switch-to-saved-filters'.
2494 To remove the top filter on the stack, use '\\[ibuffer-pop-filter]', and
2495 to disable all filtering currently in effect, use
2496 '\\[ibuffer-filter-disable]'.
2498 ** Filter Groups:
2500 Once one has mastered filters, the next logical step up is \"filter
2501 groups\". A filter group is basically a named group of buffers which
2502 match a filter, which are displayed together in an Ibuffer buffer. To
2503 create a filter group, simply use the regular functions to create a
2504 filter, and then type '\\[ibuffer-filters-to-filter-group]'.
2506 A quick example will make things clearer. Suppose that one wants to
2507 group all of one's Emacs Lisp buffers together. To do this, type
2509 '\\[ibuffer-filter-by-mode] emacs-lisp-mode RET \\[ibuffer-filters-to-filter-group] RET emacs lisp buffers RET'
2511 You may, of course, name the group whatever you want; it doesn't have
2512 to be \"emacs lisp buffers\". Filter groups may be composed of any
2513 arbitrary combination of filters.
2515 Just like filters themselves, filter groups act as a stack. Buffers
2516 will not be displayed multiple times if they would be included in
2517 multiple filter groups; instead, the first filter group is used. The
2518 filter groups are displayed in this order of precedence.
2520 You may rearrange filter groups by using the regular
2521 '\\[ibuffer-kill-line]' and '\\[ibuffer-yank]' pair. Yanked groups
2522 will be inserted before the group at point."
2523 (kill-all-local-variables)
2524 (use-local-map ibuffer-mode-map)
2525 (setq major-mode 'ibuffer-mode)
2526 (setq mode-name "Ibuffer")
2527 ;; Include state info next to the mode name.
2528 (set (make-local-variable 'mode-line-process)
2529 '(" by "
2530 (ibuffer-sorting-mode (:eval (symbol-name ibuffer-sorting-mode))
2531 "view time")
2532 (ibuffer-sorting-reversep " [rev]")
2533 (ibuffer-auto-mode " (Auto)")
2534 ;; Only list the filters if they're not already in the header-line.
2535 (header-line-format
2537 (:eval (if (functionp 'ibuffer-format-qualifier)
2538 (mapconcat 'ibuffer-format-qualifier
2539 ibuffer-filtering-qualifiers ""))))))
2540 (setq header-line-format
2541 (if ibuffer-use-header-line
2542 ;; Display the part that won't be in the mode-line.
2543 (list* "" mode-name
2544 (mapcar (lambda (elem)
2545 (if (eq (car-safe elem) 'header-line-format)
2546 (nth 2 elem) elem))
2547 mode-line-process))))
2549 (setq buffer-read-only t)
2550 (buffer-disable-undo)
2551 (setq truncate-lines ibuffer-truncate-lines)
2552 ;; This makes things less ugly for Emacs 21 users with a non-nil
2553 ;; `show-trailing-whitespace'.
2554 (setq show-trailing-whitespace nil)
2555 ;; disable `show-paren-mode' buffer-locally
2556 (if (bound-and-true-p show-paren-mode)
2557 (set (make-local-variable 'show-paren-mode) nil))
2558 (set (make-local-variable 'revert-buffer-function)
2559 #'ibuffer-update)
2560 (set (make-local-variable 'ibuffer-sorting-mode)
2561 ibuffer-default-sorting-mode)
2562 (set (make-local-variable 'ibuffer-sorting-reversep)
2563 ibuffer-default-sorting-reversep)
2564 (set (make-local-variable 'ibuffer-shrink-to-minimum-size)
2565 ibuffer-default-shrink-to-minimum-size)
2566 (set (make-local-variable 'ibuffer-display-maybe-show-predicates)
2567 ibuffer-default-display-maybe-show-predicates)
2568 (set (make-local-variable 'ibuffer-filtering-qualifiers) nil)
2569 (set (make-local-variable 'ibuffer-filter-groups) nil)
2570 (set (make-local-variable 'ibuffer-filter-group-kill-ring) nil)
2571 (set (make-local-variable 'ibuffer-hidden-filter-groups) nil)
2572 (set (make-local-variable 'ibuffer-compiled-formats) nil)
2573 (set (make-local-variable 'ibuffer-cached-formats) nil)
2574 (set (make-local-variable 'ibuffer-cached-eliding-string) nil)
2575 (set (make-local-variable 'ibuffer-cached-elide-long-columns) nil)
2576 (set (make-local-variable 'ibuffer-current-format) nil)
2577 (set (make-local-variable 'ibuffer-restore-window-config-on-quit) nil)
2578 (set (make-local-variable 'ibuffer-did-modification) nil)
2579 (set (make-local-variable 'ibuffer-tmp-hide-regexps) nil)
2580 (set (make-local-variable 'ibuffer-tmp-show-regexps) nil)
2581 (define-key ibuffer-mode-map [menu-bar edit] 'undefined)
2582 (define-key ibuffer-mode-map [menu-bar operate] (cons "Operate" ibuffer-mode-operate-map))
2583 (ibuffer-update-format)
2584 (when ibuffer-default-directory
2585 (setq default-directory ibuffer-default-directory))
2586 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
2587 (run-mode-hooks 'ibuffer-mode-hook))
2589 (provide 'ibuffer)
2591 (run-hooks 'ibuffer-load-hook)
2593 ;; Local Variables:
2594 ;; coding: iso-8859-1
2595 ;; End:
2597 ;; arch-tag: 72581688-0603-4954-b8cf-837c700f62e8
2598 ;;; ibuffer.el ends here