RWRegexErr Class Reference
[String Processing]

Exception class that reports errors from within RWTRegex. More...

#include <rw/rwerr.h>

Inheritance diagram for RWRegexErr:

List of all members.

Public Member Functions
	RWRegexErr (const char *msg, size_t eCode, size_t eOffset)
virtual	~RWRegexErr ()
size_t	getCode () const
size_t	getOffset () const

---

Detailed Description

Class RWRegexErr is an exception class used to report errors from within RWTRegex.

RWRegexErr is derived from RWInternalErr, and is therefore part of the RWxmsg class hierarchy. Classes in this hierarchy are used to report errors from within the Essential Tools Module.

RWRegexErr customizes RWInternalErr to provide not only an error message (inherited from RWxmsg), but also an error code and an error offset.

The error code is an RWTRegex<T>::RWTRegexStatus enumeration constant represented as a size_t, and is useful in generating error messages in the wide characters required for many non-Latin languages.

When RWTRegex generates an error, it creates an RWRegexErr object to represent the error. A copy of this object is saved in the RWTRegex object, and is available through a call to RWTRegex::getStatus().

Then, RWTHROW() is used to report the error. If exceptions are enabled, the function throws the RWRegexErr object as an exception. If not, then a user-defined callback function is invoked.

Synopsis

 #include <rw/rwerr.h>
 RWRegexErr msg("exception message");

Persistence

None

Examples

 #include <rw/cstring.h>
 #include <rw/locale.h>
 #include <rw/rwerr.h>
 #include <rw/cstring.h>
 #include <rw/tools/regex.h>
 
 #include <iostream>
 
 int main()
 {
   const RWCString unmatchedParen("ab)$");
 
   try
   {
     // Unmatched closing parenthesis generates exception
     RWTRegex<char> r(unmatchedParen);
 
     // Use the regular expression to avoid warnings
     r.index(unmatchedParen);
   }
   catch (const RWRegexErr& err)
   {
     std::cout << "Caught exception: "                    << std::endl
               << "Description     : " << err.why()       << std::endl
               << "Code            : " << err.getCode()   << std::endl
               << "Offset          : " << err.getOffset() << std::endl
               << unmatchedParen                          << std::endl
               << RWCString('-', err.getOffset()) << '^'  << std::endl;
   }
 
   return 0;
 }

---

Constructor & Destructor Documentation

RWRegexErr::RWRegexErr	(	const char *	msg,
		size_t	eCode,
		size_t	eOffset
	)

Initializes the error object to contain the specified error message, msg. The error code, eCode, is stored as well as the offset, eOffset, into the pattern of the error.

virtual RWRegexErr::~RWRegexErr

(

)

[virtual]

Destructor

---

Member Function Documentation

size_t RWRegexErr::getCode

(

)

const

Returns the error code for the error. The error code is an RWTRegex<T>::RWTRegexStatus enumerator represented as a size_t.

size_t RWRegexErr::getOffset

(

)

const

Returns the offset into the pattern at which the error occurred.