display-matching-fence(3)

NAME

display-matching-fence - Display the matching bracket

SYNOPSIS

n display-matching-fence

DESCRIPTION

display-matching-fence draws the fence (or bracket) pairing the one the cursor is currently over. A fence is considered to be one of the following:

{...}   (...)   [...] 

If the matching fence is currently being drawn (i.e. it is visible) both fences are drawn in the 'Normal' Matching Fence scheme (see scheme-editor(3)). If the matching fence is not currently visible the cursor is temporarily moved to the matching fence for $pause-time(5) milliseconds before returning to the starting position, the fences are hilighted using the Matching Fence 'Current' scheme. The matching fence delay can be interrupted by pressing any key. If the fence cannot be matched the fence is hilighted using the 'Select' scheme which is usually a bold red color.

The numeric argument n passed to the command is a bitwise flag where each bit is defined as follows:

0x01


Display fence (if not set nothing is done).

0x02


Use set-position id '\x85' instead of '\x84' (for internal use).

0x04


Don't Jump when matching fence is off screen.

0x08


Jump when closing a fence and its pair is off screen (for internal use).

0x10


Always jump to matching fence when closing a fence (for internal use).

0x20


Give preference to closing fence to left of cursor rather than character under the cursor (for internal use).

NOTES

This macro is used by the Fence Display setting of user-setup(3), the macro is bound to the idle-pick event using some of the more obscure numeric argument flags.

SEE ALSO

goto-matching-fence(2), user-setup(3), scheme-editor(3), $pause-time(5).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12