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