Kleingrep is a regular expression engine, providing a library and command-line tool written in Go.
It aims to provide a more featureful engine, compared to the one in Go's
[regexp](https://pkg.go.dev/regexp), while retaining some semblance of efficiency.
The engine does __not__ use backtracking, relying on the NFA-based method described in
[Russ Cox's articles](https://swtch.com/~rsc/regexp). As such, it is immune to catastrophic backtracking.
It also includes features not present in regexp, such as lookarounds and backreferences.
### Syntax
The syntax is, for the most part, a superset of Go's regexp. A full overview of the syntax can be found [here](https://pkg.go.dev/gitea.twomorecents.org/Rockingcool/kleingrep/regex#hdr-Syntax).
__For more information, see https://pkg.go.dev/gitea.twomorecents.org/Rockingcool/kleingrep/regex__.
// If lineFlag is enabled, we should only print something if:
// If lineFlag is enabled, we should only print something if:
@ -184,7 +182,7 @@ func main() {
// the corresponding end index.
// the corresponding end index.
// 3. If not, just print the character.
// 3. If not, just print the character.
ifsubstituteFlagEnabled{
ifsubstituteFlagEnabled{
fori:=rangetest_str_runes{
fori:=rangetest_str{
inMatchIndex:=false
inMatchIndex:=false
for_,m:=rangematchIndices{
for_,m:=rangematchIndices{
ifi==m[0].StartIdx{
ifi==m[0].StartIdx{
@ -195,21 +193,19 @@ func main() {
}
}
}
}
if!inMatchIndex{
if!inMatchIndex{
fmt.Fprintf(out,"%c",test_str_runes[i])
fmt.Fprintf(out,"%c",test_str[i])
}
}
}
}
}else{
}else{
fori,c:=rangetest_str_runes{
fori,c:=rangetest_str{
ifindicesToPrint.contains(i){
ifindicesToPrint.contains(i){
color.New(color.FgRed).Fprintf(out,"%c",c)
color.New(color.FgRed).Fprintf(out,"%c",c)
// Newline after every match - only if -o is enabled and -v is disabled.
// Newline after every match - only if -o is enabled and -v is disabled.
if*onlyFlag&&!(*invertFlag){
if*onlyFlag&&!(*invertFlag){
formatchIdxNum,idx:=rangematchIndices{
for_,idx:=rangematchIndices{
ifmatchIdxNum<len(matchIndices)-1{// Only print a newline afte printing a match, if there are multiple matches on the line, and we aren't on the last one. This is because the newline that gets added at the end will take care of that.
ifi+1==idx[0].EndIdx{// End index is one more than last index of match
ifi+1==idx[0].EndIdx{// End index is one more than last index of match
fmt.Fprintf(out,"\n")
fmt.Fprintf(out,"\n")
break
break
}
}
}
}
}
}
}
@ -224,10 +220,6 @@ func main() {
iferr!=nil{
iferr!=nil{
panic(err)
panic(err)
}
}
// If the last character in the string wasn't a newline, AND we either have don't -o set or we do (and we've matched something), then print a newline
i+=(numDigits-1)// I have to move back a step, so that I can add a concatenation operator if necessary, and so that the increment at the bottom of the loop works as intended
i+=(numDigits-1)// I have to move back a step, so that I can add a concatenation operator if necessary, and so that the increment at the bottom of the loop works as intended
}elseifunicode.IsDigit(re_runes[i]){// Any other number - backreference
numDigits:=1
fori+numDigits<len(re_runes)&&unicode.IsDigit(re_runes[i+numDigits]){// Skip while we see a digit
ifi<len(re_runes)&&(re_runes[i]!='('&&re_runes[i]!=nonCapLparenRune&&re_runes[i]!='|'&&re_runes[i]!='\\')||(i>0&&re_runes[i-1]=='\\'){// Every character should be concatenated if it is escaped
ifi<len(re_runes)&&(re_runes[i]!='('&&re_runes[i]!=nonCapLparenRune&&re_runes[i]!='|'&&re_runes[i]!='\\')||(i>0&&re_runes[i-1]=='\\'){// Every character should be concatenated if it is escaped
parenIndices:=make([]Group,0)// I really shouldn't be using Group here, because that's strictly for matching purposes, but its a convenient way to store the indices of the opening and closing parens.
parenIndices=append(parenIndices,Group{0,0})// I append a weird value here, because the 0-th group doesn't have any parens. This way, the 1st group will be at index 1, 2nd at 2 ...
i+=numDigitsParsed-1// Shift forward by the number of digits that were parsed. Move back one character, because the loop increment will move us back to the next character automatically
i+=numDigitsParsed-1// Shift forward by the number of digits that were parsed. Move back one character, because the loop increment will move us back to the next character automatically
for(i+numDigitsParsed)<len(re_postfix)-1&&isOctal(re_postfix[i+numDigitsParsed])&&numDigitsParsed<=4{// The '-1' exists, because even in the worst case (the character class extends till the end), the last character must be a closing bracket (and nothing else)
for(i+numDigitsParsed)<len(re_postfix)-1&&isOctal(re_postfix[i+numDigitsParsed])&&numDigitsParsed<=3{// The '-1' exists, because even in the worst case (the character class extends till the end), the last character must be a closing bracket (and nothing else)
}elseif!currentState.isAlternation&&!currentState.isKleene&&!currentState.isQuestion&&!currentState.isBackreference &&!currentState.groupBegin &&!currentState.groupEnd&¤tState.assert==noneAssert{// Normal character
}elseif!currentState.isAlternation&&!currentState.isKleene&&!currentState.isQuestion&&!currentState.groupBegin &&!currentState.groupEnd&¤tState.assert==noneAssert{// Normal character
isKleenebool// Identifies whether current node is a 0-state representing Kleene star
isKleenebool// Identifies whether current node is a 0-state representing Kleene star
isQuestionbool// Identifies whether current node is a 0-state representing the question operator
isQuestionbool// Identifies whether current node is a 0-state representing the question operator
isAlternationbool// Identifies whether current node is a 0-state representing an alternation
isAlternationbool// Identifies whether current node is a 0-state representing an alternation
isLazybool// Only for split states - Identifies whether or not to flip the order of branches (try one branch before the other)
splitState*nfaState// Only for alternation states - the 'other' branch of the alternation ('next' is the first)
splitState*nfaState// Only for alternation states - the 'other' branch of the alternation ('next' is the first)
assertassertType// Type of assertion of current node - NONE means that the node doesn't assert anything
assertassertType// Type of assertion of current node - NONE means that the node doesn't assert anything
allCharsbool// Whether or not the state represents all characters (eg. a 'dot' metacharacter). A 'dot' node doesn't store any contents directly, as it would take up too much space
allCharsbool// Whether or not the state represents all characters (eg. a 'dot' metacharacter). A 'dot' node doesn't store any contents directly, as it would take up too much space
@ -45,11 +44,9 @@ type nfaState struct {
groupBeginbool// Whether or not the node starts a capturing group
groupBeginbool// Whether or not the node starts a capturing group
groupEndbool// Whether or not the node ends a capturing group
groupEndbool// Whether or not the node ends a capturing group
groupNumint// Which capturing group the node starts / ends
groupNumint// Which capturing group the node starts / ends
isBackreferencebool// Whether or not current node is backreference
referredGroupint// If current node is a backreference, the node that it points to
// The following properties depend on the current match - I should think about resetting them for every match.
// The following properties depend on the current match - I should think about resetting them for every match.
threadGroups []Group// Assuming that a state is part of a 'thread' in the matching process, this array stores the indices of capturing groups in the current thread. As matches are found for this state, its groups will be copied over.
zeroMatchFoundbool// Whether or not the state has been used for a zero-length match - only relevant for zero states
threadBackref int// If current node is a backreference, how many characters to look forward into the referred group
threadGroups []Group// Assuming that a state is part of a 'thread' in the matching process, this array stores the indices of capturing groups in the current thread. As matches are found for this state, its groups will be copied over.
varinfinite_repsint=-1// Represents infinite reps eg. the end range in {5,}
varinfinite_repsint=-1// Represents infinite reps eg. the end range in {5,}
// This represents a node in the postfix representation of the expression
// This represents a node in the postfix representation of the expression
typepostfixNodestruct{
typepostfixNodestruct{
nodetypenodeType
nodetypenodeType
contents[]rune// Contents of the node
contents[]rune// Contents of the node
startRepsint// Minimum number of times the node should be repeated - used with numeric specifiers
startRepsint// Minimum number of times the node should be repeated - used with numeric specifiers
endRepsint// Maximum number of times the node should be repeated - used with numeric specifiers
endRepsint// Maximum number of times the node should be repeated - used with numeric specifiers
allCharsbool// Whether or not the current node represents all characters (eg. dot metacharacter)
allCharsbool// Whether or not the current node represents all characters (eg. dot metacharacter)
except[]postfixNode// For inverted character classes, we match every unicode character _except_ a few. In this case, allChars is true and the exceptions are placed here.
except[]postfixNode// For inverted character classes, we match every unicode character _except_ a few. In this case, allChars is true and the exceptions are placed here.
lookaroundSignint// ONLY USED WHEN nodetype == ASSERTION. Whether we have a positive or negative lookaround.
lookaroundSignint// ONLY USED WHEN nodetype == ASSERTION. Whether we have a positive or negative lookaround.
lookaroundDirint// Lookbehind or lookahead
lookaroundDirint// Lookbehind or lookahead
nodeContents[]postfixNode// ONLY USED WHEN nodetype == CHARCLASS. Holds all the nodes inside the given CHARCLASS node.
nodeContents[]postfixNode// ONLY USED WHEN nodetype == CHARCLASS. Holds all the nodes inside the given CHARCLASS node.
referencedGroupint// ONLY USED WHEN nodetype == backreferenceNode. Holds the group which this one refers to. After parsing is done, the expression will be rewritten eg. (a)\1 will become (a)(a). So the return value of ShuntingYard() shouldn't contain a backreferenceNode.
isLazybool// ONLY USED WHEN nodetype == kleene or question
}
}
// Converts the given list of postfixNodes to one node of type CHARCLASS.
// Converts the given list of postfixNodes to one node of type CHARCLASS.
// groupIncrement := 0 // If we have a backreference before the group its referring to, then the group its referring to will have its group number incremented.
// rtv = slices.Concat(rtv, nodes[parenIndices[node.referencedGroup].StartIdx:parenIndices[node.referencedGroup].EndIdx+1]) // Add all the nodes in the group to rtv
// numGroups += 1
// if i < parenIndices[node.referencedGroup].StartIdx {
// Numeric range tests - this is a feature that I added, and doesn't exist
// Numeric range tests - this is a feature that I added, and doesn't exist
// in any other mainstream regex engine
// in any other mainstream regex engine
@ -538,30 +520,6 @@ var reTests = []struct {
{`<389-400`,nil,`-`,nil},
{`<389-400`,nil,`-`,nil},
{`<389-400>`,nil,`391`,[]Group{{0,3}}},
{`<389-400>`,nil,`391`,[]Group{{0,3}}},
{`\b<1-10000>\b`,nil,`America declared independence in 1776.`,[]Group{{33,37}}},
{`\b<1-10000>\b`,nil,`America declared independence in 1776.`,[]Group{{33,37}}},
{`\p{Tamil}+`,nil,`உயிரெழுத்து`,[]Group{{0,11}}},// Each letter and matra is counted as a separate rune, so 'u', 'ya', 'e (matra), 'ra', 'e (matra)', 'zha', (oo (matra), 'tha', 'ith', 'tha', 'oo (matra)'.