共享编译期后端，把前端事件整理成最终字节流和参数表。 / Shared compile-time backend that turns frontend events into the final byte stream plus argument table. More...

#include <format_compile.hpp>

Data Structures
struct	ResultData
	当前后端实例产出的最终精确尺寸编译格式 / Final exact-size compiled format produced by this backend instance More...

struct	ScratchBuilder
	由前端文本/字段事件直接喂给的单遍临时构建器。 / One-pass scratch builder fed directly by frontend text/field events. More...

Static Public Member Functions
static consteval auto	Compile ()
	把一个前端编译成最终字节流、参数表和 writer 摘要。 / Compiles one frontend into the final byte stream, argument table, and writer profile.

Private Types
using	Error = typename Frontend::ErrorType

template<size_t BlobBytes, size_t ArgCount>
using	Result = ResultData<BlobBytes, ArgCount>

Static Private Member Functions
static consteval void	EmitByte (auto &data, size_t &out, uint8_t value)
	向临时或最终字节缓冲区追加一个原始字节 / Append one raw byte into a scratch or final byte buffer

template<typename T >
static consteval void	EmitNative (auto &data, size_t &out, T value)
	向临时或最终字节缓冲区追加一个按本机字节序编码的 POD 值 / Append one native-endian POD value into a scratch or final byte buffer

template<typename T >
static consteval T	ReadNative (const auto &data, size_t &pos)
	从临时字节缓冲区读取一个按本机字节序编码的 POD 值 / Read one native-endian POD value from a scratch byte buffer

static consteval auto	Failed (Error error)
	构造只携带编译错误的最小失败结果。 / Builds the minimal failed result carrying only the compile error.

static consteval FormatProfile	ProfileForOp (FormatOp op)
	指出某个操作码族需要打开哪一个 writer-profile 位。 / Says which writer-profile bit one opcode family needs.

static consteval FormatOp	FastFieldOp (const FormatField &field)
	为一个字段选择仍能正确打印它的最小操作码。 / Chooses the smallest opcode that can still print this field correctly.

static consteval bool	IsRawIntegerField (const FormatField &field)
	判断字段是否满足裸整数快路径条件。 / Tests whether one field matches the raw integer fast-path gate.

static consteval bool	IsRawTextField (const FormatField &field)
	判断字段是否满足裸文本快路径条件。 / Tests whether one field matches the raw text fast-path gate.

Static Private Attributes
static constexpr size_t	inline_text_limit = 2 * sizeof(size_t) - 1
	超过该长度后，字面文本会从内嵌模式切换为 TextRef / Maximum inline literal size before the backend spills to TextRef.

static constexpr size_t	max_code_bytes = 3 * Frontend::SourceSize() + 1

static constexpr size_t	max_text_pool_bytes = Frontend::SourceSize()

static constexpr size_t	max_arg_count = Frontend::SourceSize()

static constexpr uint8_t	unspecified_precision = std::numeric_limits<uint8_t>::max()

Detailed Description

template<typename Frontend>
class LibXR::Print::FormatCompiler< Frontend >

共享编译期后端，把前端事件整理成最终字节流和参数表。 / Shared compile-time backend that turns frontend events into the final byte stream plus argument table.

Frontend contract: The frontend must provide the members using ErrorType, static constexpr const char* SourceData(), static constexpr size_t SourceSize(), and static consteval ErrorType Walk(visitor). 前端协议：前端必须提供如下成员：using ErrorType、static constexpr const char* SourceData()、static constexpr size_t SourceSize()、以及 static consteval ErrorType Walk(visitor)。

Walk(visitor) must emit source-ordered events through:

visitor.Text(offset, text_size)
visitor.Field(const FormatField&) Walk(visitor) 必须按源串顺序发射两类事件：
visitor.Text(offset, text_size)
visitor.Field(const FormatField&)

The backend only walks the frontend once. During that single walk it collects:

output bytecode
long literal-text storage
runtime argument metadata
the runtime executor profile

Then it packs those scratch buffers into the final exact-size result. 这个后端只遍历前端一次。那一遍里会同时收集：

输出字节码
长字面文本存储
运行期参数元信息
运行期执行器摘要

最后再把这些临时缓冲收拢成精确尺寸的最终结果。

Definition at line 51 of file format_compile.hpp.

Member Typedef Documentation

◆ Error

template<typename Frontend >

using LibXR::Print::FormatCompiler< Frontend >::Error = typename Frontend::ErrorType

private

Definition at line 58 of file format_compile.hpp.

◆ Result

template<typename Frontend >

template<size_t BlobBytes, size_t ArgCount>

using LibXR::Print::FormatCompiler< Frontend >::Result = ResultData<BlobBytes, ArgCount>

private

Definition at line 86 of file format_compile.hpp.

Member Function Documentation

◆ Compile()

template<typename Frontend >

static consteval auto LibXR::Print::FormatCompiler< Frontend >::Compile ( )

inlinestaticnodiscardconsteval

把一个前端编译成最终字节流、参数表和 writer 摘要。 / Compiles one frontend into the final byte stream, argument table, and writer profile.

Returns: Returns the final compiled result object, or a failed result that carries the first compile-time error. / 返回最终编译结果对象；若失败则返回携带首个编译期错误的失败结果。

Definition at line 545 of file format_compile.hpp.

  {
    constexpr auto scratch = []() consteval
    {
      ScratchBuilder builder{};
      builder.frontend_error = Frontend::Walk(builder);
      return builder;
    }();
 
    if constexpr (scratch.frontend_error != Error::None)
    {
      return Failed(scratch.frontend_error);
    }
    else
    {
      return scratch.template Finish<scratch.FinalCodeBytes(), scratch.FinalBlobBytes(),
                                     scratch.arg_count>();
    }
  }

◆ EmitByte()

template<typename Frontend >

static consteval void LibXR::Print::FormatCompiler< Frontend >::EmitByte	(	auto &	data,
		size_t &	out,
		uint8_t	value )

inlinestaticconstevalprivate

向临时或最终字节缓冲区追加一个原始字节 / Append one raw byte into a scratch or final byte buffer

Parameters

data	目标字节缓冲区 / Target byte buffer
out	当前写位置；会前进一个字节 / Current write position; advanced by one byte
value	待追加的字节值 / Byte value to append

Definition at line 115 of file format_compile.hpp.

  {
    data[out++] = value;
  }

◆ EmitNative()

template<typename Frontend >

template<typename T >

static consteval void LibXR::Print::FormatCompiler< Frontend >::EmitNative	(	auto &	data,
		size_t &	out,
		T	value )

inlinestaticconstevalprivate

向临时或最终字节缓冲区追加一个按本机字节序编码的 POD 值 / Append one native-endian POD value into a scratch or final byte buffer

Template Parameters

T	待编码的 POD 类型 / POD type to encode

Parameters

data	目标字节缓冲区 / Target byte buffer
out	当前写位置；会前进 `sizeof(T)` / Current write position; advanced by `sizeof(T)`
value	待追加的 POD 值 / POD value to append

Definition at line 130 of file format_compile.hpp.

  {
    auto bytes = std::bit_cast<std::array<uint8_t, sizeof(T)>>(value);
    for (auto byte : bytes)
    {
      data[out++] = byte;
    }
  }

◆ Failed()

template<typename Frontend >

static consteval auto LibXR::Print::FormatCompiler< Frontend >::Failed ( Error error )

inlinestaticnodiscardconstevalprivate

构造只携带编译错误的最小失败结果。 / Builds the minimal failed result carrying only the compile error.

Parameters

error Compile-time failure category. / 编译期失败类别。

Returns: Returns a minimal failed result object. / 返回最小失败结果对象。

Definition at line 165 of file format_compile.hpp.

  {
    Result<1, 0> result{};
    result.compile_error = error;
    return result;
  }

◆ FastFieldOp()

template<typename Frontend >

static consteval FormatOp LibXR::Print::FormatCompiler< Frontend >::FastFieldOp ( const FormatField & field )

inlinestaticnodiscardconstevalprivate

为一个字段选择仍能正确打印它的最小操作码。 / Chooses the smallest opcode that can still print this field correctly.

Definition at line 210 of file format_compile.hpp.

  {
    const bool raw_integer_field = IsRawIntegerField(field);
    const bool raw_text_field = IsRawTextField(field);
 
    if (raw_integer_field && field.type == FormatType::Signed32 &&
        field.pack == FormatPackKind::I32)
    {
      return FormatOp::I32Dec;
    }
 
    if (field.type == FormatType::Unsigned32 && field.pack == FormatPackKind::U32 &&
        raw_integer_field)
    {
      return FormatOp::U32Dec;
    }
 
    if (raw_integer_field && field.type == FormatType::Binary32 &&
        field.pack == FormatPackKind::U32)
    {
      return FormatOp::U32Binary;
    }
 
    if (raw_integer_field && field.type == FormatType::Octal32 &&
        field.pack == FormatPackKind::U32)
    {
      return FormatOp::U32Octal;
    }
 
    if (raw_integer_field && field.type == FormatType::HexLower32 &&
        field.pack == FormatPackKind::U32)
    {
      return FormatOp::U32HexLower;
    }
 
    if (raw_integer_field && field.type == FormatType::HexUpper32 &&
        field.pack == FormatPackKind::U32)
    {
      return FormatOp::U32HexUpper;
    }
 
    if (raw_text_field && field.type == FormatType::Character &&
        field.pack == FormatPackKind::Character)
    {
      return FormatOp::CharacterRaw;
    }
 
    if (raw_text_field && field.type == FormatType::String &&
        field.pack == FormatPackKind::StringView)
    {
      return FormatOp::StringRaw;
    }
 
    if (field.type == FormatType::Unsigned32 && field.pack == FormatPackKind::U32 &&
        field.flags == static_cast<uint8_t>(FormatFlag::ZeroPad) && field.fill == ' ' &&
        field.width != 0 && field.precision == unspecified_precision)
    {
      return FormatOp::U32ZeroPadWidth;
    }
 
    return FormatOp::GenericField;
  }

◆ IsRawIntegerField()

template<typename Frontend >

static consteval bool LibXR::Print::FormatCompiler< Frontend >::IsRawIntegerField ( const FormatField & field )

inlinestaticnodiscardconstevalprivate

判断字段是否满足裸整数快路径条件。 / Tests whether one field matches the raw integer fast-path gate.

Definition at line 277 of file format_compile.hpp.

  {
    return field.flags == 0 && field.fill == ' ' && field.width == 0 &&
           field.precision == unspecified_precision;
  }

◆ IsRawTextField()

template<typename Frontend >

static consteval bool LibXR::Print::FormatCompiler< Frontend >::IsRawTextField ( const FormatField & field )

inlinestaticnodiscardconstevalprivate

判断字段是否满足裸文本快路径条件。 / Tests whether one field matches the raw text fast-path gate.

Definition at line 287 of file format_compile.hpp.

  {
    return (field.flags == 0 ||
            field.flags == static_cast<uint8_t>(FormatFlag::LeftAlign)) &&
           field.fill == ' ' && field.width == 0 &&
           field.precision == unspecified_precision;
  }

◆ ProfileForOp()

template<typename Frontend >

static consteval FormatProfile LibXR::Print::FormatCompiler< Frontend >::ProfileForOp ( FormatOp op )

inlinestaticnodiscardconstevalprivate

指出某个操作码族需要打开哪一个 writer-profile 位。 / Says which writer-profile bit one opcode family needs.

Parameters

op	待分类的操作码 / Opcode to classify

Returns: 对应的窄路径 profile 位；无需窄路径时返回 None / Required narrow-path profile bit, or None when no narrow path is needed

Definition at line 179 of file format_compile.hpp.

  {
    switch (op)
    {
      case FormatOp::U32Dec:
      case FormatOp::U32ZeroPadWidth:
      case FormatOp::I32Dec:
      case FormatOp::U32Binary:
      case FormatOp::U32Octal:
      case FormatOp::U32HexLower:
      case FormatOp::U32HexUpper:
        return FormatProfile::NarrowInt;
      case FormatOp::StringRaw:
      case FormatOp::CharacterRaw:
        return FormatProfile::TextArg;
      case FormatOp::GenericField:
        return FormatProfile::None;
      case FormatOp::TextInline:
      case FormatOp::TextRef:
      case FormatOp::TextSpace:
      case FormatOp::End:
        return FormatProfile::None;
    }
 
    return FormatProfile::None;
  }

◆ ReadNative()

template<typename Frontend >

template<typename T >

static consteval T LibXR::Print::FormatCompiler< Frontend >::ReadNative	(	const auto &	data,
		size_t &	pos )

inlinestaticnodiscardconstevalprivate

从临时字节缓冲区读取一个按本机字节序编码的 POD 值 / Read one native-endian POD value from a scratch byte buffer

Template Parameters

T	待读取的 POD 类型 / POD type to decode

Parameters

data	源字节缓冲区 / Source byte buffer
pos	当前读取位置；会前进 `sizeof(T)` / Current read position; advanced by `sizeof(T)`

Returns: 返回解码后的 POD 值 / Returns the decoded POD value

Definition at line 149 of file format_compile.hpp.

  {
    std::array<uint8_t, sizeof(T)> bytes{};
    for (size_t i = 0; i < sizeof(T); ++i)
    {
      bytes[i] = data[pos++];
    }
    return std::bit_cast<T>(bytes);
  }

Field Documentation

◆ inline_text_limit

template<typename Frontend >

size_t LibXR::Print::FormatCompiler< Frontend >::inline_text_limit = 2 * sizeof(size_t) - 1

staticconstexprprivate

超过该长度后，字面文本会从内嵌模式切换为 TextRef / Maximum inline literal size before the backend spills to TextRef.

Definition at line 92 of file format_compile.hpp.

◆ max_arg_count

template<typename Frontend >

size_t LibXR::Print::FormatCompiler< Frontend >::max_arg_count = Frontend::SourceSize()

staticconstexprprivate

Definition at line 105 of file format_compile.hpp.

◆ max_code_bytes

template<typename Frontend >

size_t LibXR::Print::FormatCompiler< Frontend >::max_code_bytes = 3 * Frontend::SourceSize() + 1

staticconstexprprivate

Definition at line 103 of file format_compile.hpp.

◆ max_text_pool_bytes

template<typename Frontend >

size_t LibXR::Print::FormatCompiler< Frontend >::max_text_pool_bytes = Frontend::SourceSize()

staticconstexprprivate

Definition at line 104 of file format_compile.hpp.

◆ unspecified_precision

template<typename Frontend >

uint8_t LibXR::Print::FormatCompiler< Frontend >::unspecified_precision = std::numeric_limits<uint8_t>::max()

staticconstexprprivate

Definition at line 106 of file format_compile.hpp.

The documentation for this class was generated from the following file:

src/core/print/format_compile.hpp

Data Structures

Static Public Member Functions

Private Types

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Error

◆ Result

Member Function Documentation

◆ Compile()

◆ EmitByte()

◆ EmitNative()

◆ Failed()

◆ FastFieldOp()

◆ IsRawIntegerField()

◆ IsRawTextField()

◆ ProfileForOp()

◆ ReadNative()

Field Documentation

◆ inline_text_limit

◆ max_arg_count

◆ max_code_bytes

◆ max_text_pool_bytes

◆ unspecified_precision