styled.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Jarosław Pelczar <jarek@jpelczar.com>
//
// SPDX-License-Identifier: BSD-2-Clause
 
#pragma once
 
#include "../microfmt.hpp"
#include <cstddef>
#include <cstdint>
#include <string_view>
#include <type_traits>
 
namespace microfmt {
 
enum class text_case : uint8_t { none = 0, upper, lower, title };
 
enum class text_align : uint8_t { left = 0, center, right };
 
enum class quote_style : uint8_t {
  none = 0,
  double_quotes, // "text"
  single_quotes, // 'text'
  brackets,      // [text]
  parens,        // (text)
  angle_brackets // <text>
};
 
struct MICROFMT_API_CLASS RELOCO_POINTER styled_str_view {
  microfmt::string_view text{};
  size_t width{0};
  char fill_char{' '};
  text_align align{text_align::left};
  text_case casing{text_case::none};
  quote_style quote{quote_style::none};
  size_t max_len{0}; // 0 = no truncation
  bool ellipsis{true};
};
 
[[nodiscard]] constexpr styled_str_view pad(microfmt::string_view s, size_t width, text_align a = text_align::left,
                                            char fill = ' ') noexcept {
  return {s, width, fill, a, text_case::none, quote_style::none, 0, false};
}
 
[[nodiscard]] constexpr styled_str_view pad_center(microfmt::string_view s, size_t width, char fill = ' ') noexcept {
  return pad(s, width, text_align::center, fill);
}
 
[[nodiscard]] constexpr styled_str_view pad_right(microfmt::string_view s, size_t width, char fill = ' ') noexcept {
  return pad(s, width, text_align::right, fill);
}
 
[[nodiscard]] constexpr styled_str_view to_upper(microfmt::string_view s) noexcept {
  return {s, 0, ' ', text_align::left, text_case::upper, quote_style::none, 0, false};
}
 
[[nodiscard]] constexpr styled_str_view to_lower(microfmt::string_view s) noexcept {
  return {s, 0, ' ', text_align::left, text_case::lower, quote_style::none, 0, false};
}
 
[[nodiscard]] constexpr styled_str_view truncate(microfmt::string_view s, size_t max_chars,
                                                 bool use_ellipsis = true) noexcept {
  return {s, 0, ' ', text_align::left, text_case::none, quote_style::none, max_chars, use_ellipsis};
}
 
[[nodiscard]] constexpr styled_str_view quoted(microfmt::string_view s,
                                               quote_style q = quote_style::double_quotes) noexcept {
  return {s, 0, ' ', text_align::left, text_case::none, q, 0, false};
}
 
template <> struct formatter<styled_str_view> {
  styled_str_view cfg{};
  bool align_set{false};
  bool fill_set{false};
 
  MICROFMT_API_CONSTEXPR void parse(format_parse_context &ctx) noexcept;
 
  MICROFMT_API void format(const styled_str_view &input, const sink &out) const noexcept;
};
 
#if MICROFMT_SHARED_PROVIDE_DEFINITIONS
#include "styled.ipp"
#endif
 
} // namespace microfmt