FS/UT_Directory.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        FS library (C++)
 *
 * COMMENTS:    UT_Directory creates a hash list for a directory
 *              This class makes no distinctions between the file types
 *              it leaves this to the user of the class.
 *
 *              Originally taken from UT_Directory
 */

#ifndef __UT_Directory_h__
#define __UT_Directory_h__

#include "FS_API.h"
#include <UT/UT_PtrArray.h>
#include <UT/UT_SymbolTable.h>
#include <UT/UT_StringArray.h>
#include <UT/UT_String.h>

class FS_API UT_Directory {
public:
     UT_Directory(const char *path, const char *pattern=0, int includeDots=1);
    ~UT_Directory();

    // Returns 1 if the file is found in the directory
    int         findFile(const char *filename) const;


    // Returns a list of files matching the pattern passed in.  The result
    //  contains each matching file separated by a space.
    int         getFiles(const char *pattern, UT_String &result) const;
    int         getFiles(const char *pattern, UT_StringList &list) const;
    int         getFiles(const char *pattern, UT_StringArray &array) const;
    int         entries() const;

    // Traverse all the files 
    void        traverseFiles(int (*func)(const char *filename, void *data),
                              void *data = 0, const char *pattern = 0) const;

private:
    static int           doTraverse(UT_Thing &, const char *, void *);

    UT_SymbolTable       myFiles;
};

#endif

---