xbmc/platform/Platform.h

   1 /*
   2  *  Copyright (C) 2016-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 "utils/ComponentContainer.h"
  12
  13 //! \brief Base class for services.
  14 class IPlatformService
  15 {
  16 public:
  17   virtual ~IPlatformService() = default;
  18 };
  19
  20 /**\brief Class for the Platform object
  21  *
  22  * Contains methods to retrieve platform specific information
  23  * and methods for doing platform specific environment preparation/initialisation
  24  */
  25 class CPlatform : public CComponentContainer<IPlatformService>
  26 {
  27 public:
  28   /**\brief Creates the Platform object
  29    *
  30    *@return the platform object
  31   */
  32   static CPlatform *CreateInstance();
  33
  34   /**\brief C'tor */
  35   CPlatform() = default;
  36
  37   /**\brief D'tor */
  38   virtual ~CPlatform() = default;
  39
  40   /**\brief Called at an early stage of application startup
  41    *
  42    * This method can be used to do platform specific environment preparation
  43    * or initialisation (like setting environment variables for example)
  44    */
  45   virtual bool InitStageOne() { return true; }
  46
  47   /**\brief Called at a middle stage of application startup
  48    *
  49    * This method can be used for starting platform specific services that
  50    * do not depend on windowing/gui. (eg macos XBMCHelper)
  51    */
  52   virtual bool InitStageTwo() { return true; }
  53
  54   /**\brief Called at a late stage of application startup
  55    *
  56    * This method can be used for starting platform specific Window/GUI related
  57    * services/components. (eg , WS-Discovery Daemons)
  58    */
  59   virtual bool InitStageThree() { return true; }
  60
  61   /**\brief Called at a late stage of application shutdown
  62    *
  63    * This method should be used to cleanup resources allocated in InitStageOne
  64    */
  65   virtual void DeinitStageOne() {}
  66
  67   /**\brief Called at a middle stage of application shutdown
  68    *
  69    * This method should be used to cleanup resources allocated in InitStageTwo
  70    */
  71   virtual void DeinitStageTwo() {}
  72
  73   /**\brief Called at an early stage of application shutdown
  74    *
  75    * This method should be used to cleanup resources allocated in InitStageThree
  76    */
  77   virtual void DeinitStageThree() {}
  78
  79   /**\brief Flag whether disabled add-ons - installed via packagemanager or manually - should be
  80    * offered for configuration and activation on kodi startup for this platform
  81    */
  82   virtual bool IsConfigureAddonsAtStartupEnabled() { return false; }
  83
  84   /**\brief Flag whether this platform supports user installation of binary add-ons.
  85    */
  86   virtual bool SupportsUserInstalledBinaryAddons() { return true; }
  87
  88   /**\brief Print platform specific info to log
  89    *
  90    * Logs platform specific system info during application creation startup
  91    */
  92   virtual void PlatformSyslog() {}
  93
  94   /**\brief Get a platform service instance.
  95    */
  96   template<class T>
  97   std::shared_ptr<T> GetService()
  98   {
  99     return this->GetComponent<T>();
 100   }
 101 };