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