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