# GlobPattern¶

class GlobPattern

This class can be used to test for string matches against standard Unix- shell filename globbing conventions. It serves as a portable standin for the Posix fnmatch() call.

A GlobPattern is given a pattern string, which can contain operators like *, ?, and []. Then it can be tested against any number of candidate strings; for each candidate, it will indicate whether the string matches the pattern or not. It can be used, for example, to scan a directory for all files matching a particular pattern.

Inheritance diagram

GlobPattern(std::string const &pattern = string())
GlobPattern(GlobPattern const &copy)
bool get_case_sensitive(void) const

Returns whether the match is case sensitive (true) or case insensitive (false). The default is case sensitive.

std::string get_const_prefix(void) const

Returns the initial part of the pattern before the first glob character. Since many glob patterns begin with a sequence of static characters and end with one or more glob characters, this can be used to optimized searches through sorted indices.

std::string const &get_nomatch_chars(void) const

Returns the set of characters that are not matched by * or ?.

std::string const &get_pattern(void) const

Returns the pattern string that the GlobPattern object matches.

bool has_glob_characters(void) const

Returns true if the pattern includes any special globbing characters, or false if it is just a literal string.

int match_files(vector_string &results, Filename const &cwd = Filename()) const
PyObject *match_files(Filename const &cwd = Filename()) const

Treats the GlobPattern as a filename pattern, and returns a list of any actual files that match the pattern. This is the behavior of the standard Posix glob() function. Any part of the filename may contain glob characters, including intermediate directory names.

If cwd is specified, it is the directory that relative filenames are taken to be relative to; otherwise, the actual current working directory is assumed.

The return value is the number of files matched, which are added to the results vector.

bool matches(std::string const &candidate) const

Returns true if the candidate string matches the pattern, false otherwise.

bool matches_file(Filename candidate) const

Treats the GlobPattern as a filename pattern, and returns true if the given filename matches the pattern. Unlike matches(), this will not match slash characters for single asterisk characters, and it will ignore path components that only contain a dot.

void output(std::ostream &out) const
void set_case_sensitive(bool case_sensitive)

Sets whether the match is case sensitive (true) or case insensitive (false). The default is case sensitive.

void set_nomatch_chars(std::string const &nomatch_chars)

Specifies a set of characters that are not matched by * or ?.

void set_pattern(std::string const &pattern)

Changes the pattern string that the GlobPattern object matches.