mirror of
https://github.com/pocoproject/poco.git
synced 2025-10-25 18:22:59 +02:00
115 lines
4.9 KiB
C++
115 lines
4.9 KiB
C++
//
|
|
// ErrorHandler.h
|
|
//
|
|
// $Id: //poco/1.4/XML/include/Poco/SAX/ErrorHandler.h#1 $
|
|
//
|
|
// Library: XML
|
|
// Package: SAX
|
|
// Module: SAX
|
|
//
|
|
// SAX ErrorHandler Interface.
|
|
//
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person or organization
|
|
// obtaining a copy of the software and accompanying documentation covered by
|
|
// this license (the "Software") to use, reproduce, display, distribute,
|
|
// execute, and transmit the Software, and to prepare derivative works of the
|
|
// Software, and to permit third-parties to whom the Software is furnished to
|
|
// do so, all subject to the following:
|
|
//
|
|
// The copyright notices in the Software and this entire statement, including
|
|
// the above license grant, this restriction and the following disclaimer,
|
|
// must be included in all copies of the Software, in whole or in part, and
|
|
// all derivative works of the Software, unless such copies or derivative
|
|
// works are solely in the form of machine-executable object code generated by
|
|
// a source language processor.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
|
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
|
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
|
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
|
|
#ifndef SAX_ErrorHandler_INCLUDED
|
|
#define SAX_ErrorHandler_INCLUDED
|
|
|
|
|
|
#include "Poco/XML/XML.h"
|
|
|
|
|
|
namespace Poco {
|
|
namespace XML {
|
|
|
|
|
|
class SAXException;
|
|
|
|
|
|
class XML_API ErrorHandler
|
|
/// If a SAX application needs to implement customized error handling, it must
|
|
/// implement this interface and then register an instance with the XML reader
|
|
/// using the setErrorHandler method. The parser will then report all errors and
|
|
/// warnings through this interface.
|
|
///
|
|
/// WARNING: If an application does not register an ErrorHandler, XML parsing errors
|
|
/// will go unreported, except that SAXParseExceptions will be thrown for fatal errors.
|
|
/// In order to detect validity errors, an ErrorHandler that does something with error()
|
|
/// calls must be registered.
|
|
///
|
|
/// For XML processing errors, a SAX driver must use this interface in preference to
|
|
/// throwing an exception: it is up to the application to decide whether to throw an
|
|
/// exception for different types of errors and warnings. Note, however, that there is no
|
|
/// requirement that the parser continue to report additional errors after a call to
|
|
/// fatalError. In other words, a SAX driver class may throw an exception after reporting
|
|
/// any fatalError. Also parsers may throw appropriate exceptions for non-XML errors. For
|
|
/// example, XMLReader::parse() would throw an IOException for errors accessing entities or
|
|
/// the document.
|
|
{
|
|
public:
|
|
virtual void warning(const SAXException& exc) = 0;
|
|
/// Receive notification of a warning.
|
|
///
|
|
/// SAX parsers will use this method to report conditions that are not errors or fatal
|
|
/// errors as defined by the XML recommendation. The default behaviour is to take no action.
|
|
///
|
|
/// The SAX parser must continue to provide normal parsing events after invoking this method:
|
|
/// it should still be possible for the application to process the document through to the end.
|
|
///
|
|
/// Filters may use this method to report other, non-XML warnings as well.
|
|
|
|
virtual void error(const SAXException& exc) = 0;
|
|
/// Receive notification of a recoverable error.
|
|
///
|
|
/// This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0
|
|
/// Recommendation. For example, a validating parser would use this callback to report
|
|
/// the violation of a validity constraint. The default behaviour is to take no action.
|
|
///
|
|
/// The SAX parser must continue to provide normal parsing events after invoking this
|
|
/// method: it should still be possible for the application to process the document through
|
|
/// to the end. If the application cannot do so, then the parser should report a fatal error
|
|
/// even if the XML recommendation does not require it to do so.
|
|
///
|
|
/// Filters may use this method to report other, non-XML errors as well.
|
|
|
|
virtual void fatalError(const SAXException& exc) = 0;
|
|
/// Receive notification of a non-recoverable error.
|
|
/// The application must assume that the document is unusable after the parser has
|
|
/// invoked this method, and should continue (if at all) only for the sake of collecting
|
|
/// additional error messages: in fact, SAX parsers are free to stop reporting any other
|
|
/// events once this method has been invoked.
|
|
|
|
protected:
|
|
virtual ~ErrorHandler();
|
|
};
|
|
|
|
|
|
} } // namespace Poco::XML
|
|
|
|
|
|
#endif // SAX_ErrorHandler_INCLUDED
|