]> code.delx.au - gnu-emacs/blob - lisp/emacs-lisp/ewoc.el
2005-09-24 Emilio C. Lopes <eclig@gmx.net>
[gnu-emacs] / lisp / emacs-lisp / ewoc.el
1 ;;; ewoc.el --- utility to maintain a view of a list of objects in a buffer
2
3 ;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5
6 ;; Author: Per Cederqvist <ceder@lysator.liu.se>
7 ;; Inge Wallin <inge@lysator.liu.se>
8 ;; Maintainer: monnier@gnu.org
9 ;; Created: 3 Aug 1992
10 ;; Keywords: extensions, lisp
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
28
29 ;;; Commentary:
30
31 ;; Ewoc Was Once Cookie
32 ;; But now it's Emacs' Widget for Object Collections
33
34 ;; As the name implies this derives from the `cookie' package (part
35 ;; of Elib). The changes are pervasive though mostly superficial:
36
37 ;; - uses CL (and its `defstruct')
38 ;; - separate from Elib.
39 ;; - uses its own version of a doubly-linked list which allows us
40 ;; to merge the elib-wrapper and the elib-node structures into ewoc-node
41 ;; - dropping functions not used by PCL-CVS (the only client of ewoc at the
42 ;; time of writing)
43 ;; - removing unused arguments
44 ;; - renaming:
45 ;; elib-node ==> ewoc--node
46 ;; collection ==> ewoc
47 ;; tin ==> ewoc--node
48 ;; cookie ==> data or element or elem
49
50 ;; Introduction
51 ;; ============
52 ;;
53 ;; Ewoc is a package that implements a connection between an
54 ;; dll (a doubly linked list) and the contents of a buffer.
55 ;; Possible uses are dired (have all files in a list, and show them),
56 ;; buffer-list, kom-prioritize (in the LysKOM elisp client) and
57 ;; others. pcl-cvs.el uses ewoc.el.
58 ;;
59 ;; Ewoc can be considered as the `view' part of a model-view-controller.
60 ;;
61 ;; A `element' can be any lisp object. When you use the ewoc
62 ;; package you specify a pretty-printer, a function that inserts
63 ;; a printable representation of the element in the buffer. (The
64 ;; pretty-printer should use "insert" and not
65 ;; "insert-before-markers").
66 ;;
67 ;; A `ewoc' consists of a doubly linked list of elements, a
68 ;; header, a footer and a pretty-printer. It is displayed at a
69 ;; certain point in a certain buffer. (The buffer and point are
70 ;; fixed when the ewoc is created). The header and the footer
71 ;; are constant strings. They appear before and after the elements.
72 ;;
73 ;; Ewoc does not affect the mode of the buffer in any way. It
74 ;; merely makes it easy to connect an underlying data representation
75 ;; to the buffer contents.
76 ;;
77 ;; A `ewoc--node' is an object that contains one element. There are
78 ;; functions in this package that given an ewoc--node extract the data, or
79 ;; give the next or previous ewoc--node. (All ewoc--nodes are linked together
80 ;; in a doubly linked list. The `previous' ewoc--node is the one that appears
81 ;; before the other in the buffer.) You should not do anything with
82 ;; an ewoc--node except pass it to the functions in this package.
83 ;;
84 ;; An ewoc is a very dynamic thing. You can easily add or delete elements.
85 ;; You can apply a function to all elements in an ewoc, etc, etc.
86 ;;
87 ;; Remember that an element can be anything. Your imagination is the
88 ;; limit! It is even possible to have another ewoc as an
89 ;; element. In that way some kind of tree hierarchy can be created.
90 ;;
91 ;; Full documentation will, God willing, soon be available in a
92 ;; Texinfo manual.
93
94 ;; In the mean time `grep '^(.*ewoc-[^-]' emacs-lisp/ewoc.el' can help
95 ;; you find all the exported functions:
96 ;;
97 ;; (defun ewoc-create (pretty-printer &optional header footer)
98 ;; (defalias 'ewoc-data 'ewoc--node-data)
99 ;; (defun ewoc-location (node)
100 ;; (defun ewoc-enter-first (ewoc data)
101 ;; (defun ewoc-enter-last (ewoc data)
102 ;; (defun ewoc-enter-after (ewoc node data)
103 ;; (defun ewoc-enter-before (ewoc node data)
104 ;; (defun ewoc-next (ewoc node)
105 ;; (defun ewoc-prev (ewoc node)
106 ;; (defun ewoc-nth (ewoc n)
107 ;; (defun ewoc-map (map-function ewoc &rest args)
108 ;; (defun ewoc-filter (ewoc predicate &rest args)
109 ;; (defun ewoc-locate (ewoc &optional pos guess)
110 ;; (defun ewoc-invalidate (ewoc &rest nodes)
111 ;; (defun ewoc-goto-prev (ewoc arg)
112 ;; (defun ewoc-goto-next (ewoc arg)
113 ;; (defun ewoc-goto-node (ewoc node)
114 ;; (defun ewoc-refresh (ewoc)
115 ;; (defun ewoc-collect (ewoc predicate &rest args)
116 ;; (defun ewoc-buffer (ewoc)
117 ;; (defun ewoc-get-hf (ewoc)
118 ;; (defun ewoc-set-hf (ewoc header footer)
119
120 ;; Coding conventions
121 ;; ==================
122 ;;
123 ;; All functions of course start with `ewoc'. Functions and macros
124 ;; starting with the prefix `ewoc--' are meant for internal use,
125 ;; while those starting with `ewoc-' are exported for public use.
126 ;; There are currently no global or buffer-local variables used.
127
128
129 ;;; Code:
130
131 (eval-when-compile (require 'cl)) ;because of CL compiler macros
132
133 ;; The doubly linked list is implemented as a circular list
134 ;; with a dummy node first and last. The dummy node is used as
135 ;; "the dll" (or rather is the dll handle passed around).
136
137 (defstruct (ewoc--node
138 (:type vector) ;required for ewoc--node-branch hack
139 (:constructor ewoc--node-create (start-marker data)))
140 left right data start-marker)
141
142 (defalias 'ewoc--node-branch 'aref
143 "Get the left (CHILD=0) or right (CHILD=1) child of the NODE.
144
145 \(fn NODE CHILD)")
146
147 (defun ewoc--dll-create ()
148 "Create an empty doubly linked list."
149 (let ((dummy-node (ewoc--node-create 'DL-LIST 'DL-LIST)))
150 (setf (ewoc--node-right dummy-node) dummy-node)
151 (setf (ewoc--node-left dummy-node) dummy-node)
152 dummy-node))
153
154 (defun ewoc--node-enter-before (node elemnode)
155 "Insert ELEMNODE before NODE in a DLL."
156 (assert (and (null (ewoc--node-left elemnode)) (null (ewoc--node-right elemnode))))
157 (setf (ewoc--node-left elemnode) (ewoc--node-left node))
158 (setf (ewoc--node-right elemnode) node)
159 (setf (ewoc--node-right (ewoc--node-left node)) elemnode)
160 (setf (ewoc--node-left node) elemnode))
161
162 (defun ewoc--node-enter-first (dll node)
163 "Add a free floating NODE first in DLL."
164 (ewoc--node-enter-before (ewoc--node-right dll) node))
165
166 (defun ewoc--node-enter-last (dll node)
167 "Add a free floating NODE last in DLL."
168 (ewoc--node-enter-before dll node))
169
170 (defun ewoc--node-next (dll node)
171 "Return the node after NODE, or nil if NODE is the last node."
172 (unless (eq (ewoc--node-right node) dll) (ewoc--node-right node)))
173
174 (defun ewoc--node-prev (dll node)
175 "Return the node before NODE, or nil if NODE is the first node."
176 (unless (eq (ewoc--node-left node) dll) (ewoc--node-left node)))
177
178 (defun ewoc--node-delete (node)
179 "Unbind NODE from its doubly linked list and return it."
180 ;; This is a no-op when applied to the dummy node. This will return
181 ;; nil if applied to the dummy node since it always contains nil.
182 (setf (ewoc--node-right (ewoc--node-left node)) (ewoc--node-right node))
183 (setf (ewoc--node-left (ewoc--node-right node)) (ewoc--node-left node))
184 (setf (ewoc--node-left node) nil)
185 (setf (ewoc--node-right node) nil)
186 node)
187
188 (defun ewoc--node-nth (dll n)
189 "Return the Nth node from the doubly linked list DLL.
190 N counts from zero. If DLL is not that long, nil is returned.
191 If N is negative, return the -(N+1)th last element.
192 Thus, (ewoc--node-nth dll 0) returns the first node,
193 and (ewoc--node-nth dll -1) returns the last node."
194 ;; Branch 0 ("follow left pointer") is used when n is negative.
195 ;; Branch 1 ("follow right pointer") is used otherwise.
196 (let* ((branch (if (< n 0) 0 1))
197 (node (ewoc--node-branch dll branch)))
198 (if (< n 0) (setq n (- -1 n)))
199 (while (and (not (eq dll node)) (> n 0))
200 (setq node (ewoc--node-branch node branch))
201 (setq n (1- n)))
202 (unless (eq dll node) node)))
203
204 (defun ewoc-location (node)
205 "Return the start location of NODE."
206 (ewoc--node-start-marker node))
207
208 \f
209 ;;; The ewoc data type
210
211 (defstruct (ewoc
212 (:constructor nil)
213 (:constructor ewoc--create
214 (buffer pretty-printer header footer dll))
215 (:conc-name ewoc--))
216 buffer pretty-printer header footer dll last-node)
217
218 (defmacro ewoc--set-buffer-bind-dll-let* (ewoc varlist &rest forms)
219 "Execute FORMS with ewoc--buffer selected as current buffer,
220 dll bound to ewoc--dll, and VARLIST bound as in a let*.
221 dll will be bound when VARLIST is initialized, but the current
222 buffer will *not* have been changed.
223 Return value of last form in FORMS."
224 (let ((old-buffer (make-symbol "old-buffer"))
225 (hnd (make-symbol "ewoc")))
226 `(let* ((,old-buffer (current-buffer))
227 (,hnd ,ewoc)
228 (dll (ewoc--dll ,hnd))
229 ,@varlist)
230 (set-buffer (ewoc--buffer ,hnd))
231 (unwind-protect
232 (progn ,@forms)
233 (set-buffer ,old-buffer)))))
234
235 (defmacro ewoc--set-buffer-bind-dll (ewoc &rest forms)
236 `(ewoc--set-buffer-bind-dll-let* ,ewoc nil ,@forms))
237
238 (defsubst ewoc--filter-hf-nodes (ewoc node)
239 "Evaluate NODE once and return it.
240 BUT if it is the header or the footer in EWOC return nil instead."
241 (unless (or (eq node (ewoc--header ewoc))
242 (eq node (ewoc--footer ewoc)))
243 node))
244
245
246 (defun ewoc--create-node (data pretty-printer pos)
247 "Call PRETTY-PRINTER with point set at POS in current buffer.
248 Remember the start position. Create a wrapper containing that
249 start position and the element DATA."
250 (save-excursion
251 ;; Remember the position as a number so that it doesn't move
252 ;; when we insert the string.
253 (when (markerp pos) (setq pos (marker-position pos)))
254 (goto-char pos)
255 (let ((inhibit-read-only t))
256 ;; Insert the trailing newline using insert-before-markers
257 ;; so that the start position for the next element is updated.
258 (insert-before-markers ?\n)
259 ;; Move back, and call the pretty-printer.
260 (backward-char 1)
261 (funcall pretty-printer data)
262 (ewoc--node-create (copy-marker pos) data))))
263
264
265 (defun ewoc--delete-node-internal (ewoc node)
266 "Delete a data string from EWOC.
267 Can not be used on the footer. Return the wrapper that is deleted.
268 The start-marker in the wrapper is set to nil, so that it doesn't
269 consume any more resources."
270 (let ((dll (ewoc--dll ewoc))
271 (inhibit-read-only t))
272 ;; If we are about to delete the node pointed at by last-node,
273 ;; set last-node to nil.
274 (if (eq (ewoc--last-node ewoc) node)
275 (setf (ewoc--last-node ewoc) nil))
276
277 (delete-region (ewoc--node-start-marker node)
278 (ewoc--node-start-marker (ewoc--node-next dll node)))
279 (set-marker (ewoc--node-start-marker node) nil)
280 ;; Delete the node, and return the wrapper.
281 (ewoc--node-delete node)))
282
283
284 (defun ewoc--refresh-node (pp node)
285 "Redisplay the element represented by NODE using the pretty-printer PP."
286 (let ((inhibit-read-only t))
287 (save-excursion
288 ;; First, remove the string from the buffer:
289 (delete-region (ewoc--node-start-marker node)
290 (1- (marker-position
291 (ewoc--node-start-marker (ewoc--node-right node)))))
292 ;; Calculate and insert the string.
293 (goto-char (ewoc--node-start-marker node))
294 (funcall pp (ewoc--node-data node)))))
295 \f
296 ;;; ===========================================================================
297 ;;; Public members of the Ewoc package
298
299
300 (defun ewoc-create (pretty-printer &optional header footer)
301 "Create an empty ewoc.
302
303 The ewoc will be inserted in the current buffer at the current position.
304
305 PRETTY-PRINTER should be a function that takes one argument, an
306 element, and inserts a string representing it in the buffer (at
307 point). The string PRETTY-PRINTER inserts may be empty or span
308 several lines. A trailing newline will always be inserted
309 automatically. The PRETTY-PRINTER should use `insert', and not
310 `insert-before-markers'.
311
312 Optional second argument HEADER is a string that will always be
313 present at the top of the ewoc. HEADER should end with a
314 newline. Optional third argument FOOTER is similar, and will
315 be inserted at the bottom of the ewoc."
316 (let ((new-ewoc
317 (ewoc--create (current-buffer)
318 pretty-printer nil nil (ewoc--dll-create)))
319 (pos (point)))
320 (ewoc--set-buffer-bind-dll new-ewoc
321 ;; Set default values
322 (unless header (setq header ""))
323 (unless footer (setq footer ""))
324 (setf (ewoc--node-start-marker dll) (copy-marker pos))
325 (let ((foot (ewoc--create-node footer (lambda (x) (insert footer)) pos))
326 (head (ewoc--create-node header (lambda (x) (insert header)) pos)))
327 (ewoc--node-enter-first dll head)
328 (ewoc--node-enter-last dll foot)
329 (setf (ewoc--header new-ewoc) head)
330 (setf (ewoc--footer new-ewoc) foot)))
331 ;; Return the ewoc
332 new-ewoc))
333
334 (defalias 'ewoc-data 'ewoc--node-data)
335
336 (defun ewoc-enter-first (ewoc data)
337 "Enter DATA first in EWOC.
338 Return the new node."
339 (ewoc--set-buffer-bind-dll ewoc
340 (ewoc-enter-after ewoc (ewoc--node-nth dll 0) data)))
341
342 (defun ewoc-enter-last (ewoc data)
343 "Enter DATA last in EWOC.
344 Return the new node."
345 (ewoc--set-buffer-bind-dll ewoc
346 (ewoc-enter-before ewoc (ewoc--node-nth dll -1) data)))
347
348
349 (defun ewoc-enter-after (ewoc node data)
350 "Enter a new element DATA after NODE in EWOC.
351 Return the new node."
352 (ewoc--set-buffer-bind-dll ewoc
353 (ewoc-enter-before ewoc (ewoc--node-next dll node) data)))
354
355 (defun ewoc-enter-before (ewoc node data)
356 "Enter a new element DATA before NODE in EWOC.
357 Return the new node."
358 (ewoc--set-buffer-bind-dll ewoc
359 (ewoc--node-enter-before
360 node
361 (ewoc--create-node
362 data
363 (ewoc--pretty-printer ewoc)
364 (ewoc--node-start-marker node)))))
365
366 (defun ewoc-next (ewoc node)
367 "Return the node in EWOC that follows NODE.
368 Return nil if NODE is nil or the last element."
369 (when node
370 (ewoc--filter-hf-nodes
371 ewoc (ewoc--node-next (ewoc--dll ewoc) node))))
372
373 (defun ewoc-prev (ewoc node)
374 "Return the node in EWOC that precedes NODE.
375 Return nil if NODE is nil or the first element."
376 (when node
377 (ewoc--filter-hf-nodes
378 ewoc
379 (ewoc--node-prev (ewoc--dll ewoc) node))))
380
381
382 (defun ewoc-nth (ewoc n)
383 "Return the Nth node.
384 N counts from zero. Return nil if there is less than N elements.
385 If N is negative, return the -(N+1)th last element.
386 Thus, (ewoc-nth dll 0) returns the first node,
387 and (ewoc-nth dll -1) returns the last node.
388 Use `ewoc--node-data' to extract the data from the node."
389 ;; Skip the header (or footer, if n is negative).
390 (setq n (if (< n 0) (1- n) (1+ n)))
391 (ewoc--filter-hf-nodes ewoc
392 (ewoc--node-nth (ewoc--dll ewoc) n)))
393
394 (defun ewoc-map (map-function ewoc &rest args)
395 "Apply MAP-FUNCTION to all elements in EWOC.
396 MAP-FUNCTION is applied to the first element first.
397 If MAP-FUNCTION returns non-nil the element will be refreshed (its
398 pretty-printer will be called once again).
399
400 Note that the buffer for EWOC will be the current buffer when
401 MAP-FUNCTION is called. MAP-FUNCTION must restore the current
402 buffer before it returns, if it changes it.
403
404 If more than two arguments are given, the remaining
405 arguments will be passed to MAP-FUNCTION."
406 (ewoc--set-buffer-bind-dll-let* ewoc
407 ((footer (ewoc--footer ewoc))
408 (node (ewoc--node-nth dll 1)))
409 (while (not (eq node footer))
410 (if (apply map-function (ewoc--node-data node) args)
411 (ewoc--refresh-node (ewoc--pretty-printer ewoc) node))
412 (setq node (ewoc--node-next dll node)))))
413
414 (defun ewoc-filter (ewoc predicate &rest args)
415 "Remove all elements in EWOC for which PREDICATE returns nil.
416 Note that the buffer for EWOC will be current-buffer when PREDICATE
417 is called. PREDICATE must restore the current buffer before it returns
418 if it changes it.
419 The PREDICATE is called with the element as its first argument. If any
420 ARGS are given they will be passed to the PREDICATE."
421 (ewoc--set-buffer-bind-dll-let* ewoc
422 ((node (ewoc--node-nth dll 1))
423 (footer (ewoc--footer ewoc))
424 (next nil))
425 (while (not (eq node footer))
426 (setq next (ewoc--node-next dll node))
427 (unless (apply predicate (ewoc--node-data node) args)
428 (ewoc--delete-node-internal ewoc node))
429 (setq node next))))
430
431 (defun ewoc-locate (ewoc &optional pos guess)
432 "Return the node that POS (a buffer position) is within.
433 POS may be a marker or an integer. It defaults to point.
434 GUESS should be a node that it is likely to be near POS.
435
436 If POS points before the first element, the first node is returned.
437 If POS points after the last element, the last node is returned.
438 If the EWOC is empty, nil is returned."
439 (unless pos (setq pos (point)))
440 (ewoc--set-buffer-bind-dll-let* ewoc
441 ((footer (ewoc--footer ewoc)))
442
443 (cond
444 ;; Nothing present?
445 ((eq (ewoc--node-nth dll 1) (ewoc--node-nth dll -1))
446 nil)
447
448 ;; Before second elem?
449 ((< pos (ewoc--node-start-marker (ewoc--node-nth dll 2)))
450 (ewoc--node-nth dll 1))
451
452 ;; After one-before-last elem?
453 ((>= pos (ewoc--node-start-marker (ewoc--node-nth dll -2)))
454 (ewoc--node-nth dll -2))
455
456 ;; We now know that pos is within a elem.
457 (t
458 ;; Make an educated guess about which of the three known
459 ;; node'es (the first, the last, or GUESS) is nearest.
460 (let* ((best-guess (ewoc--node-nth dll 1))
461 (distance (abs (- pos (ewoc--node-start-marker best-guess)))))
462 (when guess
463 (let ((d (abs (- pos (ewoc--node-start-marker guess)))))
464 (when (< d distance)
465 (setq distance d)
466 (setq best-guess guess))))
467
468 (let* ((g (ewoc--node-nth dll -1)) ;Check the last elem
469 (d (abs (- pos (ewoc--node-start-marker g)))))
470 (when (< d distance)
471 (setq distance d)
472 (setq best-guess g)))
473
474 (when (ewoc--last-node ewoc) ;Check "previous".
475 (let* ((g (ewoc--last-node ewoc))
476 (d (abs (- pos (ewoc--node-start-marker g)))))
477 (when (< d distance)
478 (setq distance d)
479 (setq best-guess g))))
480
481 ;; best-guess is now a "best guess".
482 ;; Find the correct node. First determine in which direction
483 ;; it lies, and then move in that direction until it is found.
484
485 (cond
486 ;; Is pos after the guess?
487 ((>= pos
488 (ewoc--node-start-marker best-guess))
489 ;; Loop until we are exactly one node too far down...
490 (while (>= pos (ewoc--node-start-marker best-guess))
491 (setq best-guess (ewoc--node-next dll best-guess)))
492 ;; ...and return the previous node.
493 (ewoc--node-prev dll best-guess))
494
495 ;; Pos is before best-guess
496 (t
497 (while (< pos (ewoc--node-start-marker best-guess))
498 (setq best-guess (ewoc--node-prev dll best-guess)))
499 best-guess)))))))
500
501 (defun ewoc-invalidate (ewoc &rest nodes)
502 "Call EWOC's pretty-printer for each element in NODES.
503 Delete current text first, thus effecting a \"refresh\"."
504 (ewoc--set-buffer-bind-dll ewoc
505 (dolist (node nodes)
506 (ewoc--refresh-node (ewoc--pretty-printer ewoc) node))))
507
508 (defun ewoc-goto-prev (ewoc arg)
509 "Move point to the ARGth previous element in EWOC.
510 Don't move if we are at the first element, or if EWOC is empty.
511 Return the node we moved to."
512 (ewoc--set-buffer-bind-dll-let* ewoc
513 ((node (ewoc-locate ewoc (point))))
514 (when node
515 ;; If we were past the last element, first jump to it.
516 (when (>= (point) (ewoc--node-start-marker (ewoc--node-right node)))
517 (setq arg (1- arg)))
518 (while (and node (> arg 0))
519 (setq arg (1- arg))
520 (setq node (ewoc--node-prev dll node)))
521 ;; Never step above the first element.
522 (unless (ewoc--filter-hf-nodes ewoc node)
523 (setq node (ewoc--node-nth dll 1)))
524 (ewoc-goto-node ewoc node))))
525
526 (defun ewoc-goto-next (ewoc arg)
527 "Move point to the ARGth next element in EWOC.
528 Return the node (or nil if we just passed the last node)."
529 (ewoc--set-buffer-bind-dll-let* ewoc
530 ((node (ewoc-locate ewoc (point))))
531 (while (and node (> arg 0))
532 (setq arg (1- arg))
533 (setq node (ewoc--node-next dll node)))
534 ;; Never step below the first element.
535 ;; (unless (ewoc--filter-hf-nodes ewoc node)
536 ;; (setq node (ewoc--node-nth dll -2)))
537 (ewoc-goto-node ewoc node)))
538
539 (defun ewoc-goto-node (ewoc node)
540 "Move point to NODE in EWOC."
541 (ewoc--set-buffer-bind-dll ewoc
542 (goto-char (ewoc--node-start-marker node))
543 (if goal-column (move-to-column goal-column))
544 (setf (ewoc--last-node ewoc) node)))
545
546 (defun ewoc-refresh (ewoc)
547 "Refresh all data in EWOC.
548 The pretty-printer that was specified when the EWOC was created
549 will be called for all elements in EWOC.
550 Note that `ewoc-invalidate' is more efficient if only a small
551 number of elements needs to be refreshed."
552 (ewoc--set-buffer-bind-dll-let* ewoc
553 ((footer (ewoc--footer ewoc)))
554 (let ((inhibit-read-only t))
555 (delete-region (ewoc--node-start-marker (ewoc--node-nth dll 1))
556 (ewoc--node-start-marker footer))
557 (goto-char (ewoc--node-start-marker footer))
558 (let ((node (ewoc--node-nth dll 1)))
559 (while (not (eq node footer))
560 (set-marker (ewoc--node-start-marker node) (point))
561 (funcall (ewoc--pretty-printer ewoc)
562 (ewoc--node-data node))
563 (insert "\n")
564 (setq node (ewoc--node-next dll node)))))
565 (set-marker (ewoc--node-start-marker footer) (point))))
566
567 (defun ewoc-collect (ewoc predicate &rest args)
568 "Select elements from EWOC using PREDICATE.
569 Return a list of all selected data elements.
570 PREDICATE is a function that takes a data element as its first
571 argument. The elements on the returned list will appear in the
572 same order as in the buffer. You should not rely on the order of
573 calls to PREDICATE.
574 Note that the buffer the EWOC is displayed in is the current
575 buffer when PREDICATE is called. PREDICATE must restore it if it
576 changes it.
577 If more than two arguments are given the
578 remaining arguments will be passed to PREDICATE."
579 (ewoc--set-buffer-bind-dll-let* ewoc
580 ((header (ewoc--header ewoc))
581 (node (ewoc--node-nth dll -2))
582 result)
583 (while (not (eq node header))
584 (if (apply predicate (ewoc--node-data node) args)
585 (push (ewoc--node-data node) result))
586 (setq node (ewoc--node-prev dll node)))
587 (nreverse result)))
588
589 (defun ewoc-buffer (ewoc)
590 "Return the buffer that is associated with EWOC.
591 Return nil if the buffer has been deleted."
592 (let ((buf (ewoc--buffer ewoc)))
593 (when (buffer-name buf) buf)))
594
595 (defun ewoc-get-hf (ewoc)
596 "Return a cons cell containing the (HEADER . FOOTER) of EWOC."
597 (cons (ewoc--node-data (ewoc--header ewoc))
598 (ewoc--node-data (ewoc--footer ewoc))))
599
600 (defun ewoc-set-hf (ewoc header footer)
601 "Set the HEADER and FOOTER of EWOC."
602 (setf (ewoc--node-data (ewoc--header ewoc)) header)
603 (setf (ewoc--node-data (ewoc--footer ewoc)) footer)
604 (ewoc--refresh-node (lambda (x) (insert header)) (ewoc--header ewoc))
605 (ewoc--refresh-node (lambda (x) (insert footer)) (ewoc--footer ewoc)))
606
607 \f
608 (provide 'ewoc)
609
610 ;;; Local Variables:
611 ;;; eval: (put 'ewoc--set-buffer-bind-dll 'lisp-indent-hook 1)
612 ;;; eval: (put 'ewoc--set-buffer-bind-dll-let* 'lisp-indent-hook 2)
613 ;;; End:
614
615 ;;; arch-tag: d78915b9-9a07-44bf-aac6-04a1fc1bd6d4
616 ;;; ewoc.el ends here