template <invocable<std::string_view> Sink>

class Writer

Defined at line 66 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer emits symbolizer markup. Writing is abstracted by way of Sink, which

is any type that is callable with a std::string_view argument.

Each call represents a single markup element.

Example usage:

```

symbolizer_markup::Writer writer(std::ref(sink));

// Color will persist until `red` goes out of scope, at which point it will

// return to the default.

auto red = writer.ChangeColor(symbolizer_markup::Color::kRed);

// Apart from ChangeColor(), calls can be chained.

writer.Reset()

.Newline()

.Symbol("foobar")

.Newline()

.Data("baz")

.Newline();

```

Public Methods

void Writer<Sink> (Sink sink)

Defined at line 68 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

auto ChangeColor (Color color, bool bold)

Changes the output color, optionally boldened. Once the return value goes

out of scope, the color is changed back to the default. Among subsequent

calls, 'last wins'.

Defined at line 79 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Symbol (std::string_view name)

Emits the markup for a symbol or type, given its linkage name.

{{{symbol:$name}}}

Defined at line 104 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Symbol (std::string_view name)

Emits the markup for a symbol or type, given its linkage name.

{{{symbol:$name}}}

Defined at line 104 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Code (uint64_t pc)

Emits the markup for the memory address of a code location.

{{{pc:$addr}}}

Defined at line 109 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Code (uint64_t pc)

Emits the markup for the memory address of a code location.

{{{pc:$addr}}}

Defined at line 109 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Data (uint64_t addr)

Emits the markup for the memory address of a data location.

{{{data:$addr}}}

Defined at line 114 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Data (uint64_t addr)

Emits the markup for the memory address of a data location.

{{{data:$addr}}}

Defined at line 114 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & ReturnAddressFrame (unsigned int frame, uint64_t pc)

Emits the markup for a backtrace frame off of the callstack.

{{{bt:$frame:$pc:ra}}}

Defined at line 119 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & ReturnAddressFrame (unsigned int frame, uint64_t pc)

Emits the markup for a backtrace frame off of the callstack.

{{{bt:$frame:$pc:ra}}}

Defined at line 119 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & ExactPcFrame (unsigned int frame, uint64_t pc)

Emits the markup for a backtrace frame leading into an interrupt.

{{{bt:$frame:$pc:pc}}}

Defined at line 126 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & ExactPcFrame (unsigned int frame, uint64_t pc)

Emits the markup for a backtrace frame leading into an interrupt.

{{{bt:$frame:$pc:pc}}}

Defined at line 126 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Dumpfile (std::string_view type, std::string_view name, std::string_view name_suffix)

Emits the markup for a dumpfile, given its type and name.

{{{dumpfile:$type:$name}}}

Defined at line 141 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Dumpfile (std::string_view type, std::string_view name, std::string_view name_suffix)

Emits the markup for a dumpfile, given its type and name.

{{{dumpfile:$type:$name}}}

Defined at line 141 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & Reset ()

Emits the markup to reset the context.

{{{reset}}}

Defined at line 155 of file ../../src/lib/symbolizer-markup/include/lib/symbolizer-markup/writer.h

Writer<Sink> & ElfModule (unsigned int id, std::string_view name, std::span<const std::byte> build_id)