Previous: Functions for Modifying Overlays, Up: Functions for Writing New Overlay Classes


4.3.3 Functions for Querying Overlays

These functions query certain things about auto-overlays or match overlays, or retrieve certain values associated with them. A few are merely convenience functions, but most depend on the internal implementation details of the auto-overlays package, and provide the only reliable interface for whatever they return.

(auto-o-class o-match)
Return the class of match overlay o-match.
(auto-o-regexp o-match)
Return the regular expression matched by the text covered by match overlay o-match.
(auto-o-regexp-group o-match)
Return the regexp group defined in the regexp definition corresponding to match overlay o-match (see Defining Regexps).
(auto-o-props o-match)
Return the list of overlay properties defined in the regexp definition corresponding to match overlay o-match (see Defining Regexps).
(auto-o-edge o-match)
Return edge (the symbol start or end) of match overlay o-match.
(auto-o-parse-function o-match)
Return appropriate parse function for match overlay o-match.
(auto-o-suicide-function o-match)
Return appropriate suicide function for match overlay o-match.
(auto-o-match-function o-match)
Return match function for match overlay o-match, if any.
(auto-o-edge-matched-p overlay edge)
Return non-nil if edge (the symbol start or end) of auto-overlay overlay is matched.
(auto-o-start-matched-p overlay)
Return non-nil if auto-overlay overlay is start-matched.
(auto-o-end-matched-p overlay)
Return non-nil if auto-overlay overlay is end-matched.