src/GUI/AircraftModel.hxx

   1 // AircraftModel.hxx - part of GUI launcher using Qt5
   2 //
   3 // Written by James Turner, started March 2015.
   4 //
   5 // Copyright (C) 2015 James Turner <zakalawe@mac.com>
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifndef FG_GUI_AIRCRAFT_MODEL
  22 #define FG_GUI_AIRCRAFT_MODEL
  23
  24 #include <QAbstractListModel>
  25 #include <QDateTime>
  26 #include <QDir>
  27 #include <QPixmap>
  28 #include <QStringList>
  29
  30 #include <simgear/package/Root.hxx>
  31
  32 const int AircraftPathRole = Qt::UserRole + 1;
  33 const int AircraftAuthorsRole = Qt::UserRole + 2;
  34 const int AircraftVariantRole = Qt::UserRole + 3;
  35 const int AircraftVariantCountRole = Qt::UserRole + 4;
  36 const int AircraftThumbnailCountRole = Qt::UserRole + 5;
  37 const int AircraftPackageIdRole = Qt::UserRole + 6;
  38 const int AircraftPackageStatusRole = Qt::UserRole + 7;
  39 const int AircraftPackageProgressRole = Qt::UserRole + 8;
  40 const int AircraftLongDescriptionRole = Qt::UserRole + 9;
  41 const int AircraftHasRatingsRole = Qt::UserRole + 10;
  42
  43 const int AircraftRatingRole = Qt::UserRole + 100;
  44 const int AircraftVariantDescriptionRole = Qt::UserRole + 200;
  45 const int AircraftThumbnailRole = Qt::UserRole + 300;
  46
  47 class AircraftScanThread;
  48 class QDataStream;
  49
  50 struct AircraftItem
  51 {
  52     AircraftItem();
  53
  54     AircraftItem(QDir dir, QString filePath);
  55
  56     // the file-name without -set.xml suffix
  57     QString baseName() const;
  58
  59     void fromDataStream(QDataStream& ds);
  60
  61     void toDataStream(QDataStream& ds) const;
  62
  63     QPixmap thumbnail() const;
  64
  65     bool excluded;
  66     QString path;
  67     QString description;
  68     QString authors;
  69     int ratings[4];
  70     QString variantOf;
  71     QDateTime pathModTime;
  72
  73     QList<AircraftItem*> variants;
  74 private:
  75     mutable QPixmap m_thumbnail;
  76 };
  77
  78
  79 enum AircraftItemStatus {
  80     PackageNotInstalled,
  81     PackageInstalled,
  82     PackageUpdateAvailable,
  83     PackageDownloading
  84 };
  85
  86 class AircraftItemModel : public QAbstractListModel
  87 {
  88     Q_OBJECT
  89 public:
  90     AircraftItemModel(QObject* pr, simgear::pkg::RootRef& root);
  91
  92     ~AircraftItemModel();
  93
  94     void setPaths(QStringList paths);
  95
  96     void scanDirs();
  97
  98     virtual int rowCount(const QModelIndex& parent) const
  99     {
 100         return m_items.size();
 101     }
 102
 103     virtual QVariant data(const QModelIndex& index, int role) const;
 104
 105     virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
 106
 107     /**
 108      * given a -set.xml path, return the corresponding model index, if one
 109      * exists.
 110      */
 111     QModelIndex indexOfAircraftPath(QString path) const;
 112
 113 private slots:
 114     void onScanResults();
 115
 116     void onScanFinished();
 117
 118 private:
 119     QVariant dataFromItem(const AircraftItem* item, quint32 variantIndex, int role) const;
 120
 121     QVariant dataFromPackage(const simgear::pkg::PackageRef& item,
 122                              quint32 variantIndex, int role) const;
 123
 124     void abandonCurrentScan();
 125
 126     QStringList m_paths;
 127     AircraftScanThread* m_scanThread;
 128     QList<AircraftItem*> m_items;
 129     QList<quint32> m_activeVariant;
 130     simgear::pkg::RootRef m_packageRoot;
 131 };
 132
 133 #endif // of FG_GUI_AIRCRAFT_MODEL