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