Update docs & tests for backtracing support

Timothy-Gonzalez · Feb 12, 2024 · 10fd74c · 10fd74c
1 parent b9495e8
commit 10fd74c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -70,7 +70,7 @@ Match specifiers are specified with `$`:
 - `$s` = match a string (at least 1 character)
 - `$$` = a literal $
 - Anything else = literal match
-- **Note:** Having two greedy operators like $s without a literal match between them (`$s$s`) will fail
+- **Note:** Supports backtracing so `abc` will match `$s$s` but `a` won't
 
 ## Expect Assertions
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -165,14 +165,14 @@ TEST("str - match")
 
     EXPECT_STR("a 123c number char", match, "a $i$c number char");
     EXPECT_STR("two nice looking - awesome beings strings", match, "two $s - $s strings");
+    EXPECT_STR("will backtrace", match, "$s$s");
 
     EXPECT_STR("abc", not match, "def");
     EXPECT_STR("the char is missing: ", not match, "the char is missing: $c");
     EXPECT_STR("the no alpha 123 match", not match, "the no alpha $a match");
     EXPECT_STR("the no whitespace \t match", not match, "the no whitespace $w match");
     EXPECT_STR("the string is missing: ", not match, "the string is missing: $s");
     EXPECT_STR("not a match", not match, "not a $s match");
-    EXPECT_STR("too greedy", not match, "$s$s");
 }
 ```
 

diff --git a/tests/str.c b/tests/str.c
@@ -39,14 +39,22 @@ TEST("str - match")
 
     EXPECT_STR("a 123c number char", match, "a $i$c number char");
     EXPECT_STR("two nice looking - awesome beings strings", match, "two $s - $s strings");
+    EXPECT_STR("will backtrace", match, "$s$s");
 
     EXPECT_STR("abc", not match, "def");
     EXPECT_STR("the char is missing: ", not match, "the char is missing: $c");
     EXPECT_STR("the no alpha 123 match", not match, "the no alpha $a match");
     EXPECT_STR("the no whitespace \t match", not match, "the no whitespace $w match");
     EXPECT_STR("the string is missing: ", not match, "the string is missing: $s");
     EXPECT_STR("not a match", not match, "not a $s match");
-    EXPECT_STR("too greedy", not match, "$s$s");
+
+    // Evil test cases (not examples, stress testing verification only)
+    EXPECT_STR("ABC_ABC_ABC", match, "$s_$s_$s");
+    EXPECT_STR("ABC____ABC____ABC", match, "ABC$sABC$sABC");
+    EXPECT_STR("WOW This is cool! WOW This is cool! WOW This is cool! WOW This is cool!",
+               match, "WOW This is cool!$sWOW This is cool!$sWOW This is cool!$sWOW This is cool!");
+    EXPECT_STR("WOW This is cool! WOW This is cool! WOW This is cool! WOW This is cool",
+               not match, "WOW This is cool!$sWOW This is cool!$sWOW This is cool!$sWOW This is cool!");
 }
 
 TEST("str - ptrs")