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