Frontier Pattern |
|
%f
is undocumented in the standard Lua references (for reasons why see LuaList:2006-12/msg00536.html).
I would like to present here the usefulness of it, in an attempt to show how it can be used, and why it should be retained.
Nb., the frontier pattern was retained in Lua v. 5.2 and is now documented in the Lua v. 5.2 Reference Manual section 6.4.1. Patterns.
Let's consider a fairly straightforward task: to find all words in upper-case in a string.
string.gsub ("the QUICK brown fox", "%u+", print) QUICK
That looks OK, found a word in all caps. But look at this:
string.gsub ("the QUICK BROwn fox", "%u+", print) QUICK BRO
We also found a word which was partially capitalised.
string.gsub ("the QUICK BROwn fox", "%u+%A", print) QUICK
The detection of non-letters correctly excluded the partially capitalised word. But wait! How about this:
string.gsub ("the QUICK brOWN fox", "%u+%A", print) QUICK OWN
We also have a second problem:
string.gsub ("the QUICK. brown fox", "%u+%A", print) QUICK.
The punctuation after the word is now part of the captured string, which is not wanted.
string.gsub ("the QUICK brOWN FOx jumps", "%A%u+%A", print) QUICK
This correctly excludes the two partially capitalised words, but still leaves the punctuation in, like this:
string.gsub ("the (QUICK) brOWN FOx jumps", "%A%u+%A", print) (QUICK)
Also, there is another problem, apart from capturing the non-letters at the sides. Look at this:
string.gsub ("THE (QUICK) brOWN FOx JUMPS", "%A%u+%A", print) (QUICK)
The correctly capitalised words at the start and end of the string are not detected.
string.gsub ("THE (QUICK) brOWN FOx JUMPS", "%f[%a]%u+%f[%A]", print) THE QUICK JUMPS
The frontier pattern %f followed by a set detects the transition from "not in set" to "in set". The source string boundary qualifies as "not in set" so it also matches the word at the very start of the string to be matched.
The second frontier pattern is also matched at the end of the string, so our final word is also captured.
Without the frontier pattern, one might resort to things like this:
s = "THE (QUICK) brOWN FOx JUMPS" s = "\0" .. s:gsub("(%A)(%u)", "%1\0%2") :gsub("(%u)(%A)", "%1\0%2") .. "\0" s = s:gsub("%z(%u+)%z", print)
('_'..s..'_'):gsub('%A(%u+)%A', print)
s = "THE QUICK brOWN FOx JUMPS" ('_'..s..'_'):gsub('%A(%u+)%A', print) --> THE JUMPS
(' '..s..' '):gsub('%A+', ' '):gsub(' (%u+) ', print) --> THE QUICK JUMPS
s:gsub('%a+', ' %1 '):gsub(' (%u+) ', print) --> THE QUICK JUMPS
s = "THE QUICK brOWN FOx JUMPS over" s:gsub('%a+', ' %1 ') -- identify words with ' (%a+) ' -- (all following patterns match a subset of this) :gsub(' %u+%l+%a* ', '') -- subtract mixed case words starting with upper :gsub(' %l+%u+%a* ', '') -- subtract mixed case words starting with lower :gsub(' %a%a?%a? ', '') -- subtract words with 1-3 characters :gsub(' (%a+) ', print) -- extract words --> QUICK JUMPS over