qt-creator/src/plugins/qmlprojectmanager/fileformat/filesystemwatcher.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/

#include "filesystemwatcher.h"

#include <QtCore/QDebug>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QFileSystemWatcher>
#include <QtCore/QTimer>

enum { debug = false };

namespace QmlProjectManager {

int FileSystemWatcher::m_objectCount = 0;
QHash<QString,int> FileSystemWatcher::m_fileCount;
QHash<QString,int> FileSystemWatcher::m_directoryCount;
QFileSystemWatcher *FileSystemWatcher::m_watcher = 0;

FileSystemWatcher::FileSystemWatcher(QObject *parent) :
    QObject(parent)
{
    if (!m_watcher)
        m_watcher = new QFileSystemWatcher();
    ++m_objectCount;
    connect(m_watcher, SIGNAL(fileChanged(QString)),
            this, SLOT(slotFileChanged(QString)));
    connect(m_watcher, SIGNAL(directoryChanged(QString)),
            this, SLOT(slotDirectoryChanged(QString)));
}

FileSystemWatcher::~FileSystemWatcher()
{
    removeFiles(files());
    removeDirectories(directories());

    if (--m_objectCount == 0) {
        delete m_watcher;
        m_watcher = 0;
    }
}

void FileSystemWatcher::addFile(const QString &file)
{
    addFiles(QStringList(file));
}


#ifdef Q_OS_MAC

// Returns upper limit of file handles that can be opened by this process at once. Exceeding it will probably result in crashes!
static rlim_t getFileLimit()
{
    struct rlimit rl;
    getrlimit(RLIMIT_NOFILE, &rl);
    return rl.rlim_cur;
}

#endif

void FileSystemWatcher::addFiles(const QStringList &files)
{
    QStringList toAdd;

    if (debug)
        qDebug() << Q_FUNC_INFO << files.count();

    foreach (const QString &file, files) {
        if (m_files.contains(file)) {
            qWarning() << "FileSystemWatcher: File" << file << "is already being watched";
            continue;
        }

#ifdef Q_OS_MAC
        static rlim_t maxFileOpen = getFileLimit();
        // We're potentially watching a _lot_ of directories. This might crash qtcreator when we hit the upper limit.
        // Heuristic is therefore: Don't use more than half of the file handles available in this watcher
        if ((rlim_t)m_directories.size() + (rlim_t)m_files.size() > maxFileOpen / 2) {
            qWarning() << "File" << file << "is not watched: Too many file handles are already open (max is" << maxFileOpen;
            break;
        }
#endif

        m_files.append(file);

        const int count = ++m_fileCount[file];
        Q_ASSERT(count > 0);

        if (count == 1)
            toAdd << file;
    }

    if (!toAdd.isEmpty())
        m_watcher->addPaths(toAdd);
}

void FileSystemWatcher::removeFile(const QString &file)
{
    removeFiles(QStringList(file));
}

void FileSystemWatcher::removeFiles(const QStringList &files)
{
    QStringList toRemove;

    if (debug)
        qDebug() << Q_FUNC_INFO << files.count();

    foreach (const QString &file, files) {
        if (!m_files.contains(file)) {
            qWarning() << "FileSystemWatcher: File" << file << "is not watched";
            continue;
        }
        m_files.removeOne(file);
        const int count = --m_fileCount[file];
        Q_ASSERT(count >= 0);

        if (!count) {
            toRemove << file;
        }
    }

    if (!toRemove.isEmpty())
        m_watcher->removePaths(toRemove);
}

QStringList FileSystemWatcher::files() const
{
    return m_files;
}

void FileSystemWatcher::addDirectory(const QString &directory)
{
    addDirectories(QStringList(directory));
}

void FileSystemWatcher::addDirectories(const QStringList &directories)
{
    QStringList toAdd;

    if (debug)
        qDebug() << Q_FUNC_INFO << directories.count();

    foreach (const QString &directory, directories) {
        if (m_directories.contains(directory)) {
            qWarning() << "Directory" << directory << "is already being watched";
            continue;
        }

#ifdef Q_OS_MAC
        static rlim_t maxFileOpen = getFileLimit();
        // We're potentially watching a _lot_ of directories. This might crash qtcreator when we hit the upper limit.
        // Heuristic is therefore: Don't use more than half of the file handles available in this watcher
        if ((rlim_t)m_directories.size() + (rlim_t)m_files.size() > maxFileOpen / 2) {
            qWarning() << "Directory" << directory << "is not watched: Too many file handles are already open (max is" << maxFileOpen;
            break;
        }
#endif

        m_directories.append(directory);

        const int count = ++m_directoryCount[directory];
        Q_ASSERT(count > 0);

        if (count == 1)
            toAdd << directory;
    }

    if (!toAdd.isEmpty())
        m_watcher->addPaths(toAdd);
}

void FileSystemWatcher::removeDirectory(const QString &directory)
{
    removeDirectories(QStringList(directory));
}

void FileSystemWatcher::removeDirectories(const QStringList &directories)
{
    QStringList toRemove;

    if (debug)
        qDebug() << Q_FUNC_INFO << directories.count();

    foreach (const QString &directory, directories) {
        if (!m_directories.contains(directory)) {
            qWarning() << "FileSystemWatcher: Directory" << directory << "is not watched";
            continue;
        }
        m_directories.removeOne(directory);

        const int count = --m_directoryCount[directory];
        Q_ASSERT(count >= 0);

        if (!count) {
            toRemove << directory;
        }
    }
    if (!toRemove.isEmpty())
        m_watcher->removePaths(toRemove);
}

QStringList FileSystemWatcher::directories() const
{
    return m_directories;
}

void FileSystemWatcher::slotFileChanged(const QString &path)
{
    if (m_files.contains(path))
        emit fileChanged(path);
}

void FileSystemWatcher::slotDirectoryChanged(const QString &path)
{
    if (m_directories.contains(path))
        emit directoryChanged(path);
}

} // namespace QmlProjectManager