entityresolver.h

This software aims to create an applet and panel tools to manage a wireless interface card, such as

//
// EntityResolver.h
//
// $Id: //poco/Main/XML/include/SAX/EntityResolver.h#5 $
//
// SAX EntityResolver Interface.
//
// Copyright (c) 2004, Guenter Obiltschnig/Applied Informatics.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Redistributions in any form must be accompanied by information on
//    how to obtain complete source code for this software and any
//    accompanying software that uses this software.  The source code
//    must either be included in the distribution or be available for no
//    more than the cost of distribution plus a nominal fee, and must be
//    freely redistributable under reasonable conditions.  For an
//    executable file, complete source code means the source code for all
//    modules it contains.  It does not include source code for modules or
//    files that typically accompany the major components of the operating
//    system on which the executable file runs.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//


#ifndef SAX_EntityResolver_INCLUDED
#define SAX_EntityResolver_INCLUDED


#ifndef XML_XML_INCLUDED
#include "XML/XML.h"
#endif
#ifndef XML_XMLString_INCLUDED
#include "XML/XMLString.h"
#endif


XML_BEGIN


class InputSource;


class XML_API EntityResolver
	/// If a SAX application needs to implement customized handling for external entities, 
	/// it must implement this interface and register an instance with the SAX driver using 
	/// the setEntityResolver method.
	/// 
	/// The XML reader will then allow the application to intercept any external entities 
	/// (including the external DTD subset and external parameter entities, if any) before 
	/// including them.
	/// 
	/// Many SAX applications will not need to implement this interface, but it will be 
	/// especially useful for applications that build XML documents from databases or other 
	/// specialised input sources, or for applications that use URI types other than URLs.
	///
	/// The application can also use this interface to redirect system identifiers to local 
	/// URIs or to look up replacements in a catalog (possibly by using the public identifier).
{
public:
	virtual InputSource* resolveEntity(const XMLString* publicId, const XMLString& systemId) = 0;
		/// Allow the application to resolve external entities.
		/// 
		/// The parser will call this method before opening any external entity except the 
		/// top-level document entity. Such entities include the external DTD subset and 
		/// external parameter entities referenced within the DTD (in either case, only 
		/// if the parser reads external parameter entities), and external general entities 
		/// referenced within the document element (if the parser reads external general entities). 
		/// The application may request that the parser locate the entity itself, that it use an 
		/// alternative URI, or that it use data provided by the application (as a character or 
		/// byte input stream).
		/// 
		/// Application writers can use this method to redirect external system identifiers to 
		/// secure and/or local URIs, to look up public identifiers in a catalogue, or to read an 
		/// entity from a database or other input source (including, for example, a dialog box). 
		/// Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve 
		/// resources. However, SAX specifies how to interpret any InputSource returned by this method, 
		/// and that if none is returned, then the system ID will be dereferenced as a URL.
		/// 
		/// If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to 
		/// the application.
		/// 
		/// Note that publicId maybe null, therefore we pass a pointer rather than a reference.

	virtual void releaseInputSource(InputSource* pSource) = 0;
		/// This is a non-standard extension to SAX!
		/// Called by the parser when the input source returned by ResolveEntity is
		/// no longer needed. Should free any resources used by the input source.

protected:
	virtual ~EntityResolver();
};


XML_END


#endif // SAX_EntityResolver_INCLUDED