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