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