///
/// HybridViewModelSpec.hpp
/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
/// https://github.com/mrousavy/nitro
/// Copyright © Marc Rousavy @ Margelo
///

#pragma once

#if __has_include(<NitroModules/HybridObject.hpp>)
#include <NitroModules/HybridObject.hpp>
#else
#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
#endif

// Forward declaration of `HybridViewModelInstanceSpec` to properly resolve imports.
namespace margelo::nitro::rive { class HybridViewModelInstanceSpec; }

#include <string>
#include <NitroModules/Promise.hpp>
#include <memory>
#include "HybridViewModelInstanceSpec.hpp"
#include <optional>

namespace margelo::nitro::rive {

  using namespace margelo::nitro;

  /**
   * An abstract base class for `ViewModel`
   * Inherit this class to create instances of `HybridViewModelSpec` in C++.
   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
   * @example
   * ```cpp
   * class HybridViewModel: public HybridViewModelSpec {
   * public:
   *   HybridViewModel(...): HybridObject(TAG) { ... }
   *   // ...
   * };
   * ```
   */
  class HybridViewModelSpec: public virtual HybridObject {
    public:
      // Constructor
      explicit HybridViewModelSpec(): HybridObject(TAG) { }

      // Destructor
      ~HybridViewModelSpec() override = default;

    public:
      // Properties
      virtual double getPropertyCount() = 0;
      virtual double getInstanceCount() = 0;
      virtual std::string getModelName() = 0;

    public:
      // Methods
      virtual std::shared_ptr<Promise<double>> getPropertyCountAsync() = 0;
      virtual std::shared_ptr<Promise<double>> getInstanceCountAsync() = 0;
      virtual std::optional<std::shared_ptr<HybridViewModelInstanceSpec>> createInstanceByIndex(double index) = 0;
      virtual std::optional<std::shared_ptr<HybridViewModelInstanceSpec>> createInstanceByName(const std::string& name) = 0;
      virtual std::optional<std::shared_ptr<HybridViewModelInstanceSpec>> createDefaultInstance() = 0;
      virtual std::optional<std::shared_ptr<HybridViewModelInstanceSpec>> createInstance() = 0;
      virtual std::shared_ptr<Promise<std::optional<std::shared_ptr<HybridViewModelInstanceSpec>>>> createInstanceByNameAsync(const std::string& name) = 0;
      virtual std::shared_ptr<Promise<std::optional<std::shared_ptr<HybridViewModelInstanceSpec>>>> createDefaultInstanceAsync() = 0;
      virtual std::shared_ptr<Promise<std::optional<std::shared_ptr<HybridViewModelInstanceSpec>>>> createBlankInstanceAsync() = 0;

    protected:
      // Hybrid Setup
      void loadHybridMethods() override;

    protected:
      // Tag for logging
      static constexpr auto TAG = "ViewModel";
  };

} // namespace margelo::nitro::rive
