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