$line-flags(5)

NAME

$line-flags - Current buffer line flags

SYNOPSIS

$line-flags bitmask; No default

DESCRIPTION

The $line-flags variable is used to retrieve or define the behavioral settings of the current line in the buffer. This variable is a bit flag, the length of the bit flag is variable. In smaller builds of MicroEmacs where features have been disabled then the field is only 8 bits wide, in a normal build then the full 16 bits are present.

0x0001


The line has changed as a result of an edit and has not been re-displayed. The flag is cleared when the change has been displayed. This bit is read only.

0x0002


The line contains an alpha mark defined by set-alpha-mark(2). This bit is read only.

0x0004


The line contains a narrow region, set by narrow-buffer(2). This bit is read only.

0x0008


The line contains some other type of anchor. This bit is read only.

0x0010


The line should be saved without a new-line or nil termination character.

0x0020


The line is a mark-up line used for annotation and should not be saved on a write operation. This bit permits lines in a buffer to be inserted for display or annotation purposes which are automatically discarded when the buffer is written to file. Mark-up lines are sometimes used by the buffer folding and collapsing to annotate folds.

0x0040


The line is protected. A protected line may be deleted or edited however it is not possible to split or join a protected line with any other line. This is used by the folding or collapse mechanisms to protect narrrow regions from editing operations.

0x0080-0x0800


User defined. Users may use the upper most bits from left to right. JASSPA may use more bits in future releases which shall be consumed from the lower bits, right to left.

0xf000


The shifted $line-scheme(5) setting. A value of zero indicates that there is no line scheme in effect on the line.

Where a bit flag is defined as read only then an attempt by the user to set a read-only bit then the bit setting is ignored, any remaining writable bits are set as requested.

EXAMPLE

Refer to the file fold.emf for examples of the use of $line-flags.

NOTES

$line-flags was first introduced in MicroEmacs '04.

SEE ALSO

narrow-buffer(2), set-alpha-mark(2), set-variable(2), $buffer-hilight(5), $buffer-scheme(5) $line-scheme(5).

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