xbmc/utils/FileExtensionProvider.h

   1 /*
   2  *  Copyright (C) 2012-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include <map>
  12 #include <memory>
  13 #include <string>
  14 #include <vector>
  15
  16 namespace ADDON
  17 {
  18 enum class AddonType;
  19 class CAddonMgr;
  20 struct AddonEvent;
  21 }
  22
  23 class CAdvancedSettings;
  24
  25 class CFileExtensionProvider
  26 {
  27 public:
  28   CFileExtensionProvider(ADDON::CAddonMgr& addonManager);
  29   ~CFileExtensionProvider();
  30
  31   /*!
  32    * @brief Returns a list of picture extensions
  33    */
  34   std::string GetPictureExtensions() const;
  35
  36   /*!
  37    * @brief Returns a list of music extensions
  38    */
  39   std::string GetMusicExtensions() const;
  40
  41   /*!
  42    * @brief Returns a list of video extensions
  43    */
  44   std::string GetVideoExtensions() const;
  45
  46   /*!
  47    * @brief Returns a list of subtitle extensions
  48    */
  49   std::string GetSubtitleExtensions() const;
  50
  51   /*!
  52    * @brief Returns a list of disc stub extensions
  53    */
  54   std::string GetDiscStubExtensions() const;
  55
  56   /*!
  57    * @brief Returns a file folder extensions
  58    */
  59   std::string GetFileFolderExtensions() const;
  60
  61   /*!
  62    * @brief Returns whether a url protocol from add-ons use encoded hostnames
  63    */
  64   bool EncodedHostName(const std::string& protocol) const;
  65
  66   /*!
  67    * @brief Returns true if related provider can operate related file
  68    *
  69    * @note Thought for cases e.g. by ISO, where can be a video or also a SACD.
  70    */
  71   bool CanOperateExtension(const std::string& path) const;
  72
  73 private:
  74   std::string GetAddonExtensions(ADDON::AddonType type) const;
  75   std::string GetAddonFileFolderExtensions(ADDON::AddonType type) const;
  76   void SetAddonExtensions();
  77   void SetAddonExtensions(ADDON::AddonType type);
  78
  79   void OnAddonEvent(const ADDON::AddonEvent& event);
  80
  81   // Construction properties
  82   std::shared_ptr<CAdvancedSettings> m_advancedSettings;
  83   ADDON::CAddonMgr &m_addonManager;
  84
  85   // File extension properties
  86   std::map<ADDON::AddonType, std::string> m_addonExtensions;
  87   std::map<ADDON::AddonType, std::string> m_addonFileFolderExtensions;
  88
  89   // Protocols from add-ons with encoded host names
  90   std::vector<std::string> m_encoded;
  91 };