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