d4/d68/qdir_8h_source.html

// Copyright (C) 2020 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef QDIR_H

#define QDIR_H


#include <QtCore/qcompare.h>

#include <QtCore/qstring.h>

#include <QtCore/qfile.h>

#include <QtCore/qfileinfo.h>

#include <QtCore/qstringlist.h>

#include <QtCore/qshareddata.h>


QT_BEGIN_NAMESPACE


class QDirIterator;

class QDirPrivate;


class Q_CORE_EXPORT QDir

{

public:

    enum Filter { Dirs        = 0x001,

                  Files       = 0x002,

                  Drives      = 0x004,

                  NoSymLinks  = 0x008,

                  AllEntries  = Dirs | Files | Drives,

                  TypeMask    = 0x00f,


                  Readable    = 0x010,

                  Writable    = 0x020,

                  Executable  = 0x040,

                  PermissionMask    = 0x070,


                  Modified    = 0x080,

                  Hidden      = 0x100,

                  System      = 0x200,


                  AccessMask  = 0x3F0,


                  AllDirs       = 0x400,

                  CaseSensitive = 0x800,

                  NoDot         = 0x2000,

                  NoDotDot      = 0x4000,

                  NoDotAndDotDot = NoDot | NoDotDot,


                  NoFilter = -1

    };

    Q_DECLARE_FLAGS(Filters, Filter)


    enum SortFlag { Name        = 0x00,

                    Time        = 0x01,

                    Size        = 0x02,

                    Unsorted    = 0x03,

                    SortByMask  = 0x03,


                    DirsFirst   = 0x04,

                    Reversed    = 0x08,

                    IgnoreCase  = 0x10,

                    DirsLast    = 0x20,

                    LocaleAware = 0x40,

                    Type        = 0x80,

                    NoSort = -1

    };

    Q_DECLARE_FLAGS(SortFlags, SortFlag)


    QDir(const QDir &);

    QDir(const QString &path = QString());

    QDir(const QString &path, const QString &nameFilter,

         SortFlags sort = SortFlags(Name | IgnoreCase), Filters filter = AllEntries);

#ifdef Q_QDOC

    QDir(const std::filesystem::path &path);

    QDir(const std::filesystem::path &path, const QString &nameFilter,

         SortFlags sort = SortFlags(Name | IgnoreCase), Filters filter = AllEntries);

#elif QT_CONFIG(cxx17_filesystem)

    template<typename T, QtPrivate::ForceFilesystemPath<T> = 0>

    QDir(const T &path) : QDir(QtPrivate::fromFilesystemPath(path))

    {

    }

    template<typename T, QtPrivate::ForceFilesystemPath<T> = 0>

    QDir(const T &path, const QString &nameFilter,

         SortFlags sort = SortFlags(Name | IgnoreCase), Filters filter = AllEntries)

         : QDir(QtPrivate::fromFilesystemPath(path), nameFilter, sort, filter)

    {

    }

#endif // QT_CONFIG(cxx17_filesystem)

    ~QDir();


    QDir &operator=(const QDir &);

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QDir)


    void swap(QDir &other) noexcept

    { d_ptr.swap(other.d_ptr); }


    void setPath(const QString &path);

#ifdef Q_QDOC

    void setPath(const std::filesystem::path &path);

#elif QT_CONFIG(cxx17_filesystem)

    template<typename T, QtPrivate::ForceFilesystemPath<T> = 0>

    void setPath(const T &path)

    {

        setPath(QtPrivate::fromFilesystemPath(path));

    }

#endif // QT_CONFIG(cxx17_filesystem)

    QString path() const;

    QString absolutePath() const;

    QString canonicalPath() const;

#if QT_CONFIG(cxx17_filesystem) || defined(Q_QDOC)

    std::filesystem::path filesystemPath() const

    { return QtPrivate::toFilesystemPath(path()); }

    std::filesystem::path filesystemAbsolutePath() const

    { return QtPrivate::toFilesystemPath(absolutePath()); }

    std::filesystem::path filesystemCanonicalPath() const

    { return QtPrivate::toFilesystemPath(canonicalPath()); }

#endif // QT_CONFIG(cxx17_filesystem)


#ifndef QT_BOOTSTRAPPED

    static void setSearchPaths(const QString &prefix, const QStringList &searchPaths);

    static void addSearchPath(const QString &prefix, const QString &path);

#ifdef Q_QDOC

    static void addSearchPath(const QString &prefix, const std::filesystem::path &path);

#elif QT_CONFIG(cxx17_filesystem)

    template<typename T, QtPrivate::ForceFilesystemPath<T> = 0>

    static void addSearchPath(const QString &prefix, const T &path)

    {

        addSearchPath(prefix, QtPrivate::fromFilesystemPath(path));

    }

#endif // QT_CONFIG(cxx17_filesystem)

    static QStringList searchPaths(const QString &prefix);

#endif // QT_BOOTSTRAPPED


    QString dirName() const;

    QString filePath(const QString &fileName) const;

    QString absoluteFilePath(const QString &fileName) const;

    QString relativeFilePath(const QString &fileName) const;


    static QString toNativeSeparators(const QString &pathName);

    static QString fromNativeSeparators(const QString &pathName);


    bool cd(const QString &dirName);

    bool cdUp();


    QStringList nameFilters() const;

    void setNameFilters(const QStringList &nameFilters);


    Filters filter() const;

    void setFilter(Filters filter);

    SortFlags sorting() const;

    void setSorting(SortFlags sort);


#if QT_CORE_REMOVED_SINCE(6, 5)

    uint count() const;

#endif

    qsizetype count(QT6_DECL_NEW_OVERLOAD) const;

    bool isEmpty(Filters filters = Filters(AllEntries | NoDotAndDotDot)) const;


#if QT_CORE_REMOVED_SINCE(6, 5) && QT_POINTER_SIZE != 4

    QString operator[](int) const;

#endif

    QString operator[](qsizetype) const;


    static QStringList nameFiltersFromString(const QString &nameFilter);


    QStringList entryList(Filters filters = NoFilter, SortFlags sort = NoSort) const;

    QStringList entryList(const QStringList &nameFilters, Filters filters = NoFilter,

                          SortFlags sort = NoSort) const;


    QFileInfoList entryInfoList(Filters filters = NoFilter, SortFlags sort = NoSort) const;

    QFileInfoList entryInfoList(const QStringList &nameFilters, Filters filters = NoFilter,

                                SortFlags sort = NoSort) const;


    bool mkdir(const QString &dirName) const;

    bool mkdir(const QString &dirName, QFile::Permissions permissions) const;

    bool rmdir(const QString &dirName) const;

    bool mkpath(const QString &dirPath) const;

    bool rmpath(const QString &dirPath) const;


    bool removeRecursively();


    bool isReadable() const;

    bool exists() const;

    bool isRoot() const;


    static bool isRelativePath(const QString &path);

    inline static bool isAbsolutePath(const QString &path) { return !isRelativePath(path); }

    bool isRelative() const;

    inline bool isAbsolute() const { return !isRelative(); }

    bool makeAbsolute();


#if QT_CORE_REMOVED_SINCE(6, 8)

    bool operator==(const QDir &dir) const;

    inline bool operator!=(const QDir &dir) const { return !operator==(dir); }

#endif


    bool remove(const QString &fileName);

    bool rename(const QString &oldName, const QString &newName);

    bool exists(const QString &name) const;


    static QFileInfoList drives();


    constexpr static inline QChar listSeparator() noexcept

    {

#if defined(Q_OS_WIN)

        return u';';

#else

        return u':';

#endif

    }


    static QChar separator()

    {

#if defined(Q_OS_WIN)

        return u'\\';

#else

        return u'/';

#endif

    }


    static bool setCurrent(const QString &path);

    static inline QDir current() { return QDir(currentPath()); }

    static QString currentPath();


    static inline QDir home() { return QDir(homePath()); }

    static QString homePath();

    static inline QDir root() { return QDir(rootPath()); }

    static QString rootPath();

    static inline QDir temp() { return QDir(tempPath()); }

    static QString tempPath();


#if QT_CONFIG(regularexpression)

    static bool match(const QStringList &filters, const QString &fileName);

    static bool match(const QString &filter, const QString &fileName);

#endif


    static QString cleanPath(const QString &path);

    void refresh() const;


protected:

    explicit QDir(QDirPrivate &d);


    QSharedDataPointer<QDirPrivate> d_ptr;


private:

    friend Q_CORE_EXPORT bool comparesEqual(const QDir &lhs, const QDir &rhs);

    Q_DECLARE_EQUALITY_COMPARABLE(QDir)

    friend class QDirIterator;

    friend class QDirListing;

    // Q_DECLARE_PRIVATE equivalent for shared data pointers

    QDirPrivate *d_func();

    const QDirPrivate *d_func() const { return d_ptr.constData(); }

};


Q_DECLARE_SHARED(QDir)

Q_DECLARE_OPERATORS_FOR_FLAGS(QDir::Filters)

Q_DECLARE_OPERATORS_FOR_FLAGS(QDir::SortFlags)


#ifndef QT_NO_DEBUG_STREAM

class QDebug;

Q_CORE_EXPORT QDebug operator<<(QDebug debug, QDir::Filters filters);

Q_CORE_EXPORT QDebug operator<<(QDebug debug, const QDir &dir);

#endif


QT_END_NAMESPACE


#endif // QDIR_H

QChar
\inmodule QtCore

QDebug
\inmodule QtCore

QDirIterator
The QDirIterator class provides an iterator for directory entrylists.
Definition qdiriterator.h:13

QDirListing
The QDirListing class provides an STL-style iterator for directory entries.
Definition qdirlisting.h:18

QDirPrivate
Definition qdir_p.h:28

QDir
\inmodule QtCore
Definition qdir.h:20

QDir::isAbsolute
bool isAbsolute() const
Returns true if the directory's path is absolute; otherwise returns false.
Definition qdir.h:186

QDir::isAbsolutePath
static bool isAbsolutePath(const QString &path)
Returns true if path is absolute; returns false if it is relative.
Definition qdir.h:184

QDir::root
static QDir root()
Returns the root directory.
Definition qdir.h:224

QDir::current
static QDir current()
Returns the application's current directory.
Definition qdir.h:219

QDir::temp
static QDir temp()
Returns the system's temporary directory.
Definition qdir.h:226

QDir::d_ptr
QSharedDataPointer< QDirPrivate > d_ptr
Definition qdir.h:240

QDir::separator
static QChar separator()
Returns the native directory separator: "/" under Unix and "\\" under Windows.
Definition qdir.h:209

QDir::home
static QDir home()
Returns the user's home directory.
Definition qdir.h:222

QDir::SortFlag
SortFlag
This enum describes the sort options available to QDir, e.g.
Definition qdir.h:50

QDir::Filter
Filter
This enum describes the filtering options available to QDir; e.g.
Definition qdir.h:22

QDir::listSeparator
static constexpr QChar listSeparator() noexcept
Definition qdir.h:200

QList< QFileInfo >

QStringList
\inmodule QtCore

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:129

Name
std::list< QString >::iterator Name
Definition lalr.h:28

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1590

QtPrivate
\macro QT_NO_KEYWORDS >
Definition qtconcurrentcompilertest.h:13

Q_DECLARE_EQUALITY_COMPARABLE
#define Q_DECLARE_EQUALITY_COMPARABLE(...)
Definition qcomparehelpers.h:309

operator!=
constexpr bool operator!=(const timespec &t1, const timespec &t2)
Definition qcore_unix_p.h:110

void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:409

comparesEqual
bool comparesEqual(const QDir &lhs, const QDir &rhs)
Definition qdir.cpp:1819

operator<<
Q_CORE_EXPORT QDebug operator<<(QDebug debug, QDir::Filters filters)
Definition qdir.cpp:2447

Q_DECLARE_FLAGS
#define Q_DECLARE_FLAGS(Flags, Enum)
Definition qflags.h:174

Q_DECLARE_OPERATORS_FOR_FLAGS
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
Definition qflags.h:194

debug
@ debug
Definition qibusplatforminputcontext.cpp:48

AccessMask
@ AccessMask
Definition qmetaobject_p.h:57

Readable
@ Readable
Definition qmetaobject_p.h:36

Writable
@ Writable
Definition qmetaobject_p.h:37

count
GLenum GLenum GLsizei count
Definition qopengles2ext.h:150

filter
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
Definition qopengles2ext.h:893

name
GLuint name
Definition qopengles2ext.h:156

path
GLsizei const GLchar *const  * path
Definition qopenglext.h:4283

isRelative
static QT_BEGIN_NAMESPACE bool isRelative(const QString &path)
Definition qqmlpreviewfileengine.cpp:15

absolutePath
static QString absolutePath(const QString &path)
Definition qqmlpreviewfileengine.cpp:30

TypeMask
@ TypeMask
Definition qqmlprofilerevent.cpp:28

operator==
bool operator==(const QRandomGenerator &rng1, const QRandomGenerator &rng2)
Definition qrandom.cpp:1220

canonicalPath
static QString canonicalPath(const QString &rootPath)
Definition qstorageinfo_win.cpp:22

absoluteFilePath
static QString absoluteFilePath(const Options *options, const QString &relativeFileName)
Definition main.cpp:1902

isReadable
return device isReadable() ? device -> read(static_cast< char * >(buf), size) :-1

match
static bool match(const uchar *found, uint foundLen, const char *target, uint targetLen)
Definition qtranslator.cpp:62

QT6_DECL_NEW_OVERLOAD
#define QT6_DECL_NEW_OVERLOAD
Definition qtversionchecks.h:67

qsizetype
ptrdiff_t qsizetype
Definition qtypes.h:165

uint
unsigned int uint
Definition qtypes.h:34

fromNativeSeparators
static QString fromNativeSeparators(const QString &pathName)
Definition qurl.cpp:3317

remove
settings remove("monkey")

d
double d
Definition src_corelib_text_qlocale.cpp:9

other
QSharedPointer< T > other(t)
[5]

swap
this swap(other)

dir
QString dir
[11]
Definition src_gui_dialogs_qfiledialog.cpp:79

fileName
fileName
[0]
Definition src_gui_dialogs_qfiledialog.cpp:5

setNameFilters
dialog setNameFilters(filters)

filters
const QStringList filters({"Image files (*.png *.xpm *.jpg)", "Text files (*.txt)", "Any files (*)" })
[6]

Type
Definition moc.h:23