lisp/extents.el

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