QDir Class Reference

Traverses directory structures and contents in a platform-independent way. More...

#include <qdir.h>

Public Types
enum	FilterSpec {   Dirs = 0x001, Files = 0x002, Drives = 0x004, NoSymLinks = 0x008,   All = 0x007, TypeMask = 0x00F, Readable = 0x010, Writable = 0x020,   Executable = 0x040, RWEMask = 0x070, Modified = 0x080, Hidden = 0x100,   System = 0x200, AccessMask = 0x3F0, DefaultFilter = -1 }
enum	SortSpec {   Name = 0x00, Time = 0x01, Size = 0x02, Unsorted = 0x03,   SortByMask = 0x03, DirsFirst = 0x04, Reversed = 0x08, IgnoreCase = 0x10,   DefaultSort = -1 }

Public Member Functions
	QDir ()
	QDir (const QString &path, const QString &nameFilter=QString::null, int sortSpec=Name|IgnoreCase, int filterSpec=All)
	QDir (const QDir &)
virtual	~QDir ()
QDir &	operator= (const QDir &)
QDir &	operator= (const QString &path)
virtual void	setPath (const QString &path)
virtual QString	path () const
virtual QString	absPath () const
virtual QString	canonicalPath () const
virtual QString	dirName () const
virtual QString	filePath (const QString &fileName, bool acceptAbsPath=TRUE) const
virtual QString	absFilePath (const QString &fileName, bool acceptAbsPath=TRUE) const
virtual bool	cd (const QString &dirName, bool acceptAbsPath=TRUE)
virtual bool	cdUp ()
QString	nameFilter () const
virtual void	setNameFilter (const QString &nameFilter)
FilterSpec	filter () const
virtual void	setFilter (int filterSpec)
SortSpec	sorting () const
virtual void	setSorting (int sortSpec)
bool	matchAllDirs () const
virtual void	setMatchAllDirs (bool)
uint	count () const
QString	operator[] (int) const
virtual QStrList	encodedEntryList (int filterSpec=DefaultFilter, int sortSpec=DefaultSort) const
virtual QStrList	encodedEntryList (const QString &nameFilter, int filterSpec=DefaultFilter, int sortSpec=DefaultSort) const
virtual QStringList	entryList (int filterSpec=DefaultFilter, int sortSpec=DefaultSort) const
virtual QStringList	entryList (const QString &nameFilter, int filterSpec=DefaultFilter, int sortSpec=DefaultSort) const
virtual const QFileInfoList *	entryInfoList (int filterSpec=DefaultFilter, int sortSpec=DefaultSort) const
virtual const QFileInfoList *	entryInfoList (const QString &nameFilter, int filterSpec=DefaultFilter, int sortSpec=DefaultSort) const
virtual bool	mkdir (const QString &dirName, bool acceptAbsPath=TRUE) const
virtual bool	rmdir (const QString &dirName, bool acceptAbsPath=TRUE) const
virtual bool	isReadable () const
virtual bool	exists () const
virtual bool	isRoot () const
virtual bool	isRelative () const
virtual void	convertToAbs ()
virtual bool	operator== (const QDir &) const
virtual bool	operator!= (const QDir &) const
virtual bool	remove (const QString &fileName, bool acceptAbsPath=TRUE)
virtual bool	rename (const QString &name, const QString &newName, bool acceptAbsPaths=TRUE)
virtual bool	exists (const QString &name, bool acceptAbsPath=TRUE)

Static Public Member Functions
static QString	convertSeparators (const QString &pathName)
static const QFileInfoList *	drives ()
static char	separator ()
static bool	setCurrent (const QString &path)
static QDir	current ()
static QDir	home ()
static QDir	root ()
static QString	currentDirPath ()
static QString	homeDirPath ()
static QString	rootDirPath ()
static bool	match (const QStringList &filters, const QString &fileName)
static bool	match (const QString &filter, const QString &fileName)
static QString	cleanDirPath (const QString &dirPath)
static bool	isRelativePath (const QString &path)

Private Member Functions
void	init ()
virtual bool	readDirEntries (const QString &nameFilter, int FilterSpec, int SortSpec)

Static Private Member Functions
static void	slashify (QString &)

Private Attributes
QString	dPath
QStringList *	fList
QFileInfoList *	fiList
QString	nameFilt
FilterSpec	filtS
SortSpec	sortS
uint	dirty: 1
uint	allDirs: 1

Detailed Description

Traverses directory structures and contents in a platform-independent way.

A QDir can point to a file using either a relative or an absolute file path. Absolute file paths begin with the directory separator ('/') or a drive specification (not applicable to UNIX). Relative file names begin with a directory name or a file name and specify a path relative to the current directory.

An example of an absolute path is the string "/tmp/quartz", a relative path might look like "src/fatlib". You can use the function isRelative() to check if a QDir is using a relative or an absolute file path. You can call the function convertToAbs() to convert a relative QDir to an absolute one.

The directory "example" under the current directory is checked for existence in the example below:

QDir d( "example" );                  // "./example"
if ( !d.exists() )
    qWarning( "Cannot find the example directory" );

If you always use '/' as a directory separator, Qt will translate your paths to conform to the underlying operating system.

cd() and cdUp() can be used to navigate the directory tree. Note that the logical cd and cdUp operations are not performed if the new directory does not exist.

Example:

QDir d = QDir::root();                        // "/"
if ( !d.cd("tmp") ) {                 // "/tmp"
    qWarning( "Cannot find the \"/tmp\" directory" );
} else {
    QFile f( d.filePath("ex1.txt") ); // "/tmp/ex1.txt"
    if ( !f.open(IO_ReadWrite) )
        qWarning( "Cannot create the file %s", f.name() );
}

To read the contents of a directory you can use the entryList() and entryInfoList() functions.

Example:

#include <stdio.h>
#include <qdir.h>

//
// This program scans the current directory and lists all files
// that are not symbolic links, sorted by size with the smallest files
// first.
//

int main( int argc, char **argv )
{
    QDir d;
    d.setFilter( QDir::Files | QDir::Hidden | QDir::NoSymLinks );
    d.setSorting( QDir::Size | QDir::Reversed );

    const QFileInfoList *list = d.entryInfoList();
    QFileInfoListIterator it( *list );        // create list iterator
    QFileInfo *fi;                            // pointer for traversing

    printf( "     BYTES FILENAME\n" );        // print header
    while ( (fi=it.current()) ) {             // for each file...
        printf( "%10li %s\n", fi->size(), fi->fileName().data() );
        ++it;                         // goto next list element
    }
}

Definition at line 52 of file qdir.h.

Member Enumeration Documentation

enum QDir::FilterSpec

This enum describes how QDir is to select what entries in a directory to return. The filter value is specified by or-ing together values from the following list:

• Dirs - List directories only

• Files - List files only

• Drives - List disk drives (does nothing under unix)
• NoSymLinks - Do not list symbolic links (where they exist)
• Readable - List files for which the application has read access.
• Writable - List files for which the application has write access.
• Executable - List files for which the application has execute access
• Modified - Only list files that have been modified (does nothing under unix)
• Hidden - List hidden files (on unix, files starting with a .)
• System - List system files (does nothing under unix)

If you do not set any of Readable, Writable or Executable, QDir will set all three of them. This makes the default easy to write and at the same time useful.

Examples: Readable|Writable means list all files for which the application has read access, write access or both. Dirs|Drives means list drives, directories, all files that the application can read, write or execute, and also symlinks to such files/directories.

Enumerator
Dirs
Files
Drives
NoSymLinks
All
TypeMask
Readable
Writable
Executable
RWEMask
Modified
Hidden
System
AccessMask
DefaultFilter

Definition at line 55 of file qdir.h.

                    { Dirs          = 0x001,
                      Files         = 0x002,
                      Drives        = 0x004,
                      NoSymLinks    = 0x008,
                      All           = 0x007,
                       TypeMask     = 0x00F,

                      Readable      = 0x010,
                      Writable      = 0x020,
                      Executable    = 0x040,
                       RWEMask      = 0x070,

                      Modified      = 0x080,
                      Hidden        = 0x100,
                      System        = 0x200,
                       AccessMask    = 0x3F0,

                      DefaultFilter = -1 };

enum QDir::SortSpec

This enum describes how QDir is to sort entries in a directory when it returns a list of them. The sort value is specified by or-ing together values from the following list:

• Name - sort by name
• Time - sort by time (modification time)
• Size - sort by file size

• Unsorted - do not sort

• DirsFirst - put all directories first in the list
• Reversed - reverse the sort order

• IgnoreCase - sort case-insensitively

You can only specify one of the first four. If you specify both DirsFirst and Reversed, directories are still put first but the list is otherwise reversed.

Enumerator
Name
Time
Size
Unsorted
SortByMask
DirsFirst
Reversed
IgnoreCase
DefaultSort

Definition at line 74 of file qdir.h.

                    { Name          = 0x00,
                      Time          = 0x01,
                      Size          = 0x02,
                      Unsorted      = 0x03,
                       SortByMask    = 0x03,

                      DirsFirst     = 0x04,
                      Reversed      = 0x08,
                      IgnoreCase    = 0x10,
                      DefaultSort   = -1 };

Constructor & Destructor Documentation

QDir::QDir

(

)

Constructs a QDir pointing to the current directory.

See also

currentDirPath()

Definition at line 137 of file qdir.cpp.

{
    dPath = QString::fromLatin1(".");
    init();
}

QDir::QDir	(	const QString &	path,
		const QString &	nameFilter = QString::null,
		int	sortSpec = Name | IgnoreCase,
		int	filterSpec = All
	)

Constructs a QDir.

• path is the directory.
• nameFilter is the file name filter.
• sortSpec is the sort specification, which describes how to sort the files in the directory.
• filterSpec is the filter specification, which describes how to filter the files in the directory.

Most of these arguments (except path) have optional values.

Example:

// lists all files in /tmp

QDir d( "/tmp" );
for ( int i=0; i<d.count(); i++ )
    printf( "%s\n", d[i] );

If path is "" or null, the directory is set to "." (the current directory). If nameFilter is "" or null, it is set to "*" (all files).

No check is made to ensure that the directory exists.

See also

exists(), setPath(), setNameFilter(), setFilter(), setSorting()

Definition at line 173 of file qdir.cpp.

{
    init();
    dPath = cleanDirPath( path );
    if ( dPath.isEmpty() )
        dPath = QString::fromLatin1(".");
    nameFilt = nameFilter;
    if ( nameFilt.isEmpty() )
        nameFilt = QString::fromLatin1("*");
    filtS = (FilterSpec)filterSpec;
    sortS = (SortSpec)sortSpec;
}

QDir::QDir

(

const QDir &

d

)

Constructs a QDir that is a copy of the given directory.

See also

operator=()

Definition at line 192 of file qdir.cpp.

{
    dPath = d.dPath;
    fList = 0;
    fiList = 0;
    nameFilt = d.nameFilt;
    dirty = TRUE;
    allDirs = d.allDirs;
    filtS = d.filtS;
    sortS = d.sortS;
}

QDir::~QDir ( )

virtual

Destructs the QDir and cleans up.

Definition at line 220 of file qdir.cpp.

{
    if ( fList )
       delete fList;
    if ( fiList )
       delete fiList;
}

Member Function Documentation

QString QDir::absFilePath ( const QString &  fileName, bool  acceptAbsPath = TRUE  ) const

virtual

Returns the absolute path name of a file in the directory. Does NOT check if the file actually exists in the directory. Redundant multiple separators or "." and ".." directories in fileName will NOT be removed (see cleanDirPath()).

If acceptAbsPath is TRUE a fileName starting with a separator ('/') will be returned without change. if acceptAbsPath is FALSE an absolute path will be appended to the directory path.

See also

filePath()

Definition at line 351 of file qdir.cpp.

{
    if ( acceptAbsPath && !isRelativePath( fileName ) )
        return fileName;

    QString tmp = absPath();
    if ( tmp.isEmpty() || (tmp[(int)tmp.length()-1] != '/' && !!fileName &&
                           fileName[0] != '/') )
        tmp += '/';
    tmp += fileName;
    return tmp;
}

QString QDir::absPath ( ) const

virtual

Returns the absolute (a path that starts with '/') path, which may contain symbolic links, but never contains redundant ".", ".." or multiple separators.

See also

setPath(), canonicalPath(), exists(), cleanDirPath(), dirName(), absFilePath()

Definition at line 276 of file qdir.cpp.

{
    if ( QDir::isRelativePath(dPath) ) {
        QString tmp = currentDirPath();
        if ( tmp.right(1) != QString::fromLatin1("/") )
            tmp += '/';
        tmp += dPath;
        return cleanDirPath( tmp );
    } else {
        return cleanDirPath( dPath );
    }
}

QString QDir::canonicalPath ( ) const

virtual

Definition at line 79 of file qdir_unix.cpp.

{
    QString r;

    char cur[PATH_MAX];
    char tmp[PATH_MAX];
    if (GETCWD( cur, PATH_MAX )) {
      if ( CHDIR(QFile::encodeName(dPath)) >= 0 ) {
        if (GETCWD( tmp, PATH_MAX )) {
          r = QFile::decodeName(tmp);
        }
        (void)CHDIR( cur );
      }
    }

    slashify( r );
    return r;
}

bool QDir::cd ( const QString &  dirName, bool  acceptAbsPath = TRUE  )

virtual

Changes directory by descending into the given directory. Returns TRUE if the new directory exists and is readable. Note that the logical cd operation is NOT performed if the new directory does not exist.

If acceptAbsPath is TRUE a path starting with a separator ('/') will cd to the absolute directory, if acceptAbsPath is FALSE any number of separators at the beginning of dirName will be removed.

Example:

QDir d = QDir::home();  // now points to home directory
if ( !d.cd("c++") ) {     // now points to "c++" under home directory if OK
    QFileInfo fi( d, "c++" );
    if ( fi.exists() ) {
        if ( fi.isDir() )
            qWarning( "Cannot cd into \"%s\".", (char*)d.absFilePath("c++") );
        else
            qWarning( "Cannot create directory \"%s\"\n"
               "A file named \"c++\" already exists in \"%s\"",
               (const char *)d.absFilePath("c++"),
               (const char *)d.path() );
        return;
    } else {
        qWarning( "Creating directory \"%s\"",
           (const char *) d.absFilePath("c++") );
        if ( !d.mkdir( "c++" ) ) {
            qWarning("Could not create directory \"%s\"",
              (const char *)d.absFilePath("c++") );
            return;
        }
    }
}

Calling cd( ".." ) is equivalent to calling cdUp().

See also

cdUp(), isReadable(), exists(), path()

Definition at line 429 of file qdir.cpp.

{
    if ( dirName.isEmpty() || dirName==QString::fromLatin1(".") )
        return TRUE;
    QString old = dPath;
    if ( acceptAbsPath && !isRelativePath(dirName) ) {
        dPath = cleanDirPath( dirName );
    } else {
        if ( !isRoot() )
            dPath += '/';
        dPath += dirName;
        if ( dirName.find('/') >= 0
                || old == QString::fromLatin1(".")
                || dirName == QString::fromLatin1("..") )
            dPath = cleanDirPath( dPath );
    }
    if ( !exists() ) {
        dPath = old;                    // regret
        return FALSE;
    }
    dirty = TRUE;
    return TRUE;
}

bool QDir::cdUp ( )

virtual

Changes directory by moving one directory up the path followed to arrive at the current directory.

Returns TRUE if the new directory exists and is readable. Note that the logical cdUp() operation is not performed if the new directory does not exist.

See also

cd(), isReadable(), exists(), path()

Definition at line 464 of file qdir.cpp.

{
    return cd( QString::fromLatin1("..") );
}

QString QDir::cleanDirPath ( const QString &  filePath )

static

Removes all multiple directory separators ('/') and resolves any "." or ".." found in the path.

Symbolic links are kept. This function does not return the canonical path, but rather the most simplified version of the input. "../stuff" becomes "stuff", "stuff/../nonsense" becomes "nonsense" and "\\stuff\\more\\..\\nonsense" becomes "\\stuff\\nonsense".

See also

absPath() canonicalPath()

Definition at line 1077 of file qdir.cpp.

{
    QString name = filePath;
    QString newPath;

    if ( name.isEmpty() )
        return name;

    slashify( name );

    bool addedSeparator;
    if ( isRelativePath(name) ) {
        addedSeparator = TRUE;
        name.insert( 0, '/' );
    } else {
        addedSeparator = FALSE;
    }

    int ePos, pos, upLevel;

    pos = ePos = name.length();
    upLevel = 0;
    int len;

    while ( pos && (pos = name.findRev('/',--pos)) != -1 ) {
        len = ePos - pos - 1;
        if ( len == 2 && name.at(pos + 1) == '.'
                      && name.at(pos + 2) == '.' ) {
            upLevel++;
        } else {
            if ( len != 0 && (len != 1 || name.at(pos + 1) != '.') ) {
                if ( !upLevel )
                    newPath = QString::fromLatin1("/")
                        + name.mid(pos + 1, len) + newPath;
                else
                    upLevel--;
            }
        }
        ePos = pos;
    }
    if ( addedSeparator ) {
        while ( upLevel-- )
            newPath.insert( 0, QString::fromLatin1("/..") );
        if ( !newPath.isEmpty() )
            newPath.remove( 0, 1 );
        else
            newPath = QString::fromLatin1(".");
    } else {
        if ( newPath.isEmpty() )
            newPath = QString::fromLatin1("/");
#if defined(_OS_FATFS_) || defined(_OS_OS2EMX_)
        if ( name[0] == '/' ) {
            if ( name[1] == '/' )               // "\\machine\x\ ..."
                newPath.insert( 0, '/' );
        } else {
            newPath = name.left(2) + newPath;
        }
#endif
    }
    return newPath;
}

QString QDir::convertSeparators ( const QString &  pathName )

static

Converts the '/' separators in pathName to system native separators. Returns the translated string.

On Windows, convertSeparators("c:/winnt/system32") returns "c:\winnt\system32".

No conversion is done on UNIX.

Definition at line 376 of file qdir.cpp.

{
    QString n( pathName );
#if defined(_OS_FATFS_) || defined(_OS_OS2EMX_)
    for ( int i=0; i<(int)n.length(); i++ ) {
        if ( n[i] == '/' )
            n[i] = '\\';
    }
#endif
    return n;
}

void QDir::convertToAbs ( )

virtual

Converts the directory path to an absolute path. If it is already absolute nothing is done.

See also

isRelative()

Definition at line 848 of file qdir.cpp.

{
    dPath = absPath();
}

uint QDir::count

(

)

const

Returns the number of files that was found. Equivalent to entryList().count().

See also

operator[](), entryList()

Definition at line 641 of file qdir.cpp.

{
    return entryList().count();
}

QDir QDir::current ( )

static

Returns the current directory.

See also

currentDirPath(), QDir::QDir()

Definition at line 978 of file qdir.cpp.

{
    return QDir( currentDirPath() );
}

QString QDir::currentDirPath ( )

static

Definition at line 141 of file qdir_unix.cpp.

{
    QString result;

    STATBUF st;
    if ( STAT( ".", &st ) == 0 ) {
        char currentName[PATH_MAX];
        if ( GETCWD( currentName, PATH_MAX ) != 0 )
            result = QFile::decodeName(currentName);
#if defined(DEBUG)
        if ( result.isNull() )
            qWarning( "QDir::currentDirPath: getcwd() failed" );
#endif
    } else {
#if defined(DEBUG)
        qWarning( "QDir::currentDirPath: stat(\".\") failed" );
#endif
    }
    slashify( result );
    return result;
}

QString QDir::dirName ( ) const

virtual

Returns the name of the directory, this is NOT the same as the path, e.g. a directory with the name "mail", might have the path "/var/spool/mail". If the directory has no name (e.g. the root directory) a null string is returned.

No check is made to ensure that a directory with this name actually exists.

See also

path(), absPath(), absFilePath(), exists(), QString::isNull()

Definition at line 300 of file qdir.cpp.

{
    int pos = dPath.findRev( '/' );
    if ( pos == -1  )
        return dPath;
    return dPath.right( dPath.length() - pos - 1 );
}

const QFileInfoList * QDir::drives ( )

static

Definition at line 276 of file qdir_unix.cpp.

{
    // at most one instance of QFileInfoList is leaked, and this variable
    // points to that list
    static QFileInfoList * knownMemoryLeak = 0;

    if ( !knownMemoryLeak ) {
        knownMemoryLeak = new QFileInfoList;
        // non-win32 versions both use just one root directory
        knownMemoryLeak->append( new QFileInfo( rootDirPath() ) );
    }

    return knownMemoryLeak;
}

QStrList QDir::encodedEntryList ( int  filterSpec = DefaultFilter, int  sortSpec = DefaultSort  ) const

virtual

This function is included to easy porting from Qt 1.x to Qt 2.0, it is the same as entryList(), but encodes the filenames as 8-bit strings using QFile::encodedName().

It is more efficient to use entryList().

Definition at line 672 of file qdir.cpp.

{
    QStrList r;
    QStringList l = entryList(filterSpec,sortSpec);
    for ( QStringList::Iterator it = l.begin(); it != l.end(); ++it ) {
        r.append( QFile::encodeName(*it) );
    }
    return r;
}

QStrList QDir::encodedEntryList ( const QString &  nameFilter, int  filterSpec = DefaultFilter, int  sortSpec = DefaultSort  ) const

virtual

This function is included to easy porting from Qt 1.x to Qt 2.0, it is the same as entryList(), but encodes the filenames as 8-bit strings using QFile::encodedName().

It is more efficient to use entryList().

Definition at line 689 of file qdir.cpp.

{
    QStrList r;
    QStringList l = entryList(nameFilter,filterSpec,sortSpec);
    for ( QStringList::Iterator it = l.begin(); it != l.end(); ++it ) {
        r.append( QFile::encodeName(*it) );
    }
    return r;
}

const QFileInfoList * QDir::entryInfoList ( int  filterSpec = DefaultFilter, int  sortSpec = DefaultSort  ) const

virtual

Returns a list of QFileInfo objects for all files and directories in the directory pointed to using the setSorting(), setFilter() and setNameFilter() specifications.

The the filter and sorting specifications can be overridden using the filterSpec and sortSpec arguments.

Returns 0 if the directory is unreadable or does not exist.

The returned pointer is a const pointer to a QFileInfoList. The list is owned by the QDir object and will be reused on the next call to entryInfoList() for the same QDir instance. If you want to keep the entries of the list after a subsequent call to this function you will need to copy them.

See also

entryList(), setNameFilter(), setSorting(), setFilter()

Definition at line 772 of file qdir.cpp.

{
    if ( !dirty && filterSpec == (int)DefaultFilter &&
                   sortSpec   == (int)DefaultSort )
        return fiList;
    return entryInfoList( nameFilt, filterSpec, sortSpec );
}

const QFileInfoList * QDir::entryInfoList ( const QString &  nameFilter, int  filterSpec = DefaultFilter, int  sortSpec = DefaultSort  ) const

virtual

Returns a list of QFileInfo objects for all files and directories in the directory pointed to using the setSorting(), setFilter() and setNameFilter() specifications.

The the filter and sorting specifications can be overridden using the nameFilter, filterSpec and sortSpec arguments.

Returns 0 if the directory is unreadable or does not exist.

The returned pointer is a const pointer to a QFileInfoList. The list is owned by the QDir object and will be reused on the next call to entryInfoList() for the same QDir instance. If you want to keep the entries of the list after a subsequent call to this function you will need to copy them.

See also

entryList(), setNameFilter(), setSorting(), setFilter()

Definition at line 799 of file qdir.cpp.

{
    if ( filterSpec == (int)DefaultFilter )
        filterSpec = filtS;
    if ( sortSpec == (int)DefaultSort )
        sortSpec = sortS;
    QDir *that = (QDir*)this;                   // mutable function
    if ( that->readDirEntries(nameFilter, filterSpec, sortSpec) )
        return that->fiList;
    else
        return 0;
}

QStringList QDir::entryList ( int  filterSpec = DefaultFilter, int  sortSpec = DefaultSort  ) const

virtual

Returns a list of the names of all files and directories in the directory indicated by the setSorting(), setFilter() and setNameFilter() specifications.

The the filter and sorting specifications can be overridden using the filterSpec and sortSpec arguments.

Returns an empty list if the directory is unreadable or does not exist.

See also

entryInfoList(), setNameFilter(), setSorting(), setFilter(), encodedEntryList()

Definition at line 717 of file qdir.cpp.

{
    if ( !dirty && filterSpec == (int)DefaultFilter &&
                   sortSpec   == (int)DefaultSort )
        return *fList;
    return entryList( nameFilt, filterSpec, sortSpec );
}

QStringList QDir::entryList ( const QString &  nameFilter, int  filterSpec = DefaultFilter, int  sortSpec = DefaultSort  ) const

virtual

Returns a list of the names of all files and directories in the directory indicated by the setSorting(), setFilter() and setNameFilter() specifications.

The the filter and sorting specifications can be overridden using the nameFilter, filterSpec and sortSpec arguments.

Returns and empty list if the directory is unreadable or does not exist.

See also

entryInfoList(), setNameFilter(), setSorting(), setFilter(), encodedEntryList()

Definition at line 739 of file qdir.cpp.

{
    if ( filterSpec == (int)DefaultFilter )
        filterSpec = filtS;
    if ( sortSpec == (int)DefaultSort )
        sortSpec = sortS;
    QDir *that = (QDir*)this;                   // mutable function
    if ( that->readDirEntries(nameFilter, filterSpec, sortSpec) )
        return *that->fList;
    else
        return QStringList();
}

bool QDir::exists ( ) const

virtual

Returns TRUE if the directory exists. (If a file with the same name is found this function will of course return FALSE).

See also

QFileInfo::exists(), QFile::exists()

Definition at line 820 of file qdir.cpp.

{
    QFileInfo fi( dPath );
    return fi.exists() && fi.isDir();
}

bool QDir::exists ( const QString &  name, bool  acceptAbsPath = TRUE  )

virtual

Checks for existence of a file.

If acceptAbsPaths is TRUE a path starting with a separator ('/') will check the file with the absolute path, if acceptAbsPath is FALSE any number of separators at the beginning of name will be removed.

Returns TRUE if the file exists, otherwise FALSE.

See also

QFileInfo::exists(), QFile::exists()

Definition at line 939 of file qdir.cpp.

{
    if ( name.isEmpty() ) {
#if defined(CHECK_NULL)
        qWarning( "QDir::exists: Empty or null file name" );
#endif
        return FALSE;
    }
    QString tmp = filePath( name, acceptAbsPath );
    return QFile::exists( tmp );
}

QString QDir::filePath ( const QString &  fileName, bool  acceptAbsPath = TRUE  ) const

virtual

Returns the path name of a file in the directory. Does NOT check if the file actually exists in the directory. If the QDir is relative the returned path name will also be relative. Redundant multiple separators or "." and ".." directories in fileName will not be removed (see cleanDirPath()).

If acceptAbsPath is TRUE a fileName starting with a separator ('/') will be returned without change. If acceptAbsPath is FALSE an absolute path will be appended to the directory path.

See also

absFilePath(), isRelative(), canonicalPath()

Definition at line 323 of file qdir.cpp.

{
    if ( acceptAbsPath && !isRelativePath(fileName) )
        return QString(fileName);

    QString tmp = dPath;
    if ( tmp.isEmpty() || (tmp[(int)tmp.length()-1] != '/' && !!fileName &&
                           fileName[0] != '/') )
        tmp += '/';
    tmp += fileName;
    return tmp;
}

QDir::FilterSpec QDir::filter ( ) const

inline

Returns the value set by setFilter()

Definition at line 208 of file qdir.h.

{
    return filtS;
}

QDir QDir::home ( )

static

Returns the home directory.

See also

homeDirPath()

Definition at line 988 of file qdir.cpp.

{
    return QDir( homeDirPath() );
}

QString QDir::homeDirPath ( )

static

Returns the absolute path for the user's home directory,

See also

home()

Definition at line 69 of file qdir_unix.cpp.

{
    QString d;
    d = QFile::decodeName(getenv("HOME"));
    slashify( d );
    if ( d.isNull() )
        d = rootDirPath();
    return d;
}

void QDir::init ( )

private

Definition at line 205 of file qdir.cpp.

{
    fList = 0;
    fiList = 0;
    nameFilt = QString::fromLatin1("*");
    dirty = TRUE;
    allDirs = FALSE;
    filtS = All;
    sortS = SortSpec(Name | IgnoreCase);
}

bool QDir::isReadable ( ) const

virtual

Definition at line 109 of file qdir_unix.cpp.

{
    return ACCESS( QFile::encodeName(dPath), R_OK | X_OK ) == 0;
}

bool QDir::isRelative ( ) const

virtual

Returns TRUE if the directory path is relative to the current directory, FALSE if the path is absolute (e.g. under UNIX a path is relative if it does not start with a '/').

According to Einstein this function should always return TRUE.

See also

convertToAbs()

Definition at line 836 of file qdir.cpp.

{
    return isRelativePath( dPath );
}

bool QDir::isRelativePath ( const QString &  path )

static

Definition at line 169 of file qdir_unix.cpp.

{
    int len = path.length();
    if ( len == 0 )
        return TRUE;
    return path[0] != '/';
}

bool QDir::isRoot ( ) const

virtual

Definition at line 114 of file qdir_unix.cpp.

{
    return dPath == QString::fromLatin1("/");
}

bool QDir::match ( const QStringList &  filters, const QString &  fileName  )

static

Returns TRUE if the fileName matches one of the wildcards in the list filters.

See also

QRegExp

Definition at line 1036 of file qdir.cpp.

{
    QStringList::ConstIterator sit = filters.begin();
    bool matched = FALSE;
    for ( ; sit != filters.end(); ++sit ) {
        QRegExp regexp( (*sit).data(), FALSE, TRUE );
        if ( regexp.match( fileName.data() ) != -1 ) {
            matched = TRUE;
            break;
        }
    }

    return matched;
}

bool QDir::match ( const QString &  filter, const QString &  fileName  )

static

Returns TRUE if the fileName matches the wildcard filter. Filter may also contain multiple wildcards separated by spaces or semicolons.

See also

QRegExp

Definition at line 1058 of file qdir.cpp.

{
    QStringList lst = qt_makeFilterList( filter );
    return match( lst, fileName );
}

bool QDir::matchAllDirs ( ) const

inline

Returns the value set by setMatchAllDirs()

See also

setMatchAllDirs()

Definition at line 218 of file qdir.h.

{
    return allDirs;
}

bool QDir::mkdir ( const QString &  dirName, bool  acceptAbsPath = TRUE  ) const

virtual

Definition at line 98 of file qdir_unix.cpp.

{
    return MKDIR( QFile::encodeName(filePath(dirName,acceptAbsPath)), 0777 ) 
        == 0;
}

QString QDir::nameFilter ( ) const

inline

Returns the string set by setNameFilter()

Definition at line 203 of file qdir.h.

{
    return nameFilt;
}

bool QDir::operator!= ( const QDir &  d ) const

inlinevirtual

Returns TRUE if the d and this dir have different path or different sort/filter settings, otherwise FALSE.

Definition at line 223 of file qdir.h.

{
    return !(*this == d);
}

QDir & QDir::operator=

(

const QDir &

d

)

Makes a copy of d and assigns it to this QDir.

Definition at line 857 of file qdir.cpp.

{
    dPath    = d.dPath;
    delete fList;
    fList    = 0;
    delete fiList;
    fiList   = 0;
    nameFilt = d.nameFilt;
    dirty    = TRUE;
    allDirs  = d.allDirs;
    filtS    = d.filtS;
    sortS    = d.sortS;
    return *this;
}

QDir & QDir::operator=

(

const QString &

path

)

Sets the directory path to be the given path.

Definition at line 876 of file qdir.cpp.

{
    dPath = cleanDirPath( path );
    dirty = TRUE;
    return *this;
}

bool QDir::operator== ( const QDir &  d ) const

virtual

Returns TRUE if the d and this dir have the same path and all sort and filter settings are equal, otherwise FALSE.

Definition at line 895 of file qdir.cpp.

{
    return dPath    == d.dPath &&
           nameFilt == d.nameFilt &&
           allDirs  == d.allDirs &&
           filtS    == d.filtS &&
           sortS    == d.sortS;
}

QString QDir::operator[]

(

int

index

)

const

Returns the file name at position index in the list of found file names. Equivalent to entryList().at(index).

Returns null if the index is out of range or if the entryList() function failed.

See also

count(), entryList()

Definition at line 657 of file qdir.cpp.

{
    entryList();
    return fList && index >= 0 && index < (int)fList->count() ?
        (*fList)[index] : QString::null;
}

QString QDir::path ( ) const

inlinevirtual

Returns the path, this may contain symbolic links, but never contains redundant ".", ".." or multiple separators.

The returned path can be either absolute or relative (see setPath()).

See also

setPath(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), convertSeparators()

Definition at line 198 of file qdir.h.

{
    return dPath;
}

bool QDir::readDirEntries ( const QString &  nameFilter, int  FilterSpec, int  SortSpec  )

privatevirtual

Definition at line 177 of file qdir_unix.cpp.

{
    int i;
    if ( !fList ) {
        fList  = new QStringList;
        CHECK_PTR( fList );
        fiList = new QFileInfoList;
        CHECK_PTR( fiList );
        fiList->setAutoDelete( TRUE );
    } else {
        fList->clear();
        fiList->clear();
    }

    QStringList filters = qt_makeFilterList( nameFilter );

    bool doDirs     = (filterSpec & Dirs)       != 0;
    bool doFiles    = (filterSpec & Files)      != 0;
    bool noSymLinks = (filterSpec & NoSymLinks) != 0;
    bool doReadable = (filterSpec & Readable)   != 0;
    bool doWritable = (filterSpec & Writable)   != 0;
    bool doExecable = (filterSpec & Executable) != 0;
    bool doHidden   = (filterSpec & Hidden)     != 0;

#if defined(_OS_OS2EMX_)
    //QRegExp   wc( nameFilter, FALSE, TRUE );  // wild card, case insensitive
#else
    //QRegExp   wc( nameFilter, TRUE, TRUE );   // wild card, case sensitive
#endif
    QFileInfo fi;
    DIR      *dir;
    dirent   *file;

    dir = opendir( QFile::encodeName(dPath) );
    if ( !dir ) {
#if defined(CHECK_NULL)
        qWarning( "QDir::readDirEntries: Cannot read the directory: %s",
                  QFile::encodeName(dPath).data() );
#endif
        return FALSE;
    }

    while ( (file = readdir(dir)) ) {
        QString fn = QFile::decodeName(file->d_name);
        fi.setFile( *this, fn );
        if ( !match( filters, fn ) && !(allDirs && fi.isDir()) )
             continue;
        if  ( (doDirs && fi.isDir()) || (doFiles && fi.isFile()) ) {
            if ( noSymLinks && fi.isSymLink() )
                continue;
            if ( (filterSpec & RWEMask) != 0 )
                if ( (doReadable && !fi.isReadable()) ||
                     (doWritable && !fi.isWritable()) ||
                     (doExecable && !fi.isExecutable()) )
                    continue;
            if ( !doHidden && fn[0] == '.' &&
                 fn != QString::fromLatin1(".")
                 && fn != QString::fromLatin1("..") )
                continue;
            fiList->append( new QFileInfo( fi ) );
        }
    }
    if ( closedir(dir) != 0 ) {
#if defined(CHECK_NULL)
        qWarning( "QDir::readDirEntries: Cannot close the directory: %s",
                  dPath.local8Bit().data() );
#endif
    }

    // Sort...
    if(fiList->count()) {
        QDirSortItem* si= new QDirSortItem[fiList->count()];
        QFileInfo* itm;
        i=0;
        for (itm = fiList->first(); itm; itm = fiList->next())
            si[i++].item = itm;
        qt_cmp_si_sortSpec = sortSpec;
        qsort( si, i, sizeof(si[0]), qt_cmp_si );
        // put them back in the list
        fiList->setAutoDelete( FALSE );
        fiList->clear();
        int j;
        for ( j=0; j<i; j++ ) {
            fiList->append( si[j].item );
            fList->append( si[j].item->fileName() );
        }
        delete [] si;
        fiList->setAutoDelete( TRUE );
    }

    if ( filterSpec == (FilterSpec)filtS && sortSpec == (SortSpec)sortS &&
         nameFilter == nameFilt )
        dirty = FALSE;
    else
        dirty = TRUE;
    return TRUE;
}

bool QDir::remove ( const QString &  fileName, bool  acceptAbsPath = TRUE  )

virtual

Removes a file.

If acceptAbsPath is TRUE a path starting with a separator ('/') will remove the file with the absolute path, if acceptAbsPath is FALSE any number of separators at the beginning of fileName will be removed.

Returns TRUE if successful, otherwise FALSE.

Definition at line 915 of file qdir.cpp.

{
    if ( fileName.isEmpty() ) {
#if defined(CHECK_NULL)
        qWarning( "QDir::remove: Empty or null file name" );
#endif
        return FALSE;
    }
    QString p = filePath( fileName, acceptAbsPath );
    return QFile::remove( p );
}

bool QDir::rename ( const QString &  name, const QString &  newName, bool  acceptAbsPaths = TRUE  )

virtual

Definition at line 119 of file qdir_unix.cpp.

{
    if ( name.isEmpty() || newName.isEmpty() ) {
#if defined(CHECK_NULL)
        qWarning( "QDir::rename: Empty or null file name(s)" );
#endif
        return FALSE;
    }
    QString fn1 = filePath( name, acceptAbsPaths );
    QString fn2 = filePath( newName, acceptAbsPaths );
    return ::rename( QFile::encodeName(fn1),
                     QFile::encodeName(fn2) ) == 0;
}

bool QDir::rmdir ( const QString &  dirName, bool  acceptAbsPath = TRUE  ) const

virtual

Definition at line 104 of file qdir_unix.cpp.

{
    return RMDIR( QFile::encodeName(filePath(dirName,acceptAbsPath)) ) == 0;
}

QDir QDir::root ( )

static

Returns the root directory.

See also

rootDirPath() drives()

Definition at line 998 of file qdir.cpp.

{
    return QDir( rootDirPath() );
}

QString QDir::rootDirPath ( )

static

Definition at line 163 of file qdir_unix.cpp.

{
    QString d = QString::fromLatin1( "/" );
    return d;
}

char QDir::separator ( )

static

Returns the native directory separator; '/' under UNIX and '\' under MS-DOS, Windows NT and OS/2.

You do not need to use this function to build file paths. If you always use '/', Qt will translate your paths to conform to the underlying operating system.

Definition at line 960 of file qdir.cpp.

{
#if defined(_OS_UNIX_)
    return '/';
#elif defined (_OS_FATFS_)
    return '\\';
#elif defined (_OS_MAC_)
    return ':';
#else
    return '/';
#endif
}

bool QDir::setCurrent ( const QString &  path )

static

Definition at line 134 of file qdir_unix.cpp.

{
    int r;
    r = CHDIR( QFile::encodeName(path) );
    return r >= 0;
}

void QDir::setFilter ( int  filterSpec )

virtual

Sets the filter used by entryList() and entryInfoList(). The filter is used to specify the kind of files that should be returned by entryList() and entryInfoList().

See also

filter(), setNameFilter()

Definition at line 538 of file qdir.cpp.

{
    if ( filtS == (FilterSpec) filterSpec )
        return;
    filtS = (FilterSpec) filterSpec;
    dirty = TRUE;
}

void QDir::setMatchAllDirs ( bool  enable )

virtual

If enable is TRUE, all directories will be listed (even if they do not match the filter or the name filter), otherwise only matched directories will be listed.

Bug:

Currently, directories that do not match the filter will not be included (the name filter will be ignored as expected).

See also

matchAllDirs()

Definition at line 626 of file qdir.cpp.

{
    if ( (bool)allDirs == enable )
        return;
    allDirs = enable;
    dirty = TRUE;
}

void QDir::setNameFilter ( const QString &  nameFilter )

virtual

Sets the name filter used by entryList() and entryInfoList().

The name filter is a wildcarding filter that understands "*" and "?" wildcards, You may specify several filter entries separated by a " " or a ";". If you want entryList() and entryInfoList() to list all files ending with ".cpp" and all files ending with ".h", you simply call dir.setNameFilter("*.cpp *.h") or dir.setNameFilter("*.cpp;*.h")

See also

nameFilter(), setFilter()

Definition at line 486 of file qdir.cpp.

{
    nameFilt = nameFilter;
    if ( nameFilt.isEmpty() )
        nameFilt = QString::fromLatin1("*");
    dirty = TRUE;
}

void QDir::setPath ( const QString &  path )

virtual

Sets the path of the directory. The path is cleaned of redundant ".", ".." and multiple separators. No check is made to ensure that a directory with this path exists.

The path can be either absolute or relative. Absolute paths begin with the directory separator ('/') or a drive specification (not applicable to UNIX). Relative file names begin with a directory name or a file name and specify a path relative to the current directory. An example of an absolute path is the string "/tmp/quartz", a relative path might look like "src/fatlib". You can use the function isRelative() to check if a QDir is using a relative or an absolute file path. You can call the function convertToAbs() to convert a relative QDir to an absolute one.

See also

path(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), isRelative(), convertToAbs()

Definition at line 248 of file qdir.cpp.

{
    dPath = cleanDirPath( path );
    if ( dPath.isEmpty() )
        dPath = QString::fromLatin1(".");
    dirty = TRUE;
}

void QDir::setSorting ( int  sortSpec )

virtual

Sets the sorting order used by entryList() and entryInfoList().

The sortSpec is specified by or-ing values from the enum SortSpec. The different values are:

One of these:

Name

Sort by name (alphabetical order).

Time

Sort by time (most recent first).

Size

Sort by size (largest first).

Unsorted

Use the operating system order (UNIX does NOT sort alphabetically).

ORed with zero or more of these:

DirsFirst

Always put directory names first.

Reversed

Reverse sort order.

IgnoreCase

Ignore case when sorting by name.

Definition at line 600 of file qdir.cpp.

{
    if ( sortS == (SortSpec) sortSpec )
        return;
    sortS = (SortSpec) sortSpec;
    dirty = TRUE;
}

void QDir::slashify ( QString &  n )

staticprivate

Definition at line 65 of file qdir_unix.cpp.

{
}

QDir::SortSpec QDir::sorting ( ) const

inline

Returns the value set by setSorting()

See also

setSorting()

Definition at line 213 of file qdir.h.

{
    return sortS;
}

Member Data Documentation

uint QDir::allDirs

private

Definition at line 194 of file qdir.h.

uint QDir::dirty

private

Definition at line 193 of file qdir.h.

QString QDir::dPath

private

Definition at line 187 of file qdir.h.

QFileInfoList* QDir::fiList

private

Definition at line 189 of file qdir.h.

FilterSpec QDir::filtS

private

Definition at line 191 of file qdir.h.

QStringList* QDir::fList

private

Definition at line 188 of file qdir.h.

QString QDir::nameFilt

private

Definition at line 190 of file qdir.h.

SortSpec QDir::sortS

private

Definition at line 192 of file qdir.h.

---

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

• doxygen-1.8.11/qtools/qdir.h
• doxygen-1.8.11/qtools/qdir.cpp
• doxygen-1.8.11/qtools/qdir_unix.cpp
• doxygen-1.8.11/qtools/qdir_win32.cpp