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