regexp
Max Reference
Open Help

regexp

Use regular expressions to process input

Examples

Discussion

With regexp, it's possible to use PERL-compatible regular expressions to parse or make substitutions within symbols and lists. The argument is a symbol that sets the RE, as does the 're' command in the left inlet. the 'substitute' command passes a symbol to be used in substitutions - if no symbol is present, it removes the previous one. Any other symbol or list in the left inlet is treated as the subject string, and is processed according to those parameters. The middle outlet reports a list of the instances where the RE matched portions of the subject string. If the RE contains parentheses, they are treated as backreferences, and the center-left outlet puts them into a list upon every match within the subject string. If a 'substitute' string has been set, the leftmost output returns the subject string with necessary substitutions. (n.b. substitute strings may contain back references, of the form %n)

Arguments

expression [symbol]

Optional

A regular expression may be used as an argument to set the regular expression (see above for regular expression formatting and metacharacter information).

substitution [symbol]

Optional

An optional second argument will set the substitution string.

Attributes

re [symbol]

The word re , followed by a PERL-compatible regular expression, sets the regular expression rules to be used when parsing or making substitutions within any symbol or list input.

If a regular expression contains spaces, it must be enclosed within double quotes when specified using the re message or as a typed-in argument to the regexp object.

Regular expressions use the following form and syntax:

[...] defines a 'class' of characters. any of the characters within it may be matched. several special symbols may also appear within it:

...-... specifies a range (within ASCII codes)

\\d specifies a decimal digit ( \\D specifies a non-decimal digit). Note that double backslashes must be used -- Max erases single backslashes.

\\s specifies white space ( \\S specifies non-white space). Note that double backslashes must be used -- Max erases single backslashes.

\\w specifies an alphanumeric ( \\W specifies a nonalphanumeric). Note that double backslashes must be used -- Max erases single backslashes.

^... specifies a complement of

...* appears zero times

...+ appears at least once

...? appears once or not at all

(...) specifies a backreference that may be referred to in a substitution string such as %n , where n is the position of the parenthesis in left-to-right order.

substitute [symbol]

The word substitute , followed by a symbol, passes a symbol to be used in substitutions. If the word substitute is not followed by a symbol, the previous substitution symbol is removed.

Note: If you need to output a % followed by a number in any substitution string, you should use %% , so that the % is not read as a backreference.

tosymbol [int]

The word tosymbol , followed by a zero or one, toggles the output behavior of the regexp object. When enabled, output from the left outlet of the object will be a single symbol. When disabled, output from the left outlet of the object will consist of a list of individual elements.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

int

Arguments

subject-string [int]
Any int received in the regexp object's inlet is treated as the subject string to be processed according to the regular expression and symbol substitutions provided.

float

Arguments

subject-string [float]
Any float received in the regexp object's inlet is treated as the subject string to be processed according to the regular expression and symbol substitutions provided.

list

Arguments

subject-string [list]
Any symbol or list received in the regexp object's inlet (not matching the object's attributes) is treated as the subject string to be processed according to the regular expression and symbol substitutions provided.

anything

Arguments

subject-string [list]
Performs the same function as a list message.

Output

symbol or list

Out left outlet: If a substitute string has been set using the substitute message, the input list or symbol is sent out the left outlet with any required substitutions (n.b. substitute strings may contain back references, of the form %n ).

Out center-left outlet: If the regular expressions contains parentheses, they are treated as backreferences. The middle outlet reports the backreferences upon every match within the subject string, and outputs them in the form of a list.

Out center outlet: The rightmost outlet reports a list of the instances where the regular expression matched portions of the subject string.

Out center-right outlet: The rightmost outlet passes the original input, in the case that not match occurs.

Out right outlet: The rightmost outlet is used to report the values of the object's attributes.

See Also

Name Description
fromsymbol Convert a symbol into numbers/messages
key Report keyboard presses
keyup Report key information on release
message Send any message
spell Convert input to UTF-8 (Unicode) codes
tosymbol Convert messages, numbers, or lists to a single symbol