annotate lisp/emacs-lisp/ewoc.el @ 70994:d3750d5046d7

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