SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › regex

Package regex

This package contains 27 source unit(s) defining 22 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

Regex #sleela 2.5 (lib/regex/Regex.sleela)

Regex class

Defines the SLeeLa standard-library type Regex used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
stateint stateNo description in source.
capturesint capturesNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resetvoid reset()No description in source.
compilevoid compile()No description in source.
validboolean valid()No description in source.
captureCountint captureCount()No description in source.

RegexCapability #sleela 2.5 (lib/regex/RegexCapability.sleela)

RegexCapability class

Defines the SLeeLa standard-library type RegexCapability used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueint valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
enablevoid enable(int flag)No description in source.
getint get()No description in source.

RegexCapture #sleela 2.5 (lib/regex/RegexCapture.sleela)

RegexCapture class

Defines the SLeeLa standard-library type RegexCapture used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
indexint indexNo description in source.
startint startNo description in source.
endint endNo description in source.
valuestring valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
getIndexint getIndex()No description in source.
getValuestring getValue()No description in source.

RegexCompiler #sleela 2.5 (lib/regex/RegexCompiler.sleela)

RegexCompiler class

Defines the SLeeLa standard-library type RegexCompiler used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
stateint stateNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resetvoid reset()No description in source.
compilevoid compile()No description in source.
compiledboolean compiled()No description in source.

RegexDialect #sleela 2.5 (lib/regex/RegexDialect.sleela)

RegexDialect class

Defines the SLeeLa standard-library type RegexDialect used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
namestring nameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(string value)No description in source.
getstring get()No description in source.

RegexEngine #sleela 2.5 (lib/regex/RegexEngine.sleela)

RegexEngine class

Defines the SLeeLa standard-library type RegexEngine used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
namestring nameNo description in source.
capabilityint capabilityNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setNamevoid setName(string value)No description in source.
getNamestring getName()No description in source.
setCapabilityvoid setCapability(int value)No description in source.
getCapabilityint getCapability()No description in source.

RegexError #sleela 2.5 (lib/regex/RegexError.sleela)

RegexError class

Defines the SLeeLa standard-library type RegexError used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
codeint codeNo description in source.
positionint positionNo description in source.
messagestring messageNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
setvoid set(int c,int p,string m)No description in source.
getCodeint getCode()No description in source.
getPositionint getPosition()No description in source.

RegexFlags #sleela 2.5 (lib/regex/RegexFlags.sleela)

RegexFlags class

Defines the SLeeLa standard-library type RegexFlags used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueint valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
ignoreCasevoid ignoreCase()No description in source.
newlinevoid newline()No description in source.
noSubexpressionsvoid noSubexpressions()No description in source.
getint get()No description in source.

RegexIterator #sleela 2.5 (lib/regex/RegexIterator.sleela)

RegexIterator class

Defines the SLeeLa standard-library type RegexIterator used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
indexint indexNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resetvoid reset()No description in source.
nextvoid next()No description in source.
currentint current()No description in source.

RegexLiteral #sleela 2.5 (lib/regex/RegexLiteral.sleela)

RegexLiteral class

Defines the SLeeLa standard-library type RegexLiteral used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valuestring valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(string text)No description in source.
escapedstring escaped()No description in source.

RegexMatch #sleela 2.5 (lib/regex/RegexMatch.sleela)

RegexMatch class

Defines the SLeeLa standard-library type RegexMatch used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
startint startNo description in source.
endint endNo description in source.
matchedboolean matchedNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
setRangevoid setRange(int a,int b)No description in source.
foundboolean found()No description in source.

RegexMatcher #sleela 2.5 (lib/regex/RegexMatcher.sleela)

RegexMatcher class

Defines the SLeeLa standard-library type RegexMatcher used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
matchedboolean matchedNo description in source.
startint startNo description in source.
endint endNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
setvoid set(int a,int b)No description in source.
foundboolean found()No description in source.

RegexNatural #sleela 2.5 (lib/regex/RegexNatural.sleela)

Defines the SLeeLa standard-library type RegexNatural used within the regex library family.

RegexNaturalGrammar #sleela 2.5 (lib/regex/RegexNaturalGrammar.sleela)

Defines the SLeeLa standard-library type RegexNaturalGrammar used within the regex library family.

RegexNaturalGroup #sleela 2.5 (lib/regex/RegexNaturalGroup.sleela)

Defines the SLeeLa standard-library type RegexNaturalGroup used within the regex library family.

RegexNaturalParser #sleela 2.5 (lib/regex/RegexNaturalParser.sleela)

Defines the SLeeLa standard-library type RegexNaturalParser used within the regex library family.

RegexNaturalSymbol #sleela 2.5 (lib/regex/RegexNaturalSymbol.sleela)

Defines the SLeeLa standard-library type RegexNaturalSymbol used within the regex library family.

RegexOptions #sleela 2.5 (lib/regex/RegexOptions.sleela)

RegexOptions class

Defines the SLeeLa standard-library type RegexOptions used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueint valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
setvoid set(int option)No description in source.
getint get()No description in source.

RegexPattern #sleela 2.5 (lib/regex/RegexPattern.sleela)

RegexPattern class

Defines the SLeeLa standard-library type RegexPattern used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
patternstring patternNo description in source.
flagsint flagsNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setPatternvoid setPattern(string value)No description in source.
getPatternstring getPattern()No description in source.
setFlagsvoid setFlags(int value)No description in source.
getFlagsint getFlags()No description in source.

RegexReplacement #sleela 2.5 (lib/regex/RegexReplacement.sleela)

RegexReplacement class

Defines the SLeeLa standard-library type RegexReplacement used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
sourcestring sourceNo description in source.
replacementstring replacementNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setSourcevoid setSource(string value)No description in source.
setReplacementvoid setReplacement(string value)No description in source.
getReplacementstring getReplacement()No description in source.

RegexReplacer #sleela 2.5 (lib/regex/RegexReplacer.sleela)

RegexReplacer class

Defines the SLeeLa standard-library type RegexReplacer used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
replacementstring replacementNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(string value)No description in source.
getstring get()No description in source.

RegexResult #sleela 2.5 (lib/regex/RegexResult.sleela)

RegexResult class

Defines the SLeeLa standard-library type RegexResult used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
successboolean successNo description in source.
codeint codeNo description in source.
messagestring messageNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
okvoid ok()No description in source.
passedboolean passed()No description in source.

RegexScanner #sleela 2.5 (lib/regex/RegexScanner.sleela)

RegexScanner class

Defines the SLeeLa standard-library type RegexScanner used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
positionint positionNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resetvoid reset()No description in source.
advancevoid advance()No description in source.
currentint current()No description in source.

RegexSplitter #sleela 2.5 (lib/regex/RegexSplitter.sleela)

RegexSplitter class

Defines the SLeeLa standard-library type RegexSplitter used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
partsint partsNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
addPartvoid addPart()No description in source.
countint count()No description in source.

RegexSubject #sleela 2.5 (lib/regex/RegexSubject.sleela)

RegexSubject class

Defines the SLeeLa standard-library type RegexSubject used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valuestring valueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(string text)No description in source.
getstring get()No description in source.
lengthint length()No description in source.

RegexSystem #sleela 2.5 (lib/regex/RegexSystem.sleela)

RegexSystem class

Defines the SLeeLa standard-library type RegexSystem used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
stateint stateNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
initializevoid initialize()No description in source.
shutdownvoid shutdown()No description in source.
readyboolean ready()No description in source.

RegexValidator #sleela 2.5 (lib/regex/RegexValidator.sleela)

RegexValidator class

Defines the SLeeLa standard-library type RegexValidator used within the regex library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
validboolean validNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
clearvoid clear()No description in source.
acceptvoid accept()No description in source.
isValidboolean isValid()No description in source.