EpgTagsContainer.h

/*
 *  Copyright (C) 2012-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "XBDateTime.h"

#include <map>
#include <memory>
#include <vector>

namespace PVR
{
class CPVREpgTagsCache;
class CPVREpgChannelData;
class CPVREpgDatabase;
class CPVREpgInfoTag;

class CPVREpgTagsContainer
{
public:
  CPVREpgTagsContainer() = delete;
  CPVREpgTagsContainer(int iEpgID,
                       const std::shared_ptr<CPVREpgChannelData>& channelData,
                       const std::shared_ptr<CPVREpgDatabase>& database);
  virtual ~CPVREpgTagsContainer();

  void SetEpgID(int iEpgID);

  void SetChannelData(const std::shared_ptr<CPVREpgChannelData>& data);

  bool UpdateEntry(const std::shared_ptr<CPVREpgInfoTag>& tag);

  bool DeleteEntry(const std::shared_ptr<CPVREpgInfoTag>& tag);

  bool UpdateEntries(const CPVREpgTagsContainer& tags);

  void Clear();

  void Cleanup(const CDateTime& time);

  bool IsEmpty() const;

  std::shared_ptr<CPVREpgInfoTag> GetTag(const CDateTime& startTime) const;

  std::shared_ptr<CPVREpgInfoTag> GetTag(unsigned int iUniqueBroadcastID) const;

  std::shared_ptr<CPVREpgInfoTag> GetTagByDatabaseID(int iDatabaseID) const;

  std::shared_ptr<CPVREpgInfoTag> GetTagBetween(const CDateTime& start, const CDateTime& end) const;

  bool UpdateActiveTag();

  std::shared_ptr<CPVREpgInfoTag> GetActiveTag() const;

  std::shared_ptr<CPVREpgInfoTag> GetNextStartingTag() const;

  std::shared_ptr<CPVREpgInfoTag> GetLastEndedTag() const;

  std::vector<std::shared_ptr<CPVREpgInfoTag>> GetTimeline(const CDateTime& timelineStart,
                                                           const CDateTime& timelineEnd,
                                                           const CDateTime& minEventEnd,
                                                           const CDateTime& maxEventStart) const;

  std::vector<std::shared_ptr<CPVREpgInfoTag>> GetAllTags() const;

  std::pair<CDateTime, CDateTime> GetFirstAndLastUncommitedEPGDate() const;

  bool NeedsSave() const;

  void QueuePersistQuery();

  void QueueDelete();

private:
  std::vector<std::shared_ptr<CPVREpgInfoTag>> CreateEntries(
      const std::vector<std::shared_ptr<CPVREpgInfoTag>>& tags) const;

  std::shared_ptr<CPVREpgInfoTag> CreateEntry(const std::shared_ptr<CPVREpgInfoTag>& tag) const;

  std::shared_ptr<CPVREpgInfoTag> CreateGapTag(const CDateTime& start, const CDateTime& end) const;

  void MergeTags(const CDateTime& minEventEnd,
                 const CDateTime& maxEventStart,
                 std::vector<std::shared_ptr<CPVREpgInfoTag>>& tags) const;

  void FixOverlappingEvents(std::vector<std::shared_ptr<CPVREpgInfoTag>>& tags) const;
  void FixOverlappingEvents(std::map<CDateTime, std::shared_ptr<CPVREpgInfoTag>>& tags) const;

  int m_iEpgID = 0;
  std::shared_ptr<CPVREpgChannelData> m_channelData;
  const std::shared_ptr<CPVREpgDatabase> m_database;
  const std::unique_ptr<CPVREpgTagsCache> m_tagsCache;

  std::map<CDateTime, std::shared_ptr<CPVREpgInfoTag>> m_changedTags;
  std::map<CDateTime, std::shared_ptr<CPVREpgInfoTag>> m_deletedTags;
};

} // namespace PVR