feature_hint_manager.h

Go to the documentation of this file.

#ifndef YAZE_APP_EDITOR_SHELL_FEEDBACK_FEATURE_HINT_MANAGER_H_
#define YAZE_APP_EDITOR_SHELL_FEEDBACK_FEATURE_HINT_MANAGER_H_
 
#include <functional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <utility>
 
#include "app/editor/shell/feedback/toast_manager.h"
 
namespace yaze {
namespace editor {
 
class UserSettings;
 
namespace FeatureHintId {
constexpr const char* kZScreamWelcome = "zscream.welcome";
constexpr const char* kZScreamOverworld = "zscream.overworld";
constexpr const char* kZScreamDungeon = "zscream.dungeon";
constexpr const char* kZScreamProjects = "zscream.projects";
constexpr const char* kZScreamSave = "zscream.save";
constexpr const char* kZScreamTile16 = "zscream.tile16";
constexpr const char* kZScreamZso = "zscream.zso";
constexpr const char* kZScreamScreenMap = "zscream.screen_map";
}  // namespace FeatureHintId
 
struct FeatureHintDefinition {
  const char* id = nullptr;
  const char* message = nullptr;
  ToastType type = ToastType::kInfo;
  float ttl_seconds = 8.0f;
  bool offer_guide = false;
};
 
class FeatureHintManager {
 public:
  void SetUserSettings(UserSettings* settings) { user_settings_ = settings; }
  void SetToastManager(ToastManager* toast_manager) {
    toast_manager_ = toast_manager;
  }
  void SetGuideCallback(std::function<void()> callback) {
    guide_callback_ = std::move(callback);
  }
 
  void RegisterBuiltinHints();
 
  void RegisterHint(FeatureHintDefinition definition);
 
  bool MaybeShow(std::string_view id);
 
  void Dismiss(std::string_view id);
 
  bool IsDismissed(std::string_view id) const;
  bool IsEnabled() const;
  void SetEnabled(bool enabled);
 
  void ResetDismissed();
 
  size_t registered_count() const { return catalog_.size(); }
  size_t dismissed_count() const;
 
 private:
  void Persist();
 
  UserSettings* user_settings_ = nullptr;
  ToastManager* toast_manager_ = nullptr;
  std::function<void()> guide_callback_;
  std::unordered_map<std::string, FeatureHintDefinition> catalog_;
};
 
}  // namespace editor
}  // namespace yaze
 
#endif  // YAZE_APP_EDITOR_SHELL_FEEDBACK_FEATURE_HINT_MANAGER_H_