fileutils.cpp 22.3 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 13 14
** 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
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22
** Alternatively, 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.
23
**
hjk's avatar
hjk committed
24 25
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32

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

33
#include "hostosinfo.h"
34 35
#include "qtcassert.h"

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

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

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

QT_END_NAMESPACE

59 60
namespace Utils {

61 62
/*! \class Utils::FileUtils

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

*/

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

  \note The \a error parameter is optional.

Leena Miettinen's avatar
Leena Miettinen committed
73
  Returns whether the operation succeeded.
74
*/
75
bool FileUtils::removeRecursively(const FileName &filePath, QString *error)
76
{
77
    QFileInfo fileInfo = filePath.toFileInfo();
78
    if (!fileInfo.exists() && !fileInfo.isSymLink())
79
        return true;
80
    QFile::setPermissions(filePath.toString(), fileInfo.permissions() | QFile::WriteUser);
81
    if (fileInfo.isDir()) {
82
        QDir dir(filePath.toString());
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
        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;
        }

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

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
/*!
  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
139
  Returns whether the operation succeeded.
140
*/
141 142
bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgtFilePath,
                                QString *error)
143
{
144
    QFileInfo srcFileInfo = srcFilePath.toFileInfo();
145
    if (srcFileInfo.isDir()) {
146
        QDir targetDir(tgtFilePath.toString());
147
        targetDir.cdUp();
148
        if (!targetDir.mkdir(tgtFilePath.toFileInfo().fileName())) {
149
            if (error) {
150
                *error = QCoreApplication::translate("Utils::FileUtils", "Failed to create directory \"%1\".")
151
                        .arg(tgtFilePath.toUserOutput());
152
            }
153
            return false;
154
        }
155 156 157
        QDir sourceDir(srcFilePath.toString());
        QStringList fileNames = sourceDir.entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot
                                                    | QDir::Hidden | QDir::System);
158
        foreach (const QString &fileName, fileNames) {
159 160 161 162
            FileName newSrcFilePath = srcFilePath;
            newSrcFilePath.appendPath(fileName);
            FileName newTgtFilePath = tgtFilePath;
            newTgtFilePath.appendPath(fileName);
163 164 165 166
            if (!copyRecursively(newSrcFilePath, newTgtFilePath, error))
                return false;
        }
    } else {
167
        if (!QFile::copy(srcFilePath.toString(), tgtFilePath.toString())) {
168
            if (error) {
169
                *error = QCoreApplication::translate("Utils::FileUtils", "Could not copy file \"%1\" to \"%2\".")
170
                        .arg(srcFilePath.toUserOutput(), tgtFilePath.toUserOutput());
171 172 173 174 175 176 177
            }
            return false;
        }
    }
    return true;
}

178 179 180
/*!
  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
181
  be returned if the file is newer than \a timeStamp.
182

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

202
/*!
Leena Miettinen's avatar
Leena Miettinen committed
203
  Recursively resolves possibly present symlinks in \a filePath.
204 205 206 207 208
  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
209
  Returns the symlink target file path.
210
*/
211
FileName FileUtils::resolveSymlinks(const FileName &path)
212
{
213
    QFileInfo f = path.toFileInfo();
214 215 216 217
    int links = 16;
    while (links-- && f.isSymLink())
        f.setFile(f.symLinkTarget());
    if (links <= 0)
218 219
        return FileName();
    return FileName::fromString(f.filePath());
220
}
221

222 223 224 225
/*!
  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
226
  Returns the possibly shortened path with native separators.
227 228 229 230 231 232 233 234 235 236 237 238 239
*/
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();
}

240 241 242 243 244 245 246 247 248 249
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;
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
}

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);
269 270
}

271 272 273 274 275 276
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
277 278 279 280 281
// 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
282 283 284 285 286
    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
287
        return name;
288 289
    TCHAR buffer[MAX_PATH];
    if (!SHGetPathFromIDList(file, buffer))
Orgad Shaneh's avatar
Orgad Shaneh committed
290
        return name;
291
    return QDir::fromNativeSeparators(QString::fromUtf16(reinterpret_cast<const ushort *>(buffer)));
Orgad Shaneh's avatar
Orgad Shaneh committed
292 293 294 295 296
#else // Filesystem is case-insensitive only on Windows
    return name;
#endif
}

297 298 299 300
bool FileUtils::isRelativePath(const QString &path)
{
    if (path.startsWith(QLatin1Char('/')))
        return false;
Christian Kandeler's avatar
Christian Kandeler committed
301 302 303 304 305 306 307 308 309
    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;
    }
310 311 312 313 314 315 316 317 318 319 320 321 322
    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);
}


323 324
QByteArray FileReader::fetchQrc(const QString &fileName)
{
325
    QTC_ASSERT(fileName.startsWith(QLatin1Char(':')), return QByteArray());
326 327
    QFile file(fileName);
    bool ok = file.open(QIODevice::ReadOnly);
328
    QTC_ASSERT(ok, qWarning() << fileName << "not there!"; return QByteArray());
329 330 331 332 333
    return file.readAll();
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode)
{
334
    QTC_ASSERT(!(mode & ~(QIODevice::ReadOnly | QIODevice::Text)), return false);
335 336 337 338 339 340 341 342 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

    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)
{
439
    return setResult(stream->status() == QDataStream::Ok);
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
}

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);
472 473 474 475
    if (m_hasError) {
        if (sf->isOpen())
            sf->rollback();
    } else {
476
        setResult(sf->commit());
477
    }
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
    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);
}

508 509
/*! \class Utils::FileName

510
    \brief The FileName class is a light-weight convenience class for filenames.
511 512 513 514

    On windows filenames are compared case insensitively.
*/

Daniel Teske's avatar
Daniel Teske committed
515 516 517 518 519 520
FileName::FileName()
    : QString()
{

}

521
/// Constructs a FileName from \a info
Daniel Teske's avatar
Daniel Teske committed
522 523 524 525 526
FileName::FileName(const QFileInfo &info)
    : QString(info.absoluteFilePath())
{
}

527 528 529 530 531 532 533
/// \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
534 535 536 537 538
QString FileName::toString() const
{
    return QString(*this);
}

539 540 541 542 543 544 545
/// \returns a QString to display to the user
/// Converts the separators to the native format
QString FileName::toUserOutput() const
{
    return QDir::toNativeSeparators(toString());
}

546 547
/// Find the parent directory of a given directory.

Sergio Ahumada's avatar
Sergio Ahumada committed
548
/// Returns an empty FileName if the current directory is already
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
/// 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);
}

568 569
/// Constructs a FileName from \a fileName
/// \a fileName is not checked for validity.
Daniel Teske's avatar
Daniel Teske committed
570 571 572 573 574
FileName FileName::fromString(const QString &filename)
{
    return FileName(filename);
}

575 576 577 578 579 580 581
/// Constructs a FileName from \a fileName
/// \a fileName is not checked for validity.
FileName FileName::fromLatin1(const QByteArray &filename)
{
    return FileName(QString::fromLatin1(filename));
}

582 583 584 585
/// Constructs a FileName from \a fileName
/// \a fileName is only passed through QDir::cleanPath
FileName FileName::fromUserInput(const QString &filename)
{
586 587
    QString clean = QDir::cleanPath(filename);
    if (clean.startsWith(QLatin1String("~/")))
Eike Ziller's avatar
Eike Ziller committed
588
        clean = QDir::homePath() + clean.mid(1);
589
    return FileName(clean);
590 591
}

Daniel Teske's avatar
Daniel Teske committed
592 593 594 595 596
FileName::FileName(const QString &string)
    : QString(string)
{

}
597

Daniel Teske's avatar
Daniel Teske committed
598 599
bool FileName::operator==(const FileName &other) const
{
600
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) == 0;
Daniel Teske's avatar
Daniel Teske committed
601 602
}

603 604 605 606 607
bool FileName::operator!=(const FileName &other) const
{
    return !(*this == other);
}

Daniel Teske's avatar
Daniel Teske committed
608 609
bool FileName::operator<(const FileName &other) const
{
610
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) < 0;
Daniel Teske's avatar
Daniel Teske committed
611 612 613 614
}

bool FileName::operator<=(const FileName &other) const
{
615
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) <= 0;
Daniel Teske's avatar
Daniel Teske committed
616 617 618 619 620 621 622 623 624 625 626 627
}

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

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

628 629
/// \returns whether FileName is a child of \a s
bool FileName::isChildOf(const FileName &s) const
Daniel Teske's avatar
Daniel Teske committed
630
{
631 632
    if (s.isEmpty())
        return false;
633
    if (!QString::startsWith(s, HostOsInfo::fileNameCaseSensitivity()))
634 635 636
        return false;
    if (size() <= s.size())
        return false;
637 638 639 640
    // 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)
641
    return at(s.size()) == QLatin1Char('/');
Daniel Teske's avatar
Daniel Teske committed
642 643
}

644 645 646 647 648 649
/// \overload
bool FileName::isChildOf(const QDir &dir) const
{
    return isChildOf(Utils::FileName::fromString(dir.absolutePath()));
}

650
/// \returns whether FileName endsWith \a s
Daniel Teske's avatar
Daniel Teske committed
651 652
bool FileName::endsWith(const QString &s) const
{
653
    return QString::endsWith(s, HostOsInfo::fileNameCaseSensitivity());
Daniel Teske's avatar
Daniel Teske committed
654 655
}

656 657 658 659
/// \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
660
{
661 662 663
    if (!isChildOf(parent))
        return Utils::FileName();
    return FileName(QString::mid(parent.size() + 1, -1));
Daniel Teske's avatar
Daniel Teske committed
664 665
}

666
/// Appends \a s, ensuring a / between the parts
667
FileName &FileName::appendPath(const QString &s)
Daniel Teske's avatar
Daniel Teske committed
668
{
669
    if (!isEmpty() && !QString::endsWith(QLatin1Char('/')))
670 671
        appendString(QLatin1Char('/'));
    appendString(s);
672 673 674
    return *this;
}

675
FileName &FileName::appendString(const QString &str)
676 677 678 679 680
{
    QString::append(str);
    return *this;
}

681
FileName &FileName::appendString(QChar str)
682 683 684
{
    QString::append(str);
    return *this;
Daniel Teske's avatar
Daniel Teske committed
685 686
}

687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
static bool isDesktopFileManagerDrop(const QMimeData *d, QStringList *files = 0)
{
    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)
                files->push_back(fileName);
            else
                break; // No result list, sufficient for checking
        }
    }
    return hasFiles;
}

FileDropSupport::FileDropSupport(QWidget *parentWidget)
    : QObject(parentWidget)
{
    QTC_ASSERT(parentWidget, return);
    parentWidget->setAcceptDrops(true);
    parentWidget->installEventFilter(this);
}

bool FileDropSupport::eventFilter(QObject *obj, QEvent *event)
{
    Q_UNUSED(obj)
    if (event->type() == QEvent::DragEnter) {
        auto dee = static_cast<QDragEnterEvent *>(event);
        if (isDesktopFileManagerDrop(dee->mimeData()))
            event->accept();
        else
            event->ignore();
    } else if (event->type() == QEvent::Drop) {
        auto de = static_cast<QDropEvent *>(event);
        QStringList tempFiles;
        if (isDesktopFileManagerDrop(de->mimeData(), &tempFiles)) {
            event->accept();
            bool needToScheduleEmit = m_files.isEmpty();
            m_files.append(tempFiles);
            if (needToScheduleEmit) // otherwise we already have a timer pending
                QTimer::singleShot(0, this, SLOT(emitFilesDropped()));
        } else {
            event->ignore();
        }
    }
    return false;
}

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

753
} // namespace Utils
Daniel Teske's avatar
Daniel Teske committed
754

755
QT_BEGIN_NAMESPACE
Daniel Teske's avatar
Daniel Teske committed
756 757
uint qHash(const Utils::FileName &a)
{
758
    if (Utils::HostOsInfo::fileNameCaseSensitivity() == Qt::CaseInsensitive)
759
        return qHash(a.toString().toUpper());
Daniel Teske's avatar
Daniel Teske committed
760 761
    return qHash(a.toString());
}
762
QT_END_NAMESPACE