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
  42 const int AircraftRatingRole = Qt::UserRole + 100;
  43 const int AircraftVariantDescriptionRole = Qt::UserRole + 200;
  44 const int AircraftThumbnailRole = Qt::UserRole + 300;
  45
  46 class AircraftScanThread;
  47 class QDataStream;
  48
  49 struct AircraftItem
  50 {
  51     AircraftItem();
  52
  53     AircraftItem(QDir dir, QString filePath);
  54
  55     // the file-name without -set.xml suffix
  56     QString baseName() const;
  57
  58     void fromDataStream(QDataStream& ds);
  59
  60     void toDataStream(QDataStream& ds) const;
  61
  62     QPixmap thumbnail() const;
  63
  64     QString path;
  65     QString description;
  66     QString authors;
  67     int ratings[4];
  68     QString variantOf;
  69     QDateTime pathModTime;
  70
  71     QList<AircraftItem*> variants;
  72 private:
  73     mutable QPixmap m_thumbnail;
  74 };
  75
  76
  77 enum AircraftItemStatus {
  78     PackageNotInstalled,
  79     PackageInstalled,
  80     PackageUpdateAvailable,
  81     PackageDownloading
  82 };
  83
  84 class AircraftItemModel : public QAbstractListModel
  85 {
  86     Q_OBJECT
  87 public:
  88     AircraftItemModel(QObject* pr, simgear::pkg::RootRef& root);
  89
  90     ~AircraftItemModel();
  91
  92     void setPaths(QStringList paths);
  93
  94     void scanDirs();
  95
  96     virtual int rowCount(const QModelIndex& parent) const
  97     {
  98         return m_items.size();
  99     }
 100
 101     virtual QVariant data(const QModelIndex& index, int role) const;
 102
 103     virtual bool setData(const QModelIndex &index, const QVariant &value, int role);
 104
 105     /**
 106      * given a -set.xml path, return the corresponding model index, if one
 107      * exists.
 108      */
 109     QModelIndex indexOfAircraftPath(QString path) const;
 110
 111 private slots:
 112     void onScanResults();
 113
 114     void onScanFinished();
 115
 116 private:
 117     QVariant dataFromItem(const AircraftItem* item, quint32 variantIndex, int role) const;
 118
 119     QVariant dataFromPackage(const simgear::pkg::PackageRef& item,
 120                              quint32 variantIndex, int role) const;
 121
 122     void abandonCurrentScan();
 123
 124     QStringList m_paths;
 125     AircraftScanThread* m_scanThread;
 126     QList<AircraftItem*> m_items;
 127     QList<quint32> m_activeVariant;
 128     simgear::pkg::RootRef m_packageRoot;
 129 };
 130
 131 #endif // of FG_GUI_AIRCRAFT_MODEL