xbmc/addons/IAddonSupportCheck.h

   1 /*
   2  *  Copyright (C) 2005-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 <string>
  12
  13 namespace KODI
  14 {
  15 namespace ADDONS
  16 {
  17
  18 /*!
  19  * @brief Parent class to ask addons for support.
  20  *
  21  * This one can be used as a parent on the respective Kodi-sided addon class,
  22  * this makes it easier to query for the desired support without using the
  23  * class's own function definition.
  24  */
  25 class IAddonSupportCheck
  26 {
  27 public:
  28   IAddonSupportCheck() = default;
  29   virtual ~IAddonSupportCheck() = default;
  30
  31   /*!
  32    * @brief Function to query the respective add-ons used for the support of
  33    * the desired file.
  34    *
  35    * @param[in] filename File which is queried for addon support
  36    * @return True if addon supports the desired file, false if not
  37    *
  38    * @note Is set here with true as default and not with "= 0" in order to have
  39    * class expandable and perhaps to be able to insert other query functions in
  40    * the future.
  41    */
  42   virtual bool SupportsFile(const std::string& filename) { return true; }
  43 };
  44
  45 } /* namespace ADDONS */
  46 } /* namespace KODI */