A UserException is-an XQueryException for errors raised via fn:error(). More...

#include <zorba/user_exception.h>

Inheritance diagram for zorba::UserException:

Collaboration diagram for zorba::UserException:

Public Types
typedef internal::diagnostic::location::column_type	column_type

typedef internal::error_object_type	error_object_type

typedef internal::diagnostic::location::line_type	line_type

enum	print_format { format_text = 0, format_xml = 1, format_xml_indented = 3 }
	The format to print exceptions as to an ostream. More...

enum	print_trace { trace, no_trace }
	Whether to include the XQuery stack trace for the XQueryException that's printed to an ostream. More...

Public Member Functions
column_type	applied_column () const throw ()
	Gets the XQuery source-code "applied at" column number containing the error. More...

column_type	applied_column_end () const throw ()
	Gets the XQuery source-code "applied at" end column number containing the error. More...

line_type	applied_line () const throw ()
	Gets the XQuery source-code "applied at" line number containing the error. More...

line_type	applied_line_end () const throw ()
	Gets the XQuery source-code "applied at" end line number containing the error. More...

char const *	applied_uri () const throw ()
	Gets the XQuery source-code "applied at" URI containing the error. More...

column_type	data_column () const throw ()
	Gets the data column number containing the error. More...

column_type	data_column_end () const throw ()
	Gets the data end column number containing the error. More...

line_type	data_line () const throw ()
	Gets the data line number containing the error. More...

line_type	data_line_end () const throw ()
	Gets the data end line number containing the error. More...

char const *	data_uri () const throw ()
	Gets the data URI containing the error. More...

Diagnostic const &	diagnostic () const throw ()
	Gets the diagnostic carried by this exception. More...

error_object_type const &	error_object () const throw ()
	Gets the error object associated with this exception. More...

bool	has_applied () const throw ()
	Checks whether the XQuery "applied at" location has been set. More...

bool	has_data () const throw ()
	Checks whether the XQuery data location has been set. More...

bool	has_source () const throw ()
	Checks whether the XQuery source-code location has been set. More...

UserException &	operator= (UserException const &from)
	Assigns this UserException from another. More...

void	polymorphic_throw () const
	Throws itself polymorphically; see http://www.parashift.com/c++-faq-lite/exceptions.html#faq-17.16. More...

XQueryStackTrace &	query_trace () throw ()
	Gets the XQuery stack trace, if any. More...

XQueryStackTrace const &	query_trace () const throw ()
	Gets the XQuery stack trace, if any. More...

char const *	raise_file () const throw ()
	Gets the C++ source-code file name whence this exception was raised. More...

line_type	raise_line () const throw ()
	Gets the C++ source-code line number whence this exception was raised. More...

void	set_applied (char const *uri, line_type line, column_type column=0, line_type line_end=0, column_type column_end=0)
	Sets the XQuery source-code "applied at" URI name, line, and column numbers. More...

void	set_data (char const *uri, line_type line, column_type column=0, line_type line_end=0, column_type column_end=0)
	Sets the XQuery source-code data URI name, line, and column numbers. More...

void	set_diagnostic (Diagnostic const &diagnostic) throw ()
	Sets the diagnostic. More...

void	set_source (char const *uri, line_type line, column_type column=0, line_type line_end=0, column_type column_end=0)
	Sets the XQuery source-code URI name, line, and column numbers. More...

column_type	source_column () const throw ()
	Gets the XQuery source-code column number containing the error. More...

column_type	source_column_end () const throw ()
	Gets the XQuery source-code end column number containing the error. More...

line_type	source_line () const throw ()
	Gets the XQuery source-code line number containing the error. More...

line_type	source_line_end () const throw ()
	Gets the XQuery source-code end line number containing the error. More...

char const *	source_uri () const throw ()
	Gets the XQuery source-code URI containing the error. More...

	UserException (UserException const &from)
	Copy-constructs a UserException. More...

char const *	what () const throw ()

	~UserException () throw ()
	Destroys this UserException. More...

Static Public Member Functions
static print_format	get_print_format (std::ostream &o)
	Gets the current print_format associated with the given ostream. More...

static bool	get_print_trace (std::ostream &o)
	Gets whether XQuery stack traces will be included when XQueryExceptions are printed to the given ostream. More...

static void	set_print_format (std::ostream &o, print_format f)
	Sets the print_format of the given ostream. More...

static void	set_print_trace (std::ostream &o, bool print)
	Sets whether XQuery stack traces will be included when XQueryExceptions are printed to the given ostream. More...

Protected Member Functions
std::unique_ptr< ZorbaException >	clone () const
	Clones this exception object. More...

std::ostream &	print (std::ostream &) const
	Prints the exception to the given ostream. More...

std::ostream &	print_impl (std::ostream &) const

std::ostream &	print_stack_trace (std::ostream &) const

Static Protected Member Functions
static bool	print_uri (std::ostream &, char const *uri)

Friends
UserException	internal::make_user_exception (char const , line_type, char const , char const , char const , char const , internal::diagnostic::location const &, error_object_type )

UserException	internal::make_user_exception (char const , line_type, Error const &, char const , internal::diagnostic::location const &, error_object_type *)

void	serialization::operator& (serialization::Archiver &, ZorbaException *&)

Detailed Description

A UserException is-an XQueryException for errors raised via fn:error().

Examples:: errors.cpp.

Definition at line 96 of file user_exception.h.

Member Typedef Documentation

typedef internal::diagnostic::location::column_type zorba::XQueryException::column_type

inherited

Definition at line 39 of file xquery_exception.h.

typedef internal::error_object_type zorba::UserException::error_object_type

Definition at line 98 of file user_exception.h.

typedef internal::diagnostic::location::line_type zorba::ZorbaException::line_type

inherited

Definition at line 44 of file zorba_exception.h.

Member Enumeration Documentation

enum zorba::ZorbaException::print_format

inherited

The format to print exceptions as to an ostream.

Enumerator
format_text	plain text
format_xml	XML without unnecessary whitespace.
format_xml_indented	XML with newlines and indentation.

Definition at line 49 of file zorba_exception.h.

enum zorba::XQueryException::print_trace

inherited

Whether to include the XQuery stack trace for the XQueryException that's printed to an ostream.

Enumerator
trace
no_trace

Definition at line 45 of file xquery_exception.h.

Constructor & Destructor Documentation

zorba::UserException::UserException ( UserException const & from )

Copy-constructs a UserException.

Parameters

from	The UserException to copy from.

zorba::UserException::~UserException	(	)
throw	(
	)

Destroys this UserException.

Member Function Documentation

column_type zorba::XQueryException::applied_column	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code "applied at" column number containing the error.

Returns: Returns said column number or 0 if unset.

Definition at line 264 of file xquery_exception.h.

column_type zorba::XQueryException::applied_column_end	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code "applied at" end column number containing the error.

Returns: Returns said column number or 0 if unset.

Definition at line 284 of file xquery_exception.h.

line_type zorba::XQueryException::applied_line	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code "applied at" line number containing the error.

Returns: Returns said line number or 0 if unset.

Definition at line 254 of file xquery_exception.h.

line_type zorba::XQueryException::applied_line_end	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code "applied at" end line number containing the error.

Returns: Returns said line number or 0 if unset.

Definition at line 274 of file xquery_exception.h.

char const* zorba::XQueryException::applied_uri	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code "applied at" URI containing the error.

Returns: Returns said URI or the empty string if unset.

Definition at line 245 of file xquery_exception.h.

std::unique_ptr<ZorbaException> zorba::UserException::clone ( ) const

protectedvirtual

Clones this exception object.

Returns: Returns a clone of this exception.

Reimplemented from zorba::ZorbaException.

column_type zorba::XQueryException::data_column	(	)	const
throw	(
	)

inlineinherited

Gets the data column number containing the error.

Returns: Returns said column number or 0 if unset.

Definition at line 190 of file xquery_exception.h.

column_type zorba::XQueryException::data_column_end	(	)	const
throw	(
	)

inlineinherited

Gets the data end column number containing the error.

Returns: Returns said column number or 0 if unset.

Definition at line 208 of file xquery_exception.h.

line_type zorba::XQueryException::data_line	(	)	const
throw	(
	)

inlineinherited

Gets the data line number containing the error.

Returns: Returns said line number or 0 if unset.

Definition at line 181 of file xquery_exception.h.

line_type zorba::XQueryException::data_line_end	(	)	const
throw	(
	)

inlineinherited

Gets the data end line number containing the error.

Returns: Returns said line number or 0 if unset.

Definition at line 199 of file xquery_exception.h.

char const* zorba::XQueryException::data_uri	(	)	const
throw	(
	)

inlineinherited

Gets the data URI containing the error.

Returns: Returns said URI or the empty string if unset.

Definition at line 172 of file xquery_exception.h.

Diagnostic const& zorba::ZorbaException::diagnostic	(	)	const
throw	(
	)

inlineinherited

Gets the diagnostic carried by this exception.

Returns: Returns said diagnostic.

Examples:: errors.cpp, external_functions.cpp, and simple.cpp.

Definition at line 80 of file zorba_exception.h.

error_object_type const& zorba::UserException::error_object	(	)	const
throw	(
	)

inline

Gets the error object associated with this exception.

Returns: Returns said error object.

Examples:: errors.cpp.

Definition at line 125 of file user_exception.h.

static print_format zorba::ZorbaException::get_print_format ( std::ostream & o )

inlinestaticinherited

Gets the current print_format associated with the given ostream.

Parameters

o	The ostream to get the print_format of.

Returns: Returns said print_format.

Definition at line 90 of file zorba_exception.h.

static bool zorba::XQueryException::get_print_trace ( std::ostream & o )

inlinestaticinherited

Gets whether XQuery stack traces will be included when XQueryExceptions are printed to the given ostream.

Parameters

o	The ostream.

Returns: Returns true only if stack traces will be included.

Definition at line 297 of file xquery_exception.h.

bool zorba::XQueryException::has_applied	(	)	const
throw	(
	)

inlineinherited

Checks whether the XQuery "applied at" location has been set.

Returns: Returns true only if the "applied at" location has been set.

Definition at line 219 of file xquery_exception.h.

bool zorba::XQueryException::has_data	(	)	const
throw	(
	)

inlineinherited

Checks whether the XQuery data location has been set.

Returns: Returns true only if the data location has been set.

Definition at line 148 of file xquery_exception.h.

bool zorba::XQueryException::has_source	(	)	const
throw	(
	)

inlineinherited

Checks whether the XQuery source-code location has been set.

Returns: Returns true only if said has been set.

Definition at line 77 of file xquery_exception.h.

UserException& zorba::UserException::operator= ( UserException const & from )

Assigns this UserException from another.

Parameters

from	The UserException to assign from.

Returns: Returns *this.

void zorba::UserException::polymorphic_throw ( ) const

virtual

Throws itself polymorphically; see http://www.parashift.com/c++-faq-lite/exceptions.html#faq-17.16.

Reimplemented from zorba::ZorbaException.

std::ostream& zorba::ZorbaException::print ( std::ostream & ) const

protectedinherited

Prints the exception to the given ostream.

Parameters

o	The ostream to print to.

Returns: Returns o.

Referenced by zorba::operator<<().

std::ostream& zorba::XQueryException::print_impl ( std::ostream & ) const

protectedvirtualinherited

Reimplemented from zorba::ZorbaException.

std::ostream& zorba::XQueryException::print_stack_trace ( std::ostream & ) const

protectedinherited

static bool zorba::XQueryException::print_uri	(	std::ostream &	,
		char const *	uri
	)

staticprotectedinherited

XQueryStackTrace& zorba::XQueryException::query_trace	(	)
throw	(
	)

inlineinherited

Gets the XQuery stack trace, if any.

Returns: Returns said stack trace.

Definition at line 306 of file xquery_exception.h.

XQueryStackTrace const& zorba::XQueryException::query_trace	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery stack trace, if any.

Returns: Returns said stack trace.

Definition at line 315 of file xquery_exception.h.

char const* zorba::ZorbaException::raise_file	(	)	const
throw	(
	)

inlineinherited

Gets the C++ source-code file name whence this exception was raised.

Returns: Returns said file name.

Definition at line 114 of file zorba_exception.h.

line_type zorba::ZorbaException::raise_line	(	)	const
throw	(
	)

inlineinherited

Gets the C++ source-code line number whence this exception was raised.

Returns: Returns said line number.

Definition at line 123 of file zorba_exception.h.

void zorba::XQueryException::set_applied	(	char const *	uri,
		line_type	line,
		column_type	column = `0`,
		line_type	line_end = `0`,
		column_type	column_end = `0`
	)

inherited

Sets the XQuery source-code "applied at" URI name, line, and column numbers.

Parameters

uri	The source-code "applied at" URI name. If either the null pointer or the empty string, `source_uri()` is used.
line	The source-code "applied at" URI line number.
column	The source-code "applied at" URI column number.
line_end	The source-code "applied at" URI end line number.
column_end	The source-code "applied at" URI end column number.

void zorba::XQueryException::set_data	(	char const *	uri,
		line_type	line,
		column_type	column = `0`,
		line_type	line_end = `0`,
		column_type	column_end = `0`
	)

inherited

Sets the XQuery source-code data URI name, line, and column numbers.

Parameters

uri	The source-code data URI name. Must not be null.
line	The source-code data URI line number.
column	The source-code data URI column number.
line_end	The source-code data URI end line number.
column_end	The source-code data URI end column number.

void zorba::ZorbaException::set_diagnostic	(	Diagnostic const &	diagnostic	)
throw	(
	)

inlineinherited

Sets the diagnostic.

Parameters

diagnostic The diagnostic.

Definition at line 105 of file zorba_exception.h.

static void zorba::ZorbaException::set_print_format	(	std::ostream &	o,
		print_format	f
	)

inlinestaticinherited

Sets the print_format of the given ostream.

Parameters

o	The ostream to set the print_format of.
f	The print_format value.

Definition at line 133 of file zorba_exception.h.

Referenced by zorba::operator<<().

static void zorba::XQueryException::set_print_trace	(	std::ostream &	o,
		bool	print
	)

inlinestaticinherited

Sets whether XQuery stack traces will be included when XQueryExceptions are printed to the given ostream.

Parameters

o	The ostream to affect.
print	If true, stack traces will be included.

Definition at line 326 of file xquery_exception.h.

Referenced by zorba::operator<<().

void zorba::XQueryException::set_source	(	char const *	uri,
		line_type	line,
		column_type	column = `0`,
		line_type	line_end = `0`,
		column_type	column_end = `0`
	)

inherited

Sets the XQuery source-code URI name, line, and column numbers.

Parameters

uri	The source-code URI name.
line	The source-code URI line number.
column	The source-code URI column number.
line_end	The source-code URI end line number.
column_end	The source-code URI end column number.

column_type zorba::XQueryException::source_column	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code column number containing the error.

Returns: Returns said column number or 0 if unset.

Definition at line 119 of file xquery_exception.h.

column_type zorba::XQueryException::source_column_end	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code end column number containing the error.

Returns: Returns said column number or 0 if unset.

Definition at line 137 of file xquery_exception.h.

line_type zorba::XQueryException::source_line	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code line number containing the error.

Returns: Returns said line number or 0 if unset.

Definition at line 110 of file xquery_exception.h.

line_type zorba::XQueryException::source_line_end	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code end line number containing the error.

Returns: Returns said line number or 0 if unset.

Definition at line 128 of file xquery_exception.h.

char const* zorba::XQueryException::source_uri	(	)	const
throw	(
	)

inlineinherited

Gets the XQuery source-code URI containing the error.

Returns: Returns said URI or the empty string if unset.

Definition at line 101 of file xquery_exception.h.

char const* zorba::ZorbaException::what	(	)	const
throw	(
	)

inherited

Examples:: simple.cpp.

Friends And Related Function Documentation

UserException internal::make_user_exception	(	char const *	,
		line_type	,
		char const *	,
		char const *	,
		char const *	,
		char const *	,
		internal::diagnostic::location const &	,
		error_object_type *
	)

friend

UserException internal::make_user_exception	(	char const *	,
		line_type	,
		Error const &	,
		char const *	,
		internal::diagnostic::location const &	,
		error_object_type *
	)

friend

void serialization::operator&	(	serialization::Archiver &	,
		ZorbaException *&
	)

friend

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

user_exception.h

Zorba

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation