String Patterns

This is an intermediate, scripting related tutorial.

What are String Patterns?

String patterns are, in essence, just strings. What makes them different from ordinary strings then, you ask? String patterns are strings that use a special combination of characters. These characters combinations are generally used with functions in the string library such as 'string.match' and 'string.gsub' to do interesting things with strings. For instance, with string patterns you can do something like this:

local s = "I am a string!"
for i in string.gmatch(s, "%S+") do --Where "%S+" is the string pattern.
    print(i)
end

I am a

string!

But what makes the code above so cool? Perhaps you've wanted to make a list of people without using a table, or maybe you need to parse a string. String patterns can help do this!

As said before, string patterns are strings that look a little different and are used for a different purpose than what strings are usually used for. Here we will look at the basics of just what make a string pattern up. Here we will look at just what the different parts of a string pattern mean.

In these examples, we will use the string.match function.

Simple matching

Guess what? You already know some string patterns! Any string is a pattern!

local pattern = "Roblox"
print( ("Welcome to Roblox"):match(pattern) )
print( ("Welcome to the Wiki"):match(pattern) )

Roblox

nil

Character Classes

There's only so far we can go by using this kind of pattern matching. Sometimes, we want to match any of a set of characters. Here's an example:

local pattern = "%d words"
print( ("This sentence has 5 words"):match(pattern) )
print( ("This one has more than 2 words"):match(pattern) )

5 words

2 words

The following table shows the meaning of each character class:

Pattern	Represents	Example matches
.	Any character	#32kas321fslk#?@34
%a	An uppercase or lowercase letter	aBcDeFgHiJkLmNoPqRsTuVwXyZ
%l	A lowercase letter	abcdefghijklmnopqrstuvwxyz
%u	An uppercase letter	ABCDEFGHIJKLMNOPQRSTUVWXYZ
%p	Any punctuation character	#^;,.
%w	An alphanumeric character - either a letter or a digit	aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789
%d	Any Digit	0123456789
%s	A whitespace character	, \n, and \r
%c	A control character
%x	A hexadecimal (Base 16) digit	0123456789ABCDEF
%z	The NULL character, '\0'
%f	The frontier pattern (not officially documented)
%bxy	The balanced capture. It matches x, y, and everything in between. It allows for the nesting of balanced captures as well. (Note: x and y must be different)	%b() captures everything between parentheses (included them).

Any non-magic character (not one of ^$()%.[]*+-?), represents itself in a pattern. To search for a literal magic character, precede it by a space - for example, to look for a percent symbol, use %%.

One of the things you might notice about the character classes above is that they are all lowercase. Making them uppercase reverses their effect. For instance, %s represents whitespace, but %S represents any non-whitespace character. %l represents a lowercase letter while %L represents its compliment - any characters but a lowercase letter. Let's look at this example, which matches a digit, followed by four non-digits:

local pattern = "%d%D%D%D%D%D"
print( ("This sentence has 5 words"):match(pattern) )
print( ("21 times 3 equals 63"):match(pattern) )

5 word

1 time

Quantifiers

Character classes allow you to match any character. Quantifiers allow you to match any number of characters

Pattern	Meaning
?	Match 0 or 1 of the preceding character specifier
*	Match 0 or more of the preceding character specifier
+	Match 1 or more of the preceding character specifier
-	Match as few of the preceding character specifier as possible

The + quantifier

Let's say you have a string that contains a number, such as "It costs 100 tix", and you want to extract the number. If you know how many digits the number has, you could use the pattern %d%d%d which would match three digits in a row. But what happens if you don't know how many digits there are? For this, you can use quantifiers. In this example, the + quantifier is suitable.

local pattern = "%d+"
print( ("It costs 100 tix"):match(pattern) ) 
print( ("It costs OVAR 9000 tix"):match(pattern) )

100

9000

Now how does this work exactly? As we know, a character class followed by a '+' matches one or more repetitions. For this example, it means that it would match the first digits it finds until it reaches the end of the string or a non-digit.

The * quantifier

The difference between + and * is that + matches 1 or more characters, while * matches 0 or more. This means that if the character class that is followed by this quantifier isn't represented in the string, it doesn't matter, because no matches are required.

local pattern = "%d%p*%d" --Matches a digit followed by 0 or more punctuation character followed by another digit.
print( ("1,!643"):match(pattern) )
print( ("12349"):match(pattern) )

1,!6

12

As you can see, it matches a digit, punctuation characters (if there are any), and then another digit. If you had used +, the second example would have returned nil, because + requires at least one match. The * pattern is very useful when you have something in the string that is optional.

The - quantifier

Unlike * and +, - matches the shortest possible sequence. For example, if you have a path name, and you want to retrieve a part of the string between /s, then you can use the - item. This example shows you the difference you'd get if you used '-' compared to the '*' item.

local s = "C:/Users/Telamon/Documents"
print( s:match("/.-/") )
print( s:match("/.+/") )

/Users/

/Users/Telamon/

From the example, you see that the - found the shortest possible sequence and stopped at the second /, while the * matched the longest sequence and stopped only at the last / in the string.

The ? quantifier

The ? quantifier is used to make certain characters in the string optional.

local pattern = "wik?is?"
print( ("This is the wiki"):match(pattern) )
print( ("There are multiple wikis"):match(pattern) )
print( ("You do not spell it wikki"):match(pattern) )
print( ("This is not a wii"):match(pattern) )

wiki wikis nil

wii

From the example you can see that the ? made the s and k optional, allowing the pattern to match "wii" and "wikis". However, only one k was allowed, so wikki was not matched

Sets

Sets are used when a single character class cannot do the whole job. For instance, you might want to match both lowercase letters (%l) as well as punctuation characters (%p) using a single class. So how would we do this? Let's take a look at this example:

local s = "123 Hello! I am another string."
local pattern = "[%l%p]+"
print( s:match(pattern) )

ello!

As you can see from the example, sets are defined by the '[' and ']' around them. You also see that the classes for lowercase letters and punctuation are contained within. This means that the set will act as a class that represents both lowercase and punctuation, unlike if you used %l%p, which would match a lowercase letter and a punctuation character following it.

You aren't restricted to using only character classes, though! You can also use normal characters to add to the set. Also, you can specify a range of characters with the '-' symbol. Let's see how this works in the following example:

--A sequence of threes, underscores, and lowercase letters
local pattern = "[3_%l]+"

for match in ("Random_123"):gmatch(pattern) do
    print(match)
end

andom_

3

--A sequence of the numbers 1 to 4 and uppercase letters
local pattern = "[1-4%u]+"

for match in ("37913 Sandwiches!"):gmatch(pattern) do
    print(match)
end

3 13

S

From the example, you can see how string.gmatch manipulated strings s1 and s2 using the string patterns. And yet, there's still one last thing you can do. Like with character classes, sets have compliments of themselves.

--A sequence of characters which are neither spaces nor one of the numbers 1 to 9
local pattern = "[^%s1-9]+" 

local result = ""
for match in ("He29ll0, I like strings1"):gmatch(pattern) do
    result = result .. match
end
print(result)

Hell0,Ilikestrings

This pattern is the compliment of [%s1-9]. As seen from the example, the compliment of a set is defined by using the ^ character at the beginning of the set. All this does is reverse the meaning of the set. As you can easily see from this example, the spaces, the number 29 in the middle of 'Hello', and the 1 at the end were removed.

Captures

Captures are used to get pieces of a string that match a capture. Captures are defined by parentheses around them. For instance, (%a%s) is a capture for a letter and a space character. When a capture is matched, it is then stored for future use. Let's look at this example:

local pattern = "(%a+)%s=%s(%d+)"

key, val = ("TwentyOne = 21"):match(Pattern)
print( key )
print( val )

TwentyOne

21

Now what happens if you want to get a list by using captures? You can use string.gmatch to do this.

local pattern = "(%a+)%s?=%s?(%d+)" --Captures a string of letters seperated by an optional space, an equal, and an optional space and then captures a string of numbers
local s = "TwentyOne = 21 Two=2 One =7 Four= 4"
for key, val in s:gmatch(pattern) do --You see how gmatch returns the captures instead of the matches to the pattern here.
    print( key, val )
end

TwentyOne 21 Two 2 One 7

Four 4

Note that 'key' and 'val' are actually referring to capture 1 and capture 2. The name does not matter, but it is still a good practice to choose a relevant name. As you can see, string.gmatch iterated through all the matches in the string and returned only the captures which is basically what captures are for, to capture a certain part of the string to use.

A final thing you can do with captures is that you can leave the captures empty. In these cases they will capture the current position on the string. This means that unlike the other, non-empty captures, a number is returned instead of a string. Look at this example:

local pattern = "()%a+()" --Captures the location of the first character, skips over a string of letters, and then captures the next character's position.
local cap1, cap2 = ("Hello!"):match(pattern)
print( cap1, cap2 )

1 6

From the example, once a match was found, string.find returned the first and second captures' positions in the string instead of returning the characters 'H' and '!'.

See also

• String Manipulation
• Lua 5.1 Reference Manual: String Patterns
• Programming in Lua: Patterns