ParagraphManagerclassoutput.t[620]

Superclass
Tree 		Subclass
Tree 		Global
Objects 		Property
Summary 		Method
Summary 		Property
Details 		Method
Details

Paragraph manager. We filter strings as they're about to be sent to the console to convert paragraph markers (represented in the source text using the "style tag" format, <.P>) into a configurable display rendering.

We also process the zero-spacing paragraph, <.P0>. This doesn't generate any output, but otherwise acts like a paragraph break in that it suppresses any paragraph breaks that immediately follow.

The special marker <./P0> cancels the effect of a <.P0>. This can be used if you want to ensure that a newline or paragraph break is displayed, even if a <.P0> was just displayed.

Our special processing ensures that paragraph tags interact with one another and with other display elements specially:

- A run of multiple consecutive paragraph tags is treated as a single paragraph tag. This property is particularly important because it allows code to write out a paragraph marker without having to worry about whether preceding code or following code add paragraph markers of their own; if redundant markers are found, we'll filter them out automatically.

- We can suppress paragraph markers following other specific sequences. For example, if the paragraph break is rendered as a blank line, we might want to suppress an extra blank line for a paragraph break after an explicit blank line.

- We can suppress other specific sequences following a paragraph marker. For example, if the paragraph break is rendered as a newline plus a tab, we could suppress whitespace following the paragraph break.

The paragraph manager should always be instantiated with transient instances, because this object's state is effectively part of the interpreter user interface, which doesn't participate in save and restore.

class ParagraphManager :   OutputFilter

Superclass Tree   (in declaration order)

ParagraphManager
        OutputFilter
                object

Subclass Tree  

(none)

Global Objects  

mainParagraphManager  menuParagraphManager 

Summary of Properties  

leadingMultiPat  leadingSinglePat  renderAfterInput  renderText  suppressAfter  suppressBefore 

Summary of Methods  

filterText 

Properties  

leadingMultiPatoutput.t[656]

pre-compile some regular expression patterns we use a lot

leadingSinglePatoutput.t[657]
no description available

renderAfterInputoutput.t[631]
Flag: show or hide paragraph breaks immediately after input. By default, we do not show paragraph breaks after an input line.

renderTextoutput.t[625]
Rendering - this is what we display on the console to represent a paragraph break. By default, we'll display a blank line.

suppressAfteroutput.t[653]
Following suppression. This is a regular expression that we match to individual characters. If the character immediately following a paragraph marker matches this expression, we'll suppress the character. We'll apply this to each character following a paragraph marker in turn until we find one that does not match; we'll suppress all of the characters that do match. By default, we suppress additional blank lines after a paragraph break.

suppressBeforeoutput.t[641]
Preceding suppression. This is a regular expression that we match to individual characters. If the character immediately preceding a paragraph marker matches this expression, we'll suppress the paragraph marker in the output. By default, we'll suppress a paragraph break following a blank line, because the default rendering would add a redundant blank line.

Methods  

filterText (ostr, txt)OVERRIDDENoutput.t[661]

process a string that's about to be written to the console

Adv3Lite Library Reference Manual
Generated on 25/04/2024 from adv3Lite version 2.0