This class is used contain and manipulate gum::ParseError. More...

#include <agrum/tools/core/errorsContainer.h>

Public Attributes
Size	error_count
	Number of errors detected. More...

Size	warning_count

Public Member Functions
Class Constructor
	ErrorsContainer ()
	Class Constructor. More...

	ErrorsContainer (const ErrorsContainer &cont)
	Copy constructor. More...

Accessors / Modifiers
void	add (ParseError error)
	Add an error object to the container. More...

ParseError	error (Idx i) const
	Returns the i-th error. More...

ParseError	last () const
	Returns the last added error. More...

void	addError (const std::string &msg, const std::string &filename, Idx line, Idx col)
	Adds an error. More...

void	addWarning (const std::string &msg, const std::string &filename, Idx line, Idx col)
	Adds a warning. More...

void	addException (const std::string &msg, const std::string &filename)
	Add an exception. More...

Size	count () const
	Returns the number of errors and warnings. More...

void	syntheticResults (std::ostream &o) const
	Print errors on output stream. More...

void	simpleErrors (std::ostream &o) const
	Print errors on output stream. More...

void	simpleErrorsAndWarnings (std::ostream &o) const
	Print errors on output stream. More...

void	elegantErrors (std::ostream &o) const
	Print errors on output stream. More...

void	elegantErrorsAndWarnings (std::ostream &o) const
	Print errors on output stream. More...

Coco/R helpers
void	Error (const std::wstring &filename, Idx line, Idx col, const wchar_t *msg)
	For adding errors. More...

void	Warning (const std::wstring &filename, Idx line, Idx col, const wchar_t *msg)
	For adding warnings. More...

void	Exception (const std::wstring &filename, const wchar_t *msg)
	For adding exceptions. More...

Class operators
ErrorsContainer	operator+ (const ErrorsContainer &cont) const
	Return the sum of two gum::ErrorsContainer. More...

ErrorsContainer	operator= (const ErrorsContainer &cont)
	Copy Operator. More...

ErrorsContainer	operator+= (const ErrorsContainer &cont)
	Add the content of a gum::ErrorsContainer to this gum::ErrorsContainer. More...

Detailed Description

This class is used contain and manipulate gum::ParseError.

Definition at line 160 of file errorsContainer.h.

Constructor & Destructor Documentation

◆ ErrorsContainer() [1/2]

gum::ErrorsContainer::ErrorsContainer ( )

Class Constructor.

◆ ErrorsContainer() [2/2]

gum::ErrorsContainer::ErrorsContainer ( const ErrorsContainer & cont )

Copy constructor.

Parameters

cont	The ErrorsContainer to copy.

Member Function Documentation

◆ add()

INLINE void gum::ErrorsContainer::add ( ParseError error )

Add an error object to the container.

Parameters

error The gum::ParseError to add.

Definition at line 50 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                             {
     errors.push_back(error);
 
     if (error.is_error)
       error_count++;
     else
       warning_count++;
   }

Here is the call graph for this function:

◆ addError()

INLINE void gum::ErrorsContainer::addError	(	const std::string &	msg,
		const std::string &	filename,
		Idx	line,
		Idx	col
	)

Adds an error.

Parameters

msg	The error's message.
filename	The error's file.
line	The error's line.
col	The error's column.

Definition at line 60 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                          {
     add(ParseError(true, msg, filename, line, col));
   }

Here is the call graph for this function:

◆ addException()

INLINE void gum::ErrorsContainer::addException	(	const std::string &	msg,
		const std::string &	filename
	)

Add an exception.

Parameters

msg	The exception's message.
filename	The exception's file.

Definition at line 76 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                     {
     add(ParseError(true, msg, filename, 0, 0));
   }

Here is the call graph for this function:

◆ addWarning()

INLINE void gum::ErrorsContainer::addWarning	(	const std::string &	msg,
		const std::string &	filename,
		Idx	line,
		Idx	col
	)

Adds a warning.

Parameters

msg	The warning's message.
filename	The warning's file.
line	The warning's line.
col	The warning's column.

Definition at line 68 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                            {
     add(ParseError(false, msg, filename, line, col));
   }

Here is the call graph for this function:

◆ count()

INLINE Size gum::ErrorsContainer::count ( ) const

Returns the number of errors and warnings.

Returns: Returns the number of errors and warnings.

Definition at line 81 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

81 { return error_count + warning_count; }

gum::ErrorsContainer::error_count

Size error_count

Number of errors detected.

Definition: errorsContainer.h:166

gum::ErrorsContainer::warning_count

Size warning_count

Definition: errorsContainer.h:169

Here is the call graph for this function:

◆ elegantErrors()

void gum::ErrorsContainer::elegantErrors ( std::ostream & o ) const

Print errors on output stream.

Parameters

o	The output strem to send results.

◆ elegantErrorsAndWarnings()

void gum::ErrorsContainer::elegantErrorsAndWarnings ( std::ostream & o ) const

Print errors on output stream.

Parameters

o	The output strem to send results.

◆ error()

ParseError gum::ErrorsContainer::error ( Idx i ) const

Returns the i-th error.

Parameters

i	The error to return.

Returns: Returns the i-th error.

Exceptions

OutOfBounds Raised if there is less than i errors.

◆ Error()

INLINE void gum::ErrorsContainer::Error	(	const std::wstring &	filename,
		Idx	line,
		Idx	col,
		const wchar_t *	msg
	)

For adding errors.

Parameters

filename	The error's file.
line	The error's line.
col	The error's column.
msg	The error's message.

Definition at line 34 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                                {
     add(ParseError(true, narrow(std::wstring(msg)), narrow(filename), line, col));
   }

Here is the call graph for this function:

◆ Exception()

INLINE void gum::ErrorsContainer::Exception	(	const std::wstring &	filename,
		const wchar_t *	msg
	)

For adding exceptions.

Parameters

filename	The exception's file.
msg	The exception's message.

Definition at line 45 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                 {
     add(ParseError(true, "Exception : " + narrow(std::wstring(msg)), narrow(filename), 0, 0));
   }

Here is the call graph for this function:

◆ last()

ParseError gum::ErrorsContainer::last ( ) const

Returns the last added error.

Returns: Returns the last added error.

Exceptions

OutOfBounds Raised if is no error to return.

◆ operator+()

ErrorsContainer gum::ErrorsContainer::operator+ ( const ErrorsContainer & cont ) const

Return the sum of two gum::ErrorsContainer.

Parameters

cont	The gum::ErrorsContainer to add.

Returns: Return the sum of two gum::ErrorsContainer.

◆ operator+=()

ErrorsContainer gum::ErrorsContainer::operator+= ( const ErrorsContainer & cont )

Add the content of a gum::ErrorsContainer to this gum::ErrorsContainer.

Parameters

cont	The gum::ErrorsContainer to add to this.

Returns: Returns this gum::ErrorsContainer.

◆ operator=()

ErrorsContainer gum::ErrorsContainer::operator= ( const ErrorsContainer & cont )

Copy Operator.

Parameters

cont	The gum::ErrorsContainer to copy.

Returns: Returns this gum::ErrorsContainer.

◆ simpleErrors()

void gum::ErrorsContainer::simpleErrors ( std::ostream & o ) const

Print errors on output stream.

Parameters

o	The output strem to send results.

◆ simpleErrorsAndWarnings()

void gum::ErrorsContainer::simpleErrorsAndWarnings ( std::ostream & o ) const

Print errors on output stream.

Parameters

o	The output strem to send results.

◆ syntheticResults()

INLINE void gum::ErrorsContainer::syntheticResults ( std::ostream & o ) const

Print errors on output stream.

Parameters

o	The output strem to send results.

Definition at line 84 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
     o << "Errors : " << error_count << std::endl;
     o << "Warnings : " << warning_count << std::endl;
   }

Here is the call graph for this function:

◆ Warning()

INLINE void gum::ErrorsContainer::Warning	(	const std::wstring &	filename,
		Idx	line,
		Idx	col,
		const wchar_t *	msg
	)

For adding warnings.

Parameters

filename	The warning's file.
line	The warning's line.
col	The warning's column.
msg	The warning's message.

Definition at line 40 of file errorsContainer_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                                {
     add(ParseError(false, narrow(std::wstring(msg)), narrow(filename), line, col));
   }

Here is the call graph for this function:

Member Data Documentation

◆ error_count

Size gum::ErrorsContainer::error_count

Number of errors detected.

Definition at line 166 of file errorsContainer.h.

◆ errors

std::vector< ParseError > gum::ErrorsContainer::errors

mutableprivate

The list of gum::ParseError contained in this gum::ErrorsContainer.

Definition at line 162 of file errorsContainer.h.

◆ warning_count

Size gum::ErrorsContainer::warning_count

Definition at line 169 of file errorsContainer.h.

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

agrum/tools/core/errorsContainer.h
agrum/tools/core/errorsContainer_inl.h

Public Attributes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ErrorsContainer() [1/2]

◆ ErrorsContainer() [2/2]

Member Function Documentation

◆ add()

◆ addError()

◆ addException()

◆ addWarning()

◆ count()

◆ elegantErrors()

◆ elegantErrorsAndWarnings()

◆ error()

◆ Error()

◆ Exception()

◆ last()

◆ operator+()

◆ operator+=()

◆ operator=()

◆ simpleErrors()

◆ simpleErrorsAndWarnings()

◆ syntheticResults()

◆ Warning()

Member Data Documentation

◆ error_count

◆ errors

◆ warning_count