event.h

Go to the documentation of this file.

#pragma once
 
#include <cstring>
#include <limits>
#include <string>
 
#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"
#include "esphome/core/helpers.h"
#include "esphome/core/string_ref.h"
 
namespace esphome::event {
 
using EventTypes = ConstVector<const char *, true>;
 
#define LOG_EVENT(prefix, type, obj) \
  if (log_entity_header(TAG, prefix, LOG_STR_LITERAL(type), (obj))) { \
    LOG_ENTITY_ICON(TAG, prefix, *(obj)); \
    LOG_ENTITY_DEVICE_CLASS(TAG, prefix, *(obj)); \
  }
 
class Event : public EntityBase {
 public:
  void trigger(const char *event_type);
  void trigger(const std::string &event_type) { this->trigger(event_type.c_str()); }
 
  void set_event_types_static(const char *const *event_types, size_t count) {
    this->types_.assign_static(event_types, count);
    this->last_event_type_ = nullptr;
  }
  void set_event_types(std::initializer_list<const char *> event_types) {
    this->set_event_types_copy_(event_types.begin(), event_types.size());
  }
  void set_event_types(const EventTypes &event_types) {
    this->set_event_types_copy_(event_types.data(), event_types.size());
  }
  void set_event_types(const FixedVector<const char *> &event_types) {
    this->set_event_types_copy_(event_types.begin(), event_types.size());
  }
 
  // Deleted overloads to catch incorrect std::string usage at compile time with clear error messages
  void set_event_types(std::initializer_list<std::string> event_types) = delete;
  void set_event_types(const FixedVector<std::string> &event_types) = delete;
 
  const EventTypes &get_event_types() const { return this->types_; }
 
  StringRef get_last_event_type() const { return StringRef::from_maybe_nullptr(this->last_event_type_); }
 
  const char *get_event_type(uint8_t index) const {
    return index < this->types_.size() ? this->types_[index] : nullptr;
  }
 
  uint8_t get_last_event_type_index() const {
    if (this->last_event_type_ == nullptr)
      return std::numeric_limits<uint8_t>::max();
    // Most events have <3 types, uint8_t is sufficient for all reasonable scenarios
    const uint8_t size = static_cast<uint8_t>(this->types_.size());
    for (uint8_t i = 0; i < size; i++) {
      if (this->types_[i] == this->last_event_type_)
        return i;
    }
    return std::numeric_limits<uint8_t>::max();
  }
 
  bool has_event() const { return this->last_event_type_ != nullptr; }
 
  template<typename F> void add_on_event_callback(F &&callback) {
    this->event_callback_.add(std::forward<F>(callback));
  }
 
 protected:
  void set_event_types_copy_(const char *const *event_types, size_t count);
 
  LazyCallbackManager<void(StringRef event_type)> event_callback_;
  EventTypes types_;
 
 private:
  const char *last_event_type_{nullptr};
};
 
}  // namespace esphome::event