fileutils.cpp 26.1 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
hjk's avatar
hjk committed
25 26
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
30 31 32 33

#include "fileutils.h"
#include "savefile.h"

34
#include "algorithm.h"
35
#include "hostosinfo.h"
36 37
#include "qtcassert.h"

38
#include <QDir>
39
#include <QDebug>
40
#include <QDateTime>
41 42
#include <QDragEnterEvent>
#include <QDropEvent>
43
#include <QMessageBox>
44
#include <QTimer>
Christian Kandeler's avatar
Christian Kandeler committed
45
#include <QUrl>
46

Orgad Shaneh's avatar
Orgad Shaneh committed
47 48
#ifdef Q_OS_WIN
#include <qt_windows.h>
49
#include <shlobj.h>
Orgad Shaneh's avatar
Orgad Shaneh committed
50 51
#endif

52 53 54 55 56 57 58 59
QT_BEGIN_NAMESPACE
QDebug operator<<(QDebug dbg, const Utils::FileName &c)
{
    return dbg << c.toString();
}

QT_END_NAMESPACE

60 61
namespace Utils {

62 63
/*! \class Utils::FileUtils

64 65
  \brief The FileUtils class contains file and directory related convenience
  functions.
66 67 68 69 70 71 72 73

*/

/*!
  Removes the directory \a filePath and its subdirectories recursively.

  \note The \a error parameter is optional.

Leena Miettinen's avatar
Leena Miettinen committed
74
  Returns whether the operation succeeded.
75
*/
76
bool FileUtils::removeRecursively(const FileName &filePath, QString *error)
77
{
78
    QFileInfo fileInfo = filePath.toFileInfo();
79
    if (!fileInfo.exists() && !fileInfo.isSymLink())
80
        return true;
81
    QFile::setPermissions(filePath.toString(), fileInfo.permissions() | QFile::WriteUser);
82
    if (fileInfo.isDir()) {
83
        QDir dir(filePath.toString());
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
        dir = dir.canonicalPath();
        if (dir.isRoot()) {
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils",
                    "Refusing to remove root directory.");
            }
            return false;
        }
        if (dir.path() == QDir::home().canonicalPath()) {
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils",
                    "Refusing to remove your home directory.");
            }
            return false;
        }

100 101 102
        QStringList fileNames = dir.entryList(QDir::Files | QDir::Hidden
                                              | QDir::System | QDir::Dirs | QDir::NoDotAndDotDot);
        foreach (const QString &fileName, fileNames) {
103
            if (!removeRecursively(FileName(filePath).appendPath(fileName), error))
104 105
                return false;
        }
106
        if (!QDir::root().rmdir(dir.path())) {
107
            if (error) {
108
                *error = QCoreApplication::translate("Utils::FileUtils", "Failed to remove directory \"%1\".")
109
                        .arg(filePath.toUserOutput());
110 111 112 113
            }
            return false;
        }
    } else {
114
        if (!QFile::remove(filePath.toString())) {
115
            if (error) {
116
                *error = QCoreApplication::translate("Utils::FileUtils", "Failed to remove file \"%1\".")
117
                        .arg(filePath.toUserOutput());
118 119 120 121 122 123 124
            }
            return false;
        }
    }
    return true;
}

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
/*!
  Copies the directory specified by \a srcFilePath recursively to \a tgtFilePath. \a tgtFilePath will contain
  the target directory, which will be created. Example usage:

  \code
    QString error;
    book ok = Utils::FileUtils::copyRecursively("/foo/bar", "/foo/baz", &error);
    if (!ok)
      qDebug() << error;
  \endcode

  This will copy the contents of /foo/bar into to the baz directory under /foo, which will be created in the process.

  \note The \a error parameter is optional.

Leena Miettinen's avatar
Leena Miettinen committed
140
  Returns whether the operation succeeded.
141
*/
142
bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgtFilePath,
BogDan Vatra's avatar
BogDan Vatra committed
143
                                QString *error, const std::function<bool (QFileInfo, QFileInfo, QString *)> &copyHelper)
144
{
145
    QFileInfo srcFileInfo = srcFilePath.toFileInfo();
146
    if (srcFileInfo.isDir()) {
hjk's avatar
hjk committed
147
        if (!tgtFilePath.exists()) {
BogDan Vatra's avatar
BogDan Vatra committed
148 149 150 151 152 153 154 155
            QDir targetDir(tgtFilePath.toString());
            targetDir.cdUp();
            if (!targetDir.mkdir(tgtFilePath.toFileInfo().fileName())) {
                if (error) {
                    *error = QCoreApplication::translate("Utils::FileUtils", "Failed to create directory \"%1\".")
                            .arg(tgtFilePath.toUserOutput());
                }
                return false;
156 157
            }
        }
158 159 160
        QDir sourceDir(srcFilePath.toString());
        QStringList fileNames = sourceDir.entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot
                                                    | QDir::Hidden | QDir::System);
161
        foreach (const QString &fileName, fileNames) {
162 163 164 165
            FileName newSrcFilePath = srcFilePath;
            newSrcFilePath.appendPath(fileName);
            FileName newTgtFilePath = tgtFilePath;
            newTgtFilePath.appendPath(fileName);
BogDan Vatra's avatar
BogDan Vatra committed
166
            if (!copyRecursively(newSrcFilePath, newTgtFilePath, error, copyHelper))
167 168 169
                return false;
        }
    } else {
BogDan Vatra's avatar
BogDan Vatra committed
170 171 172 173 174 175 176 177 178 179
        if (copyHelper) {
            if (!copyHelper(srcFileInfo, tgtFilePath.toFileInfo(), error))
                return false;
        } else {
            if (!QFile::copy(srcFilePath.toString(), tgtFilePath.toString())) {
                if (error) {
                    *error = QCoreApplication::translate("Utils::FileUtils", "Could not copy file \"%1\" to \"%2\".")
                            .arg(srcFilePath.toUserOutput(), tgtFilePath.toUserOutput());
                }
                return false;
180 181 182 183 184 185
            }
        }
    }
    return true;
}

186 187 188
/*!
  If \a filePath is a directory, the function will recursively check all files and return
  true if one of them is newer than \a timeStamp. If \a filePath is a single file, true will
Tobias Hunger's avatar
Tobias Hunger committed
189
  be returned if the file is newer than \a timeStamp.
190

Leena Miettinen's avatar
Leena Miettinen committed
191 192
  Returns whether at least one file in \a filePath has a newer date than
  \a timeStamp.
193
*/
194
bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeStamp)
195
{
196
    QFileInfo fileInfo = filePath.toFileInfo();
197 198 199
    if (!fileInfo.exists() || fileInfo.lastModified() >= timeStamp)
        return true;
    if (fileInfo.isDir()) {
200
        const QStringList dirContents = QDir(filePath.toString())
201 202
            .entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot);
        foreach (const QString &curFileName, dirContents) {
203
            if (isFileNewerThan(FileName(filePath).appendPath(curFileName), timeStamp))
204 205 206 207 208 209
                return true;
        }
    }
    return false;
}

210
/*!
Leena Miettinen's avatar
Leena Miettinen committed
211
  Recursively resolves possibly present symlinks in \a filePath.
212 213 214 215 216
  Unlike QFileInfo::canonicalFilePath(), this function will still return the expected target file
  even if the symlink is dangling.

  \note Maximum recursion depth == 16.

Leena Miettinen's avatar
Leena Miettinen committed
217
  Returns the symlink target file path.
218
*/
219
FileName FileUtils::resolveSymlinks(const FileName &path)
220
{
221
    QFileInfo f = path.toFileInfo();
222 223 224 225
    int links = 16;
    while (links-- && f.isSymLink())
        f.setFile(f.symLinkTarget());
    if (links <= 0)
226 227
        return FileName();
    return FileName::fromString(f.filePath());
228
}
229

230 231 232 233
/*!
  Like QDir::toNativeSeparators(), but use prefix '~' instead of $HOME on unix systems when an
  absolute path is given.

Leena Miettinen's avatar
Leena Miettinen committed
234
  Returns the possibly shortened path with native separators.
235 236 237 238 239 240 241 242 243 244 245 246 247
*/
QString FileUtils::shortNativePath(const FileName &path)
{
    if (HostOsInfo::isAnyUnixHost()) {
        const FileName home = FileName::fromString(QDir::cleanPath(QDir::homePath()));
        if (path.isChildOf(home)) {
            return QLatin1Char('~') + QDir::separator()
                + QDir::toNativeSeparators(path.relativeChildPath(home).toString());
        }
    }
    return path.toUserOutput();
}

248 249 250 251 252 253 254 255 256 257
QString FileUtils::fileSystemFriendlyName(const QString &name)
{
    QString result = name;
    result.replace(QRegExp(QLatin1String("\\W")), QLatin1String("_"));
    result.replace(QRegExp(QLatin1String("_+")), QLatin1String("_")); // compact _
    result.remove(QRegExp(QLatin1String("^_*"))); // remove leading _
    result.remove(QRegExp(QLatin1String("_+$"))); // remove trailing _
    if (result.isEmpty())
        result = QLatin1String("unknown");
    return result;
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
}

int FileUtils::indexOfQmakeUnfriendly(const QString &name, int startpos)
{
    static QRegExp checkRegExp(QLatin1String("[^a-zA-Z0-9_.-]"));
    return checkRegExp.indexIn(name, startpos);
}

QString FileUtils::qmakeFriendlyName(const QString &name)
{
    QString result = name;

    // Remove characters that might trip up a build system (especially qmake):
    int pos = indexOfQmakeUnfriendly(result);
    while (pos >= 0) {
        result[pos] = QLatin1Char('_');
        pos = indexOfQmakeUnfriendly(result, pos);
    }
    return fileSystemFriendlyName(result);
277 278
}

279 280 281 282 283 284
bool FileUtils::makeWritable(const FileName &path)
{
    const QString fileName = path.toString();
    return QFile::setPermissions(fileName, QFile::permissions(fileName) | QFile::WriteUser);
}

Orgad Shaneh's avatar
Orgad Shaneh committed
285 286 287 288 289
// makes sure that capitalization of directories is canonical on Windows.
// This mimics the logic in QDeclarative_isFileCaseCorrect
QString FileUtils::normalizePathName(const QString &name)
{
#ifdef Q_OS_WIN
290 291 292 293 294
    const QString nativeSeparatorName(QDir::toNativeSeparators(name));
    const LPCTSTR nameC = reinterpret_cast<LPCTSTR>(nativeSeparatorName.utf16()); // MinGW
    PIDLIST_ABSOLUTE file;
    HRESULT hr = SHParseDisplayName(nameC, NULL, &file, 0, NULL);
    if (FAILED(hr))
Orgad Shaneh's avatar
Orgad Shaneh committed
295
        return name;
296 297
    TCHAR buffer[MAX_PATH];
    if (!SHGetPathFromIDList(file, buffer))
Orgad Shaneh's avatar
Orgad Shaneh committed
298
        return name;
299
    return QDir::fromNativeSeparators(QString::fromUtf16(reinterpret_cast<const ushort *>(buffer)));
Orgad Shaneh's avatar
Orgad Shaneh committed
300 301 302 303 304
#else // Filesystem is case-insensitive only on Windows
    return name;
#endif
}

305 306 307 308
bool FileUtils::isRelativePath(const QString &path)
{
    if (path.startsWith(QLatin1Char('/')))
        return false;
Christian Kandeler's avatar
Christian Kandeler committed
309 310 311 312 313 314 315 316 317
    if (HostOsInfo::isWindowsHost()) {
        if (path.startsWith(QLatin1Char('\\')))
            return false;
        // Unlike QFileInfo, this won't accept a relative path with a drive letter.
        // Such paths result in a royal mess anyway ...
        if (path.length() >= 3 && path.at(1) == QLatin1Char(':') && path.at(0).isLetter()
                && (path.at(2) == QLatin1Char('/') || path.at(2) == QLatin1Char('\\')))
            return false;
    }
318 319 320 321 322 323 324 325 326 327 328 329 330
    return true;
}

QString FileUtils::resolvePath(const QString &baseDir, const QString &fileName)
{
    if (fileName.isEmpty())
        return QString();
    if (isAbsolutePath(fileName))
        return QDir::cleanPath(fileName);
    return QDir::cleanPath(baseDir + QLatin1Char('/') + fileName);
}


331 332
QByteArray FileReader::fetchQrc(const QString &fileName)
{
333
    QTC_ASSERT(fileName.startsWith(QLatin1Char(':')), return QByteArray());
334 335
    QFile file(fileName);
    bool ok = file.open(QIODevice::ReadOnly);
336
    QTC_ASSERT(ok, qWarning() << fileName << "not there!"; return QByteArray());
337 338 339 340 341
    return file.readAll();
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode)
{
342
    QTC_ASSERT(!(mode & ~(QIODevice::ReadOnly | QIODevice::Text)), return false);
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446

    QFile file(fileName);
    if (!file.open(QIODevice::ReadOnly | mode)) {
        m_errorString = tr("Cannot open %1 for reading: %2").arg(
                QDir::toNativeSeparators(fileName), file.errorString());
        return false;
    }
    m_data = file.readAll();
    if (file.error() != QFile::NoError) {
        m_errorString = tr("Cannot read %1: %2").arg(
                QDir::toNativeSeparators(fileName), file.errorString());
        return false;
    }
    return true;
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode, QString *errorString)
{
    if (fetch(fileName, mode))
        return true;
    if (errorString)
        *errorString = m_errorString;
    return false;
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode, QWidget *parent)
{
    if (fetch(fileName, mode))
        return true;
    if (parent)
        QMessageBox::critical(parent, tr("File Error"), m_errorString);
    return false;
}


FileSaverBase::FileSaverBase()
    : m_hasError(false)
{
}

FileSaverBase::~FileSaverBase()
{
    delete m_file;
}

bool FileSaverBase::finalize()
{
    m_file->close();
    setResult(m_file->error() == QFile::NoError);
    // We delete the object, so it is really closed even if it is a QTemporaryFile.
    delete m_file;
    m_file = 0;
    return !m_hasError;
}

bool FileSaverBase::finalize(QString *errStr)
{
    if (finalize())
        return true;
    if (errStr)
        *errStr = errorString();
    return false;
}

bool FileSaverBase::finalize(QWidget *parent)
{
    if (finalize())
        return true;
    QMessageBox::critical(parent, tr("File Error"), errorString());
    return false;
}

bool FileSaverBase::write(const char *data, int len)
{
    if (m_hasError)
        return false;
    return setResult(m_file->write(data, len) == len);
}

bool FileSaverBase::write(const QByteArray &bytes)
{
    if (m_hasError)
        return false;
    return setResult(m_file->write(bytes) == bytes.count());
}

bool FileSaverBase::setResult(bool ok)
{
    if (!ok && !m_hasError) {
        m_errorString = tr("Cannot write file %1. Disk full?").arg(
                QDir::toNativeSeparators(m_fileName));
        m_hasError = true;
    }
    return ok;
}

bool FileSaverBase::setResult(QTextStream *stream)
{
    stream->flush();
    return setResult(stream->status() == QTextStream::Ok);
}

bool FileSaverBase::setResult(QDataStream *stream)
{
447
    return setResult(stream->status() == QDataStream::Ok);
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
}

bool FileSaverBase::setResult(QXmlStreamWriter *stream)
{
    return setResult(!stream->hasError());
}


FileSaver::FileSaver(const QString &filename, QIODevice::OpenMode mode)
{
    m_fileName = filename;
    if (mode & (QIODevice::ReadOnly | QIODevice::Append)) {
        m_file = new QFile(filename);
        m_isSafe = false;
    } else {
        m_file = new SaveFile(filename);
        m_isSafe = true;
    }
    if (!m_file->open(QIODevice::WriteOnly | mode)) {
        QString err = QFile::exists(filename) ?
                tr("Cannot overwrite file %1: %2") : tr("Cannot create file %1: %2");
        m_errorString = err.arg(QDir::toNativeSeparators(filename), m_file->errorString());
        m_hasError = true;
    }
}

bool FileSaver::finalize()
{
    if (!m_isSafe)
        return FileSaverBase::finalize();

    SaveFile *sf = static_cast<SaveFile *>(m_file);
480 481 482 483
    if (m_hasError) {
        if (sf->isOpen())
            sf->rollback();
    } else {
484
        setResult(sf->commit());
485
    }
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
    delete sf;
    m_file = 0;
    return !m_hasError;
}

TempFileSaver::TempFileSaver(const QString &templ)
    : m_autoRemove(true)
{
    QTemporaryFile *tempFile = new QTemporaryFile();
    if (!templ.isEmpty())
        tempFile->setFileTemplate(templ);
    tempFile->setAutoRemove(false);
    if (!tempFile->open()) {
        m_errorString = tr("Cannot create temporary file in %1: %2").arg(
                QDir::toNativeSeparators(QFileInfo(tempFile->fileTemplate()).absolutePath()),
                tempFile->errorString());
        m_hasError = true;
    }
    m_file = tempFile;
    m_fileName = tempFile->fileName();
}

TempFileSaver::~TempFileSaver()
{
    delete m_file;
    m_file = 0;
    if (m_autoRemove)
        QFile::remove(m_fileName);
}

516 517
/*! \class Utils::FileName

518
    \brief The FileName class is a light-weight convenience class for filenames.
519 520 521 522

    On windows filenames are compared case insensitively.
*/

Daniel Teske's avatar
Daniel Teske committed
523 524 525 526 527 528
FileName::FileName()
    : QString()
{

}

529
/// Constructs a FileName from \a info
Daniel Teske's avatar
Daniel Teske committed
530 531 532 533 534
FileName::FileName(const QFileInfo &info)
    : QString(info.absoluteFilePath())
{
}

535 536 537 538 539 540 541
/// \returns a QFileInfo
QFileInfo FileName::toFileInfo() const
{
    return QFileInfo(*this);
}

/// \returns a QString for passing on to QString based APIs
Daniel Teske's avatar
Daniel Teske committed
542 543 544 545 546
QString FileName::toString() const
{
    return QString(*this);
}

547 548 549 550 551 552 553
/// \returns a QString to display to the user
/// Converts the separators to the native format
QString FileName::toUserOutput() const
{
    return QDir::toNativeSeparators(toString());
}

hjk's avatar
hjk committed
554 555 556 557 558 559 560
/// \returns a bool indicating whether a file with this
/// FileName exists.
bool FileName::exists() const
{
    return QFileInfo::exists(*this);
}

561 562
/// Find the parent directory of a given directory.

Sergio Ahumada's avatar
Sergio Ahumada committed
563
/// Returns an empty FileName if the current directory is already
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
/// a root level directory.

/// \returns \a FileName with the last segment removed.
FileName FileName::parentDir() const
{
    const QString basePath = toString();
    if (basePath.isEmpty())
        return FileName();

    const QDir base(basePath);
    if (base.isRoot())
        return FileName();

    const QString path = basePath + QLatin1String("/..");
    const QString parent = QDir::cleanPath(path);

    return FileName::fromString(parent);
}

583 584
/// Constructs a FileName from \a filename
/// \a filename is not checked for validity.
Daniel Teske's avatar
Daniel Teske committed
585 586 587 588 589
FileName FileName::fromString(const QString &filename)
{
    return FileName(filename);
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
/// Constructs a FileName from \a fileName. The \a defaultExtension is appended
/// to \a filename if that does not have an extension already.
/// \a fileName is not checked for validity.
FileName FileName::fromString(const QString &filename, const QString &defaultExtension)
{
    if (filename.isEmpty() || defaultExtension.isEmpty())
        return filename;

    QString rc = filename;
    QFileInfo fi(filename);
    // Add extension unless user specified something else
    const QChar dot = QLatin1Char('.');
    if (!fi.fileName().contains(dot)) {
        if (!defaultExtension.startsWith(dot))
            rc += dot;
        rc += defaultExtension;
    }
    return rc;
}

610 611 612 613 614 615 616
/// Constructs a FileName from \a fileName
/// \a fileName is not checked for validity.
FileName FileName::fromLatin1(const QByteArray &filename)
{
    return FileName(QString::fromLatin1(filename));
}

617 618 619 620
/// Constructs a FileName from \a fileName
/// \a fileName is only passed through QDir::cleanPath
FileName FileName::fromUserInput(const QString &filename)
{
621 622
    QString clean = QDir::cleanPath(filename);
    if (clean.startsWith(QLatin1String("~/")))
Eike Ziller's avatar
Eike Ziller committed
623
        clean = QDir::homePath() + clean.mid(1);
624
    return FileName(clean);
625 626
}

Daniel Teske's avatar
Daniel Teske committed
627 628 629 630 631
FileName::FileName(const QString &string)
    : QString(string)
{

}
632

Daniel Teske's avatar
Daniel Teske committed
633 634
bool FileName::operator==(const FileName &other) const
{
635
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) == 0;
Daniel Teske's avatar
Daniel Teske committed
636 637
}

638 639 640 641 642
bool FileName::operator!=(const FileName &other) const
{
    return !(*this == other);
}

Daniel Teske's avatar
Daniel Teske committed
643 644
bool FileName::operator<(const FileName &other) const
{
645
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) < 0;
Daniel Teske's avatar
Daniel Teske committed
646 647 648 649
}

bool FileName::operator<=(const FileName &other) const
{
650
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) <= 0;
Daniel Teske's avatar
Daniel Teske committed
651 652 653 654 655 656 657 658 659 660 661 662
}

bool FileName::operator>(const FileName &other) const
{
    return other < *this;
}

bool FileName::operator>=(const FileName &other) const
{
    return other <= *this;
}

663 664
/// \returns whether FileName is a child of \a s
bool FileName::isChildOf(const FileName &s) const
Daniel Teske's avatar
Daniel Teske committed
665
{
666 667
    if (s.isEmpty())
        return false;
668
    if (!QString::startsWith(s, HostOsInfo::fileNameCaseSensitivity()))
669 670 671
        return false;
    if (size() <= s.size())
        return false;
672 673 674 675
    // s is root, '/' was already tested in startsWith
    if (s.QString::endsWith(QLatin1Char('/')))
        return true;
    // s is a directory, next character should be '/' (/tmpdir is NOT a child of /tmp)
676
    return at(s.size()) == QLatin1Char('/');
Daniel Teske's avatar
Daniel Teske committed
677 678
}

679 680 681
/// \overload
bool FileName::isChildOf(const QDir &dir) const
{
682
    return isChildOf(FileName::fromString(dir.absolutePath()));
683 684
}

685
/// \returns whether FileName endsWith \a s
Daniel Teske's avatar
Daniel Teske committed
686 687
bool FileName::endsWith(const QString &s) const
{
688
    return QString::endsWith(s, HostOsInfo::fileNameCaseSensitivity());
Daniel Teske's avatar
Daniel Teske committed
689 690
}

691 692 693 694
/// \returns the relativeChildPath of FileName to parent if FileName is a child of parent
/// \note returns a empty FileName if FileName is not a child of parent
/// That is, this never returns a path starting with "../"
FileName FileName::relativeChildPath(const FileName &parent) const
Daniel Teske's avatar
Daniel Teske committed
695
{
696
    if (!isChildOf(parent))
697
        return FileName();
698
    return FileName(QString::mid(parent.size() + 1, -1));
Daniel Teske's avatar
Daniel Teske committed
699 700
}

701
/// Appends \a s, ensuring a / between the parts
702
FileName &FileName::appendPath(const QString &s)
Daniel Teske's avatar
Daniel Teske committed
703
{
704 705
    if (s.isEmpty())
        return *this;
706
    if (!isEmpty() && !QString::endsWith(QLatin1Char('/')))
707 708
        appendString(QLatin1Char('/'));
    appendString(s);
709 710 711
    return *this;
}

712
FileName &FileName::appendString(const QString &str)
713 714 715 716 717
{
    QString::append(str);
    return *this;
}

718
FileName &FileName::appendString(QChar str)
719 720 721
{
    QString::append(str);
    return *this;
Daniel Teske's avatar
Daniel Teske committed
722 723
}

724 725 726 727 728
QTextStream &operator<<(QTextStream &s, const FileName &fn)
{
    return s << fn.toString();
}

729
static bool isFileDrop(const QMimeData *d, QList<FileDropSupport::FileSpec> *files = 0)
730
{
731 732 733 734 735 736 737 738
    // internal drop
    if (const FileDropMimeData *internalData = qobject_cast<const FileDropMimeData *>(d)) {
        if (files)
            *files = internalData->files();
        return true;
    }

    // external drop
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
    if (files)
        files->clear();
    // Extract dropped files from Mime data.
    if (!d->hasUrls())
        return false;
    const QList<QUrl> urls = d->urls();
    if (urls.empty())
        return false;
    // Try to find local files
    bool hasFiles = false;
    const QList<QUrl>::const_iterator cend = urls.constEnd();
    for (QList<QUrl>::const_iterator it = urls.constBegin(); it != cend; ++it) {
        const QString fileName = it->toLocalFile();
        if (!fileName.isEmpty()) {
            hasFiles = true;
            if (files)
755
                files->append(FileDropSupport::FileSpec(fileName));
756 757 758 759 760 761 762
            else
                break; // No result list, sufficient for checking
        }
    }
    return hasFiles;
}

763 764 765
FileDropSupport::FileDropSupport(QWidget *parentWidget, const DropFilterFunction &filterFunction)
    : QObject(parentWidget),
      m_filterFunction(filterFunction)
766 767 768 769 770 771
{
    QTC_ASSERT(parentWidget, return);
    parentWidget->setAcceptDrops(true);
    parentWidget->installEventFilter(this);
}

772 773 774 775 776
QStringList FileDropSupport::mimeTypesForFilePaths()
{
    return QStringList() << QStringLiteral("text/uri-list");
}

777 778 779 780 781
bool FileDropSupport::eventFilter(QObject *obj, QEvent *event)
{
    Q_UNUSED(obj)
    if (event->type() == QEvent::DragEnter) {
        auto dee = static_cast<QDragEnterEvent *>(event);
782
        if (isFileDrop(dee->mimeData())
783
                && (!m_filterFunction || m_filterFunction(dee)))
784 785 786
            event->accept();
        else
            event->ignore();
787 788 789 790
        return true;
    } else if (event->type() == QEvent::DragMove) {
        event->accept();
        return true;
791 792
    } else if (event->type() == QEvent::Drop) {
        auto de = static_cast<QDropEvent *>(event);
793 794
        QList<FileSpec> tempFiles;
        if (isFileDrop(de->mimeData(), &tempFiles)
795
                && (!m_filterFunction || m_filterFunction(de))) {
796
            const FileDropMimeData *fileDropMimeData = qobject_cast<const FileDropMimeData *>(de->mimeData());
797
            event->accept();
798 799 800 801
            if (fileDropMimeData && fileDropMimeData->isOverridingFileDropAction())
                de->setDropAction(fileDropMimeData->overrideFileDropAction());
            else
                de->acceptProposedAction();
802 803
            bool needToScheduleEmit = m_files.isEmpty();
            m_files.append(tempFiles);
804 805 806 807 808 809 810 811
            if (needToScheduleEmit) { // otherwise we already have a timer pending
                // Delay the actual drop, to avoid conflict between
                // actions that happen when opening files, and actions that the item views do
                // after the drag operation.
                // If we do not do this, e.g. dragging from Outline view crashes if the editor and
                // the selected item changes
                QTimer::singleShot(100, this, SLOT(emitFilesDropped()));
            }
812 813 814
        } else {
            event->ignore();
        }
815
        return true;
816 817 818 819 820 821 822 823 824 825 826
    }
    return false;
}

void FileDropSupport::emitFilesDropped()
{
    QTC_ASSERT(!m_files.isEmpty(), return);
    emit filesDropped(m_files);
    m_files.clear();
}

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
/*!
    Sets the drop action to effectively use, instead of the "proposed" drop action from the
    drop event. This can be useful when supporting move drags within an item view, but not
    "moving" an item from the item view into a split.
 */
FileDropMimeData::FileDropMimeData()
    : m_overrideDropAction(Qt::IgnoreAction),
      m_isOverridingDropAction(false)
{

}

void FileDropMimeData::setOverrideFileDropAction(Qt::DropAction action)
{
    m_isOverridingDropAction = true;
    m_overrideDropAction = action;
}

Qt::DropAction FileDropMimeData::overrideFileDropAction() const
{
    return m_overrideDropAction;
}

bool FileDropMimeData::isOverridingFileDropAction() const
{
    return m_isOverridingDropAction;
}

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
void FileDropMimeData::addFile(const QString &filePath, int line, int column)
{
    // standard mime data
    QList<QUrl> currentUrls = urls();
    currentUrls.append(QUrl::fromLocalFile(filePath));
    setUrls(currentUrls);
    // special mime data
    m_files.append(FileDropSupport::FileSpec(filePath, line, column));
}

QList<FileDropSupport::FileSpec> FileDropMimeData::files() const
{
    return m_files;
}

870
} // namespace Utils
Daniel Teske's avatar
Daniel Teske committed
871

872
QT_BEGIN_NAMESPACE
Daniel Teske's avatar
Daniel Teske committed
873 874
uint qHash(const Utils::FileName &a)
{
875
    if (Utils::HostOsInfo::fileNameCaseSensitivity() == Qt::CaseInsensitive)
876
        return qHash(a.toString().toUpper());
Daniel Teske's avatar
Daniel Teske committed
877 878
    return qHash(a.toString());
}
879
QT_END_NAMESPACE