feisty meow concerns codebase  2.140
loggers::eol_aware Class Reference

Provides an abstract base for logging mechanisms. More...

#include <eol_aware.h>

Inheritance diagram for loggers::eol_aware:
Collaboration diagram for loggers::eol_aware:

Public Member Functions

virtual textual::parser_bits::line_ending eol ()
 observes how line endings are to be printed. More...
 
virtual void eol (textual::parser_bits::line_ending to_set)
 modifies how line endings are to be printed. More...
 
virtual basis::astring get_ending ()
 returns a string for the current ending. More...
 
virtual void get_ending (basis::astring &to_end)
 appends a string for the current ending to "to_end". More...
 

Detailed Description

Provides an abstract base for logging mechanisms.

This assists greatly in generating diagnostic entries polymorphically and in enabling different logging mechanisms to be plugged in easily. Note that all of the functions are defined virtually which enables overriding pretty much all of the base functionality. Use this wisely, if ever.

Definition at line 31 of file eol_aware.h.

Member Function Documentation

◆ eol() [1/2]

virtual textual::parser_bits::line_ending loggers::eol_aware::eol ( )
inlinevirtual

observes how line endings are to be printed.

Definition at line 34 of file eol_aware.h.

Referenced by loggers::combo_logger::eol().

◆ eol() [2/2]

virtual void loggers::eol_aware::eol ( textual::parser_bits::line_ending  to_set)
inlinevirtual

modifies how line endings are to be printed.

Reimplemented in loggers::combo_logger.

Definition at line 37 of file eol_aware.h.

◆ get_ending() [1/2]

virtual basis::astring loggers::eol_aware::get_ending ( )
inlinevirtual

returns a string for the current ending.

Definition at line 40 of file eol_aware.h.

References textual::parser_bits::eol_to_chars().

◆ get_ending() [2/2]

virtual void loggers::eol_aware::get_ending ( basis::astring to_end)
inlinevirtual

appends a string for the current ending to "to_end".

Definition at line 43 of file eol_aware.h.

References textual::parser_bits::eol_to_chars().


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