Public Member Functions

GlobPattern Class Reference

This class can be used to test for string matches against standard Unix-shell filename globbing conventions. More...

#include "globPattern.h"

List of all members.

Public Member Functions

 GlobPattern (const string &pattern=string())
 GlobPattern (const GlobPattern &copy)
bool get_case_sensitive () const
 Returns whether the match is case sensitive (true) or case insensitive (false).
string get_const_prefix () const
 Returns the initial part of the pattern before the first glob character.
const string & get_nomatch_chars () const
 Returns the set of characters that are not matched by or ?.
const string & get_pattern () const
 Returns the pattern string that the GlobPattern object matches.
bool has_glob_characters () 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, const Filename &cwd=Filename()) const
 Treats the GlobPattern as a filename pattern, and returns a list of any actual files that match the pattern.
bool matches (const string &candidate) const
 Returns true if the candidate string matches the pattern, false otherwise.
bool operator!= (const GlobPattern &other) const
bool operator< (const GlobPattern &other) const
void operator= (const GlobPattern &copy)
bool operator== (const GlobPattern &other) const
void output (ostream &out) const
void set_case_sensitive (bool case_sensitive)
 Sets whether the match is case sensitive (true) or case insensitive (false).
void set_nomatch_chars (const string &nomatch_chars)
 Specifies a set of characters that are not matched by or ?.
void set_pattern (const string &pattern)
 Changes the pattern string that the GlobPattern object matches.

Detailed Description

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.

Definition at line 37 of file globPattern.h.

Member Function Documentation

bool GlobPattern::get_case_sensitive ( ) const [inline]

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

The default is case sensitive.

Definition at line 124 of file globPattern.I.

string GlobPattern::get_const_prefix ( ) 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.

Definition at line 57 of file globPattern.cxx.

Referenced by AsyncTaskManager::find_tasks_matching().

const string & GlobPattern::get_nomatch_chars ( ) const [inline]

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

Definition at line 146 of file globPattern.I.

const string & GlobPattern::get_pattern ( ) const [inline]

Returns the pattern string that the GlobPattern object matches.

Definition at line 100 of file globPattern.I.

bool GlobPattern::has_glob_characters ( ) const

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

Definition at line 26 of file globPattern.cxx.

int GlobPattern::match_files ( vector_string &  results,
const Filename &  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.

Definition at line 99 of file globPattern.cxx.

bool GlobPattern::matches ( const string &  candidate) const [inline]

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

Definition at line 157 of file globPattern.I.

Referenced by NodePath::find_all_materials(), NodePath::find_all_texcoords(), NodePath::find_all_texture_stages(), NodePath::find_all_textures(), NodePath::find_all_vertex_columns(), AsyncTaskManager::find_tasks_matching(), ConfigVariableManager::make_variable(), ConfigVariableManager::make_variable_template(), QtessInputEntry::match(), MayaNodeTree::tag_joint_named(), MayaNodeTree::tag_named(), and MayaNodeTree::untag_named().

void GlobPattern::set_case_sensitive ( bool  case_sensitive) [inline]

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

The default is case sensitive.

Definition at line 112 of file globPattern.I.

Referenced by TxaLine::parse(), and ConfigPageManager::reload_implicit_pages().

void GlobPattern::set_nomatch_chars ( const string &  nomatch_chars) [inline]

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

Definition at line 135 of file globPattern.I.

void GlobPattern::set_pattern ( const string &  pattern) [inline]

Changes the pattern string that the GlobPattern object matches.

Definition at line 89 of file globPattern.I.

The documentation for this class was generated from the following files: