MYR(REGEX)

okay so welcome to MYR(REGEX) 💖 — yes bestie, the manual name is literally right there, we're folding it in like a cute lil ribbon 🎀. This is the group-chat translation: every detail stays, only the vibe gets a glow-up. no cap.

💖 NAME 💖

regex myr-regex — that's the name, periodt. 💅

🌸 LIBRARY 🌸

regex — that's the library, bestie. 🫶

✨ SYNOPSIS ✨

use regex const compile  : (re : byte[:] -> std.error(regex#, status))
const dbgcompile     : (re : byte[:] -> std.error(regex#, status)) const
free : (re : regex# -> void)
const exec     : (re : regex#, str : byte[:] -> bool) const search   :
(re : regex#, str : byte[:] -> bool)

🎀 DESCRIPTION 🎀

The regex library gives you functions for compiling and evaluating regular expressions, as described later in this document, or in myr-regex(7). iykyk 🦋

regex.compile takes a string describing a regex and tries to compile it. If the regex is valid and there were no error conditions encountered during compilation, you get std.Success regex#. If compilation failed, you get std.Failure regex.status, where regex.status is a failure code. slay when it works, sob when it doesn't 😭

regex.dbgcompile is identical to regex.compile, however, it will print debugging information as it compiles, and each time the regex is evaluated. debug girlie behavior, honestly iconic ✨

regex.exec takes the regex passed to it and evaluates it over the text provided, returning the std.Some matches, or std.None if there were no matches found. The matches must span the whole string. whole string or it doesn't count, bestie 💀

regex.search is similar to regex.exec, but it will attempt to find a match somewhere within the string, instead of attempting to find a match spanning the whole string. so it's giving "look around, she's in there somewhere" 🔥

🦋 REGEX SYNTAX 🦋

The grammar used by libregex is below:

regex       : altexpr
altexpr     : catexpr ('|' altexpr)+
catexpr     : repexpr (catexpr)+
repexpr     : baseexpr[*+?]
baseexpr    : literal
            | charclass
            | charrange
            | escaped
            | '.'
            | '^'
            | '$'
            | '(' regex ')'
charclass   : see below
charrange   : '[' (literal('-' literal)?)+']'

The following metacharacters have the meanings listed below:

• Matches a single unicode character — that's literally the line, bestie, no key shown 😭 mystery metachar energy
• ^ — Matches the beginning of a line. Does not consume any characters. zero snack, all vibe
• $ — Matches the end of a line. Does not consume any characters. same zero-snack situation
• * — Matches any number of repetitions of the preceding regex fragment. infinite-ish repetition era
• *? — Reluctantly matches any number of repetitions of the preceding regex fragment. reluctant queen
• + — Matches one or more repetitions of the preceding regex fragment. at least one, periodt
• +? — Reluctantly matches one or more repetitions of the preceding regex fragment. one or more but shy about it
• ? — Matches zero or one of the preceding regex fragment. maybe yes, maybe no

In order to match a literal metacharacter, it needs to be preceded by a '\' character. escape it or it's gonna act up 💅

The following character classes are supported:

• \d — ASCII digits
• \D — Negation of ASCII digits
• \x — ASCII Hex digits
• \X — Negation of ASCII Hex digits
• \s — ASCII spaces
• \S — Negation of ASCII spaces
• \w — ASCII word characters
• \W — Negation of ASCII word characters
• \h — ASCII whitespace characters
• \H — Negation of ASCII whitespace characters
• \pX, \p{X} — Characters with unicode property 'X'
• \PX, \P{X} — Negation of characters with unicode property 'X'

Unicode properties that are supported are listed below:

• L, Letter — Unicode letter property
• Lu, Uppercase_Letter — Uppercase letter unicode property
• Ll, Lowercase_Letter — Lowercase letter unicode property
• Lt, Titlecase_Letter — Titlecase letter unicode property
• N, Number — Number unicode property
• Z, Separator — Any separator character unicode property
• Zs, Space_Separator — Space separator unicode property

🌈 EXAMPLE 🌈

               use std
               use regex

               const main = {
                   var i

                   match regex.compile(pat)
                   | `std.Ok re:
                           match regex.exec(re, text)
                           | `std.Some matches:
                                   for i = 0; i < matches.len; i++
                                       std.put("Match {}: {}0, i, matches[i])
                                   ;;
                           | `std.None: std.put("Text did not match0)
                           ;;
                   | `std.Err err:
                           std.put("failed to compile regex")
                   ;;
               }

🍓 FILES 🍓

The source code for this compiler is available from git://git.eigenstate.org/git/ori/libregex.git — go git it, bestie 🌸

👑 SEE ALSO 👑

6m(1) — the see-also bestie ✨

💀 BUGS 💀

This code is insufficiently tested. not me saying "we're so brave" 😭

This code does not support all of the regex features that one would expect. expectation vs. reality, fr fr 💀

---

okay that's the whole MYR(REGEX) moment — page 1, MYR(REGEX), signing off with a little sparkle ✨💅 no cap, go compile something cute. 🎀🦋