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 #include <QSharedPointer>
  30 #include <QUrl>
  31
  32 #include <simgear/package/Root.hxx>
  33
  34 const int AircraftPathRole = Qt::UserRole + 1;
  35 const int AircraftAuthorsRole = Qt::UserRole + 2;
  36 const int AircraftVariantRole = Qt::UserRole + 3;
  37 const int AircraftVariantCountRole = Qt::UserRole + 4;
  38 const int AircraftThumbnailCountRole = Qt::UserRole + 5;
  39 const int AircraftPackageIdRole = Qt::UserRole + 6;
  40 const int AircraftPackageStatusRole = Qt::UserRole + 7;
  41 const int AircraftPackageProgressRole = Qt::UserRole + 8;
  42 const int AircraftLongDescriptionRole = Qt::UserRole + 9;
  43 const int AircraftHasRatingsRole = Qt::UserRole + 10;
  44 const int AircraftInstallPercentRole = Qt::UserRole + 11;
  45 const int AircraftPackageSizeRole = Qt::UserRole + 12;
  46 const int AircraftInstallDownloadedSizeRole = Qt::UserRole + 13;
  47 const int AircraftURIRole = Qt::UserRole + 14;
  48 const int AircraftThumbnailSizeRole = Qt::UserRole + 15;
  49
  50 const int AircraftRatingRole = Qt::UserRole + 100;
  51 const int AircraftVariantDescriptionRole = Qt::UserRole + 200;
  52 const int AircraftThumbnailRole = Qt::UserRole + 300;
  53
  54 class AircraftScanThread;
  55 class QDataStream;
  56 class PackageDelegate;
  57 struct AircraftItem;
  58 typedef QSharedPointer<AircraftItem> AircraftItemPtr;
  59
  60 struct AircraftItem
  61 {
  62     AircraftItem();
  63
  64     AircraftItem(QDir dir, QString filePath);
  65
  66     // the file-name without -set.xml suffix
  67     QString baseName() const;
  68
  69     void fromDataStream(QDataStream& ds);
  70
  71     void toDataStream(QDataStream& ds) const;
  72
  73     QPixmap thumbnail() const;
  74
  75     bool excluded;
  76     QString path;
  77     QString description;
  78     QString authors;
  79     int ratings[4];
  80     QString variantOf;
  81     QDateTime pathModTime;
  82
  83     QList<AircraftItemPtr> variants;
  84 private:
  85     mutable QPixmap m_thumbnail;
  86 };
  87
  88
  89 enum AircraftItemStatus {
  90     PackageNotInstalled = 0,
  91     PackageInstalled,
  92     PackageUpdateAvailable,
  93     PackageQueued,
  94     PackageDownloading
  95 };
  96
  97 class AircraftItemModel : public QAbstractListModel
  98 {
  99     Q_OBJECT
 100 public:
 101     AircraftItemModel(QObject* pr, const simgear::pkg::RootRef& root);
 102
 103     ~AircraftItemModel();
 104
 105     void setPaths(QStringList paths);
 106
 107     void scanDirs();
 108
 109     virtual int rowCount(const QModelIndex& parent) const;
 110
 111     virtual QVariant data(const QModelIndex& index, int role) const;
 112
 113     virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
 114
 115     /**
 116      * given a -set.xml path, return the corresponding model index, if one
 117      * exists.
 118      */
 119   //  QModelIndex indexOfAircraftPath(QString path) const;
 120
 121     QModelIndex indexOfAircraftURI(QUrl uri) const;
 122
 123     /**
 124      * return if a given aircraft is ready to be run, or not. Aircraft which
 125      * are not installed, or are downloading, are not runnable.
 126      */
 127     bool isIndexRunnable(const QModelIndex& index) const;
 128
 129 signals:
 130     void aircraftInstallFailed(QModelIndex index, QString errorMessage);
 131
 132     void aircraftInstallCompleted(QModelIndex index);
 133
 134 private slots:
 135     void onScanResults();
 136
 137     void onScanFinished();
 138
 139 private:
 140     friend class PackageDelegate;
 141
 142     QVariant dataFromItem(AircraftItemPtr item, quint32 variantIndex, int role) const;
 143
 144     QVariant dataFromPackage(const simgear::pkg::PackageRef& item,
 145                              quint32 variantIndex, int role) const;
 146
 147     QVariant packageThumbnail(simgear::pkg::PackageRef p, int index, bool download = true) const;
 148
 149     void abandonCurrentScan();
 150     void refreshPackages();
 151
 152     void installSucceeded(QModelIndex index);
 153     void installFailed(QModelIndex index, simgear::pkg::Delegate::StatusCode reason);
 154
 155     QStringList m_paths;
 156     AircraftScanThread* m_scanThread;
 157     QVector<AircraftItemPtr> m_items;
 158     PackageDelegate* m_delegate;
 159
 160     QVector<quint32> m_activeVariant;
 161     QVector<quint32> m_packageVariant;
 162
 163     simgear::pkg::RootRef m_packageRoot;
 164     simgear::pkg::PackageList m_packages;
 165
 166     mutable QHash<QString, QPixmap> m_thumbnailPixmapCache;
 167 };
 168
 169 #endif // of FG_GUI_AIRCRAFT_MODEL