filter.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/component.h"
#include "esphome/core/helpers.h"
#include <queue>
#include <utility>
#include <map>
#include <vector>

namespace esphome {
namespace text_sensor {

class TextSensor;

class Filter {
 public:
  virtual optional<std::string> new_value(std::string value) = 0;

  virtual void initialize(TextSensor *parent, Filter *next);

  void input(const std::string &value);

  void output(const std::string &value);

 protected:
  friend TextSensor;

  Filter *next_{nullptr};
  TextSensor *parent_{nullptr};
};

using lambda_filter_t = std::function<optional<std::string>(std::string)>;

class LambdaFilter : public Filter {
 public:
  explicit LambdaFilter(lambda_filter_t lambda_filter);

  optional<std::string> new_value(std::string value) override;

  const lambda_filter_t &get_lambda_filter() const;
  void set_lambda_filter(const lambda_filter_t &lambda_filter);

 protected:
  lambda_filter_t lambda_filter_;
};

class ToUpperFilter : public Filter {
 public:
  optional<std::string> new_value(std::string value) override;
};

class ToLowerFilter : public Filter {
 public:
  optional<std::string> new_value(std::string value) override;
};

class AppendFilter : public Filter {
 public:
  AppendFilter(std::string suffix) : suffix_(std::move(suffix)) {}
  optional<std::string> new_value(std::string value) override;

 protected:
  std::string suffix_;
};

class PrependFilter : public Filter {
 public:
  PrependFilter(std::string prefix) : prefix_(std::move(prefix)) {}
  optional<std::string> new_value(std::string value) override;

 protected:
  std::string prefix_;
};

class SubstituteFilter : public Filter {
 public:
  SubstituteFilter(std::vector<std::string> from_strings, std::vector<std::string> to_strings)
      : from_strings_(std::move(from_strings)), to_strings_(std::move(to_strings)) {}
  optional<std::string> new_value(std::string value) override;

 protected:
  std::vector<std::string> from_strings_;
  std::vector<std::string> to_strings_;
};

class MapFilter : public Filter {
 public:
  MapFilter(std::map<std::string, std::string> mappings) : mappings_(std::move(mappings)) {}
  optional<std::string> new_value(std::string value) override;

 protected:
  std::map<std::string, std::string> mappings_;
};

}  // namespace text_sensor
}  // namespace esphome