michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsIExpatSink.idl"
michael@0: 
michael@0: /**
michael@0:  * This interface provides notification of syntax-level events.
michael@0:  */
michael@0: [scriptable, uuid(146E194B-333D-4283-8CF6-4BC3EE9B5DFF)]
michael@0: interface nsIExtendedExpatSink : nsIExpatSink
michael@0: {
michael@0:   /**
michael@0:    * Called at the beginning of the DTD, before any entity or notation
michael@0:    * events.
michael@0:    * @param aDoctypeName The document type name.
michael@0:    * @param aSysid The declared system identifier for the external DTD subset,
michael@0:    *               or null if none was declared.
michael@0:    * @param aPubid The declared public identifier for the external DTD subset,
michael@0:    *               or null if none was declared.
michael@0:    */
michael@0:   void handleStartDTD(in wstring aDoctypeName,
michael@0:                       in wstring aSysid,
michael@0:                       in wstring aPubid);
michael@0: 
michael@0:   /**
michael@0:    * Called when a prefix mapping starts to be in-scope, before any
michael@0:    * startElement events.
michael@0:    * @param aPrefix The Namespace prefix being declared. An empty string
michael@0:    *                is used for the default element namespace, which has
michael@0:    *                no prefix.
michael@0:    * @param aUri The Namespace URI the prefix is mapped to.
michael@0:    */
michael@0:   void handleStartNamespaceDecl(in wstring aPrefix,
michael@0:                                 in wstring aUri);
michael@0:                               
michael@0:   /**
michael@0:    * Called when a prefix mapping is no longer in-scope, after any
michael@0:    * endElement events.
michael@0:    * @param aPrefix The prefix that was being mapped. This is the empty string
michael@0:    *                when a default mapping scope ends.
michael@0:    */
michael@0:   void handleEndNamespaceDecl(in wstring aPrefix);
michael@0: 
michael@0:   /**
michael@0:    * This is called for a declaration of notation.  The base argument is
michael@0:    * whatever was set by XML_SetBase. aNotationName will never be
michael@0:    * null. The other arguments can be.
michael@0:    * @param aNotationName The notation name.
michael@0:    * @param aSysId The notation's system identifier, or null if none was given.
michael@0:    * @param aPubId The notation's pubilc identifier, or null if none was given.
michael@0:    */
michael@0:   void handleNotationDecl(in wstring aNotationName,
michael@0:                           in wstring aSysid,
michael@0:                           in wstring aPubid);
michael@0:                               
michael@0:   /**
michael@0:    * This is called for a declaration of an unparsed (NDATA) entity.
michael@0:    * aName, aSysid and aNotationName arguments will never be
michael@0:    * null. The other arguments may be.
michael@0:    * @param aName  The unparsed entity's name.
michael@0:    * @param aSysId The notation's system identifier.
michael@0:    * @param aPubId The notation's pubilc identifier, or null if none was given.
michael@0:    * @param aNotationName The name of the associated notation.
michael@0:    */
michael@0:   void handleUnparsedEntityDecl(in wstring aName,
michael@0:                                 in wstring aSysid,
michael@0:                                 in wstring aPubid,
michael@0:                                 in wstring aNotationName);
michael@0: 
michael@0: };