| blob | 78dab1c93e54320050ec3e5e542f218e14539fd3 |
1 ;;; ibuffer.el --- operate on buffers like dired -*- lexical-binding:t -*-
3 ;; Copyright (C) 2000-2018 Free Software Foundation, Inc.
5 ;; Author: Colin Walters <walters@verbum.org>
6 ;; Maintainer: John Paul Wallington <jpw@gnu.org>
7 ;; Created: 8 Sep 2000
8 ;; Keywords: buffer, convenience
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; ibuffer.el is an advanced replacement for the `buffer-menu' which
28 ;; is normally distributed with Emacs. Its interface is intended to
29 ;; be analogous to that of Dired.
31 ;;; Code:
42 ;; These come from ibuf-ext.el, which can not be require'd at compile time
43 ;; because it has a recursive dependency on ibuffer.el
67 "Advanced replacement for `buffer-menu'.
68 Ibuffer lets you operate on buffers in a Dired-like way,
69 with the ability to sort, mark by regular expression,
70 and filter displayed buffers by various criteria."
79 "A list of ways to display buffer lines.
81 With Ibuffer, you are not limited to displaying just certain
82 attributes of a buffer such as size, name, and mode in a particular
83 order. Through this variable, you can completely customize and
84 control the appearance of an Ibuffer buffer. See also
85 `define-ibuffer-column', which allows you to define your own columns
86 for display.
88 This variable has the form
89 ((COLUMN COLUMN ...) (COLUMN COLUMN ...) ...)
90 Each element in `ibuffer-formats' should be a list containing COLUMN
91 specifiers. A COLUMN can be any of the following:
93 SYMBOL - A symbol naming the column. Predefined columns are:
94 mark modified read-only locked name size mode process filename
95 When you define your own columns using `define-ibuffer-column', just
96 use their name like the predefined columns here. This entry can
97 also be a function of two arguments, which should return a string.
98 The first argument is the buffer object, and the second is the mark
99 on that buffer.
100 or
102 or
103 (SYMBOL MIN-SIZE MAX-SIZE &optional ALIGN ELIDE) - SYMBOL is a
104 symbol naming the column, and MIN-SIZE and MAX-SIZE are integers (or
105 functions of no arguments returning an integer) which constrict the
106 size of a column. If MAX-SIZE is -1, there is no upper bound. The
107 default values are 0 and -1, respectively. If MIN-SIZE is negative,
108 use the end of the string. The optional element ALIGN describes the
109 alignment of the column; it can be :left, :center or :right. The
110 optional element ELIDE describes whether or not to elide the column
111 if it is too long; valid values are :elide and nil. The default is
112 nil (don't elide).
114 Some example of valid entries in `ibuffer-formats', with
115 description (also, feel free to try them out, and experiment with your
116 own!):
119 This format just displays the current mark (if any) and the name of
120 the buffer, separated by a space.
122 This format displays the current mark (if any), its modification and
123 read-only status, as well as the name of the buffer and its size. In
124 this format, the name is restricted to 16 characters (longer names
125 will be truncated, and shorter names will be padded with spaces), and
126 the name is also aligned to the left. The size of the buffer will
127 be padded with spaces up to a minimum of six characters, but there is
128 no upper limit on its size. The size will also be aligned to the
129 right.
131 Thus, if you wanted to use these two formats, the appropriate
132 value for this variable would be
135 (mark modified read-only
136 (name 16 16 :left)
137 (size 6 -1 :right)))
140 the specified formats in the list."
146 "If non-nil, then use the byte-compiler to optimize `ibuffer-formats'.
147 This will increase the redisplay speed, at the cost of loading the
148 elisp byte-compiler."
156 buffer-file-name))
157 font-lock-doc-face)
161 italic)
165 "An alist describing how to fontify buffers.
166 Each element should be of the form (PRIORITY FORM FACE), where
167 PRIORITY is an integer, FORM is an arbitrary form to evaluate in the
168 buffer, and FACE is the face to use for fontification. If the FORM
169 evaluates to non-nil, then FACE will be put on the buffer name. The
170 element with the highest PRIORITY takes precedence.
172 If you change this variable, you must kill the Ibuffer buffer and
173 recreate it for the change to take effect."
177 face))
181 "If non-nil, display Ibuffer in another window by default."
186 "If non-nil, minimize the size of the Ibuffer window by default."
192 "If non-nil, summarize Ibuffer columns."
197 "If non-nil, do not display continuation lines."
202 "If non-nil, ignore case when searching."
207 "The criteria by which to sort the buffers.
209 Note that this variable is local to each Ibuffer buffer. Thus, you
210 can have multiple Ibuffer buffers open, each with a different sorted
211 view of the buffers."
222 "If non-nil, reverse the default sorting order."
228 "The string to use for eliding long columns."
235 "A list of predicates for buffers to display conditionally.
237 A predicate can be a regexp or a function.
238 If a regexp, then it will be matched against the buffer's name.
239 If a function, it will be called with the buffer as an argument, and
240 should return non-nil if this buffer should be shown.
242 Viewing of buffers hidden because of these predicates may be customized
243 via `ibuffer-default-display-maybe-show-predicates' and is toggled by
244 giving a non-nil prefix argument to `ibuffer-update'.
245 Note that this specialized filtering occurs before real filtering."
250 "Non-nil means show buffers that match `ibuffer-maybe-show-predicates'."
259 "If non-nil, then forward and backwards movement commands cycle."
264 "The character to display for modified buffers."
269 "The character to display for read-only buffers."
274 "The character to display for marked buffers."
279 "The character to display for locked buffers."
285 "The character to display for buffers marked for deletion."
295 "If non-nil, display the current Ibuffer buffer itself.
296 Note that this has a drawback - the data about the current Ibuffer
297 buffer will most likely be inaccurate. This includes modification
298 state, size, etc."
303 "If non-nil, always display the previous buffer.
304 This variable takes precedence over filtering, and even
305 `ibuffer-never-show-predicates'."
312 "If non-nil, only offer buffers visible in the Ibuffer buffer
313 in completion lists of the `ibuffer-jump-to-buffer' command."
318 "If non-nil, display a header line containing current filters."
323 "The default directory to use for a new Ibuffer buffer.
324 If nil, inherit the directory of the buffer in which `ibuffer' was
325 called. Otherwise, this variable should be a string naming a
326 directory, like `default-directory'."
328 string)
339 "Regexp to match compressed file names."
345 "Hook run when `ibuffer' is called."
350 "Hook run upon entry into `ibuffer-mode'."
356 "Hook run when Ibuffer is loaded."
361 "Face used for displaying marked buffers."
366 "Face used for displaying buffers marked for deletion."
371 "Face used for the title string."
376 "Face used for displaying filtering group names."
381 "An alist of file name abbreviations like `directory-abbrev-alist'."
390 ;; Filter groups
394 ibuffer-filters-to-filter-group
398 ibuffer-forward-filter-group))
401 ibuffer-backward-filter-group))
404 ibuffer-jump-to-filter-group))
407 ibuffer-kill-filter-group
411 ibuffer-yank-filter-group
415 ibuffer-pop-filter-group
419 ibuffer-clear-filter-groups
423 ibuffer-pop-filter-group
428 ibuffer-save-filter-groups
433 ibuffer-switch-to-saved-filter-groups
438 ibuffer-delete-saved-filter-groups
442 ibuffer-set-filter-groups-by-mode))
444 groups-map))
489 ;; immediate operations
548 (define-key map (kbd "M-j") 'ibuffer-jump-to-filter-group)
549 (define-key map (kbd "C-k") 'ibuffer-kill-line)
550 (define-key map (kbd "C-y") 'ibuffer-yank)
551 (define-key map (kbd "/ S") 'ibuffer-save-filter-groups)
552 (define-key map (kbd "/ R") 'ibuffer-switch-to-saved-filter-groups)
553 (define-key map (kbd "/ X") 'ibuffer-delete-saved-filter-groups)
556 (define-key map (kbd "% n") 'ibuffer-mark-by-name-regexp)
557 (define-key map (kbd "% m") 'ibuffer-mark-by-mode-regexp)
558 (define-key map (kbd "% f") 'ibuffer-mark-by-file-name-regexp)
559 (define-key map (kbd "% g") 'ibuffer-mark-by-content-regexp)
560 (define-key map (kbd "% L") 'ibuffer-mark-by-locked)
562 (define-key map (kbd "C-t") 'ibuffer-visit-tags-table)
564 (define-key map (kbd "|") 'ibuffer-do-shell-command-pipe)
565 (define-key map (kbd "!") 'ibuffer-do-shell-command-file)
566 (define-key map (kbd "~") 'ibuffer-do-toggle-modified)
567 ;; marked operations
568 (define-key map (kbd "A") 'ibuffer-do-view)
569 (define-key map (kbd "D") 'ibuffer-do-delete)
570 (define-key map (kbd "E") 'ibuffer-do-eval)
571 (define-key map (kbd "F") 'ibuffer-do-shell-command-file)
572 (define-key map (kbd "I") 'ibuffer-do-query-replace-regexp)
573 (define-key map (kbd "H") 'ibuffer-do-view-other-frame)
574 (define-key map (kbd "N") 'ibuffer-do-shell-command-pipe-replace)
575 (define-key map (kbd "M") 'ibuffer-do-toggle-modified)
576 (define-key map (kbd "O") 'ibuffer-do-occur)
577 (define-key map (kbd "P") 'ibuffer-do-print)
578 (define-key map (kbd "Q") 'ibuffer-do-query-replace)
579 (define-key map (kbd "R") 'ibuffer-do-rename-uniquely)
580 (define-key map (kbd "S") 'ibuffer-do-save)
581 (define-key map (kbd "T") 'ibuffer-do-toggle-read-only)
582 (define-key map (kbd "L") 'ibuffer-do-toggle-lock)
583 (define-key map (kbd "r") 'ibuffer-do-replace-regexp)
584 (define-key map (kbd "V") 'ibuffer-do-revert)
585 (define-key map (kbd "W") 'ibuffer-do-view-and-eval)
586 (define-key map (kbd "X") 'ibuffer-do-shell-command-pipe)
588 (define-key map (kbd "k") 'ibuffer-do-kill-lines)
589 (define-key map (kbd "w") 'ibuffer-copy-filename-as-kill)
590 (define-key map (kbd "B") 'ibuffer-copy-buffername-as-kill)
592 (define-key map (kbd "RET") 'ibuffer-visit-buffer)
593 (define-key map (kbd "e") 'ibuffer-visit-buffer)
594 (define-key map (kbd "f") 'ibuffer-visit-buffer)
595 (define-key map (kbd "C-x C-f") 'ibuffer-find-file)
596 (define-key map (kbd "o") 'ibuffer-visit-buffer-other-window)
597 (define-key map (kbd "C-o") 'ibuffer-visit-buffer-other-window-noselect)
598 (define-key map (kbd "M-o") 'ibuffer-visit-buffer-1-window)
599 (define-key map (kbd "v") 'ibuffer-do-view)
600 (define-key map (kbd "C-x v") 'ibuffer-do-view-horizontally)
601 (define-key map (kbd "C-c C-a") 'ibuffer-auto-mode)
602 (define-key map (kbd "C-x 4 RET") 'ibuffer-visit-buffer-other-window)
603 (define-key map (kbd "C-x 5 RET") 'ibuffer-visit-buffer-other-frame)
605 (define-key map [menu-bar view]
606 (cons "View" (make-sparse-keymap "View")))
608 (define-key-after map [menu-bar view visit-buffer]
609 '(menu-item "View this buffer" ibuffer-visit-buffer))
610 (define-key-after map [menu-bar view visit-buffer-other-window]
611 '(menu-item "View (other window)" ibuffer-visit-buffer-other-window))
612 (define-key-after map [menu-bar view visit-buffer-other-frame]
613 '(menu-item "View (other frame)" ibuffer-visit-buffer-other-frame))
614 (define-key-after map [menu-bar view ibuffer-update]
615 '(menu-item "Update" ibuffer-update
616 :help "Regenerate the list of buffers"))
617 (define-key-after map [menu-bar view switch-format]
618 '(menu-item "Switch display format" ibuffer-switch-format
619 :help "Toggle between available values of `ibuffer-formats'"))
621 (define-key-after map [menu-bar view dashes]
622 '("--"))
624 (define-key-after map [menu-bar view sort]
625 (cons "Sort" (make-sparse-keymap "Sort")))
627 (define-key-after map [menu-bar view sort do-sort-by-major-mode]
628 '(menu-item "Sort by major mode" ibuffer-do-sort-by-major-mode))
629 (define-key-after map [menu-bar view sort do-sort-by-size]
630 '(menu-item "Sort by buffer size" ibuffer-do-sort-by-size))
631 (define-key-after map [menu-bar view sort do-sort-by-alphabetic]
632 '(menu-item "Sort lexicographically" ibuffer-do-sort-by-alphabetic
633 :help "Sort by the alphabetic order of buffer name"))
634 (define-key-after map [menu-bar view sort do-sort-by-recency]
635 '(menu-item "Sort by view time" ibuffer-do-sort-by-recency
636 :help "Sort by the last time the buffer was displayed"))
637 (define-key-after map [menu-bar view sort dashes]
638 '("--"))
639 (define-key-after map [menu-bar view sort invert-sorting]
640 '(menu-item "Reverse sorting order" ibuffer-invert-sorting))
641 (define-key-after map [menu-bar view sort toggle-sorting-mode]
642 '(menu-item "Switch sorting mode" ibuffer-toggle-sorting-mode
643 :help "Switch between the various sorting criteria"))
645 (define-key-after map [menu-bar view filter]
646 (cons "Filter" (make-sparse-keymap "Filter")))
648 (define-key-after map [menu-bar view filter filter-disable]
649 '(menu-item "Disable all filtering" ibuffer-filter-disable
650 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
651 (define-key-after map [menu-bar view filter filter-by-mode]
652 '(menu-item "Add filter by any major mode..." ibuffer-filter-by-mode))
653 (define-key-after map [menu-bar view filter filter-by-used-mode]
654 '(menu-item "Add filter by a major mode in use..."
655 ibuffer-filter-by-used-mode))
656 (define-key-after map [menu-bar view filter filter-by-derived-mode]
657 '(menu-item "Add filter by derived mode..."
658 ibuffer-filter-by-derived-mode))
659 (define-key-after map [menu-bar view filter filter-by-name]
660 '(menu-item "Add filter by buffer name..." ibuffer-filter-by-name))
661 (define-key-after map [menu-bar view filter filter-by-starred-name]
662 '(menu-item "Add filter by starred buffer name..."
663 ibuffer-filter-by-starred-name
664 :help "List buffers whose names begin with a star"))
665 (define-key-after map [menu-bar view filter filter-by-filename]
666 '(menu-item "Add filter by full filename..." ibuffer-filter-by-filename
667 :help
668 (concat "For a buffer associated with file '/a/b/c.d', "
669 "list buffer if a given pattern matches '/a/b/c.d'")))
670 (define-key-after map [menu-bar view filter filter-by-basename]
671 '(menu-item "Add filter by file basename..."
672 ibuffer-filter-by-basename
673 :help (concat "For a buffer associated with file '/a/b/c.d', "
674 "list buffer if a given pattern matches 'c.d'")))
675 (define-key-after map [menu-bar view filter filter-by-file-extension]
676 '(menu-item "Add filter by file name extension..."
677 ibuffer-filter-by-file-extension
678 :help (concat "For a buffer associated with file '/a/b/c.d', "
679 "list buffer if a given pattern matches 'd'")))
680 (define-key-after map [menu-bar view filter filter-by-directory]
681 '(menu-item "Add filter by filename's directory..."
682 ibuffer-filter-by-directory
683 :help
684 (concat "For a buffer associated with file '/a/b/c.d', "
685 "list buffer if a given pattern matches '/a/b'")))
686 (define-key-after map [menu-bar view filter filter-by-size-lt]
687 '(menu-item "Add filter by size less than..." ibuffer-filter-by-size-lt))
688 (define-key-after map [menu-bar view filter filter-by-size-gt]
689 '(menu-item "Add filter by size greater than..."
690 ibuffer-filter-by-size-gt))
691 (define-key-after map [menu-bar view filter filter-by-modified]
692 '(menu-item "Add filter by modified buffer" ibuffer-filter-by-modified
693 :help "List buffers that are marked as modified"))
694 (define-key-after map [menu-bar view filter filter-by-visiting-file]
695 '(menu-item "Add filter by buffer visiting a file"
696 ibuffer-filter-by-visiting-file
697 :help "List buffers that are visiting files"))
698 (define-key-after map [menu-bar view filter filter-by-content]
699 '(menu-item "Add filter by content (regexp)..."
700 ibuffer-filter-by-content))
701 (define-key-after map [menu-bar view filter filter-by-predicate]
702 '(menu-item "Add filter by Lisp predicate..."
703 ibuffer-filter-by-predicate))
704 (define-key-after map [menu-bar view filter pop-filter]
705 '(menu-item "Remove top filter" ibuffer-pop-filter
706 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
707 (define-key-after map [menu-bar view filter and-filter]
708 '(menu-item "AND top two filters" ibuffer-and-filter
709 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
710 (cdr ibuffer-filtering-qualifiers))
711 :help
712 "Create a new filter which is the logical AND of the top two filters"))
713 (define-key-after map [menu-bar view filter or-filter]
714 '(menu-item "OR top two filters" ibuffer-or-filter
715 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
716 (cdr ibuffer-filtering-qualifiers))
717 :help
718 "Create a new filter which is the logical OR of the top two filters"))
719 (define-key-after map [menu-bar view filter negate-filter]
720 '(menu-item "Negate top filter" ibuffer-negate-filter
721 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
722 (define-key-after map [menu-bar view filter decompose-filter]
723 '(menu-item "Decompose top filter" ibuffer-decompose-filter
724 :enable (and (featurep 'ibuf-ext)
725 (memq (car ibuffer-filtering-qualifiers) '(or saved not)))
726 :help "Break down a complex filter like OR or NOT"))
727 (define-key-after map [menu-bar view filter exchange-filters]
728 '(menu-item "Swap top two filters" ibuffer-exchange-filters
729 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
730 (cdr ibuffer-filtering-qualifiers))))
731 (define-key-after map [menu-bar view filter save-filters]
732 '(menu-item "Save current filters permanently..." ibuffer-save-filters
733 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)
734 :help "Use a mnemonic name to store current filter stack"))
735 (define-key-after map [menu-bar view filter switch-to-saved-filters]
736 '(menu-item "Restore permanently saved filters..."
737 ibuffer-switch-to-saved-filters
738 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filters)
739 :help "Replace current filters with a saved stack"))
740 (define-key-after map [menu-bar view filter add-saved-filters]
741 '(menu-item "Add to permanently saved filters..."
742 ibuffer-add-saved-filters
743 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)
744 :help "Include already saved stack with current filters"))
745 (define-key-after map [menu-bar view filter delete-saved-filters]
746 '(menu-item "Delete permanently saved filters..."
747 ibuffer-delete-saved-filters
748 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filters)))
750 (define-key-after map [menu-bar view filter-groups]
751 (cons "Filter Groups" ibuffer-mode-groups-popup))
753 (define-key-after map [menu-bar view dashes2]
754 '("--"))
755 (define-key-after map [menu-bar view auto-mode]
756 '(menu-item "Auto Mode" ibuffer-auto-mode
757 :button (:toggle . ibuffer-auto-mode)
758 :help "Attempt to automatically update the Ibuffer buffer"))
760 (define-key-after map [menu-bar mark]
761 (cons "Mark" (make-sparse-keymap "Mark")))
763 (define-key-after map [menu-bar mark toggle-marks]
764 '(menu-item "Toggle marks" ibuffer-toggle-marks
765 :help "Unmark marked buffers, and mark unmarked buffers"))
766 (define-key-after map [menu-bar mark change-marks]
767 '(menu-item "Change marks" ibuffer-change-marks
768 :help "Change OLD mark for marked buffers with NEW"))
769 (define-key-after map [menu-bar mark mark-forward]
770 '(menu-item "Mark" ibuffer-mark-forward
771 :help "Mark the buffer at point"))
772 (define-key-after map [menu-bar mark unmark-forward]
773 '(menu-item "Unmark" ibuffer-unmark-forward
774 :help "Unmark the buffer at point"))
775 (define-key-after map [menu-bar mark mark-by-mode]
776 '(menu-item "Mark by mode..." ibuffer-mark-by-mode
777 :help "Mark all buffers in a particular major mode"))
778 (define-key-after map [menu-bar mark mark-modified-buffers]
779 '(menu-item "Mark modified buffers" ibuffer-mark-modified-buffers
780 :help "Mark all buffers which have been modified"))
781 (define-key-after map [menu-bar mark mark-unsaved-buffers]
782 '(menu-item "Mark unsaved buffers" ibuffer-mark-unsaved-buffers
783 :help "Mark all buffers which have a file and are modified"))
784 (define-key-after map [menu-bar mark mark-read-only-buffers]
785 '(menu-item "Mark read-only buffers" ibuffer-mark-read-only-buffers
786 :help "Mark all buffers which are read-only"))
787 (define-key-after map [menu-bar mark mark-special-buffers]
788 '(menu-item "Mark special buffers" ibuffer-mark-special-buffers
789 :help "Mark all buffers whose name begins with a *"))
790 (define-key-after map [menu-bar mark mark-dired-buffers]
791 '(menu-item "Mark dired buffers" ibuffer-mark-dired-buffers
792 :help "Mark buffers in dired-mode"))
793 (define-key-after map [menu-bar mark mark-dissociated-buffers]
794 '(menu-item "Mark dissociated buffers" ibuffer-mark-dissociated-buffers
795 :help "Mark buffers with a non-existent associated file"))
796 (define-key-after map [menu-bar mark mark-help-buffers]
797 '(menu-item "Mark help buffers" ibuffer-mark-help-buffers
798 :help "Mark buffers in help-mode"))
799 (define-key-after map [menu-bar mark mark-compressed-file-buffers]
800 '(menu-item "Mark compressed file buffers"
801 ibuffer-mark-compressed-file-buffers
802 :help "Mark buffers which have a file that is compressed"))
803 (define-key-after map [menu-bar mark mark-old-buffers]
804 '(menu-item "Mark old buffers" ibuffer-mark-old-buffers
805 :help "Mark buffers which have not been viewed recently"))
806 (define-key-after map [menu-bar mark unmark-all]
807 '(menu-item "Unmark All" ibuffer-unmark-all))
808 (define-key-after map [menu-bar mark unmark-all-marks]
809 '(menu-item "Unmark All buffers" ibuffer-unmark-all-marks))
811 (define-key-after map [menu-bar mark dashes]
812 '("--"))
814 (define-key-after map [menu-bar mark mark-by-name-regexp]
815 '(menu-item "Mark by buffer name (regexp)..." ibuffer-mark-by-name-regexp
816 :help "Mark buffers whose name matches a regexp"))
817 (define-key-after map [menu-bar mark mark-by-mode-regexp]
818 '(menu-item "Mark by major mode (regexp)..." ibuffer-mark-by-mode-regexp
819 :help "Mark buffers whose major mode name matches a regexp"))
820 (define-key-after map [menu-bar mark mark-by-file-name-regexp]
821 '(menu-item "Mark by file name (regexp)..."
822 ibuffer-mark-by-file-name-regexp
823 :help "Mark buffers whose file name matches a regexp"))
824 (define-key-after map [menu-bar mark ibuffer-mark-by-content-regexp]
825 '(menu-item "Mark by content (regexp)..."
826 ibuffer-mark-by-content-regexp
827 :help "Mark buffers whose content matches a regexp"))
828 (define-key-after map [menu-bar mark mark-by-locked]
829 '(menu-item "Mark by locked buffers..." ibuffer-mark-by-locked
830 :help "Mark all locked buffers"))
832 map))
834 (defvar ibuffer-mode-operate-map
835 (let ((operate-map (make-sparse-keymap "Operate")))
836 (define-key-after operate-map [do-view]
837 '(menu-item "View" ibuffer-do-view))
838 (define-key-after operate-map [do-view-other-frame]
839 '(menu-item "View (separate frame)" ibuffer-do-view-other-frame))
840 (define-key-after operate-map [do-save]
841 '(menu-item "Save" ibuffer-do-save))
842 (define-key-after operate-map [do-replace-regexp]
843 '(menu-item "Replace (regexp)..." ibuffer-do-replace-regexp
844 :help "Replace text inside marked buffers"))
845 (define-key-after operate-map [do-query-replace]
846 '(menu-item "Query Replace..." ibuffer-do-query-replace
847 :help "Replace text in marked buffers, asking each time"))
848 (define-key-after operate-map [do-query-replace-regexp]
849 '(menu-item "Query Replace (regexp)..." ibuffer-do-query-replace-regexp
850 :help "Replace text in marked buffers by regexp, asking each time"))
851 (define-key-after operate-map [do-print]
852 '(menu-item "Print" ibuffer-do-print))
853 (define-key-after operate-map [do-toggle-modified]
854 '(menu-item "Toggle modification flag" ibuffer-do-toggle-modified))
855 (define-key-after operate-map [do-toggle-read-only]
856 '(menu-item "Toggle read-only flag" ibuffer-do-toggle-read-only))
857 (define-key-after operate-map [do-toggle-lock]
858 '(menu-item "Toggle lock flag" ibuffer-do-toggle-lock))
859 (define-key-after operate-map [do-revert]
860 '(menu-item "Revert" ibuffer-do-revert
861 :help "Revert marked buffers to their associated file"))
862 (define-key-after operate-map [do-rename-uniquely]
863 '(menu-item "Rename Uniquely" ibuffer-do-rename-uniquely
864 :help "Rename marked buffers to a new, unique name"))
865 (define-key-after operate-map [do-delete]
866 '(menu-item "Kill" ibuffer-do-delete))
867 (define-key-after operate-map [do-occur]
868 '(menu-item "List lines matching..." ibuffer-do-occur
869 :help "View all lines in marked buffers matching a regexp"))
870 (define-key-after operate-map [do-shell-command-pipe]
871 '(menu-item "Pipe to shell command..." ibuffer-do-shell-command-pipe
872 :help "For each marked buffer, send its contents to a shell command"))
873 (define-key-after operate-map [do-shell-command-pipe-replace]
874 '(menu-item "Pipe to shell command (replace)..." ibuffer-do-shell-command-pipe-replace
875 :help "For each marked buffer, replace its contents with output of shell command"))
876 (define-key-after operate-map [do-shell-command-file]
877 '(menu-item "Shell command on buffer's file..." ibuffer-do-shell-command-file
878 :help "For each marked buffer, run a shell command with its file as argument"))
879 (define-key-after operate-map [do-eval]
880 '(menu-item "Eval..." ibuffer-do-eval
881 :help "Evaluate a Lisp form in each marked buffer"))
882 (define-key-after operate-map [do-view-and-eval]
883 '(menu-item "Eval (viewing buffer)..." ibuffer-do-view-and-eval
884 :help "Evaluate a Lisp form in each marked buffer while viewing it"))
885 (define-key-after operate-map [diff-with-file]
886 '(menu-item "Diff with file" ibuffer-diff-with-file
887 :help "View the differences between this buffer and its file"))
889 operate-map))
891 (define-key ibuffer-mode-groups-popup [kill-filter-group]
892 '(menu-item "Kill filter group"
893 ibuffer-kill-line
894 :enable (and (featurep 'ibuf-ext)
895 ibuffer-filter-groups)))
896 (define-key ibuffer-mode-groups-popup [yank-filter-group]
897 '(menu-item "Yank last killed filter group"
898 ibuffer-yank
899 :enable (and (featurep 'ibuf-ext)
900 ibuffer-filter-group-kill-ring)))
902 (defvar ibuffer-name-map
903 (let ((map (make-sparse-keymap)))
904 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
905 (define-key map [(mouse-2)] 'ibuffer-mouse-visit-buffer)
906 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
907 map))
909 (defvar ibuffer-filename/process-header-map
910 (let ((map (make-sparse-keymap)))
911 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-filename/process)
912 map))
914 (defvar ibuffer-mode-name-map
915 (let ((map (make-sparse-keymap)))
916 (define-key map [(mouse-2)] 'ibuffer-mouse-filter-by-mode)
917 (define-key map (kbd "RET") 'ibuffer-interactive-filter-by-mode)
918 map))
920 (defvar ibuffer-name-header-map
921 (let ((map (make-sparse-keymap)))
922 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-alphabetic)
923 map))
925 (defvar ibuffer-size-header-map
926 (let ((map (make-sparse-keymap)))
927 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-size)
928 map))
930 (defvar ibuffer-mode-header-map
931 (let ((map (make-sparse-keymap)))
932 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-major-mode)
933 map))
935 (defvar ibuffer-mode-filter-group-map
936 (let ((map (make-sparse-keymap)))
937 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
938 (define-key map [(mouse-2)] 'ibuffer-mouse-toggle-filter-group)
939 (define-key map (kbd "RET") 'ibuffer-toggle-filter-group)
940 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
941 map))
943 (defvar ibuffer-did-modification nil)
945 (defvar ibuffer-compiled-formats nil)
946 (defvar ibuffer-cached-formats nil)
947 (defvar ibuffer-cached-eliding-string nil)
949 (defvar ibuffer-sorting-functions-alist nil
950 "An alist of functions which describe how to sort buffers.
952 Note: You most likely do not want to modify this variable directly;
953 use `define-ibuffer-sorter' instead.
955 The alist elements are constructed like (NAME DESCRIPTION FUNCTION)
956 Where NAME is a symbol describing the sorting method, DESCRIPTION is a
957 short string which will be displayed in the minibuffer and menu, and
958 FUNCTION is a function of two arguments, which will be the buffers to
959 compare.")
961 ;;; Utility functions
962 (defun ibuffer-columnize-and-insert-list (list &optional pad-width)
963 "Insert LIST into the current buffer in as many columns as possible.
964 The maximum number of columns is determined by the current window
965 width and the longest string in LIST."
966 (unless pad-width
967 (setq pad-width 3))
968 (let ((width (window-width))
969 (max (+ (apply #'max (mapcar #'length list))
970 pad-width)))
971 (let ((columns (/ width max)))
972 (when (zerop columns)
973 (setq columns 1))
974 (while list
975 (dotimes (_ (1- columns))
976 (insert (concat (car list) (make-string (- max (length (car list)))
977 ?\s)))
978 (setq list (cdr list)))
979 (when (not (null list))
980 (insert (pop list)))
983 (defsubst ibuffer-current-mark ()
984 (cadr (get-text-property (line-beginning-position)
985 'ibuffer-properties)))
987 (defun ibuffer-mouse-toggle-mark (event)
988 "Toggle the marked status of the buffer chosen with the mouse."
989 (interactive "e")
990 (unwind-protect
991 (let ((pt (save-excursion
992 (mouse-set-point event)
993 (point))))
994 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
995 (ibuffer-toggle-marks it)
996 (goto-char pt)
997 (let ((mark (ibuffer-current-mark)))
998 (setq buffer-read-only nil)
999 (if (eq mark ibuffer-marked-char)
1000 (ibuffer-set-mark ?\s)
1001 (ibuffer-set-mark ibuffer-marked-char)))))
1002 (setq buffer-read-only t)))
1004 (defun ibuffer-find-file (file &optional wildcards)
1005 "Like `find-file', but default to the directory of the buffer at point."
1006 (interactive
1007 (let ((default-directory (let ((buf (ibuffer-current-buffer)))
1008 (if (buffer-live-p buf)
1009 (with-current-buffer buf
1010 default-directory)
1011 default-directory))))
1012 (list (read-file-name "Find file: " default-directory)
1013 t)))
1014 (find-file file wildcards))
1016 (defun ibuffer-mouse-visit-buffer (event)
1017 "Visit the buffer chosen with the mouse."
1018 (interactive "e")
1019 (switch-to-buffer
1020 (save-excursion
1021 (mouse-set-point event)
1022 (ibuffer-current-buffer t))))
1024 (defun ibuffer-mouse-popup-menu (event)
1025 "Display a menu of operations."
1026 (interactive "e")
1027 (let ((eventpt (posn-point (event-end event)))
1028 (origpt (point)))
1029 (unwind-protect
1030 (if (get-text-property eventpt 'ibuffer-filter-group-name)
1031 (progn
1032 (goto-char eventpt)
1033 (popup-menu ibuffer-mode-groups-popup))
1034 (let ((inhibit-read-only t))
1035 (ibuffer-save-marks
1036 (ibuffer-unmark-all-marks)
1037 (save-excursion
1038 (goto-char eventpt)
1039 (ibuffer-set-mark ibuffer-marked-char))
1040 (save-excursion
1041 (popup-menu ibuffer-mode-operate-map)))))
1042 (setq buffer-read-only t)
1043 (if (= eventpt (point))
1044 (goto-char origpt)))))
1046 (defun ibuffer-skip-properties (props direction)
1047 (while (and (not (eobp))
1048 (let ((hit nil))
1049 (dolist (prop props hit)
1050 (when (get-text-property (point) prop)
1051 (setq hit t)))))
1052 (forward-line direction)
1053 (beginning-of-line)))
1055 (defun ibuffer-customize ()
1056 "Begin customizing Ibuffer interactively."
1057 (interactive)
1058 (customize-group 'ibuffer))
1060 (defun ibuffer-backward-line (&optional arg skip-group-names)
1061 "Move backwards ARG lines, wrapping around the list if necessary."
1062 (interactive "P")
1063 (or arg (setq arg 1))
1064 (beginning-of-line)
1065 (while (> arg 0)
1066 (forward-line -1)
1067 (when (and ibuffer-movement-cycle
1068 (or (get-text-property (point) 'ibuffer-title)
1069 (and skip-group-names
1070 (get-text-property (point)
1071 'ibuffer-filter-group-name))))
1072 (goto-char (point-max))
1073 (beginning-of-line))
1074 (ibuffer-skip-properties (append '(ibuffer-summary)
1075 (when skip-group-names
1076 '(ibuffer-filter-group-name)))
1077 -1)
1078 ;; Handle the special case of no buffers.
1079 (when (get-text-property (point) 'ibuffer-title)
1080 (forward-line 1)
1081 (setq arg 1))
1082 (cl-decf arg)))
1084 (defun ibuffer-forward-line (&optional arg skip-group-names)
1085 "Move forward ARG lines, wrapping around the list if necessary."
1086 (interactive "P")
1087 (or arg (setq arg 1))
1088 (beginning-of-line)
1089 (when (and ibuffer-movement-cycle
1090 (or (eobp)
1091 (get-text-property (point) 'ibuffer-summary)))
1092 (goto-char (point-min)))
1093 (when (or (get-text-property (point) 'ibuffer-title)
1094 (and skip-group-names
1095 (get-text-property (point) 'ibuffer-filter-group-name)))
1096 (when (> arg 0)
1097 (cl-decf arg))
1098 (ibuffer-skip-properties (append '(ibuffer-title)
1099 (when skip-group-names
1100 '(ibuffer-filter-group-name)))
1101 1))
1102 (if (< arg 0)
1103 (ibuffer-backward-line (- arg))
1104 (while (> arg 0)
1105 (forward-line 1)
1106 (when (and ibuffer-movement-cycle
1107 (or (eobp)
1108 (get-text-property (point) 'ibuffer-summary)))
1109 (goto-char (point-min)))
1110 (cl-decf arg)
1111 (ibuffer-skip-properties (append '(ibuffer-title)
1112 (when skip-group-names
1113 '(ibuffer-filter-group-name)))
1114 1))))
1116 (defun ibuffer-visit-buffer (&optional single)
1117 "Visit the buffer on this line.
1118 If optional argument SINGLE is non-nil, then also ensure there is only
1119 one window."
1120 (interactive "P")
1121 (let ((buf (ibuffer-current-buffer t)))
1122 (switch-to-buffer buf)
1123 (when single
1124 (delete-other-windows))))
1126 (defun ibuffer-visit-buffer-other-window (&optional noselect)
1127 "Visit the buffer on this line in another window."
1128 (interactive)
1129 (let ((buf (ibuffer-current-buffer t)))
1130 (bury-buffer (current-buffer))
1131 (if noselect
1132 (let ((curwin (selected-window)))
1133 (pop-to-buffer buf)
1134 (select-window curwin))
1135 (switch-to-buffer-other-window buf))))
1137 (defun ibuffer-visit-buffer-other-window-noselect ()
1138 "Visit the buffer on this line in another window, but don't select it."
1139 (interactive)
1140 (ibuffer-visit-buffer-other-window t))
1142 (defun ibuffer-visit-buffer-other-frame ()
1143 "Visit the buffer on this line in another frame."
1144 (interactive)
1145 (let ((buf (ibuffer-current-buffer t)))
1146 (bury-buffer (current-buffer))
1147 (switch-to-buffer-other-frame buf)))
1149 (defun ibuffer-visit-buffer-1-window ()
1150 "Visit the buffer on this line, and delete other windows."
1151 (interactive)
1152 (ibuffer-visit-buffer t))
1154 (defun ibuffer-bury-buffer ()
1155 "Bury the buffer on this line."
1156 (interactive)
1157 (let ((buf (ibuffer-current-buffer t))
1158 (line (+ 1 (count-lines 1 (point)))))
1159 (bury-buffer buf)
1160 (ibuffer-update nil t)
1161 (goto-char (point-min))
1162 (forward-line (1- line))))
1164 (defun ibuffer-visit-tags-table ()
1165 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
1166 (interactive)
1167 (let ((file (buffer-file-name (ibuffer-current-buffer t))))
1168 (if file
1169 (visit-tags-table file)
1170 (error "Specified buffer has no file"))))
1172 (defun ibuffer-do-view (&optional other-frame)
1173 "View marked buffers, or the buffer on the current line.
1174 If optional argument OTHER-FRAME is non-nil, then display each
1175 marked buffer in a new frame. Otherwise, display each buffer as
1176 a new window in the current frame, splitting vertically."
1177 (interactive)
1178 (ibuffer-do-view-1 (if other-frame 'other-frame 'vertically)))
1180 (defun ibuffer-do-view-horizontally (&optional other-frame)
1181 "As `ibuffer-do-view', but split windows horizontally."
1182 (interactive)
1183 (ibuffer-do-view-1 (if other-frame 'other-frame 'horizontally)))
1185 (defun ibuffer-do-view-1 (type)
1186 (let ((marked-bufs (or (ibuffer-get-marked-buffers)
1187 (list (ibuffer-current-buffer t)))))
1188 (unless (and (eq type 'other-frame)
1189 (not ibuffer-expert)
1190 (> (length marked-bufs) 3)
1191 (not (y-or-n-p (format "Really create a new frame for %s buffers? "
1192 (length marked-bufs)))))
1193 (unless (eq type 'other-frame)
1194 (set-buffer-modified-p nil)
1195 (delete-other-windows)
1196 (switch-to-buffer (pop marked-bufs)))
1197 (let ((height (/ (1- (if (eq type 'horizontally) (frame-width)
1198 (frame-height)))
1199 (1+ (length marked-bufs)))))
1200 (mapcar (if (eq type 'other-frame)
1201 (lambda (buf)
1202 (let ((curframe (selected-frame)))
1203 (select-frame (make-frame))
1204 (switch-to-buffer buf)
1205 (select-frame curframe)))
1206 (lambda (buf)
1207 (split-window nil height (eq type 'horizontally))
1208 (other-window 1)
1209 (switch-to-buffer buf)))
1210 marked-bufs)))))
1212 (defun ibuffer-do-view-other-frame ()
1213 "View each of the marked buffers in a separate frame."
1214 (interactive)
1215 (ibuffer-do-view t))
1217 (defsubst ibuffer-map-marked-lines (func)
1218 (prog1 (ibuffer-map-on-mark ibuffer-marked-char func)
1219 (ibuffer-redisplay t)))
1221 (defun ibuffer-shrink-to-fit (&optional owin)
1222 ;; Make sure that redisplay is performed, otherwise there can be a
1223 ;; bad interaction with code in the window-scroll-functions hook
1224 (redisplay t)
1225 (fit-window-to-buffer nil (when owin (/ (frame-height)
1226 (length (window-list (selected-frame)))))))
1228 (defun ibuffer-confirm-operation-on (operation names)
1229 "Display a buffer asking whether to perform OPERATION on NAMES."
1230 (or ibuffer-expert
1231 (if (= (length names) 1)
1232 (y-or-n-p (format "Really %s buffer %s? " operation (car names)))
1233 (let ((buf (get-buffer-create "*Ibuffer confirmation*")))
1234 (with-current-buffer buf
1235 (setq buffer-read-only nil)
1236 (erase-buffer)
1237 (ibuffer-columnize-and-insert-list names)
1238 (goto-char (point-min))
1239 (setq buffer-read-only t))
1240 (let ((windows (nreverse (window-list nil 'nomini)))
1241 lastwin)
1242 (while (window-parameter (car windows) 'window-side)
1243 (setq windows (cdr windows)))
1244 (setq lastwin (car windows))
1245 ;; Now attempt to display the buffer...
1246 (save-window-excursion
1247 (select-window lastwin)
1248 ;; The window might be too small to split; in that case,
1249 ;; try a few times to increase its size before giving up.
1250 (let ((attempts 0)
1251 (trying t))
1252 (while trying
1253 (condition-case err
1254 (progn
1255 (split-window)
1256 (setq trying nil))
1257 (error
1258 ;; Handle a failure
1259 (if (or (> (cl-incf attempts) 4)
1260 (and (stringp (cadr err))
1261 ;; This definitely falls in the
1262 ;; ghetto hack category...
1263 (not (string-match-p "too small" (cadr err)))))
1264 (signal (car err) (cdr err))
1265 (enlarge-window 3))))))
1266 (select-window (next-window))
1267 (switch-to-buffer buf)
1268 (unwind-protect
1269 (progn
1270 (fit-window-to-buffer)
1271 (y-or-n-p (format "Really %s %d buffers? "
1272 operation (length names))))
1273 (kill-buffer buf))))))))
1275 (defsubst ibuffer-map-lines-nomodify (function)
1276 "As `ibuffer-map-lines', but don't set the modification flag."
1277 (ibuffer-map-lines function t))
1279 (defun ibuffer-buffer-names-with-mark (mark)
1280 (let ((ibuffer-buffer-names-with-mark-result nil))
1281 (ibuffer-map-lines-nomodify
1282 (lambda (buf mk)
1283 (when (eq mark mk)
1284 (push (buffer-name buf)
1285 ibuffer-buffer-names-with-mark-result))))
1286 ibuffer-buffer-names-with-mark-result))
1288 (defsubst ibuffer-marked-buffer-names ()
1289 (ibuffer-buffer-names-with-mark ibuffer-marked-char))
1291 (defsubst ibuffer-deletion-marked-buffer-names ()
1292 (ibuffer-buffer-names-with-mark ibuffer-deletion-char))
1294 (defun ibuffer-count-marked-lines (&optional all)
1295 (if all
1296 (ibuffer-map-lines-nomodify
1297 (lambda (_buf mark)
1298 (not (eq mark ?\s))))
1299 (ibuffer-map-lines-nomodify
1300 (lambda (_buf mark)
1301 (eq mark ibuffer-marked-char)))))
1303 (defsubst ibuffer-count-deletion-lines ()
1304 (ibuffer-map-lines-nomodify
1305 (lambda (_buf mark)
1306 (eq mark ibuffer-deletion-char))))
1308 (defsubst ibuffer-map-deletion-lines (func)
1309 (ibuffer-map-on-mark ibuffer-deletion-char func))
1311 (defsubst ibuffer-assert-ibuffer-mode ()
1312 (cl-assert (derived-mode-p 'ibuffer-mode)))
1314 (defun ibuffer-buffer-file-name ()
1315 (cond
1316 ((buffer-file-name))
1317 ((bound-and-true-p list-buffers-directory))
1318 ((let ((dirname (and (boundp 'dired-directory)
1319 (if (stringp dired-directory)
1320 dired-directory
1321 (car dired-directory)))))
1322 (and dirname (expand-file-name dirname))))))
1324 (define-ibuffer-op ibuffer-do-save ()
1325 "Save marked buffers as with `save-buffer'."
1326 (:complex t
1327 :opstring "saved"
1328 :modifier-p :maybe)
1329 (when (buffer-modified-p buf)
1330 (if (not (with-current-buffer buf
1331 buffer-file-name))
1332 ;; handle the case where we're prompted
1333 ;; for a file name
1334 (save-window-excursion
1335 (switch-to-buffer buf)
1336 (save-buffer))
1337 (with-current-buffer buf
1338 (save-buffer))))
1339 t)
1341 (define-ibuffer-op ibuffer-do-toggle-modified ()
1342 "Toggle modification flag of marked buffers."
1343 (:opstring "(un)marked as modified"
1344 :modifier-p t)
1345 (set-buffer-modified-p (not (buffer-modified-p))))
1347 (define-ibuffer-op ibuffer-do-toggle-read-only (&optional arg)
1348 "Toggle read only status in marked buffers.
1349 If optional ARG is a non-negative integer, make buffers read only.
1350 If ARG is a negative integer or 0, make buffers writable.
1351 Otherwise, toggle read only status."
1352 (:opstring "toggled read only status in"
1353 :interactive "P"
1354 :modifier-p t)
1355 (read-only-mode (if (integerp arg) arg 'toggle)))
1357 (define-ibuffer-op ibuffer-do-toggle-lock (&optional arg)
1358 "Toggle locked status in marked buffers.
1359 If optional ARG is a non-negative integer, lock buffers.
1360 If ARG is a negative integer or 0, unlock buffers.
1361 Otherwise, toggle lock status."
1362 (:opstring "toggled lock status in"
1363 :interactive "P"
1364 :modifier-p t)
1365 (emacs-lock-mode (if (integerp arg) arg 'toggle)))
1367 (define-ibuffer-op ibuffer-do-delete ()
1368 "Kill marked buffers as with `kill-this-buffer'."
1369 (:opstring "killed"
1370 :active-opstring "kill"
1371 :dangerous t
1372 :complex t
1373 :modifier-p t)
1374 (if (kill-buffer buf)
1375 'kill
1376 nil))
1378 (define-ibuffer-op ibuffer-do-kill-on-deletion-marks ()
1379 "Kill buffers marked for deletion as with `kill-this-buffer'."
1380 (:opstring "killed"
1381 :active-opstring "kill"
1382 :dangerous t
1383 :complex t
1384 :mark :deletion
1385 :modifier-p t)
1386 (if (kill-buffer buf)
1387 'kill
1388 nil))
1390 (defun ibuffer-unmark-all (mark)
1391 "Unmark all buffers with mark MARK."
1392 (interactive "cRemove marks (RET means all):")
1393 (if (= (ibuffer-count-marked-lines t) 0)
1394 (message "No buffers marked; use 'm' to mark a buffer")
1395 (let ((fn (lambda (_buf mk)
1396 (unless (eq mk ?\s)
1397 (ibuffer-set-mark-1 ?\s)) t)))
1399 (ibuffer-map-lines fn)
1400 (ibuffer-map-on-mark mark fn))))
1401 (ibuffer-redisplay t))
1403 (defun ibuffer-unmark-all-marks ()
1404 "Remove all marks from all marked buffers in Ibuffer."
1405 (interactive)
1406 ;; hm. we could probably do this in a better fashion
1409 (defun ibuffer-toggle-marks (&optional group)
1410 "Toggle which buffers are marked.
1411 In other words, unmarked buffers become marked, and marked buffers
1412 become unmarked.
1413 If point is on a group name, then this function operates on that
1414 group."
1415 (interactive)
1416 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
1417 (setq group it))
1418 (let ((count
1419 (ibuffer-map-lines
1420 (lambda (_buf mark)
1421 (cond ((eq mark ibuffer-marked-char)
1422 (ibuffer-set-mark-1 ?\s)
1423 nil)
1424 ((eq mark ?\s)
1425 (ibuffer-set-mark-1 ibuffer-marked-char)
1426 t)
1427 (t
1428 nil)))
1429 nil group)))
1430 (message "%s buffers marked" count))
1431 (ibuffer-redisplay t))
1433 (defun ibuffer-change-marks (&optional old new)
1434 "Change all OLD marks to NEW marks.
1435 OLD and NEW are both characters used to mark buffers."
1436 (interactive
1437 (let* ((cursor-in-echo-area t)
1438 (old (progn (message "Change (old mark): ") (read-char)))
1439 (new (progn (message "Change %c marks to (new mark): " old)
1440 (read-char))))
1441 (list old new)))
1443 (ding)
1444 (let ((count
1445 (ibuffer-map-lines
1446 (lambda (_buf mark)
1447 (when (eq mark old)
1448 (ibuffer-set-mark new) t)))))
1449 (message "%s marks changed" count))))
1451 (defsubst ibuffer-get-region-and-prefix ()
1452 (let ((arg (prefix-numeric-value current-prefix-arg)))
1453 (if (use-region-p) (list (region-beginning) (region-end) arg)
1454 (list nil nil arg))))
1456 (defun ibuffer-mark-forward (start end arg)
1457 "Mark the buffers in the region, or ARG buffers.
1458 If point is on a group name, this function operates on that group."
1459 (interactive (ibuffer-get-region-and-prefix))
1460 (ibuffer-mark-region-or-n-with-char start end arg ibuffer-marked-char))
1462 (defun ibuffer-unmark-forward (start end arg)
1463 "Unmark the buffers in the region, or ARG buffers.
1464 If point is on a group name, this function operates on that group."
1465 (interactive (ibuffer-get-region-and-prefix))
1466 (ibuffer-mark-region-or-n-with-char start end arg ?\s))
1468 (defun ibuffer-unmark-backward (start end arg)
1469 "Unmark the buffers in the region, or previous ARG buffers.
1470 If point is on a group name, this function operates on that group."
1471 (interactive (ibuffer-get-region-and-prefix))
1472 (ibuffer-unmark-forward start end (- arg)))
1474 (defun ibuffer-mark-region-or-n-with-char (start end arg mark-char)
1475 (if (use-region-p)
1476 (let ((cur (point)) (line-count (count-lines start end)))
1477 (goto-char start)
1478 (ibuffer-mark-interactive line-count mark-char)
1479 (goto-char cur))
1480 (ibuffer-mark-interactive arg mark-char)))
1482 (defun ibuffer-mark-interactive (arg mark &optional movement)
1483 (ibuffer-assert-ibuffer-mode)
1484 (or arg (setq arg 1))
1485 ;; deprecated movement argument
1486 (when (and movement (< movement 0))
1487 (setq arg (- arg)))
1488 (ibuffer-forward-line 0)
1489 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
1490 (progn
1491 (require 'ibuf-ext)
1492 (ibuffer-mark-on-buffer #'identity mark it))
1493 (ibuffer-forward-line 0 t)
1494 (while (> arg 0)
1495 (ibuffer-set-mark mark)
1496 (ibuffer-forward-line 1 t)
1497 (setq arg (1- arg)))
1498 (while (< arg 0)
1499 (ibuffer-forward-line -1 t)
1500 (ibuffer-set-mark mark)
1501 (setq arg (1+ arg)))))
1503 (defun ibuffer-set-mark (mark)
1504 (ibuffer-assert-ibuffer-mode)
1505 (let ((inhibit-read-only t))
1506 (ibuffer-set-mark-1 mark)
1507 (setq ibuffer-did-modification t)
1508 (ibuffer-redisplay-current)
1509 (beginning-of-line)))
1511 (defun ibuffer-set-mark-1 (mark)
1512 (let ((beg (line-beginning-position))
1513 (end (line-end-position)))
1514 (put-text-property beg end 'ibuffer-properties
1515 (list (ibuffer-current-buffer)
1516 mark))))
1518 (defun ibuffer-mark-for-delete (start end arg)
1519 "Mark for deletion the buffers in the region, or ARG buffers.
1520 If point is on a group name, this function operates on that group."
1521 (interactive (ibuffer-get-region-and-prefix))
1522 (ibuffer-mark-region-or-n-with-char start end arg ibuffer-deletion-char))
1524 (defun ibuffer-mark-for-delete-backwards (arg)
1525 "Mark for deletion the ARG previous buffers.
1526 If point is on a group name, this function operates on that group."
1527 (interactive "p")
1528 (ibuffer-mark-interactive arg ibuffer-deletion-char -1))
1530 (defun ibuffer-current-buffer (&optional must-be-live)
1531 (let ((buf (car (get-text-property (line-beginning-position)
1532 'ibuffer-properties))))
1533 (when must-be-live
1534 (if (bufferp buf)
1535 (unless (buffer-live-p buf)
1536 (error "Buffer %s has been killed; %s" buf (substitute-command-keys "use `\\[ibuffer-update]' to update")))
1537 (error "No buffer on this line")))
1538 buf))
1540 (defun ibuffer-active-formats-name ()
1541 (if (boundp 'ibuffer-filter-format-alist)
1542 (let ((ret nil))
1543 (dolist (filter ibuffer-filtering-qualifiers ret)
1544 (let ((val (assq (car filter) ibuffer-filter-format-alist)))
1545 (when val
1546 (setq ret (car filter)))))
1547 (if ret
1548 ret
1549 :ibuffer-formats))
1550 :ibuffer-formats))
1552 (defun ibuffer-current-formats (uncompiledp)
1553 (let* ((name (ibuffer-active-formats-name)))
1554 (ibuffer-check-formats)
1555 (if (eq name :ibuffer-formats)
1556 (if uncompiledp
1557 ibuffer-formats
1558 ibuffer-compiled-formats)
1559 (cadr (assq name
1560 (if uncompiledp
1561 ibuffer-filter-format-alist
1562 ibuffer-compiled-filter-formats))))))
1564 (defun ibuffer-current-format (&optional uncompiledp)
1565 (or ibuffer-current-format
1566 (setq ibuffer-current-format 0))
1567 (nth ibuffer-current-format (ibuffer-current-formats uncompiledp)))
1569 (defun ibuffer-expand-format-entry (form)
1570 (if (or (consp form)
1571 (symbolp form))
1572 (let ((sym (intern (concat "ibuffer-make-column-"
1573 (symbol-name (if (consp form)
1574 (car form)
1575 form))))))
1576 (unless (or (fboundp sym)
1577 (assq sym ibuffer-inline-columns))
1578 (error "Unknown column %s in ibuffer-formats" form))
1579 (let (min max align elide)
1580 (if (consp form)
1581 (setq min (or (nth 1 form) 0)
1582 max (or (nth 2 form) -1)
1583 align (or (nth 3 form) :left)
1584 elide (or (nth 4 form) nil))
1585 (setq min 0
1586 max -1
1587 align :left
1588 elide nil))
1589 (list sym min max align elide)))
1590 form))
1592 (defun ibuffer-compile-make-eliding-form (strvar elide from-end-p)
1593 (let ((ellipsis (propertize ibuffer-eliding-string 'font-lock-face 'bold)))
1594 (if elide
1595 `(if (> strlen 5)
1596 ,(if from-end-p
1597 ;; FIXME: this should probably also be using
1598 ;; `truncate-string-to-width' (Bug#24972)
1599 `(concat ,ellipsis
1600 (substring ,strvar
1601 (string-width ibuffer-eliding-string)))
1602 `(concat
1603 (truncate-string-to-width
1604 ,strvar (- strlen (string-width ,ellipsis)) nil ?.)
1605 ,ellipsis))
1606 ,strvar)
1607 strvar)))
1609 (defun ibuffer-compile-make-substring-form (strvar maxvar from-end-p)
1610 (if from-end-p
1611 ;; FIXME: not sure if this case is correct (Bug#24972)
1612 `(truncate-string-to-width str strlen (- strlen ,maxvar) nil ?\s)
1613 `(truncate-string-to-width ,strvar ,maxvar nil ?\s)))
1615 (defun ibuffer-compile-make-format-form (strvar widthform alignment)
1616 (let* ((left `(make-string tmp2 ?\s))
1617 (right `(make-string (- tmp1 tmp2) ?\s)))
1618 `(progn
1619 (setq tmp1 ,widthform
1620 tmp2 (/ tmp1 2))
1621 ,(pcase alignment
1622 (:right `(concat ,left ,right ,strvar))
1623 (:center `(concat ,left ,strvar ,right))
1624 (:left `(concat ,strvar ,left ,right))
1625 (_ (error "Invalid alignment %s" alignment))))))
1627 (defun ibuffer-compile-format (format)
1628 (let ((result nil)
1629 ;; We use these variables to keep track of which variables
1630 ;; inside the generated function we need to bind, since
1631 ;; binding variables in Emacs takes time.
1632 (vars-used ()))
1633 (dolist (form format)
1634 (push
1635 ;; Generate a form based on a particular format entry, like
1636 ;; " ", mark, or (mode 16 16 :right).
1637 (if (stringp form)
1638 ;; It's a string; all we need to do is insert it.
1639 `(insert ,form)
1640 (let* ((form (ibuffer-expand-format-entry form))
1641 (sym (nth 0 form))
1642 (min (nth 1 form))
1643 (max (nth 2 form))
1644 (align (nth 3 form))
1645 (elide (nth 4 form)))
1646 (let* ((from-end-p (when (cl-minusp min)
1647 (setq min (- min))
1648 t))
1649 (letbindings nil)
1650 (outforms nil)
1651 minform
1652 maxform
1653 min-used max-used strlen-used)
1654 (when (or (not (integerp min)) (>= min 0))
1655 ;; This is a complex case; they want it limited to a
1656 ;; minimum size.
1657 (setq min-used t)
1658 (setq strlen-used t)
1659 (setq vars-used '(str strlen tmp1 tmp2))
1660 ;; Generate code to limit the string to a minimum size.
1661 (setq minform `(progn
1662 (setq str
1663 ,(ibuffer-compile-make-format-form
1664 'str
1665 `(- ,(if (integerp min)
1666 min
1667 'min)
1668 strlen)
1669 align)))))
1670 (when (or (not (integerp max)) (> max 0))
1671 (setq max-used t)
1672 (cl-pushnew 'str vars-used)
1673 ;; Generate code to limit the string to a maximum size.
1674 (setq maxform `(progn
1675 (setq str
1676 ,(ibuffer-compile-make-substring-form
1677 'str
1678 (if (integerp max)
1679 max
1680 'max)
1681 from-end-p))
1682 (setq strlen (string-width str))
1683 (setq str
1684 ,(ibuffer-compile-make-eliding-form
1685 'str elide from-end-p)))))
1686 ;; Now, put these forms together with the rest of the code.
1687 (let ((callform
1688 ;; Is this an "inline" column? This means we have
1689 ;; to get the code from the
1690 ;; `ibuffer-inline-columns' alist and insert it
1691 ;; into our generated code. Otherwise, we just
1692 ;; generate a call to the column function.
1693 (ibuffer-aif (assq sym ibuffer-inline-columns)
1694 (nth 1 it)
1695 `(or (,sym buffer mark) "")))
1696 ;; You're not expected to understand this. Hell, I
1697 ;; don't even understand it, and I wrote it five
1698 ;; minutes ago.
1699 (insertgenfn
1700 (if (get sym 'ibuffer-column-summarizer)
1701 ;; I really, really wish Emacs Lisp had closures.
1702 ;; FIXME: Elisp does have them now.
1703 (lambda (arg sym)
1704 `(insert
1705 (let ((ret ,arg))
1706 (put ',sym 'ibuffer-column-summary
1707 (cons ret (get ',sym
1708 'ibuffer-column-summary)))
1709 ret)))
1710 (lambda (arg _sym)
1711 `(insert ,arg))))
1712 (mincompform `(< strlen ,(if (integerp min)
1713 min
1714 'min)))
1715 (maxcompform `(> strlen ,(if (integerp max)
1716 max
1717 'max))))
1718 (if (or min-used max-used)
1719 ;; The complex case, where we have to limit the
1720 ;; form to a maximum or minimum size.
1721 (progn
1722 (when (and min-used (not (integerp min)))
1723 (push `(min ,min) letbindings))
1724 (when (and max-used (not (integerp max)))
1725 (push `(max ,max) letbindings))
1726 (push
1727 (if (and min-used max-used)
1728 `(if ,mincompform
1729 ,minform
1730 (if ,maxcompform
1731 ,maxform))
1732 (if min-used
1733 `(when ,mincompform
1734 ,minform)
1735 `(when ,maxcompform
1736 ,maxform)))
1737 outforms)
1738 (push `(setq str ,callform
1739 ,@(when strlen-used
1740 `(strlen (string-width str))))
1741 outforms)
1742 (setq outforms
1743 (append outforms
1744 (list (funcall insertgenfn 'str sym)))))
1745 ;; The simple case; just insert the string.
1746 (push (funcall insertgenfn callform sym) outforms))
1747 ;; Finally, return a `let' form which binds the
1748 ;; variables in `letbindings', and contains all the
1749 ;; code in `outforms'.
1750 `(let ,letbindings
1751 ,@outforms)))))
1752 result))
1753 ;; We don't want to unconditionally load the byte-compiler.
1754 (funcall (if (or ibuffer-always-compile-formats
1755 (featurep 'bytecomp))
1756 #'byte-compile
1757 #'identity)
1758 ;; Here, we actually create a lambda form which
1759 ;; inserts all the generated forms for each entry
1760 ;; in the format string.
1761 `(lambda (buffer mark)
1762 (let ,vars-used
1763 ,@(nreverse result))))))
1765 (defun ibuffer-recompile-formats ()
1766 "Recompile `ibuffer-formats'."
1767 (interactive)
1768 (setq ibuffer-compiled-formats
1769 (mapcar #'ibuffer-compile-format ibuffer-formats))
1770 (when (boundp 'ibuffer-filter-format-alist)
1771 (setq ibuffer-compiled-filter-formats
1772 (mapcar (lambda (entry)
1773 (cons (car entry)
1774 (mapcar (lambda (formats)
1775 (mapcar #'ibuffer-compile-format formats))
1776 (cdr entry))))
1777 ibuffer-filter-format-alist))))
1779 (defun ibuffer-clear-summary-columns (format)
1780 (dolist (form format)
1781 (when (and (consp form)
1782 (get (car form) 'ibuffer-column-summarizer))
1783 (put (car form) 'ibuffer-column-summary nil))))
1785 (defun ibuffer-check-formats ()
1786 (when (null ibuffer-formats)
1787 (error "No formats!"))
1788 (let ((ext-loaded (featurep 'ibuf-ext)))
1789 (when (or (null ibuffer-compiled-formats)
1790 (null ibuffer-cached-formats)
1791 (not (eq ibuffer-cached-formats ibuffer-formats))
1792 (null ibuffer-cached-eliding-string)
1793 (not (equal ibuffer-cached-eliding-string ibuffer-eliding-string))
1794 (and ext-loaded
1795 (not (eq ibuffer-cached-filter-formats
1796 ibuffer-filter-format-alist))
1797 (and ibuffer-filter-format-alist
1798 (null ibuffer-compiled-filter-formats))))
1799 (message "Formats have changed, recompiling...")
1800 (ibuffer-recompile-formats)
1801 (setq ibuffer-cached-formats ibuffer-formats
1802 ibuffer-cached-eliding-string ibuffer-eliding-string)
1803 (when ext-loaded
1804 (setq ibuffer-cached-filter-formats ibuffer-filter-format-alist))
1805 (message "Formats have changed, recompiling...done"))))
1807 (defvar ibuffer-inline-columns nil)
1809 (defface ibuffer-locked-buffer
1810 '((((background dark)) (:foreground "RosyBrown"))
1811 (t (:foreground "brown4")))
1812 "*Face used for locked buffers in Ibuffer."
1813 :version "26.1"
1814 :group 'ibuffer
1815 :group 'font-lock-highlighting-faces)
1816 (defvar ibuffer-locked-buffer 'ibuffer-locked-buffer)
1818 (define-ibuffer-column mark (:name " " :inline t)
1819 (string mark))
1821 (define-ibuffer-column read-only (:name "R" :inline t)
1822 (if buffer-read-only
1823 (string ibuffer-read-only-char)
1824 " "))
1826 (define-ibuffer-column locked
1827 (:name "L" :inline t :props ('font-lock-face 'ibuffer-locked-buffer))
1828 (if (and (boundp 'emacs-lock-mode) emacs-lock-mode)
1829 (string ibuffer-locked-char)
1830 " "))
1832 (define-ibuffer-column modified (:name "M" :inline t)
1833 (if (buffer-modified-p)
1834 (string ibuffer-modified-char)
1835 " "))
1837 (define-ibuffer-column name
1838 (:inline t
1839 :header-mouse-map ibuffer-name-header-map
1840 :props
1841 ('mouse-face 'highlight 'keymap ibuffer-name-map
1842 'ibuffer-name-column t
1843 'help-echo '(if tooltip-mode
1845 "mouse-1: mark buffer mouse-2: select buffer mouse-3: operate"))
1846 :summarizer
1847 (lambda (strings)
1848 (let ((bufs (length strings)))
1849 (cond ((zerop bufs) "No buffers")
1850 ((= 1 bufs) "1 buffer")
1851 (t (format "%s buffers" bufs))))))
1852 (let ((string (propertize (buffer-name)
1853 'font-lock-face
1854 (ibuffer-buffer-name-face buffer mark))))
1856 string
1857 (replace-regexp-in-string
1860 (define-ibuffer-column size
1861 (:inline t
1862 :header-mouse-map ibuffer-size-header-map
1863 :summarizer
1864 (lambda (column-strings)
1865 (let ((total 0))
1866 (dolist (string column-strings)
1867 (setq total
1868 ;; like, ewww ...
1869 (+ (float (string-to-number string))
1870 total)))
1871 (format "%.0f" total))))
1872 (format "%s" (buffer-size)))
1874 (define-ibuffer-column mode
1875 (:inline t
1876 :header-mouse-map ibuffer-mode-header-map
1877 :props
1878 ('mouse-face 'highlight
1879 'keymap ibuffer-mode-name-map
1880 'help-echo "mouse-2: filter by this mode"))
1881 (format-mode-line mode-name nil nil (current-buffer)))
1883 (define-ibuffer-column process
1884 (:summarizer
1885 (lambda (strings)
1886 (let ((total (length (delete "" strings))))
1887 (cond ((zerop total) "No processes")
1888 ((= 1 total) "1 process")
1889 (t (format "%d processes" total))))))
1890 (ibuffer-aif (get-buffer-process buffer)
1891 (format "(%s %s)" it (process-status it))
1892 ""))
1894 (define-ibuffer-column filename
1895 (:summarizer
1896 (lambda (strings)
1897 (let ((total (length (delete "" strings))))
1898 (cond ((zerop total) "No files")
1899 ((= 1 total) "1 file")
1900 (t (format "%d files" total))))))
1901 (let ((directory-abbrev-alist ibuffer-directory-abbrev-alist))
1902 (abbreviate-file-name
1903 (or (ibuffer-buffer-file-name) ""))))
1905 (define-ibuffer-column filename-and-process
1906 (:name "Filename/Process"
1907 :header-mouse-map ibuffer-filename/process-header-map
1908 :summarizer
1909 (lambda (strings)
1910 (setq strings (delete "" strings))
1911 (let ((procs 0)
1912 (files 0))
1913 (dolist (string strings)
1914 (when (get-text-property 1 'ibuffer-process string)
1915 (setq procs (1+ procs)))
1916 (setq files (1+ files)))
1917 (concat (cond ((zerop files) "No files")
1918 ((= 1 files) "1 file")
1919 (t (format "%d files" files)))
1920 ", "
1921 (cond ((zerop procs) "no processes")
1922 ((= 1 procs) "1 process")
1923 (t (format "%d processes" procs)))))))
1924 (let ((proc (get-buffer-process buffer))
1925 (filename (ibuffer-make-column-filename buffer mark)))
1926 (if proc
1927 (concat (propertize (format "(%s %s)" proc (process-status proc))
1928 'font-lock-face 'italic
1929 'ibuffer-process proc)
1930 (if (> (length filename) 0)
1931 (format " %s" filename)
1932 ""))
1933 filename)))
1935 (defun ibuffer-format-column (str width alignment)
1936 (let ((left (make-string (/ width 2) ?\s))
1937 (right (make-string (- width (/ width 2)) ?\s)))
1938 (pcase alignment
1939 (:right (concat left right str))
1940 (:center (concat left str right))
1941 (_ (concat str left right)))))
1943 (defun ibuffer-buffer-name-face (buf mark)
1944 (cond ((eq mark ibuffer-marked-char)
1945 ibuffer-marked-face)
1946 ((eq mark ibuffer-deletion-char)
1947 ibuffer-deletion-face)
1948 (t
1949 (let ((level -1)
1950 result)
1951 (dolist (e ibuffer-fontification-alist result)
1952 (when (and (> (car e) level)
1953 (with-current-buffer buf
1954 (eval (nth 1 e))))
1955 (setq level (car e)
1956 result (nth 2 e))))))))
1958 (defun ibuffer-insert-buffer-line (buffer mark format)
1959 "Insert a line describing BUFFER and MARK using FORMAT."
1960 (ibuffer-assert-ibuffer-mode)
1961 (let ((beg (point)))
1962 (funcall format buffer mark)
1963 (put-text-property beg (point) 'ibuffer-properties (list buffer mark)))
1966 ;; This function knows a bit too much of the internals. It would be
1967 ;; nice if it was all abstracted away.
1968 (defun ibuffer-redisplay-current ()
1969 (ibuffer-assert-ibuffer-mode)
1970 (when (eobp)
1971 (forward-line -1))
1972 (beginning-of-line)
1973 (let ((curformat (mapcar #'ibuffer-expand-format-entry
1974 (ibuffer-current-format t))))
1975 (ibuffer-clear-summary-columns curformat)
1976 (let ((buf (ibuffer-current-buffer)))
1977 (when buf
1978 (let ((mark (ibuffer-current-mark)))
1979 (save-excursion
1980 (delete-region (point) (1+ (line-end-position)))
1981 (ibuffer-insert-buffer-line
1982 buf mark
1983 (ibuffer-current-format)))
1984 (when ibuffer-shrink-to-minimum-size
1985 (ibuffer-shrink-to-fit)))))))
1987 (defun ibuffer-map-on-mark (mark func)
1988 (ibuffer-map-lines
1989 (lambda (buf mk)
1990 (if (eq mark mk)
1991 (funcall func buf mark)
1992 nil))))
1994 (defun ibuffer-map-lines (function &optional nomodify group)
1995 "Call FUNCTION for each buffer.
1996 Set the ibuffer modification flag unless NOMODIFY is non-nil.
1998 If optional argument GROUP is non-nil, then only call FUNCTION on
1999 buffers in filtering group GROUP.
2001 FUNCTION is called with two arguments:
2002 the buffer object itself and the current mark symbol."
2003 (ibuffer-assert-ibuffer-mode)
2004 (ibuffer-forward-line 0)
2005 (let* ((orig-target-line (1+ (count-lines (save-excursion
2006 (goto-char (point-min))
2007 (ibuffer-forward-line 0)
2008 (point))
2009 (point))))
2010 (target-line-offset orig-target-line)
2011 (ibuffer-map-lines-total 0)
2012 (ibuffer-map-lines-count 0))
2013 (unwind-protect
2014 (progn
2015 (setq buffer-read-only nil)
2016 (goto-char (point-min))
2017 (ibuffer-forward-line 0 t)
2018 (while (and (not (eobp))
2019 (not (get-text-property (point) 'ibuffer-summary))
2020 (progn
2021 (ibuffer-forward-line 0 t)
2022 (and (not (eobp))
2023 (not (get-text-property (point) 'ibuffer-summary)))))
2024 (let ((result
2025 (if (buffer-live-p (ibuffer-current-buffer))
2026 (when (or (null group)
2027 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group)
2028 (equal group it)))
2029 (save-excursion
2030 (funcall function
2031 (ibuffer-current-buffer)
2032 (ibuffer-current-mark))))
2033 ;; Kill the line if the buffer is dead
2034 'kill)))
2035 ;; A given mapping function should return:
2036 ;; nil if it chose not to affect the buffer
2037 ;; `kill' means the remove line from the buffer list
2038 ;; t otherwise
2039 (cl-incf ibuffer-map-lines-total)
2040 (cond ((null result)
2041 (forward-line 1))
2042 ((eq result 'kill)
2043 (delete-region (line-beginning-position)
2044 (1+ (line-end-position)))
2045 (cl-incf ibuffer-map-lines-count)
2046 (when (< ibuffer-map-lines-total
2047 orig-target-line)
2048 (cl-decf target-line-offset)))
2049 (t
2050 (cl-incf ibuffer-map-lines-count)
2051 (forward-line 1)))))
2052 ibuffer-map-lines-count)
2053 (progn
2054 (setq buffer-read-only t)
2055 (unless nomodify
2056 (set-buffer-modified-p nil))
2057 (goto-char (point-min))
2058 (ibuffer-forward-line 0)
2059 (ibuffer-forward-line (1- target-line-offset))))))
2061 ;; Return buffers around current line.
2062 (defun ibuffer--near-buffers (n)
2063 (delq nil
2064 (mapcar
2065 (lambda (x)
2066 (car (get-text-property
2067 (line-beginning-position (if (natnump n) x (- (1- x))))
2068 'ibuffer-properties)))
2069 (number-sequence 1 (abs n)))))
2071 (defun ibuffer-get-marked-buffers ()
2072 "Return a list of buffer objects currently marked."
2073 (delq nil
2074 (mapcar (lambda (e)
2075 (when (eq (cdr e) ibuffer-marked-char)
2076 (car e)))
2077 (ibuffer-current-state-list))))
2079 (defun ibuffer-current-state-list (&optional pos)
2080 "Return a list like (BUF . MARK) of all buffers in an ibuffer.
2081 If POS is non-nil, return a list like (BUF MARK POINT), where POINT is
2082 the value of point at the beginning of the line for that buffer."
2083 (let ((ibuffer-current-state-list-tmp '()))
2084 ;; ah, if only we had closures. I bet this will mysteriously
2085 ;; break later. Don't blame me.
2086 (if pos
2087 (ibuffer-map-lines-nomodify
2088 (lambda (buf mark)
2089 (when (buffer-live-p buf)
2090 (push (list buf mark (point)) ibuffer-current-state-list-tmp))))
2091 (ibuffer-map-lines-nomodify
2092 (lambda (buf mark)
2093 (when (buffer-live-p buf)
2094 (push (cons buf mark) ibuffer-current-state-list-tmp)))))
2095 (nreverse ibuffer-current-state-list-tmp)))
2097 (defun ibuffer-current-buffers-with-marks (curbufs)
2098 "Return a list like (BUF . MARK) of all open buffers."
2099 (let ((bufs (ibuffer-current-state-list)))
2100 (mapcar (lambda (buf) (let ((e (assq buf bufs)))
2101 (if e
2102 e
2103 (cons buf ?\s))))
2104 curbufs)))
2106 (defun ibuffer-buf-matches-predicates (buf predicates)
2107 (let ((hit nil)
2108 (name (buffer-name buf)))
2109 (dolist (pred predicates)
2110 (when (if (stringp pred)
2111 (string-match pred name)
2112 (funcall pred buf))
2113 (setq hit t)))
2114 hit))
2116 (defun ibuffer-filter-buffers (ibuffer-buf last bmarklist all)
2117 (let ((ext-loaded (featurep 'ibuf-ext)))
2118 (delq nil
2119 (mapcar
2120 ;; element should be like (BUFFER . MARK)
2121 (lambda (e)
2122 (let* ((buf (car e)))
2123 (when
2124 ;; This takes precedence over anything else
2125 (or (and ibuffer-always-show-last-buffer
2126 (eq last buf))
2127 (funcall (if ext-loaded
2128 #'ibuffer-ext-visible-p
2129 #'ibuffer-visible-p)
2130 buf all ibuffer-buf))
2131 e)))
2132 bmarklist))))
2134 (defun ibuffer-visible-p (buf all &optional ibuffer-buf)
2135 (and (or all
2136 (not
2137 (ibuffer-buf-matches-predicates buf ibuffer-maybe-show-predicates)))
2138 (or ibuffer-view-ibuffer
2139 (and ibuffer-buf
2140 (not (eq ibuffer-buf buf))))))
2142 ;; This function is a special case; it's not defined by
2143 ;; `define-ibuffer-sorter'.
2144 (defun ibuffer-do-sort-by-recency ()
2145 "Sort the buffers by last view time."
2146 (interactive)
2147 (setq ibuffer-sorting-mode 'recency)
2148 (when (eq ibuffer-last-sorting-mode 'recency)
2149 (setq ibuffer-sorting-reversep (not ibuffer-sorting-reversep)))
2150 (ibuffer-update nil t)
2151 (setq ibuffer-last-sorting-mode 'recency))
2153 (defun ibuffer-update-format ()
2154 (when (null ibuffer-current-format)
2155 (setq ibuffer-current-format 0))
2156 (when (null ibuffer-formats)
2157 (error "Ibuffer error: no formats!")))
2159 (defun ibuffer-switch-format ()
2160 "Switch the current display format."
2161 (interactive)
2162 (ibuffer-assert-ibuffer-mode)
2163 (unless (consp ibuffer-formats)
2164 (error "Ibuffer error: No formats!"))
2165 (setq ibuffer-current-format
2166 (if (>= ibuffer-current-format (1- (length (ibuffer-current-formats nil))))
2167 0
2168 (1+ ibuffer-current-format)))
2169 (ibuffer-update-format)
2170 (ibuffer-redisplay t))
2172 (defun ibuffer-update-title-and-summary (format)
2173 (ibuffer-assert-ibuffer-mode)
2174 ;; Don't do funky font-lock stuff here
2175 (let ((inhibit-modification-hooks t))
2176 (if (get-text-property (point-min) 'ibuffer-title)
2177 (delete-region (point-min)
2178 (next-single-property-change
2179 (point-min) 'ibuffer-title)))
2180 (goto-char (point-min))
2181 (add-text-properties
2182 (point)
2183 (progn
2184 (let ((opos (point)))
2185 ;; Insert the title names.
2186 (dolist (element format)
2187 (insert
2188 (if (stringp element)
2189 element
2190 (pcase-let ((`(,sym ,min ,_max ,align) element))
2191 ;; Ignore a negative min when we're inserting the title
2192 (when (cl-minusp min)
2193 (setq min (- min)))
2194 (let* ((name (or (get sym 'ibuffer-column-name)
2195 (error "Unknown column %s in ibuffer-formats" sym)))
2196 (len (length name))
2197 (hmap (get sym 'header-mouse-map))
2198 (strname (if (< len min)
2199 (ibuffer-format-column name
2200 (- min len)
2201 align)
2202 name)))
2203 (when hmap
2204 (setq
2205 strname
2206 (propertize strname 'mouse-face 'highlight 'keymap hmap)))
2207 strname)))))
2208 (add-text-properties opos (point) `(ibuffer-title-header t))
2210 ;; Add the underlines
2211 (let ((str (save-excursion
2212 (forward-line -1)
2213 (beginning-of-line)
2214 (buffer-substring (point) (line-end-position)))))
2215 (apply #'insert (mapcar
2216 (lambda (c)
2217 (if (not (or (eq c ?\s)
2219 ?-
2220 ?\s))
2221 str)))
2223 (point))
2224 `(ibuffer-title t font-lock-face ,ibuffer-title-face))
2225 ;; Now, insert the summary columns.
2226 (goto-char (point-max))
2227 (if (get-text-property (1- (point-max)) 'ibuffer-summary)
2228 (delete-region (previous-single-property-change
2229 (point-max) 'ibuffer-summary)
2230 (point-max)))
2231 (if ibuffer-display-summary
2232 (add-text-properties
2233 (point)
2234 (progn
2236 (dolist (element format)
2237 (insert
2238 (if (stringp element)
2239 (make-string (length element) ?\s)
2240 (pcase-let ((`(,sym ,min ,_max ,align) element))
2241 ;; Ignore a negative min when we're inserting the title.
2242 (when (cl-minusp min)
2243 (setq min (- min)))
2244 (let* ((summary
2245 (if (get sym 'ibuffer-column-summarizer)
2246 (funcall (get sym 'ibuffer-column-summarizer)
2247 (get sym 'ibuffer-column-summary))
2248 (make-string
2249 (length (get sym 'ibuffer-column-name))
2250 ?\s)))
2251 (len (length summary)))
2252 (if (< len min)
2253 (ibuffer-format-column summary
2254 (- min len)
2255 align)
2256 summary))))))
2257 (point))
2258 `(ibuffer-summary t)))))
2261 (defun ibuffer-redisplay (&optional silent)
2262 "Redisplay the current list of buffers.
2263 This does not show new buffers; use `ibuffer-update' for that.
2265 If optional arg SILENT is non-nil, do not display progress messages."
2266 (interactive)
2267 (ibuffer-forward-line 0)
2268 (unless silent
2269 (message "Redisplaying current buffer list..."))
2270 (let ((blist (ibuffer-current-state-list)))
2271 (when (and (null blist)
2272 (featurep 'ibuf-ext)
2273 (or ibuffer-filtering-qualifiers ibuffer-hidden-filter-groups))
2274 (message "No buffers! (note: filtering in effect)"))
2275 (ibuffer-redisplay-engine blist t)
2276 (unless silent
2277 (message "Redisplaying current buffer list...done"))
2278 (ibuffer-forward-line 0)))
2280 (defun ibuffer-update (arg &optional silent)
2281 "Regenerate the list of all buffers.
2283 Prefix arg non-nil means to toggle whether buffers that match
2284 `ibuffer-maybe-show-predicates' should be displayed.
2286 If optional arg SILENT is non-nil, do not display progress messages."
2287 (interactive "P")
2288 (if arg
2289 (setq ibuffer-display-maybe-show-predicates
2290 (not ibuffer-display-maybe-show-predicates)))
2291 (ibuffer-forward-line 0)
2292 (let* ((bufs (buffer-list))
2293 (blist (ibuffer-filter-buffers
2294 (current-buffer)
2295 (if (and
2296 (cadr bufs)
2297 (eq ibuffer-always-show-last-buffer
2298 :nomini)
2299 (minibufferp (cadr bufs)))
2300 (nth 2 bufs)
2301 (cadr bufs))
2302 (ibuffer-current-buffers-with-marks bufs)
2303 ibuffer-display-maybe-show-predicates)))
2304 (and (null blist)
2305 (featurep 'ibuf-ext)
2306 ibuffer-filtering-qualifiers
2307 (message "No buffers! (note: filtering in effect)"))
2308 (unless silent
2309 (message "Updating buffer list..."))
2310 (ibuffer-redisplay-engine blist arg)
2311 (unless silent
2312 (message "Updating buffer list...done")))
2313 (if (eq ibuffer-shrink-to-minimum-size 'onewindow)
2314 (ibuffer-shrink-to-fit t)
2315 (when ibuffer-shrink-to-minimum-size
2316 (ibuffer-shrink-to-fit)))
2317 (ibuffer-forward-line 0)
2318 ;; I tried to update this automatically from the mode-line-process format,
2319 ;; but changing nil-ness of header-line-format while computing
2320 ;; mode-line-format is asking a bit too much it seems. --Stef
2321 (setq header-line-format
2322 (and ibuffer-use-header-line
2323 ibuffer-filtering-qualifiers
2324 ibuffer-header-line-format)))
2326 (defun ibuffer-sort-bufferlist (bmarklist)
2327 (unless ibuffer-sorting-functions-alist
2328 ;; make sure the sorting functions are loaded
2329 (require 'ibuf-ext))
2330 (let* ((sortdat (assq ibuffer-sorting-mode
2331 ibuffer-sorting-functions-alist))
2332 (func (nth 2 sortdat)))
2333 (let ((result
2334 ;; actually sort the buffers
2335 (if (and sortdat func)
2336 (sort bmarklist func)
2337 bmarklist)))
2338 ;; perhaps reverse the sorted buffer list
2339 (if ibuffer-sorting-reversep
2340 (nreverse result)
2341 result))))
2343 (defun ibuffer-insert-filter-group (name display-name filter-string format bmarklist)
2344 (add-text-properties
2345 (point)
2346 (progn
2347 (insert "[ " display-name " ]")
2348 (point))
2349 `(ibuffer-filter-group-name
2350 ,name
2351 font-lock-face ,ibuffer-filter-group-name-face
2352 keymap ,ibuffer-mode-filter-group-map
2353 mouse-face highlight
2354 help-echo ,(let ((echo '(if tooltip-mode
2356 "mouse-1: toggle marks mouse-2: hide/show")))
2357 (if (> (length filter-string) 0)
2358 `(concat ,filter-string
2360 ,echo)
2361 echo))))
2363 (when bmarklist
2364 (put-text-property
2365 (point)
2366 (progn
2367 (dolist (entry bmarklist)
2368 (ibuffer-insert-buffer-line (car entry) (cdr entry) format))
2369 (point))
2370 'ibuffer-filter-group
2371 name)))
2373 (defun ibuffer-redisplay-engine (bmarklist &optional _ignore)
2374 (ibuffer-assert-ibuffer-mode)
2375 (let* ((--ibuffer-insert-buffers-and-marks-format
2376 (ibuffer-current-format))
2377 (--ibuffer-expanded-format (mapcar #'ibuffer-expand-format-entry
2378 (ibuffer-current-format t)))
2379 (orig (count-lines (point-min) (point)))
2380 ;; Inhibit font-lock caching tricks, since we're modifying the
2381 ;; entire buffer at once
2382 (inhibit-modification-hooks t)
2383 (ext-loaded (featurep 'ibuf-ext))
2384 (bgroups (if ext-loaded
2385 (ibuffer-generate-filter-groups bmarklist)
2386 (list (cons "Default" bmarklist)))))
2387 (ibuffer-clear-summary-columns --ibuffer-expanded-format)
2388 (unwind-protect
2389 (progn
2390 (setq buffer-read-only nil)
2391 (erase-buffer)
2392 (ibuffer-update-format)
2393 (dolist (group (nreverse bgroups))
2394 (let* ((name (car group))
2395 (disabled (and ext-loaded
2396 (member name ibuffer-hidden-filter-groups)))
2397 (bmarklist (cdr group)))
2398 (unless (and (null bmarklist)
2399 (not disabled)
2400 ext-loaded
2401 (null ibuffer-show-empty-filter-groups))
2402 (ibuffer-insert-filter-group
2403 name
2404 (if disabled (concat name " ...") name)
2405 (if ext-loaded
2406 (ibuffer-format-filter-group-data name)
2407 "")
2408 --ibuffer-insert-buffers-and-marks-format
2409 (if disabled
2410 nil
2411 (ibuffer-sort-bufferlist bmarklist))))))
2412 (ibuffer-update-title-and-summary --ibuffer-expanded-format))
2413 (setq buffer-read-only t)
2414 (set-buffer-modified-p ibuffer-did-modification)
2415 (setq ibuffer-did-modification nil)
2416 (goto-char (point-min))
2417 (forward-line orig))))
2419 ;;;###autoload
2420 (defun ibuffer-list-buffers (&optional files-only)
2421 "Display a list of buffers, in another window.
2422 If optional argument FILES-ONLY is non-nil, then add a filter for
2423 buffers which are visiting a file."
2424 (interactive "P")
2425 (ibuffer t nil (when files-only
2426 '((filename . ".*"))) t))
2428 ;;;###autoload
2429 (defun ibuffer-other-window (&optional files-only)
2430 "Like `ibuffer', but displayed in another window by default.
2431 If optional argument FILES-ONLY is non-nil, then add a filter for
2432 buffers which are visiting a file."
2433 (interactive "P")
2434 (ibuffer t nil (when files-only
2435 '((filename . ".*")))))
2437 ;;;###autoload
2438 (defun ibuffer (&optional other-window-p name qualifiers noselect
2439 shrink filter-groups formats)
2440 "Begin using Ibuffer to edit a list of buffers.
2441 Type `h' after entering ibuffer for more information.
2443 All arguments are optional.
2444 OTHER-WINDOW-P says to use another window.
2446 QUALIFIERS is an initial set of filtering qualifiers to use;
2447 see `ibuffer-filtering-qualifiers'.
2448 NOSELECT means don't select the Ibuffer buffer.
2449 SHRINK means shrink the buffer to minimal size. The special
2450 value `onewindow' means always use another window.
2451 FILTER-GROUPS is an initial set of filtering groups to use;
2452 see `ibuffer-filter-groups'.
2453 FORMATS is the value to use for `ibuffer-formats'.
2454 If specified, then the variable `ibuffer-formats' will have
2455 that value locally in this buffer."
2456 (interactive "P")
2457 (when ibuffer-use-other-window
2458 (setq other-window-p t))
2459 (let ((buf (get-buffer-create (or name "*Ibuffer*"))))
2460 (if other-window-p
2461 (or (and noselect (display-buffer buf t))
2462 (pop-to-buffer buf t))
2463 (funcall (if noselect #'display-buffer #'switch-to-buffer) buf))
2464 (with-current-buffer buf
2465 (save-selected-window
2466 ;; We switch to the buffer's window in order to be able
2467 ;; to modify the value of point
2468 (select-window (get-buffer-window buf 0))
2469 (or (derived-mode-p 'ibuffer-mode)
2470 (ibuffer-mode))
2471 (when shrink
2472 (setq ibuffer-shrink-to-minimum-size shrink))
2473 (when qualifiers
2474 (require 'ibuf-ext)
2475 (setq ibuffer-filtering-qualifiers qualifiers))
2476 (when filter-groups
2477 (require 'ibuf-ext)
2478 (setq ibuffer-filter-groups filter-groups))
2479 (when formats
2480 (set (make-local-variable 'ibuffer-formats) formats))
2481 (ibuffer-update nil)
2482 ;; Skip the group name by default.
2483 (ibuffer-forward-line 0 t)
2484 (unwind-protect
2485 (progn
2486 (setq buffer-read-only nil)
2487 (run-hooks 'ibuffer-hook))
2488 (setq buffer-read-only t))
2489 (unless ibuffer-expert
2490 (message "Commands: m, u, t, RET, g, k, S, D, Q; q to quit; h for help"))))))
2492 ;;;###autoload
2493 (defun ibuffer-jump (&optional other-window)
2494 "Call Ibuffer and set point at the line listing the current buffer.
2495 If optional arg OTHER-WINDOW is non-nil, then use another window."
2496 (interactive "P")
2497 (let ((name (buffer-name)))
2498 (ibuffer other-window)
2499 (ignore-errors (ibuffer-jump-to-buffer name))))
2501 (put 'ibuffer-mode 'mode-class 'special)
2502 (define-derived-mode ibuffer-mode special-mode "IBuffer"
2503 "A major mode for viewing a list of buffers.
2504 In Ibuffer, you can conveniently perform many operations on the
2505 currently open buffers, in addition to filtering your view to a
2506 particular subset of them, and sorting by various criteria.
2508 Operations on marked buffers:
2520 buffers.
2525 a given regexp (like the function `occur').
2527 buffers to a shell command.
2529 buffers with the output of a shell command.
2531 buffer's file as an argument.
2533 is a very flexible command. For example, if you want to make all
2534 of the marked buffers read only, try using (read-only-mode 1) as
2535 the input form.
2537 is evaluated.
2539 but don't kill the associated buffer.
2542 Marking commands:
2546 all unmarked buffers.
2550 previous line.
2555 This means that the buffer is modified, and has an associated file.
2557 regardless of whether or not they have an associated file.
2559 ends with `*'.
2561 an associated file, but that file doesn't currently exist.
2573 Filtering commands:
2601 Filter group commands:
2612 Sorting commands:
2622 Other commands:
2625 Prefix arg means to toggle whether buffers that match
2626 `ibuffer-maybe-show-predicates' should be displayed.
2633 and its associated file.
2637 the new window.
2640 ** Information on Filtering:
2642 You can filter your ibuffer view via different criteria. Each Ibuffer
2643 buffer has its own stack of active filters. For example, suppose you
2644 are working on an Emacs Lisp project. You can create an Ibuffer
2645 buffer displays buffers in just `emacs-lisp' modes via
2647 is just one entry on the filtering stack.
2649 You can also combine filters. The various filtering commands push a
2650 new filter onto the stack, and the filters combine to show just
2651 buffers which satisfy ALL criteria on the stack. For example, suppose
2652 you only want to see buffers in `emacs-lisp' mode, whose names begin
2658 Additionally, you can OR the top two filters together with
2660 `emacs-lisp-mode' or `lisp-interaction-mode', type:
2666 Filters can also be saved and restored using mnemonic names: see the
2667 functions `ibuffer-save-filters' and `ibuffer-switch-to-saved-filters'.
2670 to disable all filtering currently in effect, use
2673 ** Filter Groups:
2677 match a filter, which are displayed together in an Ibuffer buffer. To
2678 create a filter group, simply use the regular functions to create a
2681 A quick example will make things clearer. Suppose that one wants to
2682 group all of one's Emacs Lisp buffers together. To do this, type:
2687 You may, of course, name the group whatever you want; it doesn't have
2689 arbitrary combination of filters.
2691 Just like filters themselves, filter groups act as a stack. Buffers
2692 will not be displayed multiple times if they would be included in
2693 multiple filter groups; instead, the first filter group is used. The
2694 filter groups are displayed in this order of precedence.
2696 You may rearrange filter groups by using the regular
2698 will be inserted before the group at point."
2699 ;; Include state info next to the mode name.
2700 (set (make-local-variable 'mode-line-process)
2701 '(" by "
2702 (ibuffer-sorting-mode (:eval (symbol-name ibuffer-sorting-mode))
2703 "view time")
2704 (ibuffer-sorting-reversep " [rev]")
2705 (ibuffer-auto-mode " (Auto)")
2706 ;; Only list the filters if they're not already in the header-line.
2707 (header-line-format
2708 ""
2709 (:eval (if (functionp 'ibuffer-format-qualifier)
2710 (mapconcat 'ibuffer-format-qualifier
2711 ibuffer-filtering-qualifiers ""))))))
2712 ;; `ibuffer-update' puts this on header-line-format when needed.
2713 (setq ibuffer-header-line-format
2714 ;; Display the part that won't be in the mode-line.
2715 `("" ,mode-name
2716 ,@(mapcar (lambda (elem)
2717 (if (eq (car-safe elem) 'header-line-format)
2718 (nth 2 elem) elem))
2719 mode-line-process)))
2721 (setq buffer-read-only t)
2722 (buffer-disable-undo)
2723 (setq truncate-lines ibuffer-truncate-lines)
2724 ;; This makes things less ugly for Emacs 21 users with a non-nil
2725 ;; `show-trailing-whitespace'.
2726 (setq show-trailing-whitespace nil)
2727 ;; disable `show-paren-mode' buffer-locally
2728 (if (bound-and-true-p show-paren-mode)
2729 (set (make-local-variable 'show-paren-mode) nil))
2730 (set (make-local-variable 'revert-buffer-function)
2731 #'ibuffer-update)
2732 (set (make-local-variable 'ibuffer-sorting-mode)
2733 ibuffer-default-sorting-mode)
2734 (set (make-local-variable 'ibuffer-sorting-reversep)
2735 ibuffer-default-sorting-reversep)
2736 (set (make-local-variable 'ibuffer-shrink-to-minimum-size)
2737 ibuffer-default-shrink-to-minimum-size)
2738 (set (make-local-variable 'ibuffer-display-maybe-show-predicates)
2739 ibuffer-default-display-maybe-show-predicates)
2740 (set (make-local-variable 'ibuffer-filtering-qualifiers) nil)
2741 (set (make-local-variable 'ibuffer-filter-groups) nil)
2742 (set (make-local-variable 'ibuffer-filter-group-kill-ring) nil)
2743 (set (make-local-variable 'ibuffer-hidden-filter-groups) nil)
2744 (set (make-local-variable 'ibuffer-compiled-formats) nil)
2745 (set (make-local-variable 'ibuffer-cached-formats) nil)
2746 (set (make-local-variable 'ibuffer-cached-eliding-string) nil)
2747 (set (make-local-variable 'ibuffer-current-format) nil)
2748 (set (make-local-variable 'ibuffer-did-modification) nil)
2749 (set (make-local-variable 'ibuffer-tmp-hide-regexps) nil)
2750 (set (make-local-variable 'ibuffer-tmp-show-regexps) nil)
2751 (define-key ibuffer-mode-map [menu-bar edit] 'undefined)
2752 (define-key ibuffer-mode-map [menu-bar operate] (cons "Operate" ibuffer-mode-operate-map))
2753 (ibuffer-update-format)
2754 (when ibuffer-default-directory
2755 (setq default-directory ibuffer-default-directory))
2756 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t))
2758 (provide 'ibuffer)
2760 (run-hooks 'ibuffer-load-hook)
2762 ;;; ibuffer.el ends here