MATCHES

The MATCHES operator returns TRUE if a string matches a given mask.

Syntax

expr [NOT] MATCHES mask [ ESCAPE "char" ]

expr is any character string expression.
mask is a character string expression defining the filter.
char is a single char specifying the escape symbol.

Usage

The mask can be any combination of characters, including the *, ?, [, ], - and ^ wildcards:

The * star character matches any string of zero or more characters.
The ? question mark matches any single character.
The [ ] brackets match any enclosed character.
Inside [ ], the - (hyphen) between characters means a range of characters.
Inside [ ], the ^ An initial caret matches any character that is not listed.

The ESCAPE clause can be used to define an escape character different from the default backslash. It must be enclosed in single or double quotes.

A backslash (or the escape character specified by the ESCAPE clause) makes the operator treat the next character as a literal character, even if it is one of the special symbols in the mask list. This allows you to search for wildcard charachers such as *, ?, [, ] or \.

If you need to escape a wildcard character, keep in mind that a string constant must also escape the backslash character. As a result, if you want to pass a backslash to the MATCHES operator (by using backslash as default escape character), you need to write four backslashes in the original string constant.

The next table shows some examples of string constants used in the source code and their equivalent MATCHES pattern:

Table 1. String constants used in the source code and their equivalent `MATCHES` pattern
Original String Constant	Equivalent MATCHES pattern	Description
`"*"`	`*`	Matches any character in a non-empty string.
`"?"`	`?`	Matches a single character.
`"abc*"`	`abc*`	Starts with abc.
`"*abc"`	`*abc`	Ends with abc.
`"abc"`	`abc`	Contains abc.
`"abc??"`	`abc??`	Starts with abc, followed by two additional characters.
`"[a-z]*"`	`[a-z]*`	Starts with a letter in the range a to z.
`"[^0-9]*"`	`[^0-9]*`	Must not start with a digit.
`"\\*"`	`\*`	Contains a single star character (the * wildcard is escaped)
`"abc\\\\def"`	`abc\\def`	Contains abc followed by a backslash followed by def (the backslash is escaped)

Example

MAIN
  IF "55f-plot" MATCHES "55[a-z]-*" THEN
     DISPLAY "Item reference format is correct."
  END IF
END MAIN