/* * Copyright (c) 2020, the SerenityOS developers. * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #ifndef KERNEL # include # include #endif namespace AK { class TypeErasedFormatParams; class FormatParser; class FormatBuilder; template struct Formatter { using __no_formatter_defined = void; }; template inline constexpr bool HasFormatter = true; template inline constexpr bool HasFormatter::__no_formatter_defined> = false; constexpr size_t max_format_arguments = 256; struct TypeErasedParameter { enum class Type { UInt8, UInt16, UInt32, UInt64, Int8, Int16, Int32, Int64, Custom }; template static consteval Type get_type_from_size() { if constexpr (is_unsigned) { if constexpr (size == 1) return Type::UInt8; if constexpr (size == 2) return Type::UInt16; if constexpr (size == 4) return Type::UInt32; if constexpr (size == 8) return Type::UInt64; } else { if constexpr (size == 1) return Type::Int8; if constexpr (size == 2) return Type::Int16; if constexpr (size == 4) return Type::Int32; if constexpr (size == 8) return Type::Int64; } VERIFY_NOT_REACHED(); } template static consteval Type get_type() { if constexpr (IsIntegral) return get_type_from_size>(); else return Type::Custom; } template constexpr auto visit(Visitor&& visitor) const { switch (type) { case TypeErasedParameter::Type::UInt8: return visitor(*static_cast(value)); case TypeErasedParameter::Type::UInt16: return visitor(*static_cast(value)); case TypeErasedParameter::Type::UInt32: return visitor(*static_cast(value)); case TypeErasedParameter::Type::UInt64: return visitor(*static_cast(value)); case TypeErasedParameter::Type::Int8: return visitor(*static_cast(value)); case TypeErasedParameter::Type::Int16: return visitor(*static_cast(value)); case TypeErasedParameter::Type::Int32: return visitor(*static_cast(value)); case TypeErasedParameter::Type::Int64: return visitor(*static_cast(value)); default: TODO(); } } constexpr size_t to_size() const { return visit([](T value) { if constexpr (sizeof(T) > sizeof(size_t)) VERIFY(value < NumericLimits::max()); if constexpr (IsSigned) VERIFY(value > 0); return static_cast(value); }); } // FIXME: Getters and setters. const void* value; Type type; ErrorOr (*formatter)(TypeErasedFormatParams&, FormatBuilder&, FormatParser&, void const* value); }; class FormatBuilder { public: enum class Align { Default, Left, Center, Right, }; enum class SignMode { OnlyIfNeeded, Always, Reserved, Default = OnlyIfNeeded, }; explicit FormatBuilder(StringBuilder& builder) : m_builder(builder) { } ErrorOr put_padding(char fill, size_t amount); ErrorOr put_literal(StringView value); ErrorOr put_string( StringView value, Align align = Align::Left, size_t min_width = 0, size_t max_width = NumericLimits::max(), char fill = ' '); ErrorOr put_u64( u64 value, u8 base = 10, bool prefix = false, bool upper_case = false, bool zero_pad = false, Align align = Align::Right, size_t min_width = 0, char fill = ' ', SignMode sign_mode = SignMode::OnlyIfNeeded, bool is_negative = false); ErrorOr put_i64( i64 value, u8 base = 10, bool prefix = false, bool upper_case = false, bool zero_pad = false, Align align = Align::Right, size_t min_width = 0, char fill = ' ', SignMode sign_mode = SignMode::OnlyIfNeeded); #ifndef KERNEL ErrorOr put_f80( long double value, u8 base = 10, bool upper_case = false, Align align = Align::Right, size_t min_width = 0, size_t precision = 6, char fill = ' ', SignMode sign_mode = SignMode::OnlyIfNeeded); ErrorOr put_f64( double value, u8 base = 10, bool upper_case = false, bool zero_pad = false, Align align = Align::Right, size_t min_width = 0, size_t precision = 6, char fill = ' ', SignMode sign_mode = SignMode::OnlyIfNeeded); #endif ErrorOr put_hexdump( ReadonlyBytes, size_t width, char fill = ' '); const StringBuilder& builder() const { return m_builder; } StringBuilder& builder() { return m_builder; } private: StringBuilder& m_builder; }; class TypeErasedFormatParams { public: Span parameters() const { return m_parameters; } void set_parameters(Span parameters) { m_parameters = parameters; } size_t take_next_index() { return m_next_index++; } private: Span m_parameters; size_t m_next_index { 0 }; }; template ErrorOr __format_value(TypeErasedFormatParams& params, FormatBuilder& builder, FormatParser& parser, const void* value) { Formatter formatter; formatter.parse(params, parser); return formatter.format(builder, *static_cast(value)); } template class VariadicFormatParams : public TypeErasedFormatParams { public: static_assert(sizeof...(Parameters) <= max_format_arguments); explicit VariadicFormatParams(const Parameters&... parameters) : m_data({ TypeErasedParameter { ¶meters, TypeErasedParameter::get_type(), __format_value }... }) { this->set_parameters(m_data); } private: Array m_data; }; // We use the same format for most types for consistency. This is taken directly from // std::format. One difference is that we are not counting the width or sign towards the // total width when calculating zero padding for numbers. // https://en.cppreference.com/w/cpp/utility/format/formatter#Standard_format_specification struct StandardFormatter { enum class Mode { Default, Binary, BinaryUppercase, Decimal, Octal, Hexadecimal, HexadecimalUppercase, Character, String, Pointer, Float, Hexfloat, HexfloatUppercase, HexDump, }; FormatBuilder::Align m_align = FormatBuilder::Align::Default; FormatBuilder::SignMode m_sign_mode = FormatBuilder::SignMode::OnlyIfNeeded; Mode m_mode = Mode::Default; bool m_alternative_form = false; char m_fill = ' '; bool m_zero_pad = false; Optional m_width; Optional m_precision; void parse(TypeErasedFormatParams&, FormatParser&); }; template struct Formatter>::Type> : StandardFormatter { Formatter() = default; explicit Formatter(StandardFormatter formatter) : StandardFormatter(move(formatter)) { } ErrorOr format(FormatBuilder&, T); }; template<> struct Formatter : StandardFormatter { Formatter() = default; explicit Formatter(StandardFormatter formatter) : StandardFormatter(move(formatter)) { } ErrorOr format(FormatBuilder&, StringView); }; template requires(HasFormatter) struct Formatter> : StandardFormatter { Formatter() = default; explicit Formatter(StandardFormatter formatter) : StandardFormatter(move(formatter)) { } ErrorOr format(FormatBuilder& builder, Vector value) { if (m_mode == Mode::Pointer) { Formatter formatter { *this }; TRY(formatter.format(builder, reinterpret_cast(value.data()))); return {}; } if (m_sign_mode != FormatBuilder::SignMode::Default) VERIFY_NOT_REACHED(); if (m_alternative_form) VERIFY_NOT_REACHED(); if (m_zero_pad) VERIFY_NOT_REACHED(); if (m_mode != Mode::Default) VERIFY_NOT_REACHED(); if (m_width.has_value() && m_precision.has_value()) VERIFY_NOT_REACHED(); m_width = m_width.value_or(0); m_precision = m_precision.value_or(NumericLimits::max()); Formatter content_fmt; TRY(builder.put_literal("[ "sv)); bool first = true; for (auto& content : value) { if (!first) { TRY(builder.put_literal(", "sv)); content_fmt = Formatter {}; } first = false; TRY(content_fmt.format(builder, content)); } TRY(builder.put_literal(" ]"sv)); return {}; } }; template<> struct Formatter : Formatter { ErrorOr format(FormatBuilder& builder, ReadonlyBytes value) { if (m_mode == Mode::Pointer) { Formatter formatter { *this }; return formatter.format(builder, reinterpret_cast(value.data())); } if (m_mode == Mode::Default || m_mode == Mode::HexDump) { m_mode = Mode::HexDump; return Formatter::format(builder, value); } return Formatter::format(builder, value); } }; template<> struct Formatter : Formatter { }; template<> struct Formatter : Formatter { ErrorOr format(FormatBuilder& builder, const char* value) { if (m_mode == Mode::Pointer) { Formatter formatter { *this }; return formatter.format(builder, reinterpret_cast(value)); } return Formatter::format(builder, value); } }; template<> struct Formatter : Formatter { }; template struct Formatter : Formatter { }; template struct Formatter : Formatter { ErrorOr format(FormatBuilder& builder, const unsigned char* value) { if (m_mode == Mode::Pointer) { Formatter formatter { *this }; return formatter.format(builder, reinterpret_cast(value)); } return Formatter::format(builder, { value, Size }); } }; template<> struct Formatter : Formatter { }; template<> struct Formatter : Formatter { }; template struct Formatter : StandardFormatter { ErrorOr format(FormatBuilder& builder, T* value) { if (m_mode == Mode::Default) m_mode = Mode::Pointer; Formatter formatter { *this }; return formatter.format(builder, reinterpret_cast(value)); } }; template<> struct Formatter : StandardFormatter { ErrorOr format(FormatBuilder&, char); }; template<> struct Formatter : StandardFormatter { ErrorOr format(FormatBuilder& builder, wchar_t); }; template<> struct Formatter : StandardFormatter { ErrorOr format(FormatBuilder&, bool); }; #ifndef KERNEL template<> struct Formatter : StandardFormatter { ErrorOr format(FormatBuilder&, float value); }; template<> struct Formatter : StandardFormatter { Formatter() = default; explicit Formatter(StandardFormatter formatter) : StandardFormatter(formatter) { } ErrorOr format(FormatBuilder&, double); }; template<> struct Formatter : StandardFormatter { Formatter() = default; explicit Formatter(StandardFormatter formatter) : StandardFormatter(formatter) { } ErrorOr format(FormatBuilder&, long double value); }; #endif template<> struct Formatter : Formatter { ErrorOr format(FormatBuilder& builder, std::nullptr_t) { if (m_mode == Mode::Default) m_mode = Mode::Pointer; return Formatter::format(builder, 0); } }; ErrorOr vformat(StringBuilder&, StringView fmtstr, TypeErasedFormatParams&); #ifndef KERNEL void vout(FILE*, StringView fmtstr, TypeErasedFormatParams&, bool newline = false); template void out(FILE* file, CheckedFormatString&& fmtstr, const Parameters&... parameters) { VariadicFormatParams variadic_format_params { parameters... }; vout(file, fmtstr.view(), variadic_format_params); } template void outln(FILE* file, CheckedFormatString&& fmtstr, const Parameters&... parameters) { VariadicFormatParams variadic_format_params { parameters... }; vout(file, fmtstr.view(), variadic_format_params, true); } inline void outln(FILE* file) { fputc('\n', file); } template void out(CheckedFormatString&& fmtstr, const Parameters&... parameters) { out(stdout, move(fmtstr), parameters...); } template void outln(CheckedFormatString&& fmtstr, const Parameters&... parameters) { outln(stdout, move(fmtstr), parameters...); } inline void outln() { outln(stdout); } # define outln_if(flag, fmt, ...) \ do { \ if constexpr (flag) \ outln(fmt, ##__VA_ARGS__); \ } while (0) template void warn(CheckedFormatString&& fmtstr, const Parameters&... parameters) { out(stderr, move(fmtstr), parameters...); } template void warnln(CheckedFormatString&& fmtstr, const Parameters&... parameters) { outln(stderr, move(fmtstr), parameters...); } inline void warnln() { outln(stderr); } # define warnln_if(flag, fmt, ...) \ do { \ if constexpr (flag) \ outln(fmt, ##__VA_ARGS__); \ } while (0) #endif void vdbgln(StringView fmtstr, TypeErasedFormatParams&); template void dbgln(CheckedFormatString&& fmtstr, const Parameters&... parameters) { VariadicFormatParams variadic_format_params { parameters... }; vdbgln(fmtstr.view(), variadic_format_params); } inline void dbgln() { dbgln(""); } void set_debug_enabled(bool); #ifdef KERNEL void vdmesgln(StringView fmtstr, TypeErasedFormatParams&); template void dmesgln(CheckedFormatString&& fmt, const Parameters&... parameters) { VariadicFormatParams variadic_format_params { parameters... }; vdmesgln(fmt.view(), variadic_format_params); } void v_critical_dmesgln(StringView fmtstr, TypeErasedFormatParams&); // be very careful to not cause any allocations here, since we could be in // a very unstable situation template void critical_dmesgln(CheckedFormatString&& fmt, const Parameters&... parameters) { VariadicFormatParams variadic_format_params { parameters... }; v_critical_dmesgln(fmt.view(), variadic_format_params); } #endif template class FormatIfSupported { public: explicit FormatIfSupported(const T& value) : m_value(value) { } const T& value() const { return m_value; } private: const T& m_value; }; template struct __FormatIfSupported : Formatter { ErrorOr format(FormatBuilder& builder, FormatIfSupported const&) { return Formatter::format(builder, "?"); } }; template struct __FormatIfSupported : Formatter { ErrorOr format(FormatBuilder& builder, FormatIfSupported const& value) { return Formatter::format(builder, value.value()); } }; template struct Formatter> : __FormatIfSupported> { }; // This is a helper class, the idea is that if you want to implement a formatter you can inherit // from this class to "break down" the formatting. struct FormatString { }; template<> struct Formatter : Formatter { template ErrorOr format(FormatBuilder& builder, StringView fmtstr, const Parameters&... parameters) { VariadicFormatParams variadic_format_params { parameters... }; return vformat(builder, fmtstr, variadic_format_params); } ErrorOr vformat(FormatBuilder& builder, StringView fmtstr, TypeErasedFormatParams& params); }; template<> struct Formatter : Formatter { ErrorOr format(FormatBuilder& builder, Error const& error) { #if defined(__serenity__) && defined(KERNEL) if (error.is_errno()) return Formatter::format(builder, "Error(errno={})", error.code()); return Formatter::format(builder, "Error({})", error.string_literal()); #else if (error.is_syscall()) return Formatter::format(builder, "{}: {} (errno={})", error.string_literal(), strerror(error.code()), error.code()); if (error.is_errno()) return Formatter::format(builder, "{} (errno={})", strerror(error.code()), error.code()); return Formatter::format(builder, "{}", error.string_literal()); #endif } }; template struct Formatter> : Formatter { ErrorOr format(FormatBuilder& builder, ErrorOr const& error_or) { if (error_or.is_error()) return Formatter::format(builder, "{}", error_or.error()); return Formatter::format(builder, "{{{}}}", error_or.value()); } }; } // namespace AK #ifdef KERNEL using AK::critical_dmesgln; using AK::dmesgln; #else using AK::out; using AK::outln; using AK::warn; using AK::warnln; #endif using AK::dbgln; using AK::CheckedFormatString; using AK::FormatIfSupported; using AK::FormatString; #define dbgln_if(flag, fmt, ...) \ do { \ if constexpr (flag) \ dbgln(fmt, ##__VA_ARGS__); \ } while (0)