alloc_helpers.h

Go to the documentation of this file.

#pragma once
 
 
#include <array>
#include <cstdarg>
#include <cstdint>
#include <cstdio>
#include <string>
#include <type_traits>
#include <vector>
 
#include "esphome/core/helpers.h"
 
namespace esphome {
 
// --- String helpers (allocating) ---
 
std::string str_truncate(const std::string &str, size_t length);
 
std::string str_until(const char *str, char ch);
std::string str_until(const std::string &str, char ch);
 
std::string str_lower_case(const std::string &str);
 
std::string str_upper_case(const std::string &str);
 
std::string str_snake_case(const std::string &str);
 
std::string str_sanitize(const std::string &str);
 
std::string __attribute__((format(printf, 1, 3))) str_snprintf(const char *fmt, size_t len, ...);
 
std::string __attribute__((format(printf, 1, 2))) str_sprintf(const char *fmt, ...);
 
// --- Hex/binary formatting helpers (allocating) ---
 
std::string format_mac_address_pretty(const uint8_t mac[6]);
 
std::string format_hex(const uint8_t *data, size_t length);
 
std::string format_hex(const std::vector<uint8_t> &data);
 
template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> std::string format_hex(T val) {
  val = convert_big_endian(val);
  return format_hex(reinterpret_cast<uint8_t *>(&val), sizeof(T));
}
 
template<std::size_t N> std::string format_hex(const std::array<uint8_t, N> &data) {
  return format_hex(data.data(), data.size());
}
 
std::string format_hex_pretty(const uint8_t *data, size_t length, char separator = '.', bool show_length = true);
 
std::string format_hex_pretty(const uint16_t *data, size_t length, char separator = '.', bool show_length = true);
 
std::string format_hex_pretty(const std::vector<uint8_t> &data, char separator = '.', bool show_length = true);
 
std::string format_hex_pretty(const std::vector<uint16_t> &data, char separator = '.', bool show_length = true);
 
std::string format_hex_pretty(const std::string &data, char separator = '.', bool show_length = true);
 
template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
std::string format_hex_pretty(T val, char separator = '.', bool show_length = true) {
  val = convert_big_endian(val);
  return format_hex_pretty(reinterpret_cast<uint8_t *>(&val), sizeof(T), separator, show_length);
}
 
std::string format_bin(const uint8_t *data, size_t length);
 
template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> std::string format_bin(T val) {
  val = convert_big_endian(val);
  return format_bin(reinterpret_cast<uint8_t *>(&val), sizeof(T));
}
 
// --- Base64 helpers (allocating) ---
 
std::string base64_encode(const uint8_t *buf, size_t buf_len);
std::string base64_encode(const std::vector<uint8_t> &buf);
 
std::vector<uint8_t> base64_decode(const std::string &encoded_string);
 
// --- MAC address helpers (allocating) ---
 
std::string get_mac_address();
 
std::string get_mac_address_pretty();
 
}  // namespace esphome