lsst.pex::policy::SyntaxError Class Reference

an exception thrown because a general syntax error was encountered. More...

#include <parserexceptions.h>

Inheritance diagram for lsst.pex::policy::SyntaxError:

Public Member Functions
	SyntaxError (POL_EARGS_TYPED)
	Create an exception the exception with a default message. More...
	SyntaxError (POL_EARGS_TYPED, const std::string &msg)
	Create an exception the exception with a given message. More...
	SyntaxError (POL_EARGS_TYPED, const std::string &msg, int lineno)
	Create an exception the exception with a given message. More...
virtual char const *	getType () const throw ()
	Return the fully-specified C++ type of a pointer to the exception. More...
virtual lsst::pex::exceptions::Exception *	clone () const
	Return a copy of the exception as an Exception pointer. More...
void	addMessage (char const *file, int line, char const *func, std::string const &message)
	Add a tracepoint and a message to an exception before rethrowing it (access via LSST_EXCEPT_ADD). More...
Traceback const &	getTraceback (void) const noexcept
	Retrieve the list of tracepoints associated with an exception. More...
virtual std::ostream &	addToStream (std::ostream &stream) const
	Add a text representation of this exception, including its traceback with messages, to a stream. More...
virtual char const *	what (void) const noexcept
	Return a character string summarizing this exception. More...
T	what (T... args)

Static Public Member Functions
static std::string	makeLocatedMessage (const std::string &msg, int lineno)

Detailed Description

an exception thrown because a general syntax error was encountered.

Definition at line 124 of file parserexceptions.h.

Constructor & Destructor Documentation

SyntaxError() [1/3]

lsst.pex::policy::SyntaxError::SyntaxError ( POL_EARGS_TYPED  )

inline

Create an exception the exception with a default message.

Definition at line 129 of file parserexceptions.h.

: ParserError(POL_EARGS_UNTYPED, "Unknonwn syntax error") {}

SyntaxError() [2/3]

lsst.pex::policy::SyntaxError::SyntaxError ( POL_EARGS_TYPED  , const std::string &  msg  )

inline

Create an exception the exception with a given message.

Parameters

msg	a message describing the problem.

Definition at line 135 of file parserexceptions.h.

: ParserError(POL_EARGS_UNTYPED, msg) {}

SyntaxError() [3/3]

lsst.pex::policy::SyntaxError::SyntaxError ( POL_EARGS_TYPED  , const std::string &  msg, int  lineno  )

inline

Create an exception the exception with a given message.

Parameters

msg	a message describing the problem.
lineno	a line number in the file (or stream) being parsed where the problem occurred. The first line of the file is typically line 1.

Definition at line 144 of file parserexceptions.h.

            : ParserError(POL_EARGS_UNTYPED, msg, lineno) {}

Member Function Documentation

addMessage()

void Exception::addMessage ( char const *  file, int  line, char const *  func, std::string const &  message  )

inherited

Add a tracepoint and a message to an exception before rethrowing it (access via LSST_EXCEPT_ADD).

Parameters

[in]	file	Filename (automatically passed in by macro).
[in]	line	Line number (automatically passed in by macro).
[in]	func	Function name (automatically passed in by macro).
[in]	message	Additional message to associate with this rethrow.

Definition at line 49 of file Exception.cc.

                                                                                                 {
    std::ostringstream stream;
    stream << _message;
    if (_traceback.empty()) {
        // This means the message-only constructor was used, which should only happen
        // from Python...but this method isn't accessible from Python, so maybe
        // this Exception was thrown in Python, then passed back to C++.  Or, more
        // likely, someone didn't read the warning and threw this exception in C++
        // without using LSST_EXCEPT.
        // But, because we don't have a traceback for that first message, we can't
        // add one here without messing up the stringification logic later.  Since
        // this is a rare case (and should be considered a bug, but we don't want
        // exception code throwing its own exceptions unless it absolutely has to),
        // we'll proceed by just appending the message and ignoring the traceback.
        stream << "; " << message;
    } else {
        if (_traceback.size() == static_cast<std::size_t>(1)) {
            // The original message doesn't have an index (because it's faster,
            // and there's no need if there's only one), so when we add the second,
            // we have to give it an index.
            stream << " {0}; ";
        } else {
            stream << "; ";
        }
        stream << message << " {" << _traceback.size() << "}";
        _traceback.push_back(Tracepoint(file, line, func, message));
    }
    _message = stream.str();
}

addToStream()

std::ostream & Exception::addToStream ( std::ostream &  stream ) const

virtualinherited

Add a text representation of this exception, including its traceback with messages, to a stream.

Parameters

[in]

stream

Reference to an output stream.

Returns

Reference to the output stream after adding the text.

Definition at line 81 of file Exception.cc.

                                                           {
    if (_traceback.empty()) {
        // The exception was raised in Python, so we don't include the traceback, the type, or any
        // newlines, because Python will print those itself.
        stream << _message;
    } else {
        stream << std::endl;  // Start with a newline to separate our stuff from Pythons "<type>: " prefix.
        for (std::size_t i = 0; i != _traceback.size(); ++i) {
            stream << "  File \"" << _traceback[i]._file << "\", line " << _traceback[i]._line << ", in "
                   << _traceback[i]._func << std::endl;
            stream << "    " << _traceback[i]._message << " {" << i << "}" << std::endl;
        }
        std::string type(getType(), 0, std::strlen(getType()) - 2);
        stream << type << ": '" << _message << "'" << std::endl;
    }
    return stream;
}

clone()

virtual lsst::pex::exceptions::Exception* lsst.pex::policy::SyntaxError::clone ( ) const

virtual

Return a copy of the exception as an Exception pointer.

Can be overridden by derived classes that add data or methods.

Returns

Pointer to a copy of the exception.

Reimplemented from lsst.pex::policy::ParserError.

Reimplemented in lsst.pex::policy::UnsupportedSyntax, and lsst.pex::policy::FormatSyntaxError.

getTraceback()

Traceback const & Exception::getTraceback ( void  ) const

noexceptinherited

Retrieve the list of tracepoints associated with an exception.

Definition at line 79 of file Exception.cc.

{ return _traceback; }

getType()

virtual char const* lsst.pex::policy::SyntaxError::getType ( ) const throw ( )

virtual

Return the fully-specified C++ type of a pointer to the exception.

This is overridden by derived classes (automatically if the LSST_EXCEPTION_TYPE macro is used). It is used by the Python interface.

Returns

String with the C++ type; does not need to be freed/deleted.

Reimplemented from lsst.pex::policy::ParserError.

Reimplemented in lsst.pex::policy::UnsupportedSyntax, and lsst.pex::policy::FormatSyntaxError.

makeLocatedMessage()

static std::string lsst.pex::policy::ParserError::makeLocatedMessage ( const std::string &  msg, int  lineno  )

inlinestaticinherited

Definition at line 72 of file parserexceptions.h.

                                                                          {
        std::ostringstream out;
        out << "Policy Parsing Error:" << lineno << ": " << msg << std::ends;
        return out.str();
    }

what()

char const * Exception::what ( void  ) const

virtualnoexceptinherited

Return a character string summarizing this exception.

This combines all the messages added to the exception, but not the type or traceback (use the stream operator to get this more detailed information).

Not allowed to throw any exceptions.

Returns

String representation; does not need to be freed/deleted.

Definition at line 99 of file Exception.cc.

{ return _message.c_str(); }

---

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

• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_policy/20.0.0-1-gb058bd0+46a6078777/include/lsst/pex/policy/parserexceptions.h