#include <Log.hh>

Inheritance diagram for CASM::Log:

Detailed Description

Definition at line 48 of file Log.hh.

Public Member Functions
	Log (std::ostream &_ostream=std::cout, int _verbosity=standard, bool _show_clock=false, int _indent_space=2)
	Construct a Log. More...

template<int _required_verbosity = standard>
void	calculate (const std::string &what)

template<int _required_verbosity = standard>
void	construct (const std::string &what)

template<int _required_verbosity = standard>
void	generate (const std::string &what)

template<int _required_verbosity = standard>
void	set (const std::string &what)

template<int _required_verbosity = standard>
void	check (const std::string &what)

template<int _required_verbosity = standard>
void	results (const std::string &what)

template<int _required_verbosity = standard>
void	read (const std::string &what)

template<int _required_verbosity = standard>
void	write (const std::string &what)

template<int _required_verbosity = standard>
void	begin (const std::string &what)

template<int _required_verbosity = standard>
void	end (const std::string &what)

template<int _required_verbosity = standard>
void	warning (const std::string &what)

template<int _required_verbosity = standard>
void	error (const std::string &what)

template<int _required_verbosity = standard>
void	compiling (const std::string &what)

template<int _required_verbosity = standard>
void	custom (const std::string &what)

template<int _required_verbosity = standard>
void	custom (const std::string &type, const std::string &what)

template<int _required_verbosity = standard>
void	begin_section ()
	Begin a section, without header. More...

Log &	subsection ()
	Create a subsection. More...

void	end_section ()
	End a section. More...

void	restart_clock ()

void	show_clock ()

void	hide_clock ()

double	time_s () const

void	begin_lap ()

double	lap_time () const

int	verbosity () const

void	set_verbosity (int _verbosity)

template<int _required_verbosity>
Log &	require ()

void	reset (std::ostream &_ostream=std::cout)

void	set_width (int width)

int	width () const

void	set_justification (JustificationType justification)

JustificationType	justification ()

Log &	paragraph (std::string text)
	Print indented paragraph with wrapping at Log::width() More...

Log &	verbatim (std::string text, bool indent_first_line=true)
	Print verbatim, but with indentation (optional on first line) More...

template<typename OutputIterator >
Log &	verbatim_list (OutputIterator begin, OutputIterator end, std::string sep="- ")
	Print a list. More...

	operator std::ostream & ()

std::ostream &	ostream ()

bool	print () const

	operator bool ()

int	indent_space () const

std::string	indent_str () const

void	increase_indent ()

void	decrease_indent ()

void	increase_indent_spaces (int n)

void	decrease_indent_spaces (int n)

Log &	indent ()

template<typename T >
Log &	indent (const T &t)
	Same as verbatim, but uses stringstream to convert to string first. More...

Static Public Member Functions
static std::string	invalid_verbosity_msg (std::string s)

static std::pair< bool, int >	verbosity_level (std::string s)
	Read verbosity level from a string. More...

Static Public Attributes
static const int	none = 0

static const int	quiet = 5

static const int	standard = 10

static const int	verbose = 20

static const int	debug = 100

Private Member Functions
template<int _required_verbosity = standard>
void	_add (const std::string &type, const std::string &what)

void	_print_justified_line (std::vector< std::string > &line, int curr_width)

void	_print_left_justified_line (std::vector< std::string > &line, int curr_width)

void	_print_right_justified_line (std::vector< std::string > &line, int curr_width)

void	_print_center_justified_line (std::vector< std::string > &line, int curr_width)

void	_print_full_justified_line (std::vector< std::string > &line, int curr_width)

void	_add_time ()

bool	_print () const

Private Attributes
std::vector< int >	m_required_verbosity

int	m_verbosity
	If m_verbosity >= required verbosity, then print. More...

bool	m_print
	Whether to print. More...

bool	m_show_clock

int	m_indent_space
	indent_str = m_indent_space*m_indent_level + m_indent_spaces More...

int	m_indent_level

int	m_indent_spaces

int	m_paragraph_width

JustificationType	m_justification

boost::chrono::steady_clock::time_point	m_start_time

boost::chrono::steady_clock::time_point	m_lap_start_time

std::ostream *	m_ostream

Friends
template<typename T >
Log &	operator<< (Log &log, const T &msg_details)

Log &	operator<< (Log &log, std::ostream &(*fptr)(std::ostream &))

Constructor & Destructor Documentation

◆ Log()

CASM::Log::Log	(	std::ostream &	_ostream = `std::cout`,
		int	_verbosity = `standard`,
		bool	_show_clock = `false`,
		int	_indent_space = `2`
	)

Construct a Log.

Parameters

ostream	The stream to print to
verbosity	The amount to be printed

For verbosity:

0: print nothing
10: print all standard output
100: print all possible output

Definition at line 22 of file Log.cc.

Member Function Documentation

◆ _add()

template<int _required_verbosity = standard>

void CASM::Log::_add	(	const std::string &	type,
		const std::string &	what
	)

inlineprivate

Definition at line 309 of file Log.hh.

◆ _add_time()

void CASM::Log::_add_time ( )

private

Definition at line 262 of file Log.cc.

◆ _print()

bool CASM::Log::_print ( ) const

private

Definition at line 268 of file Log.cc.

◆ _print_center_justified_line()

void CASM::Log::_print_center_justified_line	(	std::vector< std::string > &	line,
		int	curr_width
	)

private

Definition at line 126 of file Log.cc.

◆ _print_full_justified_line()

void CASM::Log::_print_full_justified_line	(	std::vector< std::string > &	line,
		int	curr_width
	)

private

Definition at line 142 of file Log.cc.

◆ _print_justified_line()

void CASM::Log::_print_justified_line	(	std::vector< std::string > &	line,
		int	curr_width
	)

private

Definition at line 81 of file Log.cc.

◆ _print_left_justified_line()

void CASM::Log::_print_left_justified_line	(	std::vector< std::string > &	line,
		int	curr_width
	)

private

Definition at line 98 of file Log.cc.

◆ _print_right_justified_line()

void CASM::Log::_print_right_justified_line	(	std::vector< std::string > &	line,
		int	curr_width
	)

private

Definition at line 110 of file Log.cc.

◆ begin()

template<int _required_verbosity = standard>

void CASM::Log::begin ( const std::string & what )

inline

Definition at line 114 of file Log.hh.

◆ begin_lap()

void CASM::Log::begin_lap ( )

Definition at line 47 of file Log.cc.

◆ begin_section()

template<int _required_verbosity = standard>

void CASM::Log::begin_section ( )

inline

Begin a section, without header.

Definition at line 158 of file Log.hh.

◆ calculate()

template<int _required_verbosity = standard>

void CASM::Log::calculate ( const std::string & what )

inline

Definition at line 74 of file Log.hh.

◆ check()

template<int _required_verbosity = standard>

void CASM::Log::check ( const std::string & what )

inline

Definition at line 94 of file Log.hh.

◆ compiling()

template<int _required_verbosity = standard>

void CASM::Log::compiling ( const std::string & what )

inline

Definition at line 134 of file Log.hh.

◆ construct()

template<int _required_verbosity = standard>

void CASM::Log::construct ( const std::string & what )

inline

Definition at line 79 of file Log.hh.

◆ custom() [1/2]

template<int _required_verbosity = standard>

void CASM::Log::custom	(	const std::string &	type,
		const std::string &	what
	)

inline

Definition at line 152 of file Log.hh.

◆ custom() [2/2]

template<int _required_verbosity = standard>

void CASM::Log::custom ( const std::string & what )

inline

Definition at line 139 of file Log.hh.

◆ decrease_indent()

void CASM::Log::decrease_indent ( )

inline

Definition at line 279 of file Log.hh.

◆ decrease_indent_spaces()

void CASM::Log::decrease_indent_spaces ( int n )

inline

Definition at line 287 of file Log.hh.

◆ end()

template<int _required_verbosity = standard>

void CASM::Log::end ( const std::string & what )

inline

Definition at line 119 of file Log.hh.

◆ end_section()

void CASM::Log::end_section ( )

inline

End a section.

Definition at line 192 of file Log.hh.

◆ error()

template<int _required_verbosity = standard>

void CASM::Log::error ( const std::string & what )

inline

Definition at line 129 of file Log.hh.

◆ generate()

template<int _required_verbosity = standard>

void CASM::Log::generate ( const std::string & what )

inline

Definition at line 84 of file Log.hh.

◆ hide_clock()

void CASM::Log::hide_clock ( )

Definition at line 39 of file Log.cc.

◆ increase_indent()

void CASM::Log::increase_indent ( )

inline

Definition at line 277 of file Log.hh.

◆ increase_indent_spaces()

void CASM::Log::increase_indent_spaces ( int n )

inline

Definition at line 285 of file Log.hh.

◆ indent() [1/2]

Log& CASM::Log::indent ( )

inline

Definition at line 289 of file Log.hh.

◆ indent() [2/2]

template<typename T >

Log& CASM::Log::indent ( const T & t )

inline

Same as verbatim, but uses stringstream to convert to string first.

Definition at line 296 of file Log.hh.

◆ indent_space()

int CASM::Log::indent_space ( ) const

inline

Definition at line 271 of file Log.hh.

◆ indent_str()

std::string CASM::Log::indent_str ( ) const

inline

Definition at line 273 of file Log.hh.

◆ invalid_verbosity_msg()

std::string CASM::Log::invalid_verbosity_msg ( std::string s )

static

Definition at line 219 of file Log.cc.

◆ justification()

JustificationType CASM::Log::justification ( )

inline

Definition at line 240 of file Log.hh.

◆ lap_time()

double CASM::Log::lap_time ( ) const

Definition at line 49 of file Log.cc.

◆ operator bool()

CASM::Log::operator bool ( )

inlineexplicit

Definition at line 266 of file Log.hh.

◆ operator std::ostream &()

CASM::Log::operator std::ostream & ( )

Definition at line 217 of file Log.cc.

◆ ostream()

std::ostream& CASM::Log::ostream ( )

inline

Definition at line 262 of file Log.hh.

◆ paragraph()

Log & CASM::Log::paragraph ( std::string text )

Print indented paragraph with wrapping at Log::width()

Definition at line 168 of file Log.cc.

◆ print()

bool CASM::Log::print ( ) const

Definition at line 260 of file Log.cc.

◆ read()

template<int _required_verbosity = standard>

void CASM::Log::read ( const std::string & what )

inline

Definition at line 104 of file Log.hh.

◆ require()

template<int _required_verbosity>

Log& CASM::Log::require ( )

inline

Definition at line 221 of file Log.hh.

◆ reset()

void CASM::Log::reset ( std::ostream & _ostream = std::cout )

Definition at line 59 of file Log.cc.

◆ restart_clock()

void CASM::Log::restart_clock ( )

Definition at line 35 of file Log.cc.

◆ results()

template<int _required_verbosity = standard>

void CASM::Log::results ( const std::string & what )

inline

Definition at line 99 of file Log.hh.

◆ set()

template<int _required_verbosity = standard>

void CASM::Log::set ( const std::string & what )

inline

Definition at line 89 of file Log.hh.

◆ set_justification()

void CASM::Log::set_justification ( JustificationType justification )

inline

Definition at line 236 of file Log.hh.

◆ set_verbosity()

void CASM::Log::set_verbosity ( int _verbosity )

Definition at line 57 of file Log.cc.

◆ set_width()

void CASM::Log::set_width ( int width )

inline

Definition at line 232 of file Log.hh.

◆ show_clock()

void CASM::Log::show_clock ( )

Definition at line 37 of file Log.cc.

◆ subsection()

Log& CASM::Log::subsection ( )

inline

Create a subsection.

Note creates a subsection, but remembers the previous section, so that when 'end_section' is called the previous section's verbosity level becomes active again.

Example:

log.begin("Section A");
log << stuff << std::endl;
log << std::endl;
 
log.increase_indent();
log.subsection().begin("Section A.1");
log << indent_str() << subsection_stuff << std::endl;
log << std::endl;
log.end_section();
log.decrease_indent();
 
log << "continue in section A" << std::endl;
log << std::endl;

Definition at line 186 of file Log.hh.

◆ time_s()

double CASM::Log::time_s ( ) const

Definition at line 41 of file Log.cc.

◆ verbatim()

Log & CASM::Log::verbatim	(	std::string	text,
		bool	indent_first_line = `true`
	)

Print verbatim, but with indentation (optional on first line)

Definition at line 201 of file Log.cc.

◆ verbatim_list()

template<typename OutputIterator >

Log & CASM::Log::verbatim_list	(	OutputIterator	begin,
		OutputIterator	end,
		std::string	sep = `"- "`
	)

Print a list.

Prints each element in vector to a stringstream, then uses Log::verbatim to print into the list.
Indentation is set to the length of the "sep" string

Example, with initial indent of 2 spaces, and sep="-- ":

A list:
  -- first value
  -- some value
     that prints
     on multiple lines
  -- last value

Definition at line 377 of file Log.hh.

◆ verbosity()

int CASM::Log::verbosity ( ) const

Definition at line 55 of file Log.cc.

◆ verbosity_level()

std::pair< bool, int > CASM::Log::verbosity_level ( std::string s )

static

Read verbosity level from a string.

Returns: result, a pair of bool,int result.first == true if successfully read, and result.second is the verbosity level

Definition at line 231 of file Log.cc.

◆ warning()

template<int _required_verbosity = standard>

void CASM::Log::warning ( const std::string & what )

inline

Definition at line 124 of file Log.hh.

◆ width()

int CASM::Log::width ( ) const

inline

Definition at line 234 of file Log.hh.

◆ write()

template<int _required_verbosity = standard>

void CASM::Log::write ( const std::string & what )

inline

Definition at line 109 of file Log.hh.

Friends And Related Function Documentation

◆ operator<< [1/2]

template<typename T >

Log& operator<<	(	Log &	log,
		const T &	msg_details
	)

friend

Definition at line 394 of file Log.hh.

◆ operator<< [2/2]

Log& operator<<	(	Log &	log,
		std::ostream &(*)(std::ostream &)	fptr
	)

friend

Definition at line 270 of file Log.cc.

Member Data Documentation

◆ debug

const int CASM::Log::debug = 100

static

Definition at line 54 of file Log.hh.

◆ m_indent_level

int CASM::Log::m_indent_level

private

Definition at line 347 of file Log.hh.

◆ m_indent_space

int CASM::Log::m_indent_space

private

indent_str = m_indent_space*m_indent_level + m_indent_spaces

Definition at line 346 of file Log.hh.

◆ m_indent_spaces

int CASM::Log::m_indent_spaces

private

Definition at line 348 of file Log.hh.

◆ m_justification

JustificationType CASM::Log::m_justification

private

Definition at line 352 of file Log.hh.

◆ m_lap_start_time

boost::chrono::steady_clock::time_point CASM::Log::m_lap_start_time

private

Definition at line 356 of file Log.hh.

◆ m_ostream

std::ostream* CASM::Log::m_ostream

private

Definition at line 358 of file Log.hh.

◆ m_paragraph_width

int CASM::Log::m_paragraph_width

private

Definition at line 351 of file Log.hh.

◆ m_print

bool CASM::Log::m_print

private

Whether to print.

Definition at line 341 of file Log.hh.

◆ m_required_verbosity

std::vector<int> CASM::Log::m_required_verbosity

private

Definition at line 335 of file Log.hh.

◆ m_show_clock

bool CASM::Log::m_show_clock

private

Definition at line 343 of file Log.hh.

◆ m_start_time

boost::chrono::steady_clock::time_point CASM::Log::m_start_time

private

Definition at line 354 of file Log.hh.

◆ m_verbosity

int CASM::Log::m_verbosity

private

If m_verbosity >= required verbosity, then print.

Definition at line 338 of file Log.hh.

◆ none

const int CASM::Log::none = 0

static

Definition at line 50 of file Log.hh.

◆ quiet

const int CASM::Log::quiet = 5

static

Definition at line 51 of file Log.hh.

◆ standard

const int CASM::Log::standard = 10

static

Definition at line 52 of file Log.hh.

◆ verbose

const int CASM::Log::verbose = 20

static

Definition at line 53 of file Log.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/casm_io/Log.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/casm_io/Log.cc

Detailed Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ Log()

Member Function Documentation

◆ _add()

◆ _add_time()

◆ _print()

◆ _print_center_justified_line()

◆ _print_full_justified_line()

◆ _print_justified_line()

◆ _print_left_justified_line()

◆ _print_right_justified_line()

◆ begin()

◆ begin_lap()

◆ begin_section()

◆ calculate()

◆ check()

◆ compiling()

◆ construct()

◆ custom() [1/2]

◆ custom() [2/2]

◆ decrease_indent()

◆ decrease_indent_spaces()

◆ end()

◆ end_section()

◆ error()

◆ generate()

◆ hide_clock()

◆ increase_indent()

◆ increase_indent_spaces()

◆ indent() [1/2]

◆ indent() [2/2]

◆ indent_space()

◆ indent_str()

◆ invalid_verbosity_msg()

◆ justification()

◆ lap_time()

◆ operator bool()

◆ operator std::ostream &()

◆ ostream()

◆ paragraph()

◆ print()

◆ read()

◆ require()

◆ reset()

◆ restart_clock()

◆ results()

◆ set()

◆ set_justification()

◆ set_verbosity()

◆ set_width()

◆ show_clock()

◆ subsection()

◆ time_s()

◆ verbatim()

◆ verbatim_list()

◆ verbosity()

◆ verbosity_level()

◆ warning()

◆ width()

◆ write()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ debug

◆ m_indent_level

◆ m_indent_space

◆ m_indent_spaces

◆ m_justification

◆ m_lap_start_time

◆ m_ostream

◆ m_paragraph_width

◆ m_print