NAME

Prima::Edit - standard text editor

SYNOPSIS

        use Prima qw(Edit Application);
        my $e = Prima::Edit->new(
                text         => 'Hello $world',
                syntaxHilite => 1,
        );
        run Prima;

DESCRIPTION

The class provides text editing capabilities, three types of selection, text wrapping, syntax highlighting, auto indenting, undo and redo function, and search and replace methods.

The module declares the bt:: package that contains integer constants for the selection of block type, used by the blockType property.

USAGE

The text is stored line-wise in the {lines} array; to access it use the get_line method.

All keyboard events except the character input and tab keys are processed by the accelerator table ( see Prima::Menu ). The default accelItems table defines names, keyboard combinations, and the corresponding actions to the class functions. The class does not provide functionality to change these mappings. To do so, consult "Prima::AccelTable" in Prima::Menu.

Coordinates

The class addresses the text space by (X,Y)-coordinates, where X is the visual cluster offset and Y is the line number. The addressing coordinate system can be visual, physical, or logical. See below.

Cluster shaping and word wrapping can play a role here. Consider f.ex. a text string "offset is zero", that for the sake of the example can wrapped by width and displayed as two lines, "offset" and "is zero". Here, the font substitutes "ff" text with a single ligature glyph. Here, for example, coord("f") will be (0,1) in all coordinates, but coord("z") is not:

Physical

The X coordinate is a character offset from character line number Y. These coordinates are identical with and without the wordWrap flag. This coordinate is used for direct text manipulation.

Example: coord("z") is (0,10);

Visual

The X coordinate is a glyph cluster offset from the character line number Y. These coordinates are identical with and without the wordWrap flag. This coordinate is used for cursor and selection API.

Example: coord("z") is (0,9);

Logical

The Y coordinate is the wrapped line index. The chunkMap internal array contains addresses in the logical coordinates. The X coordinate is a glyph cluster offset from the line start. This coordinate is used mostly internally.

To access the text chunk-wise, use the get_chunk method.

Example: coord("z") is (1,3);

API

Events

ParseSyntax TEXT, RESULT_ARRAY_REF: Called when syntax highlighting is required - TEXT is a string to be parsed, and the parsing results to be stored in RESULT_ARRAY_REF, which is a reference to an array of integer pairs, each representing a single-colored text chunk. The first integer in the pairs is the length of a chunk, the second - color value ( cl::XXX constants ).

Properties

autoIndent BOOLEAN

Turns the auto indenting on or off

Default value: 1

blockType INTEGER

Defines the type of selection block. Can be one of the following constants:

bt::CUA

Normal block, where the first and the last line of the selection can be partial, and the lines between occupy the whole line. CUA stands for 'common user access'.

Default keys: Shift + arrow keys

See also: mark_horizontal

cursor X, Y

Selects the visual position of the cursor

cursorX X

Selects the visual horizontal position of the cursor

cursorY Y

Selects the visual vertical position of the cursor

cursorWrap BOOLEAN

Selects cursor behavior when moved horizontally outside the line. If 0, the cursor is not moved. If 1, the cursor moved to the adjacent line.

insertMode BOOLEAN

Set the typing mode - if 1, the typed text is inserted, if 0, the new text overwrites the old text. When insertMode is 0, the cursor shape is thick and covers the whole character; when 1, it is of the default cursor width.

Default toggle key: Insert

hiliteNumbers COLOR

Selects the color for number highlighting

hiliteQStrings COLOR

Selects the color for highlighting the single-quoted strings

hiliteQQStrings COLOR

Selects the color for highlighting the double-quoted strings

hiliteIDs ARRAY

An array of scalar pairs that define words to be highlighted. The first item in the pair is an array of words, and the second item is a color value.

hiliteChars ARRAY

An array of scalar pairs that define characters to be highlighted. The first item in the pair is a string of characters, and the second item is a color value.

hiliteREs ARRAY

An array of scalar pairs that define character patterns to be highlighted. The first item in the pair is a perl regular expression, and the second item is a color value.

Note: these are tricky. Generally, these assume that whatever is captured in (), is highlighted, and that capturing parentheses match from the first character onwards. So for simple matches like (\d+) (digits) or (#.*) this works fine. Things become more interesting if you need to check text after, or especially before the capture. For this, you need to make sure that whatever text is matched by a regexp, it must not move the pos pointer as the regexes are internally concatenated with the \G anchor before the actual matching takes place (i.e. starting each time from the position the previous regex left off), and use /gc flags (advancing pos to the match length). Advancing the pos will nullify color highlighting on the text after the capture but before the end of the match - so you'll need look-ahead assertions for this type of match, (?=pattern) and (?!pattern) (see "Lookaround Assertions" in perlre ).

For example, we have a string ABC123abc, and we want to match 123 followed by abc. This won't work:

        hiliteREs => [
                '(123)abc',cl::LightRed,
                '(abc)', cl::LightGreen
        ]

while this will:

        hiliteREs => [
                '(123)(?=abc)',cl::LightRed,
                '(abc)', cl::LightGreen 
        ]

If you need to look behind, the corresponding assertions (?<=pattern) and (?<!pattern) could be used, but these are even more restrictive in that they only support fixed-width looks-behinds (NB: \K won't work because of \G either). That way, if we want to match 123 that follows ABC, this won't work:

        hiliteREs =>  [
                '(ABC)',cl::LightBlue,
                '(?<=[ABC]+)(123)',cl::LightRed,
        ]

while this will:

        hiliteREs =>  [
                '(ABC)',cl::LightBlue,
                '(?<=[ABC]{3})(123)',cl::LightRed,
        ]

mark MARK [ BLOCK_TYPE ]

Selects block marking state. If MARK is 1, starts the block marking, if 0 - stops the block marking. When MARK is 1, BLOCK_TYPE can be used to set the selection type ( bt::XXX constants ). If BLOCK_TYPE is unset the value of blockType is used.

markers ARRAY

An array of arrays with integer pairs, X and Y, where each represents visual coordinates in text. Used as anchor storage for fast navigation.

Methods

add_marker X, Y

Adds visual coordinates X,Y to the markers property.

back_char [ REPEAT = 1 ]

Removes REPEAT times a character left to the cursor. If the cursor is on 0 X-position, removes the new-line character and concatenates the two lines.

Default key: Backspace

cancel_block

Removes the selection block

Default key: Alt+U

change_locked

Returns 1 if the logical locking is on, and 0 if it is off.

AUTHOR

Dmitry Karasik, <dmitry@karasik.eu.org>.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)