Universal output to console class. More...

#include <picout.h>

Classes
class	Notifier
	Class for emit notifications of PICout. More...

Public Types
enum	OutputDevice { NoDevices = 0x0 , Console = 0x1 , DEPRECATEDM =("use PICout::Console") = Console , Buffer = 0x2 , AllDevices = 0xFFFF }
	Enum contains output devices of PICout. More...

Public Member Functions
	PICout (int controls=PICoutManipulators::DefaultControls, PICoutStdStream stream=PICoutStdStream::StdOut)
	Default constructor with default features (AddSpaces and AddNewLine)

	PICout (bool active, PICoutStdStream stream=PICoutStdStream::StdOut)
	Construct with default features (AddSpaces and AddNewLine), but if "active" is false does nothing.

PICout &	operator<< (const char *v)
	Output operator for strings with `"const char * "` type.

PICout &	operator<< (const PIString &v)
	Output operator for PIString.

PICout &	operator<< (bool v)
	Output operator for boolean values.

PICout &	operator<< (char v)
	Output operator for `"char"` values.

PICout &	operator<< (uchar v)
	Output operator for `"unsigned char"` values.

PICout &	operator<< (short v)
	Output operator for `"short"` values.

PICout &	operator<< (ushort v)
	Output operator for `"unsigned short"` values.

PICout &	operator<< (int v)
	Output operator for `"int"` values.

PICout &	operator<< (uint v)
	Output operator for `"unsigned int"` values.

PICout &	operator<< (long v)
	Output operator for `"long"` values.

PICout &	operator<< (ulong v)
	Output operator for `"unsigned long"` values.

PICout &	operator<< (llong v)
	Output operator for `"long long"` values.

PICout &	operator<< (ullong v)
	Output operator for `"unsigned long long"` values.

PICout &	operator<< (float v)
	Output operator for `"float"` values.

PICout &	operator<< (double v)
	Output operator for `"double"` values.

PICout &	operator<< (ldouble v)
	Output operator for `"ldouble"` values.

PICout &	operator<< (const void *v)
	Output operator for pointers.

PICout &	operator<< (const PIObject *v)
	Output operator for PIObject and ancestors.

PICout &	operator<< (PICoutManipulators::PICoutSpecialChar v)
	Output operator for PICoutSpecialChar values.

PICout &	operator<< (PIFlags< PICoutManipulators::PICoutFormat > v)
	Output operator for PIFlags<PICoutFormat> values.

PICout &	operator<< (PICoutManipulators::PICoutFormat v)
	Output operator for PICoutFormat values.

PICout &	operator<< (PICoutManipulators::PICoutAction v)
	Do some action. More...

PICout &	setControl (PICoutManipulators::PICoutControl c, bool on=true)
	Set control flag "c" is "on" state.

PICout &	setControls (PICoutManipulators::PICoutControls c)
	Set control flags "c".

PICout &	saveAndSetControls (PICoutManipulators::PICoutControls c)
	Exec saveControls() and set control flags to "c".

PICout &	saveControls ()
	Save control flags to internal stack. More...

PICout &	restoreControls ()
	Restore control flags from internal stack. More...

PICout &	space ()
	Conditional put space character to output. More...

PICout &	quote ()
	Conditional put quote character to output. More...

PICout &	newLine ()
	Conditional put new line character to output. More...

PICout &	write (char c)
	Write char.

PICout &	write (const char *str)
	Write raw data.

PICout &	write (const char *str, int len)
	Write raw data.

PICout &	write (const PIString &s)
	Write raw PIString.

Static Public Member Functions
static void	stdoutPIString (const PIString &str, PICoutStdStream s=PICoutStdStream::StdOut)
	Output PIString to stdout.

static PIString	getBuffer ()
	Returns internal PIString buffer.

static PIString	getBufferAndClear ()
	Returns internal PIString buffer and clear it.

static void	clearBuffer ()
	Clear internal PIString buffer.

static bool	setOutputDevice (OutputDevice d, bool on=true)
	Set output to device "d" enabled "on". Returns if it was enabled.

static bool	enableOutputDevice (OutputDevice d)
	Turn on output device "d". Returns if it was enabled.

static bool	disableOutputDevice (OutputDevice d)
	Turn off output device "d". Returns if it was enabled.

static void	setOutputDevices (OutputDevices d)
	Set output to devices to "d".

static OutputDevices	currentOutputDevices ()
	Returns current output devices.

static bool	isOutputDeviceActive (OutputDevice d)
	Returns if output device "d" is active.

static PICout	withExternalBuffer (PIString *buffer, PIFlags< PICoutManipulators::PICoutControl > controls=PICoutManipulators::AddSpaces)
	Construct with external buffer.

static PICout	withExternalBufferAndID (PIString *buffer, int id, PIFlags< PICoutManipulators::PICoutControl > controls=PICoutManipulators::DefaultControls)
	Construct with external buffer and ID "id". See Notifier for details.

static int	registerExternalBufferID ()
	Returns unique external buffer ID for later use in withExternalBufferAndID()

Related Functions
(Note that these are not member functions.)
PICout	operator<< (PICout s, const PISystemMonitor::ThreadStats &v)
	Output operator to PICout.

template<typename T >
PICout	operator<< (PICout s, const PIDeque< T > &v)
	Output operator to PICout.

template<typename Key , typename Type >
PICout	operator<< (PICout s, const PIMap< Key, Type > &v)
	Output operator to PICout.

template<typename Type0 , typename Type1 >
PICout	operator<< (PICout s, const PIPair< Type0, Type1 > &v)
	Output operator to PICout.

template<typename T >
PICout	operator<< (PICout s, const PIVector< T > &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIBinaryLog::BinLogInfo &bi)
	Output operator PIBinaryLog::BinLogInfo to PICout.

PICout	operator<< (PICout s, const PIDir &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIFile::FileInfo &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PISerial::DeviceInfo &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIJSON &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PISystemInfo::MountInfo &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIConstChars &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIStringList &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PITime &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIDate &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIDateTime &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PINetworkAddress &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PISystemTime &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PISystemTime::Frequency &f)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIValueTree &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariant &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariantTypes::Enumerator &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariantTypes::Enum &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariantTypes::File &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariantTypes::Dir &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariantTypes::Color &v)
	Output operator to PICout.

PICout	operator<< (PICout s, const PIVariantTypes::IODevice &v)
	Output operator to PICout.

Detailed Description

Universal output to console class.

Synopsis

This class provide many stream operators for output with some features. Output to PICout is thread-sequential, i.e. doesn`t mixed from parallel threads.

Features

support text formatting (color, style)
insertion spaces between entries
insertion new line at the end of output
strings are quoted
custom output operator can be easily written
can outpur to console, internal buffer or both

Usage

using namespace PICoutManipulators;
int a = 10, b = 32, c = 11;
piCout << a << Hex << b << Bin << c;
// 10 20 1011
 
piCout << "this"
       << "is" << Green << "green" << Default << "word";
// this is green word
 
PICout(AddSpaces | AddNewLine | AddQuotes) << Tab << "tab and"
                                           << "quotes";
// "tab and" "quotes"

Writing your own output operator

inline PICout operator<<(PICout s, const PIByteArray & ba) {
    s.space();               // insert space after previous output
    s.quote();               // ONLY if you want to quoted your type
    s.saveAndSetControls(0); // clear all features and
    // save them to stack,
    // now it`s behavior similar to std::cout
 
    // your output
    for (uint i = 0; i < ba.size(); ++i)
        s << ba[i];
 
    s.restoreControls(); // restore features from stack
    s.quote();           // ONLY if you want to quoted your type
    return s;
}

Member Enumeration Documentation

◆ OutputDevice

enum PICout::OutputDevice

Enum contains output devices of PICout.

Enumerator
NoDevices	PICout is disabled
Console	Standard console output
Buffer	Internal buffer
AllDevices	All

Member Function Documentation

◆ operator<<()

PICout & PICout::operator<< ( PICoutManipulators::PICoutAction v )

Do some action.

TODO : wondows ClearScreen !!!

◆ saveControls()

PICout & PICout::saveControls ( )

Save control flags to internal stack.

See also: restoreControl()

◆ restoreControls()

PICout & PICout::restoreControls ( )

Restore control flags from internal stack.

See also: saveControl()

◆ space()

PICout & PICout::space ( )

Conditional put space character to output.

If it is not a first output and control AddSpaces is set space character is put

See also: quote(), newLine()

◆ quote()

PICout & PICout::quote ( )

Conditional put quote character to output.

If control AddQuotes is set quote character is put

See also: space(), newLine()

◆ newLine()

PICout & PICout::newLine ( )

Conditional put new line character to output.

If control AddNewLine is set new line character is put

See also: space(), quote()

Classes

Public Types

Public Member Functions

Static Public Member Functions

Related Functions