gecko/parser/xml/public/nsISAXDTDHandler.idl

110 lines
4.7 KiB
Plaintext
Raw Normal View History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Robert Sayre.
*
* Portions created by the Initial Developer are Copyright (C) 2005
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
/**
* Receive notification of basic DTD-related events.
*
* If a SAX application needs information about notations and
* unparsed entities, then the application implements this interface
* and registers an instance with the SAX parser using the parser's
* setDTDHandler method. The parser uses the instance to report
* notation and unparsed entity declarations to the application.
*
* Note that this interface includes only those DTD events that the
* XML recommendation requires processors to report: notation and
* unparsed entity declarations.
*
* The SAX parser may report these events in any order, regardless
* of the order in which the notations and unparsed entities were
* declared; however, all DTD events must be reported after the
* document handler's startDocument event, and before the first
* startElement event. (If the LexicalHandler is used, these events
* must also be reported before the endDTD event.)
*/
[scriptable, uuid(4d01f225-6cc5-11da-be43-001422106990)]
interface nsISAXDTDHandler : nsISupports {
/**
* Receive notification of a notation declaration event.
*
* It is up to the application to record the notation for later
* reference, if necessary; notations may appear as attribute values
* and in unparsed entity declarations, and are sometime used with
* processing instruction target names.
*
* At least one of publicId and systemId must be non-null. If a
* system identifier is present, and it is a URL, the SAX parser
* must resolve it fully before passing it to the application
* through this event.
*
* There is no guarantee that the notation declaration will be
* reported before any unparsed entities that use it.
*
* @param name The notation name.
* @param publicId The notation's public identifier, or null if none was
* given.
* @param systemId The notation's system identifier, or null if none was
* given.
*/
void notationDecl(in AString name,
in AString publicId,
in AString systemId);
/**
* Receive notification of an unparsed entity declaration event.
*
* Note that the notation name corresponds to a notation reported
* by the notationDecl event. It is up to the application to record
* the entity for later reference, if necessary; unparsed entities
* may appear as attribute values.
*
* If the system identifier is a URL, the parser must resolve it
* fully before passing it to the application.
*
* @param name The unparsed entity's name.
* @param publicId The entity's public identifier, or null if none was
* given.
* @param systemId The entity's system identifier, or null if none was
* given.
* @param notationName The name of the associated notation.
*/
void unparsedEntityDecl(in AString name, in AString publicId,
in AString systemId, in AString notationName);
};