AddonDll.h

/*
 *  Copyright (C) 2005-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 "addons/Addon.h"
#include "addons/kodi-dev-kit/include/kodi/c-api/addon_base.h"

#include <map>
#include <memory>
#include <string>

class DllAddon;

namespace ADDON
{

class CBinaryAddonBase;
using BinaryAddonBasePtr = std::shared_ptr<CBinaryAddonBase>;

using ADDON_INSTANCE_HANDLER = void*;

class CAddonDllInformer
{
public:
  virtual ~CAddonDllInformer() = default;

  virtual bool IsInUse(const std::string& id) = 0;
};

class CAddonDll : public CAddon
{
public:
  CAddonDll(const AddonInfoPtr& addonInfo, BinaryAddonBasePtr addonBase);
  CAddonDll(const AddonInfoPtr& addonInfo, AddonType addonType);
  ~CAddonDll() override;

  // Implementation of IAddon via CAddon
  std::string LibPath() const override;

  // addon settings
  bool SaveSettings(AddonInstanceId id = ADDON_SETTINGS_ID) override;

  bool DllLoaded(void) const;

  CAddonVersion GetTypeVersionDll(int type) const;

  CAddonVersion GetTypeMinVersionDll(int type) const;

  ADDON_STATUS CreateInstance(KODI_ADDON_INSTANCE_STRUCT* instance);

  void DestroyInstance(KODI_ADDON_INSTANCE_STRUCT* instance);

  bool IsInUse() const override;
  void RegisterInformer(CAddonDllInformer* informer);
  AddonPtr GetRunningInstance() const override;

  void OnPreInstall() override;
  void OnPostInstall(bool update, bool modal) override;
  void OnPreUnInstall() override;
  void OnPostUnInstall() override;

  bool Initialized() const { return m_initialized; }

protected:
  static std::string GetDllPath(const std::string& strFileName);

  std::string m_parentLib;

private:
  ADDON_STATUS Create(KODI_ADDON_INSTANCE_STRUCT* firstKodiInstance);

  void Destroy();

  bool CheckAPIVersion(int type);

  BinaryAddonBasePtr m_binaryAddonBase = nullptr;
  DllAddon* m_pDll = nullptr;
  bool m_initialized = false;
  bool LoadDll();
  std::map<ADDON_INSTANCE_HANDLER, KODI_ADDON_INSTANCE_STRUCT*> m_usedInstances;
  CAddonDllInformer* m_informer = nullptr;

  virtual ADDON_STATUS TransferSettings(AddonInstanceId instanceId);

  AddonGlobalInterface m_interface = {};
};

} /* namespace ADDON */