LogConnectionConsole Class Reference

Implements a log connection to an IO Stream. More...

#include <LogConnectionConsole.h>

Inheritance diagram for LogConnectionConsole:

Collaboration diagram for LogConnectionConsole:

Public Member Functions
	LogConnectionConsole (int outputFD, bool color)
	Constructor.
	LogConnectionConsole (int outputFD)
	Constructor which automatically enables color if the file descriptor is a terminal and supports colors.
	~LogConnectionConsole () override
	Destructor.
bool	sendMessage (const LogMessage &message) override
	Sends a log message.
void	write (const std::string &message)
	Send a preformatted string message to the connected output.
bool	isConnected () override
	Returns true if the connection to the io stream could be established.
void	finalizeOnAbort () override
	Make sure output is flushed on abort.

Static Public Member Functions
static bool	terminalSupportsColors (int fileDescriptor)
	Returns true if the given file descriptor is a tty and supports colors.
static bool	getPythonLoggingEnabled ()
	Check whether console logging via python is enabled.
static void	setPythonLoggingEnabled (bool enabled)
	Set whether console logging via pyhthon is enabled.
static bool	getEscapeNewlinesEnabled ()
	Check whether we want to escape newlines on console.
static void	setEscapeNewlinesEnabled (bool enabled)
	Set whether we want to escape newlines on console.

Private Attributes
int	m_fd
	The output stream used for sending the log message.
bool	m_color
	Flag for color output.

Static Private Attributes
static bool	s_pythonLoggingEnabled {false}
	Flag to indicate whether log messages should be sent to python sys.stdout.
static bool	s_escapeNewlinesEnabled {false}
	Flag to indicate whether newlines should be replaced by ' ' in the output.

Detailed Description

Implements a log connection to an IO Stream.

Inherits from the abstract base class LogConnectionBase.

Definition at line 24 of file LogConnectionConsole.h.

Constructor & Destructor Documentation

LogConnectionConsole() [1/2]

LogConnectionConsole	(	int	outputFD,
		bool	color
	)

Constructor.

Parameters

outputFD	The output file descriptor to write to
color	whether color should be used for output

Definition at line 23 of file LogConnectionConsole.cc.

                                                                  :
  m_fd(dup(outputFD)), m_color(color)
{
  // check fd
  if (m_fd < 0) throw std::runtime_error(std::string("Error duplicating file descriptor: ") + std::strerror(errno));
}

LogConnectionConsole() [2/2]

LogConnectionConsole ( int  outputFD )

inlineexplicit

Constructor which automatically enables color if the file descriptor is a terminal and supports colors.

Parameters

outputFD

The output file descriptor to write to.

Definition at line 35 of file LogConnectionConsole.h.

: LogConnectionConsole(outputFD, terminalSupportsColors(outputFD)) {}

~LogConnectionConsole()

~LogConnectionConsole ( )

override

Destructor.

Definition at line 30 of file LogConnectionConsole.cc.

{
  if (m_fd > 0) close(m_fd);
}

Member Function Documentation

finalizeOnAbort()

void finalizeOnAbort ( )

overridevirtual

Make sure output is flushed on abort.

Reimplemented from LogConnectionBase.

Definition at line 98 of file LogConnectionConsole.cc.

{
  // If python logging is enabled we need to give jupyter some time to flush
  // the output as this happens only in the output thread. Seems flushing again is fine :D
  if (LogConnectionConsole::getPythonLoggingEnabled()) {
    boost::python::import("sys").attr("stdout").attr("flush")();
  }
}

getEscapeNewlinesEnabled()

static bool getEscapeNewlinesEnabled ( )

inlinestatic

Check whether we want to escape newlines on console.

Definition at line 60 of file LogConnectionConsole.h.

{ return s_escapeNewlinesEnabled; }

getPythonLoggingEnabled()

static bool getPythonLoggingEnabled ( )

inlinestatic

Check whether console logging via python is enabled.

Definition at line 56 of file LogConnectionConsole.h.

{ return s_pythonLoggingEnabled; }

isConnected()

bool isConnected ( )

overridevirtual

Returns true if the connection to the io stream could be established.

Implements LogConnectionBase.

Definition at line 35 of file LogConnectionConsole.cc.

{
  return s_pythonLoggingEnabled || m_fd >= 0;
}

sendMessage()

bool sendMessage ( const LogMessage &  message )

overridevirtual

Sends a log message.

Parameters

message

The log message object.

Returns

true if the message could be send.

Implements LogConnectionBase.

Definition at line 64 of file LogConnectionConsole.cc.

{
  if (!isConnected()) return false;
  // format message
  std::stringstream stream;
  if (m_color) {
    const std::string color_str[] = {
      "\x1b[32m",        // Debug  : green
      "",                // Info   : terminal default
      "\x1b[34m",        // Result : blue
      "\x1b[33m",        // Warning: yellow
      "\x1b[31m",        // Error  : red
      "\x1b[07m\x1b[31m" // Fatal  : red reversed
    };
    const std::string& c{color_str[message.getLogLevel()]};
    stream << c;
  }
  stream << message;
  std::string messagestr = stream.str();
  if (s_escapeNewlinesEnabled) {
    // remove trailing whitespace
    boost::trim_right_if(messagestr, boost::is_any_of(" \t\n\r"));
    // escape all remaining newlines
    boost::replace_all(messagestr, "\n", "\\n");
    // and make sure we end in an actual newline
    messagestr += "\n";
  }
  if (m_color) {
    messagestr += "\x1b[m";
  }
  write(messagestr);
  return true;
}

setEscapeNewlinesEnabled()

static void setEscapeNewlinesEnabled ( bool  enabled )

inlinestatic

Set whether we want to escape newlines on console.

Definition at line 62 of file LogConnectionConsole.h.

{ s_escapeNewlinesEnabled = enabled; }

setPythonLoggingEnabled()

static void setPythonLoggingEnabled ( bool  enabled )

inlinestatic

Set whether console logging via pyhthon is enabled.

Definition at line 58 of file LogConnectionConsole.h.

{ s_pythonLoggingEnabled = enabled; }

terminalSupportsColors()

bool terminalSupportsColors ( int  fileDescriptor )

static

Returns true if the given file descriptor is a tty and supports colors.

Definition at line 40 of file LogConnectionConsole.cc.

{
  //enable color for TTYs with color support (list taken from gtest)
  const bool isTTY = isatty(fileDescriptor);
  const std::string termName = getenv("TERM") ? getenv("TERM") : "";
  const bool useColor = isTTY and
                        (termName == "xterm" or termName == "xterm-color" or termName == "xterm-256color" or
                         termName == "sceen" or termName == "screen-256color" or termName == "tmux" or
                         termName == "tmux-256color" or termName == "rxvt-unicode" or
                         termName == "rxvt-unicode-256color" or termName == "linux" or termName == "cygwin");
  return useColor;
}

write()

void write

(

const std::string &

message

)

Send a preformatted string message to the connected output.

Definition at line 53 of file LogConnectionConsole.cc.

{
  if (s_pythonLoggingEnabled) {
    auto pymessage = boost::python::import("sys").attr("stdout");
    pymessage.attr("write")(message);
    pymessage.attr("flush")();
  } else {
    ::write(m_fd, message.data(), message.size());
  }
}

Member Data Documentation

m_color

bool m_color

private

Flag for color output.

Definition at line 67 of file LogConnectionConsole.h.

m_fd

int m_fd

private

The output stream used for sending the log message.

Definition at line 66 of file LogConnectionConsole.h.

s_escapeNewlinesEnabled

bool s_escapeNewlinesEnabled {false}

staticprivate

Flag to indicate whether newlines should be replaced by '
' in the output.

Definition at line 69 of file LogConnectionConsole.h.

s_pythonLoggingEnabled

bool s_pythonLoggingEnabled {false}

staticprivate

Flag to indicate whether log messages should be sent to python sys.stdout.

Definition at line 68 of file LogConnectionConsole.h.

---

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

• framework/logging/include/LogConnectionConsole.h
• framework/logging/src/LogConnectionConsole.cc