user.plugin.text_navigation.text_navigation.py

Modules

Actions

user.navigation(navigation_action: str, direction: str, navigation_target_name: str, before_or_after: str, regex: Pattern, occurrence_number: int)

Navigate in `direction` to the occurrence_number-th time that `regex` occurs, then execute `navigation_action` at the given `before_or_after` position.

user.navigation_by_name(navigation_action: str, direction: str, before_or_after: str, navigation_target_name: str, occurrence_number: int)

Like user.navigation, but to a named target.

Captures

user.navigation_target: Pattern

<user.any_alphanumeric_key> | {user.navigation_target_name} | phrase <user.text>

A target to navigate to. Returns a regular expression.

Lists

user.navigation_action

actions to perform, for instance move, select, cut, etc

'move'	'GO'
'extend'	'EXTEND'
'select'	'SELECT'
'clear'	'DELETE'
'cut'	'CUT'
'copy'	'COPY'

user.before_or_after

words to indicate if the cursor should be moved before or after a given reference point

'before'	'BEFORE'
'after'	'AFTER'

user.navigation_target_name

names for regular expressions for common things to navigate to, for instance a word with or without underscores

'word'	'\\w+'
'small'	'[A-Z]?[a-z0-9]+'
'big'	'[\\S]+'
'parens'	'\\((.*?)\\)'
'squares'	'\\[(.*?)\\]'
'braces'	'\\{(.*?)\\}'
'quotes'	'\\"(.*?)\\"'
'angles'	'\\<(.*?)\\>'
'all'	'(.+)'
'method'	'\\w+\\((.*?)\\)'
'constant'	'[A-Z_][A-Z_]+'

Settings

user.text_navigation_max_line_search: int = 10

the maximum number of rows that will be included in the search for the keywords above and below in <user direction>