parentheses-matched

Arguments: lisp-edit-pane file-position type matches-closing in-view

This generic function is called whenever the text cursor in a lisp-edit-pane is moved so that it is just before an opening parenthesis or just after a closing parenthesis, if there is a matching parenthesis within the top-level lisp form that the text cursor is in. It is also called for matching double-quote characters of literal strings.

There is no need for an application to call this function, but it may add methods to implement side effects. A lisp-edit-pane will automatically draw a mark to indicate the matching parenthesis if it is in view (according to parenthesis-matching-style and parenthesis-matching-color), but an application may also wish to add a status-bar message, for example, particularly if the matching parenthesis is not in view.

The default method that specializes on lisp-edit-pane does nothing. (The IDE editor adds an internal method to its lisp-edit-pane subclass for status-bar messages.)

The method will be called with the following arguments:

• lisp-edit-pane is the lisp-edit-pane window where the parenthesis match has occurred.
• file-position is the character index of the matching character.
• type is either nil for a matching parenthesis or the keyword :quote for a matching double-quote character.
• matches-closing is true if the matching character is a closing parenthesis or quote, and nil if it is an opening one.
• in-view is true if the matching character is currently scrolled into view, and is nil otherwise.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.