annotate lisp/extents.el @ 267:966663fcf606 r20-5b32

Import from CVS: tag r20-5b32
author cvs
date Mon, 13 Aug 2007 10:26:29 +0200
parents 78478c60bfcd
children c5d627a313b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; extents.el --- miscellaneous extent functions not written in C
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1993-4, 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5 ;; Keywords: internal, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
7 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; along with XEmacs; see the file COPYING. If not, write to the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21 ;; Free Software Foundation, 59 Temple Place - Suite 330,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; Boston, MA 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24 ;;; Synched up with: Not in FSF.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28 ;; some help from stig@hackvan.com here.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32 ;; an alternative to map-extents.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33 (defun mapcar-extents (function &optional predicate buffer-or-string from to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34 flags property value)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35 "Applies FUNCTION to all extents which overlap a region in BUFFER-OR-STRING.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36 The region is delimited by FROM and TO. FUNCTION is called with
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 one argument, the extent. A list of the values returned by FUNCTION
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38 is returned. An optional PREDICATE may be used to further limit the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39 extents over which FUNCTION is mapped. The optional arguments FLAGS,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40 PROPERTY, and VALUE may also be used to control the extents passed to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41 PREDICATE or FUNCTION. See also `map-extents'."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 (let (*result*)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43 (map-extents (if predicate
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 #'(lambda (ex junk)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45 (and (funcall predicate ex)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 (setq *result* (cons (funcall function ex)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 *result*)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48 nil)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 #'(lambda (ex junk)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50 (setq *result* (cons (funcall function ex)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51 *result*))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53 buffer-or-string from to nil flags property value)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 (nreverse *result*)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 (defun extent-list (&optional buffer-or-string from to flags)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57 "Return a list of the extents in BUFFER-OR-STRING.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 BUFFER-OR-STRING defaults to the current buffer if omitted.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59 FROM and TO can be used to limit the range over which extents are
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 returned; if omitted, all extents in the buffer or string are returned.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 More specifically, if a range is specified using FROM and TO, only
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63 extents that overlap the range (i.e. begin or end inside of the range)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64 are included in the list. FROM and TO default to the beginning and
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 end of BUFFER-OR-STRING, respectively.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 FLAGS controls how end cases are treated. For a discussion of this,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 and exactly what ``overlap'' means, see `map-extents'.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 If you want to map a function over the extents in a buffer or string,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 consider using `map-extents' or `mapcar-extents' instead."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72 (mapcar-extents 'identity nil buffer-or-string from to flags))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 (defun extent-string (extent)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 "Return the string delimited by the bounds of EXTENT."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 (let ((object (extent-object extent)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 (if (bufferp object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 (buffer-substring (extent-start-position extent)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (extent-end-position extent)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (substring object
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 (extent-start-position extent)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83 (extent-end-position extent)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 (defun extent-descendants (extent)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86 "Return a list of all descendants of EXTENT, including EXTENT.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 This recursively applies `extent-children' to any children of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 EXTENT, until no more children can be found."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 (let ((children (extent-children extent)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 (if children
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 (apply 'nconc (mapcar 'extent-descendants children))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 (list extent))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94 (defun set-extent-keymap (extent keymap)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 "Set EXTENT's `keymap' property to KEYMAP."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 (set-extent-property extent 'keymap keymap))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97
211
78478c60bfcd Import from CVS: tag r20-4b4
cvs
parents: 209
diff changeset
98 (defun extent-keymap (extent)
78478c60bfcd Import from CVS: tag r20-4b4
cvs
parents: 209
diff changeset
99 "Return EXTENT's `keymap' property."
78478c60bfcd Import from CVS: tag r20-4b4
cvs
parents: 209
diff changeset
100 (extent-property extent 'keymap))
78478c60bfcd Import from CVS: tag r20-4b4
cvs
parents: 209
diff changeset
101
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102 ;;; extents.el ends here