host_param_surface.hpp

Go to the documentation of this file.

#pragma once
 
// The StateStore-backed HostParamSurface used by Pulp's format adapters. The
// framework-agnostic HostParamSurface and HostActionSurface contracts live in
// host_surfaces.hpp, which this header re-exports.
 
#include <functional>
#include <optional>
#include <string_view>
 
#include <pulp/dataplane/host_surfaces.hpp>
#include <pulp/runtime/alive_token.hpp>
#include <pulp/state/parameter.hpp>
 
namespace pulp::state {
class StateStore;
}
 
namespace pulp::dataplane {

class StateStoreHostParamSurface : public HostParamSurface {
  public:
    using KeyResolver = std::function<std::optional<state::ParamID>(std::string_view key)>;

    explicit StateStoreHostParamSurface(state::StateStore& store, KeyResolver resolver = {});

    StateStoreHostParamSurface(state::StateStore& store, runtime::AliveToken::Handle owner_alive,
                               KeyResolver resolver = {});
 
  protected:
    bool do_has_param(std::string_view key) override;
    double do_get_param(std::string_view key) override;
    void do_set_param(std::string_view key, double normalized) override;
    void do_begin_gesture(std::string_view key) override;
    void do_end_gesture(std::string_view key) override;
    std::string do_param_display_text(std::string_view key, double normalized) override;
    int do_param_step_count(std::string_view key) override;
 
  private:
    bool owner_is_alive() const;
 
    state::StateStore& store_;
    runtime::AliveToken::Handle owner_alive_;
    KeyResolver resolver_;
};
 
} // namespace pulp::dataplane