$buffer-fhook(5)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

NAME

$buffer-fhook - Buffer macro hook command name (buffer creation)
$buffer-dhook - Buffer macro hook command name (buffer deletion)
$buffer-bhook - Buffer macro hook command name (buffer current)
$buffer-ehook - Buffer macro hook command name (buffer swapped)

SYNOPSIS

$buffer-fhook FunctionName
$buffer-dhook FunctionName
$buffer-bhook FunctionName
$buffer-ehook FunctionName

DESCRIPTION

Defines the buffer create, delete, begin and end hook command which are executed:

$buffer-fhook

When the buffer is created.

$buffer-dhook

When the buffer is deleted.

$buffer-bhook

When the buffer becomes the current buffer.

$buffer-ehook

When the buffer is swapped out from being the current buffer.

The variable $buffer-fhook cannot be directly set and is largely redundant as the file hook is executed only when the buffer's major-mode(2) is first assigned. Its main use is within macros which wish to ascertain what type of buffer it is executing on, i.e. if a command was to be executed only on C files then the follow ensures that this is the case:

!iif &not &seq $buffer-fhook "fhook-c"  !abort

Where the command fhook-c is the C major-mode file hook, note that the $buffer-major-mode(5) can often be used for the same purposes.

dhooks are executed when a buffer is deleted, but before the contents of the buffer are lost. Note that dhooks will not be called if the buffer never becomes active, or if MicroEmacs quits due to the receipt of a panic signal.

bhooks and ehooks are usually used to set and restore global variables which require different setting in the current buffer.

These variables are initially set by the system when the buffer first becomes active, when the buffer's major-mode(2) is determined. After this point the dhook, bhook & ehook variables can be set to any function the user wishes, however the $buffer-fhook variable can only be changed by calls to major-mode as the value of the variable must stay in sync with $buffer-major-mode(5).

$buffer-fhook(5)

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO