CSimpleGlobTempl< SOCHAR > Class Template Reference

Implementation of the SimpleGlob class. More...

#include <SimpleGlob.h>

Inheritance diagram for CSimpleGlobTempl< SOCHAR >:

Collaboration diagram for CSimpleGlobTempl< SOCHAR >:

Public Member Functions
	CSimpleGlobTempl (unsigned int a_uiFlags=0, int a_nReservedSlots=0)
	Initialize the class. More...
	~CSimpleGlobTempl ()
	Deallocate all memory buffers. More...
int	Init (unsigned int a_uiFlags=0, int a_nReservedSlots=0)
	Initialize (or re-initialize) the class in preparation for adding new filespecs. More...
int	Add (const SOCHAR *a_pszFileSpec)
	Add a new filespec to the glob. More...
int	Add (int a_nCount, const SOCHAR *const *a_rgpszFileSpec)
	Add an array of filespec to the glob. More...
int	FileCount () const
	Return the number of files in the argv array. More...
SOCHAR **	Files ()
	Return the full argv array. More...
SOCHAR *	File (int n)
	Return the a single file. More...

Private Types
enum	ARG_ARRAY_TYPE { OFFSETS, POINTERS }
	The argv array has it's members stored as either an offset into the string buffer, or as pointers to their string in the buffer. The offsets are used because if the string buffer is dynamically resized, all pointers into that buffer would become invalid. More...

Private Member Functions
void	SetArgvArrayType (ARG_ARRAY_TYPE a_nNewType)
	Change the type of data stored in the argv array. More...
int	AppendName (const SOCHAR *a_pszFileName, bool a_bIsDir)
	Add a filename to the array if it passes all requirements. More...
bool	GrowArgvArray (int a_nNewLen)
	Grow the argv array to the required size. More...
bool	GrowStringBuffer (size_t a_uiMinSize)
	Grow the string buffer to the required size. More...
Private Member Functions inherited from SimpleGlobBase< SOCHAR >
	SimpleGlobBase ()
	~SimpleGlobBase ()
void	FilePrep ()
int	FindFirstFileS (const char *a_pszFileSpec, unsigned int a_uiFlags)
bool	FindNextFileS (char)
void	FindDone ()
const char *	GetFileNameS (char) const
bool	IsDirS (char) const
SG_FileType	GetFileTypeS (const char *a_pszPath) const

Static Private Member Functions
static int	fileSortCompare (const void *a1, const void *a2)
	Compare two (possible NULL) strings. More...

Private Attributes
unsigned int	m_uiFlags
ARG_ARRAY_TYPE	m_nArgArrayType
	is the argv array storing indexes or pointers More...
SOCHAR **	m_rgpArgs
	argv array More...
int	m_nReservedSlots
	number of client reserved slots in the argv array More...
int	m_nArgsSize
	allocated size of array More...
int	m_nArgsLen
	used length More...
SOCHAR *	m_pBuffer
	argv string buffer More...
size_t	m_uiBufferSize
	allocated size of buffer More...
size_t	m_uiBufferLen
	used length of buffer More...
SOCHAR	m_szPathPrefix [MAX_PATH]
	path prefix of any wildcard filenames More...

Detailed Description

template<class SOCHAR>
class CSimpleGlobTempl< SOCHAR >

Implementation of the SimpleGlob class.

Definition at line 431 of file SimpleGlob.h.

Member Enumeration Documentation

template<class SOCHAR>

enum CSimpleGlobTempl::ARG_ARRAY_TYPE

private

The argv array has it's members stored as either an offset into the string buffer, or as pointers to their string in the buffer. The offsets are used because if the string buffer is dynamically resized, all pointers into that buffer would become invalid.

Enumerator
OFFSETS
POINTERS

Definition at line 513 of file SimpleGlob.h.

{ OFFSETS, POINTERS };

Constructor & Destructor Documentation

template<class SOCHAR >

CSimpleGlobTempl< SOCHAR >::CSimpleGlobTempl	(	unsigned int	a_uiFlags = 0,
		int	a_nReservedSlots = 0
	)

Initialize the class.

Parameters

a_uiFlags	Combination of SG_GLOB flags.
a_nReservedSlots	Number of slots in the argv array that should be reserved. In the returned array these slots argv[0] ... argv[a_nReservedSlots-1] will be left empty for the caller to fill in.

Definition at line 547 of file SimpleGlob.h.

{
        m_rgpArgs = NULL;
        m_nArgsSize = 0;
        m_pBuffer = NULL;
        m_uiBufferSize = 0;

        Init(a_uiFlags, a_nReservedSlots);
}

template<class SOCHAR >

CSimpleGlobTempl< SOCHAR >::~CSimpleGlobTempl

(

)

Deallocate all memory buffers.

Definition at line 557 of file SimpleGlob.h.

{
        if (m_rgpArgs)
                free(m_rgpArgs);
        if (m_pBuffer)
                free(m_pBuffer);
}

Member Function Documentation

template<class SOCHAR >

int CSimpleGlobTempl< SOCHAR >::Add

(

const SOCHAR *

a_pszFileSpec

)

Add a new filespec to the glob.

The filesystem will be immediately scanned for all matching files and directories and they will be added to the glob.

Parameters

a_pszFileSpec

Filespec to add to the glob.

Returns

SG_SUCCESS Matching files were added to the glob.

SG_ERR_NOMATCH Nothing matched the pattern. To ignore this error compare the return value to >= SG_SUCCESS.

SG_ERR_MEMORY Out of memory failure.

SG_ERR_FAILURE General failure.

Definition at line 585 of file SimpleGlob.h.

References MAX_PATH, SG_ERR_NOMATCH, SG_FILETYPE_DIR, SG_FILETYPE_INVALID, SG_GLOB_FULLSORT, SG_GLOB_NOCHECK, SG_GLOB_NOSORT, SG_PATH_CHAR, SG_SUCCESS, SimpleGlobUtil::strchr(), SimpleGlobUtil::strcpy_s(), and SimpleGlobUtil::strrchr().

{
#ifdef _WIN32
        // Windows FindFirst/FindNext recognizes forward slash as the same as backward slash
        // and follows the directories. We need to do the same when calculating the prefix
        // and when we have no wildcards.
        SOCHAR szFileSpec[MAX_PATH];
        SimpleGlobUtil::strcpy_s(szFileSpec, MAX_PATH, a_pszFileSpec);
        const SOCHAR *pszPath = SimpleGlobUtil::strchr(szFileSpec, '/');
        while (pszPath) {
                szFileSpec[pszPath - szFileSpec] = SG_PATH_CHAR;
                pszPath = SimpleGlobUtil::strchr(pszPath + 1, '/');
        }
        a_pszFileSpec = szFileSpec;
#endif

        // if this doesn't contain wildcards then we can just add it directly
        m_szPathPrefix[0] = 0;
        if (!SimpleGlobUtil::strchr(a_pszFileSpec, '*') && !SimpleGlobUtil::strchr(a_pszFileSpec, '?')) {
                SG_FileType nType = GetFileTypeS(a_pszFileSpec);
                if (nType == SG_FILETYPE_INVALID) {
                        if (m_uiFlags & SG_GLOB_NOCHECK) {
                                return AppendName(a_pszFileSpec, false);
                        }
                        return SG_ERR_NOMATCH;
                }
                return AppendName(a_pszFileSpec, nType == SG_FILETYPE_DIR);
        }
#ifdef _WIN32
        // Windows doesn't return the directory with the filename, so we need to extract the
        // path from the search string ourselves and prefix it to the filename we get back.
        const SOCHAR *pszFilename = SimpleGlobUtil::strrchr(a_pszFileSpec, SG_PATH_CHAR);
        if (pszFilename) {
                SimpleGlobUtil::strcpy_s(m_szPathPrefix, MAX_PATH, a_pszFileSpec);
                m_szPathPrefix[pszFilename - a_pszFileSpec + 1] = 0;
        }
#endif

        // search for the first match on the file
        int rc = FindFirstFileS(a_pszFileSpec, m_uiFlags);
        if (rc != SG_SUCCESS) {
                if (rc == SG_ERR_NOMATCH && (m_uiFlags & SG_GLOB_NOCHECK)) {
                        int ok = AppendName(a_pszFileSpec, false);
                        if (ok != SG_SUCCESS)
                                rc = ok;
                }
                return rc;
        }
        // add it and find all subsequent matches
        int nError, nStartLen = m_nArgsLen;
        bool bSuccess;
        do {
                nError = AppendName(GetFileNameS((SOCHAR) 0), IsDirS((SOCHAR) 0));
                bSuccess = FindNextFileS((SOCHAR) 0);
        }
        while (nError == SG_SUCCESS && bSuccess);
        SimpleGlobBase < SOCHAR >::FindDone();

        // sort these files if required
        if (m_nArgsLen > nStartLen && !(m_uiFlags & SG_GLOB_NOSORT)) {
                if (m_uiFlags & SG_GLOB_FULLSORT) {
                        nStartLen = m_nReservedSlots;
                }
                SetArgvArrayType(POINTERS);
                qsort(m_rgpArgs + nStartLen, m_nArgsLen - nStartLen, sizeof(m_rgpArgs[0]), fileSortCompare);
        }

        return nError;
}

template<class SOCHAR >

int CSimpleGlobTempl< SOCHAR >::Add	(	int	a_nCount,
		const SOCHAR *const *	a_rgpszFileSpec
	)

Add an array of filespec to the glob.

The filesystem will be immediately scanned for all matching files and directories in each filespec and they will be added to the glob.

Parameters

a_nCount	Number of filespec in the array.
a_rgpszFileSpec	Array of filespec to add to the glob.

Returns

SG_SUCCESS Matching files were added to the glob.

SG_ERR_NOMATCH Nothing matched the pattern. To ignore this error compare the return value to >= SG_SUCCESS.

SG_ERR_MEMORY Out of memory failure.

SG_ERR_FAILURE General failure.

Definition at line 655 of file SimpleGlob.h.

References SG_SUCCESS.

{
        int nResult;
        for (int n = 0; n < a_nCount; ++n) {
                nResult = Add(a_rgpszFileSpec[n]);
                if (nResult != SG_SUCCESS) {
                        return nResult;
                }
        }
        return SG_SUCCESS;
}

template<class SOCHAR >

int CSimpleGlobTempl< SOCHAR >::AppendName ( const SOCHAR *  a_pszFileName, bool  a_bIsDir  )

private

Add a filename to the array if it passes all requirements.

Definition at line 667 of file SimpleGlob.h.

References SG_ERR_MEMORY, SG_GLOB_MARK, SG_GLOB_NODOT, SG_GLOB_ONLYDIR, SG_GLOB_ONLYFILE, SG_PATH_CHAR, SG_SUCCESS, SimpleGlobUtil::strcpy_s(), and SimpleGlobUtil::strlen().

{
        // we need the argv array as offsets in case we resize it
        SetArgvArrayType(OFFSETS);

        // check for special cases which cause us to ignore this entry
        if ((m_uiFlags & SG_GLOB_ONLYDIR) && !a_bIsDir) {
                return SG_SUCCESS;
        }
        if ((m_uiFlags & SG_GLOB_ONLYFILE) && a_bIsDir) {
                return SG_SUCCESS;
        }
        if ((m_uiFlags & SG_GLOB_NODOT) && a_bIsDir) {
                if (a_pszFileName[0] == '.') {
                        if (a_pszFileName[1] == '\0') {
                                return SG_SUCCESS;
                        }
                        if (a_pszFileName[1] == '.' && a_pszFileName[2] == '\0') {
                                return SG_SUCCESS;
                        }
                }
        }
        // ensure that we have enough room in the argv array
        if (!GrowArgvArray(m_nArgsLen + 1)) {
                return SG_ERR_MEMORY;
        }
        // ensure that we have enough room in the string buffer
        size_t uiPrefixLen = SimpleGlobUtil::strlen(m_szPathPrefix);
        size_t uiLen = uiPrefixLen + SimpleGlobUtil::strlen(a_pszFileName) + 1; // + null character
        if (a_bIsDir && (m_uiFlags & SG_GLOB_MARK) == SG_GLOB_MARK) {
                ++uiLen;                                // need space for the backslash
        }
        if (!GrowStringBuffer(m_uiBufferLen + uiLen)) {
                return SG_ERR_MEMORY;
        }
        // add this entry
        m_rgpArgs[m_nArgsLen++] = (SOCHAR *) m_uiBufferLen;     // offset from beginning of buffer
        SimpleGlobUtil::strcpy_s(m_pBuffer + m_uiBufferLen, m_uiBufferSize - m_uiBufferLen, m_szPathPrefix);
        SimpleGlobUtil::strcpy_s(m_pBuffer + m_uiBufferLen + uiPrefixLen, m_uiBufferSize - m_uiBufferLen - uiPrefixLen, a_pszFileName);
        m_uiBufferLen += uiLen;

        // add the directory slash if desired
        if (a_bIsDir && (m_uiFlags & SG_GLOB_MARK) == SG_GLOB_MARK) {
                const static SOCHAR szDirSlash[] = { SG_PATH_CHAR, 0 };
                SimpleGlobUtil::strcpy_s(m_pBuffer + m_uiBufferLen - 2, m_uiBufferSize - (m_uiBufferLen - 2), szDirSlash);
        }

        return SG_SUCCESS;
}

template<class SOCHAR>

SOCHAR* CSimpleGlobTempl< SOCHAR >::File ( int  n )

inline

Return the a single file.

Definition at line 502 of file SimpleGlob.h.

References CSimpleGlobTempl< SOCHAR >::Files(), CSimpleGlobTempl< SOCHAR >::m_nArgsLen, and SG_ASSERT.

                                   {
                SG_ASSERT(n >= 0 && n < m_nArgsLen);
                return Files()[n];
        }

template<class SOCHAR>

int CSimpleGlobTempl< SOCHAR >::FileCount ( ) const

inline

Return the number of files in the argv array.

Definition at line 493 of file SimpleGlob.h.

References CSimpleGlobTempl< SOCHAR >::m_nArgsLen.

                                     {
                return m_nArgsLen;
        }

template<class SOCHAR>

SOCHAR** CSimpleGlobTempl< SOCHAR >::Files ( )

inline

Return the full argv array.

Definition at line 496 of file SimpleGlob.h.

References CSimpleGlobTempl< SOCHAR >::m_rgpArgs, CSimpleGlobTempl< SOCHAR >::POINTERS, and CSimpleGlobTempl< SOCHAR >::SetArgvArrayType().

Referenced by CSimpleGlobTempl< SOCHAR >::File().

                                  {
                SetArgvArrayType(POINTERS);
                return m_rgpArgs;
        }

template<class SOCHAR >

int CSimpleGlobTempl< SOCHAR >::fileSortCompare ( const void *  a1, const void *  a2  )

staticprivate

Compare two (possible NULL) strings.

Definition at line 770 of file SimpleGlob.h.

References SimpleGlobUtil::strcasecmp().

{
        const SOCHAR *s1 = *(const SOCHAR **) a1;
        const SOCHAR *s2 = *(const SOCHAR **) a2;
        if (s1 && s2) {
                return SimpleGlobUtil::strcasecmp(s1, s2);
        }
        // NULL sorts first
        return s1 == s2 ? 0 : (s1 ? 1 : -1);
}

template<class SOCHAR >

bool CSimpleGlobTempl< SOCHAR >::GrowArgvArray ( int  a_nNewLen )

private

Grow the argv array to the required size.

Definition at line 736 of file SimpleGlob.h.

{
        if (a_nNewLen >= m_nArgsSize) {
                static const int SG_ARGV_INITIAL_SIZE = 32;
                int nNewSize = (m_nArgsSize > 0) ? m_nArgsSize * 2 : SG_ARGV_INITIAL_SIZE;
                while (a_nNewLen >= nNewSize) {
                        nNewSize *= 2;
                }
                void *pNewBuffer = realloc(m_rgpArgs, nNewSize * sizeof(SOCHAR *));
                if (!pNewBuffer)
                        return false;
                m_nArgsSize = nNewSize;
                m_rgpArgs = (SOCHAR **) pNewBuffer;
        }
        return true;
}

template<class SOCHAR >

bool CSimpleGlobTempl< SOCHAR >::GrowStringBuffer ( size_t  a_uiMinSize )

private

Grow the string buffer to the required size.

Definition at line 753 of file SimpleGlob.h.

{
        if (a_uiMinSize >= m_uiBufferSize) {
                static const int SG_BUFFER_INITIAL_SIZE = 1024;
                size_t uiNewSize = (m_uiBufferSize > 0) ? m_uiBufferSize * 2 : SG_BUFFER_INITIAL_SIZE;
                while (a_uiMinSize >= uiNewSize) {
                        uiNewSize *= 2;
                }
                void *pNewBuffer = realloc(m_pBuffer, uiNewSize * sizeof(SOCHAR));
                if (!pNewBuffer)
                        return false;
                m_uiBufferSize = uiNewSize;
                m_pBuffer = (SOCHAR *) pNewBuffer;
        }
        return true;
}

template<class SOCHAR >

int CSimpleGlobTempl< SOCHAR >::Init	(	unsigned int	a_uiFlags = 0,
		int	a_nReservedSlots = 0
	)

Initialize (or re-initialize) the class in preparation for adding new filespecs.

All existing files are cleared. Note that allocated memory is only deallocated at object destruction.

Parameters

a_uiFlags	Combination of SG_GLOB flags.
a_nReservedSlots	Number of slots in the argv array that should be reserved. In the returned array these slots argv[0] ... argv[a_nReservedSlots-1] will be left empty for the caller to fill in.

Definition at line 565 of file SimpleGlob.h.

References SG_ERR_MEMORY, and SG_SUCCESS.

{
        m_nArgArrayType = POINTERS;
        m_uiFlags = a_uiFlags;
        m_nArgsLen = a_nReservedSlots;
        m_nReservedSlots = a_nReservedSlots;
        m_uiBufferLen = 0;

        if (m_nReservedSlots > 0) {
                if (!GrowArgvArray(m_nReservedSlots)) {
                        return SG_ERR_MEMORY;
                }
                for (int n = 0; n < m_nReservedSlots; ++n) {
                        m_rgpArgs[n] = NULL;
                }
        }

        return SG_SUCCESS;
}

template<class SOCHAR >

void CSimpleGlobTempl< SOCHAR >::SetArgvArrayType ( ARG_ARRAY_TYPE  a_nNewType )

private

Change the type of data stored in the argv array.

Definition at line 717 of file SimpleGlob.h.

References SG_ASSERT.

Referenced by CSimpleGlobTempl< SOCHAR >::Files().

{
        if (m_nArgArrayType == a_nNewType)
                return;
        if (a_nNewType == POINTERS) {
                SG_ASSERT(m_nArgArrayType == OFFSETS);
                for (int n = 0; n < m_nArgsLen; ++n) {
                        m_rgpArgs[n] = (m_rgpArgs[n] == (SOCHAR *) - 1) ? NULL : m_pBuffer + (size_t) m_rgpArgs[n];
                }
        } else {
                SG_ASSERT(a_nNewType == OFFSETS);
                SG_ASSERT(m_nArgArrayType == POINTERS);
                for (int n = 0; n < m_nArgsLen; ++n) {
                        m_rgpArgs[n] = (m_rgpArgs[n] == NULL) ? (SOCHAR *) - 1 : (SOCHAR *) (m_rgpArgs[n] - m_pBuffer);
                }
        }
        m_nArgArrayType = a_nNewType;
}

Field Documentation

template<class SOCHAR>

ARG_ARRAY_TYPE CSimpleGlobTempl< SOCHAR >::m_nArgArrayType

private

is the argv array storing indexes or pointers

Definition at line 532 of file SimpleGlob.h.

template<class SOCHAR>

int CSimpleGlobTempl< SOCHAR >::m_nArgsLen

private

used length

Definition at line 536 of file SimpleGlob.h.

Referenced by CSimpleGlobTempl< SOCHAR >::File(), and CSimpleGlobTempl< SOCHAR >::FileCount().

template<class SOCHAR>

int CSimpleGlobTempl< SOCHAR >::m_nArgsSize

private

allocated size of array

Definition at line 535 of file SimpleGlob.h.

template<class SOCHAR>

int CSimpleGlobTempl< SOCHAR >::m_nReservedSlots

private

number of client reserved slots in the argv array

Definition at line 534 of file SimpleGlob.h.

template<class SOCHAR>

SOCHAR* CSimpleGlobTempl< SOCHAR >::m_pBuffer

private

argv string buffer

Definition at line 537 of file SimpleGlob.h.

template<class SOCHAR>

SOCHAR** CSimpleGlobTempl< SOCHAR >::m_rgpArgs

private

argv array

Definition at line 533 of file SimpleGlob.h.

Referenced by CSimpleGlobTempl< SOCHAR >::Files().

template<class SOCHAR>

SOCHAR CSimpleGlobTempl< SOCHAR >::m_szPathPrefix[MAX_PATH]

private

path prefix of any wildcard filenames

Definition at line 540 of file SimpleGlob.h.

template<class SOCHAR>

size_t CSimpleGlobTempl< SOCHAR >::m_uiBufferLen

private

used length of buffer

Definition at line 539 of file SimpleGlob.h.

template<class SOCHAR>

size_t CSimpleGlobTempl< SOCHAR >::m_uiBufferSize

private

allocated size of buffer

Definition at line 538 of file SimpleGlob.h.

template<class SOCHAR>

unsigned int CSimpleGlobTempl< SOCHAR >::m_uiFlags

private

Definition at line 531 of file SimpleGlob.h.

---

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

• SimpleGlob.h