editor-pane-evaluate-region-in-listener

editor-pane-evaluate-region-in-listener Function

Summary

Evaluates a region of the text in an editor-pane in a Listener.

Package

capi

Signature

editor-pane-evaluate-region-in-listener editor-pane region-spec &optional listener

Arguments

`editor-pane`⇩	An editor-pane.
`region-spec`⇩	`:buffer`, `:region` or a list of two editor:points.
`listener`⇩	`nil` or a listener-pane.

Description

The function editor-pane-evaluate-region-in-listener evaluates the region that is specified by region-spec inside the buffer of editor-pane (the result of editor-pane-buffer).

editor-pane-evaluate-region-in-listener first looks for a Listener:

If listener is a listener-pane, it uses it.
If editor-pane is a listener-pane, it uses it.
Otherwise, it looks for a pane of type listener-pane inside the interface of editor-pane. If it fails to find a Listener, an error is signalled.

It then chooses the region, based on region-spec.

If region-spec is :buffer, the region is the whole of the buffer.
If region-spec is :region, the region is the highlighted region of the buffer. If there is no highlighted region, a warning is signalled and no evaluation occurs.
Otherwise, region-spec must a list of two editor:point objects specifying the region inside the buffer of editor-pane. If this is not the case, an error is signaled.

editor-pane-evaluate-region-in-listener then repeatedly reads forms from the region and evaluates them in the Listener, until it reaches the end of the region.

The reading is done in the appropriate context of the buffer, most importantly in the correct package. The evaluation is done in the context of the Listener. Most importantly it means that any output of the evaluation (and results) appear in the Listener, but also all the dynamic enviroment of the Listener, including error handling, is applicable.