guidegrid.h

Go to the documentation of this file.

// -*- Mode: c++ -*-
#ifndef GUIDEGRID_H_
#define GUIDEGRID_H_
 
// C++
#include <list>
#include <utility>
#include <vector>
 
// Qt
#include <QString>
#include <QDateTime>
#include <QEvent>
 
// MythTV
#include "libmythbase/mthreadpool.h"
#include "libmythbase/programinfo.h"
#include "libmythtv/channelgroup.h"
#include "libmythtv/channelutil.h"
#include "libmythtv/tv_play.h"
#include "libmythui/mythscreentype.h"
#include "libmythui/mythuiguidegrid.h"
 
// MythFrontend
#include "schedulecommon.h"
 
class ProgramInfo;
class QTimer;
class MythUIButtonList;
class MythUIGuideGrid;
 
using db_chan_list_t = std::vector<ChannelInfo>  ;
using db_chan_list_list_t = std::vector<db_chan_list_t>;
using ProgInfoGuideArray = std::array<std::array<ProgramInfo *,MAX_DISPLAY_TIMES>,MAX_DISPLAY_CHANS>;
 
class JumpToChannel;
class JumpToChannelListener
{
  public:
    virtual ~JumpToChannelListener() = default;
    virtual void GoTo(int start, int cur_row) = 0;
    virtual void SetJumpToChannel(JumpToChannel *ptr) = 0;
    virtual int  FindChannel(uint chanid, const QString &channum,
                             bool exact = true) const = 0;
};
 
class JumpToChannel : public QObject
{
    Q_OBJECT
 
  public:
    JumpToChannel(
        JumpToChannelListener *parent, QString start_entry,
        int start_chan_idx, int cur_chan_idx, uint rows_disp);
 
    bool ProcessEntry(const QStringList &actions, const QKeyEvent *e);
 
    QString GetEntry(void) const { return m_entry; }
 
  public slots:
    virtual void deleteLater(void);
 
  private:
    ~JumpToChannel() override = default;
    bool Update(void);
 
  private:
    JumpToChannelListener *m_listener {nullptr};
    QString  m_entry;
    int      m_previousStartChannelIndex;
    int      m_previousCurrentChannelIndex;
    uint     m_rowsDisplayed;
    QTimer  *m_timer                  {nullptr}; // audited ref #5318
 
    static const uint kJumpToChannelTimeout = 3500; // ms
};
 
// GuideUIElement encapsulates the arguments to
// MythUIGuideGrid::SetProgramInfo().  The elements are prepared in a
// background thread and then sent via an event to the UI thread for
// rendering.
class GuideUIElement {
public:
    GuideUIElement(int row, int col, const QRect area,
                   QString title, QString category,
                   int arrow, int recType, int recStat, bool selected)
        : m_row(row), m_col(col), m_area(area), m_title(std::move(title)),
          m_category(std::move(category)), m_arrow(arrow), m_recType(recType),
          m_recStat(recStat), m_selected(selected) {}
    const int m_row;
    const int m_col;
    const QRect m_area;
    const QString m_title;
    const QString m_category;
    const int m_arrow;
    const int m_recType;
    const int m_recStat;
    const bool m_selected;
};
 
class GuideGrid : public ScheduleCommon, public JumpToChannelListener
{
    Q_OBJECT;
 
  public:
    // Use this function to instantiate a guidegrid instance.
    static void RunProgramGuide(uint           startChanId,
                                const QString &startChanNum,
                                const QDateTime &startTime,
                                TV            *player = nullptr,
                                bool           embedVideo = false,
                                bool           allowFinder = true,
                                int            changrpid = -1);
 
    ChannelInfoList GetSelection(void) const;
 
    void GoTo(int start, int cur_row) override; // JumpToChannelListener
    void SetJumpToChannel(JumpToChannel *ptr) override; // JumpToChannelListener
 
    bool Create(void) override; // MythScreenType
    void Load(void) override; // MythScreenType
    void Init(void) override; // MythScreenType
    bool keyPressEvent(QKeyEvent *event) override; // MythScreenType
    bool gestureEvent(MythGestureEvent *event) override; // MythScreenType
 
    void aboutToShow() override; // MythScreenType
    void aboutToHide() override; // MythScreenType
    // Allow class GuideUpdateProgramRow to figure out whether the
    // current start time/channel coordinates are the same, so that it can
    // skip the work if not.
    uint GetCurrentStartChannel(void) const { return m_currentStartChannel; }
    QDateTime GetCurrentStartTime(void) const { return m_currentStartTime; }
 
  public slots:
    void PlayerExiting(TV* Player);
 
  signals:
    void ChangeVolume(bool Up, int NewVolume = -1);
    void ToggleMute(bool CycleChannels);
 
  protected slots:
    void cursorLeft();
    void cursorRight();
    void cursorDown();
    void cursorUp();
 
    void toggleGuideListing();
    void toggleChannelFavorite(int grpid = -1);
    void ChannelGroupMenu(int mode = 0);
    void generateListings();
 
    void enter();
 
    void showProgFinder();
    void channelUpdate();
 
    void deleteRule();
 
    void Close() override; // MythScreenType
    void customEvent(QEvent *event) override; // ScheduleCommon
 
  protected:
    GuideGrid(MythScreenStack *parentStack,
              uint chanid, QString channum,
              const QDateTime &startTime,
              TV *player = nullptr,
              bool embedVideo = false,
              bool allowFinder = true,
              int changrpid = -1);
   ~GuideGrid() override;
    ProgramInfo *GetCurrentProgram(void) const override // ScheduleCommon
        //cppcheck-suppress CastIntegerToAddressAtReturn
        { return m_programInfos[m_currentRow][m_currentCol]; };
 
  private slots:
    void updateTimeout(void);
    void updateInfo(void);
    void updateChannels(void);
    void updateJumpToChannel(void);
 
  private:
 
    Q_DISABLE_COPY(GuideGrid);
 
    enum MoveVector : std::uint8_t {
        kScrollUp,
        kScrollDown,
        kScrollLeft,
        kScrollRight,
        kPageUp,
        kPageDown,
        kPageLeft,
        kPageRight,
        kDayLeft,
        kDayRight,
    };
 
    void moveLeftRight(MoveVector movement);
    void moveUpDown(MoveVector movement);
    void moveToTime(const QDateTime& datetime);
 
    void ShowMenu(void) override; // MythScreenType
    void ShowRecordingMenu(void);
    void ShowJumpToTime(void);
 
    int  FindChannel(uint chanid, const QString &channum,
                     bool exact = true) const override; // JumpToChannelListener
 
    void fillChannelInfos(bool gotostartchannel = true);
    void fillTimeInfos(void);
    void fillProgramInfos(bool useExistingData = false);
    // Set row=-1 to fill all rows.
    void fillProgramRowInfos(int row, bool useExistingData);
public:
    // These need to be public so that the helper classes can operate.
    ProgramList *getProgramListFromProgram(int chanNum);
    void updateProgramsUI(unsigned int firstRow, unsigned int numRows,
                          int progPast,
                          const QVector<ProgramList*> &proglists,
                          const ProgInfoGuideArray &programInfos,
                          const std::list<GuideUIElement> &elements);
    void updateChannelsNonUI(QVector<ChannelInfo *> &chinfos,
                             QVector<bool> &unavailables);
    void updateChannelsUI(const QVector<ChannelInfo *> &chinfos,
                          const QVector<bool> &unavailables);
private:
 
    void setStartChannel(int newStartChannel);
 
    ChannelInfo       *GetChannelInfo(uint chan_idx, int sel = -1);
    const ChannelInfo *GetChannelInfo(uint chan_idx, int sel = -1) const;
    uint                 GetChannelCount(void) const;
    int                  GetStartChannelOffset(int row = -1) const;
 
    ProgramList GetProgramList(uint chanid) const;
    uint GetAlternateChannelIndex(uint chan_idx, bool with_same_channum) const;
    void updateDateText(void);
 
  private:
    std::chrono::minutes  m_selectRecThreshold {16min};
 
    bool  m_allowFinder             {false};
    db_chan_list_list_t m_channelInfos;
    QMap<uint,uint>      m_channelInfoIdx;
 
    std::vector<ProgramList*> m_programs;
    ProgInfoGuideArray m_programInfos {};
    ProgramList  m_recList;
 
    QDateTime m_originalStartTime;
    QDateTime m_currentStartTime;
    QDateTime m_currentEndTime;
    uint      m_currentStartChannel       {0};
    uint      m_startChanID;
    QString   m_startChanNum;
 
    int       m_currentRow                {0};
    int       m_currentCol                {0};
 
    bool      m_sortReverse               {false};
 
    int       m_channelCount              {5};
    int       m_timeCount                 {30};
    bool      m_verticalLayout            {false};
 
    QDateTime m_firstTime;
    QDateTime m_lastTime;
 
    TV     *m_player                      {nullptr};
    bool    m_embedVideo                  {false};
    void    EmbedTVWindow(void);
    static void    HideTVWindow(void);
    QRect   m_videoRect;
 
    QString m_channelOrdering;
 
    QTimer *m_updateTimer                 {nullptr}; // audited ref #5318
 
    MThreadPool       m_threadPool;
 
    int               m_changrpid {-1};
    ChannelGroupList  m_changrplist;
    ChannelGroupList  m_channelGroupListManual;
 
    QRecursiveMutex   m_jumpToChannelLock;
    JumpToChannel    *m_jumpToChannel     {nullptr};
 
    MythUIButtonList *m_timeList          {nullptr};
    MythUIButtonList *m_channelList       {nullptr};
    MythUIGuideGrid  *m_guideGrid         {nullptr};
    MythUIText       *m_dateText          {nullptr};
    MythUIText       *m_longdateText      {nullptr};
    MythUIText       *m_jumpToText        {nullptr};
    MythUIText       *m_changroupname     {nullptr};
    MythUIImage      *m_channelImage      {nullptr};
};
 
#endif