src/plugins/analyzerbase/ianalyzerengine.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Author: Nicolas Arnaud-Cormos, KDAB (nicolas.arnaud-cormos@kdab.com)
   8 **
   9 ** Contact: Nokia Corporation (qt-info@nokia.com)
  10 **
  11 ** No Commercial Usage
  12 **
  13 ** This file contains pre-release code and may not be distributed.
  14 ** You may use this file in accordance with the terms and conditions
  15 ** contained in the Technology Preview License Agreement accompanying
  16 ** this package.
  17 **
  18 ** GNU Lesser General Public License Usage
  19 **
  20 ** Alternatively, this file may be used under the terms of the GNU Lesser
  21 ** General Public License version 2.1 as published by the Free Software
  22 ** Foundation and appearing in the file LICENSE.LGPL included in the
  23 ** packaging of this file.  Please review the following information to
  24 ** ensure the GNU Lesser General Public License version 2.1 requirements
  25 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  26 **
  27 ** In addition, as a special exception, Nokia gives you certain additional
  28 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  29 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  30 **
  31 ** If you have questions regarding the use of this file, please contact
  32 ** Nokia at qt-info@nokia.com.
  33 **
  34 **************************************************************************/
  35
  36 #ifndef IANALYZERENGINE_H
  37 #define IANALYZERENGINE_H
  38
  39 #include "analyzerbase_global.h"
  40
  41 #include <projectexplorer/task.h>
  42
  43 #include <QtCore/QObject>
  44 #include <QtCore/QString>
  45
  46 namespace ProjectExplorer {
  47 class RunConfiguration;
  48 }
  49
  50 namespace Analyzer {
  51
  52 class ANALYZER_EXPORT IAnalyzerEngine : public QObject
  53 {
  54     Q_OBJECT
  55 public:
  56     explicit IAnalyzerEngine(ProjectExplorer::RunConfiguration *runConfiguration);
  57
  58     virtual void start() = 0;
  59     /// trigger async stop
  60     virtual void stop() = 0;
  61
  62     ProjectExplorer::RunConfiguration *runConfiguration() const;
  63
  64 signals:
  65     void standardOutputReceived(const QString &);
  66     void standardErrorReceived(const QString &);
  67     void taskToBeAdded(ProjectExplorer::Task::TaskType type, const QString &description,
  68                        const QString &file, int line);
  69     void finished();
  70     void starting(const IAnalyzerEngine *);
  71
  72 private:
  73     ProjectExplorer::RunConfiguration *m_runConfig;
  74 };
  75
  76 } // namespace Analyzer
  77
  78 #endif // IANALYZERENGINE_H