ground/gcs/src/libs/utils/filesearch.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       filesearch.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @brief
   8  * @see        The GNU Public License (GPL) Version 3
   9  * @defgroup
  10  * @{
  11  *
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef FILESEARCH_H
  30 #define FILESEARCH_H
  31
  32 #include "utils_global.h"
  33
  34 #include <QtCore/QStringList>
  35 #include <QtCore/QFuture>
  36 #include <QtCore/QMap>
  37 #include <QTextDocument>
  38
  39 namespace Utils {
  40 class QTCREATOR_UTILS_EXPORT FileSearchResult {
  41 public:
  42     FileSearchResult() {}
  43     FileSearchResult(QString fileName, int lineNumber, QString matchingLine, int matchStart, int matchLength)
  44         : fileName(fileName), lineNumber(lineNumber), matchingLine(matchingLine), matchStart(matchStart), matchLength(matchLength)
  45     {}
  46     QString fileName;
  47     int lineNumber;
  48     QString matchingLine;
  49     int matchStart;
  50     int matchLength;
  51 };
  52
  53 QTCREATOR_UTILS_EXPORT QFuture<FileSearchResult> findInFiles(const QString &searchTerm, const QStringList &files,
  54                                                              QTextDocument::FindFlags flags, QMap<QString, QString> fileToContentsMap = QMap<QString, QString>());
  55
  56 QTCREATOR_UTILS_EXPORT QFuture<FileSearchResult> findInFilesRegExp(const QString &searchTerm, const QStringList &files,
  57                                                                    QTextDocument::FindFlags flags, QMap<QString, QString> fileToContentsMap = QMap<QString, QString>());
  58 } // namespace Utils
  59
  60 #endif // FILESEARCH_H