Atlas  0.7.0
Networking protocol for the Worldforge system.
Atlas::Formatter Class Reference

#include <Formatter.h>

Inheritance diagram for Atlas::Formatter:
Collaboration diagram for Atlas::Formatter:

Public Member Functions

 Formatter (std::ostream &s, Atlas::Bridge &b)
 
void streamBegin () override
 
void streamMessage () override
 
void streamEnd () override
 
void mapMapItem (std::string name) override
 
void mapListItem (std::string name) override
 
void mapIntItem (std::string name, std::int64_t) override
 
void mapFloatItem (std::string name, double) override
 
void mapStringItem (std::string name, std::string) override
 
void mapNoneItem (std::string name) override
 
void mapEnd () override
 
void listMapItem () override
 
void listListItem () override
 
void listIntItem (std::int64_t) override
 
void listFloatItem (double) override
 
void listStringItem (std::string) override
 
void listNoneItem () override
 
void listEnd () override
 
void setSpacing (int s)
 

Protected Attributes

std::ostream & m_stream
 
Bridgem_bridge
 
int m_indent
 
int m_spacing
 

Detailed Description

Atlas stream formatter

This class implements the Bridge interface that accepts an Atlas stream. It copies the input stream to an output bridge, inserting formatting characters according to settings defined at construction time.

See also
Codec

Definition at line 23 of file Formatter.h.

Member Function Documentation

◆ listEnd()

void Atlas::Formatter::listEnd ( )
overridevirtual

Ends the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 127 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listEnd().

◆ listFloatItem()

void Atlas::Formatter::listFloatItem ( double  )
overridevirtual

Adds a float to the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 113 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listFloatItem().

◆ listIntItem()

void Atlas::Formatter::listIntItem ( std::int64_t  )
overridevirtual

Adds an integer to the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 108 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listIntItem().

◆ listListItem()

void Atlas::Formatter::listListItem ( )
overridevirtual

Starts a list object in the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 103 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listListItem().

◆ listMapItem()

void Atlas::Formatter::listMapItem ( )
overridevirtual

Starts a map object in the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 95 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listMapItem().

◆ listNoneItem()

void Atlas::Formatter::listNoneItem ( )
overridevirtual

Adds an empty item to the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 123 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listNoneItem().

◆ listStringItem()

void Atlas::Formatter::listStringItem ( std::string  )
overridevirtual

Adds a string to the currently streamed list.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 118 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::listStringItem().

◆ mapEnd()

void Atlas::Formatter::mapEnd ( )
overridevirtual

Ends the currently streamed map.

Implements Atlas::Bridge.

Definition at line 86 of file Formatter.cpp.

◆ mapFloatItem()

void Atlas::Formatter::mapFloatItem ( std::string  name,
double   
)
overridevirtual

Adds a float to the currently streamed map.

Implements Atlas::Bridge.

Definition at line 66 of file Formatter.cpp.

◆ mapIntItem()

void Atlas::Formatter::mapIntItem ( std::string  name,
std::int64_t   
)
overridevirtual

Adds an integer to the currently streamed map.

Implements Atlas::Bridge.

Definition at line 59 of file Formatter.cpp.

◆ mapListItem()

void Atlas::Formatter::mapListItem ( std::string  name)
overridevirtual

Starts a list object to the currently streamed map.

Implements Atlas::Bridge.

Reimplemented in Atlas::MultiLineListFormatter.

Definition at line 53 of file Formatter.cpp.

Referenced by Atlas::MultiLineListFormatter::mapListItem().

◆ mapMapItem()

void Atlas::Formatter::mapMapItem ( std::string  name)
overridevirtual

Starts a map object to the currently streamed map.

Implements Atlas::Bridge.

Definition at line 45 of file Formatter.cpp.

◆ mapNoneItem()

void Atlas::Formatter::mapNoneItem ( std::string  name)
overridevirtual

Adds a none item to the currently streamed map.

Implements Atlas::Bridge.

Definition at line 80 of file Formatter.cpp.

◆ mapStringItem()

void Atlas::Formatter::mapStringItem ( std::string  name,
std::string   
)
overridevirtual

Adds a string to the currently streamed map.

Implements Atlas::Bridge.

Definition at line 73 of file Formatter.cpp.

◆ streamBegin()

void Atlas::Formatter::streamBegin ( )
overridevirtual

Begin an Atlas stream.

Implements Atlas::Bridge.

Definition at line 21 of file Formatter.cpp.

◆ streamEnd()

void Atlas::Formatter::streamEnd ( )
overridevirtual

Ends the Atlas stream.

Implements Atlas::Bridge.

Definition at line 37 of file Formatter.cpp.

◆ streamMessage()

void Atlas::Formatter::streamMessage ( )
overridevirtual

Start a message in an Atlas stream.

Implements Atlas::Bridge.

Definition at line 28 of file Formatter.cpp.


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