(ibuffer-last-sorting-mode): New variable.
[bpt/emacs.git] / lisp / ibuf-macs.el
CommitLineData
25d2f683
CW
1;;; ibuf-macs.el --- macros for ibuffer
2
0d30b337 3;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
409cc4a3 4;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
25d2f683
CW
5
6;; Author: Colin Walters <walters@verbum.org>
4e4a724c 7;; Maintainer: John Paul Wallington <jpw@gnu.org>
25d2f683 8;; Created: 6 Dec 2001
25d2f683
CW
9;; Keywords: buffer, convenience
10
76649361 11;; This file is part of GNU Emacs.
25d2f683
CW
12
13;; This program is free software; you can redistribute it and/or
14;; modify it under the terms of the GNU General Public License as
b4aa6026 15;; published by the Free Software Foundation; either version 3, or (at
25d2f683
CW
16;; your option) any later version.
17
18;; This program is distributed in the hope that it will be useful, but
19;; WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21;; General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
24;; along with this program ; see the file COPYING. If not, write to
086add15
LK
25;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
25d2f683 27
30764597
PJ
28;;; Commentary:
29
25d2f683
CW
30;;; Code:
31
00332656
CW
32(eval-when-compile
33 (require 'cl))
34
25d2f683
CW
35;; From Paul Graham's "ANSI Common Lisp", adapted for Emacs Lisp here.
36(defmacro ibuffer-aif (test true-body &rest false-body)
37 "Evaluate TRUE-BODY or FALSE-BODY depending on value of TEST.
38If TEST returns non-nil, bind `it' to the value, and evaluate
39TRUE-BODY. Otherwise, evaluate forms in FALSE-BODY as if in `progn'.
40Compare with `if'."
28528604 41 (let ((sym (make-symbol "ibuffer-aif-sym")))
25d2f683
CW
42 `(let ((,sym ,test))
43 (if ,sym
44 (let ((it ,sym))
45 ,true-body)
46 (progn
47 ,@false-body)))))
48;; (put 'ibuffer-aif 'lisp-indent-function 2)
49
50(defmacro ibuffer-awhen (test &rest body)
51 "Evaluate BODY if TEST returns non-nil.
52During evaluation of body, bind `it' to the value returned by TEST."
53 `(ibuffer-aif ,test
54 (progn ,@body)
55 nil))
56;; (put 'ibuffer-awhen 'lisp-indent-function 1)
57
58(defmacro ibuffer-save-marks (&rest body)
59 "Save the marked status of the buffers and execute BODY; restore marks."
28528604 60 (let ((bufsym (make-symbol "bufsym")))
25d2f683
CW
61 `(let ((,bufsym (current-buffer))
62 (ibuffer-save-marks-tmp-mark-list (ibuffer-current-state-list)))
63 (unwind-protect
64 (progn
65 (save-excursion
66 ,@body))
67 (with-current-buffer ,bufsym
76649361 68 (ibuffer-redisplay-engine
25d2f683
CW
69 ;; Get rid of dead buffers
70 (delq nil
71 (mapcar #'(lambda (e) (when (buffer-live-p (car e))
72 e))
73 ibuffer-save-marks-tmp-mark-list)))
74 (ibuffer-redisplay t))))))
75;; (put 'ibuffer-save-marks 'lisp-indent-function 0)
76
77;;;###autoload
f0b31589
DN
78(defmacro* define-ibuffer-column (symbol (&key name inline props summarizer
79 header-mouse-map) &rest body)
25d2f683
CW
80 "Define a column SYMBOL for use with `ibuffer-formats'.
81
82BODY will be called with `buffer' bound to the buffer object, and
1bb57048
CW
83`mark' bound to the current mark on the buffer. The original ibuffer
84buffer will be bound to `ibuffer-buf'.
25d2f683
CW
85
86If NAME is given, it will be used as a title for the column.
87Otherwise, the title will default to a capitalized version of the
88SYMBOL's name. PROPS is a plist of additional properties to add to
1255dfe6
CW
89the text, such as `mouse-face'. And SUMMARIZER, if given, is a
90function which will be passed a list of all the strings in its column;
91it should return a string to display at the bottom.
25d2f683 92
b641fbd7
DN
93If HEADER-MOUSE-MAP is given, it will be used as a keymap for the
94title of the column.
95
25d2f683
CW
96Note that this macro expands into a `defun' for a function named
97ibuffer-make-column-NAME. If INLINE is non-nil, then the form will be
98inlined into the compiled format versions. This means that if you
99change its definition, you should explicitly call
9bb69f45
JB
100`ibuffer-recompile-formats'.
101
102\(fn SYMBOL (&key NAME INLINE PROPS SUMMARIZER) &rest BODY)"
25d2f683
CW
103 (let* ((sym (intern (concat "ibuffer-make-column-"
104 (symbol-name symbol))))
ceb44935 105 (bod-1 `(with-current-buffer buffer
25d2f683
CW
106 ,@body))
107 (bod (if props
108 `(propertize
109 ,bod-1
110 ,@props)
111 bod-1)))
112 `(progn
113 ,(if inline
114 `(push '(,sym ,bod) ibuffer-inline-columns)
d62920ca 115 `(defun ,sym (buffer mark)
25d2f683
CW
116 ,bod))
117 (put (quote ,sym) 'ibuffer-column-name
118 ,(if (stringp name)
119 name
120 (capitalize (symbol-name symbol))))
f0b31589 121 ,(if header-mouse-map `(put (quote ,sym) 'header-mouse-map ,header-mouse-map))
1255dfe6 122 ,(if summarizer
ceb44935 123 ;; Store the name of the summarizing function.
1255dfe6
CW
124 `(put (quote ,sym) 'ibuffer-column-summarizer
125 (quote ,summarizer)))
126 ,(if summarizer
ceb44935
CW
127 ;; This will store the actual values of the column
128 ;; summary.
129 `(put (quote ,sym) 'ibuffer-column-summary nil))
25d2f683
CW
130 :autoload-end)))
131;; (put 'define-ibuffer-column 'lisp-indent-function 'defun)
132
133;;;###autoload
134(defmacro* define-ibuffer-sorter (name documentation
71296446 135 (&key
25d2f683
CW
136 description)
137 &rest body)
138 "Define a method of sorting named NAME.
139DOCUMENTATION is the documentation of the function, which will be called
140`ibuffer-do-sort-by-NAME'.
141DESCRIPTION is a short string describing the sorting method.
142
143For sorting, the forms in BODY will be evaluated with `a' bound to one
144buffer object, and `b' bound to another. BODY should return a non-nil
9bb69f45
JB
145value if and only if `a' is \"less than\" `b'.
146
147\(fn NAME DOCUMENTATION (&key DESCRIPTION) &rest BODY)"
25d2f683
CW
148 `(progn
149 (defun ,(intern (concat "ibuffer-do-sort-by-" (symbol-name name))) ()
150 ,(or documentation "No :documentation specified for this sorting method.")
151 (interactive)
152 (setq ibuffer-sorting-mode ',name)
153 (ibuffer-redisplay t))
154 (push (list ',name ,description
155 #'(lambda (a b)
156 ,@body))
157 ibuffer-sorting-functions-alist)
158 :autoload-end))
159;; (put 'define-ibuffer-sorter 'lisp-indent-function 1)
160
161;;;###autoload
162(defmacro* define-ibuffer-op (op args
163 documentation
71296446 164 (&key
25d2f683
CW
165 interactive
166 mark
167 modifier-p
168 dangerous
169 (opstring "operated on")
170 (active-opstring "Operate on")
171 complex)
172 &rest body)
1bb57048
CW
173 "Generate a function which operates on a buffer.
174OP becomes the name of the function; if it doesn't begin with
175`ibuffer-do-', then that is prepended to it.
25d2f683
CW
176When an operation is performed, this function will be called once for
177each marked buffer, with that buffer current.
178
179ARGS becomes the formal parameters of the function.
180DOCUMENTATION becomes the docstring of the function.
181INTERACTIVE becomes the interactive specification of the function.
182MARK describes which type of mark (:deletion, or nil) this operation
183uses. :deletion means the function operates on buffers marked for
184deletion, otherwise it acts on normally marked buffers.
185MODIFIER-P describes how the function modifies buffers. This is used
186to set the modification flag of the Ibuffer buffer itself. Valid
187values are:
188 nil - the function never modifiers buffers
189 t - the function it always modifies buffers
190 :maybe - attempt to discover this information by comparing the
191 buffer's modification flag.
192DANGEROUS is a boolean which should be set if the user should be
193prompted before performing this operation.
194OPSTRING is a string which will be displayed to the user after the
195operation is complete, in the form:
196 \"Operation complete; OPSTRING x buffers\"
197ACTIVE-OPSTRING is a string which will be displayed to the user in a
198confirmation message, in the form:
199 \"Really ACTIVE-OPSTRING x buffers?\"
200COMPLEX means this function is special; see the source code of this
9bb69f45
JB
201macro for exactly what it does.
202
203\(fn OP ARGS DOCUMENTATION (&key INTERACTIVE MARK MODIFIER-P DANGEROUS OPSTRING ACTIVE-OPSTRING COMPLEX) &rest BODY)"
25d2f683 204 `(progn
1bb57048
CW
205 (defun ,(intern (concat (if (string-match "^ibuffer-do" (symbol-name op))
206 "" "ibuffer-do-") (symbol-name op)))
207 ,args
25d2f683
CW
208 ,(if (stringp documentation)
209 documentation
210 (format "%s marked buffers." active-opstring))
211 ,(if (not (null interactive))
212 `(interactive ,interactive)
213 '(interactive))
214 (assert (eq major-mode 'ibuffer-mode))
215 (setq ibuffer-did-modification nil)
216 (let ((marked-names (,(case mark
217 (:deletion
218 'ibuffer-deletion-marked-buffer-names)
219 (t
220 'ibuffer-marked-buffer-names)))))
221 (when (null marked-names)
222 (setq marked-names (list (buffer-name (ibuffer-current-buffer))))
223 (ibuffer-set-mark ,(case mark
224 (:deletion
225 'ibuffer-deletion-char)
226 (t
227 'ibuffer-marked-char))))
228 ,(let* ((finish (append
229 '(progn)
230 (if (eq modifier-p t)
231 '((setq ibuffer-did-modification t))
232 ())
233 `((ibuffer-redisplay t)
234 (message ,(concat "Operation finished; " opstring " %s buffers") count))))
235 (inner-body (if complex
236 `(progn ,@body)
237 `(progn
238 (with-current-buffer buf
239 (save-excursion
240 ,@body))
241 t)))
242 (body `(let ((count
243 (,(case mark
244 (:deletion
245 'ibuffer-map-deletion-lines)
246 (t
247 'ibuffer-map-marked-lines))
bde57911 248 #'(lambda (buf mark)
25d2f683
CW
249 ,(if (eq modifier-p :maybe)
250 `(let ((ibuffer-tmp-previous-buffer-modification
251 (buffer-modified-p buf)))
252 (prog1 ,inner-body
253 (when (not (eq ibuffer-tmp-previous-buffer-modification
254 (buffer-modified-p buf)))
255 (setq ibuffer-did-modification t))))
256 inner-body)))))
257 ,finish)))
258 (if dangerous
259 `(when (ibuffer-confirm-operation-on ,active-opstring marked-names)
260 ,body)
261 body))))
262 :autoload-end))
263;; (put 'define-ibuffer-op 'lisp-indent-function 2)
264
265;;;###autoload
266(defmacro* define-ibuffer-filter (name documentation
71296446 267 (&key
25d2f683
CW
268 reader
269 description)
270 &rest body)
271 "Define a filter named NAME.
272DOCUMENTATION is the documentation of the function.
273READER is a form which should read a qualifier from the user.
274DESCRIPTION is a short string describing the filter.
275
276BODY should contain forms which will be evaluated to test whether or
277not a particular buffer should be displayed or not. The forms in BODY
278will be evaluated with BUF bound to the buffer object, and QUALIFIER
9bb69f45
JB
279bound to the current value of the filter.
280
281\(fn NAME DOCUMENTATION (&key READER DESCRIPTION) &rest BODY)"
25d2f683 282 (let ((fn-name (intern (concat "ibuffer-filter-by-" (symbol-name name)))))
71296446 283 `(progn
25d2f683
CW
284 (defun ,fn-name (qualifier)
285 ,(concat (or documentation "This filter is not documented."))
286 (interactive (list ,reader))
287 (ibuffer-push-filter (cons ',name qualifier))
8a26c165 288 (message "%s"
25d2f683
CW
289 (format ,(concat (format "Filter by %s added: " description)
290 " %s")
291 qualifier))
292 (ibuffer-update nil t))
293 (push (list ',name ,description
294 #'(lambda (buf qualifier)
295 ,@body))
296 ibuffer-filtering-alist)
297 :autoload-end)))
298;; (put 'define-ibuffer-filter 'lisp-indent-function 2)
299
300(provide 'ibuf-macs)
301
cbee283d 302;; arch-tag: 2748edce-82c9-4cd9-9d9d-bd73e43c20c5
25d2f683 303;;; ibuf-macs.el ends here