Reference · stzRegex

Match()

This is what :MatchEntireContent has always said it does, and what the naming redesign settled on: match the complete pattern against the complete content.

also written: Macth · IsMatched · MacthString · MatchString

Basic examples (2)

Softanza

o1 = new stzRegex("hello world")
? o1.MatchXT("HELLO world", 1, :MatchEntireContent, [])
? o1.MatchXT("HELLO world", 1, :MatchEntireContent, [ :CaseInsensitive ])

Output

0
1

run on 2026-10-02 04:23 inside the library at commit 0e72e2e2c; taken from 40_test_8_options_via_matchxt.ring(opens in a new tab)

Softanza

txt = "hello
world"
o = new stzRegex("hello.world")
? o.MatchXT(txt, 1, :MatchEntireContent, []) # Returns false - dot doesn't match newline
? o.MatchXT(txt, 1, :MatchEntireContent, [ :DotMatchesAll ]) # Returns true - dot matches newline

Output

0
1

run on 2026-10-02 04:23 inside the library at commit 0e72e2e2c; taken from 28_understanding_regex_options.ring(opens in a new tab)

Scope (2)

Softanza

txt = "Name: John, Age: 30"
o1 = new stzRegex("Name: (?<name>.*), Age: (?<age>\d+)")
? o1.Match(txt)
? o1.HasNames() + NL
? @@( o1.Names() ) + NL
? @@NL( o1.CaptureXT() )

Output

1
1

[ "name", "age" ]

[
	[ "name", "John" ],
	[ "age", "30" ]
]

run on 2026-10-02 04:23 inside the library at commit 0e72e2e2c; taken from 38_test_6_named_capture_groups.ring(opens in a new tab)

Softanza

oRx = new stzRegex("[0-9]+")
oRx.MatchXT("a12b345c6", 1, :MatchFirstOccurrenceIfNotGoPartial, [])
# Matches gives the values
? @@(oRx.Matches())
# MatchesZ gives value and position
? @@(oRx.MatchesZ())
# ...as DATA, not as console output
? isList(oRx.MatchesZ())
# ...one entry per match
? len(oRx.MatchesZ())
# ZZ gives the position as a SECTION instead
? @@(oRx.MatchesZZ())
# ValuesAndTheirPositions agrees
? @@(oRx.ValuesAndTheirPositions())
# ...and so does MatchesAndTheirPositions
? @@(oRx.MatchesAndTheirPositions())
# ...and it is not empty
? len(oRx.MatchingSubStringsAndTheirPositions())

Output

[ "12", "345", "6" ]
[ [ "12", 2 ], [ "345", 5 ], [ "6", 9 ] ]
1
3
[ [ "12", [ 2, 4 ] ], [ "345", [ 5, 8 ] ], [ "6", [ 9, 10 ] ] ]
[ [ "12", 2 ], [ "345", 5 ], [ "6", 9 ] ]
[ [ "12", 2 ], [ "345", 5 ], [ "6", 9 ] ]
3

run on 2026-10-02 04:23 inside the library at commit 0e72e2e2c; taken from 00_regex_narrated.ring(opens in a new tab)

The extensions of this method

Each extension, and whether it exists for this method; an extension that exists combines with the others (FindSTCS).

Extension

Exists

What it adds · The names

does what the method does, then returns the object, so the call can be chained

chains on the next, more specific type of object (the Q ladder)

QQQ

chains on the most specific type of object (the Q ladder)

QRT

returns the result as an object of the requested type

takes a case-sensitivity flag

takes the position to start from (StartingAt)

takes bounds that are included (IncludingBounds)

yes

the extended form: more parameters than the base method · MacthXT, MatchXT, MatchManyXT

XTT

yet another extension: a further extended form, after XT

includes the position in what it returns

returns positions as sections, [start, end]

selects by a condition

selects by a condition, with the expressive keywords (@NextItem, @PreviousItem...)

takes a direction, forward or backward (Directional)

takes a function (the condition or the update is given as a function); the forms document also uses F for the future form, which defers the action

Many

yes

works on a collection of items instead of one (the plural form) · MatchMany, MatchManyXT

Except

takes exceptions, what to leave out (the exceptional form)

returns the result without duplication

Every example is a test file of the library, run inside the library for this page; only those whose output kept every promise their file wrote are shown.

Match()

Basic examples (2)

Scope (2)

The extensions of this method

See also