src/plugins/projectexplorer/task.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 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef PROJECTEXPLORER_TASK_H
  35 #define PROJECTEXPLORER_TASK_H
  36
  37 #include "projectexplorer_export.h"
  38
  39 #include <QtCore/QMetaType>
  40
  41 #include <QtGui/QTextLayout>
  42
  43 namespace ProjectExplorer {
  44
  45 // Build issue (warning or error).
  46 class PROJECTEXPLORER_EXPORT Task
  47 {
  48 public:
  49     enum TaskType {
  50         Unknown,
  51         Error,
  52         Warning
  53     };
  54
  55     Task();
  56     Task(TaskType type_, const QString &description_,
  57          const QString &file_, int line_, const QString &category_);
  58
  59     bool isNull() const;
  60
  61     unsigned int taskId;
  62     TaskType type;
  63     QString description;
  64     QString file;
  65     int line;
  66     QString category;
  67     // Having a QList<QTextLayout::FormatRange> in Task isn't that great
  68     // It would be cleaner to split up the text into
  69     // the logical hunks and then assemble them again
  70     // (That is different consumers of tasks could show them in
  71     // different ways!)
  72     // But then again, the wording of the text most likely
  73     // doesn't work if you split it up, nor are our parsers
  74     // anywhere near being that good
  75     QList<QTextLayout::FormatRange> formats;
  76 private:
  77     static unsigned int s_nextId;
  78 };
  79
  80 bool operator==(const Task &t1, const Task &t2);
  81 uint qHash(const Task &task);
  82
  83 } //namespace ProjectExplorer
  84
  85 Q_DECLARE_METATYPE(ProjectExplorer::Task)
  86 Q_DECLARE_METATYPE(QList<ProjectExplorer::Task>)
  87
  88 #endif // PROJECTEXPLORER_TASK_H