src/plugins/qmlprojectmanager/fileformat/filefilteritems.cpp

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #include "filefilteritems.h"
  34
  35 #include <QtCore/QDebug>
  36 #include <QtCore/QDir>
  37 #include <QtGui/QImageReader>
  38
  39 namespace QmlProjectManager {
  40
  41 FileFilterBaseItem::FileFilterBaseItem(QObject *parent) :
  42         QmlProjectContentItem(parent),
  43         m_recurse(RecurseDefault)
  44 {
  45     m_updateFileListTimer.setSingleShot(true);
  46     m_updateFileListTimer.setInterval(50);
  47     connect(&m_dirWatcher, SIGNAL(directoryChanged(QString)), this, SLOT(updateFileList()));
  48     connect(&m_updateFileListTimer, SIGNAL(timeout()), this, SLOT(updateFileListNow()));
  49 }
  50
  51 QString FileFilterBaseItem::directory() const
  52 {
  53     return m_rootDir;
  54 }
  55
  56 void FileFilterBaseItem::setDirectory(const QString &dirPath)
  57 {
  58     if (m_rootDir == dirPath)
  59         return;
  60     m_rootDir = dirPath;
  61     emit directoryChanged();
  62
  63     updateFileList();
  64 }
  65
  66 void FileFilterBaseItem::setDefaultDirectory(const QString &dirPath)
  67 {
  68     if (m_defaultDir == dirPath)
  69         return;
  70     m_defaultDir = dirPath;
  71
  72     updateFileListNow();
  73 }
  74
  75 QString FileFilterBaseItem::filter() const
  76 {
  77     return m_filter;
  78 }
  79
  80 void FileFilterBaseItem::setFilter(const QString &filter)
  81 {
  82     if (filter == m_filter)
  83         return;
  84     m_filter = filter;
  85
  86     m_regExpList.clear();
  87     m_fileSuffixes.clear();
  88
  89     foreach (const QString &pattern, filter.split(QLatin1Char(';'))) {
  90         if (pattern.isEmpty())
  91             continue;
  92         // decide if it's a canonical pattern like *.x
  93         if (pattern.startsWith(QLatin1String("*."))) {
  94             const QString suffix = pattern.right(pattern.size() - 1);
  95             if (!suffix.contains(QLatin1Char('*'))
  96                     && !suffix.contains(QLatin1Char('?'))
  97                     && !suffix.contains(QLatin1Char('['))) {
  98                 m_fileSuffixes << suffix;
  99                 continue;
 100             }
 101         }
 102         m_regExpList << QRegExp(pattern, Qt::CaseInsensitive, QRegExp::Wildcard);
 103     }
 104
 105     updateFileList();
 106 }
 107
 108 bool FileFilterBaseItem::recursive() const
 109 {
 110     bool recursive;
 111     if (m_recurse == Recurse) {
 112         recursive = true;
 113     } else if (m_recurse == DoNotRecurse) {
 114         recursive = false;
 115     } else {  // RecurseDefault
 116         if (m_explicitFiles.isEmpty()) {
 117             recursive = true;
 118         } else {
 119             recursive = false;
 120         }
 121     }
 122     return recursive;
 123 }
 124
 125 void FileFilterBaseItem::setRecursive(bool recurse)
 126 {
 127     bool oldRecursive = recursive();
 128
 129     if (recurse) {
 130         m_recurse = Recurse;
 131     } else {
 132             m_recurse = DoNotRecurse;
 133     }
 134
 135     if (recurse != oldRecursive)
 136         updateFileList();
 137 }
 138
 139 QStringList FileFilterBaseItem::pathsProperty() const
 140 {
 141     return m_explicitFiles;
 142 }
 143
 144 void FileFilterBaseItem::setPathsProperty(const QStringList &path)
 145 {
 146     m_explicitFiles = path;
 147     updateFileList();
 148 }
 149
 150 QStringList FileFilterBaseItem::files() const
 151 {
 152     return m_files.toList();
 153 }
 154
 155 /**
 156   Check whether filter matches a file path - regardless whether the file already exists or not.
 157
 158   @param filePath: absolute file path
 159   */
 160 bool FileFilterBaseItem::matchesFile(const QString &filePath) const
 161 {
 162     foreach (const QString &explicitFile, m_explicitFiles) {
 163         if (absolutePath(explicitFile) == filePath)
 164             return true;
 165     }
 166
 167     const QString &fileName = QFileInfo(filePath).fileName();
 168
 169     if (!fileMatches(fileName))
 170         return false;
 171
 172     const QDir fileDir = QFileInfo(filePath).absoluteDir();
 173     foreach (const QString &watchedDirectory, m_dirWatcher.directories()) {
 174         if (QDir(watchedDirectory) == fileDir)
 175             return true;
 176     }
 177
 178     return false;
 179 }
 180
 181 QString FileFilterBaseItem::absolutePath(const QString &path) const
 182 {
 183     if (QFileInfo(path).isAbsolute())
 184         return path;
 185     return QDir(absoluteDir()).absoluteFilePath(path);
 186 }
 187
 188 QString FileFilterBaseItem::absoluteDir() const
 189 {
 190     QString absoluteDir;
 191     if (QFileInfo(m_rootDir).isAbsolute()) {
 192         absoluteDir = m_rootDir;
 193     } else if (!m_defaultDir.isEmpty()) {
 194         absoluteDir = m_defaultDir + QLatin1Char('/') + m_rootDir;
 195     }
 196
 197     return absoluteDir;
 198 }
 199
 200 void FileFilterBaseItem::updateFileList()
 201 {
 202     if (!m_updateFileListTimer.isActive())
 203         m_updateFileListTimer.start();
 204 }
 205
 206 void FileFilterBaseItem::updateFileListNow()
 207 {
 208     if (m_updateFileListTimer.isActive())
 209         m_updateFileListTimer.stop();
 210
 211     const QString projectDir = absoluteDir();
 212     if (projectDir.isEmpty())
 213         return;
 214
 215     QSet<QString> dirsToBeWatched;
 216     QSet<QString> newFiles;
 217     foreach (const QString &explicitPath, m_explicitFiles) {
 218         newFiles << absolutePath(explicitPath);
 219     }
 220     if ((!m_fileSuffixes.isEmpty() || !m_regExpList.isEmpty()) && m_explicitFiles.isEmpty())
 221         newFiles += filesInSubTree(QDir(m_defaultDir), QDir(projectDir), &dirsToBeWatched);
 222
 223     if (newFiles != m_files) {
 224         QSet<QString> addedFiles = newFiles;
 225         QSet<QString> removedFiles = m_files;
 226         QSet<QString> unchanged = newFiles;
 227         unchanged.intersect(m_files);
 228         addedFiles.subtract(unchanged);
 229         removedFiles.subtract(unchanged);
 230
 231         m_files = newFiles;
 232         emit filesChanged(addedFiles, removedFiles);
 233     }
 234
 235     // update watched directories
 236     const QSet<QString> oldDirs = m_dirWatcher.directories().toSet();
 237     const QSet<QString> unwatchDirs = oldDirs - dirsToBeWatched;
 238     const QSet<QString> watchDirs = dirsToBeWatched - oldDirs;
 239
 240     if (!unwatchDirs.isEmpty())
 241         m_dirWatcher.removeDirectories(unwatchDirs.toList());
 242     if (!watchDirs.isEmpty())
 243         m_dirWatcher.addDirectories(watchDirs.toList());
 244 }
 245
 246 bool FileFilterBaseItem::fileMatches(const QString &fileName) const
 247 {
 248     foreach (const QString &suffix, m_fileSuffixes) {
 249         if (fileName.endsWith(suffix, Qt::CaseInsensitive)) {
 250             return true;
 251         }
 252     }
 253
 254     foreach (const QRegExp &filter, m_regExpList) {
 255         if (filter.exactMatch(fileName)) {
 256             return true;
 257         }
 258     }
 259
 260     return false;
 261 }
 262
 263 QSet<QString> FileFilterBaseItem::filesInSubTree(const QDir &rootDir, const QDir &dir, QSet<QString> *parsedDirs)
 264 {
 265     QSet<QString> fileSet;
 266
 267     if (parsedDirs)
 268         parsedDirs->insert(dir.absolutePath());
 269
 270     foreach (const QFileInfo &file, dir.entryInfoList(QDir::Files)) {
 271         const QString fileName = file.fileName();
 272
 273         if (fileMatches(fileName))
 274             fileSet.insert(file.absoluteFilePath());
 275     }
 276
 277     if (recursive()) {
 278         foreach (const QFileInfo &subDir, dir.entryInfoList(QDir::Dirs | QDir::NoDotAndDotDot)) {
 279             fileSet += filesInSubTree(rootDir, QDir(subDir.absoluteFilePath()), parsedDirs);
 280         }
 281     }
 282     return fileSet;
 283 }
 284
 285 QmlFileFilterItem::QmlFileFilterItem(QObject *parent)
 286     : FileFilterBaseItem(parent)
 287 {
 288     setFilter(QLatin1String("*.qml"));
 289 }
 290
 291 JsFileFilterItem::JsFileFilterItem(QObject *parent)
 292     : FileFilterBaseItem(parent)
 293 {
 294     setFilter(QLatin1String("*.js"));
 295 }
 296
 297 void JsFileFilterItem::setFilter(const QString &filter)
 298 {
 299     FileFilterBaseItem::setFilter(filter);
 300     emit filterChanged();
 301 }
 302
 303 ImageFileFilterItem::ImageFileFilterItem(QObject *parent)
 304     : FileFilterBaseItem(parent)
 305 {
 306     QString filter;
 307     // supported image formats according to
 308     QList<QByteArray> extensions = QImageReader::supportedImageFormats();
 309     foreach (const QByteArray &extension, extensions) {
 310         filter.append(QString("*.%1;").arg(QString::fromAscii(extension)));
 311     }
 312     setFilter(filter);
 313 }
 314
 315 void ImageFileFilterItem::setFilter(const QString &filter)
 316 {
 317     FileFilterBaseItem::setFilter(filter);
 318     emit filterChanged();
 319 }
 320
 321 CssFileFilterItem::CssFileFilterItem(QObject *parent)
 322     : FileFilterBaseItem(parent)
 323 {
 324     setFilter(QLatin1String("*.css"));
 325 }
 326
 327 void CssFileFilterItem::setFilter(const QString &filter)
 328 {
 329     FileFilterBaseItem::setFilter(filter);
 330     emit filterChanged();
 331 }
 332
 333 OtherFileFilterItem::OtherFileFilterItem(QObject *parent)
 334     : FileFilterBaseItem(parent)
 335 {
 336 }
 337
 338 void OtherFileFilterItem::setFilter(const QString &filter)
 339 {
 340     FileFilterBaseItem::setFilter(filter);
 341     emit filterChanged();
 342 }
 343
 344 } // namespace QmlProjectManager
 345