#include <gimbal_pattern.h>

Related Symbols
(Note that these are not member symbols.)
Lifetime Management
Methods for creating, referencing, and unreferencing patterns
const GblPattern *	GblPattern_create (const char *pRegExp)

const GblPattern *	GblPattern_ref (const GblPattern *pSelf)

GblRefCount	GblPattern_unref (const GblPattern *pSelf)

GblRefCount	GblPattern_refCount (const GblPattern *pSelf)

GblRefCount	GblPattern_totalCount (void)

Properties and Operators
Methods for getters and basic operations
int	GblPattern_compare (const GblPattern pSelf, const GblPattern pRhs)

GblBool	GblPattern_equals (const GblPattern pSelf, const GblPattern pRhs)

size_t	GblPattern_bytes (const GblPattern *pSelf)

const char *	GblPattern_string (const GblPattern pSelf, GblStringBuffer pBuff)

Matching
Methods for generic pattern matching
GblBool	GblPattern_match (const GblPattern pSelf, const char pString, GblStringView pMatch, int pCount)

GblBool	GblPattern_matchStr (const char pRegExp, const char pString, GblStringView pMatch, int pCount)

Inverse Matching
Methods for returning non matches
GblBool	GblPattern_matchNot (const GblPattern pSelf, const char pString, GblStringView pMatch, int pCount)

GblBool	GblPattern_matchNotStr (const char pRegExp, const char pString, GblStringView pMatch, int pCount)

Exact Matching
Methods for checking exact matches
GblBool	GblPattern_matchExact (const GblPattern pSelf, const char pString)

GblBool	GblPattern_matchExactStr (const char pRegExp, const char pString)

Match Counting
Methods used for counting matches
size_t	GblPattern_matchCount (const GblPattern pSelf, const char pString)

size_t	GblPattern_matchCountStr (const char pRegExp, const char pString)

Detailed Description

Opaque structure containing a compiled regular expression.

GblPattern is the compiled version of a regular expression string, produced by GblPattern_create(). It is faster than working with raw regular expression strings, since preprocessing has already been done.

It is advised that when you are repeatedly using the same regular expression, you store it and use it as a GblPattern.

Note: GblPattern is a reference-counted shared pointer type.

Friends And Related Symbol Documentation

◆ GblPattern_create()

const GblPattern * GblPattern_create ( const char * pRegExp )

◆ GblPattern_ref()

const GblPattern * GblPattern_ref ( const GblPattern * pSelf )

◆ GblPattern_unref()

GblRefCount GblPattern_unref ( const GblPattern * pSelf )

◆ GblPattern_refCount()

GblRefCount GblPattern_refCount ( const GblPattern * pSelf )

◆ GblPattern_totalCount()

GblRefCount GblPattern_totalCount ( void )

◆ GblPattern_compare()

int GblPattern_compare	(	const GblPattern *	pSelf,
		const GblPattern *	pRhs
	)

◆ GblPattern_equals()

GblBool GblPattern_equals	(	const GblPattern *	pSelf,
		const GblPattern *	pRhs
	)

◆ GblPattern_bytes()

size_t GblPattern_bytes ( const GblPattern * pSelf )

◆ GblPattern_string()

const char * GblPattern_string	(	const GblPattern *	pSelf,
		GblStringBuffer *	pBuff
	)

◆ GblPattern_match()

GblBool GblPattern_match	(	const GblPattern *	pSelf,
		const char *	pString,
		GblStringView *	pMatch,
		int *	pCount
	)

GblPattern_match() searches through pString for substrings which match the pattern given by pSelf. When it has found the number of matches equal to the value given by pCount (or 1 if pCount is NULL), pMatch is set to the substring of the final match (or ignored when NULL) and GBL_TRUE is returned. If the match could not be found, GBL_FALSE is returned.

Note: When pCount points to a value of 0, no matches are expected to be found. If a match is found, GBL_FALSE is returned, otherwise GBL_TRUE is returned (inverted from normal).; When pCount points to a value of -1, all matches are searched, with pMatch being updated to point to the final one and pCount being updated to store the final number of matches.

Parameters

pSelf	The precompiled regular expression pattern
pString	The input string to search for matches within
pMatch	(Optional) Output used to hold the final match substring
pCount	(Optional, defaults to 1) Number of matches to find

Return values

GBL_FALSE	The requested match number wasn't found.
GBL_TRUE	The requested match number was found.

See also: GblPattern_matchNot()

◆ GblPattern_matchStr()

GblBool GblPattern_matchStr	(	const char *	pRegExp,
		const char *	pString,
		GblStringView *	pMatch,
		int *	pCount
	)

◆ GblPattern_matchNot()

GblBool GblPattern_matchNot	(	const GblPattern *	pSelf,
		const char *	pString,
		GblStringView *	pMatch,
		int *	pCount
	)

◆ GblPattern_matchNotStr()

GblBool GblPattern_matchNotStr	(	const char *	pRegExp,
		const char *	pString,
		GblStringView *	pMatch,
		int *	pCount
	)

◆ GblPattern_matchExact()

GblBool GblPattern_matchExact	(	const GblPattern *	pSelf,
		const char *	pString
	)

◆ GblPattern_matchExactStr()

GblBool GblPattern_matchExactStr	(	const char *	pRegExp,
		const char *	pString
	)

◆ GblPattern_matchCount()

size_t GblPattern_matchCount	(	const GblPattern *	pSelf,
		const char *	pString
	)

◆ GblPattern_matchCountStr()

size_t GblPattern_matchCountStr	(	const char *	pRegExp,
		const char *	pString
	)

The documentation for this struct was generated from the following file:

gimbal_pattern.h

Related Symbols