fileutils.h 5.75 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**************************************************************************/

#ifndef FILEUTILS_H
#define FILEUTILS_H

#include "utils_global.h"

36 37 38 39 40
#include <QCoreApplication>
#include <QIODevice>
#include <QXmlStreamWriter> // Mac.
#include <QFileInfo>
#include <QMetaType>
41 42 43 44 45 46 47

QT_BEGIN_NAMESPACE
class QFile;
class QTemporaryFile;
class QWidget;
class QTextStream;
class QDataStream;
48
class QDateTime;
49 50 51 52
QT_END_NAMESPACE

namespace Utils {

53 54 55 56 57 58 59
class QTCREATOR_UTILS_EXPORT FileUtils {
public:
    static bool removeRecursively(const QString &filePath, QString *error = 0);
    static bool copyRecursively(const QString &srcFilePath,
                         const QString &tgtFilePath, QString *error = 0);
    static bool isFileNewerThan(const QString &filePath,
                            const QDateTime &timeStamp);
60
    static QString resolveSymlinks(const QString &path);
61 62
};

63 64
class QTCREATOR_UTILS_EXPORT FileReader
{
Friedemann Kleint's avatar
Friedemann Kleint committed
65
    Q_DECLARE_TR_FUNCTIONS(Utils::FileUtils) // sic!
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
public:
    static QByteArray fetchQrc(const QString &fileName); // Only for internal resources
    bool fetch(const QString &fileName, QIODevice::OpenMode mode = QIODevice::NotOpen); // QIODevice::ReadOnly is implicit
    bool fetch(const QString &fileName, QIODevice::OpenMode mode, QString *errorString);
    bool fetch(const QString &fileName, QString *errorString)
        { return fetch(fileName, QIODevice::NotOpen, errorString); }
    bool fetch(const QString &fileName, QIODevice::OpenMode mode, QWidget *parent);
    bool fetch(const QString &fileName, QWidget *parent)
        { return fetch(fileName, QIODevice::NotOpen, parent); }
    const QByteArray &data() const { return m_data; }
    const QString &errorString() const { return m_errorString; }
private:
    QByteArray m_data;
    QString m_errorString;
};

class QTCREATOR_UTILS_EXPORT FileSaverBase
{
Friedemann Kleint's avatar
Friedemann Kleint committed
84
    Q_DECLARE_TR_FUNCTIONS(Utils::FileUtils) // sic!
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
public:
    FileSaverBase();
    virtual ~FileSaverBase();

    QString fileName() const { return m_fileName; }
    bool hasError() const { return m_hasError; }
    QString errorString() const { return m_errorString; }
    virtual bool finalize();
    bool finalize(QString *errStr);
    bool finalize(QWidget *parent);

    bool write(const char *data, int len);
    bool write(const QByteArray &bytes);
    bool setResult(QTextStream *stream);
    bool setResult(QDataStream *stream);
    bool setResult(QXmlStreamWriter *stream);
    bool setResult(bool ok);

protected:
    QFile *m_file;
    QString m_fileName;
    QString m_errorString;
    bool m_hasError;

private:
    Q_DISABLE_COPY(FileSaverBase)
};

class QTCREATOR_UTILS_EXPORT FileSaver : public FileSaverBase
{
Friedemann Kleint's avatar
Friedemann Kleint committed
115
    Q_DECLARE_TR_FUNCTIONS(Utils::FileUtils) // sic!
116 117 118 119 120 121 122 123 124 125 126 127 128
public:
    explicit FileSaver(const QString &filename, QIODevice::OpenMode mode = QIODevice::NotOpen); // QIODevice::WriteOnly is implicit

    virtual bool finalize();
    using FileSaverBase::finalize;
    QFile *file() { return m_file; }

private:
    bool m_isSafe;
};

class QTCREATOR_UTILS_EXPORT TempFileSaver : public FileSaverBase
{
Friedemann Kleint's avatar
Friedemann Kleint committed
129
    Q_DECLARE_TR_FUNCTIONS(Utils::FileUtils) // sic!
130 131 132 133 134 135 136 137 138 139 140 141
public:
    explicit TempFileSaver(const QString &templ = QString());
    ~TempFileSaver();

    QTemporaryFile *file() { return reinterpret_cast<QTemporaryFile *>(m_file); }

    void setAutoRemove(bool on) { m_autoRemove = on; }

private:
    bool m_autoRemove;
};

Daniel Teske's avatar
Daniel Teske committed
142 143 144 145 146
class QTCREATOR_UTILS_EXPORT FileName : private QString
{
public:
    FileName();
    explicit FileName(const QFileInfo &info);
147
    QFileInfo toFileInfo() const;
Daniel Teske's avatar
Daniel Teske committed
148
    static FileName fromString(const QString &filename);
149 150 151
    static FileName fromUserInput(const QString &filename);
    QString toString() const;
    QString toUserOutput() const;
152 153

    FileName parentDir() const;
Daniel Teske's avatar
Daniel Teske committed
154 155

    bool operator==(const FileName &other) const;
156
    bool operator!=(const FileName &other) const;
Daniel Teske's avatar
Daniel Teske committed
157 158 159 160 161
    bool operator<(const FileName &other) const;
    bool operator<=(const FileName &other) const;
    bool operator>(const FileName &other) const;
    bool operator>=(const FileName &other) const;

162
    bool isChildOf(const FileName &s) const;
163
    bool isChildOf(const QDir &dir) const;
Daniel Teske's avatar
Daniel Teske committed
164 165
    bool endsWith(const QString &s) const;

166
    Utils::FileName relativeChildPath(const FileName &parent) const;
167 168 169
    Utils::FileName &appendPath(const QString &s);
    Utils::FileName &append(const QString &str);
    Utils::FileName &append(QChar str);
Daniel Teske's avatar
Daniel Teske committed
170 171 172 173 174

    using QString::size;
    using QString::count;
    using QString::length;
    using QString::isEmpty;
175 176
    using QString::isNull;
    using QString::clear;
Daniel Teske's avatar
Daniel Teske committed
177 178 179 180
private:
    FileName(const QString &string);
};

hjk's avatar
hjk committed
181
} // namespace Utils
182

183
QT_BEGIN_NAMESPACE
Daniel Teske's avatar
Daniel Teske committed
184
QTCREATOR_UTILS_EXPORT uint qHash(const Utils::FileName &a);
185
QT_END_NAMESPACE
Daniel Teske's avatar
Daniel Teske committed
186

187 188
Q_DECLARE_METATYPE(Utils::FileName)

189
#endif // FILEUTILS_H